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 struct disk_cache;
  47
  48 static inline bool
  49 disk_cache_get_function_timestamp(void *ptr, uint32_t* timestamp)
  50 {
  51 #ifdef ENABLE_SHADER_CACHE
  52    Dl_info info;
  53    struct stat st;
  54    if (!dladdr(ptr, &info) || !info.dli_fname) {
  55       return false;
  56    }
  57    if (stat(info.dli_fname, &st)) {
  58       return false;
  59    }
  60    *timestamp = st.st_mtime;
  61    return true;
  62 #else
  63    return false;
  64 #endif
  65 }
  66
  67 /* Provide inlined stub functions if the shader cache is disabled. */
  68
  69 #ifdef ENABLE_SHADER_CACHE
  70
  71 /**
  72  * Create a new cache object.
  73  *
  74  * This function creates the handle necessary for all subsequent cache_*
  75  * functions.
  76  *
  77  * This cache provides two distinct operations:
  78  *
  79  *   o Storage and retrieval of arbitrary objects by cryptographic
  80  *     name (or "key").  This is provided via disk_cache_put() and
  81  *     disk_cache_get().
  82  *
  83  *   o The ability to store a key alone and check later whether the
  84  *     key was previously stored. This is provided via disk_cache_put_key()
  85  *     and disk_cache_has_key().
  86  *
  87  * The put_key()/has_key() operations are conceptually identical to
  88  * put()/get() with no data, but are provided separately to allow for
  89  * a more efficient implementation.
  90  *
  91  * In all cases, the keys are sequences of 20 bytes. It is anticipated
  92  * that callers will compute appropriate SHA-1 signatures for keys,
  93  * (though nothing in this implementation directly relies on how the
  94  * names are computed). See mesa-sha1.h and _mesa_sha1_compute for
  95  * assistance in computing SHA-1 signatures.
  96  */
  97 struct disk_cache *
  98 disk_cache_create(const char *gpu_name, const char *timestamp,
  99                   uint64_t driver_flags);
 100
 101 /**
 102  * Destroy a cache object, (freeing all associated resources).
 103  */
 104 void
 105 disk_cache_destroy(struct disk_cache *cache);
 106
 107 /**
 108  * Remove the item in the cache under the name \key.
 109  */
 110 void
 111 disk_cache_remove(struct disk_cache *cache, const cache_key key);
 112
 113 /**
 114  * Store an item in the cache under the name \key.
 115  *
 116  * The item can be retrieved later with disk_cache_get(), (unless the item has
 117  * been evicted in the interim).
 118  *
 119  * Any call to disk_cache_put() may cause an existing, random item to be
 120  * evicted from the cache.
 121  */
 122 void
 123 disk_cache_put(struct disk_cache *cache, const cache_key key,
 124                const void *data, size_t size);
 125
 126 /**
 127  * Retrieve an item previously stored in the cache with the name <key>.
 128  *
 129  * The item must have been previously stored with a call to disk_cache_put().
 130  *
 131  * If \size is non-NULL, then, on successful return, it will be set to the
 132  * size of the object.
 133  *
 134  * \return A pointer to the stored object if found. NULL if the object
 135  * is not found, or if any error occurs, (memory allocation failure,
 136  * filesystem error, etc.). The returned data is malloc'ed so the
 137  * caller should call free() it when finished.
 138  */
 139 void *
 140 disk_cache_get(struct disk_cache *cache, const cache_key key, size_t *size);
 141
 142 /**
 143  * Store the name \key within the cache, (without any associated data).
 144  *
 145  * Later this key can be checked with disk_cache_has_key(), (unless the key
 146  * has been evicted in the interim).
 147  *
 148  * Any call to disk_cache_put_key() may cause an existing, random key to be
 149  * evicted from the cache.
 150  */
 151 void
 152 disk_cache_put_key(struct disk_cache *cache, const cache_key key);
 153
 154 /**
 155  * Test whether the name \key was previously recorded in the cache.
 156  *
 157  * Return value: True if disk_cache_put_key() was previously called with
 158  * \key, (and the key was not evicted in the interim).
 159  *
 160  * Note: disk_cache_has_key() will only return true for keys passed to
 161  * disk_cache_put_key(). Specifically, a call to disk_cache_put() will not cause
 162  * disk_cache_has_key() to return true for the same key.
 163  */
 164 bool
 165 disk_cache_has_key(struct disk_cache *cache, const cache_key key);
 166
 167 /**
 168  * Compute the name \key from \data of given \size.
 169  */
 170 void
 171 disk_cache_compute_key(struct disk_cache *cache, const void *data, size_t size,
 172                        cache_key key);
 173
 174 #else
 175
 176 static inline struct disk_cache *
 177 disk_cache_create(const char *gpu_name, const char *timestamp,
 178                   uint64_t driver_flags)
 179 {
 180    return NULL;
 181 }
 182
 183 static inline void
 184 disk_cache_destroy(struct disk_cache *cache) {
 185    return;
 186 }
 187
 188 static inline void
 189 disk_cache_put(struct disk_cache *cache, const cache_key key,
 190           const void *data, size_t size)
 191 {
 192    return;
 193 }
 194
 195 static inline void
 196 disk_cache_remove(struct disk_cache *cache, const cache_key key)
 197 {
 198    return;
 199 }
 200
 201 static inline uint8_t *
 202 disk_cache_get(struct disk_cache *cache, const cache_key key, size_t *size)
 203 {
 204    return NULL;
 205 }
 206
 207 static inline void
 208 disk_cache_put_key(struct disk_cache *cache, const cache_key key)
 209 {
 210    return;
 211 }
 212
 213 static inline bool
 214 disk_cache_has_key(struct disk_cache *cache, const cache_key key)
 215 {
 216    return false;
 217 }
 218
 219 static inline void
 220 disk_cache_compute_key(struct disk_cache *cache, const void *data, size_t size,
 221                        const cache_key key)
 222 {
 223    return;
 224 }
 225
 226 #endif /* ENABLE_SHADER_CACHE */
 227
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 #endif /* CACHE_H */