fba4b0a3a03bc9aa22d23863fbb8514766646394
2 * Copyright © 2017 Timothy Arceri
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:
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
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.
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"
34 write_stream_out_to_cache(struct blob
*blob
,
35 struct pipe_shader_state
*tgsi
)
37 blob_write_bytes(blob
, &tgsi
->stream_output
,
38 sizeof(tgsi
->stream_output
));
42 write_tgsi_to_cache(struct blob
*blob
, struct pipe_shader_state
*tgsi
,
43 struct st_context
*st
, unsigned char *sha1
,
46 blob_write_uint32(blob
, num_tokens
);
47 blob_write_bytes(blob
, tgsi
->tokens
,
48 num_tokens
* sizeof(struct tgsi_token
));
50 disk_cache_put(st
->ctx
->Cache
, sha1
, blob
->data
, blob
->size
);
54 * Store tgsi and any other required state in on-disk shader cache.
57 st_store_tgsi_in_disk_cache(struct st_context
*st
, struct gl_program
*prog
,
58 struct pipe_shader_state
*out_state
,
64 /* Exit early when we are dealing with a ff shader with no source file to
65 * generate a source from.
67 if (*prog
->sh
.data
->sha1
== 0)
71 struct blob
*blob
= blob_create(NULL
);
73 switch (prog
->info
.stage
) {
74 case MESA_SHADER_VERTEX
: {
75 struct st_vertex_program
*stvp
= (struct st_vertex_program
*) prog
;
78 blob_write_uint32(blob
, stvp
->num_inputs
);
79 blob_write_bytes(blob
, stvp
->index_to_input
,
80 sizeof(stvp
->index_to_input
));
81 blob_write_bytes(blob
, stvp
->result_to_output
,
82 sizeof(stvp
->result_to_output
));
84 write_stream_out_to_cache(blob
, &stvp
->tgsi
);
85 write_tgsi_to_cache(blob
, &stvp
->tgsi
, st
, sha1
, num_tokens
);
88 case MESA_SHADER_TESS_CTRL
: {
89 struct st_tessctrl_program
*stcp
= (struct st_tessctrl_program
*) prog
;
92 write_stream_out_to_cache(blob
, out_state
);
93 write_tgsi_to_cache(blob
, out_state
, st
, sha1
, num_tokens
);
96 case MESA_SHADER_TESS_EVAL
: {
97 struct st_tesseval_program
*step
= (struct st_tesseval_program
*) prog
;
100 write_stream_out_to_cache(blob
, out_state
);
101 write_tgsi_to_cache(blob
, out_state
, st
, sha1
, num_tokens
);
104 case MESA_SHADER_GEOMETRY
: {
105 struct st_geometry_program
*stgp
= (struct st_geometry_program
*) prog
;
108 write_stream_out_to_cache(blob
, out_state
);
109 write_tgsi_to_cache(blob
, out_state
, st
, sha1
, num_tokens
);
112 case MESA_SHADER_FRAGMENT
: {
113 struct st_fragment_program
*stfp
= (struct st_fragment_program
*) prog
;
116 write_tgsi_to_cache(blob
, &stfp
->tgsi
, st
, sha1
, num_tokens
);
119 case MESA_SHADER_COMPUTE
: {
120 struct st_compute_program
*stcp
= (struct st_compute_program
*) prog
;
123 write_tgsi_to_cache(blob
, out_state
, st
, sha1
, num_tokens
);
127 unreachable("Unsupported stage");
130 if (st
->ctx
->_Shader
->Flags
& GLSL_CACHE_INFO
) {
132 _mesa_sha1_format(sha1_buf
, sha1
);
133 fprintf(stderr
, "putting %s tgsi_tokens in cache: %s\n",
134 _mesa_shader_stage_to_string(prog
->info
.stage
), sha1_buf
);
141 read_stream_out_from_cache(struct blob_reader
*blob_reader
,
142 struct pipe_shader_state
*tgsi
)
144 blob_copy_bytes(blob_reader
, (uint8_t *) &tgsi
->stream_output
,
145 sizeof(tgsi
->stream_output
));
149 read_tgsi_from_cache(struct blob_reader
*blob_reader
,
150 const struct tgsi_token
**tokens
)
152 uint32_t num_tokens
= blob_read_uint32(blob_reader
);
153 unsigned tokens_size
= num_tokens
* sizeof(struct tgsi_token
);
154 *tokens
= (const struct tgsi_token
*) MALLOC(tokens_size
);
155 blob_copy_bytes(blob_reader
, (uint8_t *) *tokens
, tokens_size
);
159 st_load_tgsi_from_disk_cache(struct gl_context
*ctx
,
160 struct gl_shader_program
*prog
)
165 unsigned char *stage_sha1
[MESA_SHADER_STAGES
];
168 /* Compute and store sha1 for each stage. These will be reused by the
169 * cache store pass if we fail to find the cached tgsi.
171 for (unsigned i
= 0; i
< MESA_SHADER_STAGES
; i
++) {
172 if (prog
->_LinkedShaders
[i
] == NULL
)
175 char *buf
= ralloc_strdup(NULL
, "tgsi_tokens ");
176 _mesa_sha1_format(sha1_buf
,
177 prog
->_LinkedShaders
[i
]->Program
->sh
.data
->sha1
);
178 ralloc_strcat(&buf
, sha1_buf
);
180 struct gl_program
*glprog
= prog
->_LinkedShaders
[i
]->Program
;
181 switch (glprog
->info
.stage
) {
182 case MESA_SHADER_VERTEX
: {
183 struct st_vertex_program
*stvp
= (struct st_vertex_program
*) glprog
;
184 stage_sha1
[i
] = stvp
->sha1
;
185 ralloc_strcat(&buf
, " vs");
186 _mesa_sha1_compute(buf
, strlen(buf
), stage_sha1
[i
]);
189 case MESA_SHADER_TESS_CTRL
: {
190 struct st_tessctrl_program
*stcp
=
191 (struct st_tessctrl_program
*) glprog
;
192 stage_sha1
[i
] = stcp
->sha1
;
193 ralloc_strcat(&buf
, " tcs");
194 _mesa_sha1_compute(buf
, strlen(buf
), stage_sha1
[i
]);
197 case MESA_SHADER_TESS_EVAL
: {
198 struct st_tesseval_program
*step
=
199 (struct st_tesseval_program
*) glprog
;
200 stage_sha1
[i
] = step
->sha1
;
201 ralloc_strcat(&buf
, " tes");
202 _mesa_sha1_compute(buf
, strlen(buf
), stage_sha1
[i
]);
205 case MESA_SHADER_GEOMETRY
: {
206 struct st_geometry_program
*stgp
=
207 (struct st_geometry_program
*) glprog
;
208 stage_sha1
[i
] = stgp
->sha1
;
209 ralloc_strcat(&buf
, " gs");
210 _mesa_sha1_compute(buf
, strlen(buf
), stage_sha1
[i
]);
213 case MESA_SHADER_FRAGMENT
: {
214 struct st_fragment_program
*stfp
=
215 (struct st_fragment_program
*) glprog
;
216 stage_sha1
[i
] = stfp
->sha1
;
217 ralloc_strcat(&buf
, " fs");
218 _mesa_sha1_compute(buf
, strlen(buf
), stage_sha1
[i
]);
221 case MESA_SHADER_COMPUTE
: {
222 struct st_compute_program
*stcp
=
223 (struct st_compute_program
*) glprog
;
224 stage_sha1
[i
] = stcp
->sha1
;
225 ralloc_strcat(&buf
, " cs");
226 _mesa_sha1_compute(buf
, strlen(buf
), stage_sha1
[i
]);
230 unreachable("Unsupported stage");
236 /* Now that we have created the sha1 keys that will be used for writting to
237 * the tgsi cache fallback to the regular glsl to tgsi path if we didn't
238 * load the GLSL IR from cache. We do this as glsl to tgsi can alter things
239 * such as gl_program_parameter_list which holds things like uniforms.
241 if (prog
->data
->LinkStatus
!= linking_skipped
)
244 struct st_context
*st
= st_context(ctx
);
245 uint8_t *buffer
= NULL
;
246 for (unsigned i
= 0; i
< MESA_SHADER_STAGES
; i
++) {
247 if (prog
->_LinkedShaders
[i
] == NULL
)
250 unsigned char *sha1
= stage_sha1
[i
];
252 buffer
= (uint8_t *) disk_cache_get(ctx
->Cache
, sha1
, &size
);
254 struct blob_reader blob_reader
;
255 blob_reader_init(&blob_reader
, buffer
, size
);
257 struct gl_program
*glprog
= prog
->_LinkedShaders
[i
]->Program
;
258 switch (glprog
->info
.stage
) {
259 case MESA_SHADER_VERTEX
: {
260 struct st_vertex_program
*stvp
=
261 (struct st_vertex_program
*) glprog
;
263 st_release_vp_variants(st
, stvp
);
265 stvp
->num_inputs
= blob_read_uint32(&blob_reader
);
266 blob_copy_bytes(&blob_reader
, (uint8_t *) stvp
->index_to_input
,
267 sizeof(stvp
->index_to_input
));
268 blob_copy_bytes(&blob_reader
, (uint8_t *) stvp
->result_to_output
,
269 sizeof(stvp
->result_to_output
));
271 read_stream_out_from_cache(&blob_reader
, &stvp
->tgsi
);
272 read_tgsi_from_cache(&blob_reader
, &stvp
->tgsi
.tokens
);
275 st
->dirty
|= ST_NEW_VERTEX_PROGRAM(st
, stvp
);
279 case MESA_SHADER_TESS_CTRL
: {
280 struct st_tessctrl_program
*sttcp
=
281 (struct st_tessctrl_program
*) glprog
;
283 st_release_basic_variants(st
, sttcp
->Base
.Target
,
284 &sttcp
->variants
, &sttcp
->tgsi
);
286 read_stream_out_from_cache(&blob_reader
, &sttcp
->tgsi
);
287 read_tgsi_from_cache(&blob_reader
, &sttcp
->tgsi
.tokens
);
289 if (st
->tcp
== sttcp
)
290 st
->dirty
|= sttcp
->affected_states
;
294 case MESA_SHADER_TESS_EVAL
: {
295 struct st_tesseval_program
*sttep
=
296 (struct st_tesseval_program
*) glprog
;
298 st_release_basic_variants(st
, sttep
->Base
.Target
,
299 &sttep
->variants
, &sttep
->tgsi
);
301 read_stream_out_from_cache(&blob_reader
, &sttep
->tgsi
);
302 read_tgsi_from_cache(&blob_reader
, &sttep
->tgsi
.tokens
);
304 if (st
->tep
== sttep
)
305 st
->dirty
|= sttep
->affected_states
;
309 case MESA_SHADER_GEOMETRY
: {
310 struct st_geometry_program
*stgp
=
311 (struct st_geometry_program
*) glprog
;
313 st_release_basic_variants(st
, stgp
->Base
.Target
, &stgp
->variants
,
316 read_stream_out_from_cache(&blob_reader
, &stgp
->tgsi
);
317 read_tgsi_from_cache(&blob_reader
, &stgp
->tgsi
.tokens
);
320 st
->dirty
|= stgp
->affected_states
;
324 case MESA_SHADER_FRAGMENT
: {
325 struct st_fragment_program
*stfp
=
326 (struct st_fragment_program
*) glprog
;
328 st_release_fp_variants(st
, stfp
);
330 read_tgsi_from_cache(&blob_reader
, &stfp
->tgsi
.tokens
);
333 st
->dirty
|= stfp
->affected_states
;
337 case MESA_SHADER_COMPUTE
: {
338 struct st_compute_program
*stcp
=
339 (struct st_compute_program
*) glprog
;
341 st_release_cp_variants(st
, stcp
);
343 read_tgsi_from_cache(&blob_reader
,
344 (const struct tgsi_token
**) &stcp
->tgsi
.prog
);
346 stcp
->tgsi
.req_local_mem
= stcp
->Base
.info
.cs
.shared_size
;
347 stcp
->tgsi
.req_private_mem
= 0;
348 stcp
->tgsi
.req_input_mem
= 0;
351 st
->dirty
|= stcp
->affected_states
;
356 unreachable("Unsupported stage");
359 if (blob_reader
.current
!= blob_reader
.end
|| blob_reader
.overrun
) {
360 /* Something very bad has gone wrong discard the item from the
361 * cache and rebuild/link from source.
363 assert(!"Invalid TGSI shader disk cache item!");
365 if (ctx
->_Shader
->Flags
& GLSL_CACHE_INFO
) {
366 fprintf(stderr
, "Error reading program from cache (invalid "
367 "TGSI cache item)\n");
370 disk_cache_remove(ctx
->Cache
, sha1
);
372 goto fallback_recompile
;
375 if (ctx
->_Shader
->Flags
& GLSL_CACHE_INFO
) {
376 _mesa_sha1_format(sha1_buf
, sha1
);
377 fprintf(stderr
, "%s tgsi_tokens retrieved from cache: %s\n",
378 _mesa_shader_stage_to_string(i
), sha1_buf
);
381 st_set_prog_affected_state_flags(glprog
);
382 _mesa_associate_uniform_storage(ctx
, prog
, glprog
->Parameters
);
386 /* Failed to find a matching cached shader so fallback to recompile.
388 if (ctx
->_Shader
->Flags
& GLSL_CACHE_INFO
) {
389 fprintf(stderr
, "TGSI cache item not found falling back to "
393 goto fallback_recompile
;
402 for (unsigned i
= 0; i
< prog
->NumShaders
; i
++) {
403 _mesa_glsl_compile_shader(ctx
, prog
->Shaders
[i
], false, false, true);
406 prog
->data
->cache_fallback
= true;
407 _mesa_glsl_link_shader(ctx
, prog
);