src/gallium/drivers/iris/iris_disk_cache.c

   1 /*
   2  * Copyright © 2018 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_disk_cache.c
  25  *
  26  * Functions for interacting with the on-disk shader cache.
  27  */
  28
  29 #include <stdio.h>
  30 #include <stdint.h>
  31 #include <assert.h>
  32 #include <string.h>
  33
  34 #include "compiler/nir/nir.h"
  35 #include "util/blob.h"
  36 #include "util/build_id.h"
  37 #include "util/disk_cache.h"
  38 #include "util/mesa-sha1.h"
  39
  40 #include "iris_context.h"
  41
  42 static bool debug = false;
  43
  44 /**
  45  * Compute a disk cache key for the given uncompiled shader and NOS key.
  46  */
  47 static void
  48 iris_disk_cache_compute_key(struct disk_cache *cache,
  49                             const struct iris_uncompiled_shader *ish,
  50                             const void *orig_prog_key,
  51                             uint32_t prog_key_size,
  52                             cache_key cache_key)
  53 {
  54    /* Create a copy of the program key with program_string_id zeroed out.
  55     * It's essentially random data which we don't want to include in our
  56     * hashing and comparisons.  We'll set a proper value on a cache hit.
  57     */
  58    union brw_any_prog_key prog_key;
  59    memcpy(&prog_key, orig_prog_key, prog_key_size);
  60    prog_key.base.program_string_id = 0;
  61
  62    uint8_t data[sizeof(prog_key) + sizeof(ish->nir_sha1)];
  63    uint32_t data_size = prog_key_size + sizeof(ish->nir_sha1);
  64
  65    memcpy(data, ish->nir_sha1, sizeof(ish->nir_sha1));
  66    memcpy(data + sizeof(ish->nir_sha1), &prog_key, prog_key_size);
  67
  68    disk_cache_compute_key(cache, data, data_size, cache_key);
  69 }
  70
  71 /**
  72  * Store the given compiled shader in the disk cache.
  73  *
  74  * This should only be called on newly compiled shaders.  No checking is
  75  * done to prevent repeated stores of the same shader.
  76  */
  77 void
  78 iris_disk_cache_store(struct disk_cache *cache,
  79                       const struct iris_uncompiled_shader *ish,
  80                       const struct iris_compiled_shader *shader,
  81                       const void *prog_key,
  82                       uint32_t prog_key_size)
  83 {
  84 #ifdef ENABLE_SHADER_CACHE
  85    if (!cache)
  86       return;
  87
  88    gl_shader_stage stage = ish->nir->info.stage;
  89    const struct brw_stage_prog_data *prog_data = shader->prog_data;
  90
  91    cache_key cache_key;
  92    iris_disk_cache_compute_key(cache, ish, prog_key, prog_key_size, cache_key);
  93
  94    if (debug) {
  95       char sha1[41];
  96       _mesa_sha1_format(sha1, cache_key);
  97       fprintf(stderr, "[mesa disk cache] storing %s\n", sha1);
  98    }
  99
 100    struct blob blob;
 101    blob_init(&blob);
 102
 103    /* We write the following data to the cache blob:
 104     *
 105     * 1. Prog data (must come first because it has the assembly size)
 106     * 2. Assembly code
 107     * 3. Number of entries in the system value array
 108     * 4. System value array
 109     * 5. Legacy param array (only used for compute workgroup ID)
 110     * 6. Binding table
 111     */
 112    blob_write_bytes(&blob, shader->prog_data, brw_prog_data_size(stage));
 113    blob_write_bytes(&blob, shader->map, shader->prog_data->program_size);
 114    blob_write_uint32(&blob, shader->num_system_values);
 115    blob_write_bytes(&blob, shader->system_values,
 116                     shader->num_system_values * sizeof(enum brw_param_builtin));
 117    blob_write_uint32(&blob, shader->kernel_input_size);
 118    blob_write_bytes(&blob, prog_data->param,
 119                     prog_data->nr_params * sizeof(uint32_t));
 120    blob_write_bytes(&blob, &shader->bt, sizeof(shader->bt));
 121
 122    disk_cache_put(cache, cache_key, blob.data, blob.size, NULL);
 123    blob_finish(&blob);
 124 #endif
 125 }
 126
 127 static const enum iris_program_cache_id cache_id_for_stage[] = {
 128    [MESA_SHADER_VERTEX]    = IRIS_CACHE_VS,
 129    [MESA_SHADER_TESS_CTRL] = IRIS_CACHE_TCS,
 130    [MESA_SHADER_TESS_EVAL] = IRIS_CACHE_TES,
 131    [MESA_SHADER_GEOMETRY]  = IRIS_CACHE_GS,
 132    [MESA_SHADER_FRAGMENT]  = IRIS_CACHE_FS,
 133    [MESA_SHADER_COMPUTE]   = IRIS_CACHE_CS,
 134 };
 135
 136 /**
 137  * Search for a compiled shader in the disk cache.  If found, upload it
 138  * to the in-memory program cache so we can use it.
 139  */
 140 struct iris_compiled_shader *
 141 iris_disk_cache_retrieve(struct iris_context *ice,
 142                          const struct iris_uncompiled_shader *ish,
 143                          const void *prog_key,
 144                          uint32_t key_size)
 145 {
 146 #ifdef ENABLE_SHADER_CACHE
 147    struct iris_screen *screen = (void *) ice->ctx.screen;
 148    struct disk_cache *cache = screen->disk_cache;
 149    gl_shader_stage stage = ish->nir->info.stage;
 150
 151    if (!cache)
 152       return NULL;
 153
 154    cache_key cache_key;
 155    iris_disk_cache_compute_key(cache, ish, prog_key, key_size, cache_key);
 156
 157    if (debug) {
 158       char sha1[41];
 159       _mesa_sha1_format(sha1, cache_key);
 160       fprintf(stderr, "[mesa disk cache] retrieving %s: ", sha1);
 161    }
 162
 163    size_t size;
 164    void *buffer = disk_cache_get(screen->disk_cache, cache_key, &size);
 165
 166    if (debug)
 167       fprintf(stderr, "%s\n", buffer ? "found" : "missing");
 168
 169    if (!buffer)
 170       return NULL;
 171
 172    const uint32_t prog_data_size = brw_prog_data_size(stage);
 173
 174    struct brw_stage_prog_data *prog_data = ralloc_size(NULL, prog_data_size);
 175    const void *assembly;
 176    uint32_t num_system_values;
 177    uint32_t kernel_input_size;
 178    uint32_t *system_values = NULL;
 179    uint32_t *so_decls = NULL;
 180
 181    struct blob_reader blob;
 182    blob_reader_init(&blob, buffer, size);
 183    blob_copy_bytes(&blob, prog_data, prog_data_size);
 184    assembly = blob_read_bytes(&blob, prog_data->program_size);
 185    num_system_values = blob_read_uint32(&blob);
 186    if (num_system_values) {
 187       system_values =
 188          ralloc_array(NULL, enum brw_param_builtin, num_system_values);
 189       blob_copy_bytes(&blob, system_values,
 190                       num_system_values * sizeof(enum brw_param_builtin));
 191    }
 192
 193    kernel_input_size = blob_read_uint32(&blob);
 194
 195    prog_data->param = NULL;
 196    prog_data->pull_param = NULL;
 197    assert(prog_data->nr_pull_params == 0);
 198
 199    if (prog_data->nr_params) {
 200       prog_data->param = ralloc_array(NULL, uint32_t, prog_data->nr_params);
 201       blob_copy_bytes(&blob, prog_data->param,
 202                       prog_data->nr_params * sizeof(uint32_t));
 203    }
 204
 205    struct iris_binding_table bt;
 206    blob_copy_bytes(&blob, &bt, sizeof(bt));
 207
 208    if (stage == MESA_SHADER_VERTEX ||
 209        stage == MESA_SHADER_TESS_EVAL ||
 210        stage == MESA_SHADER_GEOMETRY) {
 211       struct brw_vue_prog_data *vue_prog_data = (void *) prog_data;
 212       so_decls = screen->vtbl.create_so_decl_list(&ish->stream_output,
 213                                                &vue_prog_data->vue_map);
 214    }
 215
 216    /* System values and uniforms are stored in constant buffer 0, the
 217     * user-facing UBOs are indexed by one.  So if any constant buffer is
 218     * needed, the constant buffer 0 will be needed, so account for it.
 219     */
 220    unsigned num_cbufs = ish->nir->info.num_ubos;
 221
 222    if (num_cbufs || ish->nir->num_uniforms)
 223       num_cbufs++;
 224
 225    if (num_system_values)
 226       num_cbufs++;
 227
 228    assert(stage < ARRAY_SIZE(cache_id_for_stage));
 229    enum iris_program_cache_id cache_id = cache_id_for_stage[stage];
 230
 231    /* Upload our newly read shader to the in-memory program cache and
 232     * return it to the caller.
 233     */
 234    struct iris_compiled_shader *shader =
 235       iris_upload_shader(ice, cache_id, key_size, prog_key, assembly,
 236                          prog_data, so_decls, system_values,
 237                          num_system_values, kernel_input_size, num_cbufs, &bt);
 238
 239    free(buffer);
 240
 241    return shader;
 242 #else
 243    return NULL;
 244 #endif
 245 }
 246
 247 /**
 248  * Initialize the on-disk shader cache.
 249  */
 250 void
 251 iris_disk_cache_init(struct iris_screen *screen)
 252 {
 253 #ifdef ENABLE_SHADER_CACHE
 254    if (INTEL_DEBUG & DEBUG_DISK_CACHE_DISABLE_MASK)
 255       return;
 256
 257    /* array length = print length + nul char + 1 extra to verify it's unused */
 258    char renderer[11];
 259    UNUSED int len =
 260       snprintf(renderer, sizeof(renderer), "iris_%04x", screen->pci_id);
 261    assert(len == sizeof(renderer) - 2);
 262
 263    const struct build_id_note *note =
 264       build_id_find_nhdr_for_addr(iris_disk_cache_init);
 265    assert(note && build_id_length(note) == 20); /* sha1 */
 266
 267    const uint8_t *id_sha1 = build_id_data(note);
 268    assert(id_sha1);
 269
 270    char timestamp[41];
 271    _mesa_sha1_format(timestamp, id_sha1);
 272
 273    const uint64_t driver_flags =
 274       brw_get_compiler_config_value(screen->compiler);
 275    screen->disk_cache = disk_cache_create(renderer, timestamp, driver_flags);
 276 #endif
 277 }