From: Marek Olšák Date: Sun, 13 Nov 2016 15:38:01 +0000 (+0100) Subject: util: import cache.c/h from glsl X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=31727300e177b11c2b2b267838b59b090cb605d0;p=mesa.git util: import cache.c/h from glsl It's not dependent on GLSL and it can be useful for shader caches that don't deal with GLSL. v2: address review comments v3: keep the other 3 lines in configure.ac Reviewed-by: Emil Velikov --- diff --git a/configure.ac b/configure.ac index 9d62b90cfb5..b89bf23801b 100644 --- a/configure.ac +++ b/configure.ac @@ -1361,7 +1361,6 @@ if test "x$with_sha1" = "x"; then AC_MSG_ERROR([Cannot enable shader cache (no SHA-1 implementation found)]) fi fi -AM_CONDITIONAL([ENABLE_SHADER_CACHE], [test x$enable_shader_cache = xyes]) if test "x$enable_shader_cache" = "xyes"; then AC_DEFINE([ENABLE_SHADER_CACHE], [1], [Enable shader cache]) fi diff --git a/src/compiler/Makefile.glsl.am b/src/compiler/Makefile.glsl.am index 3eac677de0d..5b1d74e2835 100644 --- a/src/compiler/Makefile.glsl.am +++ b/src/compiler/Makefile.glsl.am @@ -131,10 +131,6 @@ glsl_libglsl_la_SOURCES = \ $(LIBGLSL_GENERATED_FILES) \ $(LIBGLSL_FILES) -if ENABLE_SHADER_CACHE -glsl_libglsl_la_SOURCES += $(LIBGLSL_SHADER_CACHE_FILES) -endif - glsl_libstandalone_la_SOURCES = \ $(GLSL_COMPILER_CXX_FILES) diff --git a/src/compiler/Makefile.sources b/src/compiler/Makefile.sources index 08d93e0a261..d05bcacb9c5 100644 --- a/src/compiler/Makefile.sources +++ b/src/compiler/Makefile.sources @@ -136,10 +136,6 @@ LIBGLSL_FILES = \ glsl/s_expression.cpp \ glsl/s_expression.h -LIBGLSL_SHADER_CACHE_FILES = \ - glsl/cache.c \ - glsl/cache.h - # glsl_compiler GLSL_COMPILER_CXX_FILES = \ diff --git a/src/compiler/glsl/cache.c b/src/compiler/glsl/cache.c deleted file mode 100644 index e74c27d3000..00000000000 --- a/src/compiler/glsl/cache.c +++ /dev/null @@ -1,710 +0,0 @@ -/* - * Copyright © 2014 Intel Corporation - * - * Permission is hereby granted, free of charge, to any person obtaining a - * copy of this software and associated documentation files (the "Software"), - * to deal in the Software without restriction, including without limitation - * the rights to use, copy, modify, merge, publish, distribute, sublicense, - * and/or sell copies of the Software, and to permit persons to whom the - * Software is furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice (including the next - * paragraph) shall be included in all copies or substantial portions of the - * Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL - * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS - * IN THE SOFTWARE. - */ - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "util/u_atomic.h" -#include "util/mesa-sha1.h" -#include "util/ralloc.h" -#include "main/errors.h" - -#include "cache.h" - -/* Number of bits to mask off from a cache key to get an index. */ -#define CACHE_INDEX_KEY_BITS 16 - -/* Mask for computing an index from a key. */ -#define CACHE_INDEX_KEY_MASK ((1 << CACHE_INDEX_KEY_BITS) - 1) - -/* The number of keys that can be stored in the index. */ -#define CACHE_INDEX_MAX_KEYS (1 << CACHE_INDEX_KEY_BITS) - -struct program_cache { - /* The path to the cache directory. */ - char *path; - - /* A pointer to the mmapped index file within the cache directory. */ - uint8_t *index_mmap; - size_t index_mmap_size; - - /* Pointer to total size of all objects in cache (within index_mmap) */ - uint64_t *size; - - /* Pointer to stored keys, (within index_mmap). */ - uint8_t *stored_keys; - - /* Maximum size of all cached objects (in bytes). */ - uint64_t max_size; -}; - -/* Create a directory named 'path' if it does not already exist. - * - * Returns: 0 if path already exists as a directory or if created. - * -1 in all other cases. - */ -static int -mkdir_if_needed(char *path) -{ - struct stat sb; - - /* If the path exists already, then our work is done if it's a - * directory, but it's an error if it is not. - */ - if (stat(path, &sb) == 0) { - if (S_ISDIR(sb.st_mode)) { - return 0; - } else { - _mesa_warning(NULL, - "Cannot use %s for shader cache (not a directory)" - "---disabling.\n", path); - return -1; - } - } - - int ret = mkdir(path, 0755); - if (ret == 0 || (ret == -1 && errno == EEXIST)) - return 0; - - _mesa_warning(NULL, - "Failed to create %s for shader cache (%s)---disabling.\n", - path, strerror(errno)); - - return -1; -} - -/* Concatenate an existing path and a new name to form a new path. If the new - * path does not exist as a directory, create it then return the resulting - * name of the new path (ralloc'ed off of 'ctx'). - * - * Returns NULL on any error, such as: - * - * does not exist or is not a directory - * / exists but is not a directory - * / cannot be created as a directory - */ -static char * -concatenate_and_mkdir(void *ctx, char *path, char *name) -{ - char *new_path; - struct stat sb; - - if (stat(path, &sb) != 0 || ! S_ISDIR(sb.st_mode)) - return NULL; - - new_path = ralloc_asprintf(ctx, "%s/%s", path, name); - - if (mkdir_if_needed(new_path) == 0) - return new_path; - else - return NULL; -} - -struct program_cache * -cache_create(void) -{ - void *local; - struct program_cache *cache = NULL; - char *path, *max_size_str; - uint64_t max_size; - int fd = -1; - struct stat sb; - size_t size; - - /* A ralloc context for transient data during this invocation. */ - local = ralloc_context(NULL); - if (local == NULL) - goto fail; - - /* At user request, disable shader cache entirely. */ - if (getenv("MESA_GLSL_CACHE_DISABLE")) - goto fail; - - /* Determine path for cache based on the first defined name as follows: - * - * $MESA_GLSL_CACHE_DIR - * $XDG_CACHE_HOME/mesa - * /.cache/mesa - */ - path = getenv("MESA_GLSL_CACHE_DIR"); - if (path && mkdir_if_needed(path) == -1) { - goto fail; - } - - if (path == NULL) { - char *xdg_cache_home = getenv("XDG_CACHE_HOME"); - - if (xdg_cache_home) { - if (mkdir_if_needed(xdg_cache_home) == -1) - goto fail; - - path = concatenate_and_mkdir(local, xdg_cache_home, "mesa"); - if (path == NULL) - goto fail; - } - } - - if (path == NULL) { - char *buf; - size_t buf_size; - struct passwd pwd, *result; - - buf_size = sysconf(_SC_GETPW_R_SIZE_MAX); - if (buf_size == -1) - buf_size = 512; - - /* Loop until buf_size is large enough to query the directory */ - while (1) { - buf = ralloc_size(local, buf_size); - - getpwuid_r(getuid(), &pwd, buf, buf_size, &result); - if (result) - break; - - if (errno == ERANGE) { - ralloc_free(buf); - buf = NULL; - buf_size *= 2; - } else { - goto fail; - } - } - - path = concatenate_and_mkdir(local, pwd.pw_dir, ".cache"); - if (path == NULL) - goto fail; - - path = concatenate_and_mkdir(local, path, "mesa"); - if (path == NULL) - goto fail; - } - - cache = ralloc(NULL, struct program_cache); - if (cache == NULL) - goto fail; - - cache->path = ralloc_strdup(cache, path); - if (cache->path == NULL) - goto fail; - - path = ralloc_asprintf(local, "%s/index", cache->path); - if (path == NULL) - goto fail; - - fd = open(path, O_RDWR | O_CREAT | O_CLOEXEC, 0644); - if (fd == -1) - goto fail; - - if (fstat(fd, &sb) == -1) - goto fail; - - /* Force the index file to be the expected size. */ - size = sizeof(*cache->size) + CACHE_INDEX_MAX_KEYS * CACHE_KEY_SIZE; - if (sb.st_size != size) { - if (ftruncate(fd, size) == -1) - goto fail; - } - - /* We map this shared so that other processes see updates that we - * make. - * - * Note: We do use atomic addition to ensure that multiple - * processes don't scramble the cache size recorded in the - * index. But we don't use any locking to prevent multiple - * processes from updating the same entry simultaneously. The idea - * is that if either result lands entirely in the index, then - * that's equivalent to a well-ordered write followed by an - * eviction and a write. On the other hand, if the simultaneous - * writes result in a corrupt entry, that's not really any - * different than both entries being evicted, (since within the - * guarantees of the cryptographic hash, a corrupt entry is - * unlikely to ever match a real cache key). - */ - cache->index_mmap = mmap(NULL, size, PROT_READ | PROT_WRITE, - MAP_SHARED, fd, 0); - if (cache->index_mmap == MAP_FAILED) - goto fail; - cache->index_mmap_size = size; - - close(fd); - - cache->size = (uint64_t *) cache->index_mmap; - cache->stored_keys = cache->index_mmap + sizeof(uint64_t); - - max_size = 0; - - max_size_str = getenv("MESA_GLSL_CACHE_MAX_SIZE"); - if (max_size_str) { - char *end; - max_size = strtoul(max_size_str, &end, 10); - if (end == max_size_str) { - max_size = 0; - } else { - while (*end && isspace(*end)) - end++; - switch (*end) { - case 'K': - case 'k': - max_size *= 1024; - break; - case 'M': - case 'm': - max_size *= 1024*1024; - break; - case '\0': - case 'G': - case 'g': - default: - max_size *= 1024*1024*1024; - break; - } - } - } - - /* Default to 1GB for maximum cache size. */ - if (max_size == 0) - max_size = 1024*1024*1024; - - cache->max_size = max_size; - - ralloc_free(local); - - return cache; - - fail: - if (fd != -1) - close(fd); - if (cache) - ralloc_free(cache); - ralloc_free(local); - - return NULL; -} - -void -cache_destroy(struct program_cache *cache) -{ - munmap(cache->index_mmap, cache->index_mmap_size); - - ralloc_free(cache); -} - -/* Return a filename within the cache's directory corresponding to 'key'. The - * returned filename is ralloced with 'cache' as the parent context. - * - * Returns NULL if out of memory. - */ -static char * -get_cache_file(struct program_cache *cache, cache_key key) -{ - char buf[41]; - - _mesa_sha1_format(buf, key); - - return ralloc_asprintf(cache, "%s/%c%c/%s", - cache->path, buf[0], buf[1], buf + 2); -} - -/* Create the directory that will be needed for the cache file for \key. - * - * Obviously, the implementation here must closely match - * _get_cache_file above. -*/ -static void -make_cache_file_directory(struct program_cache *cache, cache_key key) -{ - char *dir; - char buf[41]; - - _mesa_sha1_format(buf, key); - - dir = ralloc_asprintf(cache, "%s/%c%c", cache->path, buf[0], buf[1]); - - mkdir_if_needed(dir); - - ralloc_free(dir); -} - -/* Given a directory path and predicate function, count all entries in - * that directory for which the predicate returns true. Then choose a - * random entry from among those counted. - * - * Returns: A malloc'ed string for the path to the chosen file, (or - * NULL on any error). The caller should free the string when - * finished. - */ -static char * -choose_random_file_matching(const char *dir_path, - bool (*predicate)(struct dirent *)) -{ - DIR *dir; - struct dirent *entry; - unsigned int count, victim; - char *filename; - - dir = opendir(dir_path); - if (dir == NULL) - return NULL; - - count = 0; - - while (1) { - entry = readdir(dir); - if (entry == NULL) - break; - if (! predicate(entry)) - continue; - - count++; - } - - if (count == 0) { - closedir(dir); - return NULL; - } - - victim = rand() % count; - - rewinddir(dir); - count = 0; - - while (1) { - entry = readdir(dir); - if (entry == NULL) - break; - if (! predicate(entry)) - continue; - if (count == victim) - break; - - count++; - } - - if (entry == NULL) { - closedir(dir); - return NULL; - } - - if (asprintf(&filename, "%s/%s", dir_path, entry->d_name) < 0) - filename = NULL; - - closedir(dir); - - return filename; -} - -/* Is entry a regular file, and not having a name with a trailing - * ".tmp" - */ -static bool -is_regular_non_tmp_file(struct dirent *entry) -{ - size_t len; - - if (entry->d_type != DT_REG) - return false; - - len = strlen (entry->d_name); - if (len >= 4 && strcmp(&entry->d_name[len-4], ".tmp") == 0) - return false; - - return true; -} - -/* Returns the size of the deleted file, (or 0 on any error). */ -static size_t -unlink_random_file_from_directory(const char *path) -{ - struct stat sb; - char *filename; - - filename = choose_random_file_matching(path, is_regular_non_tmp_file); - if (filename == NULL) - return 0; - - if (stat(filename, &sb) == -1) { - free (filename); - return 0; - } - - unlink(filename); - - free (filename); - - return sb.st_size; -} - -/* Is entry a directory with a two-character name, (and not the - * special name of "..") - */ -static bool -is_two_character_sub_directory(struct dirent *entry) -{ - if (entry->d_type != DT_DIR) - return false; - - if (strlen(entry->d_name) != 2) - return false; - - if (strcmp(entry->d_name, "..") == 0) - return false; - - return true; -} - -static void -evict_random_item(struct program_cache *cache) -{ - const char hex[] = "0123456789abcde"; - char *dir_path; - int a, b; - size_t size; - - /* With a reasonably-sized, full cache, (and with keys generated - * from a cryptographic hash), we can choose two random hex digits - * and reasonably expect the directory to exist with a file in it. - */ - a = rand() % 16; - b = rand() % 16; - - if (asprintf(&dir_path, "%s/%c%c", cache->path, hex[a], hex[b]) < 0) - return; - - size = unlink_random_file_from_directory(dir_path); - - free(dir_path); - - if (size) { - p_atomic_add(cache->size, - size); - return; - } - - /* In the case where the random choice of directory didn't find - * something, we choose randomly from the existing directories. - * - * Really, the only reason this code exists is to allow the unit - * tests to work, (which use an artificially-small cache to be able - * to force a single cached item to be evicted). - */ - dir_path = choose_random_file_matching(cache->path, - is_two_character_sub_directory); - if (dir_path == NULL) - return; - - size = unlink_random_file_from_directory(dir_path); - - free(dir_path); - - if (size) - p_atomic_add(cache->size, - size); -} - -void -cache_put(struct program_cache *cache, - cache_key key, - const void *data, - size_t size) -{ - int fd = -1, fd_final = -1, err, ret; - size_t len; - char *filename = NULL, *filename_tmp = NULL; - const char *p = data; - - filename = get_cache_file(cache, key); - if (filename == NULL) - goto done; - - /* Write to a temporary file to allow for an atomic rename to the - * final destination filename, (to prevent any readers from seeing - * a partially written file). - */ - filename_tmp = ralloc_asprintf(cache, "%s.tmp", filename); - if (filename_tmp == NULL) - goto done; - - fd = open(filename_tmp, O_WRONLY | O_CLOEXEC | O_CREAT, 0644); - - /* Make the two-character subdirectory within the cache as needed. */ - if (fd == -1) { - if (errno != ENOENT) - goto done; - - make_cache_file_directory(cache, key); - - fd = open(filename_tmp, O_WRONLY | O_CLOEXEC | O_CREAT, 0644); - if (fd == -1) - goto done; - } - - /* With the temporary file open, we take an exclusive flock on - * it. If the flock fails, then another process still has the file - * open with the flock held. So just let that file be responsible - * for writing the file. - */ - err = flock(fd, LOCK_EX | LOCK_NB); - if (err == -1) - goto done; - - /* Now that we have the lock on the open temporary file, we can - * check to see if the destination file already exists. If so, - * another process won the race between when we saw that the file - * didn't exist and now. In this case, we don't do anything more, - * (to ensure the size accounting of the cache doesn't get off). - */ - fd_final = open(filename, O_RDONLY | O_CLOEXEC); - if (fd_final != -1) - goto done; - - /* OK, we're now on the hook to write out a file that we know is - * not in the cache, and is also not being written out to the cache - * by some other process. - * - * Before we do that, if the cache is too large, evict something - * else first. - */ - if (*cache->size + size > cache->max_size) - evict_random_item(cache); - - /* Now, finally, write out the contents to the temporary file, then - * rename them atomically to the destination filename, and also - * perform an atomic increment of the total cache size. - */ - for (len = 0; len < size; len += ret) { - ret = write(fd, p + len, size - len); - if (ret == -1) { - unlink(filename_tmp); - goto done; - } - } - - rename(filename_tmp, filename); - - p_atomic_add(cache->size, size); - - /* This close finally releases the flock, (now that the final dile - * has been renamed into place and the size has been added). - */ - close(fd); - fd = -1; - - done: - if (filename_tmp) - ralloc_free(filename_tmp); - if (filename) - ralloc_free(filename); - if (fd != -1) - close(fd); -} - -void * -cache_get(struct program_cache *cache, cache_key key, size_t *size) -{ - int fd = -1, ret, len; - struct stat sb; - char *filename = NULL; - uint8_t *data = NULL; - - if (size) - *size = 0; - - filename = get_cache_file(cache, key); - if (filename == NULL) - goto fail; - - fd = open(filename, O_RDONLY | O_CLOEXEC); - if (fd == -1) - goto fail; - - if (fstat(fd, &sb) == -1) - goto fail; - - data = malloc(sb.st_size); - if (data == NULL) - goto fail; - - for (len = 0; len < sb.st_size; len += ret) { - ret = read(fd, data + len, sb.st_size - len); - if (ret == -1) - goto fail; - } - - ralloc_free(filename); - close(fd); - - if (size) - *size = sb.st_size; - - return data; - - fail: - if (data) - free(data); - if (filename) - ralloc_free(filename); - if (fd != -1) - close(fd); - - return NULL; -} - -void -cache_put_key(struct program_cache *cache, cache_key key) -{ - uint32_t *key_chunk = (uint32_t *) key; - int i = *key_chunk & CACHE_INDEX_KEY_MASK; - unsigned char *entry; - - entry = &cache->stored_keys[i + CACHE_KEY_SIZE]; - - memcpy(entry, key, CACHE_KEY_SIZE); -} - -/* This function lets us test whether a given key was previously - * stored in the cache with cache_put_key(). The implement is - * efficient by not using syscalls or hitting the disk. It's not - * race-free, but the races are benign. If we race with someone else - * calling cache_put_key, then that's just an extra cache miss and an - * extra recompile. - */ -bool -cache_has_key(struct program_cache *cache, cache_key key) -{ - uint32_t *key_chunk = (uint32_t *) key; - int i = *key_chunk & CACHE_INDEX_KEY_MASK; - unsigned char *entry; - - entry = &cache->stored_keys[i + CACHE_KEY_SIZE]; - - return memcmp(entry, key, CACHE_KEY_SIZE) == 0; -} diff --git a/src/compiler/glsl/cache.h b/src/compiler/glsl/cache.h deleted file mode 100644 index d804169c656..00000000000 --- a/src/compiler/glsl/cache.h +++ /dev/null @@ -1,177 +0,0 @@ -/* - * Copyright © 2014 Intel Corporation - * - * Permission is hereby granted, free of charge, to any person obtaining a - * copy of this software and associated documentation files (the "Software"), - * to deal in the Software without restriction, including without limitation - * the rights to use, copy, modify, merge, publish, distribute, sublicense, - * and/or sell copies of the Software, and to permit persons to whom the - * Software is furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice (including the next - * paragraph) shall be included in all copies or substantial portions of the - * Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL - * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS - * IN THE SOFTWARE. - */ - -#pragma once -#ifndef CACHE_H -#define CACHE_H - -#ifdef __cplusplus -extern "C" { -#endif - -#include -#include - -/* Size of cache keys in bytes. */ -#define CACHE_KEY_SIZE 20 - -typedef uint8_t cache_key[CACHE_KEY_SIZE]; - -/* Provide inlined stub functions if the shader cache is disabled. */ - -#ifdef ENABLE_SHADER_CACHE - -/** - * Create a new cache object. - * - * This function creates the handle necessary for all subsequent cache_* - * functions. - * - * This cache provides two distinct operations: - * - * o Storage and retrieval of arbitrary objects by cryptographic - * name (or "key"). This is provided via cache_put() and - * cache_get(). - * - * o The ability to store a key alone and check later whether the - * key was previously stored. This is provided via cache_put_key() - * and cache_has_key(). - * - * The put_key()/has_key() operations are conceptually identical to - * put()/get() with no data, but are provided separately to allow for - * a more efficient implementation. - * - * In all cases, the keys are sequences of 20 bytes. It is anticipated - * that callers will compute appropriate SHA-1 signatures for keys, - * (though nothing in this implementation directly relies on how the - * names are computed). See mesa-sha1.h and _mesa_sha1_compute for - * assistance in computing SHA-1 signatures. - */ -struct program_cache * -cache_create(void); - -/** - * Destroy a cache object, (freeing all associated resources). - */ -void -cache_destroy(struct program_cache *cache); - -/** - * Store an item in the cache under the name \key. - * - * The item can be retrieved later with cache_get(), (unless the item has - * been evicted in the interim). - * - * Any call to cache_put() may cause an existing, random item to be - * evicted from the cache. - */ -void -cache_put(struct program_cache *cache, cache_key key, - const void *data, size_t size); - -/** - * Retrieve an item previously stored in the cache with the name . - * - * The item must have been previously stored with a call to cache_put(). - * - * If \size is non-NULL, then, on successful return, it will be set to the - * size of the object. - * - * \return A pointer to the stored object if found. NULL if the object - * is not found, or if any error occurs, (memory allocation failure, - * filesystem error, etc.). The returned data is malloc'ed so the - * caller should call free() it when finished. - */ -void * -cache_get(struct program_cache *cache, cache_key key, size_t *size); - -/** - * Store the name \key within the cache, (without any associated data). - * - * Later this key can be checked with cache_has_key(), (unless the key - * has been evicted in the interim). - * - * Any call to cache_record() may cause an existing, random key to be - * evicted from the cache. - */ -void -cache_put_key(struct program_cache *cache, cache_key key); - -/** - * Test whether the name \key was previously recorded in the cache. - * - * Return value: True if cache_put_key() was previously called with - * \key, (and the key was not evicted in the interim). - * - * Note: cache_has_key() will only return true for keys passed to - * cache_put_key(). Specifically, a call to cache_put() will not cause - * cache_has_key() to return true for the same key. - */ -bool -cache_has_key(struct program_cache *cache, cache_key key); - -#else - -static inline struct program_cache * -cache_create(void) -{ - return NULL; -} - -static inline void -cache_destroy(struct program_cache *cache) { - return; -} - -static inline void -cache_put(struct program_cache *cache, cache_key key, - const void *data, size_t size) -{ - return; -} - -static inline uint8_t * -cache_get(struct program_cache *cache, cache_key key, size_t *size) -{ - return NULL; -} - -static inline void -cache_put_key(struct program_cache *cache, cache_key key) -{ - return; -} - -static inline bool -cache_has_key(struct program_cache *cache, cache_key key) -{ - return false; -} - -#endif /* ENABLE_SHADER_CACHE */ - -#ifdef __cplusplus -} -#endif - -#endif /* CACHE_H */ diff --git a/src/compiler/glsl/tests/cache_test.c b/src/compiler/glsl/tests/cache_test.c index 724dfcd7753..94a3c1dfb9e 100644 --- a/src/compiler/glsl/tests/cache_test.c +++ b/src/compiler/glsl/tests/cache_test.c @@ -32,31 +32,11 @@ #include #include "util/mesa-sha1.h" -#include "cache.h" +#include "util/disk_cache.h" bool error = false; #ifdef ENABLE_SHADER_CACHE -void -_mesa_warning(void *ctx, const char *fmt, ...); - -void -_mesa_warning(void *ctx, const char *fmt, ...) -{ - va_list vargs; - (void) ctx; - - va_start(vargs, fmt); - - /* This output is not thread-safe, but that's good enough for the - * standalone compiler. - */ - fprintf(stderr, "Mesa warning: "); - vfprintf(stderr, fmt, vargs); - fprintf(stderr, "\n"); - - va_end(vargs); -} static void expect_equal(uint64_t actual, uint64_t expected, const char *test) diff --git a/src/util/Makefile.sources b/src/util/Makefile.sources index c5531c82d8a..b7ca347f5e8 100644 --- a/src/util/Makefile.sources +++ b/src/util/Makefile.sources @@ -4,6 +4,8 @@ MESA_UTIL_FILES := \ bitset.h \ debug.c \ debug.h \ + disk_cache.c \ + disk_cache.h \ format_r11g11b10f.h \ format_rgb9e5.h \ format_srgb.h \ diff --git a/src/util/disk_cache.c b/src/util/disk_cache.c new file mode 100644 index 00000000000..79242aa3c1e --- /dev/null +++ b/src/util/disk_cache.c @@ -0,0 +1,712 @@ +/* + * Copyright © 2014 Intel Corporation + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice (including the next + * paragraph) shall be included in all copies or substantial portions of the + * Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#ifdef ENABLE_SHADER_CACHE + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "util/u_atomic.h" +#include "util/mesa-sha1.h" +#include "util/ralloc.h" +#include "main/errors.h" + +#include "disk_cache.h" + +/* Number of bits to mask off from a cache key to get an index. */ +#define CACHE_INDEX_KEY_BITS 16 + +/* Mask for computing an index from a key. */ +#define CACHE_INDEX_KEY_MASK ((1 << CACHE_INDEX_KEY_BITS) - 1) + +/* The number of keys that can be stored in the index. */ +#define CACHE_INDEX_MAX_KEYS (1 << CACHE_INDEX_KEY_BITS) + +struct program_cache { + /* The path to the cache directory. */ + char *path; + + /* A pointer to the mmapped index file within the cache directory. */ + uint8_t *index_mmap; + size_t index_mmap_size; + + /* Pointer to total size of all objects in cache (within index_mmap) */ + uint64_t *size; + + /* Pointer to stored keys, (within index_mmap). */ + uint8_t *stored_keys; + + /* Maximum size of all cached objects (in bytes). */ + uint64_t max_size; +}; + +/* Create a directory named 'path' if it does not already exist. + * + * Returns: 0 if path already exists as a directory or if created. + * -1 in all other cases. + */ +static int +mkdir_if_needed(char *path) +{ + struct stat sb; + + /* If the path exists already, then our work is done if it's a + * directory, but it's an error if it is not. + */ + if (stat(path, &sb) == 0) { + if (S_ISDIR(sb.st_mode)) { + return 0; + } else { + fprintf(stderr, "Cannot use %s for shader cache (not a directory)" + "---disabling.\n", path); + return -1; + } + } + + int ret = mkdir(path, 0755); + if (ret == 0 || (ret == -1 && errno == EEXIST)) + return 0; + + fprintf(stderr, "Failed to create %s for shader cache (%s)---disabling.\n", + path, strerror(errno)); + + return -1; +} + +/* Concatenate an existing path and a new name to form a new path. If the new + * path does not exist as a directory, create it then return the resulting + * name of the new path (ralloc'ed off of 'ctx'). + * + * Returns NULL on any error, such as: + * + * does not exist or is not a directory + * / exists but is not a directory + * / cannot be created as a directory + */ +static char * +concatenate_and_mkdir(void *ctx, char *path, char *name) +{ + char *new_path; + struct stat sb; + + if (stat(path, &sb) != 0 || ! S_ISDIR(sb.st_mode)) + return NULL; + + new_path = ralloc_asprintf(ctx, "%s/%s", path, name); + + if (mkdir_if_needed(new_path) == 0) + return new_path; + else + return NULL; +} + +struct program_cache * +cache_create(void) +{ + void *local; + struct program_cache *cache = NULL; + char *path, *max_size_str; + uint64_t max_size; + int fd = -1; + struct stat sb; + size_t size; + + /* A ralloc context for transient data during this invocation. */ + local = ralloc_context(NULL); + if (local == NULL) + goto fail; + + /* At user request, disable shader cache entirely. */ + if (getenv("MESA_GLSL_CACHE_DISABLE")) + goto fail; + + /* Determine path for cache based on the first defined name as follows: + * + * $MESA_GLSL_CACHE_DIR + * $XDG_CACHE_HOME/mesa + * /.cache/mesa + */ + path = getenv("MESA_GLSL_CACHE_DIR"); + if (path && mkdir_if_needed(path) == -1) { + goto fail; + } + + if (path == NULL) { + char *xdg_cache_home = getenv("XDG_CACHE_HOME"); + + if (xdg_cache_home) { + if (mkdir_if_needed(xdg_cache_home) == -1) + goto fail; + + path = concatenate_and_mkdir(local, xdg_cache_home, "mesa"); + if (path == NULL) + goto fail; + } + } + + if (path == NULL) { + char *buf; + size_t buf_size; + struct passwd pwd, *result; + + buf_size = sysconf(_SC_GETPW_R_SIZE_MAX); + if (buf_size == -1) + buf_size = 512; + + /* Loop until buf_size is large enough to query the directory */ + while (1) { + buf = ralloc_size(local, buf_size); + + getpwuid_r(getuid(), &pwd, buf, buf_size, &result); + if (result) + break; + + if (errno == ERANGE) { + ralloc_free(buf); + buf = NULL; + buf_size *= 2; + } else { + goto fail; + } + } + + path = concatenate_and_mkdir(local, pwd.pw_dir, ".cache"); + if (path == NULL) + goto fail; + + path = concatenate_and_mkdir(local, path, "mesa"); + if (path == NULL) + goto fail; + } + + cache = ralloc(NULL, struct program_cache); + if (cache == NULL) + goto fail; + + cache->path = ralloc_strdup(cache, path); + if (cache->path == NULL) + goto fail; + + path = ralloc_asprintf(local, "%s/index", cache->path); + if (path == NULL) + goto fail; + + fd = open(path, O_RDWR | O_CREAT | O_CLOEXEC, 0644); + if (fd == -1) + goto fail; + + if (fstat(fd, &sb) == -1) + goto fail; + + /* Force the index file to be the expected size. */ + size = sizeof(*cache->size) + CACHE_INDEX_MAX_KEYS * CACHE_KEY_SIZE; + if (sb.st_size != size) { + if (ftruncate(fd, size) == -1) + goto fail; + } + + /* We map this shared so that other processes see updates that we + * make. + * + * Note: We do use atomic addition to ensure that multiple + * processes don't scramble the cache size recorded in the + * index. But we don't use any locking to prevent multiple + * processes from updating the same entry simultaneously. The idea + * is that if either result lands entirely in the index, then + * that's equivalent to a well-ordered write followed by an + * eviction and a write. On the other hand, if the simultaneous + * writes result in a corrupt entry, that's not really any + * different than both entries being evicted, (since within the + * guarantees of the cryptographic hash, a corrupt entry is + * unlikely to ever match a real cache key). + */ + cache->index_mmap = mmap(NULL, size, PROT_READ | PROT_WRITE, + MAP_SHARED, fd, 0); + if (cache->index_mmap == MAP_FAILED) + goto fail; + cache->index_mmap_size = size; + + close(fd); + + cache->size = (uint64_t *) cache->index_mmap; + cache->stored_keys = cache->index_mmap + sizeof(uint64_t); + + max_size = 0; + + max_size_str = getenv("MESA_GLSL_CACHE_MAX_SIZE"); + if (max_size_str) { + char *end; + max_size = strtoul(max_size_str, &end, 10); + if (end == max_size_str) { + max_size = 0; + } else { + while (*end && isspace(*end)) + end++; + switch (*end) { + case 'K': + case 'k': + max_size *= 1024; + break; + case 'M': + case 'm': + max_size *= 1024*1024; + break; + case '\0': + case 'G': + case 'g': + default: + max_size *= 1024*1024*1024; + break; + } + } + } + + /* Default to 1GB for maximum cache size. */ + if (max_size == 0) + max_size = 1024*1024*1024; + + cache->max_size = max_size; + + ralloc_free(local); + + return cache; + + fail: + if (fd != -1) + close(fd); + if (cache) + ralloc_free(cache); + ralloc_free(local); + + return NULL; +} + +void +cache_destroy(struct program_cache *cache) +{ + munmap(cache->index_mmap, cache->index_mmap_size); + + ralloc_free(cache); +} + +/* Return a filename within the cache's directory corresponding to 'key'. The + * returned filename is ralloced with 'cache' as the parent context. + * + * Returns NULL if out of memory. + */ +static char * +get_cache_file(struct program_cache *cache, cache_key key) +{ + char buf[41]; + + _mesa_sha1_format(buf, key); + + return ralloc_asprintf(cache, "%s/%c%c/%s", + cache->path, buf[0], buf[1], buf + 2); +} + +/* Create the directory that will be needed for the cache file for \key. + * + * Obviously, the implementation here must closely match + * _get_cache_file above. +*/ +static void +make_cache_file_directory(struct program_cache *cache, cache_key key) +{ + char *dir; + char buf[41]; + + _mesa_sha1_format(buf, key); + + dir = ralloc_asprintf(cache, "%s/%c%c", cache->path, buf[0], buf[1]); + + mkdir_if_needed(dir); + + ralloc_free(dir); +} + +/* Given a directory path and predicate function, count all entries in + * that directory for which the predicate returns true. Then choose a + * random entry from among those counted. + * + * Returns: A malloc'ed string for the path to the chosen file, (or + * NULL on any error). The caller should free the string when + * finished. + */ +static char * +choose_random_file_matching(const char *dir_path, + bool (*predicate)(struct dirent *)) +{ + DIR *dir; + struct dirent *entry; + unsigned int count, victim; + char *filename; + + dir = opendir(dir_path); + if (dir == NULL) + return NULL; + + count = 0; + + while (1) { + entry = readdir(dir); + if (entry == NULL) + break; + if (! predicate(entry)) + continue; + + count++; + } + + if (count == 0) { + closedir(dir); + return NULL; + } + + victim = rand() % count; + + rewinddir(dir); + count = 0; + + while (1) { + entry = readdir(dir); + if (entry == NULL) + break; + if (! predicate(entry)) + continue; + if (count == victim) + break; + + count++; + } + + if (entry == NULL) { + closedir(dir); + return NULL; + } + + if (asprintf(&filename, "%s/%s", dir_path, entry->d_name) < 0) + filename = NULL; + + closedir(dir); + + return filename; +} + +/* Is entry a regular file, and not having a name with a trailing + * ".tmp" + */ +static bool +is_regular_non_tmp_file(struct dirent *entry) +{ + size_t len; + + if (entry->d_type != DT_REG) + return false; + + len = strlen (entry->d_name); + if (len >= 4 && strcmp(&entry->d_name[len-4], ".tmp") == 0) + return false; + + return true; +} + +/* Returns the size of the deleted file, (or 0 on any error). */ +static size_t +unlink_random_file_from_directory(const char *path) +{ + struct stat sb; + char *filename; + + filename = choose_random_file_matching(path, is_regular_non_tmp_file); + if (filename == NULL) + return 0; + + if (stat(filename, &sb) == -1) { + free (filename); + return 0; + } + + unlink(filename); + + free (filename); + + return sb.st_size; +} + +/* Is entry a directory with a two-character name, (and not the + * special name of "..") + */ +static bool +is_two_character_sub_directory(struct dirent *entry) +{ + if (entry->d_type != DT_DIR) + return false; + + if (strlen(entry->d_name) != 2) + return false; + + if (strcmp(entry->d_name, "..") == 0) + return false; + + return true; +} + +static void +evict_random_item(struct program_cache *cache) +{ + const char hex[] = "0123456789abcde"; + char *dir_path; + int a, b; + size_t size; + + /* With a reasonably-sized, full cache, (and with keys generated + * from a cryptographic hash), we can choose two random hex digits + * and reasonably expect the directory to exist with a file in it. + */ + a = rand() % 16; + b = rand() % 16; + + if (asprintf(&dir_path, "%s/%c%c", cache->path, hex[a], hex[b]) < 0) + return; + + size = unlink_random_file_from_directory(dir_path); + + free(dir_path); + + if (size) { + p_atomic_add(cache->size, - size); + return; + } + + /* In the case where the random choice of directory didn't find + * something, we choose randomly from the existing directories. + * + * Really, the only reason this code exists is to allow the unit + * tests to work, (which use an artificially-small cache to be able + * to force a single cached item to be evicted). + */ + dir_path = choose_random_file_matching(cache->path, + is_two_character_sub_directory); + if (dir_path == NULL) + return; + + size = unlink_random_file_from_directory(dir_path); + + free(dir_path); + + if (size) + p_atomic_add(cache->size, - size); +} + +void +cache_put(struct program_cache *cache, + cache_key key, + const void *data, + size_t size) +{ + int fd = -1, fd_final = -1, err, ret; + size_t len; + char *filename = NULL, *filename_tmp = NULL; + const char *p = data; + + filename = get_cache_file(cache, key); + if (filename == NULL) + goto done; + + /* Write to a temporary file to allow for an atomic rename to the + * final destination filename, (to prevent any readers from seeing + * a partially written file). + */ + filename_tmp = ralloc_asprintf(cache, "%s.tmp", filename); + if (filename_tmp == NULL) + goto done; + + fd = open(filename_tmp, O_WRONLY | O_CLOEXEC | O_CREAT, 0644); + + /* Make the two-character subdirectory within the cache as needed. */ + if (fd == -1) { + if (errno != ENOENT) + goto done; + + make_cache_file_directory(cache, key); + + fd = open(filename_tmp, O_WRONLY | O_CLOEXEC | O_CREAT, 0644); + if (fd == -1) + goto done; + } + + /* With the temporary file open, we take an exclusive flock on + * it. If the flock fails, then another process still has the file + * open with the flock held. So just let that file be responsible + * for writing the file. + */ + err = flock(fd, LOCK_EX | LOCK_NB); + if (err == -1) + goto done; + + /* Now that we have the lock on the open temporary file, we can + * check to see if the destination file already exists. If so, + * another process won the race between when we saw that the file + * didn't exist and now. In this case, we don't do anything more, + * (to ensure the size accounting of the cache doesn't get off). + */ + fd_final = open(filename, O_RDONLY | O_CLOEXEC); + if (fd_final != -1) + goto done; + + /* OK, we're now on the hook to write out a file that we know is + * not in the cache, and is also not being written out to the cache + * by some other process. + * + * Before we do that, if the cache is too large, evict something + * else first. + */ + if (*cache->size + size > cache->max_size) + evict_random_item(cache); + + /* Now, finally, write out the contents to the temporary file, then + * rename them atomically to the destination filename, and also + * perform an atomic increment of the total cache size. + */ + for (len = 0; len < size; len += ret) { + ret = write(fd, p + len, size - len); + if (ret == -1) { + unlink(filename_tmp); + goto done; + } + } + + rename(filename_tmp, filename); + + p_atomic_add(cache->size, size); + + /* This close finally releases the flock, (now that the final dile + * has been renamed into place and the size has been added). + */ + close(fd); + fd = -1; + + done: + if (filename_tmp) + ralloc_free(filename_tmp); + if (filename) + ralloc_free(filename); + if (fd != -1) + close(fd); +} + +void * +cache_get(struct program_cache *cache, cache_key key, size_t *size) +{ + int fd = -1, ret, len; + struct stat sb; + char *filename = NULL; + uint8_t *data = NULL; + + if (size) + *size = 0; + + filename = get_cache_file(cache, key); + if (filename == NULL) + goto fail; + + fd = open(filename, O_RDONLY | O_CLOEXEC); + if (fd == -1) + goto fail; + + if (fstat(fd, &sb) == -1) + goto fail; + + data = malloc(sb.st_size); + if (data == NULL) + goto fail; + + for (len = 0; len < sb.st_size; len += ret) { + ret = read(fd, data + len, sb.st_size - len); + if (ret == -1) + goto fail; + } + + ralloc_free(filename); + close(fd); + + if (size) + *size = sb.st_size; + + return data; + + fail: + if (data) + free(data); + if (filename) + ralloc_free(filename); + if (fd != -1) + close(fd); + + return NULL; +} + +void +cache_put_key(struct program_cache *cache, cache_key key) +{ + uint32_t *key_chunk = (uint32_t *) key; + int i = *key_chunk & CACHE_INDEX_KEY_MASK; + unsigned char *entry; + + entry = &cache->stored_keys[i + CACHE_KEY_SIZE]; + + memcpy(entry, key, CACHE_KEY_SIZE); +} + +/* This function lets us test whether a given key was previously + * stored in the cache with cache_put_key(). The implement is + * efficient by not using syscalls or hitting the disk. It's not + * race-free, but the races are benign. If we race with someone else + * calling cache_put_key, then that's just an extra cache miss and an + * extra recompile. + */ +bool +cache_has_key(struct program_cache *cache, cache_key key) +{ + uint32_t *key_chunk = (uint32_t *) key; + int i = *key_chunk & CACHE_INDEX_KEY_MASK; + unsigned char *entry; + + entry = &cache->stored_keys[i + CACHE_KEY_SIZE]; + + return memcmp(entry, key, CACHE_KEY_SIZE) == 0; +} + +#endif diff --git a/src/util/disk_cache.h b/src/util/disk_cache.h new file mode 100644 index 00000000000..d4d939883e6 --- /dev/null +++ b/src/util/disk_cache.h @@ -0,0 +1,176 @@ +/* + * Copyright © 2014 Intel Corporation + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice (including the next + * paragraph) shall be included in all copies or substantial portions of the + * Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#ifndef DISK_CACHE_H +#define DISK_CACHE_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Size of cache keys in bytes. */ +#define CACHE_KEY_SIZE 20 + +typedef uint8_t cache_key[CACHE_KEY_SIZE]; + +/* Provide inlined stub functions if the shader cache is disabled. */ + +#ifdef ENABLE_SHADER_CACHE + +/** + * Create a new cache object. + * + * This function creates the handle necessary for all subsequent cache_* + * functions. + * + * This cache provides two distinct operations: + * + * o Storage and retrieval of arbitrary objects by cryptographic + * name (or "key"). This is provided via cache_put() and + * cache_get(). + * + * o The ability to store a key alone and check later whether the + * key was previously stored. This is provided via cache_put_key() + * and cache_has_key(). + * + * The put_key()/has_key() operations are conceptually identical to + * put()/get() with no data, but are provided separately to allow for + * a more efficient implementation. + * + * In all cases, the keys are sequences of 20 bytes. It is anticipated + * that callers will compute appropriate SHA-1 signatures for keys, + * (though nothing in this implementation directly relies on how the + * names are computed). See mesa-sha1.h and _mesa_sha1_compute for + * assistance in computing SHA-1 signatures. + */ +struct program_cache * +cache_create(void); + +/** + * Destroy a cache object, (freeing all associated resources). + */ +void +cache_destroy(struct program_cache *cache); + +/** + * Store an item in the cache under the name \key. + * + * The item can be retrieved later with cache_get(), (unless the item has + * been evicted in the interim). + * + * Any call to cache_put() may cause an existing, random item to be + * evicted from the cache. + */ +void +cache_put(struct program_cache *cache, cache_key key, + const void *data, size_t size); + +/** + * Retrieve an item previously stored in the cache with the name . + * + * The item must have been previously stored with a call to cache_put(). + * + * If \size is non-NULL, then, on successful return, it will be set to the + * size of the object. + * + * \return A pointer to the stored object if found. NULL if the object + * is not found, or if any error occurs, (memory allocation failure, + * filesystem error, etc.). The returned data is malloc'ed so the + * caller should call free() it when finished. + */ +void * +cache_get(struct program_cache *cache, cache_key key, size_t *size); + +/** + * Store the name \key within the cache, (without any associated data). + * + * Later this key can be checked with cache_has_key(), (unless the key + * has been evicted in the interim). + * + * Any call to cache_record() may cause an existing, random key to be + * evicted from the cache. + */ +void +cache_put_key(struct program_cache *cache, cache_key key); + +/** + * Test whether the name \key was previously recorded in the cache. + * + * Return value: True if cache_put_key() was previously called with + * \key, (and the key was not evicted in the interim). + * + * Note: cache_has_key() will only return true for keys passed to + * cache_put_key(). Specifically, a call to cache_put() will not cause + * cache_has_key() to return true for the same key. + */ +bool +cache_has_key(struct program_cache *cache, cache_key key); + +#else + +static inline struct program_cache * +cache_create(void) +{ + return NULL; +} + +static inline void +cache_destroy(struct program_cache *cache) { + return; +} + +static inline void +cache_put(struct program_cache *cache, cache_key key, + const void *data, size_t size) +{ + return; +} + +static inline uint8_t * +cache_get(struct program_cache *cache, cache_key key, size_t *size) +{ + return NULL; +} + +static inline void +cache_put_key(struct program_cache *cache, cache_key key) +{ + return; +} + +static inline bool +cache_has_key(struct program_cache *cache, cache_key key) +{ + return false; +} + +#endif /* ENABLE_SHADER_CACHE */ + +#ifdef __cplusplus +} +#endif + +#endif /* CACHE_H */