2 * Copyright © 2017 Intel Corporation
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 shall be included
12 * in all copies or substantial portions of the Software.
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.
24 * @file iris_program_cache.c
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.
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"
49 enum iris_program_cache_id cache_id
;
54 key_size_for_cache(enum iris_program_cache_id cache_id
)
56 static const unsigned key_sizes
[] = {
57 [IRIS_CACHE_VS
] = sizeof(struct brw_vs_prog_key
),
58 [IRIS_CACHE_TCS
] = sizeof(struct brw_tcs_prog_key
),
59 [IRIS_CACHE_TES
] = sizeof(struct brw_tes_prog_key
),
60 [IRIS_CACHE_GS
] = sizeof(struct brw_gs_prog_key
),
61 [IRIS_CACHE_FS
] = sizeof(struct brw_wm_prog_key
),
62 [IRIS_CACHE_CS
] = sizeof(struct brw_cs_prog_key
),
65 /* BLORP keys aren't all the same size. */
66 assert(cache_id
!= IRIS_CACHE_BLORP
);
68 return key_sizes
[cache_id
];
71 static struct keybox
*
72 make_keybox(void *mem_ctx
,
73 enum iris_program_cache_id cache_id
,
77 struct keybox
*keybox
=
78 ralloc_size(mem_ctx
, sizeof(struct keybox
) + key_size
);
80 keybox
->cache_id
= cache_id
;
81 keybox
->size
= key_size
;
82 memcpy(keybox
->data
, key
, key_size
);
88 keybox_hash(const void *void_key
)
90 const struct keybox
*key
= void_key
;
91 return _mesa_hash_data(&key
->cache_id
, key
->size
+ sizeof(key
->cache_id
));
95 keybox_equals(const void *void_a
, const void *void_b
)
97 const struct keybox
*a
= void_a
, *b
= void_b
;
98 if (a
->size
!= b
->size
)
101 return memcmp(a
->data
, b
->data
, a
->size
) == 0;
105 dirty_flag_for_cache(enum iris_program_cache_id cache_id
)
107 assert(cache_id
<= MESA_SHADER_STAGES
);
110 // XXX: move this flagging out to a higher level, allow comparison of
111 // XXX: new and old programs to decide what bits to twiddle
112 // XXX: CLIP: toggle if barycentric modes has any NONPERSPECTIVE or not
113 if (cache_id
== IRIS_CACHE_FS
)
114 return IRIS_DIRTY_WM
| IRIS_DIRTY_FS
| IRIS_DIRTY_CLIP
| IRIS_DIRTY_SBE
;
115 if (cache_id
== IRIS_CACHE_VS
)
116 return IRIS_DIRTY_VS
| IRIS_DIRTY_VF_SGVS
;
118 return IRIS_DIRTY_VS
<< cache_id
| IRIS_DIRTY_BINDINGS_VS
<< cache_id
;
122 get_program_string_id(enum iris_program_cache_id cache_id
, const void *key
)
126 return ((struct brw_vs_prog_key
*) key
)->program_string_id
;
128 return ((struct brw_tcs_prog_key
*) key
)->program_string_id
;
130 return ((struct brw_tes_prog_key
*) key
)->program_string_id
;
132 return ((struct brw_gs_prog_key
*) key
)->program_string_id
;
134 return ((struct brw_cs_prog_key
*) key
)->program_string_id
;
136 return ((struct brw_wm_prog_key
*) key
)->program_string_id
;
138 unreachable("no program string id for this kind of program");
142 static struct iris_compiled_shader
*
143 iris_find_cached_shader(struct iris_context
*ice
,
144 enum iris_program_cache_id cache_id
,
148 struct keybox
*keybox
=
149 make_keybox(ice
->shaders
.cache
, cache_id
, key
, key_size
);
150 struct hash_entry
*entry
=
151 _mesa_hash_table_search(ice
->shaders
.cache
, keybox
);
155 return entry
? entry
->data
: NULL
;
159 * Looks for a program in the cache and binds it.
161 * If no program was found, returns false and leaves the binding alone.
164 iris_bind_cached_shader(struct iris_context
*ice
,
165 enum iris_program_cache_id cache_id
,
168 unsigned key_size
= key_size_for_cache(cache_id
);
169 struct iris_compiled_shader
*shader
=
170 iris_find_cached_shader(ice
, cache_id
, key
, key_size
);
175 if (memcmp(shader
, ice
->shaders
.prog
[cache_id
], sizeof(*shader
)) != 0) {
176 ice
->shaders
.prog
[cache_id
] = shader
;
177 ice
->state
.dirty
|= dirty_flag_for_cache(cache_id
);
184 iris_unbind_shader(struct iris_context
*ice
,
185 enum iris_program_cache_id cache_id
)
187 if (ice
->shaders
.prog
[cache_id
]) {
188 ice
->shaders
.prog
[cache_id
] = NULL
;
189 ice
->state
.dirty
|= dirty_flag_for_cache(cache_id
);
194 iris_find_previous_compile(const struct iris_context
*ice
,
195 enum iris_program_cache_id cache_id
,
196 unsigned program_string_id
)
198 hash_table_foreach(ice
->shaders
.cache
, entry
) {
199 const struct keybox
*keybox
= entry
->key
;
200 if (keybox
->cache_id
== cache_id
&&
201 get_program_string_id(cache_id
, keybox
->data
) == program_string_id
) {
210 * Look for an existing entry in the cache that has identical assembly code.
212 * This is useful for programs generating shaders at runtime, where multiple
213 * distinct shaders (from an API perspective) may compile to the same assembly
214 * in our backend. This saves space in the program cache buffer.
216 static const struct iris_compiled_shader
*
217 find_existing_assembly(struct hash_table
*cache
,
218 const void *assembly
,
219 unsigned assembly_size
)
221 hash_table_foreach(cache
, entry
) {
222 const struct iris_compiled_shader
*existing
= entry
->data
;
223 if (existing
->prog_data
->program_size
== assembly_size
&&
224 memcmp(existing
->map
, assembly
, assembly_size
) == 0)
230 static struct iris_compiled_shader
*
231 iris_upload_shader(struct iris_context
*ice
,
232 enum iris_program_cache_id cache_id
,
235 const void *assembly
,
236 struct brw_stage_prog_data
*prog_data
,
239 struct iris_screen
*screen
= (void *) ice
->ctx
.screen
;
240 struct gen_device_info
*devinfo
= &screen
->devinfo
;
241 struct hash_table
*cache
= ice
->shaders
.cache
;
242 struct iris_compiled_shader
*shader
=
243 rzalloc_size(cache
, sizeof(struct iris_compiled_shader
) +
244 ice
->vtbl
.derived_program_state_size(cache_id
));
245 const struct iris_compiled_shader
*existing
=
246 find_existing_assembly(cache
, assembly
, prog_data
->program_size
);
248 /* If we can find a matching prog in the cache already, then reuse the
249 * existing stuff without creating new copy into the underlying buffer
250 * object. This is notably useful for programs generating shaders at
251 * runtime, where multiple shaders may compile to the same thing in our
255 pipe_resource_reference(&shader
->assembly
.res
, existing
->assembly
.res
);
256 shader
->assembly
.offset
= existing
->assembly
.offset
;
257 shader
->map
= existing
->map
;
259 shader
->assembly
.res
= NULL
;
260 u_upload_alloc(ice
->shaders
.uploader
, 0, prog_data
->program_size
, 64,
261 &shader
->assembly
.offset
, &shader
->assembly
.res
,
263 memcpy(shader
->map
, assembly
, prog_data
->program_size
);
266 shader
->prog_data
= prog_data
;
267 shader
->streamout
= streamout
;
269 ralloc_steal(shader
, shader
->prog_data
);
270 ralloc_steal(shader
->prog_data
, prog_data
->param
);
271 ralloc_steal(shader
->prog_data
, prog_data
->pull_param
);
272 ralloc_steal(shader
, shader
->streamout
);
274 /* Store the 3DSTATE shader packets and other derived state. */
275 ice
->vtbl
.store_derived_program_state(devinfo
, cache_id
, shader
);
277 struct keybox
*keybox
= make_keybox(cache
, cache_id
, key
, key_size
);
278 _mesa_hash_table_insert(ice
->shaders
.cache
, keybox
, shader
);
284 * Upload a new shader to the program cache, and bind it for use.
286 * \param prog_data must be ralloc'd and will be stolen.
289 iris_upload_and_bind_shader(struct iris_context
*ice
,
290 enum iris_program_cache_id cache_id
,
292 const void *assembly
,
293 struct brw_stage_prog_data
*prog_data
,
296 assert(cache_id
!= IRIS_CACHE_BLORP
);
298 struct iris_compiled_shader
*shader
=
299 iris_upload_shader(ice
, cache_id
, key_size_for_cache(cache_id
), key
,
300 assembly
, prog_data
, streamout
);
302 ice
->shaders
.prog
[cache_id
] = shader
;
303 ice
->state
.dirty
|= dirty_flag_for_cache(cache_id
);
307 iris_blorp_lookup_shader(struct blorp_batch
*blorp_batch
,
308 const void *key
, uint32_t key_size
,
309 uint32_t *kernel_out
, void *prog_data_out
)
311 struct blorp_context
*blorp
= blorp_batch
->blorp
;
312 struct iris_context
*ice
= blorp
->driver_ctx
;
313 struct iris_batch
*batch
= blorp_batch
->driver_batch
;
314 struct iris_compiled_shader
*shader
=
315 iris_find_cached_shader(ice
, IRIS_CACHE_BLORP
, key
, key_size
);
320 struct iris_bo
*bo
= iris_resource_bo(shader
->assembly
.res
);
322 iris_bo_offset_from_base_address(bo
) + shader
->assembly
.offset
;
323 *((void **) prog_data_out
) = shader
->prog_data
;
325 iris_use_pinned_bo(batch
, bo
, false);
331 iris_blorp_upload_shader(struct blorp_batch
*blorp_batch
,
332 const void *key
, uint32_t key_size
,
333 const void *kernel
, UNUSED
uint32_t kernel_size
,
334 const struct brw_stage_prog_data
*prog_data_templ
,
335 UNUSED
uint32_t prog_data_size
,
336 uint32_t *kernel_out
, void *prog_data_out
)
338 struct blorp_context
*blorp
= blorp_batch
->blorp
;
339 struct iris_context
*ice
= blorp
->driver_ctx
;
340 struct iris_batch
*batch
= blorp_batch
->driver_batch
;
342 void *prog_data
= ralloc_size(NULL
, prog_data_size
);
343 memcpy(prog_data
, prog_data_templ
, prog_data_size
);
345 struct iris_compiled_shader
*shader
=
346 iris_upload_shader(ice
, IRIS_CACHE_BLORP
, key_size
, key
, kernel
,
349 struct iris_bo
*bo
= iris_resource_bo(shader
->assembly
.res
);
351 iris_bo_offset_from_base_address(bo
) + shader
->assembly
.offset
;
352 *((void **) prog_data_out
) = shader
->prog_data
;
354 iris_use_pinned_bo(batch
, bo
, false);
360 iris_init_program_cache(struct iris_context
*ice
)
363 _mesa_hash_table_create(ice
, keybox_hash
, keybox_equals
);
365 ice
->shaders
.uploader
=
366 u_upload_create(&ice
->ctx
, 16384, PIPE_BIND_CUSTOM
, PIPE_USAGE_IMMUTABLE
,
367 IRIS_RESOURCE_FLAG_SHADER_MEMZONE
);
371 iris_destroy_program_cache(struct iris_context
*ice
)
373 for (int i
= 0; i
< MESA_SHADER_STAGES
; i
++) {
374 ice
->shaders
.prog
[i
] = NULL
;
377 hash_table_foreach(ice
->shaders
.cache
, entry
) {
378 struct iris_compiled_shader
*shader
= entry
->data
;
379 pipe_resource_reference(&shader
->assembly
.res
, NULL
);
382 u_upload_destroy(ice
->shaders
.uploader
);
384 ralloc_free(ice
->shaders
.cache
);
388 cache_name(enum iris_program_cache_id cache_id
)
390 if (cache_id
== IRIS_CACHE_BLORP
)
393 return _mesa_shader_stage_to_string(cache_id
);
397 iris_print_program_cache(struct iris_context
*ice
)
399 struct iris_screen
*screen
= (struct iris_screen
*)ice
->ctx
.screen
;
400 const struct gen_device_info
*devinfo
= &screen
->devinfo
;
402 hash_table_foreach(ice
->shaders
.cache
, entry
) {
403 const struct keybox
*keybox
= entry
->key
;
404 struct iris_compiled_shader
*shader
= entry
->data
;
405 fprintf(stderr
, "%s:\n", cache_name(keybox
->cache_id
));
406 brw_disassemble(devinfo
, shader
->map
, 0,
407 shader
->prog_data
->program_size
, stderr
);