1 /*
2 * Copyright © 2014 Intel Corporation
3 *
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:
10 *
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
13 * Software.
14 *
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
21 * IN THE SOFTWARE.
22 */
23
24 #ifndef DISK_CACHE_H
25 #define DISK_CACHE_H
26
27 #ifdef ENABLE_SHADER_CACHE
28 #include <dlfcn.h>
29 #endif
30 #include <assert.h>
31 #include <stdint.h>
32 #include <stdbool.h>
33 #include <sys/stat.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* Size of cache keys in bytes. */
40 #define CACHE_KEY_SIZE 20
41
42 #define CACHE_DIR_NAME "mesa_shader_cache"
43
44 typedef uint8_t cache_key[CACHE_KEY_SIZE];
45
46 /* WARNING: 3rd party applications might be reading the cache item metadata.
47 * Do not change these values without making the change widely known.
48 * Please contact Valve developers and make them aware of this change.
49 */
50 #define CACHE_ITEM_TYPE_UNKNOWN 0x0
51 #define CACHE_ITEM_TYPE_GLSL 0x1
52
53 struct cache_item_metadata {
54 /**
55 * The cache item type. This could be used to identify a GLSL cache item,
56 * a certain type of IR (tgsi, nir, etc), or signal that it is the final
57 * binary form of the shader.
58 */
59 uint32_t type;
60
61 /** GLSL cache item metadata */
62 cache_key *keys; /* sha1 list of shaders that make up the cache item */
63 uint32_t num_keys;
64 };
65
66 struct disk_cache;
67
68 static inline char *
disk_cache_format_hex_id(char * buf,const uint8_t * hex_id,unsigned size)69 disk_cache_format_hex_id(char *buf, const uint8_t *hex_id, unsigned size)
70 {
71 static const char hex_digits[] = "0123456789abcdef";
72 unsigned i;
73
74 for (i = 0; i < size; i += 2) {
75 buf[i] = hex_digits[hex_id[i >> 1] >> 4];
76 buf[i + 1] = hex_digits[hex_id[i >> 1] & 0x0f];
77 }
78 buf[i] = '\0';
79
80 return buf;
81 }
82
83 static inline bool
disk_cache_get_function_timestamp(void * ptr,uint32_t * timestamp)84 disk_cache_get_function_timestamp(void *ptr, uint32_t* timestamp)
85 {
86 #ifdef ENABLE_SHADER_CACHE
87 Dl_info info;
88 struct stat st;
89 if (!dladdr(ptr, &info) || !info.dli_fname) {
90 return false;
91 }
92 if (stat(info.dli_fname, &st)) {
93 return false;
94 }
95 *timestamp = st.st_mtime;
96 return true;
97 #else
98 return false;
99 #endif
100 }
101
102 /* Provide inlined stub functions if the shader cache is disabled. */
103
104 #ifdef ENABLE_SHADER_CACHE
105
106 /**
107 * Create a new cache object.
108 *
109 * This function creates the handle necessary for all subsequent cache_*
110 * functions.
111 *
112 * This cache provides two distinct operations:
113 *
114 * o Storage and retrieval of arbitrary objects by cryptographic
115 * name (or "key"). This is provided via disk_cache_put() and
116 * disk_cache_get().
117 *
118 * o The ability to store a key alone and check later whether the
119 * key was previously stored. This is provided via disk_cache_put_key()
120 * and disk_cache_has_key().
121 *
122 * The put_key()/has_key() operations are conceptually identical to
123 * put()/get() with no data, but are provided separately to allow for
124 * a more efficient implementation.
125 *
126 * In all cases, the keys are sequences of 20 bytes. It is anticipated
127 * that callers will compute appropriate SHA-1 signatures for keys,
128 * (though nothing in this implementation directly relies on how the
129 * names are computed). See mesa-sha1.h and _mesa_sha1_compute for
130 * assistance in computing SHA-1 signatures.
131 */
132 struct disk_cache *
133 disk_cache_create(const char *gpu_name, const char *timestamp,
134 uint64_t driver_flags);
135
136 /**
137 * Destroy a cache object, (freeing all associated resources).
138 */
139 void
140 disk_cache_destroy(struct disk_cache *cache);
141
142 /**
143 * Remove the item in the cache under the name \key.
144 */
145 void
146 disk_cache_remove(struct disk_cache *cache, const cache_key key);
147
148 /**
149 * Store an item in the cache under the name \key.
150 *
151 * The item can be retrieved later with disk_cache_get(), (unless the item has
152 * been evicted in the interim).
153 *
154 * Any call to disk_cache_put() may cause an existing, random item to be
155 * evicted from the cache.
156 */
157 void
158 disk_cache_put(struct disk_cache *cache, const cache_key key,
159 const void *data, size_t size,
160 struct cache_item_metadata *cache_item_metadata);
161
162 /**
163 * Retrieve an item previously stored in the cache with the name <key>.
164 *
165 * The item must have been previously stored with a call to disk_cache_put().
166 *
167 * If \size is non-NULL, then, on successful return, it will be set to the
168 * size of the object.
169 *
170 * \return A pointer to the stored object if found. NULL if the object
171 * is not found, or if any error occurs, (memory allocation failure,
172 * filesystem error, etc.). The returned data is malloc'ed so the
173 * caller should call free() it when finished.
174 */
175 void *
176 disk_cache_get(struct disk_cache *cache, const cache_key key, size_t *size);
177
178 /**
179 * Store the name \key within the cache, (without any associated data).
180 *
181 * Later this key can be checked with disk_cache_has_key(), (unless the key
182 * has been evicted in the interim).
183 *
184 * Any call to disk_cache_put_key() may cause an existing, random key to be
185 * evicted from the cache.
186 */
187 void
188 disk_cache_put_key(struct disk_cache *cache, const cache_key key);
189
190 /**
191 * Test whether the name \key was previously recorded in the cache.
192 *
193 * Return value: True if disk_cache_put_key() was previously called with
194 * \key, (and the key was not evicted in the interim).
195 *
196 * Note: disk_cache_has_key() will only return true for keys passed to
197 * disk_cache_put_key(). Specifically, a call to disk_cache_put() will not cause
198 * disk_cache_has_key() to return true for the same key.
199 */
200 bool
201 disk_cache_has_key(struct disk_cache *cache, const cache_key key);
202
203 /**
204 * Compute the name \key from \data of given \size.
205 */
206 void
207 disk_cache_compute_key(struct disk_cache *cache, const void *data, size_t size,
208 cache_key key);
209
210 #else
211
212 static inline struct disk_cache *
disk_cache_create(const char * gpu_name,const char * timestamp,uint64_t driver_flags)213 disk_cache_create(const char *gpu_name, const char *timestamp,
214 uint64_t driver_flags)
215 {
216 return NULL;
217 }
218
219 static inline void
disk_cache_destroy(struct disk_cache * cache)220 disk_cache_destroy(struct disk_cache *cache) {
221 return;
222 }
223
224 static inline void
disk_cache_put(struct disk_cache * cache,const cache_key key,const void * data,size_t size,struct cache_item_metadata * cache_item_metadata)225 disk_cache_put(struct disk_cache *cache, const cache_key key,
226 const void *data, size_t size,
227 struct cache_item_metadata *cache_item_metadata)
228 {
229 return;
230 }
231
232 static inline void
disk_cache_remove(struct disk_cache * cache,const cache_key key)233 disk_cache_remove(struct disk_cache *cache, const cache_key key)
234 {
235 return;
236 }
237
238 static inline uint8_t *
disk_cache_get(struct disk_cache * cache,const cache_key key,size_t * size)239 disk_cache_get(struct disk_cache *cache, const cache_key key, size_t *size)
240 {
241 return NULL;
242 }
243
244 static inline void
disk_cache_put_key(struct disk_cache * cache,const cache_key key)245 disk_cache_put_key(struct disk_cache *cache, const cache_key key)
246 {
247 return;
248 }
249
250 static inline bool
disk_cache_has_key(struct disk_cache * cache,const cache_key key)251 disk_cache_has_key(struct disk_cache *cache, const cache_key key)
252 {
253 return false;
254 }
255
256 static inline void
disk_cache_compute_key(struct disk_cache * cache,const void * data,size_t size,const cache_key key)257 disk_cache_compute_key(struct disk_cache *cache, const void *data, size_t size,
258 const cache_key key)
259 {
260 return;
261 }
262
263 #endif /* ENABLE_SHADER_CACHE */
264
265 #ifdef __cplusplus
266 }
267 #endif
268
269 #endif /* CACHE_H */
270