src/intel/vulkan/anv_pipeline_cache.c

   1 /*
   2  * Copyright © 2015 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 #include "util/mesa-sha1.h"
  25 #include "util/debug.h"
  26 #include "anv_private.h"
  27
  28 /* Remaining work:
  29  *
  30  * - Compact binding table layout so it's tight and not dependent on
  31  *   descriptor set layout.
  32  *
  33  * - Review prog_data struct for size and cacheability: struct
  34  *   brw_stage_prog_data has binding_table which uses a lot of uint32_t for 8
  35  *   bit quantities etc; param, pull_param, and image_params are pointers, we
  36  *   just need the compation map. use bit fields for all bools, eg
  37  *   dual_src_blend.
  38  */
  39
  40 void
  41 anv_pipeline_cache_init(struct anv_pipeline_cache *cache,
  42                         struct anv_device *device)
  43 {
  44    cache->device = device;
  45    anv_state_stream_init(&cache->program_stream,
  46                          &device->instruction_block_pool);
  47    pthread_mutex_init(&cache->mutex, NULL);
  48
  49    cache->kernel_count = 0;
  50    cache->total_size = 0;
  51    cache->table_size = 1024;
  52    const size_t byte_size = cache->table_size * sizeof(cache->hash_table[0]);
  53    cache->hash_table = malloc(byte_size);
  54
  55    /* We don't consider allocation failure fatal, we just start with a 0-sized
  56     * cache. */
  57    if (cache->hash_table == NULL)
  58       cache->table_size = 0;
  59    else
  60       memset(cache->hash_table, 0xff, byte_size);
  61 }
  62
  63 void
  64 anv_pipeline_cache_finish(struct anv_pipeline_cache *cache)
  65 {
  66    anv_state_stream_finish(&cache->program_stream);
  67    pthread_mutex_destroy(&cache->mutex);
  68    free(cache->hash_table);
  69 }
  70
  71 struct cache_entry {
  72    unsigned char sha1[20];
  73    uint32_t prog_data_size;
  74    uint32_t kernel_size;
  75    char prog_data[0];
  76
  77    /* kernel follows prog_data at next 64 byte aligned address */
  78 };
  79
  80 static uint32_t
  81 entry_size(struct cache_entry *entry)
  82 {
  83    /* This returns the number of bytes needed to serialize an entry, which
  84     * doesn't include the alignment padding bytes.
  85     */
  86
  87    return sizeof(*entry) + entry->prog_data_size + entry->kernel_size;
  88 }
  89
  90 void
  91 anv_hash_shader(unsigned char *hash, const void *key, size_t key_size,
  92                 struct anv_shader_module *module,
  93                 const char *entrypoint,
  94                 const VkSpecializationInfo *spec_info)
  95 {
  96    struct mesa_sha1 *ctx;
  97
  98    ctx = _mesa_sha1_init();
  99    _mesa_sha1_update(ctx, key, key_size);
 100    _mesa_sha1_update(ctx, module->sha1, sizeof(module->sha1));
 101    _mesa_sha1_update(ctx, entrypoint, strlen(entrypoint));
 102    /* hash in shader stage, pipeline layout? */
 103    if (spec_info) {
 104       _mesa_sha1_update(ctx, spec_info->pMapEntries,
 105                         spec_info->mapEntryCount * sizeof spec_info->pMapEntries[0]);
 106       _mesa_sha1_update(ctx, spec_info->pData, spec_info->dataSize);
 107    }
 108    _mesa_sha1_final(ctx, hash);
 109 }
 110
 111 uint32_t
 112 anv_pipeline_cache_search(struct anv_pipeline_cache *cache,
 113                           const unsigned char *sha1, void *prog_data)
 114 {
 115    const uint32_t mask = cache->table_size - 1;
 116    const uint32_t start = (*(uint32_t *) sha1);
 117
 118    for (uint32_t i = 0; i < cache->table_size; i++) {
 119       const uint32_t index = (start + i) & mask;
 120       const uint32_t offset = cache->hash_table[index];
 121
 122       if (offset == ~0)
 123          return NO_KERNEL;
 124
 125       struct cache_entry *entry =
 126          cache->program_stream.block_pool->map + offset;
 127       if (memcmp(entry->sha1, sha1, sizeof(entry->sha1)) == 0) {
 128          if (prog_data)
 129             memcpy(prog_data, entry->prog_data, entry->prog_data_size);
 130
 131          const uint32_t preamble_size =
 132             align_u32(sizeof(*entry) + entry->prog_data_size, 64);
 133
 134          return offset + preamble_size;
 135       }
 136    }
 137
 138    return NO_KERNEL;
 139 }
 140
 141 static void
 142 anv_pipeline_cache_add_entry(struct anv_pipeline_cache *cache,
 143                              struct cache_entry *entry, uint32_t entry_offset)
 144 {
 145    const uint32_t mask = cache->table_size - 1;
 146    const uint32_t start = (*(uint32_t *) entry->sha1);
 147
 148    /* We'll always be able to insert when we get here. */
 149    assert(cache->kernel_count < cache->table_size / 2);
 150
 151    for (uint32_t i = 0; i < cache->table_size; i++) {
 152       const uint32_t index = (start + i) & mask;
 153       if (cache->hash_table[index] == ~0) {
 154          cache->hash_table[index] = entry_offset;
 155          break;
 156       }
 157    }
 158
 159    cache->total_size += entry_size(entry);
 160    cache->kernel_count++;
 161 }
 162
 163 static VkResult
 164 anv_pipeline_cache_grow(struct anv_pipeline_cache *cache)
 165 {
 166    const uint32_t table_size = cache->table_size * 2;
 167    const uint32_t old_table_size = cache->table_size;
 168    const size_t byte_size = table_size * sizeof(cache->hash_table[0]);
 169    uint32_t *table;
 170    uint32_t *old_table = cache->hash_table;
 171
 172    table = malloc(byte_size);
 173    if (table == NULL)
 174       return VK_ERROR_OUT_OF_HOST_MEMORY;
 175
 176    cache->hash_table = table;
 177    cache->table_size = table_size;
 178    cache->kernel_count = 0;
 179    cache->total_size = 0;
 180
 181    memset(cache->hash_table, 0xff, byte_size);
 182    for (uint32_t i = 0; i < old_table_size; i++) {
 183       const uint32_t offset = old_table[i];
 184       if (offset == ~0)
 185          continue;
 186
 187       struct cache_entry *entry =
 188          cache->program_stream.block_pool->map + offset;
 189       anv_pipeline_cache_add_entry(cache, entry, offset);
 190    }
 191
 192    free(old_table);
 193
 194    return VK_SUCCESS;
 195 }
 196
 197 uint32_t
 198 anv_pipeline_cache_upload_kernel(struct anv_pipeline_cache *cache,
 199                                  const unsigned char *sha1,
 200                                  const void *kernel, size_t kernel_size,
 201                                  const void *prog_data, size_t prog_data_size)
 202 {
 203    pthread_mutex_lock(&cache->mutex);
 204    struct cache_entry *entry;
 205
 206    /* Meta pipelines don't have SPIR-V, so we can't hash them.
 207     * Consequentally, they just don't get cached.
 208     */
 209    const uint32_t preamble_size = sha1 ?
 210       align_u32(sizeof(*entry) + prog_data_size, 64) :
 211       0;
 212
 213    const uint32_t size = preamble_size + kernel_size;
 214
 215    assert(size < cache->program_stream.block_pool->block_size);
 216    const struct anv_state state =
 217       anv_state_stream_alloc(&cache->program_stream, size, 64);
 218
 219    if (sha1 && env_var_as_boolean("ANV_ENABLE_PIPELINE_CACHE", false)) {
 220       assert(anv_pipeline_cache_search(cache, sha1, NULL) == NO_KERNEL);
 221       entry = state.map;
 222       memcpy(entry->sha1, sha1, sizeof(entry->sha1));
 223       entry->prog_data_size = prog_data_size;
 224       memcpy(entry->prog_data, prog_data, prog_data_size);
 225       entry->kernel_size = kernel_size;
 226
 227       if (cache->kernel_count == cache->table_size / 2)
 228          anv_pipeline_cache_grow(cache);
 229
 230       /* Failing to grow that hash table isn't fatal, but may mean we don't
 231        * have enough space to add this new kernel. Only add it if there's room.
 232        */
 233       if (cache->kernel_count < cache->table_size / 2)
 234          anv_pipeline_cache_add_entry(cache, entry, state.offset);
 235    }
 236
 237    pthread_mutex_unlock(&cache->mutex);
 238
 239    memcpy(state.map + preamble_size, kernel, kernel_size);
 240
 241    if (!cache->device->info.has_llc)
 242       anv_state_clflush(state);
 243
 244    return state.offset + preamble_size;
 245 }
 246
 247 struct cache_header {
 248    uint32_t header_size;
 249    uint32_t header_version;
 250    uint32_t vendor_id;
 251    uint32_t device_id;
 252    uint8_t  uuid[VK_UUID_SIZE];
 253 };
 254
 255 static void
 256 anv_pipeline_cache_load(struct anv_pipeline_cache *cache,
 257                         const void *data, size_t size)
 258 {
 259    struct anv_device *device = cache->device;
 260    struct cache_header header;
 261    uint8_t uuid[VK_UUID_SIZE];
 262
 263    if (size < sizeof(header))
 264       return;
 265    memcpy(&header, data, sizeof(header));
 266    if (header.header_size < sizeof(header))
 267       return;
 268    if (header.header_version != VK_PIPELINE_CACHE_HEADER_VERSION_ONE)
 269       return;
 270    if (header.vendor_id != 0x8086)
 271       return;
 272    if (header.device_id != device->chipset_id)
 273       return;
 274    anv_device_get_cache_uuid(uuid);
 275    if (memcmp(header.uuid, uuid, VK_UUID_SIZE) != 0)
 276       return;
 277
 278    const void *end = data + size;
 279    const void *p = data + header.header_size;
 280
 281    while (p < end) {
 282       /* The kernels aren't 64 byte aligned in the serialized format so
 283        * they're always right after the prog_data.
 284        */
 285       const struct cache_entry *entry = p;
 286       const void *kernel = &entry->prog_data[entry->prog_data_size];
 287
 288       anv_pipeline_cache_upload_kernel(cache, entry->sha1,
 289                                        kernel, entry->kernel_size,
 290                                        entry->prog_data, entry->prog_data_size);
 291       p = kernel + entry->kernel_size;
 292    }
 293 }
 294
 295 VkResult anv_CreatePipelineCache(
 296     VkDevice                                    _device,
 297     const VkPipelineCacheCreateInfo*            pCreateInfo,
 298     const VkAllocationCallbacks*                pAllocator,
 299     VkPipelineCache*                            pPipelineCache)
 300 {
 301    ANV_FROM_HANDLE(anv_device, device, _device);
 302    struct anv_pipeline_cache *cache;
 303
 304    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO);
 305    assert(pCreateInfo->flags == 0);
 306
 307    cache = anv_alloc2(&device->alloc, pAllocator,
 308                        sizeof(*cache), 8,
 309                        VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 310    if (cache == NULL)
 311       return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
 312
 313    anv_pipeline_cache_init(cache, device);
 314
 315    if (pCreateInfo->initialDataSize > 0)
 316       anv_pipeline_cache_load(cache,
 317                               pCreateInfo->pInitialData,
 318                               pCreateInfo->initialDataSize);
 319
 320    *pPipelineCache = anv_pipeline_cache_to_handle(cache);
 321
 322    return VK_SUCCESS;
 323 }
 324
 325 void anv_DestroyPipelineCache(
 326     VkDevice                                    _device,
 327     VkPipelineCache                             _cache,
 328     const VkAllocationCallbacks*                pAllocator)
 329 {
 330    ANV_FROM_HANDLE(anv_device, device, _device);
 331    ANV_FROM_HANDLE(anv_pipeline_cache, cache, _cache);
 332
 333    anv_pipeline_cache_finish(cache);
 334
 335    anv_free2(&device->alloc, pAllocator, cache);
 336 }
 337
 338 VkResult anv_GetPipelineCacheData(
 339     VkDevice                                    _device,
 340     VkPipelineCache                             _cache,
 341     size_t*                                     pDataSize,
 342     void*                                       pData)
 343 {
 344    ANV_FROM_HANDLE(anv_device, device, _device);
 345    ANV_FROM_HANDLE(anv_pipeline_cache, cache, _cache);
 346    struct cache_header *header;
 347
 348    const size_t size = sizeof(*header) + cache->total_size;
 349
 350    if (pData == NULL) {
 351       *pDataSize = size;
 352       return VK_SUCCESS;
 353    }
 354
 355    if (*pDataSize < sizeof(*header)) {
 356       *pDataSize = 0;
 357       return VK_INCOMPLETE;
 358    }
 359
 360    void *p = pData, *end = pData + *pDataSize;
 361    header = p;
 362    header->header_size = sizeof(*header);
 363    header->header_version = VK_PIPELINE_CACHE_HEADER_VERSION_ONE;
 364    header->vendor_id = 0x8086;
 365    header->device_id = device->chipset_id;
 366    anv_device_get_cache_uuid(header->uuid);
 367    p += header->header_size;
 368
 369    struct cache_entry *entry;
 370    for (uint32_t i = 0; i < cache->table_size; i++) {
 371       if (cache->hash_table[i] == ~0)
 372          continue;
 373
 374       entry = cache->program_stream.block_pool->map + cache->hash_table[i];
 375       if (end < p + entry_size(entry))
 376          break;
 377
 378       memcpy(p, entry, sizeof(*entry) + entry->prog_data_size);
 379       p += sizeof(*entry) + entry->prog_data_size;
 380
 381       void *kernel = (void *) entry +
 382          align_u32(sizeof(*entry) + entry->prog_data_size, 64);
 383
 384       memcpy(p, kernel, entry->kernel_size);
 385       p += entry->kernel_size;
 386    }
 387
 388    *pDataSize = p - pData;
 389
 390    return VK_SUCCESS;
 391 }
 392
 393 static void
 394 anv_pipeline_cache_merge(struct anv_pipeline_cache *dst,
 395                          struct anv_pipeline_cache *src)
 396 {
 397    for (uint32_t i = 0; i < src->table_size; i++) {
 398       if (src->hash_table[i] == ~0)
 399          continue;
 400
 401       struct cache_entry *entry =
 402          src->program_stream.block_pool->map + src->hash_table[i];
 403
 404       if (anv_pipeline_cache_search(dst, entry->sha1, NULL) != NO_KERNEL)
 405          continue;
 406
 407       const void *kernel = (void *) entry +
 408          align_u32(sizeof(*entry) + entry->prog_data_size, 64);
 409       anv_pipeline_cache_upload_kernel(dst, entry->sha1,
 410                                        kernel, entry->kernel_size,
 411                                        entry->prog_data, entry->prog_data_size);
 412    }
 413 }
 414
 415 VkResult anv_MergePipelineCaches(
 416     VkDevice                                    _device,
 417     VkPipelineCache                             destCache,
 418     uint32_t                                    srcCacheCount,
 419     const VkPipelineCache*                      pSrcCaches)
 420 {
 421    ANV_FROM_HANDLE(anv_pipeline_cache, dst, destCache);
 422
 423    for (uint32_t i = 0; i < srcCacheCount; i++) {
 424       ANV_FROM_HANDLE(anv_pipeline_cache, src, pSrcCaches[i]);
 425
 426       anv_pipeline_cache_merge(dst, src);
 427    }
 428
 429    return VK_SUCCESS;
 430 }