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
30 #include "util/build_id.h"
36 #include "util/mesa-sha1.h"
42 /* Size of cache keys in bytes. */
43 #define CACHE_KEY_SIZE 20
45 #define CACHE_DIR_NAME "mesa_shader_cache"
47 typedef uint8_t cache_key
[CACHE_KEY_SIZE
];
49 /* WARNING: 3rd party applications might be reading the cache item metadata.
50 * Do not change these values without making the change widely known.
51 * Please contact Valve developers and make them aware of this change.
53 #define CACHE_ITEM_TYPE_UNKNOWN 0x0
54 #define CACHE_ITEM_TYPE_GLSL 0x1
57 (*disk_cache_put_cb
) (const void *key
, signed long keySize
,
58 const void *value
, signed long valueSize
);
61 (*disk_cache_get_cb
) (const void *key
, signed long keySize
,
62 void *value
, signed long valueSize
);
64 struct cache_item_metadata
{
66 * The cache item type. This could be used to identify a GLSL cache item,
67 * a certain type of IR (tgsi, nir, etc), or signal that it is the final
68 * binary form of the shader.
72 /** GLSL cache item metadata */
73 cache_key
*keys
; /* sha1 list of shaders that make up the cache item */
80 disk_cache_format_hex_id(char *buf
, const uint8_t *hex_id
, unsigned size
)
82 static const char hex_digits
[] = "0123456789abcdef";
85 for (i
= 0; i
< size
; i
+= 2) {
86 buf
[i
] = hex_digits
[hex_id
[i
>> 1] >> 4];
87 buf
[i
+ 1] = hex_digits
[hex_id
[i
>> 1] & 0x0f];
96 disk_cache_get_function_timestamp(void *ptr
, uint32_t* timestamp
)
100 if (!dladdr(ptr
, &info
) || !info
.dli_fname
) {
103 if (stat(info
.dli_fname
, &st
)) {
108 fprintf(stderr
, "Mesa: The provided filesystem timestamp for the cache "
109 "is bogus! Disabling On-disk cache.\n");
113 *timestamp
= st
.st_mtime
;
119 disk_cache_get_function_identifier(void *ptr
, struct mesa_sha1
*ctx
)
123 #ifdef HAVE_DL_ITERATE_PHDR
124 const struct build_id_note
*note
= NULL
;
125 if ((note
= build_id_find_nhdr_for_addr(ptr
))) {
126 _mesa_sha1_update(ctx
, build_id_data(note
), build_id_length(note
));
129 if (disk_cache_get_function_timestamp(ptr
, ×tamp
)) {
130 _mesa_sha1_update(ctx
, ×tamp
, sizeof(timestamp
));
137 /* Provide inlined stub functions if the shader cache is disabled. */
139 #ifdef ENABLE_SHADER_CACHE
142 * Create a new cache object.
144 * This function creates the handle necessary for all subsequent cache_*
147 * This cache provides two distinct operations:
149 * o Storage and retrieval of arbitrary objects by cryptographic
150 * name (or "key"). This is provided via disk_cache_put() and
153 * o The ability to store a key alone and check later whether the
154 * key was previously stored. This is provided via disk_cache_put_key()
155 * and disk_cache_has_key().
157 * The put_key()/has_key() operations are conceptually identical to
158 * put()/get() with no data, but are provided separately to allow for
159 * a more efficient implementation.
161 * In all cases, the keys are sequences of 20 bytes. It is anticipated
162 * that callers will compute appropriate SHA-1 signatures for keys,
163 * (though nothing in this implementation directly relies on how the
164 * names are computed). See mesa-sha1.h and _mesa_sha1_compute for
165 * assistance in computing SHA-1 signatures.
168 disk_cache_create(const char *gpu_name
, const char *timestamp
,
169 uint64_t driver_flags
);
172 * Destroy a cache object, (freeing all associated resources).
175 disk_cache_destroy(struct disk_cache
*cache
);
177 /* Wait for all previous disk_cache_put() calls to be processed (used for unit
181 disk_cache_wait_for_idle(struct disk_cache
*cache
);
184 * Remove the item in the cache under the name \key.
187 disk_cache_remove(struct disk_cache
*cache
, const cache_key key
);
190 * Store an item in the cache under the name \key.
192 * The item can be retrieved later with disk_cache_get(), (unless the item has
193 * been evicted in the interim).
195 * Any call to disk_cache_put() may cause an existing, random item to be
196 * evicted from the cache.
199 disk_cache_put(struct disk_cache
*cache
, const cache_key key
,
200 const void *data
, size_t size
,
201 struct cache_item_metadata
*cache_item_metadata
);
204 * Retrieve an item previously stored in the cache with the name <key>.
206 * The item must have been previously stored with a call to disk_cache_put().
208 * If \size is non-NULL, then, on successful return, it will be set to the
209 * size of the object.
211 * \return A pointer to the stored object if found. NULL if the object
212 * is not found, or if any error occurs, (memory allocation failure,
213 * filesystem error, etc.). The returned data is malloc'ed so the
214 * caller should call free() it when finished.
217 disk_cache_get(struct disk_cache
*cache
, const cache_key key
, size_t *size
);
220 * Store the name \key within the cache, (without any associated data).
222 * Later this key can be checked with disk_cache_has_key(), (unless the key
223 * has been evicted in the interim).
225 * Any call to disk_cache_put_key() may cause an existing, random key to be
226 * evicted from the cache.
229 disk_cache_put_key(struct disk_cache
*cache
, const cache_key key
);
232 * Test whether the name \key was previously recorded in the cache.
234 * Return value: True if disk_cache_put_key() was previously called with
235 * \key, (and the key was not evicted in the interim).
237 * Note: disk_cache_has_key() will only return true for keys passed to
238 * disk_cache_put_key(). Specifically, a call to disk_cache_put() will not cause
239 * disk_cache_has_key() to return true for the same key.
242 disk_cache_has_key(struct disk_cache
*cache
, const cache_key key
);
245 * Compute the name \key from \data of given \size.
248 disk_cache_compute_key(struct disk_cache
*cache
, const void *data
, size_t size
,
252 disk_cache_set_callbacks(struct disk_cache
*cache
, disk_cache_put_cb put
,
253 disk_cache_get_cb get
);
257 static inline struct disk_cache
*
258 disk_cache_create(const char *gpu_name
, const char *timestamp
,
259 uint64_t driver_flags
)
265 disk_cache_destroy(struct disk_cache
*cache
) {
270 disk_cache_put(struct disk_cache
*cache
, const cache_key key
,
271 const void *data
, size_t size
,
272 struct cache_item_metadata
*cache_item_metadata
)
278 disk_cache_remove(struct disk_cache
*cache
, const cache_key key
)
283 static inline uint8_t *
284 disk_cache_get(struct disk_cache
*cache
, const cache_key key
, size_t *size
)
290 disk_cache_put_key(struct disk_cache
*cache
, const cache_key key
)
296 disk_cache_has_key(struct disk_cache
*cache
, const cache_key key
)
302 disk_cache_compute_key(struct disk_cache
*cache
, const void *data
, size_t size
,
309 disk_cache_set_callbacks(struct disk_cache
*cache
, disk_cache_put_cb put
,
310 disk_cache_get_cb get
)
315 #endif /* ENABLE_SHADER_CACHE */