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