#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"
/* 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 {
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;
-}
-
struct disk_cache *
disk_cache_create(const char *gpu_name, const char *timestamp)
{
if (mkdir_if_needed(path) == -1)
goto fail;
- path = create_mesa_cache_dir(local, path, timestamp,
- gpu_name);
+ path = concatenate_and_mkdir(local, path, "mesa");
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, "mesa");
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, "mesa");
if (path == NULL)
goto fail;
}
*/
util_queue_init(&cache->cache_queue, "disk_cache", 32, 1);
+ /* 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;
+
+ cache->driver_keys_blob =
+ ralloc_size(cache, cache->driver_keys_blob_size);
+ if (!cache->driver_keys_blob)
+ goto fail;
+
+ memcpy(cache->driver_keys_blob, timestamp, ts_size);
+ memcpy(cache->driver_keys_blob + ts_size, gpu_name, gpu_name_size);
+ memcpy(cache->driver_keys_blob + ts_size + gpu_name_size, &ptr_size,
+ ptr_size_size);
+
+ /* Seed our rand function */
+ s_rand_xorshift128plus(cache->seed_xorshift128plus, true);
+
ralloc_free(local);
return cache;
*/
static char *
choose_lru_file_matching(const char *dir_path,
- bool (*predicate)(const struct dirent *,
- const char *dir_path))
+ bool (*predicate)(const char *dir_path,
+ const struct stat *,
+ const char *, const size_t))
{
DIR *dir;
struct dirent *entry;
entry = readdir(dir);
if (entry == NULL)
break;
- if (!predicate(entry, dir_path))
- continue;
struct stat sb;
if (fstatat(dirfd(dir), entry->d_name, &sb, 0) == 0) {
if (!lru_atime || (sb.st_atime < lru_atime)) {
- size_t len = strlen(entry->d_name) + 1;
- char *tmp = realloc(lru_name, len);
+ size_t len = strlen(entry->d_name);
+
+ if (!predicate(dir_path, &sb, entry->d_name, len))
+ continue;
+
+ char *tmp = realloc(lru_name, len + 1);
if (tmp) {
lru_name = tmp;
- memcpy(lru_name, entry->d_name, len);
+ memcpy(lru_name, entry->d_name, len + 1);
lru_atime = sb.st_atime;
}
}
* ".tmp"
*/
static bool
-is_regular_non_tmp_file(const struct dirent *entry, const char *path)
+is_regular_non_tmp_file(const char *path, const struct stat *sb,
+ const char *d_name, const size_t len)
{
- char *filename;
- if (asprintf(&filename, "%s/%s", path, entry->d_name) == -1)
+ if (!S_ISREG(sb->st_mode))
return false;
- struct stat sb;
- int res = stat(filename, &sb);
- free(filename);
-
- if (res == -1 || !S_ISREG(sb.st_mode))
- return false;
-
- size_t len = strlen (entry->d_name);
- if (len >= 4 && strcmp(&entry->d_name[len-4], ".tmp") == 0)
+ if (len >= 4 && strcmp(&d_name[len-4], ".tmp") == 0)
return false;
return true;
* special name of ".."). We also return false if the dir is empty.
*/
static bool
-is_two_character_sub_directory(const struct dirent *entry, const char *path)
+is_two_character_sub_directory(const char *path, const struct stat *sb,
+ const char *d_name, const size_t len)
{
- char *subdir;
- if (asprintf(&subdir, "%s/%s", path, entry->d_name) == -1)
+ if (!S_ISDIR(sb->st_mode))
return false;
- struct stat sb;
- int res = stat(subdir, &sb);
- if (res == -1 || !S_ISDIR(sb.st_mode)) {
- free(subdir);
+ if (len != 2)
return false;
- }
- if (strlen(entry->d_name) != 2) {
- free(subdir);
+ if (strcmp(d_name, "..") == 0)
return false;
- }
- if (strcmp(entry->d_name, "..") == 0) {
- free(subdir);
+ char *subdir;
+ if (asprintf(&subdir, "%s/%s", path, d_name) == -1)
return false;
- }
-
DIR *dir = opendir(subdir);
free(subdir);
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);
p_atomic_add(cache->size, - (uint64_t)sb.st_size);
}
+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:
* "If the memory is available, buffers sizes on the order of 128K or 256K
* bytes should be used."
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);
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.
+ */
+
+ /* 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;
+ }
+
+ /* 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);
- for (len = 0; len < cf_data_size; len += ret) {
- ret = write(fd, ((uint8_t *) &cf_data) + len, cf_data_size - len);
- if (ret == -1) {
- unlink(filename_tmp);
- goto done;
- }
+ 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
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;
+ file_size += cf_data_size + dc_job->cache->driver_keys_blob_size;
p_atomic_add(dc_job->cache->size, file_size);
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_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;
if (data == NULL)
goto fail;
+ size_t ck_size = cache->driver_keys_blob_size;
+#ifndef NDEBUG
+ uint8_t *file_header = malloc(ck_size);
+ if (!file_header)
+ goto fail;
+
+ assert(sb.st_size > ck_size);
+ ret = read_all(fd, file_header, ck_size);
+ if (ret == -1) {
+ free(file_header);
+ goto fail;
+ }
+
+ assert(memcmp(cache->driver_keys_blob, file_header, ck_size) == 0);
+
+ free(file_header);
+#else
+ /* The cache keys are currently just used for distributing precompiled
+ * shaders, they are not used by Mesa so just skip them for now.
+ */
+ ret = lseek(fd, ck_size, SEEK_CUR);
+ if (ret == -1)
+ goto fail;
+#endif
+
/* 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);
- if (ret == -1)
- goto fail;
- }
+ 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;
- for (len = 0; len < cache_data_size; len += ret) {
- ret = read(fd, data + len, cache_data_size - len);
- if (ret == -1)
- goto fail;
- }
+ size_t cache_data_size = sb.st_size - cf_data_size - ck_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);
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 */