spirv: Add SpvCapabilityShaderViewportIndexLayerEXT
[mesa.git] / src / compiler / spirv / vtn_variables.c
1 /*
2 * Copyright © 2015 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 (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 DEALINGS
21 * IN THE SOFTWARE.
22 *
23 * Authors:
24 * Jason Ekstrand (jason@jlekstrand.net)
25 *
26 */
27
28 #include "vtn_private.h"
29 #include "spirv_info.h"
30
31 static struct vtn_access_chain *
32 vtn_access_chain_create(struct vtn_builder *b, unsigned length)
33 {
34 struct vtn_access_chain *chain;
35
36 /* Subtract 1 from the length since there's already one built in */
37 size_t size = sizeof(*chain) +
38 (MAX2(length, 1) - 1) * sizeof(chain->link[0]);
39 chain = rzalloc_size(b, size);
40 chain->length = length;
41
42 return chain;
43 }
44
45 static struct vtn_access_chain *
46 vtn_access_chain_extend(struct vtn_builder *b, struct vtn_access_chain *old,
47 unsigned new_ids)
48 {
49 struct vtn_access_chain *chain;
50
51 unsigned old_len = old ? old->length : 0;
52 chain = vtn_access_chain_create(b, old_len + new_ids);
53
54 for (unsigned i = 0; i < old_len; i++)
55 chain->link[i] = old->link[i];
56
57 return chain;
58 }
59
60 static bool
61 vtn_pointer_uses_ssa_offset(struct vtn_builder *b,
62 struct vtn_pointer *ptr)
63 {
64 return ptr->mode == vtn_variable_mode_ubo ||
65 ptr->mode == vtn_variable_mode_ssbo ||
66 (ptr->mode == vtn_variable_mode_workgroup &&
67 b->options->lower_workgroup_access_to_offsets);
68 }
69
70 static bool
71 vtn_pointer_is_external_block(struct vtn_builder *b,
72 struct vtn_pointer *ptr)
73 {
74 return ptr->mode == vtn_variable_mode_ssbo ||
75 ptr->mode == vtn_variable_mode_ubo ||
76 ptr->mode == vtn_variable_mode_push_constant ||
77 (ptr->mode == vtn_variable_mode_workgroup &&
78 b->options->lower_workgroup_access_to_offsets);
79 }
80
81 /* Dereference the given base pointer by the access chain */
82 static struct vtn_pointer *
83 vtn_access_chain_pointer_dereference(struct vtn_builder *b,
84 struct vtn_pointer *base,
85 struct vtn_access_chain *deref_chain)
86 {
87 struct vtn_access_chain *chain =
88 vtn_access_chain_extend(b, base->chain, deref_chain->length);
89 struct vtn_type *type = base->type;
90
91 /* OpPtrAccessChain is only allowed on things which support variable
92 * pointers. For everything else, the client is expected to just pass us
93 * the right access chain.
94 */
95 vtn_assert(!deref_chain->ptr_as_array);
96
97 unsigned start = base->chain ? base->chain->length : 0;
98 for (unsigned i = 0; i < deref_chain->length; i++) {
99 chain->link[start + i] = deref_chain->link[i];
100
101 if (glsl_type_is_struct(type->type)) {
102 vtn_assert(deref_chain->link[i].mode == vtn_access_mode_literal);
103 type = type->members[deref_chain->link[i].id];
104 } else {
105 type = type->array_element;
106 }
107 }
108
109 struct vtn_pointer *ptr = rzalloc(b, struct vtn_pointer);
110 ptr->mode = base->mode;
111 ptr->type = type;
112 ptr->var = base->var;
113 ptr->chain = chain;
114
115 return ptr;
116 }
117
118 static nir_ssa_def *
119 vtn_access_link_as_ssa(struct vtn_builder *b, struct vtn_access_link link,
120 unsigned stride)
121 {
122 vtn_assert(stride > 0);
123 if (link.mode == vtn_access_mode_literal) {
124 return nir_imm_int(&b->nb, link.id * stride);
125 } else if (stride == 1) {
126 nir_ssa_def *ssa = vtn_ssa_value(b, link.id)->def;
127 if (ssa->bit_size != 32)
128 ssa = nir_u2u32(&b->nb, ssa);
129 return ssa;
130 } else {
131 nir_ssa_def *src0 = vtn_ssa_value(b, link.id)->def;
132 if (src0->bit_size != 32)
133 src0 = nir_u2u32(&b->nb, src0);
134 return nir_imul(&b->nb, src0, nir_imm_int(&b->nb, stride));
135 }
136 }
137
138 static nir_ssa_def *
139 vtn_variable_resource_index(struct vtn_builder *b, struct vtn_variable *var,
140 nir_ssa_def *desc_array_index)
141 {
142 if (!desc_array_index) {
143 vtn_assert(glsl_type_is_struct(var->type->type));
144 desc_array_index = nir_imm_int(&b->nb, 0);
145 }
146
147 nir_intrinsic_instr *instr =
148 nir_intrinsic_instr_create(b->nb.shader,
149 nir_intrinsic_vulkan_resource_index);
150 instr->src[0] = nir_src_for_ssa(desc_array_index);
151 nir_intrinsic_set_desc_set(instr, var->descriptor_set);
152 nir_intrinsic_set_binding(instr, var->binding);
153
154 nir_ssa_dest_init(&instr->instr, &instr->dest, 1, 32, NULL);
155 nir_builder_instr_insert(&b->nb, &instr->instr);
156
157 return &instr->dest.ssa;
158 }
159
160 static nir_ssa_def *
161 vtn_resource_reindex(struct vtn_builder *b, nir_ssa_def *base_index,
162 nir_ssa_def *offset_index)
163 {
164 nir_intrinsic_instr *instr =
165 nir_intrinsic_instr_create(b->nb.shader,
166 nir_intrinsic_vulkan_resource_reindex);
167 instr->src[0] = nir_src_for_ssa(base_index);
168 instr->src[1] = nir_src_for_ssa(offset_index);
169
170 nir_ssa_dest_init(&instr->instr, &instr->dest, 1, 32, NULL);
171 nir_builder_instr_insert(&b->nb, &instr->instr);
172
173 return &instr->dest.ssa;
174 }
175
176 static struct vtn_pointer *
177 vtn_ssa_offset_pointer_dereference(struct vtn_builder *b,
178 struct vtn_pointer *base,
179 struct vtn_access_chain *deref_chain)
180 {
181 nir_ssa_def *block_index = base->block_index;
182 nir_ssa_def *offset = base->offset;
183 struct vtn_type *type = base->type;
184
185 unsigned idx = 0;
186 if (base->mode == vtn_variable_mode_ubo ||
187 base->mode == vtn_variable_mode_ssbo) {
188 if (!block_index) {
189 vtn_assert(base->var && base->type);
190 nir_ssa_def *desc_arr_idx;
191 if (glsl_type_is_array(type->type)) {
192 if (deref_chain->length >= 1) {
193 desc_arr_idx =
194 vtn_access_link_as_ssa(b, deref_chain->link[0], 1);
195 idx++;
196 /* This consumes a level of type */
197 type = type->array_element;
198 } else {
199 /* This is annoying. We've been asked for a pointer to the
200 * array of UBOs/SSBOs and not a specifc buffer. Return a
201 * pointer with a descriptor index of 0 and we'll have to do
202 * a reindex later to adjust it to the right thing.
203 */
204 desc_arr_idx = nir_imm_int(&b->nb, 0);
205 }
206 } else if (deref_chain->ptr_as_array) {
207 /* You can't have a zero-length OpPtrAccessChain */
208 vtn_assert(deref_chain->length >= 1);
209 desc_arr_idx = vtn_access_link_as_ssa(b, deref_chain->link[0], 1);
210 } else {
211 /* We have a regular non-array SSBO. */
212 desc_arr_idx = NULL;
213 }
214 block_index = vtn_variable_resource_index(b, base->var, desc_arr_idx);
215 } else if (deref_chain->ptr_as_array &&
216 type->base_type == vtn_base_type_struct && type->block) {
217 /* We are doing an OpPtrAccessChain on a pointer to a struct that is
218 * decorated block. This is an interesting corner in the SPIR-V
219 * spec. One interpretation would be that they client is clearly
220 * trying to treat that block as if it's an implicit array of blocks
221 * repeated in the buffer. However, the SPIR-V spec for the
222 * OpPtrAccessChain says:
223 *
224 * "Base is treated as the address of the first element of an
225 * array, and the Element element’s address is computed to be the
226 * base for the Indexes, as per OpAccessChain."
227 *
228 * Taken literally, that would mean that your struct type is supposed
229 * to be treated as an array of such a struct and, since it's
230 * decorated block, that means an array of blocks which corresponds
231 * to an array descriptor. Therefore, we need to do a reindex
232 * operation to add the index from the first link in the access chain
233 * to the index we recieved.
234 *
235 * The downside to this interpretation (there always is one) is that
236 * this might be somewhat surprising behavior to apps if they expect
237 * the implicit array behavior described above.
238 */
239 vtn_assert(deref_chain->length >= 1);
240 nir_ssa_def *offset_index =
241 vtn_access_link_as_ssa(b, deref_chain->link[0], 1);
242 idx++;
243
244 block_index = vtn_resource_reindex(b, block_index, offset_index);
245 }
246 }
247
248 if (!offset) {
249 if (base->mode == vtn_variable_mode_workgroup) {
250 /* SLM doesn't need nor have a block index */
251 vtn_assert(!block_index);
252
253 /* We need the variable for the base offset */
254 vtn_assert(base->var);
255
256 /* We need ptr_type for size and alignment */
257 vtn_assert(base->ptr_type);
258
259 /* Assign location on first use so that we don't end up bloating SLM
260 * address space for variables which are never statically used.
261 */
262 if (base->var->shared_location < 0) {
263 vtn_assert(base->ptr_type->length > 0 && base->ptr_type->align > 0);
264 b->shader->num_shared = vtn_align_u32(b->shader->num_shared,
265 base->ptr_type->align);
266 base->var->shared_location = b->shader->num_shared;
267 b->shader->num_shared += base->ptr_type->length;
268 }
269
270 offset = nir_imm_int(&b->nb, base->var->shared_location);
271 } else {
272 /* The code above should have ensured a block_index when needed. */
273 vtn_assert(block_index);
274
275 /* Start off with at the start of the buffer. */
276 offset = nir_imm_int(&b->nb, 0);
277 }
278 }
279
280 if (deref_chain->ptr_as_array && idx == 0) {
281 /* We need ptr_type for the stride */
282 vtn_assert(base->ptr_type);
283
284 /* We need at least one element in the chain */
285 vtn_assert(deref_chain->length >= 1);
286
287 nir_ssa_def *elem_offset =
288 vtn_access_link_as_ssa(b, deref_chain->link[idx],
289 base->ptr_type->stride);
290 offset = nir_iadd(&b->nb, offset, elem_offset);
291 idx++;
292 }
293
294 for (; idx < deref_chain->length; idx++) {
295 switch (glsl_get_base_type(type->type)) {
296 case GLSL_TYPE_UINT:
297 case GLSL_TYPE_INT:
298 case GLSL_TYPE_UINT16:
299 case GLSL_TYPE_INT16:
300 case GLSL_TYPE_UINT64:
301 case GLSL_TYPE_INT64:
302 case GLSL_TYPE_FLOAT:
303 case GLSL_TYPE_FLOAT16:
304 case GLSL_TYPE_DOUBLE:
305 case GLSL_TYPE_BOOL:
306 case GLSL_TYPE_ARRAY: {
307 nir_ssa_def *elem_offset =
308 vtn_access_link_as_ssa(b, deref_chain->link[idx], type->stride);
309 offset = nir_iadd(&b->nb, offset, elem_offset);
310 type = type->array_element;
311 break;
312 }
313
314 case GLSL_TYPE_STRUCT: {
315 vtn_assert(deref_chain->link[idx].mode == vtn_access_mode_literal);
316 unsigned member = deref_chain->link[idx].id;
317 nir_ssa_def *mem_offset = nir_imm_int(&b->nb, type->offsets[member]);
318 offset = nir_iadd(&b->nb, offset, mem_offset);
319 type = type->members[member];
320 break;
321 }
322
323 default:
324 vtn_fail("Invalid type for deref");
325 }
326 }
327
328 struct vtn_pointer *ptr = rzalloc(b, struct vtn_pointer);
329 ptr->mode = base->mode;
330 ptr->type = type;
331 ptr->block_index = block_index;
332 ptr->offset = offset;
333
334 return ptr;
335 }
336
337 /* Dereference the given base pointer by the access chain */
338 static struct vtn_pointer *
339 vtn_pointer_dereference(struct vtn_builder *b,
340 struct vtn_pointer *base,
341 struct vtn_access_chain *deref_chain)
342 {
343 if (vtn_pointer_uses_ssa_offset(b, base)) {
344 return vtn_ssa_offset_pointer_dereference(b, base, deref_chain);
345 } else {
346 return vtn_access_chain_pointer_dereference(b, base, deref_chain);
347 }
348 }
349
350 /* Crawls a chain of array derefs and rewrites the types so that the
351 * lengths stay the same but the terminal type is the one given by
352 * tail_type. This is useful for split structures.
353 */
354 static void
355 rewrite_deref_types(struct vtn_builder *b, nir_deref *deref,
356 const struct glsl_type *type)
357 {
358 deref->type = type;
359 if (deref->child) {
360 vtn_assert(deref->child->deref_type == nir_deref_type_array);
361 vtn_assert(glsl_type_is_array(deref->type));
362 rewrite_deref_types(b, deref->child, glsl_get_array_element(type));
363 }
364 }
365
366 struct vtn_pointer *
367 vtn_pointer_for_variable(struct vtn_builder *b,
368 struct vtn_variable *var, struct vtn_type *ptr_type)
369 {
370 struct vtn_pointer *pointer = rzalloc(b, struct vtn_pointer);
371
372 pointer->mode = var->mode;
373 pointer->type = var->type;
374 vtn_assert(ptr_type->base_type == vtn_base_type_pointer);
375 vtn_assert(ptr_type->deref->type == var->type->type);
376 pointer->ptr_type = ptr_type;
377 pointer->var = var;
378
379 return pointer;
380 }
381
382 nir_deref_var *
383 vtn_pointer_to_deref(struct vtn_builder *b, struct vtn_pointer *ptr)
384 {
385 /* Do on-the-fly copy propagation for samplers. */
386 if (ptr->var->copy_prop_sampler)
387 return vtn_pointer_to_deref(b, ptr->var->copy_prop_sampler);
388
389 nir_deref_var *deref_var;
390 if (ptr->var->var) {
391 deref_var = nir_deref_var_create(b, ptr->var->var);
392 /* Raw variable access */
393 if (!ptr->chain)
394 return deref_var;
395 } else {
396 vtn_assert(ptr->var->members);
397 /* Create the deref_var manually. It will get filled out later. */
398 deref_var = rzalloc(b, nir_deref_var);
399 deref_var->deref.deref_type = nir_deref_type_var;
400 }
401
402 struct vtn_access_chain *chain = ptr->chain;
403 vtn_assert(chain);
404
405 struct vtn_type *deref_type = ptr->var->type;
406 nir_deref *tail = &deref_var->deref;
407 nir_variable **members = ptr->var->members;
408
409 for (unsigned i = 0; i < chain->length; i++) {
410 enum glsl_base_type base_type = glsl_get_base_type(deref_type->type);
411 switch (base_type) {
412 case GLSL_TYPE_UINT:
413 case GLSL_TYPE_INT:
414 case GLSL_TYPE_UINT16:
415 case GLSL_TYPE_INT16:
416 case GLSL_TYPE_UINT64:
417 case GLSL_TYPE_INT64:
418 case GLSL_TYPE_FLOAT:
419 case GLSL_TYPE_FLOAT16:
420 case GLSL_TYPE_DOUBLE:
421 case GLSL_TYPE_BOOL:
422 case GLSL_TYPE_ARRAY: {
423 deref_type = deref_type->array_element;
424
425 nir_deref_array *deref_arr = nir_deref_array_create(b);
426 deref_arr->deref.type = deref_type->type;
427
428 if (chain->link[i].mode == vtn_access_mode_literal) {
429 deref_arr->deref_array_type = nir_deref_array_type_direct;
430 deref_arr->base_offset = chain->link[i].id;
431 } else {
432 vtn_assert(chain->link[i].mode == vtn_access_mode_id);
433 deref_arr->deref_array_type = nir_deref_array_type_indirect;
434 deref_arr->base_offset = 0;
435 deref_arr->indirect =
436 nir_src_for_ssa(vtn_ssa_value(b, chain->link[i].id)->def);
437 }
438 tail->child = &deref_arr->deref;
439 tail = tail->child;
440 break;
441 }
442
443 case GLSL_TYPE_STRUCT: {
444 vtn_assert(chain->link[i].mode == vtn_access_mode_literal);
445 unsigned idx = chain->link[i].id;
446 deref_type = deref_type->members[idx];
447 if (members) {
448 /* This is a pre-split structure. */
449 deref_var->var = members[idx];
450 rewrite_deref_types(b, &deref_var->deref, members[idx]->type);
451 vtn_assert(tail->type == deref_type->type);
452 members = NULL;
453 } else {
454 nir_deref_struct *deref_struct = nir_deref_struct_create(b, idx);
455 deref_struct->deref.type = deref_type->type;
456 tail->child = &deref_struct->deref;
457 tail = tail->child;
458 }
459 break;
460 }
461 default:
462 vtn_fail("Invalid type for deref");
463 }
464 }
465
466 vtn_assert(members == NULL);
467 return deref_var;
468 }
469
470 static void
471 _vtn_local_load_store(struct vtn_builder *b, bool load, nir_deref_var *deref,
472 nir_deref *tail, struct vtn_ssa_value *inout)
473 {
474 /* The deref tail may contain a deref to select a component of a vector (in
475 * other words, it might not be an actual tail) so we have to save it away
476 * here since we overwrite it later.
477 */
478 nir_deref *old_child = tail->child;
479
480 if (glsl_type_is_vector_or_scalar(tail->type)) {
481 /* Terminate the deref chain in case there is one more link to pick
482 * off a component of the vector.
483 */
484 tail->child = NULL;
485
486 nir_intrinsic_op op = load ? nir_intrinsic_load_var :
487 nir_intrinsic_store_var;
488
489 nir_intrinsic_instr *intrin = nir_intrinsic_instr_create(b->shader, op);
490 intrin->variables[0] = nir_deref_var_clone(deref, intrin);
491 intrin->num_components = glsl_get_vector_elements(tail->type);
492
493 if (load) {
494 nir_ssa_dest_init(&intrin->instr, &intrin->dest,
495 intrin->num_components,
496 glsl_get_bit_size(tail->type),
497 NULL);
498 inout->def = &intrin->dest.ssa;
499 } else {
500 nir_intrinsic_set_write_mask(intrin, (1 << intrin->num_components) - 1);
501 intrin->src[0] = nir_src_for_ssa(inout->def);
502 }
503
504 nir_builder_instr_insert(&b->nb, &intrin->instr);
505 } else if (glsl_get_base_type(tail->type) == GLSL_TYPE_ARRAY ||
506 glsl_type_is_matrix(tail->type)) {
507 unsigned elems = glsl_get_length(tail->type);
508 nir_deref_array *deref_arr = nir_deref_array_create(b);
509 deref_arr->deref_array_type = nir_deref_array_type_direct;
510 deref_arr->deref.type = glsl_get_array_element(tail->type);
511 tail->child = &deref_arr->deref;
512 for (unsigned i = 0; i < elems; i++) {
513 deref_arr->base_offset = i;
514 _vtn_local_load_store(b, load, deref, tail->child, inout->elems[i]);
515 }
516 } else {
517 vtn_assert(glsl_get_base_type(tail->type) == GLSL_TYPE_STRUCT);
518 unsigned elems = glsl_get_length(tail->type);
519 nir_deref_struct *deref_struct = nir_deref_struct_create(b, 0);
520 tail->child = &deref_struct->deref;
521 for (unsigned i = 0; i < elems; i++) {
522 deref_struct->index = i;
523 deref_struct->deref.type = glsl_get_struct_field(tail->type, i);
524 _vtn_local_load_store(b, load, deref, tail->child, inout->elems[i]);
525 }
526 }
527
528 tail->child = old_child;
529 }
530
531 nir_deref_var *
532 vtn_nir_deref(struct vtn_builder *b, uint32_t id)
533 {
534 struct vtn_pointer *ptr = vtn_value(b, id, vtn_value_type_pointer)->pointer;
535 return vtn_pointer_to_deref(b, ptr);
536 }
537
538 /*
539 * Gets the NIR-level deref tail, which may have as a child an array deref
540 * selecting which component due to OpAccessChain supporting per-component
541 * indexing in SPIR-V.
542 */
543 static nir_deref *
544 get_deref_tail(nir_deref_var *deref)
545 {
546 nir_deref *cur = &deref->deref;
547 while (!glsl_type_is_vector_or_scalar(cur->type) && cur->child)
548 cur = cur->child;
549
550 return cur;
551 }
552
553 struct vtn_ssa_value *
554 vtn_local_load(struct vtn_builder *b, nir_deref_var *src)
555 {
556 nir_deref *src_tail = get_deref_tail(src);
557 struct vtn_ssa_value *val = vtn_create_ssa_value(b, src_tail->type);
558 _vtn_local_load_store(b, true, src, src_tail, val);
559
560 if (src_tail->child) {
561 nir_deref_array *vec_deref = nir_deref_as_array(src_tail->child);
562 vtn_assert(vec_deref->deref.child == NULL);
563 val->type = vec_deref->deref.type;
564 if (vec_deref->deref_array_type == nir_deref_array_type_direct)
565 val->def = vtn_vector_extract(b, val->def, vec_deref->base_offset);
566 else
567 val->def = vtn_vector_extract_dynamic(b, val->def,
568 vec_deref->indirect.ssa);
569 }
570
571 return val;
572 }
573
574 void
575 vtn_local_store(struct vtn_builder *b, struct vtn_ssa_value *src,
576 nir_deref_var *dest)
577 {
578 nir_deref *dest_tail = get_deref_tail(dest);
579
580 if (dest_tail->child) {
581 struct vtn_ssa_value *val = vtn_create_ssa_value(b, dest_tail->type);
582 _vtn_local_load_store(b, true, dest, dest_tail, val);
583 nir_deref_array *deref = nir_deref_as_array(dest_tail->child);
584 vtn_assert(deref->deref.child == NULL);
585 if (deref->deref_array_type == nir_deref_array_type_direct)
586 val->def = vtn_vector_insert(b, val->def, src->def,
587 deref->base_offset);
588 else
589 val->def = vtn_vector_insert_dynamic(b, val->def, src->def,
590 deref->indirect.ssa);
591 _vtn_local_load_store(b, false, dest, dest_tail, val);
592 } else {
593 _vtn_local_load_store(b, false, dest, dest_tail, src);
594 }
595 }
596
597 nir_ssa_def *
598 vtn_pointer_to_offset(struct vtn_builder *b, struct vtn_pointer *ptr,
599 nir_ssa_def **index_out, unsigned *end_idx_out)
600 {
601 if (vtn_pointer_uses_ssa_offset(b, ptr)) {
602 if (!ptr->offset) {
603 struct vtn_access_chain chain = {
604 .length = 0,
605 };
606 ptr = vtn_ssa_offset_pointer_dereference(b, ptr, &chain);
607 }
608 *index_out = ptr->block_index;
609 return ptr->offset;
610 }
611
612 vtn_assert(ptr->mode == vtn_variable_mode_push_constant);
613 *index_out = NULL;
614
615 unsigned idx = 0;
616 struct vtn_type *type = ptr->var->type;
617 nir_ssa_def *offset = nir_imm_int(&b->nb, 0);
618
619 if (ptr->chain) {
620 for (; idx < ptr->chain->length; idx++) {
621 enum glsl_base_type base_type = glsl_get_base_type(type->type);
622 switch (base_type) {
623 case GLSL_TYPE_UINT:
624 case GLSL_TYPE_INT:
625 case GLSL_TYPE_UINT16:
626 case GLSL_TYPE_INT16:
627 case GLSL_TYPE_UINT64:
628 case GLSL_TYPE_INT64:
629 case GLSL_TYPE_FLOAT:
630 case GLSL_TYPE_FLOAT16:
631 case GLSL_TYPE_DOUBLE:
632 case GLSL_TYPE_BOOL:
633 case GLSL_TYPE_ARRAY:
634 offset = nir_iadd(&b->nb, offset,
635 vtn_access_link_as_ssa(b, ptr->chain->link[idx],
636 type->stride));
637
638 type = type->array_element;
639 break;
640
641 case GLSL_TYPE_STRUCT: {
642 vtn_assert(ptr->chain->link[idx].mode == vtn_access_mode_literal);
643 unsigned member = ptr->chain->link[idx].id;
644 offset = nir_iadd(&b->nb, offset,
645 nir_imm_int(&b->nb, type->offsets[member]));
646 type = type->members[member];
647 break;
648 }
649
650 default:
651 vtn_fail("Invalid type for deref");
652 }
653 }
654 }
655
656 vtn_assert(type == ptr->type);
657 if (end_idx_out)
658 *end_idx_out = idx;
659
660 return offset;
661 }
662
663 /* Tries to compute the size of an interface block based on the strides and
664 * offsets that are provided to us in the SPIR-V source.
665 */
666 static unsigned
667 vtn_type_block_size(struct vtn_builder *b, struct vtn_type *type)
668 {
669 enum glsl_base_type base_type = glsl_get_base_type(type->type);
670 switch (base_type) {
671 case GLSL_TYPE_UINT:
672 case GLSL_TYPE_INT:
673 case GLSL_TYPE_UINT16:
674 case GLSL_TYPE_INT16:
675 case GLSL_TYPE_UINT64:
676 case GLSL_TYPE_INT64:
677 case GLSL_TYPE_FLOAT:
678 case GLSL_TYPE_FLOAT16:
679 case GLSL_TYPE_BOOL:
680 case GLSL_TYPE_DOUBLE: {
681 unsigned cols = type->row_major ? glsl_get_vector_elements(type->type) :
682 glsl_get_matrix_columns(type->type);
683 if (cols > 1) {
684 vtn_assert(type->stride > 0);
685 return type->stride * cols;
686 } else {
687 unsigned type_size = glsl_get_bit_size(type->type) / 8;
688 return glsl_get_vector_elements(type->type) * type_size;
689 }
690 }
691
692 case GLSL_TYPE_STRUCT:
693 case GLSL_TYPE_INTERFACE: {
694 unsigned size = 0;
695 unsigned num_fields = glsl_get_length(type->type);
696 for (unsigned f = 0; f < num_fields; f++) {
697 unsigned field_end = type->offsets[f] +
698 vtn_type_block_size(b, type->members[f]);
699 size = MAX2(size, field_end);
700 }
701 return size;
702 }
703
704 case GLSL_TYPE_ARRAY:
705 vtn_assert(type->stride > 0);
706 vtn_assert(glsl_get_length(type->type) > 0);
707 return type->stride * glsl_get_length(type->type);
708
709 default:
710 vtn_fail("Invalid block type");
711 return 0;
712 }
713 }
714
715 static void
716 vtn_access_chain_get_offset_size(struct vtn_builder *b,
717 struct vtn_access_chain *chain,
718 struct vtn_type *type,
719 unsigned *access_offset,
720 unsigned *access_size)
721 {
722 *access_offset = 0;
723
724 for (unsigned i = 0; i < chain->length; i++) {
725 if (chain->link[i].mode != vtn_access_mode_literal)
726 break;
727
728 if (glsl_type_is_struct(type->type)) {
729 *access_offset += type->offsets[chain->link[i].id];
730 type = type->members[chain->link[i].id];
731 } else {
732 *access_offset += type->stride * chain->link[i].id;
733 type = type->array_element;
734 }
735 }
736
737 *access_size = vtn_type_block_size(b, type);
738 }
739
740 static void
741 _vtn_load_store_tail(struct vtn_builder *b, nir_intrinsic_op op, bool load,
742 nir_ssa_def *index, nir_ssa_def *offset,
743 unsigned access_offset, unsigned access_size,
744 struct vtn_ssa_value **inout, const struct glsl_type *type)
745 {
746 nir_intrinsic_instr *instr = nir_intrinsic_instr_create(b->nb.shader, op);
747 instr->num_components = glsl_get_vector_elements(type);
748
749 int src = 0;
750 if (!load) {
751 nir_intrinsic_set_write_mask(instr, (1 << instr->num_components) - 1);
752 instr->src[src++] = nir_src_for_ssa((*inout)->def);
753 }
754
755 if (op == nir_intrinsic_load_push_constant) {
756 nir_intrinsic_set_base(instr, access_offset);
757 nir_intrinsic_set_range(instr, access_size);
758 }
759
760 if (index)
761 instr->src[src++] = nir_src_for_ssa(index);
762
763 if (op == nir_intrinsic_load_push_constant) {
764 /* We need to subtract the offset from where the intrinsic will load the
765 * data. */
766 instr->src[src++] =
767 nir_src_for_ssa(nir_isub(&b->nb, offset,
768 nir_imm_int(&b->nb, access_offset)));
769 } else {
770 instr->src[src++] = nir_src_for_ssa(offset);
771 }
772
773 if (load) {
774 nir_ssa_dest_init(&instr->instr, &instr->dest,
775 instr->num_components,
776 glsl_get_bit_size(type), NULL);
777 (*inout)->def = &instr->dest.ssa;
778 }
779
780 nir_builder_instr_insert(&b->nb, &instr->instr);
781
782 if (load && glsl_get_base_type(type) == GLSL_TYPE_BOOL)
783 (*inout)->def = nir_ine(&b->nb, (*inout)->def, nir_imm_int(&b->nb, 0));
784 }
785
786 static void
787 _vtn_block_load_store(struct vtn_builder *b, nir_intrinsic_op op, bool load,
788 nir_ssa_def *index, nir_ssa_def *offset,
789 unsigned access_offset, unsigned access_size,
790 struct vtn_access_chain *chain, unsigned chain_idx,
791 struct vtn_type *type, struct vtn_ssa_value **inout)
792 {
793 if (chain && chain_idx >= chain->length)
794 chain = NULL;
795
796 if (load && chain == NULL && *inout == NULL)
797 *inout = vtn_create_ssa_value(b, type->type);
798
799 enum glsl_base_type base_type = glsl_get_base_type(type->type);
800 switch (base_type) {
801 case GLSL_TYPE_UINT:
802 case GLSL_TYPE_INT:
803 case GLSL_TYPE_UINT16:
804 case GLSL_TYPE_INT16:
805 case GLSL_TYPE_UINT64:
806 case GLSL_TYPE_INT64:
807 case GLSL_TYPE_FLOAT:
808 case GLSL_TYPE_FLOAT16:
809 case GLSL_TYPE_DOUBLE:
810 case GLSL_TYPE_BOOL:
811 /* This is where things get interesting. At this point, we've hit
812 * a vector, a scalar, or a matrix.
813 */
814 if (glsl_type_is_matrix(type->type)) {
815 /* Loading the whole matrix */
816 struct vtn_ssa_value *transpose;
817 unsigned num_ops, vec_width, col_stride;
818 if (type->row_major) {
819 num_ops = glsl_get_vector_elements(type->type);
820 vec_width = glsl_get_matrix_columns(type->type);
821 col_stride = type->array_element->stride;
822 if (load) {
823 const struct glsl_type *transpose_type =
824 glsl_matrix_type(base_type, vec_width, num_ops);
825 *inout = vtn_create_ssa_value(b, transpose_type);
826 } else {
827 transpose = vtn_ssa_transpose(b, *inout);
828 inout = &transpose;
829 }
830 } else {
831 num_ops = glsl_get_matrix_columns(type->type);
832 vec_width = glsl_get_vector_elements(type->type);
833 col_stride = type->stride;
834 }
835
836 for (unsigned i = 0; i < num_ops; i++) {
837 nir_ssa_def *elem_offset =
838 nir_iadd(&b->nb, offset, nir_imm_int(&b->nb, i * col_stride));
839 _vtn_load_store_tail(b, op, load, index, elem_offset,
840 access_offset, access_size,
841 &(*inout)->elems[i],
842 glsl_vector_type(base_type, vec_width));
843 }
844
845 if (load && type->row_major)
846 *inout = vtn_ssa_transpose(b, *inout);
847 } else {
848 unsigned elems = glsl_get_vector_elements(type->type);
849 unsigned type_size = glsl_get_bit_size(type->type) / 8;
850 if (elems == 1 || type->stride == type_size) {
851 /* This is a tightly-packed normal scalar or vector load */
852 vtn_assert(glsl_type_is_vector_or_scalar(type->type));
853 _vtn_load_store_tail(b, op, load, index, offset,
854 access_offset, access_size,
855 inout, type->type);
856 } else {
857 /* This is a strided load. We have to load N things separately.
858 * This is the single column of a row-major matrix case.
859 */
860 vtn_assert(type->stride > type_size);
861 vtn_assert(type->stride % type_size == 0);
862
863 nir_ssa_def *per_comp[4];
864 for (unsigned i = 0; i < elems; i++) {
865 nir_ssa_def *elem_offset =
866 nir_iadd(&b->nb, offset,
867 nir_imm_int(&b->nb, i * type->stride));
868 struct vtn_ssa_value *comp, temp_val;
869 if (!load) {
870 temp_val.def = nir_channel(&b->nb, (*inout)->def, i);
871 temp_val.type = glsl_scalar_type(base_type);
872 }
873 comp = &temp_val;
874 _vtn_load_store_tail(b, op, load, index, elem_offset,
875 access_offset, access_size,
876 &comp, glsl_scalar_type(base_type));
877 per_comp[i] = comp->def;
878 }
879
880 if (load) {
881 if (*inout == NULL)
882 *inout = vtn_create_ssa_value(b, type->type);
883 (*inout)->def = nir_vec(&b->nb, per_comp, elems);
884 }
885 }
886 }
887 return;
888
889 case GLSL_TYPE_ARRAY: {
890 unsigned elems = glsl_get_length(type->type);
891 for (unsigned i = 0; i < elems; i++) {
892 nir_ssa_def *elem_off =
893 nir_iadd(&b->nb, offset, nir_imm_int(&b->nb, i * type->stride));
894 _vtn_block_load_store(b, op, load, index, elem_off,
895 access_offset, access_size,
896 NULL, 0,
897 type->array_element, &(*inout)->elems[i]);
898 }
899 return;
900 }
901
902 case GLSL_TYPE_STRUCT: {
903 unsigned elems = glsl_get_length(type->type);
904 for (unsigned i = 0; i < elems; i++) {
905 nir_ssa_def *elem_off =
906 nir_iadd(&b->nb, offset, nir_imm_int(&b->nb, type->offsets[i]));
907 _vtn_block_load_store(b, op, load, index, elem_off,
908 access_offset, access_size,
909 NULL, 0,
910 type->members[i], &(*inout)->elems[i]);
911 }
912 return;
913 }
914
915 default:
916 vtn_fail("Invalid block member type");
917 }
918 }
919
920 static struct vtn_ssa_value *
921 vtn_block_load(struct vtn_builder *b, struct vtn_pointer *src)
922 {
923 nir_intrinsic_op op;
924 unsigned access_offset = 0, access_size = 0;
925 switch (src->mode) {
926 case vtn_variable_mode_ubo:
927 op = nir_intrinsic_load_ubo;
928 break;
929 case vtn_variable_mode_ssbo:
930 op = nir_intrinsic_load_ssbo;
931 break;
932 case vtn_variable_mode_push_constant:
933 op = nir_intrinsic_load_push_constant;
934 vtn_access_chain_get_offset_size(b, src->chain, src->var->type,
935 &access_offset, &access_size);
936 break;
937 case vtn_variable_mode_workgroup:
938 op = nir_intrinsic_load_shared;
939 break;
940 default:
941 vtn_fail("Invalid block variable mode");
942 }
943
944 nir_ssa_def *offset, *index = NULL;
945 unsigned chain_idx;
946 offset = vtn_pointer_to_offset(b, src, &index, &chain_idx);
947
948 struct vtn_ssa_value *value = NULL;
949 _vtn_block_load_store(b, op, true, index, offset,
950 access_offset, access_size,
951 src->chain, chain_idx, src->type, &value);
952 return value;
953 }
954
955 static void
956 vtn_block_store(struct vtn_builder *b, struct vtn_ssa_value *src,
957 struct vtn_pointer *dst)
958 {
959 nir_intrinsic_op op;
960 switch (dst->mode) {
961 case vtn_variable_mode_ssbo:
962 op = nir_intrinsic_store_ssbo;
963 break;
964 case vtn_variable_mode_workgroup:
965 op = nir_intrinsic_store_shared;
966 break;
967 default:
968 vtn_fail("Invalid block variable mode");
969 }
970
971 nir_ssa_def *offset, *index = NULL;
972 unsigned chain_idx;
973 offset = vtn_pointer_to_offset(b, dst, &index, &chain_idx);
974
975 _vtn_block_load_store(b, op, false, index, offset,
976 0, 0, dst->chain, chain_idx, dst->type, &src);
977 }
978
979 static void
980 _vtn_variable_load_store(struct vtn_builder *b, bool load,
981 struct vtn_pointer *ptr,
982 struct vtn_ssa_value **inout)
983 {
984 enum glsl_base_type base_type = glsl_get_base_type(ptr->type->type);
985 switch (base_type) {
986 case GLSL_TYPE_UINT:
987 case GLSL_TYPE_INT:
988 case GLSL_TYPE_UINT16:
989 case GLSL_TYPE_INT16:
990 case GLSL_TYPE_UINT64:
991 case GLSL_TYPE_INT64:
992 case GLSL_TYPE_FLOAT:
993 case GLSL_TYPE_FLOAT16:
994 case GLSL_TYPE_BOOL:
995 case GLSL_TYPE_DOUBLE:
996 /* At this point, we have a scalar, vector, or matrix so we know that
997 * there cannot be any structure splitting still in the way. By
998 * stopping at the matrix level rather than the vector level, we
999 * ensure that matrices get loaded in the optimal way even if they
1000 * are storred row-major in a UBO.
1001 */
1002 if (load) {
1003 *inout = vtn_local_load(b, vtn_pointer_to_deref(b, ptr));
1004 } else {
1005 vtn_local_store(b, *inout, vtn_pointer_to_deref(b, ptr));
1006 }
1007 return;
1008
1009 case GLSL_TYPE_ARRAY:
1010 case GLSL_TYPE_STRUCT: {
1011 unsigned elems = glsl_get_length(ptr->type->type);
1012 if (load) {
1013 vtn_assert(*inout == NULL);
1014 *inout = rzalloc(b, struct vtn_ssa_value);
1015 (*inout)->type = ptr->type->type;
1016 (*inout)->elems = rzalloc_array(b, struct vtn_ssa_value *, elems);
1017 }
1018
1019 struct vtn_access_chain chain = {
1020 .length = 1,
1021 .link = {
1022 { .mode = vtn_access_mode_literal, },
1023 }
1024 };
1025 for (unsigned i = 0; i < elems; i++) {
1026 chain.link[0].id = i;
1027 struct vtn_pointer *elem = vtn_pointer_dereference(b, ptr, &chain);
1028 _vtn_variable_load_store(b, load, elem, &(*inout)->elems[i]);
1029 }
1030 return;
1031 }
1032
1033 default:
1034 vtn_fail("Invalid access chain type");
1035 }
1036 }
1037
1038 struct vtn_ssa_value *
1039 vtn_variable_load(struct vtn_builder *b, struct vtn_pointer *src)
1040 {
1041 if (vtn_pointer_is_external_block(b, src)) {
1042 return vtn_block_load(b, src);
1043 } else {
1044 struct vtn_ssa_value *val = NULL;
1045 _vtn_variable_load_store(b, true, src, &val);
1046 return val;
1047 }
1048 }
1049
1050 void
1051 vtn_variable_store(struct vtn_builder *b, struct vtn_ssa_value *src,
1052 struct vtn_pointer *dest)
1053 {
1054 if (vtn_pointer_is_external_block(b, dest)) {
1055 vtn_assert(dest->mode == vtn_variable_mode_ssbo ||
1056 dest->mode == vtn_variable_mode_workgroup);
1057 vtn_block_store(b, src, dest);
1058 } else {
1059 _vtn_variable_load_store(b, false, dest, &src);
1060 }
1061 }
1062
1063 static void
1064 _vtn_variable_copy(struct vtn_builder *b, struct vtn_pointer *dest,
1065 struct vtn_pointer *src)
1066 {
1067 vtn_assert(src->type->type == dest->type->type);
1068 enum glsl_base_type base_type = glsl_get_base_type(src->type->type);
1069 switch (base_type) {
1070 case GLSL_TYPE_UINT:
1071 case GLSL_TYPE_INT:
1072 case GLSL_TYPE_UINT16:
1073 case GLSL_TYPE_INT16:
1074 case GLSL_TYPE_UINT64:
1075 case GLSL_TYPE_INT64:
1076 case GLSL_TYPE_FLOAT:
1077 case GLSL_TYPE_FLOAT16:
1078 case GLSL_TYPE_DOUBLE:
1079 case GLSL_TYPE_BOOL:
1080 /* At this point, we have a scalar, vector, or matrix so we know that
1081 * there cannot be any structure splitting still in the way. By
1082 * stopping at the matrix level rather than the vector level, we
1083 * ensure that matrices get loaded in the optimal way even if they
1084 * are storred row-major in a UBO.
1085 */
1086 vtn_variable_store(b, vtn_variable_load(b, src), dest);
1087 return;
1088
1089 case GLSL_TYPE_ARRAY:
1090 case GLSL_TYPE_STRUCT: {
1091 struct vtn_access_chain chain = {
1092 .length = 1,
1093 .link = {
1094 { .mode = vtn_access_mode_literal, },
1095 }
1096 };
1097 unsigned elems = glsl_get_length(src->type->type);
1098 for (unsigned i = 0; i < elems; i++) {
1099 chain.link[0].id = i;
1100 struct vtn_pointer *src_elem =
1101 vtn_pointer_dereference(b, src, &chain);
1102 struct vtn_pointer *dest_elem =
1103 vtn_pointer_dereference(b, dest, &chain);
1104
1105 _vtn_variable_copy(b, dest_elem, src_elem);
1106 }
1107 return;
1108 }
1109
1110 default:
1111 vtn_fail("Invalid access chain type");
1112 }
1113 }
1114
1115 static void
1116 vtn_variable_copy(struct vtn_builder *b, struct vtn_pointer *dest,
1117 struct vtn_pointer *src)
1118 {
1119 /* TODO: At some point, we should add a special-case for when we can
1120 * just emit a copy_var intrinsic.
1121 */
1122 _vtn_variable_copy(b, dest, src);
1123 }
1124
1125 static void
1126 set_mode_system_value(struct vtn_builder *b, nir_variable_mode *mode)
1127 {
1128 vtn_assert(*mode == nir_var_system_value || *mode == nir_var_shader_in);
1129 *mode = nir_var_system_value;
1130 }
1131
1132 static void
1133 vtn_get_builtin_location(struct vtn_builder *b,
1134 SpvBuiltIn builtin, int *location,
1135 nir_variable_mode *mode)
1136 {
1137 switch (builtin) {
1138 case SpvBuiltInPosition:
1139 *location = VARYING_SLOT_POS;
1140 break;
1141 case SpvBuiltInPointSize:
1142 *location = VARYING_SLOT_PSIZ;
1143 break;
1144 case SpvBuiltInClipDistance:
1145 *location = VARYING_SLOT_CLIP_DIST0; /* XXX CLIP_DIST1? */
1146 break;
1147 case SpvBuiltInCullDistance:
1148 *location = VARYING_SLOT_CULL_DIST0;
1149 break;
1150 case SpvBuiltInVertexIndex:
1151 *location = SYSTEM_VALUE_VERTEX_ID;
1152 set_mode_system_value(b, mode);
1153 break;
1154 case SpvBuiltInVertexId:
1155 /* Vulkan defines VertexID to be zero-based and reserves the new
1156 * builtin keyword VertexIndex to indicate the non-zero-based value.
1157 */
1158 *location = SYSTEM_VALUE_VERTEX_ID_ZERO_BASE;
1159 set_mode_system_value(b, mode);
1160 break;
1161 case SpvBuiltInInstanceIndex:
1162 *location = SYSTEM_VALUE_INSTANCE_INDEX;
1163 set_mode_system_value(b, mode);
1164 break;
1165 case SpvBuiltInInstanceId:
1166 *location = SYSTEM_VALUE_INSTANCE_ID;
1167 set_mode_system_value(b, mode);
1168 break;
1169 case SpvBuiltInPrimitiveId:
1170 if (b->shader->info.stage == MESA_SHADER_FRAGMENT) {
1171 vtn_assert(*mode == nir_var_shader_in);
1172 *location = VARYING_SLOT_PRIMITIVE_ID;
1173 } else if (*mode == nir_var_shader_out) {
1174 *location = VARYING_SLOT_PRIMITIVE_ID;
1175 } else {
1176 *location = SYSTEM_VALUE_PRIMITIVE_ID;
1177 set_mode_system_value(b, mode);
1178 }
1179 break;
1180 case SpvBuiltInInvocationId:
1181 *location = SYSTEM_VALUE_INVOCATION_ID;
1182 set_mode_system_value(b, mode);
1183 break;
1184 case SpvBuiltInLayer:
1185 *location = VARYING_SLOT_LAYER;
1186 if (b->shader->info.stage == MESA_SHADER_FRAGMENT)
1187 *mode = nir_var_shader_in;
1188 else if (b->shader->info.stage == MESA_SHADER_GEOMETRY)
1189 *mode = nir_var_shader_out;
1190 else if (b->options && b->options->caps.shader_viewport_index_layer &&
1191 (b->shader->info.stage == MESA_SHADER_VERTEX ||
1192 b->shader->info.stage == MESA_SHADER_TESS_EVAL))
1193 *mode = nir_var_shader_out;
1194 else
1195 vtn_fail("invalid stage for SpvBuiltInLayer");
1196 break;
1197 case SpvBuiltInViewportIndex:
1198 *location = VARYING_SLOT_VIEWPORT;
1199 if (b->shader->info.stage == MESA_SHADER_GEOMETRY)
1200 *mode = nir_var_shader_out;
1201 else if (b->options && b->options->caps.shader_viewport_index_layer &&
1202 (b->shader->info.stage == MESA_SHADER_VERTEX ||
1203 b->shader->info.stage == MESA_SHADER_TESS_EVAL))
1204 *mode = nir_var_shader_out;
1205 else if (b->shader->info.stage == MESA_SHADER_FRAGMENT)
1206 *mode = nir_var_shader_in;
1207 else
1208 vtn_fail("invalid stage for SpvBuiltInViewportIndex");
1209 break;
1210 case SpvBuiltInTessLevelOuter:
1211 *location = VARYING_SLOT_TESS_LEVEL_OUTER;
1212 break;
1213 case SpvBuiltInTessLevelInner:
1214 *location = VARYING_SLOT_TESS_LEVEL_INNER;
1215 break;
1216 case SpvBuiltInTessCoord:
1217 *location = SYSTEM_VALUE_TESS_COORD;
1218 set_mode_system_value(b, mode);
1219 break;
1220 case SpvBuiltInPatchVertices:
1221 *location = SYSTEM_VALUE_VERTICES_IN;
1222 set_mode_system_value(b, mode);
1223 break;
1224 case SpvBuiltInFragCoord:
1225 *location = VARYING_SLOT_POS;
1226 vtn_assert(*mode == nir_var_shader_in);
1227 break;
1228 case SpvBuiltInPointCoord:
1229 *location = VARYING_SLOT_PNTC;
1230 vtn_assert(*mode == nir_var_shader_in);
1231 break;
1232 case SpvBuiltInFrontFacing:
1233 *location = SYSTEM_VALUE_FRONT_FACE;
1234 set_mode_system_value(b, mode);
1235 break;
1236 case SpvBuiltInSampleId:
1237 *location = SYSTEM_VALUE_SAMPLE_ID;
1238 set_mode_system_value(b, mode);
1239 break;
1240 case SpvBuiltInSamplePosition:
1241 *location = SYSTEM_VALUE_SAMPLE_POS;
1242 set_mode_system_value(b, mode);
1243 break;
1244 case SpvBuiltInSampleMask:
1245 if (*mode == nir_var_shader_out) {
1246 *location = FRAG_RESULT_SAMPLE_MASK;
1247 } else {
1248 *location = SYSTEM_VALUE_SAMPLE_MASK_IN;
1249 set_mode_system_value(b, mode);
1250 }
1251 break;
1252 case SpvBuiltInFragDepth:
1253 *location = FRAG_RESULT_DEPTH;
1254 vtn_assert(*mode == nir_var_shader_out);
1255 break;
1256 case SpvBuiltInHelperInvocation:
1257 *location = SYSTEM_VALUE_HELPER_INVOCATION;
1258 set_mode_system_value(b, mode);
1259 break;
1260 case SpvBuiltInNumWorkgroups:
1261 *location = SYSTEM_VALUE_NUM_WORK_GROUPS;
1262 set_mode_system_value(b, mode);
1263 break;
1264 case SpvBuiltInWorkgroupSize:
1265 /* This should already be handled */
1266 vtn_fail("unsupported builtin");
1267 break;
1268 case SpvBuiltInWorkgroupId:
1269 *location = SYSTEM_VALUE_WORK_GROUP_ID;
1270 set_mode_system_value(b, mode);
1271 break;
1272 case SpvBuiltInLocalInvocationId:
1273 *location = SYSTEM_VALUE_LOCAL_INVOCATION_ID;
1274 set_mode_system_value(b, mode);
1275 break;
1276 case SpvBuiltInLocalInvocationIndex:
1277 *location = SYSTEM_VALUE_LOCAL_INVOCATION_INDEX;
1278 set_mode_system_value(b, mode);
1279 break;
1280 case SpvBuiltInGlobalInvocationId:
1281 *location = SYSTEM_VALUE_GLOBAL_INVOCATION_ID;
1282 set_mode_system_value(b, mode);
1283 break;
1284 case SpvBuiltInBaseVertex:
1285 *location = SYSTEM_VALUE_BASE_VERTEX;
1286 set_mode_system_value(b, mode);
1287 break;
1288 case SpvBuiltInBaseInstance:
1289 *location = SYSTEM_VALUE_BASE_INSTANCE;
1290 set_mode_system_value(b, mode);
1291 break;
1292 case SpvBuiltInDrawIndex:
1293 *location = SYSTEM_VALUE_DRAW_ID;
1294 set_mode_system_value(b, mode);
1295 break;
1296 case SpvBuiltInViewIndex:
1297 *location = SYSTEM_VALUE_VIEW_INDEX;
1298 set_mode_system_value(b, mode);
1299 break;
1300 default:
1301 vtn_fail("unsupported builtin");
1302 }
1303 }
1304
1305 static void
1306 apply_var_decoration(struct vtn_builder *b, nir_variable *nir_var,
1307 const struct vtn_decoration *dec)
1308 {
1309 switch (dec->decoration) {
1310 case SpvDecorationRelaxedPrecision:
1311 break; /* FIXME: Do nothing with this for now. */
1312 case SpvDecorationNoPerspective:
1313 nir_var->data.interpolation = INTERP_MODE_NOPERSPECTIVE;
1314 break;
1315 case SpvDecorationFlat:
1316 nir_var->data.interpolation = INTERP_MODE_FLAT;
1317 break;
1318 case SpvDecorationCentroid:
1319 nir_var->data.centroid = true;
1320 break;
1321 case SpvDecorationSample:
1322 nir_var->data.sample = true;
1323 break;
1324 case SpvDecorationInvariant:
1325 nir_var->data.invariant = true;
1326 break;
1327 case SpvDecorationConstant:
1328 vtn_assert(nir_var->constant_initializer != NULL);
1329 nir_var->data.read_only = true;
1330 break;
1331 case SpvDecorationNonReadable:
1332 nir_var->data.image.write_only = true;
1333 break;
1334 case SpvDecorationNonWritable:
1335 nir_var->data.read_only = true;
1336 nir_var->data.image.read_only = true;
1337 break;
1338 case SpvDecorationRestrict:
1339 nir_var->data.image.restrict_flag = true;
1340 break;
1341 case SpvDecorationVolatile:
1342 nir_var->data.image._volatile = true;
1343 break;
1344 case SpvDecorationCoherent:
1345 nir_var->data.image.coherent = true;
1346 break;
1347 case SpvDecorationComponent:
1348 nir_var->data.location_frac = dec->literals[0];
1349 break;
1350 case SpvDecorationIndex:
1351 nir_var->data.index = dec->literals[0];
1352 break;
1353 case SpvDecorationBuiltIn: {
1354 SpvBuiltIn builtin = dec->literals[0];
1355
1356 if (builtin == SpvBuiltInWorkgroupSize) {
1357 /* This shouldn't be a builtin. It's actually a constant. */
1358 nir_var->data.mode = nir_var_global;
1359 nir_var->data.read_only = true;
1360
1361 nir_constant *c = rzalloc(nir_var, nir_constant);
1362 c->values[0].u32[0] = b->shader->info.cs.local_size[0];
1363 c->values[0].u32[1] = b->shader->info.cs.local_size[1];
1364 c->values[0].u32[2] = b->shader->info.cs.local_size[2];
1365 nir_var->constant_initializer = c;
1366 break;
1367 }
1368
1369 nir_variable_mode mode = nir_var->data.mode;
1370 vtn_get_builtin_location(b, builtin, &nir_var->data.location, &mode);
1371 nir_var->data.mode = mode;
1372
1373 switch (builtin) {
1374 case SpvBuiltInTessLevelOuter:
1375 case SpvBuiltInTessLevelInner:
1376 nir_var->data.compact = true;
1377 break;
1378 case SpvBuiltInSamplePosition:
1379 nir_var->data.origin_upper_left = b->origin_upper_left;
1380 /* fallthrough */
1381 case SpvBuiltInFragCoord:
1382 nir_var->data.pixel_center_integer = b->pixel_center_integer;
1383 break;
1384 default:
1385 break;
1386 }
1387 }
1388
1389 case SpvDecorationSpecId:
1390 case SpvDecorationRowMajor:
1391 case SpvDecorationColMajor:
1392 case SpvDecorationMatrixStride:
1393 case SpvDecorationAliased:
1394 case SpvDecorationUniform:
1395 case SpvDecorationStream:
1396 case SpvDecorationOffset:
1397 case SpvDecorationLinkageAttributes:
1398 break; /* Do nothing with these here */
1399
1400 case SpvDecorationPatch:
1401 nir_var->data.patch = true;
1402 break;
1403
1404 case SpvDecorationLocation:
1405 vtn_fail("Handled above");
1406
1407 case SpvDecorationBlock:
1408 case SpvDecorationBufferBlock:
1409 case SpvDecorationArrayStride:
1410 case SpvDecorationGLSLShared:
1411 case SpvDecorationGLSLPacked:
1412 break; /* These can apply to a type but we don't care about them */
1413
1414 case SpvDecorationBinding:
1415 case SpvDecorationDescriptorSet:
1416 case SpvDecorationNoContraction:
1417 case SpvDecorationInputAttachmentIndex:
1418 vtn_warn("Decoration not allowed for variable or structure member: %s",
1419 spirv_decoration_to_string(dec->decoration));
1420 break;
1421
1422 case SpvDecorationXfbBuffer:
1423 case SpvDecorationXfbStride:
1424 vtn_warn("Vulkan does not have transform feedback: %s",
1425 spirv_decoration_to_string(dec->decoration));
1426 break;
1427
1428 case SpvDecorationCPacked:
1429 case SpvDecorationSaturatedConversion:
1430 case SpvDecorationFuncParamAttr:
1431 case SpvDecorationFPRoundingMode:
1432 case SpvDecorationFPFastMathMode:
1433 case SpvDecorationAlignment:
1434 vtn_warn("Decoration only allowed for CL-style kernels: %s",
1435 spirv_decoration_to_string(dec->decoration));
1436 break;
1437
1438 default:
1439 vtn_fail("Unhandled decoration");
1440 }
1441 }
1442
1443 static void
1444 var_is_patch_cb(struct vtn_builder *b, struct vtn_value *val, int member,
1445 const struct vtn_decoration *dec, void *out_is_patch)
1446 {
1447 if (dec->decoration == SpvDecorationPatch) {
1448 *((bool *) out_is_patch) = true;
1449 }
1450 }
1451
1452 static void
1453 var_decoration_cb(struct vtn_builder *b, struct vtn_value *val, int member,
1454 const struct vtn_decoration *dec, void *void_var)
1455 {
1456 struct vtn_variable *vtn_var = void_var;
1457
1458 /* Handle decorations that apply to a vtn_variable as a whole */
1459 switch (dec->decoration) {
1460 case SpvDecorationBinding:
1461 vtn_var->binding = dec->literals[0];
1462 return;
1463 case SpvDecorationDescriptorSet:
1464 vtn_var->descriptor_set = dec->literals[0];
1465 return;
1466 case SpvDecorationInputAttachmentIndex:
1467 vtn_var->input_attachment_index = dec->literals[0];
1468 return;
1469 case SpvDecorationPatch:
1470 vtn_var->patch = true;
1471 break;
1472 default:
1473 break;
1474 }
1475
1476 if (val->value_type == vtn_value_type_pointer) {
1477 assert(val->pointer->var == void_var);
1478 assert(val->pointer->chain == NULL);
1479 assert(member == -1);
1480 } else {
1481 assert(val->value_type == vtn_value_type_type);
1482 }
1483
1484 /* Location is odd. If applied to a split structure, we have to walk the
1485 * whole thing and accumulate the location. It's easier to handle as a
1486 * special case.
1487 */
1488 if (dec->decoration == SpvDecorationLocation) {
1489 unsigned location = dec->literals[0];
1490 bool is_vertex_input;
1491 if (b->shader->info.stage == MESA_SHADER_FRAGMENT &&
1492 vtn_var->mode == vtn_variable_mode_output) {
1493 is_vertex_input = false;
1494 location += FRAG_RESULT_DATA0;
1495 } else if (b->shader->info.stage == MESA_SHADER_VERTEX &&
1496 vtn_var->mode == vtn_variable_mode_input) {
1497 is_vertex_input = true;
1498 location += VERT_ATTRIB_GENERIC0;
1499 } else if (vtn_var->mode == vtn_variable_mode_input ||
1500 vtn_var->mode == vtn_variable_mode_output) {
1501 is_vertex_input = false;
1502 location += vtn_var->patch ? VARYING_SLOT_PATCH0 : VARYING_SLOT_VAR0;
1503 } else {
1504 vtn_warn("Location must be on input or output variable");
1505 return;
1506 }
1507
1508 if (vtn_var->var) {
1509 /* This handles the member and lone variable cases */
1510 vtn_var->var->data.location = location;
1511 } else {
1512 /* This handles the structure member case */
1513 assert(vtn_var->members);
1514 unsigned length =
1515 glsl_get_length(glsl_without_array(vtn_var->type->type));
1516 for (unsigned i = 0; i < length; i++) {
1517 vtn_var->members[i]->data.location = location;
1518 location +=
1519 glsl_count_attribute_slots(vtn_var->members[i]->interface_type,
1520 is_vertex_input);
1521 }
1522 }
1523 return;
1524 } else {
1525 if (vtn_var->var) {
1526 assert(member == -1);
1527 apply_var_decoration(b, vtn_var->var, dec);
1528 } else if (vtn_var->members) {
1529 if (member >= 0) {
1530 /* Member decorations must come from a type */
1531 assert(val->value_type == vtn_value_type_type);
1532 apply_var_decoration(b, vtn_var->members[member], dec);
1533 } else {
1534 unsigned length =
1535 glsl_get_length(glsl_without_array(vtn_var->type->type));
1536 for (unsigned i = 0; i < length; i++)
1537 apply_var_decoration(b, vtn_var->members[i], dec);
1538 }
1539 } else {
1540 /* A few variables, those with external storage, have no actual
1541 * nir_variables associated with them. Fortunately, all decorations
1542 * we care about for those variables are on the type only.
1543 */
1544 vtn_assert(vtn_var->mode == vtn_variable_mode_ubo ||
1545 vtn_var->mode == vtn_variable_mode_ssbo ||
1546 vtn_var->mode == vtn_variable_mode_push_constant ||
1547 (vtn_var->mode == vtn_variable_mode_workgroup &&
1548 b->options->lower_workgroup_access_to_offsets));
1549 }
1550 }
1551 }
1552
1553 static enum vtn_variable_mode
1554 vtn_storage_class_to_mode(struct vtn_builder *b,
1555 SpvStorageClass class,
1556 struct vtn_type *interface_type,
1557 nir_variable_mode *nir_mode_out)
1558 {
1559 enum vtn_variable_mode mode;
1560 nir_variable_mode nir_mode;
1561 switch (class) {
1562 case SpvStorageClassUniform:
1563 if (interface_type->block) {
1564 mode = vtn_variable_mode_ubo;
1565 nir_mode = 0;
1566 } else if (interface_type->buffer_block) {
1567 mode = vtn_variable_mode_ssbo;
1568 nir_mode = 0;
1569 } else {
1570 vtn_fail("Invalid uniform variable type");
1571 }
1572 break;
1573 case SpvStorageClassStorageBuffer:
1574 mode = vtn_variable_mode_ssbo;
1575 nir_mode = 0;
1576 break;
1577 case SpvStorageClassUniformConstant:
1578 if (glsl_type_is_image(interface_type->type)) {
1579 mode = vtn_variable_mode_image;
1580 nir_mode = nir_var_uniform;
1581 } else if (glsl_type_is_sampler(interface_type->type)) {
1582 mode = vtn_variable_mode_sampler;
1583 nir_mode = nir_var_uniform;
1584 } else {
1585 vtn_fail("Invalid uniform constant variable type");
1586 }
1587 break;
1588 case SpvStorageClassPushConstant:
1589 mode = vtn_variable_mode_push_constant;
1590 nir_mode = nir_var_uniform;
1591 break;
1592 case SpvStorageClassInput:
1593 mode = vtn_variable_mode_input;
1594 nir_mode = nir_var_shader_in;
1595 break;
1596 case SpvStorageClassOutput:
1597 mode = vtn_variable_mode_output;
1598 nir_mode = nir_var_shader_out;
1599 break;
1600 case SpvStorageClassPrivate:
1601 mode = vtn_variable_mode_global;
1602 nir_mode = nir_var_global;
1603 break;
1604 case SpvStorageClassFunction:
1605 mode = vtn_variable_mode_local;
1606 nir_mode = nir_var_local;
1607 break;
1608 case SpvStorageClassWorkgroup:
1609 mode = vtn_variable_mode_workgroup;
1610 nir_mode = nir_var_shared;
1611 break;
1612 case SpvStorageClassCrossWorkgroup:
1613 case SpvStorageClassGeneric:
1614 case SpvStorageClassAtomicCounter:
1615 default:
1616 vtn_fail("Unhandled variable storage class");
1617 }
1618
1619 if (nir_mode_out)
1620 *nir_mode_out = nir_mode;
1621
1622 return mode;
1623 }
1624
1625 nir_ssa_def *
1626 vtn_pointer_to_ssa(struct vtn_builder *b, struct vtn_pointer *ptr)
1627 {
1628 /* This pointer needs to have a pointer type with actual storage */
1629 vtn_assert(ptr->ptr_type);
1630 vtn_assert(ptr->ptr_type->type);
1631
1632 if (!ptr->offset) {
1633 /* If we don't have an offset then we must be a pointer to the variable
1634 * itself.
1635 */
1636 vtn_assert(!ptr->offset && !ptr->block_index);
1637
1638 struct vtn_access_chain chain = {
1639 .length = 0,
1640 };
1641 ptr = vtn_ssa_offset_pointer_dereference(b, ptr, &chain);
1642 }
1643
1644 vtn_assert(ptr->offset);
1645 if (ptr->block_index) {
1646 vtn_assert(ptr->mode == vtn_variable_mode_ubo ||
1647 ptr->mode == vtn_variable_mode_ssbo);
1648 return nir_vec2(&b->nb, ptr->block_index, ptr->offset);
1649 } else {
1650 vtn_assert(ptr->mode == vtn_variable_mode_workgroup);
1651 return ptr->offset;
1652 }
1653 }
1654
1655 struct vtn_pointer *
1656 vtn_pointer_from_ssa(struct vtn_builder *b, nir_ssa_def *ssa,
1657 struct vtn_type *ptr_type)
1658 {
1659 vtn_assert(ssa->num_components <= 2 && ssa->bit_size == 32);
1660 vtn_assert(ptr_type->base_type == vtn_base_type_pointer);
1661 vtn_assert(ptr_type->deref->base_type != vtn_base_type_pointer);
1662 /* This pointer type needs to have actual storage */
1663 vtn_assert(ptr_type->type);
1664
1665 struct vtn_pointer *ptr = rzalloc(b, struct vtn_pointer);
1666 ptr->mode = vtn_storage_class_to_mode(b, ptr_type->storage_class,
1667 ptr_type, NULL);
1668 ptr->type = ptr_type->deref;
1669 ptr->ptr_type = ptr_type;
1670
1671 if (ssa->num_components > 1) {
1672 vtn_assert(ssa->num_components == 2);
1673 vtn_assert(ptr->mode == vtn_variable_mode_ubo ||
1674 ptr->mode == vtn_variable_mode_ssbo);
1675 ptr->block_index = nir_channel(&b->nb, ssa, 0);
1676 ptr->offset = nir_channel(&b->nb, ssa, 1);
1677 } else {
1678 vtn_assert(ssa->num_components == 1);
1679 vtn_assert(ptr->mode == vtn_variable_mode_workgroup);
1680 ptr->block_index = NULL;
1681 ptr->offset = ssa;
1682 }
1683
1684 return ptr;
1685 }
1686
1687 static bool
1688 is_per_vertex_inout(const struct vtn_variable *var, gl_shader_stage stage)
1689 {
1690 if (var->patch || !glsl_type_is_array(var->type->type))
1691 return false;
1692
1693 if (var->mode == vtn_variable_mode_input) {
1694 return stage == MESA_SHADER_TESS_CTRL ||
1695 stage == MESA_SHADER_TESS_EVAL ||
1696 stage == MESA_SHADER_GEOMETRY;
1697 }
1698
1699 if (var->mode == vtn_variable_mode_output)
1700 return stage == MESA_SHADER_TESS_CTRL;
1701
1702 return false;
1703 }
1704
1705 static void
1706 vtn_create_variable(struct vtn_builder *b, struct vtn_value *val,
1707 struct vtn_type *ptr_type, SpvStorageClass storage_class,
1708 nir_constant *initializer)
1709 {
1710 vtn_assert(ptr_type->base_type == vtn_base_type_pointer);
1711 struct vtn_type *type = ptr_type->deref;
1712
1713 struct vtn_type *without_array = type;
1714 while(glsl_type_is_array(without_array->type))
1715 without_array = without_array->array_element;
1716
1717 enum vtn_variable_mode mode;
1718 nir_variable_mode nir_mode;
1719 mode = vtn_storage_class_to_mode(b, storage_class, without_array, &nir_mode);
1720
1721 switch (mode) {
1722 case vtn_variable_mode_ubo:
1723 b->shader->info.num_ubos++;
1724 break;
1725 case vtn_variable_mode_ssbo:
1726 b->shader->info.num_ssbos++;
1727 break;
1728 case vtn_variable_mode_image:
1729 b->shader->info.num_images++;
1730 break;
1731 case vtn_variable_mode_sampler:
1732 b->shader->info.num_textures++;
1733 break;
1734 case vtn_variable_mode_push_constant:
1735 b->shader->num_uniforms = vtn_type_block_size(b, type);
1736 break;
1737 default:
1738 /* No tallying is needed */
1739 break;
1740 }
1741
1742 struct vtn_variable *var = rzalloc(b, struct vtn_variable);
1743 var->type = type;
1744 var->mode = mode;
1745
1746 vtn_assert(val->value_type == vtn_value_type_pointer);
1747 val->pointer = vtn_pointer_for_variable(b, var, ptr_type);
1748
1749 switch (var->mode) {
1750 case vtn_variable_mode_local:
1751 case vtn_variable_mode_global:
1752 case vtn_variable_mode_image:
1753 case vtn_variable_mode_sampler:
1754 /* For these, we create the variable normally */
1755 var->var = rzalloc(b->shader, nir_variable);
1756 var->var->name = ralloc_strdup(var->var, val->name);
1757 var->var->type = var->type->type;
1758 var->var->data.mode = nir_mode;
1759
1760 switch (var->mode) {
1761 case vtn_variable_mode_image:
1762 case vtn_variable_mode_sampler:
1763 var->var->interface_type = without_array->type;
1764 break;
1765 default:
1766 var->var->interface_type = NULL;
1767 break;
1768 }
1769 break;
1770
1771 case vtn_variable_mode_workgroup:
1772 if (b->options->lower_workgroup_access_to_offsets) {
1773 var->shared_location = -1;
1774 } else {
1775 /* Create the variable normally */
1776 var->var = rzalloc(b->shader, nir_variable);
1777 var->var->name = ralloc_strdup(var->var, val->name);
1778 var->var->type = var->type->type;
1779 var->var->data.mode = nir_var_shared;
1780 }
1781 break;
1782
1783 case vtn_variable_mode_input:
1784 case vtn_variable_mode_output: {
1785 /* In order to know whether or not we're a per-vertex inout, we need
1786 * the patch qualifier. This means walking the variable decorations
1787 * early before we actually create any variables. Not a big deal.
1788 *
1789 * GLSLang really likes to place decorations in the most interior
1790 * thing it possibly can. In particular, if you have a struct, it
1791 * will place the patch decorations on the struct members. This
1792 * should be handled by the variable splitting below just fine.
1793 *
1794 * If you have an array-of-struct, things get even more weird as it
1795 * will place the patch decorations on the struct even though it's
1796 * inside an array and some of the members being patch and others not
1797 * makes no sense whatsoever. Since the only sensible thing is for
1798 * it to be all or nothing, we'll call it patch if any of the members
1799 * are declared patch.
1800 */
1801 var->patch = false;
1802 vtn_foreach_decoration(b, val, var_is_patch_cb, &var->patch);
1803 if (glsl_type_is_array(var->type->type) &&
1804 glsl_type_is_struct(without_array->type)) {
1805 vtn_foreach_decoration(b, vtn_value(b, without_array->id,
1806 vtn_value_type_type),
1807 var_is_patch_cb, &var->patch);
1808 }
1809
1810 /* For inputs and outputs, we immediately split structures. This
1811 * is for a couple of reasons. For one, builtins may all come in
1812 * a struct and we really want those split out into separate
1813 * variables. For another, interpolation qualifiers can be
1814 * applied to members of the top-level struct ane we need to be
1815 * able to preserve that information.
1816 */
1817
1818 int array_length = -1;
1819 struct vtn_type *interface_type = var->type;
1820 if (is_per_vertex_inout(var, b->shader->info.stage)) {
1821 /* In Geometry shaders (and some tessellation), inputs come
1822 * in per-vertex arrays. However, some builtins come in
1823 * non-per-vertex, hence the need for the is_array check. In
1824 * any case, there are no non-builtin arrays allowed so this
1825 * check should be sufficient.
1826 */
1827 interface_type = var->type->array_element;
1828 array_length = glsl_get_length(var->type->type);
1829 }
1830
1831 if (glsl_type_is_struct(interface_type->type)) {
1832 /* It's a struct. Split it. */
1833 unsigned num_members = glsl_get_length(interface_type->type);
1834 var->members = ralloc_array(b, nir_variable *, num_members);
1835
1836 for (unsigned i = 0; i < num_members; i++) {
1837 const struct glsl_type *mtype = interface_type->members[i]->type;
1838 if (array_length >= 0)
1839 mtype = glsl_array_type(mtype, array_length);
1840
1841 var->members[i] = rzalloc(b->shader, nir_variable);
1842 var->members[i]->name =
1843 ralloc_asprintf(var->members[i], "%s.%d", val->name, i);
1844 var->members[i]->type = mtype;
1845 var->members[i]->interface_type =
1846 interface_type->members[i]->type;
1847 var->members[i]->data.mode = nir_mode;
1848 var->members[i]->data.patch = var->patch;
1849
1850 if (initializer) {
1851 assert(i < initializer->num_elements);
1852 var->members[i]->constant_initializer =
1853 nir_constant_clone(initializer->elements[i], var->members[i]);
1854 }
1855 }
1856
1857 initializer = NULL;
1858 } else {
1859 var->var = rzalloc(b->shader, nir_variable);
1860 var->var->name = ralloc_strdup(var->var, val->name);
1861 var->var->type = var->type->type;
1862 var->var->interface_type = interface_type->type;
1863 var->var->data.mode = nir_mode;
1864 var->var->data.patch = var->patch;
1865 }
1866
1867 /* For inputs and outputs, we need to grab locations and builtin
1868 * information from the interface type.
1869 */
1870 vtn_foreach_decoration(b, vtn_value(b, interface_type->id,
1871 vtn_value_type_type),
1872 var_decoration_cb, var);
1873 break;
1874 }
1875
1876 case vtn_variable_mode_param:
1877 vtn_fail("Not created through OpVariable");
1878
1879 case vtn_variable_mode_ubo:
1880 case vtn_variable_mode_ssbo:
1881 case vtn_variable_mode_push_constant:
1882 /* These don't need actual variables. */
1883 break;
1884 }
1885
1886 if (initializer) {
1887 var->var->constant_initializer =
1888 nir_constant_clone(initializer, var->var);
1889 }
1890
1891 vtn_foreach_decoration(b, val, var_decoration_cb, var);
1892
1893 if (var->mode == vtn_variable_mode_image ||
1894 var->mode == vtn_variable_mode_sampler) {
1895 /* XXX: We still need the binding information in the nir_variable
1896 * for these. We should fix that.
1897 */
1898 var->var->data.binding = var->binding;
1899 var->var->data.descriptor_set = var->descriptor_set;
1900 var->var->data.index = var->input_attachment_index;
1901
1902 if (var->mode == vtn_variable_mode_image)
1903 var->var->data.image.format = without_array->image_format;
1904 }
1905
1906 if (var->mode == vtn_variable_mode_local) {
1907 vtn_assert(var->members == NULL && var->var != NULL);
1908 nir_function_impl_add_variable(b->nb.impl, var->var);
1909 } else if (var->var) {
1910 nir_shader_add_variable(b->shader, var->var);
1911 } else if (var->members) {
1912 unsigned count = glsl_get_length(without_array->type);
1913 for (unsigned i = 0; i < count; i++) {
1914 vtn_assert(var->members[i]->data.mode != nir_var_local);
1915 nir_shader_add_variable(b->shader, var->members[i]);
1916 }
1917 } else {
1918 vtn_assert(vtn_pointer_is_external_block(b, val->pointer));
1919 }
1920 }
1921
1922 static void
1923 vtn_assert_types_equal(struct vtn_builder *b, SpvOp opcode,
1924 struct vtn_type *dst_type,
1925 struct vtn_type *src_type)
1926 {
1927 if (dst_type->id == src_type->id)
1928 return;
1929
1930 if (vtn_types_compatible(b, dst_type, src_type)) {
1931 /* Early versions of GLSLang would re-emit types unnecessarily and you
1932 * would end up with OpLoad, OpStore, or OpCopyMemory opcodes which have
1933 * mismatched source and destination types.
1934 *
1935 * https://github.com/KhronosGroup/glslang/issues/304
1936 * https://github.com/KhronosGroup/glslang/issues/307
1937 * https://bugs.freedesktop.org/show_bug.cgi?id=104338
1938 * https://bugs.freedesktop.org/show_bug.cgi?id=104424
1939 */
1940 vtn_warn("Source and destination types of %s do not have the same "
1941 "ID (but are compatible): %u vs %u",
1942 spirv_op_to_string(opcode), dst_type->id, src_type->id);
1943 return;
1944 }
1945
1946 vtn_fail("Source and destination types of %s do not match: %s vs. %s",
1947 spirv_op_to_string(opcode),
1948 glsl_get_type_name(dst_type->type),
1949 glsl_get_type_name(src_type->type));
1950 }
1951
1952 void
1953 vtn_handle_variables(struct vtn_builder *b, SpvOp opcode,
1954 const uint32_t *w, unsigned count)
1955 {
1956 switch (opcode) {
1957 case SpvOpUndef: {
1958 struct vtn_value *val = vtn_push_value(b, w[2], vtn_value_type_undef);
1959 val->type = vtn_value(b, w[1], vtn_value_type_type)->type;
1960 break;
1961 }
1962
1963 case SpvOpVariable: {
1964 struct vtn_type *ptr_type = vtn_value(b, w[1], vtn_value_type_type)->type;
1965
1966 struct vtn_value *val = vtn_push_value(b, w[2], vtn_value_type_pointer);
1967
1968 SpvStorageClass storage_class = w[3];
1969 nir_constant *initializer = NULL;
1970 if (count > 4)
1971 initializer = vtn_value(b, w[4], vtn_value_type_constant)->constant;
1972
1973 vtn_create_variable(b, val, ptr_type, storage_class, initializer);
1974 break;
1975 }
1976
1977 case SpvOpAccessChain:
1978 case SpvOpPtrAccessChain:
1979 case SpvOpInBoundsAccessChain: {
1980 struct vtn_access_chain *chain = vtn_access_chain_create(b, count - 4);
1981 chain->ptr_as_array = (opcode == SpvOpPtrAccessChain);
1982
1983 unsigned idx = 0;
1984 for (int i = 4; i < count; i++) {
1985 struct vtn_value *link_val = vtn_untyped_value(b, w[i]);
1986 if (link_val->value_type == vtn_value_type_constant) {
1987 chain->link[idx].mode = vtn_access_mode_literal;
1988 chain->link[idx].id = link_val->constant->values[0].u32[0];
1989 } else {
1990 chain->link[idx].mode = vtn_access_mode_id;
1991 chain->link[idx].id = w[i];
1992
1993 }
1994 idx++;
1995 }
1996
1997 struct vtn_type *ptr_type = vtn_value(b, w[1], vtn_value_type_type)->type;
1998 struct vtn_value *base_val = vtn_untyped_value(b, w[3]);
1999 if (base_val->value_type == vtn_value_type_sampled_image) {
2000 /* This is rather insane. SPIR-V allows you to use OpSampledImage
2001 * to combine an array of images with a single sampler to get an
2002 * array of sampled images that all share the same sampler.
2003 * Fortunately, this means that we can more-or-less ignore the
2004 * sampler when crawling the access chain, but it does leave us
2005 * with this rather awkward little special-case.
2006 */
2007 struct vtn_value *val =
2008 vtn_push_value(b, w[2], vtn_value_type_sampled_image);
2009 val->sampled_image = ralloc(b, struct vtn_sampled_image);
2010 val->sampled_image->type = base_val->sampled_image->type;
2011 val->sampled_image->image =
2012 vtn_pointer_dereference(b, base_val->sampled_image->image, chain);
2013 val->sampled_image->sampler = base_val->sampled_image->sampler;
2014 } else {
2015 vtn_assert(base_val->value_type == vtn_value_type_pointer);
2016 struct vtn_value *val =
2017 vtn_push_value(b, w[2], vtn_value_type_pointer);
2018 val->pointer = vtn_pointer_dereference(b, base_val->pointer, chain);
2019 val->pointer->ptr_type = ptr_type;
2020 }
2021 break;
2022 }
2023
2024 case SpvOpCopyMemory: {
2025 struct vtn_value *dest = vtn_value(b, w[1], vtn_value_type_pointer);
2026 struct vtn_value *src = vtn_value(b, w[2], vtn_value_type_pointer);
2027
2028 vtn_assert_types_equal(b, opcode, dest->type->deref, src->type->deref);
2029
2030 vtn_variable_copy(b, dest->pointer, src->pointer);
2031 break;
2032 }
2033
2034 case SpvOpLoad: {
2035 struct vtn_type *res_type =
2036 vtn_value(b, w[1], vtn_value_type_type)->type;
2037 struct vtn_value *src_val = vtn_value(b, w[3], vtn_value_type_pointer);
2038 struct vtn_pointer *src = src_val->pointer;
2039
2040 vtn_assert_types_equal(b, opcode, res_type, src_val->type->deref);
2041
2042 if (src->mode == vtn_variable_mode_image ||
2043 src->mode == vtn_variable_mode_sampler) {
2044 vtn_push_value(b, w[2], vtn_value_type_pointer)->pointer = src;
2045 return;
2046 }
2047
2048 vtn_push_ssa(b, w[2], res_type, vtn_variable_load(b, src));
2049 break;
2050 }
2051
2052 case SpvOpStore: {
2053 struct vtn_value *dest_val = vtn_value(b, w[1], vtn_value_type_pointer);
2054 struct vtn_pointer *dest = dest_val->pointer;
2055 struct vtn_value *src_val = vtn_untyped_value(b, w[2]);
2056
2057 /* OpStore requires us to actually have a storage type */
2058 vtn_fail_if(dest->type->type == NULL,
2059 "Invalid destination type for OpStore");
2060
2061 if (glsl_get_base_type(dest->type->type) == GLSL_TYPE_BOOL &&
2062 glsl_get_base_type(src_val->type->type) == GLSL_TYPE_UINT) {
2063 /* Early versions of GLSLang would use uint types for UBOs/SSBOs but
2064 * would then store them to a local variable as bool. Work around
2065 * the issue by doing an implicit conversion.
2066 *
2067 * https://github.com/KhronosGroup/glslang/issues/170
2068 * https://bugs.freedesktop.org/show_bug.cgi?id=104424
2069 */
2070 vtn_warn("OpStore of value of type OpTypeInt to a pointer to type "
2071 "OpTypeBool. Doing an implicit conversion to work around "
2072 "the problem.");
2073 struct vtn_ssa_value *bool_ssa =
2074 vtn_create_ssa_value(b, dest->type->type);
2075 bool_ssa->def = nir_i2b(&b->nb, vtn_ssa_value(b, w[2])->def);
2076 vtn_variable_store(b, bool_ssa, dest);
2077 break;
2078 }
2079
2080 vtn_assert_types_equal(b, opcode, dest_val->type->deref, src_val->type);
2081
2082 if (glsl_type_is_sampler(dest->type->type)) {
2083 vtn_warn("OpStore of a sampler detected. Doing on-the-fly copy "
2084 "propagation to workaround the problem.");
2085 vtn_assert(dest->var->copy_prop_sampler == NULL);
2086 dest->var->copy_prop_sampler =
2087 vtn_value(b, w[2], vtn_value_type_pointer)->pointer;
2088 break;
2089 }
2090
2091 struct vtn_ssa_value *src = vtn_ssa_value(b, w[2]);
2092 vtn_variable_store(b, src, dest);
2093 break;
2094 }
2095
2096 case SpvOpArrayLength: {
2097 struct vtn_pointer *ptr =
2098 vtn_value(b, w[3], vtn_value_type_pointer)->pointer;
2099
2100 const uint32_t offset = ptr->var->type->offsets[w[4]];
2101 const uint32_t stride = ptr->var->type->members[w[4]]->stride;
2102
2103 if (!ptr->block_index) {
2104 struct vtn_access_chain chain = {
2105 .length = 0,
2106 };
2107 ptr = vtn_ssa_offset_pointer_dereference(b, ptr, &chain);
2108 vtn_assert(ptr->block_index);
2109 }
2110
2111 nir_intrinsic_instr *instr =
2112 nir_intrinsic_instr_create(b->nb.shader,
2113 nir_intrinsic_get_buffer_size);
2114 instr->src[0] = nir_src_for_ssa(ptr->block_index);
2115 nir_ssa_dest_init(&instr->instr, &instr->dest, 1, 32, NULL);
2116 nir_builder_instr_insert(&b->nb, &instr->instr);
2117 nir_ssa_def *buf_size = &instr->dest.ssa;
2118
2119 /* array_length = max(buffer_size - offset, 0) / stride */
2120 nir_ssa_def *array_length =
2121 nir_idiv(&b->nb,
2122 nir_imax(&b->nb,
2123 nir_isub(&b->nb,
2124 buf_size,
2125 nir_imm_int(&b->nb, offset)),
2126 nir_imm_int(&b->nb, 0u)),
2127 nir_imm_int(&b->nb, stride));
2128
2129 struct vtn_value *val = vtn_push_value(b, w[2], vtn_value_type_ssa);
2130 val->ssa = vtn_create_ssa_value(b, glsl_uint_type());
2131 val->ssa->def = array_length;
2132 break;
2133 }
2134
2135 case SpvOpCopyMemorySized:
2136 default:
2137 vtn_fail("Unhandled opcode");
2138 }
2139 }