src/mesa/state_tracker/st_shader_cache.c

   1 /*
   2  * Copyright © 2017 Timothy Arceri
   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
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include <stdio.h>
  25 #include "st_debug.h"
  26 #include "st_program.h"
  27 #include "st_shader_cache.h"
  28 #include "compiler/glsl/program.h"
  29 #include "pipe/p_shader_tokens.h"
  30 #include "program/ir_to_mesa.h"
  31 #include "util/u_memory.h"
  32
  33 static void
  34 write_stream_out_to_cache(struct blob *blob,
  35                           struct pipe_shader_state *tgsi)
  36 {
  37    blob_write_bytes(blob, &tgsi->stream_output,
  38                     sizeof(tgsi->stream_output));
  39 }
  40
  41 static void
  42 write_tgsi_to_cache(struct blob *blob, struct pipe_shader_state *tgsi,
  43                     struct gl_program *prog, unsigned num_tokens)
  44 {
  45    blob_write_uint32(blob, num_tokens);
  46    blob_write_bytes(blob, tgsi->tokens,
  47                     num_tokens * sizeof(struct tgsi_token));
  48
  49    prog->driver_cache_blob = ralloc_size(NULL, blob->size);
  50    memcpy(prog->driver_cache_blob, blob->data, blob->size);
  51    prog->driver_cache_blob_size = blob->size;
  52 }
  53
  54 /**
  55  * Store tgsi and any other required state in on-disk shader cache.
  56  */
  57 void
  58 st_store_tgsi_in_disk_cache(struct st_context *st, struct gl_program *prog,
  59                             struct pipe_shader_state *out_state,
  60                             unsigned num_tokens)
  61 {
  62    if (!st->ctx->Cache)
  63       return;
  64
  65    /* Exit early when we are dealing with a ff shader with no source file to
  66     * generate a source from.
  67     */
  68    static const char zero[sizeof(prog->sh.data->sha1)] = {0};
  69    if (memcmp(prog->sh.data->sha1, zero, sizeof(prog->sh.data->sha1)) == 0)
  70       return;
  71
  72    struct blob blob;
  73    blob_init(&blob);
  74
  75    switch (prog->info.stage) {
  76    case MESA_SHADER_VERTEX: {
  77       struct st_vertex_program *stvp = (struct st_vertex_program *) prog;
  78
  79       blob_write_uint32(&blob, stvp->num_inputs);
  80       blob_write_bytes(&blob, stvp->index_to_input,
  81                        sizeof(stvp->index_to_input));
  82       blob_write_bytes(&blob, stvp->result_to_output,
  83                        sizeof(stvp->result_to_output));
  84
  85       write_stream_out_to_cache(&blob, &stvp->tgsi);
  86       write_tgsi_to_cache(&blob, &stvp->tgsi, prog, num_tokens);
  87       break;
  88    }
  89    case MESA_SHADER_TESS_CTRL:
  90    case MESA_SHADER_TESS_EVAL:
  91    case MESA_SHADER_GEOMETRY: {
  92       write_stream_out_to_cache(&blob, out_state);
  93       write_tgsi_to_cache(&blob, out_state, prog, num_tokens);
  94       break;
  95    }
  96    case MESA_SHADER_FRAGMENT: {
  97       struct st_fragment_program *stfp = (struct st_fragment_program *) prog;
  98
  99       write_tgsi_to_cache(&blob, &stfp->tgsi, prog, num_tokens);
 100       break;
 101    }
 102    case MESA_SHADER_COMPUTE: {
 103       write_tgsi_to_cache(&blob, out_state, prog, num_tokens);
 104       break;
 105    }
 106    default:
 107       unreachable("Unsupported stage");
 108    }
 109
 110    if (st->ctx->_Shader->Flags & GLSL_CACHE_INFO) {
 111       fprintf(stderr, "putting %s tgsi_tokens in cache\n",
 112               _mesa_shader_stage_to_string(prog->info.stage));
 113    }
 114
 115    blob_finish(&blob);
 116 }
 117
 118 static void
 119 read_stream_out_from_cache(struct blob_reader *blob_reader,
 120                            struct pipe_shader_state *tgsi)
 121 {
 122    blob_copy_bytes(blob_reader, (uint8_t *) &tgsi->stream_output,
 123                     sizeof(tgsi->stream_output));
 124 }
 125
 126 static void
 127 read_tgsi_from_cache(struct blob_reader *blob_reader,
 128                      const struct tgsi_token **tokens)
 129 {
 130    uint32_t num_tokens  = blob_read_uint32(blob_reader);
 131    unsigned tokens_size = num_tokens * sizeof(struct tgsi_token);
 132    *tokens = (const struct tgsi_token*) MALLOC(tokens_size);
 133    blob_copy_bytes(blob_reader, (uint8_t *) *tokens, tokens_size);
 134 }
 135
 136 bool
 137 st_load_tgsi_from_disk_cache(struct gl_context *ctx,
 138                              struct gl_shader_program *prog)
 139 {
 140    if (!ctx->Cache)
 141       return false;
 142
 143    /* If we didn't load the GLSL metadata from cache then we could not have
 144     * loaded the tgsi either.
 145     */
 146    if (prog->data->LinkStatus != linking_skipped)
 147       return false;
 148
 149    struct st_context *st = st_context(ctx);
 150    for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
 151       if (prog->_LinkedShaders[i] == NULL)
 152          continue;
 153
 154       struct gl_program *glprog = prog->_LinkedShaders[i]->Program;
 155
 156       size_t size = glprog->driver_cache_blob_size;
 157       uint8_t *buffer = (uint8_t *) glprog->driver_cache_blob;
 158
 159       struct blob_reader blob_reader;
 160       blob_reader_init(&blob_reader, buffer, size);
 161
 162       switch (glprog->info.stage) {
 163       case MESA_SHADER_VERTEX: {
 164          struct st_vertex_program *stvp = (struct st_vertex_program *) glprog;
 165
 166          st_release_vp_variants(st, stvp);
 167
 168          stvp->num_inputs = blob_read_uint32(&blob_reader);
 169          blob_copy_bytes(&blob_reader, (uint8_t *) stvp->index_to_input,
 170                          sizeof(stvp->index_to_input));
 171          blob_copy_bytes(&blob_reader, (uint8_t *) stvp->result_to_output,
 172                          sizeof(stvp->result_to_output));
 173
 174          read_stream_out_from_cache(&blob_reader, &stvp->tgsi);
 175          read_tgsi_from_cache(&blob_reader, &stvp->tgsi.tokens);
 176
 177          if (st->vp == stvp)
 178             st->dirty |= ST_NEW_VERTEX_PROGRAM(st, stvp);
 179
 180          break;
 181       }
 182       case MESA_SHADER_TESS_CTRL: {
 183          struct st_common_program *sttcp = st_common_program(glprog);
 184
 185          st_release_basic_variants(st, sttcp->Base.Target,
 186                                    &sttcp->variants, &sttcp->tgsi);
 187
 188          read_stream_out_from_cache(&blob_reader, &sttcp->tgsi);
 189          read_tgsi_from_cache(&blob_reader, &sttcp->tgsi.tokens);
 190
 191          if (st->tcp == sttcp)
 192             st->dirty |= sttcp->affected_states;
 193
 194          break;
 195       }
 196       case MESA_SHADER_TESS_EVAL: {
 197          struct st_common_program *sttep = st_common_program(glprog);
 198
 199          st_release_basic_variants(st, sttep->Base.Target,
 200                                    &sttep->variants, &sttep->tgsi);
 201
 202          read_stream_out_from_cache(&blob_reader, &sttep->tgsi);
 203          read_tgsi_from_cache(&blob_reader, &sttep->tgsi.tokens);
 204
 205          if (st->tep == sttep)
 206             st->dirty |= sttep->affected_states;
 207
 208          break;
 209       }
 210       case MESA_SHADER_GEOMETRY: {
 211          struct st_common_program *stgp = st_common_program(glprog);
 212
 213          st_release_basic_variants(st, stgp->Base.Target, &stgp->variants,
 214                                    &stgp->tgsi);
 215
 216          read_stream_out_from_cache(&blob_reader, &stgp->tgsi);
 217          read_tgsi_from_cache(&blob_reader, &stgp->tgsi.tokens);
 218
 219          if (st->gp == stgp)
 220             st->dirty |= stgp->affected_states;
 221
 222          break;
 223       }
 224       case MESA_SHADER_FRAGMENT: {
 225          struct st_fragment_program *stfp =
 226             (struct st_fragment_program *) glprog;
 227
 228          st_release_fp_variants(st, stfp);
 229
 230          read_tgsi_from_cache(&blob_reader, &stfp->tgsi.tokens);
 231
 232          if (st->fp == stfp)
 233             st->dirty |= stfp->affected_states;
 234
 235          break;
 236       }
 237       case MESA_SHADER_COMPUTE: {
 238          struct st_compute_program *stcp =
 239             (struct st_compute_program *) glprog;
 240
 241          st_release_cp_variants(st, stcp);
 242
 243          read_tgsi_from_cache(&blob_reader,
 244                               (const struct tgsi_token**) &stcp->tgsi.prog);
 245
 246          stcp->tgsi.req_local_mem = stcp->Base.info.cs.shared_size;
 247          stcp->tgsi.req_private_mem = 0;
 248          stcp->tgsi.req_input_mem = 0;
 249
 250          if (st->cp == stcp)
 251             st->dirty |= stcp->affected_states;
 252
 253          break;
 254       }
 255       default:
 256          unreachable("Unsupported stage");
 257       }
 258
 259       /* Make sure we don't try to read more data than we wrote. This should
 260        * never happen in release builds but its useful to have this check to
 261        * catch development bugs.
 262        */
 263       if (blob_reader.current != blob_reader.end || blob_reader.overrun) {
 264          assert(!"Invalid TGSI shader disk cache item!");
 265
 266          if (ctx->_Shader->Flags & GLSL_CACHE_INFO) {
 267             fprintf(stderr, "Error reading program from cache (invalid "
 268                     "TGSI cache item)\n");
 269          }
 270       }
 271
 272       if (ctx->_Shader->Flags & GLSL_CACHE_INFO) {
 273          fprintf(stderr, "%s tgsi_tokens retrieved from cache\n",
 274                  _mesa_shader_stage_to_string(i));
 275       }
 276
 277       st_set_prog_affected_state_flags(glprog);
 278       _mesa_associate_uniform_storage(ctx, prog, glprog, false);
 279
 280       /* Create Gallium shaders now instead of on demand. */
 281       if (ST_DEBUG & DEBUG_PRECOMPILE ||
 282           st->shader_has_one_variant[glprog->info.stage])
 283          st_precompile_shader_variant(st, glprog);
 284
 285       /* We don't need the cached blob anymore so free it */
 286       ralloc_free(glprog->driver_cache_blob);
 287       glprog->driver_cache_blob = NULL;
 288       glprog->driver_cache_blob_size = 0;
 289    }
 290
 291    return true;
 292 }