2 * Copyright © 2014 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 #ifdef ENABLE_SHADER_CACHE
32 #include <sys/types.h>
47 #include "util/crc32.h"
48 #include "util/debug.h"
49 #include "util/rand_xor.h"
50 #include "util/u_atomic.h"
51 #include "util/u_queue.h"
52 #include "util/mesa-sha1.h"
53 #include "util/ralloc.h"
54 #include "util/compiler.h"
56 #include "disk_cache.h"
58 /* Number of bits to mask off from a cache key to get an index. */
59 #define CACHE_INDEX_KEY_BITS 16
61 /* Mask for computing an index from a key. */
62 #define CACHE_INDEX_KEY_MASK ((1 << CACHE_INDEX_KEY_BITS) - 1)
64 /* The number of keys that can be stored in the index. */
65 #define CACHE_INDEX_MAX_KEYS (1 << CACHE_INDEX_KEY_BITS)
67 /* The cache version should be bumped whenever a change is made to the
68 * structure of cache entries or the index. This will give any 3rd party
69 * applications reading the cache entries a chance to adjust to the changes.
71 * - The cache version is checked internally when reading a cache entry. If we
72 * ever have a mismatch we are in big trouble as this means we had a cache
73 * collision. In case of such an event please check the skys for giant
74 * asteroids and that the entire Mesa team hasn't been eaten by wolves.
76 * - There is no strict requirement that cache versions be backwards
77 * compatible but effort should be taken to limit disruption where possible.
79 #define CACHE_VERSION 1
81 /* 3 is the recomended level, with 22 as the absolute maximum */
82 #define ZSTD_COMPRESSION_LEVEL 3
85 /* The path to the cache directory. */
87 bool path_init_failed
;
89 /* Thread queue for compressing and writing cache entries to disk */
90 struct util_queue cache_queue
;
92 /* Seed for rand, which is used to pick a random directory */
93 uint64_t seed_xorshift128plus
[2];
95 /* A pointer to the mmapped index file within the cache directory. */
97 size_t index_mmap_size
;
99 /* Pointer to total size of all objects in cache (within index_mmap) */
102 /* Pointer to stored keys, (within index_mmap). */
103 uint8_t *stored_keys
;
105 /* Maximum size of all cached objects (in bytes). */
108 /* Driver cache keys. */
109 uint8_t *driver_keys_blob
;
110 size_t driver_keys_blob_size
;
112 disk_cache_put_cb blob_put_cb
;
113 disk_cache_get_cb blob_get_cb
;
116 struct disk_cache_put_job
{
117 struct util_queue_fence fence
;
119 struct disk_cache
*cache
;
123 /* Copy of cache data to be compressed and written. */
126 /* Size of data to be compressed and written. */
129 struct cache_item_metadata cache_item_metadata
;
132 /* Create a directory named 'path' if it does not already exist.
134 * Returns: 0 if path already exists as a directory or if created.
135 * -1 in all other cases.
138 mkdir_if_needed(const char *path
)
142 /* If the path exists already, then our work is done if it's a
143 * directory, but it's an error if it is not.
145 if (stat(path
, &sb
) == 0) {
146 if (S_ISDIR(sb
.st_mode
)) {
149 fprintf(stderr
, "Cannot use %s for shader cache (not a directory)"
150 "---disabling.\n", path
);
155 int ret
= mkdir(path
, 0755);
156 if (ret
== 0 || (ret
== -1 && errno
== EEXIST
))
159 fprintf(stderr
, "Failed to create %s for shader cache (%s)---disabling.\n",
160 path
, strerror(errno
));
165 /* Concatenate an existing path and a new name to form a new path. If the new
166 * path does not exist as a directory, create it then return the resulting
167 * name of the new path (ralloc'ed off of 'ctx').
169 * Returns NULL on any error, such as:
171 * <path> does not exist or is not a directory
172 * <path>/<name> exists but is not a directory
173 * <path>/<name> cannot be created as a directory
176 concatenate_and_mkdir(void *ctx
, const char *path
, const char *name
)
181 if (stat(path
, &sb
) != 0 || ! S_ISDIR(sb
.st_mode
))
184 new_path
= ralloc_asprintf(ctx
, "%s/%s", path
, name
);
186 if (mkdir_if_needed(new_path
) == 0)
192 #define DRV_KEY_CPY(_dst, _src, _src_size) \
194 memcpy(_dst, _src, _src_size); \
199 disk_cache_create(const char *gpu_name
, const char *driver_id
,
200 uint64_t driver_flags
)
203 struct disk_cache
*cache
= NULL
;
204 char *path
, *max_size_str
;
210 uint8_t cache_version
= CACHE_VERSION
;
211 size_t cv_size
= sizeof(cache_version
);
213 /* If running as a users other than the real user disable cache */
214 if (geteuid() != getuid())
217 /* A ralloc context for transient data during this invocation. */
218 local
= ralloc_context(NULL
);
222 /* At user request, disable shader cache entirely. */
223 if (env_var_as_boolean("MESA_GLSL_CACHE_DISABLE", false))
226 cache
= rzalloc(NULL
, struct disk_cache
);
230 /* Assume failure. */
231 cache
->path_init_failed
= true;
233 /* Determine path for cache based on the first defined name as follows:
235 * $MESA_GLSL_CACHE_DIR
236 * $XDG_CACHE_HOME/mesa_shader_cache
237 * <pwd.pw_dir>/.cache/mesa_shader_cache
239 path
= getenv("MESA_GLSL_CACHE_DIR");
241 if (mkdir_if_needed(path
) == -1)
244 path
= concatenate_and_mkdir(local
, path
, CACHE_DIR_NAME
);
250 char *xdg_cache_home
= getenv("XDG_CACHE_HOME");
252 if (xdg_cache_home
) {
253 if (mkdir_if_needed(xdg_cache_home
) == -1)
256 path
= concatenate_and_mkdir(local
, xdg_cache_home
, CACHE_DIR_NAME
);
265 struct passwd pwd
, *result
;
267 buf_size
= sysconf(_SC_GETPW_R_SIZE_MAX
);
271 /* Loop until buf_size is large enough to query the directory */
273 buf
= ralloc_size(local
, buf_size
);
275 getpwuid_r(getuid(), &pwd
, buf
, buf_size
, &result
);
279 if (errno
== ERANGE
) {
288 path
= concatenate_and_mkdir(local
, pwd
.pw_dir
, ".cache");
292 path
= concatenate_and_mkdir(local
, path
, CACHE_DIR_NAME
);
297 cache
->path
= ralloc_strdup(cache
, path
);
298 if (cache
->path
== NULL
)
301 path
= ralloc_asprintf(local
, "%s/index", cache
->path
);
305 fd
= open(path
, O_RDWR
| O_CREAT
| O_CLOEXEC
, 0644);
309 if (fstat(fd
, &sb
) == -1)
312 /* Force the index file to be the expected size. */
313 size
= sizeof(*cache
->size
) + CACHE_INDEX_MAX_KEYS
* CACHE_KEY_SIZE
;
314 if (sb
.st_size
!= size
) {
315 if (ftruncate(fd
, size
) == -1)
319 /* We map this shared so that other processes see updates that we
322 * Note: We do use atomic addition to ensure that multiple
323 * processes don't scramble the cache size recorded in the
324 * index. But we don't use any locking to prevent multiple
325 * processes from updating the same entry simultaneously. The idea
326 * is that if either result lands entirely in the index, then
327 * that's equivalent to a well-ordered write followed by an
328 * eviction and a write. On the other hand, if the simultaneous
329 * writes result in a corrupt entry, that's not really any
330 * different than both entries being evicted, (since within the
331 * guarantees of the cryptographic hash, a corrupt entry is
332 * unlikely to ever match a real cache key).
334 cache
->index_mmap
= mmap(NULL
, size
, PROT_READ
| PROT_WRITE
,
336 if (cache
->index_mmap
== MAP_FAILED
)
338 cache
->index_mmap_size
= size
;
340 cache
->size
= (uint64_t *) cache
->index_mmap
;
341 cache
->stored_keys
= cache
->index_mmap
+ sizeof(uint64_t);
345 max_size_str
= getenv("MESA_GLSL_CACHE_MAX_SIZE");
348 max_size
= strtoul(max_size_str
, &end
, 10);
349 if (end
== max_size_str
) {
359 max_size
*= 1024*1024;
365 max_size
*= 1024*1024*1024;
371 /* Default to 1GB for maximum cache size. */
373 max_size
= 1024*1024*1024;
376 cache
->max_size
= max_size
;
378 /* 4 threads were chosen below because just about all modern CPUs currently
379 * available that run Mesa have *at least* 4 cores. For these CPUs allowing
380 * more threads can result in the queue being processed faster, thus
381 * avoiding excessive memory use due to a backlog of cache entrys building
382 * up in the queue. Since we set the UTIL_QUEUE_INIT_USE_MINIMUM_PRIORITY
383 * flag this should have little negative impact on low core systems.
385 * The queue will resize automatically when it's full, so adding new jobs
388 util_queue_init(&cache
->cache_queue
, "disk$", 32, 4,
389 UTIL_QUEUE_INIT_RESIZE_IF_FULL
|
390 UTIL_QUEUE_INIT_USE_MINIMUM_PRIORITY
|
391 UTIL_QUEUE_INIT_SET_FULL_THREAD_AFFINITY
);
393 cache
->path_init_failed
= false;
400 cache
->driver_keys_blob_size
= cv_size
;
402 /* Create driver id keys */
403 size_t id_size
= strlen(driver_id
) + 1;
404 size_t gpu_name_size
= strlen(gpu_name
) + 1;
405 cache
->driver_keys_blob_size
+= id_size
;
406 cache
->driver_keys_blob_size
+= gpu_name_size
;
408 /* We sometimes store entire structs that contains a pointers in the cache,
409 * use pointer size as a key to avoid hard to debug issues.
411 uint8_t ptr_size
= sizeof(void *);
412 size_t ptr_size_size
= sizeof(ptr_size
);
413 cache
->driver_keys_blob_size
+= ptr_size_size
;
415 size_t driver_flags_size
= sizeof(driver_flags
);
416 cache
->driver_keys_blob_size
+= driver_flags_size
;
418 cache
->driver_keys_blob
=
419 ralloc_size(cache
, cache
->driver_keys_blob_size
);
420 if (!cache
->driver_keys_blob
)
423 uint8_t *drv_key_blob
= cache
->driver_keys_blob
;
424 DRV_KEY_CPY(drv_key_blob
, &cache_version
, cv_size
)
425 DRV_KEY_CPY(drv_key_blob
, driver_id
, id_size
)
426 DRV_KEY_CPY(drv_key_blob
, gpu_name
, gpu_name_size
)
427 DRV_KEY_CPY(drv_key_blob
, &ptr_size
, ptr_size_size
)
428 DRV_KEY_CPY(drv_key_blob
, &driver_flags
, driver_flags_size
)
430 /* Seed our rand function */
431 s_rand_xorshift128plus(cache
->seed_xorshift128plus
, true);
446 disk_cache_destroy(struct disk_cache
*cache
)
448 if (cache
&& !cache
->path_init_failed
) {
449 util_queue_finish(&cache
->cache_queue
);
450 util_queue_destroy(&cache
->cache_queue
);
451 munmap(cache
->index_mmap
, cache
->index_mmap_size
);
458 disk_cache_wait_for_idle(struct disk_cache
*cache
)
460 util_queue_finish(&cache
->cache_queue
);
463 /* Return a filename within the cache's directory corresponding to 'key'. The
464 * returned filename is ralloced with 'cache' as the parent context.
466 * Returns NULL if out of memory.
469 get_cache_file(struct disk_cache
*cache
, const cache_key key
)
474 if (cache
->path_init_failed
)
477 _mesa_sha1_format(buf
, key
);
478 if (asprintf(&filename
, "%s/%c%c/%s", cache
->path
, buf
[0],
479 buf
[1], buf
+ 2) == -1)
485 /* Create the directory that will be needed for the cache file for \key.
487 * Obviously, the implementation here must closely match
488 * _get_cache_file above.
491 make_cache_file_directory(struct disk_cache
*cache
, const cache_key key
)
496 _mesa_sha1_format(buf
, key
);
497 if (asprintf(&dir
, "%s/%c%c", cache
->path
, buf
[0], buf
[1]) == -1)
500 mkdir_if_needed(dir
);
504 /* Given a directory path and predicate function, find the entry with
505 * the oldest access time in that directory for which the predicate
508 * Returns: A malloc'ed string for the path to the chosen file, (or
509 * NULL on any error). The caller should free the string when
513 choose_lru_file_matching(const char *dir_path
,
514 bool (*predicate
)(const char *dir_path
,
516 const char *, const size_t))
519 struct dirent
*entry
;
521 char *lru_name
= NULL
;
522 time_t lru_atime
= 0;
524 dir
= opendir(dir_path
);
529 entry
= readdir(dir
);
534 if (fstatat(dirfd(dir
), entry
->d_name
, &sb
, 0) == 0) {
535 if (!lru_atime
|| (sb
.st_atime
< lru_atime
)) {
536 size_t len
= strlen(entry
->d_name
);
538 if (!predicate(dir_path
, &sb
, entry
->d_name
, len
))
541 char *tmp
= realloc(lru_name
, len
+ 1);
544 memcpy(lru_name
, entry
->d_name
, len
+ 1);
545 lru_atime
= sb
.st_atime
;
551 if (lru_name
== NULL
) {
556 if (asprintf(&filename
, "%s/%s", dir_path
, lru_name
) < 0)
565 /* Is entry a regular file, and not having a name with a trailing
569 is_regular_non_tmp_file(const char *path
, const struct stat
*sb
,
570 const char *d_name
, const size_t len
)
572 if (!S_ISREG(sb
->st_mode
))
575 if (len
>= 4 && strcmp(&d_name
[len
-4], ".tmp") == 0)
581 /* Returns the size of the deleted file, (or 0 on any error). */
583 unlink_lru_file_from_directory(const char *path
)
588 filename
= choose_lru_file_matching(path
, is_regular_non_tmp_file
);
589 if (filename
== NULL
)
592 if (stat(filename
, &sb
) == -1) {
600 return sb
.st_blocks
* 512;
603 /* Is entry a directory with a two-character name, (and not the
604 * special name of ".."). We also return false if the dir is empty.
607 is_two_character_sub_directory(const char *path
, const struct stat
*sb
,
608 const char *d_name
, const size_t len
)
610 if (!S_ISDIR(sb
->st_mode
))
616 if (strcmp(d_name
, "..") == 0)
620 if (asprintf(&subdir
, "%s/%s", path
, d_name
) == -1)
622 DIR *dir
= opendir(subdir
);
628 unsigned subdir_entries
= 0;
630 while ((d
= readdir(dir
)) != NULL
) {
631 if(++subdir_entries
> 2)
636 /* If dir only contains '.' and '..' it must be empty */
637 if (subdir_entries
<= 2)
644 evict_lru_item(struct disk_cache
*cache
)
648 /* With a reasonably-sized, full cache, (and with keys generated
649 * from a cryptographic hash), we can choose two random hex digits
650 * and reasonably expect the directory to exist with a file in it.
651 * Provides pseudo-LRU eviction to reduce checking all cache files.
653 uint64_t rand64
= rand_xorshift128plus(cache
->seed_xorshift128plus
);
654 if (asprintf(&dir_path
, "%s/%02" PRIx64
, cache
->path
, rand64
& 0xff) < 0)
657 size_t size
= unlink_lru_file_from_directory(dir_path
);
662 p_atomic_add(cache
->size
, - (uint64_t)size
);
666 /* In the case where the random choice of directory didn't find
667 * something, we choose the least recently accessed from the
668 * existing directories.
670 * Really, the only reason this code exists is to allow the unit
671 * tests to work, (which use an artificially-small cache to be able
672 * to force a single cached item to be evicted).
674 dir_path
= choose_lru_file_matching(cache
->path
,
675 is_two_character_sub_directory
);
676 if (dir_path
== NULL
)
679 size
= unlink_lru_file_from_directory(dir_path
);
684 p_atomic_add(cache
->size
, - (uint64_t)size
);
688 disk_cache_remove(struct disk_cache
*cache
, const cache_key key
)
692 char *filename
= get_cache_file(cache
, key
);
693 if (filename
== NULL
) {
697 if (stat(filename
, &sb
) == -1) {
706 p_atomic_add(cache
->size
, - (uint64_t)sb
.st_blocks
* 512);
710 read_all(int fd
, void *buf
, size_t count
)
716 for (done
= 0; done
< count
; done
+= read_ret
) {
717 read_ret
= read(fd
, in
+ done
, count
- done
);
718 if (read_ret
== -1 || read_ret
== 0)
725 write_all(int fd
, const void *buf
, size_t count
)
727 const char *out
= buf
;
731 for (done
= 0; done
< count
; done
+= written
) {
732 written
= write(fd
, out
+ done
, count
- done
);
739 /* From the zlib docs:
740 * "If the memory is available, buffers sizes on the order of 128K or 256K
741 * bytes should be used."
743 #define BUFSIZE 256 * 1024
746 * Compresses cache entry in memory and writes it to disk. Returns the size
747 * of the data written to disk.
750 deflate_and_write_to_disk(const void *in_data
, size_t in_data_size
, int dest
,
751 const char *filename
)
754 /* from the zstd docs (https://facebook.github.io/zstd/zstd_manual.html):
755 * compression runs faster if `dstCapacity` >= `ZSTD_compressBound(srcSize)`.
757 size_t out_size
= ZSTD_compressBound(in_data_size
);
758 void * out
= malloc(out_size
);
760 size_t ret
= ZSTD_compress(out
, out_size
, in_data
, in_data_size
,
761 ZSTD_COMPRESSION_LEVEL
);
762 if (ZSTD_isError(ret
)) {
766 ssize_t written
= write_all(dest
, out
, ret
);
776 /* allocate deflate state */
778 strm
.zalloc
= Z_NULL
;
780 strm
.opaque
= Z_NULL
;
781 strm
.next_in
= (uint8_t *) in_data
;
782 strm
.avail_in
= in_data_size
;
784 int ret
= deflateInit(&strm
, Z_BEST_COMPRESSION
);
788 /* compress until end of in_data */
789 size_t compressed_size
= 0;
792 out
= malloc(BUFSIZE
* sizeof(unsigned char));
797 int remaining
= in_data_size
- BUFSIZE
;
798 flush
= remaining
> 0 ? Z_NO_FLUSH
: Z_FINISH
;
799 in_data_size
-= BUFSIZE
;
801 /* Run deflate() on input until the output buffer is not full (which
802 * means there is no more data to deflate).
805 strm
.avail_out
= BUFSIZE
;
808 ret
= deflate(&strm
, flush
); /* no bad return value */
809 assert(ret
!= Z_STREAM_ERROR
); /* state not clobbered */
811 size_t have
= BUFSIZE
- strm
.avail_out
;
812 compressed_size
+= have
;
814 ssize_t written
= write_all(dest
, out
, have
);
816 (void)deflateEnd(&strm
);
820 } while (strm
.avail_out
== 0);
822 /* all input should be used */
823 assert(strm
.avail_in
== 0);
825 } while (flush
!= Z_FINISH
);
827 /* stream should be complete */
828 assert(ret
== Z_STREAM_END
);
830 /* clean up and return */
831 (void)deflateEnd(&strm
);
833 return compressed_size
;
837 static struct disk_cache_put_job
*
838 create_put_job(struct disk_cache
*cache
, const cache_key key
,
839 const void *data
, size_t size
,
840 struct cache_item_metadata
*cache_item_metadata
)
842 struct disk_cache_put_job
*dc_job
= (struct disk_cache_put_job
*)
843 malloc(sizeof(struct disk_cache_put_job
) + size
);
846 dc_job
->cache
= cache
;
847 memcpy(dc_job
->key
, key
, sizeof(cache_key
));
848 dc_job
->data
= dc_job
+ 1;
849 memcpy(dc_job
->data
, data
, size
);
852 /* Copy the cache item metadata */
853 if (cache_item_metadata
) {
854 dc_job
->cache_item_metadata
.type
= cache_item_metadata
->type
;
855 if (cache_item_metadata
->type
== CACHE_ITEM_TYPE_GLSL
) {
856 dc_job
->cache_item_metadata
.num_keys
=
857 cache_item_metadata
->num_keys
;
858 dc_job
->cache_item_metadata
.keys
= (cache_key
*)
859 malloc(cache_item_metadata
->num_keys
* sizeof(cache_key
));
861 if (!dc_job
->cache_item_metadata
.keys
)
864 memcpy(dc_job
->cache_item_metadata
.keys
,
865 cache_item_metadata
->keys
,
866 sizeof(cache_key
) * cache_item_metadata
->num_keys
);
869 dc_job
->cache_item_metadata
.type
= CACHE_ITEM_TYPE_UNKNOWN
;
870 dc_job
->cache_item_metadata
.keys
= NULL
;
883 destroy_put_job(void *job
, int thread_index
)
886 struct disk_cache_put_job
*dc_job
= (struct disk_cache_put_job
*) job
;
887 free(dc_job
->cache_item_metadata
.keys
);
893 struct cache_entry_file_data
{
895 uint32_t uncompressed_size
;
899 cache_put(void *job
, int thread_index
)
903 int fd
= -1, fd_final
= -1, err
, ret
;
905 char *filename
= NULL
, *filename_tmp
= NULL
;
906 struct disk_cache_put_job
*dc_job
= (struct disk_cache_put_job
*) job
;
908 filename
= get_cache_file(dc_job
->cache
, dc_job
->key
);
909 if (filename
== NULL
)
912 /* If the cache is too large, evict something else first. */
913 while (*dc_job
->cache
->size
+ dc_job
->size
> dc_job
->cache
->max_size
&&
915 evict_lru_item(dc_job
->cache
);
919 /* Write to a temporary file to allow for an atomic rename to the
920 * final destination filename, (to prevent any readers from seeing
921 * a partially written file).
923 if (asprintf(&filename_tmp
, "%s.tmp", filename
) == -1)
926 fd
= open(filename_tmp
, O_WRONLY
| O_CLOEXEC
| O_CREAT
, 0644);
928 /* Make the two-character subdirectory within the cache as needed. */
933 make_cache_file_directory(dc_job
->cache
, dc_job
->key
);
935 fd
= open(filename_tmp
, O_WRONLY
| O_CLOEXEC
| O_CREAT
, 0644);
940 /* With the temporary file open, we take an exclusive flock on
941 * it. If the flock fails, then another process still has the file
942 * open with the flock held. So just let that file be responsible
943 * for writing the file.
946 err
= flock(fd
, LOCK_EX
| LOCK_NB
);
948 struct flock lock
= {
950 .l_len
= 0, /* entire file */
954 err
= fcntl(fd
, F_SETLK
, &lock
);
959 /* Now that we have the lock on the open temporary file, we can
960 * check to see if the destination file already exists. If so,
961 * another process won the race between when we saw that the file
962 * didn't exist and now. In this case, we don't do anything more,
963 * (to ensure the size accounting of the cache doesn't get off).
965 fd_final
= open(filename
, O_RDONLY
| O_CLOEXEC
);
966 if (fd_final
!= -1) {
967 unlink(filename_tmp
);
971 /* OK, we're now on the hook to write out a file that we know is
972 * not in the cache, and is also not being written out to the cache
973 * by some other process.
976 /* Write the driver_keys_blob, this can be used find information about the
977 * mesa version that produced the entry or deal with hash collisions,
978 * should that ever become a real problem.
980 ret
= write_all(fd
, dc_job
->cache
->driver_keys_blob
,
981 dc_job
->cache
->driver_keys_blob_size
);
983 unlink(filename_tmp
);
987 /* Write the cache item metadata. This data can be used to deal with
988 * hash collisions, as well as providing useful information to 3rd party
989 * tools reading the cache files.
991 ret
= write_all(fd
, &dc_job
->cache_item_metadata
.type
,
994 unlink(filename_tmp
);
998 if (dc_job
->cache_item_metadata
.type
== CACHE_ITEM_TYPE_GLSL
) {
999 ret
= write_all(fd
, &dc_job
->cache_item_metadata
.num_keys
,
1002 unlink(filename_tmp
);
1006 ret
= write_all(fd
, dc_job
->cache_item_metadata
.keys
[0],
1007 dc_job
->cache_item_metadata
.num_keys
*
1010 unlink(filename_tmp
);
1015 /* Create CRC of the data. We will read this when restoring the cache and
1016 * use it to check for corruption.
1018 struct cache_entry_file_data cf_data
;
1019 cf_data
.crc32
= util_hash_crc32(dc_job
->data
, dc_job
->size
);
1020 cf_data
.uncompressed_size
= dc_job
->size
;
1022 size_t cf_data_size
= sizeof(cf_data
);
1023 ret
= write_all(fd
, &cf_data
, cf_data_size
);
1025 unlink(filename_tmp
);
1029 /* Now, finally, write out the contents to the temporary file, then
1030 * rename them atomically to the destination filename, and also
1031 * perform an atomic increment of the total cache size.
1033 size_t file_size
= deflate_and_write_to_disk(dc_job
->data
, dc_job
->size
,
1035 if (file_size
== 0) {
1036 unlink(filename_tmp
);
1039 ret
= rename(filename_tmp
, filename
);
1041 unlink(filename_tmp
);
1046 if (stat(filename
, &sb
) == -1) {
1047 /* Something went wrong remove the file */
1052 p_atomic_add(dc_job
->cache
->size
, sb
.st_blocks
* 512);
1057 /* This close finally releases the flock, (now that the final file
1058 * has been renamed into place and the size has been added).
1067 disk_cache_put(struct disk_cache
*cache
, const cache_key key
,
1068 const void *data
, size_t size
,
1069 struct cache_item_metadata
*cache_item_metadata
)
1071 if (cache
->blob_put_cb
) {
1072 cache
->blob_put_cb(key
, CACHE_KEY_SIZE
, data
, size
);
1076 if (cache
->path_init_failed
)
1079 struct disk_cache_put_job
*dc_job
=
1080 create_put_job(cache
, key
, data
, size
, cache_item_metadata
);
1083 util_queue_fence_init(&dc_job
->fence
);
1084 util_queue_add_job(&cache
->cache_queue
, dc_job
, &dc_job
->fence
,
1085 cache_put
, destroy_put_job
, dc_job
->size
);
1090 * Decompresses cache entry, returns true if successful.
1093 inflate_cache_data(uint8_t *in_data
, size_t in_data_size
,
1094 uint8_t *out_data
, size_t out_data_size
)
1097 size_t ret
= ZSTD_decompress(out_data
, out_data_size
, in_data
, in_data_size
);
1098 return !ZSTD_isError(ret
);
1102 /* allocate inflate state */
1103 strm
.zalloc
= Z_NULL
;
1104 strm
.zfree
= Z_NULL
;
1105 strm
.opaque
= Z_NULL
;
1106 strm
.next_in
= in_data
;
1107 strm
.avail_in
= in_data_size
;
1108 strm
.next_out
= out_data
;
1109 strm
.avail_out
= out_data_size
;
1111 int ret
= inflateInit(&strm
);
1115 ret
= inflate(&strm
, Z_NO_FLUSH
);
1116 assert(ret
!= Z_STREAM_ERROR
); /* state not clobbered */
1118 /* Unless there was an error we should have decompressed everything in one
1119 * go as we know the uncompressed file size.
1121 if (ret
!= Z_STREAM_END
) {
1122 (void)inflateEnd(&strm
);
1125 assert(strm
.avail_out
== 0);
1127 /* clean up and return */
1128 (void)inflateEnd(&strm
);
1134 disk_cache_get(struct disk_cache
*cache
, const cache_key key
, size_t *size
)
1138 char *filename
= NULL
;
1139 uint8_t *data
= NULL
;
1140 uint8_t *uncompressed_data
= NULL
;
1141 uint8_t *file_header
= NULL
;
1146 if (cache
->blob_get_cb
) {
1147 /* This is what Android EGL defines as the maxValueSize in egl_cache_t
1148 * class implementation.
1150 const signed long max_blob_size
= 64 * 1024;
1151 void *blob
= malloc(max_blob_size
);
1156 cache
->blob_get_cb(key
, CACHE_KEY_SIZE
, blob
, max_blob_size
);
1168 filename
= get_cache_file(cache
, key
);
1169 if (filename
== NULL
)
1172 fd
= open(filename
, O_RDONLY
| O_CLOEXEC
);
1176 if (fstat(fd
, &sb
) == -1)
1179 data
= malloc(sb
.st_size
);
1183 size_t ck_size
= cache
->driver_keys_blob_size
;
1184 file_header
= malloc(ck_size
);
1188 if (sb
.st_size
< ck_size
)
1191 ret
= read_all(fd
, file_header
, ck_size
);
1195 /* Check for extremely unlikely hash collisions */
1196 if (memcmp(cache
->driver_keys_blob
, file_header
, ck_size
) != 0) {
1197 assert(!"Mesa cache keys mismatch!");
1201 size_t cache_item_md_size
= sizeof(uint32_t);
1203 ret
= read_all(fd
, &md_type
, cache_item_md_size
);
1207 if (md_type
== CACHE_ITEM_TYPE_GLSL
) {
1209 cache_item_md_size
+= sizeof(uint32_t);
1210 ret
= read_all(fd
, &num_keys
, sizeof(uint32_t));
1214 /* The cache item metadata is currently just used for distributing
1215 * precompiled shaders, they are not used by Mesa so just skip them for
1217 * TODO: pass the metadata back to the caller and do some basic
1220 cache_item_md_size
+= num_keys
* sizeof(cache_key
);
1221 ret
= lseek(fd
, num_keys
* sizeof(cache_key
), SEEK_CUR
);
1226 /* Load the CRC that was created when the file was written. */
1227 struct cache_entry_file_data cf_data
;
1228 size_t cf_data_size
= sizeof(cf_data
);
1229 ret
= read_all(fd
, &cf_data
, cf_data_size
);
1233 /* Load the actual cache data. */
1234 size_t cache_data_size
=
1235 sb
.st_size
- cf_data_size
- ck_size
- cache_item_md_size
;
1236 ret
= read_all(fd
, data
, cache_data_size
);
1240 /* Uncompress the cache data */
1241 uncompressed_data
= malloc(cf_data
.uncompressed_size
);
1242 if (!inflate_cache_data(data
, cache_data_size
, uncompressed_data
,
1243 cf_data
.uncompressed_size
))
1246 /* Check the data for corruption */
1247 if (cf_data
.crc32
!= util_hash_crc32(uncompressed_data
,
1248 cf_data
.uncompressed_size
))
1257 *size
= cf_data
.uncompressed_size
;
1259 return uncompressed_data
;
1264 if (uncompressed_data
)
1265 free(uncompressed_data
);
1277 disk_cache_put_key(struct disk_cache
*cache
, const cache_key key
)
1279 const uint32_t *key_chunk
= (const uint32_t *) key
;
1280 int i
= CPU_TO_LE32(*key_chunk
) & CACHE_INDEX_KEY_MASK
;
1281 unsigned char *entry
;
1283 if (cache
->blob_put_cb
) {
1284 cache
->blob_put_cb(key
, CACHE_KEY_SIZE
, key_chunk
, sizeof(uint32_t));
1288 if (cache
->path_init_failed
)
1291 entry
= &cache
->stored_keys
[i
* CACHE_KEY_SIZE
];
1293 memcpy(entry
, key
, CACHE_KEY_SIZE
);
1296 /* This function lets us test whether a given key was previously
1297 * stored in the cache with disk_cache_put_key(). The implement is
1298 * efficient by not using syscalls or hitting the disk. It's not
1299 * race-free, but the races are benign. If we race with someone else
1300 * calling disk_cache_put_key, then that's just an extra cache miss and an
1304 disk_cache_has_key(struct disk_cache
*cache
, const cache_key key
)
1306 const uint32_t *key_chunk
= (const uint32_t *) key
;
1307 int i
= CPU_TO_LE32(*key_chunk
) & CACHE_INDEX_KEY_MASK
;
1308 unsigned char *entry
;
1310 if (cache
->blob_get_cb
) {
1312 return cache
->blob_get_cb(key
, CACHE_KEY_SIZE
, &blob
, sizeof(uint32_t));
1315 if (cache
->path_init_failed
)
1318 entry
= &cache
->stored_keys
[i
* CACHE_KEY_SIZE
];
1320 return memcmp(entry
, key
, CACHE_KEY_SIZE
) == 0;
1324 disk_cache_compute_key(struct disk_cache
*cache
, const void *data
, size_t size
,
1327 struct mesa_sha1 ctx
;
1329 _mesa_sha1_init(&ctx
);
1330 _mesa_sha1_update(&ctx
, cache
->driver_keys_blob
,
1331 cache
->driver_keys_blob_size
);
1332 _mesa_sha1_update(&ctx
, data
, size
);
1333 _mesa_sha1_final(&ctx
, key
);
1337 disk_cache_set_callbacks(struct disk_cache
*cache
, disk_cache_put_cb put
,
1338 disk_cache_get_cb get
)
1340 cache
->blob_put_cb
= put
;
1341 cache
->blob_get_cb
= get
;
1344 #endif /* ENABLE_SHADER_CACHE */