src/gallium/drivers/iris/iris_program_cache.c

   1 /*
   2  * Copyright © 2017 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 shall be included
  12  * in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20  * DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 /**
  24  * @file iris_program_cache.c
  25  *
  26  * The in-memory program cache.  This is basically a hash table mapping
  27  * API-specified shaders and a state key to a compiled variant.  It also
  28  * takes care of uploading shader assembly into a BO for use on the GPU.
  29  */
  30
  31 #include <stdio.h>
  32 #include <errno.h>
  33 #include "pipe/p_defines.h"
  34 #include "pipe/p_state.h"
  35 #include "pipe/p_context.h"
  36 #include "pipe/p_screen.h"
  37 #include "util/u_atomic.h"
  38 #include "util/u_upload_mgr.h"
  39 #include "compiler/nir/nir.h"
  40 #include "compiler/nir/nir_builder.h"
  41 #include "intel/compiler/brw_compiler.h"
  42 #include "intel/compiler/brw_eu.h"
  43 #include "intel/compiler/brw_nir.h"
  44 #include "iris_context.h"
  45 #include "iris_resource.h"
  46
  47 struct keybox {
  48    uint16_t size;
  49    enum iris_program_cache_id cache_id;
  50    uint8_t data[0];
  51 };
  52
  53 static struct keybox *
  54 make_keybox(void *mem_ctx,
  55             enum iris_program_cache_id cache_id,
  56             const void *key,
  57             uint32_t key_size)
  58 {
  59    struct keybox *keybox =
  60       ralloc_size(mem_ctx, sizeof(struct keybox) + key_size);
  61
  62    keybox->cache_id = cache_id;
  63    keybox->size = key_size;
  64    memcpy(keybox->data, key, key_size);
  65
  66    return keybox;
  67 }
  68
  69 static uint32_t
  70 keybox_hash(const void *void_key)
  71 {
  72    const struct keybox *key = void_key;
  73    return _mesa_hash_data(&key->cache_id, key->size + sizeof(key->cache_id));
  74 }
  75
  76 static bool
  77 keybox_equals(const void *void_a, const void *void_b)
  78 {
  79    const struct keybox *a = void_a, *b = void_b;
  80    if (a->size != b->size)
  81       return false;
  82
  83    return memcmp(a->data, b->data, a->size) == 0;
  84 }
  85
  86 struct iris_compiled_shader *
  87 iris_find_cached_shader(struct iris_context *ice,
  88                         enum iris_program_cache_id cache_id,
  89                         uint32_t key_size,
  90                         const void *key)
  91 {
  92    struct keybox *keybox = make_keybox(NULL, cache_id, key, key_size);
  93    struct hash_entry *entry =
  94       _mesa_hash_table_search(ice->shaders.cache, keybox);
  95
  96    ralloc_free(keybox);
  97
  98    return entry ? entry->data : NULL;
  99 }
 100
 101 const void *
 102 iris_find_previous_compile(const struct iris_context *ice,
 103                            enum iris_program_cache_id cache_id,
 104                            unsigned program_string_id)
 105 {
 106    hash_table_foreach(ice->shaders.cache, entry) {
 107       const struct keybox *keybox = entry->key;
 108       const struct brw_base_prog_key *key = (const void *)keybox->data;
 109       if (keybox->cache_id == cache_id &&
 110           key->program_string_id == program_string_id) {
 111          return keybox->data;
 112       }
 113    }
 114
 115    return NULL;
 116 }
 117
 118 void
 119 iris_delete_shader_variants(struct iris_context *ice,
 120                             struct iris_uncompiled_shader *ish)
 121 {
 122    struct hash_table *cache = ice->shaders.cache;
 123    gl_shader_stage stage = ish->nir->info.stage;
 124    enum iris_program_cache_id cache_id = stage;
 125
 126    hash_table_foreach(cache, entry) {
 127       const struct keybox *keybox = entry->key;
 128       const struct brw_base_prog_key *key = (const void *)keybox->data;
 129
 130       if (keybox->cache_id == cache_id &&
 131           key->program_string_id == ish->program_id) {
 132          struct iris_compiled_shader *shader = entry->data;
 133
 134          _mesa_hash_table_remove(cache, entry);
 135
 136          /* Shader variants may still be bound in the context even after
 137           * the API-facing shader has been deleted.  In particular, a draw
 138           * may not have triggered iris_update_compiled_shaders() yet.  In
 139           * that case, we may be referring to that shader's VUE map, stream
 140           * output settings, and so on.  We also like to compare the old and
 141           * new shader programs when swapping them out to flag dirty state.
 142           *
 143           * So, it's hazardous to delete a bound shader variant.  We avoid
 144           * doing so, choosing to instead move "deleted" shader variants to
 145           * a list, deferring the actual deletion until they're not bound.
 146           *
 147           * For simplicity, we always move deleted variants to the list,
 148           * even if we could delete them immediately.  We'll then process
 149           * the list, catching both these variants and any others.
 150           */
 151          list_addtail(&shader->link, &ice->shaders.deleted_variants[stage]);
 152       }
 153    }
 154
 155    /* Process any pending deferred variant deletions. */
 156    list_for_each_entry_safe(struct iris_compiled_shader, shader,
 157                             &ice->shaders.deleted_variants[stage], link) {
 158       /* If the shader is still bound, defer deletion. */
 159       if (ice->shaders.prog[stage] == shader)
 160          continue;
 161
 162       list_del(&shader->link);
 163
 164       /* Actually delete the variant. */
 165       pipe_resource_reference(&shader->assembly.res, NULL);
 166       ralloc_free(shader);
 167    }
 168 }
 169
 170
 171 /**
 172  * Look for an existing entry in the cache that has identical assembly code.
 173  *
 174  * This is useful for programs generating shaders at runtime, where multiple
 175  * distinct shaders (from an API perspective) may compile to the same assembly
 176  * in our backend.  This saves space in the program cache buffer.
 177  */
 178 static const struct iris_compiled_shader *
 179 find_existing_assembly(struct hash_table *cache,
 180                        const void *assembly,
 181                        unsigned assembly_size)
 182 {
 183    hash_table_foreach(cache, entry) {
 184       const struct iris_compiled_shader *existing = entry->data;
 185       if (existing->prog_data->program_size == assembly_size &&
 186           memcmp(existing->map, assembly, assembly_size) == 0)
 187          return existing;
 188    }
 189    return NULL;
 190 }
 191
 192 struct iris_compiled_shader *
 193 iris_upload_shader(struct iris_context *ice,
 194                    enum iris_program_cache_id cache_id,
 195                    uint32_t key_size,
 196                    const void *key,
 197                    const void *assembly,
 198                    struct brw_stage_prog_data *prog_data,
 199                    uint32_t *streamout,
 200                    enum brw_param_builtin *system_values,
 201                    unsigned num_system_values,
 202                    unsigned num_cbufs,
 203                    const struct iris_binding_table *bt)
 204 {
 205    struct hash_table *cache = ice->shaders.cache;
 206    struct iris_screen *screen = (struct iris_screen *)ice->ctx.screen;
 207    struct iris_compiled_shader *shader =
 208       rzalloc_size(cache, sizeof(struct iris_compiled_shader) +
 209                    screen->vtbl.derived_program_state_size(cache_id));
 210    const struct iris_compiled_shader *existing =
 211       find_existing_assembly(cache, assembly, prog_data->program_size);
 212
 213    /* If we can find a matching prog in the cache already, then reuse the
 214     * existing stuff without creating new copy into the underlying buffer
 215     * object.  This is notably useful for programs generating shaders at
 216     * runtime, where multiple shaders may compile to the same thing in our
 217     * backend.
 218     */
 219    if (existing) {
 220       pipe_resource_reference(&shader->assembly.res, existing->assembly.res);
 221       shader->assembly.offset = existing->assembly.offset;
 222       shader->map = existing->map;
 223    } else {
 224       shader->assembly.res = NULL;
 225       u_upload_alloc(ice->shaders.uploader, 0, prog_data->program_size, 64,
 226                      &shader->assembly.offset, &shader->assembly.res,
 227                      &shader->map);
 228       memcpy(shader->map, assembly, prog_data->program_size);
 229    }
 230
 231    list_inithead(&shader->link);
 232
 233    shader->prog_data = prog_data;
 234    shader->streamout = streamout;
 235    shader->system_values = system_values;
 236    shader->num_system_values = num_system_values;
 237    shader->num_cbufs = num_cbufs;
 238    shader->bt = *bt;
 239
 240    ralloc_steal(shader, shader->prog_data);
 241    ralloc_steal(shader->prog_data, prog_data->param);
 242    ralloc_steal(shader->prog_data, prog_data->pull_param);
 243    ralloc_steal(shader, shader->streamout);
 244    ralloc_steal(shader, shader->system_values);
 245
 246    /* Store the 3DSTATE shader packets and other derived state. */
 247    screen->vtbl.store_derived_program_state(ice, cache_id, shader);
 248
 249    struct keybox *keybox = make_keybox(shader, cache_id, key, key_size);
 250    _mesa_hash_table_insert(ice->shaders.cache, keybox, shader);
 251
 252    return shader;
 253 }
 254
 255 bool
 256 iris_blorp_lookup_shader(struct blorp_batch *blorp_batch,
 257                          const void *key, uint32_t key_size,
 258                          uint32_t *kernel_out, void *prog_data_out)
 259 {
 260    struct blorp_context *blorp = blorp_batch->blorp;
 261    struct iris_context *ice = blorp->driver_ctx;
 262    struct iris_batch *batch = blorp_batch->driver_batch;
 263    struct iris_compiled_shader *shader =
 264       iris_find_cached_shader(ice, IRIS_CACHE_BLORP, key_size, key);
 265
 266    if (!shader)
 267       return false;
 268
 269    struct iris_bo *bo = iris_resource_bo(shader->assembly.res);
 270    *kernel_out =
 271       iris_bo_offset_from_base_address(bo) + shader->assembly.offset;
 272    *((void **) prog_data_out) = shader->prog_data;
 273
 274    iris_use_pinned_bo(batch, bo, false, IRIS_DOMAIN_NONE);
 275
 276    return true;
 277 }
 278
 279 bool
 280 iris_blorp_upload_shader(struct blorp_batch *blorp_batch, uint32_t stage,
 281                          const void *key, uint32_t key_size,
 282                          const void *kernel, UNUSED uint32_t kernel_size,
 283                          const struct brw_stage_prog_data *prog_data_templ,
 284                          UNUSED uint32_t prog_data_size,
 285                          uint32_t *kernel_out, void *prog_data_out)
 286 {
 287    struct blorp_context *blorp = blorp_batch->blorp;
 288    struct iris_context *ice = blorp->driver_ctx;
 289    struct iris_batch *batch = blorp_batch->driver_batch;
 290
 291    void *prog_data = ralloc_size(NULL, prog_data_size);
 292    memcpy(prog_data, prog_data_templ, prog_data_size);
 293
 294    struct iris_binding_table bt;
 295    memset(&bt, 0, sizeof(bt));
 296
 297    struct iris_compiled_shader *shader =
 298       iris_upload_shader(ice, IRIS_CACHE_BLORP, key_size, key, kernel,
 299                          prog_data, NULL, NULL, 0, 0, &bt);
 300
 301    struct iris_bo *bo = iris_resource_bo(shader->assembly.res);
 302    *kernel_out =
 303       iris_bo_offset_from_base_address(bo) + shader->assembly.offset;
 304    *((void **) prog_data_out) = shader->prog_data;
 305
 306    iris_use_pinned_bo(batch, bo, false, IRIS_DOMAIN_NONE);
 307
 308    return true;
 309 }
 310
 311 void
 312 iris_init_program_cache(struct iris_context *ice)
 313 {
 314    ice->shaders.cache =
 315       _mesa_hash_table_create(ice, keybox_hash, keybox_equals);
 316
 317    ice->shaders.uploader =
 318       u_upload_create(&ice->ctx, 16384, PIPE_BIND_CUSTOM, PIPE_USAGE_IMMUTABLE,
 319                       IRIS_RESOURCE_FLAG_SHADER_MEMZONE);
 320
 321    for (int i = 0; i < MESA_SHADER_STAGES; i++)
 322       list_inithead(&ice->shaders.deleted_variants[i]);
 323 }
 324
 325 void
 326 iris_destroy_program_cache(struct iris_context *ice)
 327 {
 328    for (int i = 0; i < MESA_SHADER_STAGES; i++) {
 329       ice->shaders.prog[i] = NULL;
 330
 331       list_for_each_entry_safe(struct iris_compiled_shader, shader,
 332                                &ice->shaders.deleted_variants[i], link) {
 333          pipe_resource_reference(&shader->assembly.res, NULL);
 334       }
 335    }
 336
 337    hash_table_foreach(ice->shaders.cache, entry) {
 338       struct iris_compiled_shader *shader = entry->data;
 339       pipe_resource_reference(&shader->assembly.res, NULL);
 340    }
 341
 342    u_upload_destroy(ice->shaders.uploader);
 343
 344    ralloc_free(ice->shaders.cache);
 345 }
 346
 347 static const char *
 348 cache_name(enum iris_program_cache_id cache_id)
 349 {
 350    if (cache_id == IRIS_CACHE_BLORP)
 351       return "BLORP";
 352
 353    return _mesa_shader_stage_to_string(cache_id);
 354 }
 355
 356 void
 357 iris_print_program_cache(struct iris_context *ice)
 358 {
 359    struct iris_screen *screen = (struct iris_screen *)ice->ctx.screen;
 360    const struct gen_device_info *devinfo = &screen->devinfo;
 361
 362    hash_table_foreach(ice->shaders.cache, entry) {
 363       const struct keybox *keybox = entry->key;
 364       struct iris_compiled_shader *shader = entry->data;
 365       fprintf(stderr, "%s:\n", cache_name(keybox->cache_id));
 366       brw_disassemble(devinfo, shader->map, 0,
 367                       shader->prog_data->program_size, stderr);
 368    }
 369 }