#include <sys/file.h>
#include <sys/types.h>
#include <sys/stat.h>
-#include <sys/statvfs.h>
#include <sys/mman.h>
#include <unistd.h>
#include <fcntl.h>
#include "zlib.h"
#include "util/crc32.h"
+#include "util/rand_xor.h"
#include "util/u_atomic.h"
#include "util/u_queue.h"
#include "util/mesa-sha1.h"
#include "util/ralloc.h"
#include "main/errors.h"
-#include "util/macros.h"
#include "disk_cache.h"
/* The number of keys that can be stored in the index. */
#define CACHE_INDEX_MAX_KEYS (1 << CACHE_INDEX_KEY_BITS)
+/* The cache version should be bumped whenever a change is made to the
+ * structure of cache entries or the index. This will give any 3rd party
+ * applications reading the cache entries a chance to adjust to the changes.
+ *
+ * - The cache version is checked internally when reading a cache entry. If we
+ * ever have a mismatch we are in big trouble as this means we had a cache
+ * collision. In case of such an event please check the skys for giant
+ * asteroids and that the entire Mesa team hasn't been eaten by wolves.
+ *
+ * - There is no strict requirement that cache versions be backwards
+ * compatible but effort should be taken to limit disruption where possible.
+ */
+#define CACHE_VERSION 1
+
struct disk_cache {
/* The path to the cache directory. */
char *path;
/* Thread queue for compressing and writing cache entries to disk */
struct util_queue cache_queue;
+ /* Seed for rand, which is used to pick a random directory */
+ uint64_t seed_xorshift128plus[2];
+
/* A pointer to the mmapped index file within the cache directory. */
uint8_t *index_mmap;
size_t index_mmap_size;
/* Maximum size of all cached objects (in bytes). */
uint64_t max_size;
+
+ /* Driver cache keys. */
+ uint8_t *driver_keys_blob;
+ size_t driver_keys_blob_size;
};
struct disk_cache_put_job {
/* Size of data to be compressed and written. */
size_t size;
+
+ struct cache_item_metadata cache_item_metadata;
};
/* Create a directory named 'path' if it does not already exist.
return NULL;
}
-static int
-remove_dir(const char *fpath, const struct stat *sb,
- int typeflag, struct FTW *ftwbuf)
-{
- if (S_ISREG(sb->st_mode))
- unlink(fpath);
- else if (S_ISDIR(sb->st_mode))
- rmdir(fpath);
-
- return 0;
-}
-
-static void
-remove_old_cache_directories(void *mem_ctx, const char *path,
- const char *timestamp)
-{
- DIR *dir = opendir(path);
-
- struct dirent* d_entry;
- while((d_entry = readdir(dir)) != NULL)
- {
- char *full_path =
- ralloc_asprintf(mem_ctx, "%s/%s", path, d_entry->d_name);
-
- struct stat sb;
- if (stat(full_path, &sb) == 0 && S_ISDIR(sb.st_mode) &&
- strcmp(d_entry->d_name, timestamp) != 0 &&
- strcmp(d_entry->d_name, "..") != 0 &&
- strcmp(d_entry->d_name, ".") != 0) {
- nftw(full_path, remove_dir, 20, FTW_DEPTH);
- }
- }
-
- closedir(dir);
-}
-
-static char *
-create_mesa_cache_dir(void *mem_ctx, const char *path, const char *timestamp,
- const char *gpu_name)
-{
- char *new_path = concatenate_and_mkdir(mem_ctx, path, "mesa");
- if (new_path == NULL)
- return NULL;
-
- /* Create a parent architecture directory so that we don't remove cache
- * files for other architectures. In theory we could share the cache
- * between architectures but we have no way of knowing if they were created
- * by a compatible Mesa version.
- */
- new_path = concatenate_and_mkdir(mem_ctx, new_path, get_arch_bitness_str());
- if (new_path == NULL)
- return NULL;
-
- /* Remove cache directories for old Mesa versions */
- remove_old_cache_directories(mem_ctx, new_path, timestamp);
-
- new_path = concatenate_and_mkdir(mem_ctx, new_path, timestamp);
- if (new_path == NULL)
- return NULL;
-
- new_path = concatenate_and_mkdir(mem_ctx, new_path, gpu_name);
- if (new_path == NULL)
- return NULL;
-
- return new_path;
-}
+#define DRV_KEY_CPY(_dst, _src, _src_size) \
+do { \
+ memcpy(_dst, _src, _src_size); \
+ _dst += _src_size; \
+} while (0);
struct disk_cache *
-disk_cache_create(const char *gpu_name, const char *timestamp)
+disk_cache_create(const char *gpu_name, const char *timestamp,
+ uint64_t driver_flags)
{
void *local;
struct disk_cache *cache = NULL;
uint64_t max_size;
int fd = -1;
struct stat sb;
- struct statvfs vfs = { 0 };
size_t size;
/* If running as a users other than the real user disable cache */
/* Determine path for cache based on the first defined name as follows:
*
* $MESA_GLSL_CACHE_DIR
- * $XDG_CACHE_HOME/mesa
- * <pwd.pw_dir>/.cache/mesa
+ * $XDG_CACHE_HOME/mesa_shader_cache
+ * <pwd.pw_dir>/.cache/mesa_shader_cache
*/
path = getenv("MESA_GLSL_CACHE_DIR");
if (path) {
if (mkdir_if_needed(path) == -1)
goto fail;
- path = create_mesa_cache_dir(local, path, timestamp,
- gpu_name);
+ path = concatenate_and_mkdir(local, path, CACHE_DIR_NAME);
if (path == NULL)
goto fail;
}
if (mkdir_if_needed(xdg_cache_home) == -1)
goto fail;
- path = create_mesa_cache_dir(local, xdg_cache_home, timestamp,
- gpu_name);
+ path = concatenate_and_mkdir(local, xdg_cache_home, CACHE_DIR_NAME);
if (path == NULL)
goto fail;
}
if (path == NULL)
goto fail;
- path = create_mesa_cache_dir(local, path, timestamp, gpu_name);
+ path = concatenate_and_mkdir(local, path, CACHE_DIR_NAME);
if (path == NULL)
goto fail;
}
}
}
- /* Default to 1GB or 10% of filesystem for maximum cache size. */
+ /* Default to 1GB for maximum cache size. */
if (max_size == 0) {
- statvfs(path, &vfs);
- max_size = MAX2(1024*1024*1024, vfs.f_blocks * vfs.f_bsize / 10);
+ max_size = 1024*1024*1024;
}
cache->max_size = max_size;
* really care about getting things to disk quickly just that it's not
* blocking other tasks.
*/
- util_queue_init(&cache->cache_queue, "disk_cache", 32, 1);
+ util_queue_init(&cache->cache_queue, "disk_cache", 32, 1, 0);
+
+ uint8_t cache_version = CACHE_VERSION;
+ size_t cv_size = sizeof(cache_version);
+ cache->driver_keys_blob_size = cv_size;
+
+ /* Create driver id keys */
+ size_t ts_size = strlen(timestamp) + 1;
+ size_t gpu_name_size = strlen(gpu_name) + 1;
+ cache->driver_keys_blob_size += ts_size;
+ cache->driver_keys_blob_size += gpu_name_size;
+
+ /* We sometimes store entire structs that contains a pointers in the cache,
+ * use pointer size as a key to avoid hard to debug issues.
+ */
+ uint8_t ptr_size = sizeof(void *);
+ size_t ptr_size_size = sizeof(ptr_size);
+ cache->driver_keys_blob_size += ptr_size_size;
+
+ size_t driver_flags_size = sizeof(driver_flags);
+ cache->driver_keys_blob_size += driver_flags_size;
+
+ cache->driver_keys_blob =
+ ralloc_size(cache, cache->driver_keys_blob_size);
+ if (!cache->driver_keys_blob)
+ goto fail;
+
+ uint8_t *drv_key_blob = cache->driver_keys_blob;
+ DRV_KEY_CPY(drv_key_blob, &cache_version, cv_size)
+ DRV_KEY_CPY(drv_key_blob, timestamp, ts_size)
+ DRV_KEY_CPY(drv_key_blob, gpu_name, gpu_name_size)
+ DRV_KEY_CPY(drv_key_blob, &ptr_size, ptr_size_size)
+ DRV_KEY_CPY(drv_key_blob, &driver_flags, driver_flags_size)
+
+ /* Seed our rand function */
+ s_rand_xorshift128plus(cache->seed_xorshift128plus, true);
ralloc_free(local);
unlink(filename);
free (filename);
- return sb.st_size;
+ return sb.st_blocks * 512;
}
/* Is entry a directory with a two-character name, (and not the
static void
evict_lru_item(struct disk_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.
* Provides pseudo-LRU eviction to reduce checking all cache files.
*/
- a = rand() % 16;
- b = rand() % 16;
-
- if (asprintf(&dir_path, "%s/%c%c", cache->path, hex[a], hex[b]) < 0)
+ uint64_t rand64 = rand_xorshift128plus(cache->seed_xorshift128plus);
+ if (asprintf(&dir_path, "%s/%02" PRIx64 , cache->path, rand64 & 0xff) < 0)
return;
- size = unlink_lru_file_from_directory(dir_path);
+ size_t size = unlink_lru_file_from_directory(dir_path);
free(dir_path);
unlink(filename);
free(filename);
- if (sb.st_size)
- p_atomic_add(cache->size, - (uint64_t)sb.st_size);
+ if (sb.st_blocks)
+ p_atomic_add(cache->size, - (uint64_t)sb.st_blocks * 512);
+}
+
+static ssize_t
+read_all(int fd, void *buf, size_t count)
+{
+ char *in = buf;
+ ssize_t read_ret;
+ size_t done;
+
+ for (done = 0; done < count; done += read_ret) {
+ read_ret = read(fd, in + done, count - done);
+ if (read_ret == -1 || read_ret == 0)
+ return -1;
+ }
+ return done;
+}
+
+static ssize_t
+write_all(int fd, const void *buf, size_t count)
+{
+ const char *out = buf;
+ ssize_t written;
+ size_t done;
+
+ for (done = 0; done < count; done += written) {
+ written = write(fd, out + done, count - done);
+ if (written == -1)
+ return -1;
+ }
+ return done;
}
/* From the zlib docs:
size_t have = BUFSIZE - strm.avail_out;
compressed_size += have;
- size_t written = 0;
- for (size_t len = 0; len < have; len += written) {
- written = write(dest, out + len, have - len);
- if (written == -1) {
- (void)deflateEnd(&strm);
- return 0;
- }
+ ssize_t written = write_all(dest, out, have);
+ if (written == -1) {
+ (void)deflateEnd(&strm);
+ return 0;
}
} while (strm.avail_out == 0);
static struct disk_cache_put_job *
create_put_job(struct disk_cache *cache, const cache_key key,
- const void *data, size_t size)
+ const void *data, size_t size,
+ struct cache_item_metadata *cache_item_metadata)
{
struct disk_cache_put_job *dc_job = (struct disk_cache_put_job *)
malloc(sizeof(struct disk_cache_put_job) + size);
dc_job->data = dc_job + 1;
memcpy(dc_job->data, data, size);
dc_job->size = size;
+
+ /* Copy the cache item metadata */
+ if (cache_item_metadata) {
+ dc_job->cache_item_metadata.type = cache_item_metadata->type;
+ if (cache_item_metadata->type == CACHE_ITEM_TYPE_GLSL) {
+ dc_job->cache_item_metadata.num_keys =
+ cache_item_metadata->num_keys;
+ dc_job->cache_item_metadata.keys = (cache_key *)
+ malloc(cache_item_metadata->num_keys * sizeof(cache_key));
+
+ if (!dc_job->cache_item_metadata.keys)
+ goto fail;
+
+ memcpy(dc_job->cache_item_metadata.keys,
+ cache_item_metadata->keys,
+ sizeof(cache_key) * cache_item_metadata->num_keys);
+ }
+ } else {
+ dc_job->cache_item_metadata.type = CACHE_ITEM_TYPE_UNKNOWN;
+ dc_job->cache_item_metadata.keys = NULL;
+ }
}
return dc_job;
+
+fail:
+ free(dc_job->cache_item_metadata.keys);
+ free(dc_job);
+
+ return NULL;
}
static void
destroy_put_job(void *job, int thread_index)
{
if (job) {
+ struct disk_cache_put_job *dc_job = (struct disk_cache_put_job *) job;
+ free(dc_job->cache_item_metadata.keys);
+
free(job);
}
}
int fd = -1, fd_final = -1, err, ret;
unsigned i = 0;
- size_t len;
char *filename = NULL, *filename_tmp = NULL;
struct disk_cache_put_job *dc_job = (struct disk_cache_put_job *) job;
* (to ensure the size accounting of the cache doesn't get off).
*/
fd_final = open(filename, O_RDONLY | O_CLOEXEC);
- if (fd_final != -1)
+ if (fd_final != -1) {
+ unlink(filename_tmp);
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.
- *
- * Create CRC of the data and store at the start of the file. We will
- * read this when restoring the cache and use it to check for corruption.
*/
- struct cache_entry_file_data cf_data;
- cf_data.crc32 = util_hash_crc32(dc_job->data, dc_job->size);
- cf_data.uncompressed_size = dc_job->size;
- size_t cf_data_size = sizeof(cf_data);
- for (len = 0; len < cf_data_size; len += ret) {
- ret = write(fd, ((uint8_t *) &cf_data) + len, cf_data_size - len);
+ /* Write the driver_keys_blob, this can be used find information about the
+ * mesa version that produced the entry or deal with hash collisions,
+ * should that ever become a real problem.
+ */
+ ret = write_all(fd, dc_job->cache->driver_keys_blob,
+ dc_job->cache->driver_keys_blob_size);
+ if (ret == -1) {
+ unlink(filename_tmp);
+ goto done;
+ }
+
+ /* Write the cache item metadata. This data can be used to deal with
+ * hash collisions, as well as providing useful information to 3rd party
+ * tools reading the cache files.
+ */
+ ret = write_all(fd, &dc_job->cache_item_metadata.type,
+ sizeof(uint32_t));
+ if (ret == -1) {
+ unlink(filename_tmp);
+ goto done;
+ }
+
+ if (dc_job->cache_item_metadata.type == CACHE_ITEM_TYPE_GLSL) {
+ ret = write_all(fd, &dc_job->cache_item_metadata.num_keys,
+ sizeof(uint32_t));
+ if (ret == -1) {
+ unlink(filename_tmp);
+ goto done;
+ }
+
+ ret = write_all(fd, dc_job->cache_item_metadata.keys[0],
+ dc_job->cache_item_metadata.num_keys *
+ sizeof(cache_key));
if (ret == -1) {
unlink(filename_tmp);
goto done;
}
}
+ /* Create CRC of the data. We will read this when restoring the cache and
+ * use it to check for corruption.
+ */
+ struct cache_entry_file_data cf_data;
+ cf_data.crc32 = util_hash_crc32(dc_job->data, dc_job->size);
+ cf_data.uncompressed_size = dc_job->size;
+
+ size_t cf_data_size = sizeof(cf_data);
+ ret = write_all(fd, &cf_data, cf_data_size);
+ if (ret == -1) {
+ unlink(filename_tmp);
+ goto done;
+ }
+
/* 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.
unlink(filename_tmp);
goto done;
}
- rename(filename_tmp, filename);
+ ret = rename(filename_tmp, filename);
+ if (ret == -1) {
+ unlink(filename_tmp);
+ goto done;
+ }
- file_size += cf_data_size;
- p_atomic_add(dc_job->cache->size, file_size);
+ struct stat sb;
+ if (stat(filename, &sb) == -1) {
+ /* Something went wrong remove the file */
+ unlink(filename);
+ goto done;
+ }
+
+ p_atomic_add(dc_job->cache->size, sb.st_blocks * 512);
done:
if (fd_final != -1)
close(fd_final);
- /* This close finally releases the flock, (now that the final dile
+ /* This close finally releases the flock, (now that the final file
* has been renamed into place and the size has been added).
*/
if (fd != -1)
void
disk_cache_put(struct disk_cache *cache, const cache_key key,
- const void *data, size_t size)
+ const void *data, size_t size,
+ struct cache_item_metadata *cache_item_metadata)
{
struct disk_cache_put_job *dc_job =
- create_put_job(cache, key, data, size);
+ create_put_job(cache, key, data, size, cache_item_metadata);
if (dc_job) {
util_queue_fence_init(&dc_job->fence);
void *
disk_cache_get(struct disk_cache *cache, const cache_key key, size_t *size)
{
- int fd = -1, ret, len;
+ int fd = -1, ret;
struct stat sb;
char *filename = NULL;
uint8_t *data = NULL;
uint8_t *uncompressed_data = NULL;
+ uint8_t *file_header = NULL;
if (size)
*size = 0;
if (data == NULL)
goto fail;
- /* Load the CRC that was created when the file was written. */
- struct cache_entry_file_data cf_data;
- size_t cf_data_size = sizeof(cf_data);
- assert(sb.st_size > cf_data_size);
- for (len = 0; len < cf_data_size; len += ret) {
- ret = read(fd, ((uint8_t *) &cf_data) + len, cf_data_size - len);
+ size_t ck_size = cache->driver_keys_blob_size;
+ file_header = malloc(ck_size);
+ if (!file_header)
+ goto fail;
+
+ if (sb.st_size < ck_size)
+ goto fail;
+
+ ret = read_all(fd, file_header, ck_size);
+ if (ret == -1)
+ goto fail;
+
+ /* Check for extremely unlikely hash collisions */
+ if (memcmp(cache->driver_keys_blob, file_header, ck_size) != 0) {
+ assert(!"Mesa cache keys mismatch!");
+ goto fail;
+ }
+
+ size_t cache_item_md_size = sizeof(uint32_t);
+ uint32_t md_type;
+ ret = read_all(fd, &md_type, cache_item_md_size);
+ if (ret == -1)
+ goto fail;
+
+ if (md_type == CACHE_ITEM_TYPE_GLSL) {
+ uint32_t num_keys;
+ cache_item_md_size += sizeof(uint32_t);
+ ret = read_all(fd, &num_keys, sizeof(uint32_t));
if (ret == -1)
goto fail;
- }
- /* Load the actual cache data. */
- size_t cache_data_size = sb.st_size - cf_data_size;
- for (len = 0; len < cache_data_size; len += ret) {
- ret = read(fd, data + len, cache_data_size - len);
+ /* The cache item metadata is currently just used for distributing
+ * precompiled shaders, they are not used by Mesa so just skip them for
+ * now.
+ * TODO: pass the metadata back to the caller and do some basic
+ * validation.
+ */
+ cache_item_md_size += sizeof(cache_key);
+ ret = lseek(fd, num_keys * sizeof(cache_key), SEEK_CUR);
if (ret == -1)
goto fail;
}
+ /* Load the CRC that was created when the file was written. */
+ struct cache_entry_file_data cf_data;
+ size_t cf_data_size = sizeof(cf_data);
+ ret = read_all(fd, &cf_data, cf_data_size);
+ if (ret == -1)
+ goto fail;
+
+ /* Load the actual cache data. */
+ size_t cache_data_size =
+ sb.st_size - cf_data_size - ck_size - cache_item_md_size;
+ ret = read_all(fd, data, cache_data_size);
+ if (ret == -1)
+ goto fail;
+
/* Uncompress the cache data */
uncompressed_data = malloc(cf_data.uncompressed_size);
if (!inflate_cache_data(data, cache_data_size, uncompressed_data,
free(uncompressed_data);
if (filename)
free(filename);
+ if (file_header)
+ free(file_header);
if (fd != -1)
close(fd);
int i = *key_chunk & CACHE_INDEX_KEY_MASK;
unsigned char *entry;
- entry = &cache->stored_keys[i + CACHE_KEY_SIZE];
+ entry = &cache->stored_keys[i * CACHE_KEY_SIZE];
memcpy(entry, key, CACHE_KEY_SIZE);
}
int i = *key_chunk & CACHE_INDEX_KEY_MASK;
unsigned char *entry;
- entry = &cache->stored_keys[i + CACHE_KEY_SIZE];
+ entry = &cache->stored_keys[i * CACHE_KEY_SIZE];
return memcmp(entry, key, CACHE_KEY_SIZE) == 0;
}
+void
+disk_cache_compute_key(struct disk_cache *cache, const void *data, size_t size,
+ cache_key key)
+{
+ struct mesa_sha1 ctx;
+
+ _mesa_sha1_init(&ctx);
+ _mesa_sha1_update(&ctx, cache->driver_keys_blob,
+ cache->driver_keys_blob_size);
+ _mesa_sha1_update(&ctx, data, size);
+ _mesa_sha1_final(&ctx, key);
+}
+
#endif /* ENABLE_SHADER_CACHE */
projects / mesa.git / blobdiff