src/util/disk_cache.h

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