spirv: handle gl_SampleMask
[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_extend(struct vtn_builder *b, struct vtn_access_chain *old,
33 unsigned new_ids)
34 {
35 struct vtn_access_chain *chain;
36
37 unsigned new_len = old->length + new_ids;
38 /* TODO: don't use rzalloc */
39 chain = rzalloc_size(b, sizeof(*chain) + new_len * sizeof(chain->link[0]));
40
41 chain->var = old->var;
42 chain->length = new_len;
43
44 for (unsigned i = 0; i < old->length; i++)
45 chain->link[i] = old->link[i];
46
47 return chain;
48 }
49
50 static nir_ssa_def *
51 vtn_access_link_as_ssa(struct vtn_builder *b, struct vtn_access_link link,
52 unsigned stride)
53 {
54 assert(stride > 0);
55 if (link.mode == vtn_access_mode_literal) {
56 return nir_imm_int(&b->nb, link.id * stride);
57 } else if (stride == 1) {
58 return vtn_ssa_value(b, link.id)->def;
59 } else {
60 return nir_imul(&b->nb, vtn_ssa_value(b, link.id)->def,
61 nir_imm_int(&b->nb, stride));
62 }
63 }
64
65 static struct vtn_type *
66 vtn_access_chain_tail_type(struct vtn_builder *b,
67 struct vtn_access_chain *chain)
68 {
69 struct vtn_type *type = chain->var->type;
70 for (unsigned i = 0; i < chain->length; i++) {
71 if (glsl_type_is_struct(type->type)) {
72 assert(chain->link[i].mode == vtn_access_mode_literal);
73 type = type->members[chain->link[i].id];
74 } else {
75 type = type->array_element;
76 }
77 }
78 return type;
79 }
80
81 /* Crawls a chain of array derefs and rewrites the types so that the
82 * lengths stay the same but the terminal type is the one given by
83 * tail_type. This is useful for split structures.
84 */
85 static void
86 rewrite_deref_types(nir_deref *deref, const struct glsl_type *type)
87 {
88 deref->type = type;
89 if (deref->child) {
90 assert(deref->child->deref_type == nir_deref_type_array);
91 assert(glsl_type_is_array(deref->type));
92 rewrite_deref_types(deref->child, glsl_get_array_element(type));
93 }
94 }
95
96 nir_deref_var *
97 vtn_access_chain_to_deref(struct vtn_builder *b, struct vtn_access_chain *chain)
98 {
99 nir_deref_var *deref_var;
100 if (chain->var->var) {
101 deref_var = nir_deref_var_create(b, chain->var->var);
102 } else {
103 assert(chain->var->members);
104 /* Create the deref_var manually. It will get filled out later. */
105 deref_var = rzalloc(b, nir_deref_var);
106 deref_var->deref.deref_type = nir_deref_type_var;
107 }
108
109 struct vtn_type *deref_type = chain->var->type;
110 nir_deref *tail = &deref_var->deref;
111 nir_variable **members = chain->var->members;
112
113 for (unsigned i = 0; i < chain->length; i++) {
114 enum glsl_base_type base_type = glsl_get_base_type(deref_type->type);
115 switch (base_type) {
116 case GLSL_TYPE_UINT:
117 case GLSL_TYPE_INT:
118 case GLSL_TYPE_FLOAT:
119 case GLSL_TYPE_DOUBLE:
120 case GLSL_TYPE_BOOL:
121 case GLSL_TYPE_ARRAY: {
122 deref_type = deref_type->array_element;
123
124 nir_deref_array *deref_arr = nir_deref_array_create(b);
125 deref_arr->deref.type = deref_type->type;
126
127 if (chain->link[i].mode == vtn_access_mode_literal) {
128 deref_arr->deref_array_type = nir_deref_array_type_direct;
129 deref_arr->base_offset = chain->link[i].id;
130 } else {
131 assert(chain->link[i].mode == vtn_access_mode_id);
132 deref_arr->deref_array_type = nir_deref_array_type_indirect;
133 deref_arr->base_offset = 0;
134 deref_arr->indirect =
135 nir_src_for_ssa(vtn_ssa_value(b, chain->link[i].id)->def);
136 }
137 tail->child = &deref_arr->deref;
138 tail = tail->child;
139 break;
140 }
141
142 case GLSL_TYPE_STRUCT: {
143 assert(chain->link[i].mode == vtn_access_mode_literal);
144 unsigned idx = chain->link[i].id;
145 deref_type = deref_type->members[idx];
146 if (members) {
147 /* This is a pre-split structure. */
148 deref_var->var = members[idx];
149 rewrite_deref_types(&deref_var->deref, members[idx]->type);
150 assert(tail->type == deref_type->type);
151 members = NULL;
152 } else {
153 nir_deref_struct *deref_struct = nir_deref_struct_create(b, idx);
154 deref_struct->deref.type = deref_type->type;
155 tail->child = &deref_struct->deref;
156 tail = tail->child;
157 }
158 break;
159 }
160 default:
161 unreachable("Invalid type for deref");
162 }
163 }
164
165 assert(members == NULL);
166 return deref_var;
167 }
168
169 static void
170 _vtn_local_load_store(struct vtn_builder *b, bool load, nir_deref_var *deref,
171 nir_deref *tail, struct vtn_ssa_value *inout)
172 {
173 /* The deref tail may contain a deref to select a component of a vector (in
174 * other words, it might not be an actual tail) so we have to save it away
175 * here since we overwrite it later.
176 */
177 nir_deref *old_child = tail->child;
178
179 if (glsl_type_is_vector_or_scalar(tail->type)) {
180 /* Terminate the deref chain in case there is one more link to pick
181 * off a component of the vector.
182 */
183 tail->child = NULL;
184
185 nir_intrinsic_op op = load ? nir_intrinsic_load_var :
186 nir_intrinsic_store_var;
187
188 nir_intrinsic_instr *intrin = nir_intrinsic_instr_create(b->shader, op);
189 intrin->variables[0] = nir_deref_var_clone(deref, intrin);
190 intrin->num_components = glsl_get_vector_elements(tail->type);
191
192 if (load) {
193 nir_ssa_dest_init(&intrin->instr, &intrin->dest,
194 intrin->num_components,
195 glsl_get_bit_size(tail->type),
196 NULL);
197 inout->def = &intrin->dest.ssa;
198 } else {
199 nir_intrinsic_set_write_mask(intrin, (1 << intrin->num_components) - 1);
200 intrin->src[0] = nir_src_for_ssa(inout->def);
201 }
202
203 nir_builder_instr_insert(&b->nb, &intrin->instr);
204 } else if (glsl_get_base_type(tail->type) == GLSL_TYPE_ARRAY ||
205 glsl_type_is_matrix(tail->type)) {
206 unsigned elems = glsl_get_length(tail->type);
207 nir_deref_array *deref_arr = nir_deref_array_create(b);
208 deref_arr->deref_array_type = nir_deref_array_type_direct;
209 deref_arr->deref.type = glsl_get_array_element(tail->type);
210 tail->child = &deref_arr->deref;
211 for (unsigned i = 0; i < elems; i++) {
212 deref_arr->base_offset = i;
213 _vtn_local_load_store(b, load, deref, tail->child, inout->elems[i]);
214 }
215 } else {
216 assert(glsl_get_base_type(tail->type) == GLSL_TYPE_STRUCT);
217 unsigned elems = glsl_get_length(tail->type);
218 nir_deref_struct *deref_struct = nir_deref_struct_create(b, 0);
219 tail->child = &deref_struct->deref;
220 for (unsigned i = 0; i < elems; i++) {
221 deref_struct->index = i;
222 deref_struct->deref.type = glsl_get_struct_field(tail->type, i);
223 _vtn_local_load_store(b, load, deref, tail->child, inout->elems[i]);
224 }
225 }
226
227 tail->child = old_child;
228 }
229
230 nir_deref_var *
231 vtn_nir_deref(struct vtn_builder *b, uint32_t id)
232 {
233 struct vtn_access_chain *chain =
234 vtn_value(b, id, vtn_value_type_access_chain)->access_chain;
235
236 return vtn_access_chain_to_deref(b, chain);
237 }
238
239 /*
240 * Gets the NIR-level deref tail, which may have as a child an array deref
241 * selecting which component due to OpAccessChain supporting per-component
242 * indexing in SPIR-V.
243 */
244 static nir_deref *
245 get_deref_tail(nir_deref_var *deref)
246 {
247 nir_deref *cur = &deref->deref;
248 while (!glsl_type_is_vector_or_scalar(cur->type) && cur->child)
249 cur = cur->child;
250
251 return cur;
252 }
253
254 struct vtn_ssa_value *
255 vtn_local_load(struct vtn_builder *b, nir_deref_var *src)
256 {
257 nir_deref *src_tail = get_deref_tail(src);
258 struct vtn_ssa_value *val = vtn_create_ssa_value(b, src_tail->type);
259 _vtn_local_load_store(b, true, src, src_tail, val);
260
261 if (src_tail->child) {
262 nir_deref_array *vec_deref = nir_deref_as_array(src_tail->child);
263 assert(vec_deref->deref.child == NULL);
264 val->type = vec_deref->deref.type;
265 if (vec_deref->deref_array_type == nir_deref_array_type_direct)
266 val->def = vtn_vector_extract(b, val->def, vec_deref->base_offset);
267 else
268 val->def = vtn_vector_extract_dynamic(b, val->def,
269 vec_deref->indirect.ssa);
270 }
271
272 return val;
273 }
274
275 void
276 vtn_local_store(struct vtn_builder *b, struct vtn_ssa_value *src,
277 nir_deref_var *dest)
278 {
279 nir_deref *dest_tail = get_deref_tail(dest);
280
281 if (dest_tail->child) {
282 struct vtn_ssa_value *val = vtn_create_ssa_value(b, dest_tail->type);
283 _vtn_local_load_store(b, true, dest, dest_tail, val);
284 nir_deref_array *deref = nir_deref_as_array(dest_tail->child);
285 assert(deref->deref.child == NULL);
286 if (deref->deref_array_type == nir_deref_array_type_direct)
287 val->def = vtn_vector_insert(b, val->def, src->def,
288 deref->base_offset);
289 else
290 val->def = vtn_vector_insert_dynamic(b, val->def, src->def,
291 deref->indirect.ssa);
292 _vtn_local_load_store(b, false, dest, dest_tail, val);
293 } else {
294 _vtn_local_load_store(b, false, dest, dest_tail, src);
295 }
296 }
297
298 static nir_ssa_def *
299 get_vulkan_resource_index(struct vtn_builder *b, struct vtn_access_chain *chain,
300 struct vtn_type **type, unsigned *chain_idx)
301 {
302 /* Push constants have no explicit binding */
303 if (chain->var->mode == vtn_variable_mode_push_constant) {
304 *chain_idx = 0;
305 *type = chain->var->type;
306 return NULL;
307 }
308
309 nir_ssa_def *array_index;
310 if (glsl_type_is_array(chain->var->type->type)) {
311 assert(chain->length > 0);
312 array_index = vtn_access_link_as_ssa(b, chain->link[0], 1);
313 *chain_idx = 1;
314 *type = chain->var->type->array_element;
315 } else {
316 array_index = nir_imm_int(&b->nb, 0);
317 *chain_idx = 0;
318 *type = chain->var->type;
319 }
320
321 nir_intrinsic_instr *instr =
322 nir_intrinsic_instr_create(b->nb.shader,
323 nir_intrinsic_vulkan_resource_index);
324 instr->src[0] = nir_src_for_ssa(array_index);
325 nir_intrinsic_set_desc_set(instr, chain->var->descriptor_set);
326 nir_intrinsic_set_binding(instr, chain->var->binding);
327
328 nir_ssa_dest_init(&instr->instr, &instr->dest, 1, 32, NULL);
329 nir_builder_instr_insert(&b->nb, &instr->instr);
330
331 return &instr->dest.ssa;
332 }
333
334 nir_ssa_def *
335 vtn_access_chain_to_offset(struct vtn_builder *b,
336 struct vtn_access_chain *chain,
337 nir_ssa_def **index_out, struct vtn_type **type_out,
338 unsigned *end_idx_out, bool stop_at_matrix)
339 {
340 unsigned idx = 0;
341 struct vtn_type *type;
342 *index_out = get_vulkan_resource_index(b, chain, &type, &idx);
343
344 nir_ssa_def *offset = nir_imm_int(&b->nb, 0);
345 for (; idx < chain->length; idx++) {
346 enum glsl_base_type base_type = glsl_get_base_type(type->type);
347 switch (base_type) {
348 case GLSL_TYPE_UINT:
349 case GLSL_TYPE_INT:
350 case GLSL_TYPE_FLOAT:
351 case GLSL_TYPE_DOUBLE:
352 case GLSL_TYPE_BOOL:
353 /* Some users may not want matrix or vector derefs */
354 if (stop_at_matrix)
355 goto end;
356 /* Fall through */
357
358 case GLSL_TYPE_ARRAY:
359 offset = nir_iadd(&b->nb, offset,
360 vtn_access_link_as_ssa(b, chain->link[idx],
361 type->stride));
362
363 type = type->array_element;
364 break;
365
366 case GLSL_TYPE_STRUCT: {
367 assert(chain->link[idx].mode == vtn_access_mode_literal);
368 unsigned member = chain->link[idx].id;
369 offset = nir_iadd(&b->nb, offset,
370 nir_imm_int(&b->nb, type->offsets[member]));
371 type = type->members[member];
372 break;
373 }
374
375 default:
376 unreachable("Invalid type for deref");
377 }
378 }
379
380 end:
381 *type_out = type;
382 if (end_idx_out)
383 *end_idx_out = idx;
384
385 return offset;
386 }
387
388 /* Tries to compute the size of an interface block based on the strides and
389 * offsets that are provided to us in the SPIR-V source.
390 */
391 static unsigned
392 vtn_type_block_size(struct vtn_type *type)
393 {
394 enum glsl_base_type base_type = glsl_get_base_type(type->type);
395 switch (base_type) {
396 case GLSL_TYPE_UINT:
397 case GLSL_TYPE_INT:
398 case GLSL_TYPE_FLOAT:
399 case GLSL_TYPE_BOOL:
400 case GLSL_TYPE_DOUBLE: {
401 unsigned cols = type->row_major ? glsl_get_vector_elements(type->type) :
402 glsl_get_matrix_columns(type->type);
403 if (cols > 1) {
404 assert(type->stride > 0);
405 return type->stride * cols;
406 } else if (base_type == GLSL_TYPE_DOUBLE) {
407 return glsl_get_vector_elements(type->type) * 8;
408 } else {
409 return glsl_get_vector_elements(type->type) * 4;
410 }
411 }
412
413 case GLSL_TYPE_STRUCT:
414 case GLSL_TYPE_INTERFACE: {
415 unsigned size = 0;
416 unsigned num_fields = glsl_get_length(type->type);
417 for (unsigned f = 0; f < num_fields; f++) {
418 unsigned field_end = type->offsets[f] +
419 vtn_type_block_size(type->members[f]);
420 size = MAX2(size, field_end);
421 }
422 return size;
423 }
424
425 case GLSL_TYPE_ARRAY:
426 assert(type->stride > 0);
427 assert(glsl_get_length(type->type) > 0);
428 return type->stride * glsl_get_length(type->type);
429
430 default:
431 assert(!"Invalid block type");
432 return 0;
433 }
434 }
435
436 static void
437 vtn_access_chain_get_offset_size(struct vtn_access_chain *chain,
438 unsigned *access_offset,
439 unsigned *access_size)
440 {
441 /* Only valid for push constants accesses now. */
442 assert(chain->var->mode == vtn_variable_mode_push_constant);
443
444 struct vtn_type *type = chain->var->type;
445
446 *access_offset = 0;
447
448 for (unsigned i = 0; i < chain->length; i++) {
449 if (chain->link[i].mode != vtn_access_mode_literal)
450 break;
451
452 if (glsl_type_is_struct(type->type)) {
453 *access_offset += type->offsets[chain->link[i].id];
454 type = type->members[chain->link[i].id];
455 } else {
456 *access_offset += type->stride * chain->link[i].id;
457 type = type->array_element;
458 }
459 }
460
461 *access_size = vtn_type_block_size(type);
462 }
463
464 static void
465 _vtn_load_store_tail(struct vtn_builder *b, nir_intrinsic_op op, bool load,
466 nir_ssa_def *index, nir_ssa_def *offset,
467 unsigned access_offset, unsigned access_size,
468 struct vtn_ssa_value **inout, const struct glsl_type *type)
469 {
470 nir_intrinsic_instr *instr = nir_intrinsic_instr_create(b->nb.shader, op);
471 instr->num_components = glsl_get_vector_elements(type);
472
473 int src = 0;
474 if (!load) {
475 nir_intrinsic_set_write_mask(instr, (1 << instr->num_components) - 1);
476 instr->src[src++] = nir_src_for_ssa((*inout)->def);
477 }
478
479 if (op == nir_intrinsic_load_push_constant) {
480 assert(access_offset % 4 == 0);
481
482 nir_intrinsic_set_base(instr, access_offset);
483 nir_intrinsic_set_range(instr, access_size);
484 }
485
486 if (index)
487 instr->src[src++] = nir_src_for_ssa(index);
488
489 if (op == nir_intrinsic_load_push_constant) {
490 /* We need to subtract the offset from where the intrinsic will load the
491 * data. */
492 instr->src[src++] =
493 nir_src_for_ssa(nir_isub(&b->nb, offset,
494 nir_imm_int(&b->nb, access_offset)));
495 } else {
496 instr->src[src++] = nir_src_for_ssa(offset);
497 }
498
499 if (load) {
500 nir_ssa_dest_init(&instr->instr, &instr->dest,
501 instr->num_components,
502 glsl_get_bit_size(type), NULL);
503 (*inout)->def = &instr->dest.ssa;
504 }
505
506 nir_builder_instr_insert(&b->nb, &instr->instr);
507
508 if (load && glsl_get_base_type(type) == GLSL_TYPE_BOOL)
509 (*inout)->def = nir_ine(&b->nb, (*inout)->def, nir_imm_int(&b->nb, 0));
510 }
511
512 static void
513 _vtn_block_load_store(struct vtn_builder *b, nir_intrinsic_op op, bool load,
514 nir_ssa_def *index, nir_ssa_def *offset,
515 unsigned access_offset, unsigned access_size,
516 struct vtn_access_chain *chain, unsigned chain_idx,
517 struct vtn_type *type, struct vtn_ssa_value **inout)
518 {
519 if (chain && chain_idx >= chain->length)
520 chain = NULL;
521
522 if (load && chain == NULL && *inout == NULL)
523 *inout = vtn_create_ssa_value(b, type->type);
524
525 enum glsl_base_type base_type = glsl_get_base_type(type->type);
526 switch (base_type) {
527 case GLSL_TYPE_UINT:
528 case GLSL_TYPE_INT:
529 case GLSL_TYPE_FLOAT:
530 case GLSL_TYPE_DOUBLE:
531 case GLSL_TYPE_BOOL:
532 /* This is where things get interesting. At this point, we've hit
533 * a vector, a scalar, or a matrix.
534 */
535 if (glsl_type_is_matrix(type->type)) {
536 if (chain == NULL) {
537 /* Loading the whole matrix */
538 struct vtn_ssa_value *transpose;
539 unsigned num_ops, vec_width;
540 if (type->row_major) {
541 num_ops = glsl_get_vector_elements(type->type);
542 vec_width = glsl_get_matrix_columns(type->type);
543 if (load) {
544 const struct glsl_type *transpose_type =
545 glsl_matrix_type(base_type, vec_width, num_ops);
546 *inout = vtn_create_ssa_value(b, transpose_type);
547 } else {
548 transpose = vtn_ssa_transpose(b, *inout);
549 inout = &transpose;
550 }
551 } else {
552 num_ops = glsl_get_matrix_columns(type->type);
553 vec_width = glsl_get_vector_elements(type->type);
554 }
555
556 for (unsigned i = 0; i < num_ops; i++) {
557 nir_ssa_def *elem_offset =
558 nir_iadd(&b->nb, offset,
559 nir_imm_int(&b->nb, i * type->stride));
560 _vtn_load_store_tail(b, op, load, index, elem_offset,
561 access_offset, access_size,
562 &(*inout)->elems[i],
563 glsl_vector_type(base_type, vec_width));
564 }
565
566 if (load && type->row_major)
567 *inout = vtn_ssa_transpose(b, *inout);
568 } else if (type->row_major) {
569 /* Row-major but with an access chiain. */
570 nir_ssa_def *col_offset =
571 vtn_access_link_as_ssa(b, chain->link[chain_idx],
572 type->array_element->stride);
573 offset = nir_iadd(&b->nb, offset, col_offset);
574
575 if (chain_idx + 1 < chain->length) {
576 /* Picking off a single element */
577 nir_ssa_def *row_offset =
578 vtn_access_link_as_ssa(b, chain->link[chain_idx + 1],
579 type->stride);
580 offset = nir_iadd(&b->nb, offset, row_offset);
581 if (load)
582 *inout = vtn_create_ssa_value(b, glsl_scalar_type(base_type));
583 _vtn_load_store_tail(b, op, load, index, offset,
584 access_offset, access_size,
585 inout, glsl_scalar_type(base_type));
586 } else {
587 /* Grabbing a column; picking one element off each row */
588 unsigned num_comps = glsl_get_vector_elements(type->type);
589 const struct glsl_type *column_type =
590 glsl_get_column_type(type->type);
591
592 nir_ssa_def *comps[4];
593 for (unsigned i = 0; i < num_comps; i++) {
594 nir_ssa_def *elem_offset =
595 nir_iadd(&b->nb, offset,
596 nir_imm_int(&b->nb, i * type->stride));
597
598 struct vtn_ssa_value *comp, temp_val;
599 if (!load) {
600 temp_val.def = nir_channel(&b->nb, (*inout)->def, i);
601 temp_val.type = glsl_scalar_type(base_type);
602 }
603 comp = &temp_val;
604 _vtn_load_store_tail(b, op, load, index, elem_offset,
605 access_offset, access_size,
606 &comp, glsl_scalar_type(base_type));
607 comps[i] = comp->def;
608 }
609
610 if (load) {
611 if (*inout == NULL)
612 *inout = vtn_create_ssa_value(b, column_type);
613
614 (*inout)->def = nir_vec(&b->nb, comps, num_comps);
615 }
616 }
617 } else {
618 /* Column-major with a deref. Fall through to array case. */
619 nir_ssa_def *col_offset =
620 vtn_access_link_as_ssa(b, chain->link[chain_idx], type->stride);
621 offset = nir_iadd(&b->nb, offset, col_offset);
622
623 _vtn_block_load_store(b, op, load, index, offset,
624 access_offset, access_size,
625 chain, chain_idx + 1,
626 type->array_element, inout);
627 }
628 } else if (chain == NULL) {
629 /* Single whole vector */
630 assert(glsl_type_is_vector_or_scalar(type->type));
631 _vtn_load_store_tail(b, op, load, index, offset,
632 access_offset, access_size,
633 inout, type->type);
634 } else {
635 /* Single component of a vector. Fall through to array case. */
636 nir_ssa_def *elem_offset =
637 vtn_access_link_as_ssa(b, chain->link[chain_idx], type->stride);
638 offset = nir_iadd(&b->nb, offset, elem_offset);
639
640 _vtn_block_load_store(b, op, load, index, offset,
641 access_offset, access_size,
642 NULL, 0,
643 type->array_element, inout);
644 }
645 return;
646
647 case GLSL_TYPE_ARRAY: {
648 unsigned elems = glsl_get_length(type->type);
649 for (unsigned i = 0; i < elems; i++) {
650 nir_ssa_def *elem_off =
651 nir_iadd(&b->nb, offset, nir_imm_int(&b->nb, i * type->stride));
652 _vtn_block_load_store(b, op, load, index, elem_off,
653 access_offset, access_size,
654 NULL, 0,
655 type->array_element, &(*inout)->elems[i]);
656 }
657 return;
658 }
659
660 case GLSL_TYPE_STRUCT: {
661 unsigned elems = glsl_get_length(type->type);
662 for (unsigned i = 0; i < elems; i++) {
663 nir_ssa_def *elem_off =
664 nir_iadd(&b->nb, offset, nir_imm_int(&b->nb, type->offsets[i]));
665 _vtn_block_load_store(b, op, load, index, elem_off,
666 access_offset, access_size,
667 NULL, 0,
668 type->members[i], &(*inout)->elems[i]);
669 }
670 return;
671 }
672
673 default:
674 unreachable("Invalid block member type");
675 }
676 }
677
678 static struct vtn_ssa_value *
679 vtn_block_load(struct vtn_builder *b, struct vtn_access_chain *src)
680 {
681 nir_intrinsic_op op;
682 unsigned access_offset = 0, access_size = 0;
683 switch (src->var->mode) {
684 case vtn_variable_mode_ubo:
685 op = nir_intrinsic_load_ubo;
686 break;
687 case vtn_variable_mode_ssbo:
688 op = nir_intrinsic_load_ssbo;
689 break;
690 case vtn_variable_mode_push_constant:
691 op = nir_intrinsic_load_push_constant;
692 vtn_access_chain_get_offset_size(src, &access_offset, &access_size);
693 break;
694 default:
695 assert(!"Invalid block variable mode");
696 }
697
698 nir_ssa_def *offset, *index = NULL;
699 struct vtn_type *type;
700 unsigned chain_idx;
701 offset = vtn_access_chain_to_offset(b, src, &index, &type, &chain_idx, true);
702
703 struct vtn_ssa_value *value = NULL;
704 _vtn_block_load_store(b, op, true, index, offset,
705 access_offset, access_size,
706 src, chain_idx, type, &value);
707 return value;
708 }
709
710 static void
711 vtn_block_store(struct vtn_builder *b, struct vtn_ssa_value *src,
712 struct vtn_access_chain *dst)
713 {
714 nir_ssa_def *offset, *index = NULL;
715 struct vtn_type *type;
716 unsigned chain_idx;
717 offset = vtn_access_chain_to_offset(b, dst, &index, &type, &chain_idx, true);
718
719 _vtn_block_load_store(b, nir_intrinsic_store_ssbo, false, index, offset,
720 0, 0, dst, chain_idx, type, &src);
721 }
722
723 static bool
724 vtn_variable_is_external_block(struct vtn_variable *var)
725 {
726 return var->mode == vtn_variable_mode_ssbo ||
727 var->mode == vtn_variable_mode_ubo ||
728 var->mode == vtn_variable_mode_push_constant;
729 }
730
731 static void
732 _vtn_variable_load_store(struct vtn_builder *b, bool load,
733 struct vtn_access_chain *chain,
734 struct vtn_type *tail_type,
735 struct vtn_ssa_value **inout)
736 {
737 enum glsl_base_type base_type = glsl_get_base_type(tail_type->type);
738 switch (base_type) {
739 case GLSL_TYPE_UINT:
740 case GLSL_TYPE_INT:
741 case GLSL_TYPE_FLOAT:
742 case GLSL_TYPE_BOOL:
743 case GLSL_TYPE_DOUBLE:
744 /* At this point, we have a scalar, vector, or matrix so we know that
745 * there cannot be any structure splitting still in the way. By
746 * stopping at the matrix level rather than the vector level, we
747 * ensure that matrices get loaded in the optimal way even if they
748 * are storred row-major in a UBO.
749 */
750 if (load) {
751 *inout = vtn_local_load(b, vtn_access_chain_to_deref(b, chain));
752 } else {
753 vtn_local_store(b, *inout, vtn_access_chain_to_deref(b, chain));
754 }
755 return;
756
757 case GLSL_TYPE_ARRAY:
758 case GLSL_TYPE_STRUCT: {
759 struct vtn_access_chain *new_chain =
760 vtn_access_chain_extend(b, chain, 1);
761 new_chain->link[chain->length].mode = vtn_access_mode_literal;
762 unsigned elems = glsl_get_length(tail_type->type);
763 if (load) {
764 assert(*inout == NULL);
765 *inout = rzalloc(b, struct vtn_ssa_value);
766 (*inout)->type = tail_type->type;
767 (*inout)->elems = rzalloc_array(b, struct vtn_ssa_value *, elems);
768 }
769 for (unsigned i = 0; i < elems; i++) {
770 new_chain->link[chain->length].id = i;
771 struct vtn_type *elem_type = base_type == GLSL_TYPE_ARRAY ?
772 tail_type->array_element : tail_type->members[i];
773 _vtn_variable_load_store(b, load, new_chain, elem_type,
774 &(*inout)->elems[i]);
775 }
776 return;
777 }
778
779 default:
780 unreachable("Invalid access chain type");
781 }
782 }
783
784 struct vtn_ssa_value *
785 vtn_variable_load(struct vtn_builder *b, struct vtn_access_chain *src)
786 {
787 if (vtn_variable_is_external_block(src->var)) {
788 return vtn_block_load(b, src);
789 } else {
790 struct vtn_type *tail_type = vtn_access_chain_tail_type(b, src);
791 struct vtn_ssa_value *val = NULL;
792 _vtn_variable_load_store(b, true, src, tail_type, &val);
793 return val;
794 }
795 }
796
797 void
798 vtn_variable_store(struct vtn_builder *b, struct vtn_ssa_value *src,
799 struct vtn_access_chain *dest)
800 {
801 if (vtn_variable_is_external_block(dest->var)) {
802 assert(dest->var->mode == vtn_variable_mode_ssbo);
803 vtn_block_store(b, src, dest);
804 } else {
805 struct vtn_type *tail_type = vtn_access_chain_tail_type(b, dest);
806 _vtn_variable_load_store(b, false, dest, tail_type, &src);
807 }
808 }
809
810 static void
811 _vtn_variable_copy(struct vtn_builder *b, struct vtn_access_chain *dest,
812 struct vtn_access_chain *src, struct vtn_type *tail_type)
813 {
814 enum glsl_base_type base_type = glsl_get_base_type(tail_type->type);
815 switch (base_type) {
816 case GLSL_TYPE_UINT:
817 case GLSL_TYPE_INT:
818 case GLSL_TYPE_FLOAT:
819 case GLSL_TYPE_DOUBLE:
820 case GLSL_TYPE_BOOL:
821 /* At this point, we have a scalar, vector, or matrix so we know that
822 * there cannot be any structure splitting still in the way. By
823 * stopping at the matrix level rather than the vector level, we
824 * ensure that matrices get loaded in the optimal way even if they
825 * are storred row-major in a UBO.
826 */
827 vtn_variable_store(b, vtn_variable_load(b, src), dest);
828 return;
829
830 case GLSL_TYPE_ARRAY:
831 case GLSL_TYPE_STRUCT: {
832 struct vtn_access_chain *new_src, *new_dest;
833 new_src = vtn_access_chain_extend(b, src, 1);
834 new_dest = vtn_access_chain_extend(b, dest, 1);
835 new_src->link[src->length].mode = vtn_access_mode_literal;
836 new_dest->link[dest->length].mode = vtn_access_mode_literal;
837 unsigned elems = glsl_get_length(tail_type->type);
838 for (unsigned i = 0; i < elems; i++) {
839 new_src->link[src->length].id = i;
840 new_dest->link[dest->length].id = i;
841 struct vtn_type *elem_type = base_type == GLSL_TYPE_ARRAY ?
842 tail_type->array_element : tail_type->members[i];
843 _vtn_variable_copy(b, new_dest, new_src, elem_type);
844 }
845 return;
846 }
847
848 default:
849 unreachable("Invalid access chain type");
850 }
851 }
852
853 static void
854 vtn_variable_copy(struct vtn_builder *b, struct vtn_access_chain *dest,
855 struct vtn_access_chain *src)
856 {
857 struct vtn_type *tail_type = vtn_access_chain_tail_type(b, src);
858 assert(vtn_access_chain_tail_type(b, dest)->type == tail_type->type);
859
860 /* TODO: At some point, we should add a special-case for when we can
861 * just emit a copy_var intrinsic.
862 */
863 _vtn_variable_copy(b, dest, src, tail_type);
864 }
865
866 static void
867 set_mode_system_value(nir_variable_mode *mode)
868 {
869 assert(*mode == nir_var_system_value || *mode == nir_var_shader_in);
870 *mode = nir_var_system_value;
871 }
872
873 static void
874 vtn_get_builtin_location(struct vtn_builder *b,
875 SpvBuiltIn builtin, int *location,
876 nir_variable_mode *mode)
877 {
878 switch (builtin) {
879 case SpvBuiltInPosition:
880 *location = VARYING_SLOT_POS;
881 break;
882 case SpvBuiltInPointSize:
883 *location = VARYING_SLOT_PSIZ;
884 break;
885 case SpvBuiltInClipDistance:
886 *location = VARYING_SLOT_CLIP_DIST0; /* XXX CLIP_DIST1? */
887 break;
888 case SpvBuiltInCullDistance:
889 *location = VARYING_SLOT_CULL_DIST0;
890 break;
891 case SpvBuiltInVertexIndex:
892 *location = SYSTEM_VALUE_VERTEX_ID;
893 set_mode_system_value(mode);
894 break;
895 case SpvBuiltInVertexId:
896 /* Vulkan defines VertexID to be zero-based and reserves the new
897 * builtin keyword VertexIndex to indicate the non-zero-based value.
898 */
899 *location = SYSTEM_VALUE_VERTEX_ID_ZERO_BASE;
900 set_mode_system_value(mode);
901 break;
902 case SpvBuiltInInstanceIndex:
903 *location = SYSTEM_VALUE_INSTANCE_INDEX;
904 set_mode_system_value(mode);
905 break;
906 case SpvBuiltInInstanceId:
907 *location = SYSTEM_VALUE_INSTANCE_ID;
908 set_mode_system_value(mode);
909 break;
910 case SpvBuiltInPrimitiveId:
911 if (b->shader->stage == MESA_SHADER_FRAGMENT) {
912 assert(*mode == nir_var_shader_in);
913 *location = VARYING_SLOT_PRIMITIVE_ID;
914 } else if (*mode == nir_var_shader_out) {
915 *location = VARYING_SLOT_PRIMITIVE_ID;
916 } else {
917 *location = SYSTEM_VALUE_PRIMITIVE_ID;
918 set_mode_system_value(mode);
919 }
920 break;
921 case SpvBuiltInInvocationId:
922 *location = SYSTEM_VALUE_INVOCATION_ID;
923 set_mode_system_value(mode);
924 break;
925 case SpvBuiltInLayer:
926 *location = VARYING_SLOT_LAYER;
927 if (b->shader->stage == MESA_SHADER_FRAGMENT)
928 *mode = nir_var_shader_in;
929 else if (b->shader->stage == MESA_SHADER_GEOMETRY)
930 *mode = nir_var_shader_out;
931 else
932 unreachable("invalid stage for SpvBuiltInLayer");
933 break;
934 case SpvBuiltInViewportIndex:
935 *location = VARYING_SLOT_VIEWPORT;
936 if (b->shader->stage == MESA_SHADER_GEOMETRY)
937 *mode = nir_var_shader_out;
938 else if (b->shader->stage == MESA_SHADER_FRAGMENT)
939 *mode = nir_var_shader_in;
940 else
941 unreachable("invalid stage for SpvBuiltInViewportIndex");
942 break;
943 case SpvBuiltInTessLevelOuter:
944 *location = VARYING_SLOT_TESS_LEVEL_OUTER;
945 break;
946 case SpvBuiltInTessLevelInner:
947 *location = VARYING_SLOT_TESS_LEVEL_INNER;
948 break;
949 case SpvBuiltInTessCoord:
950 *location = SYSTEM_VALUE_TESS_COORD;
951 set_mode_system_value(mode);
952 break;
953 case SpvBuiltInPatchVertices:
954 *location = SYSTEM_VALUE_VERTICES_IN;
955 set_mode_system_value(mode);
956 break;
957 case SpvBuiltInFragCoord:
958 *location = VARYING_SLOT_POS;
959 assert(*mode == nir_var_shader_in);
960 break;
961 case SpvBuiltInPointCoord:
962 *location = VARYING_SLOT_PNTC;
963 assert(*mode == nir_var_shader_in);
964 break;
965 case SpvBuiltInFrontFacing:
966 *location = SYSTEM_VALUE_FRONT_FACE;
967 set_mode_system_value(mode);
968 break;
969 case SpvBuiltInSampleId:
970 *location = SYSTEM_VALUE_SAMPLE_ID;
971 set_mode_system_value(mode);
972 break;
973 case SpvBuiltInSamplePosition:
974 *location = SYSTEM_VALUE_SAMPLE_POS;
975 set_mode_system_value(mode);
976 break;
977 case SpvBuiltInSampleMask:
978 if (*mode == nir_var_shader_out) {
979 *location = FRAG_RESULT_SAMPLE_MASK;
980 } else {
981 *location = SYSTEM_VALUE_SAMPLE_MASK_IN;
982 set_mode_system_value(mode);
983 }
984 break;
985 case SpvBuiltInFragDepth:
986 *location = FRAG_RESULT_DEPTH;
987 assert(*mode == nir_var_shader_out);
988 break;
989 case SpvBuiltInNumWorkgroups:
990 *location = SYSTEM_VALUE_NUM_WORK_GROUPS;
991 set_mode_system_value(mode);
992 break;
993 case SpvBuiltInWorkgroupSize:
994 /* This should already be handled */
995 unreachable("unsupported builtin");
996 break;
997 case SpvBuiltInWorkgroupId:
998 *location = SYSTEM_VALUE_WORK_GROUP_ID;
999 set_mode_system_value(mode);
1000 break;
1001 case SpvBuiltInLocalInvocationId:
1002 *location = SYSTEM_VALUE_LOCAL_INVOCATION_ID;
1003 set_mode_system_value(mode);
1004 break;
1005 case SpvBuiltInLocalInvocationIndex:
1006 *location = SYSTEM_VALUE_LOCAL_INVOCATION_INDEX;
1007 set_mode_system_value(mode);
1008 break;
1009 case SpvBuiltInGlobalInvocationId:
1010 *location = SYSTEM_VALUE_GLOBAL_INVOCATION_ID;
1011 set_mode_system_value(mode);
1012 break;
1013 case SpvBuiltInHelperInvocation:
1014 default:
1015 unreachable("unsupported builtin");
1016 }
1017 }
1018
1019 static void
1020 apply_var_decoration(struct vtn_builder *b, nir_variable *nir_var,
1021 const struct vtn_decoration *dec)
1022 {
1023 switch (dec->decoration) {
1024 case SpvDecorationRelaxedPrecision:
1025 break; /* FIXME: Do nothing with this for now. */
1026 case SpvDecorationNoPerspective:
1027 nir_var->data.interpolation = INTERP_MODE_NOPERSPECTIVE;
1028 break;
1029 case SpvDecorationFlat:
1030 nir_var->data.interpolation = INTERP_MODE_FLAT;
1031 break;
1032 case SpvDecorationCentroid:
1033 nir_var->data.centroid = true;
1034 break;
1035 case SpvDecorationSample:
1036 nir_var->data.sample = true;
1037 break;
1038 case SpvDecorationInvariant:
1039 nir_var->data.invariant = true;
1040 break;
1041 case SpvDecorationConstant:
1042 assert(nir_var->constant_initializer != NULL);
1043 nir_var->data.read_only = true;
1044 break;
1045 case SpvDecorationNonWritable:
1046 nir_var->data.read_only = true;
1047 break;
1048 case SpvDecorationComponent:
1049 nir_var->data.location_frac = dec->literals[0];
1050 break;
1051 case SpvDecorationIndex:
1052 nir_var->data.index = dec->literals[0];
1053 break;
1054 case SpvDecorationBuiltIn: {
1055 SpvBuiltIn builtin = dec->literals[0];
1056
1057 if (builtin == SpvBuiltInWorkgroupSize) {
1058 /* This shouldn't be a builtin. It's actually a constant. */
1059 nir_var->data.mode = nir_var_global;
1060 nir_var->data.read_only = true;
1061
1062 nir_constant *c = rzalloc(nir_var, nir_constant);
1063 c->values[0].u32[0] = b->shader->info->cs.local_size[0];
1064 c->values[0].u32[1] = b->shader->info->cs.local_size[1];
1065 c->values[0].u32[2] = b->shader->info->cs.local_size[2];
1066 nir_var->constant_initializer = c;
1067 break;
1068 }
1069
1070 nir_variable_mode mode = nir_var->data.mode;
1071 vtn_get_builtin_location(b, builtin, &nir_var->data.location, &mode);
1072 nir_var->data.mode = mode;
1073
1074 switch (builtin) {
1075 case SpvBuiltInTessLevelOuter:
1076 case SpvBuiltInTessLevelInner:
1077 nir_var->data.compact = true;
1078 break;
1079 case SpvBuiltInSamplePosition:
1080 nir_var->data.origin_upper_left = b->origin_upper_left;
1081 /* fallthrough */
1082 case SpvBuiltInFragCoord:
1083 nir_var->data.pixel_center_integer = b->pixel_center_integer;
1084 break;
1085 default:
1086 break;
1087 }
1088 }
1089
1090 case SpvDecorationSpecId:
1091 case SpvDecorationRowMajor:
1092 case SpvDecorationColMajor:
1093 case SpvDecorationMatrixStride:
1094 case SpvDecorationRestrict:
1095 case SpvDecorationAliased:
1096 case SpvDecorationVolatile:
1097 case SpvDecorationCoherent:
1098 case SpvDecorationNonReadable:
1099 case SpvDecorationUniform:
1100 case SpvDecorationStream:
1101 case SpvDecorationOffset:
1102 case SpvDecorationLinkageAttributes:
1103 break; /* Do nothing with these here */
1104
1105 case SpvDecorationPatch:
1106 nir_var->data.patch = true;
1107 break;
1108
1109 case SpvDecorationLocation:
1110 unreachable("Handled above");
1111
1112 case SpvDecorationBlock:
1113 case SpvDecorationBufferBlock:
1114 case SpvDecorationArrayStride:
1115 case SpvDecorationGLSLShared:
1116 case SpvDecorationGLSLPacked:
1117 break; /* These can apply to a type but we don't care about them */
1118
1119 case SpvDecorationBinding:
1120 case SpvDecorationDescriptorSet:
1121 case SpvDecorationNoContraction:
1122 case SpvDecorationInputAttachmentIndex:
1123 vtn_warn("Decoration not allowed for variable or structure member: %s",
1124 spirv_decoration_to_string(dec->decoration));
1125 break;
1126
1127 case SpvDecorationXfbBuffer:
1128 case SpvDecorationXfbStride:
1129 vtn_warn("Vulkan does not have transform feedback: %s",
1130 spirv_decoration_to_string(dec->decoration));
1131 break;
1132
1133 case SpvDecorationCPacked:
1134 case SpvDecorationSaturatedConversion:
1135 case SpvDecorationFuncParamAttr:
1136 case SpvDecorationFPRoundingMode:
1137 case SpvDecorationFPFastMathMode:
1138 case SpvDecorationAlignment:
1139 vtn_warn("Decoration only allowed for CL-style kernels: %s",
1140 spirv_decoration_to_string(dec->decoration));
1141 break;
1142 }
1143 }
1144
1145 static void
1146 var_is_patch_cb(struct vtn_builder *b, struct vtn_value *val, int member,
1147 const struct vtn_decoration *dec, void *out_is_patch)
1148 {
1149 if (dec->decoration == SpvDecorationPatch) {
1150 *((bool *) out_is_patch) = true;
1151 }
1152 }
1153
1154 static void
1155 var_decoration_cb(struct vtn_builder *b, struct vtn_value *val, int member,
1156 const struct vtn_decoration *dec, void *void_var)
1157 {
1158 struct vtn_variable *vtn_var = void_var;
1159
1160 /* Handle decorations that apply to a vtn_variable as a whole */
1161 switch (dec->decoration) {
1162 case SpvDecorationBinding:
1163 vtn_var->binding = dec->literals[0];
1164 return;
1165 case SpvDecorationDescriptorSet:
1166 vtn_var->descriptor_set = dec->literals[0];
1167 return;
1168 case SpvDecorationInputAttachmentIndex:
1169 vtn_var->input_attachment_index = dec->literals[0];
1170 return;
1171 case SpvDecorationPatch:
1172 vtn_var->patch = true;
1173 break;
1174 default:
1175 break;
1176 }
1177
1178 if (val->value_type == vtn_value_type_access_chain) {
1179 assert(val->access_chain->length == 0);
1180 assert(val->access_chain->var == void_var);
1181 assert(member == -1);
1182 } else {
1183 assert(val->value_type == vtn_value_type_type);
1184 }
1185
1186 /* Location is odd. If applied to a split structure, we have to walk the
1187 * whole thing and accumulate the location. It's easier to handle as a
1188 * special case.
1189 */
1190 if (dec->decoration == SpvDecorationLocation) {
1191 unsigned location = dec->literals[0];
1192 bool is_vertex_input;
1193 if (b->shader->stage == MESA_SHADER_FRAGMENT &&
1194 vtn_var->mode == vtn_variable_mode_output) {
1195 is_vertex_input = false;
1196 location += FRAG_RESULT_DATA0;
1197 } else if (b->shader->stage == MESA_SHADER_VERTEX &&
1198 vtn_var->mode == vtn_variable_mode_input) {
1199 is_vertex_input = true;
1200 location += VERT_ATTRIB_GENERIC0;
1201 } else if (vtn_var->mode == vtn_variable_mode_input ||
1202 vtn_var->mode == vtn_variable_mode_output) {
1203 is_vertex_input = false;
1204 location += vtn_var->patch ? VARYING_SLOT_PATCH0 : VARYING_SLOT_VAR0;
1205 } else {
1206 vtn_warn("Location must be on input or output variable");
1207 return;
1208 }
1209
1210 if (vtn_var->var) {
1211 /* This handles the member and lone variable cases */
1212 vtn_var->var->data.location = location;
1213 } else {
1214 /* This handles the structure member case */
1215 assert(vtn_var->members);
1216 unsigned length =
1217 glsl_get_length(glsl_without_array(vtn_var->type->type));
1218 for (unsigned i = 0; i < length; i++) {
1219 vtn_var->members[i]->data.location = location;
1220 location +=
1221 glsl_count_attribute_slots(vtn_var->members[i]->interface_type,
1222 is_vertex_input);
1223 }
1224 }
1225 return;
1226 } else {
1227 if (vtn_var->var) {
1228 assert(member <= 0);
1229 apply_var_decoration(b, vtn_var->var, dec);
1230 } else if (vtn_var->members) {
1231 if (member >= 0) {
1232 assert(vtn_var->members);
1233 apply_var_decoration(b, vtn_var->members[member], dec);
1234 } else {
1235 unsigned length =
1236 glsl_get_length(glsl_without_array(vtn_var->type->type));
1237 for (unsigned i = 0; i < length; i++)
1238 apply_var_decoration(b, vtn_var->members[i], dec);
1239 }
1240 } else {
1241 /* A few variables, those with external storage, have no actual
1242 * nir_variables associated with them. Fortunately, all decorations
1243 * we care about for those variables are on the type only.
1244 */
1245 assert(vtn_var->mode == vtn_variable_mode_ubo ||
1246 vtn_var->mode == vtn_variable_mode_ssbo ||
1247 vtn_var->mode == vtn_variable_mode_push_constant);
1248 }
1249 }
1250 }
1251
1252 static bool
1253 is_per_vertex_inout(const struct vtn_variable *var, gl_shader_stage stage)
1254 {
1255 if (var->patch || !glsl_type_is_array(var->type->type))
1256 return false;
1257
1258 if (var->mode == vtn_variable_mode_input) {
1259 return stage == MESA_SHADER_TESS_CTRL ||
1260 stage == MESA_SHADER_TESS_EVAL ||
1261 stage == MESA_SHADER_GEOMETRY;
1262 }
1263
1264 if (var->mode == vtn_variable_mode_output)
1265 return stage == MESA_SHADER_TESS_CTRL;
1266
1267 return false;
1268 }
1269
1270 void
1271 vtn_handle_variables(struct vtn_builder *b, SpvOp opcode,
1272 const uint32_t *w, unsigned count)
1273 {
1274 switch (opcode) {
1275 case SpvOpVariable: {
1276 struct vtn_variable *var = rzalloc(b, struct vtn_variable);
1277 var->type = vtn_value(b, w[1], vtn_value_type_type)->type;
1278
1279 var->chain.var = var;
1280 var->chain.length = 0;
1281
1282 struct vtn_value *val =
1283 vtn_push_value(b, w[2], vtn_value_type_access_chain);
1284 val->access_chain = &var->chain;
1285
1286 struct vtn_type *without_array = var->type;
1287 while(glsl_type_is_array(without_array->type))
1288 without_array = without_array->array_element;
1289
1290 nir_variable_mode nir_mode;
1291 switch ((SpvStorageClass)w[3]) {
1292 case SpvStorageClassUniform:
1293 case SpvStorageClassUniformConstant:
1294 if (without_array->block) {
1295 var->mode = vtn_variable_mode_ubo;
1296 b->shader->info->num_ubos++;
1297 } else if (without_array->buffer_block) {
1298 var->mode = vtn_variable_mode_ssbo;
1299 b->shader->info->num_ssbos++;
1300 } else if (glsl_type_is_image(without_array->type)) {
1301 var->mode = vtn_variable_mode_image;
1302 nir_mode = nir_var_uniform;
1303 b->shader->info->num_images++;
1304 } else if (glsl_type_is_sampler(without_array->type)) {
1305 var->mode = vtn_variable_mode_sampler;
1306 nir_mode = nir_var_uniform;
1307 b->shader->info->num_textures++;
1308 } else {
1309 assert(!"Invalid uniform variable type");
1310 }
1311 break;
1312 case SpvStorageClassPushConstant:
1313 var->mode = vtn_variable_mode_push_constant;
1314 assert(b->shader->num_uniforms == 0);
1315 b->shader->num_uniforms = vtn_type_block_size(var->type);
1316 break;
1317 case SpvStorageClassInput:
1318 var->mode = vtn_variable_mode_input;
1319 nir_mode = nir_var_shader_in;
1320 break;
1321 case SpvStorageClassOutput:
1322 var->mode = vtn_variable_mode_output;
1323 nir_mode = nir_var_shader_out;
1324 break;
1325 case SpvStorageClassPrivate:
1326 var->mode = vtn_variable_mode_global;
1327 nir_mode = nir_var_global;
1328 break;
1329 case SpvStorageClassFunction:
1330 var->mode = vtn_variable_mode_local;
1331 nir_mode = nir_var_local;
1332 break;
1333 case SpvStorageClassWorkgroup:
1334 var->mode = vtn_variable_mode_workgroup;
1335 nir_mode = nir_var_shared;
1336 break;
1337 case SpvStorageClassCrossWorkgroup:
1338 case SpvStorageClassGeneric:
1339 case SpvStorageClassAtomicCounter:
1340 default:
1341 unreachable("Unhandled variable storage class");
1342 }
1343
1344 switch (var->mode) {
1345 case vtn_variable_mode_local:
1346 case vtn_variable_mode_global:
1347 case vtn_variable_mode_image:
1348 case vtn_variable_mode_sampler:
1349 case vtn_variable_mode_workgroup:
1350 /* For these, we create the variable normally */
1351 var->var = rzalloc(b->shader, nir_variable);
1352 var->var->name = ralloc_strdup(var->var, val->name);
1353 var->var->type = var->type->type;
1354 var->var->data.mode = nir_mode;
1355
1356 switch (var->mode) {
1357 case vtn_variable_mode_image:
1358 case vtn_variable_mode_sampler:
1359 var->var->interface_type = without_array->type;
1360 break;
1361 default:
1362 var->var->interface_type = NULL;
1363 break;
1364 }
1365 break;
1366
1367 case vtn_variable_mode_input:
1368 case vtn_variable_mode_output: {
1369 /* In order to know whether or not we're a per-vertex inout, we need
1370 * the patch qualifier. This means walking the variable decorations
1371 * early before we actually create any variables. Not a big deal.
1372 *
1373 * GLSLang really likes to place decorations in the most interior
1374 * thing it possibly can. In particular, if you have a struct, it
1375 * will place the patch decorations on the struct members. This
1376 * should be handled by the variable splitting below just fine.
1377 *
1378 * If you have an array-of-struct, things get even more weird as it
1379 * will place the patch decorations on the struct even though it's
1380 * inside an array and some of the members being patch and others not
1381 * makes no sense whatsoever. Since the only sensible thing is for
1382 * it to be all or nothing, we'll call it patch if any of the members
1383 * are declared patch.
1384 */
1385 var->patch = false;
1386 vtn_foreach_decoration(b, val, var_is_patch_cb, &var->patch);
1387 if (glsl_type_is_array(var->type->type) &&
1388 glsl_type_is_struct(without_array->type)) {
1389 vtn_foreach_decoration(b, without_array->val,
1390 var_is_patch_cb, &var->patch);
1391 }
1392
1393 /* For inputs and outputs, we immediately split structures. This
1394 * is for a couple of reasons. For one, builtins may all come in
1395 * a struct and we really want those split out into separate
1396 * variables. For another, interpolation qualifiers can be
1397 * applied to members of the top-level struct ane we need to be
1398 * able to preserve that information.
1399 */
1400
1401 int array_length = -1;
1402 struct vtn_type *interface_type = var->type;
1403 if (is_per_vertex_inout(var, b->shader->stage)) {
1404 /* In Geometry shaders (and some tessellation), inputs come
1405 * in per-vertex arrays. However, some builtins come in
1406 * non-per-vertex, hence the need for the is_array check. In
1407 * any case, there are no non-builtin arrays allowed so this
1408 * check should be sufficient.
1409 */
1410 interface_type = var->type->array_element;
1411 array_length = glsl_get_length(var->type->type);
1412 }
1413
1414 if (glsl_type_is_struct(interface_type->type)) {
1415 /* It's a struct. Split it. */
1416 unsigned num_members = glsl_get_length(interface_type->type);
1417 var->members = ralloc_array(b, nir_variable *, num_members);
1418
1419 for (unsigned i = 0; i < num_members; i++) {
1420 const struct glsl_type *mtype = interface_type->members[i]->type;
1421 if (array_length >= 0)
1422 mtype = glsl_array_type(mtype, array_length);
1423
1424 var->members[i] = rzalloc(b->shader, nir_variable);
1425 var->members[i]->name =
1426 ralloc_asprintf(var->members[i], "%s.%d", val->name, i);
1427 var->members[i]->type = mtype;
1428 var->members[i]->interface_type =
1429 interface_type->members[i]->type;
1430 var->members[i]->data.mode = nir_mode;
1431 var->members[i]->data.patch = var->patch;
1432 }
1433 } else {
1434 var->var = rzalloc(b->shader, nir_variable);
1435 var->var->name = ralloc_strdup(var->var, val->name);
1436 var->var->type = var->type->type;
1437 var->var->interface_type = interface_type->type;
1438 var->var->data.mode = nir_mode;
1439 var->var->data.patch = var->patch;
1440 }
1441
1442 /* For inputs and outputs, we need to grab locations and builtin
1443 * information from the interface type.
1444 */
1445 vtn_foreach_decoration(b, interface_type->val, var_decoration_cb, var);
1446 break;
1447
1448 case vtn_variable_mode_param:
1449 unreachable("Not created through OpVariable");
1450 }
1451
1452 case vtn_variable_mode_ubo:
1453 case vtn_variable_mode_ssbo:
1454 case vtn_variable_mode_push_constant:
1455 /* These don't need actual variables. */
1456 break;
1457 }
1458
1459 if (count > 4) {
1460 assert(count == 5);
1461 nir_constant *constant =
1462 vtn_value(b, w[4], vtn_value_type_constant)->constant;
1463 var->var->constant_initializer =
1464 nir_constant_clone(constant, var->var);
1465 }
1466
1467 vtn_foreach_decoration(b, val, var_decoration_cb, var);
1468
1469 if (var->mode == vtn_variable_mode_image ||
1470 var->mode == vtn_variable_mode_sampler) {
1471 /* XXX: We still need the binding information in the nir_variable
1472 * for these. We should fix that.
1473 */
1474 var->var->data.binding = var->binding;
1475 var->var->data.descriptor_set = var->descriptor_set;
1476 var->var->data.index = var->input_attachment_index;
1477
1478 if (var->mode == vtn_variable_mode_image)
1479 var->var->data.image.format = without_array->image_format;
1480 }
1481
1482 if (var->mode == vtn_variable_mode_local) {
1483 assert(var->members == NULL && var->var != NULL);
1484 nir_function_impl_add_variable(b->impl, var->var);
1485 } else if (var->var) {
1486 nir_shader_add_variable(b->shader, var->var);
1487 } else if (var->members) {
1488 unsigned count = glsl_get_length(without_array->type);
1489 for (unsigned i = 0; i < count; i++) {
1490 assert(var->members[i]->data.mode != nir_var_local);
1491 nir_shader_add_variable(b->shader, var->members[i]);
1492 }
1493 } else {
1494 assert(var->mode == vtn_variable_mode_ubo ||
1495 var->mode == vtn_variable_mode_ssbo ||
1496 var->mode == vtn_variable_mode_push_constant);
1497 }
1498 break;
1499 }
1500
1501 case SpvOpAccessChain:
1502 case SpvOpInBoundsAccessChain: {
1503 struct vtn_access_chain *base, *chain;
1504 struct vtn_value *base_val = vtn_untyped_value(b, w[3]);
1505 if (base_val->value_type == vtn_value_type_sampled_image) {
1506 /* This is rather insane. SPIR-V allows you to use OpSampledImage
1507 * to combine an array of images with a single sampler to get an
1508 * array of sampled images that all share the same sampler.
1509 * Fortunately, this means that we can more-or-less ignore the
1510 * sampler when crawling the access chain, but it does leave us
1511 * with this rather awkward little special-case.
1512 */
1513 base = base_val->sampled_image->image;
1514 } else {
1515 assert(base_val->value_type == vtn_value_type_access_chain);
1516 base = base_val->access_chain;
1517 }
1518
1519 chain = vtn_access_chain_extend(b, base, count - 4);
1520
1521 unsigned idx = base->length;
1522 for (int i = 4; i < count; i++) {
1523 struct vtn_value *link_val = vtn_untyped_value(b, w[i]);
1524 if (link_val->value_type == vtn_value_type_constant) {
1525 chain->link[idx].mode = vtn_access_mode_literal;
1526 chain->link[idx].id = link_val->constant->values[0].u32[0];
1527 } else {
1528 chain->link[idx].mode = vtn_access_mode_id;
1529 chain->link[idx].id = w[i];
1530 }
1531 idx++;
1532 }
1533
1534 if (base_val->value_type == vtn_value_type_sampled_image) {
1535 struct vtn_value *val =
1536 vtn_push_value(b, w[2], vtn_value_type_sampled_image);
1537 val->sampled_image = ralloc(b, struct vtn_sampled_image);
1538 val->sampled_image->image = chain;
1539 val->sampled_image->sampler = base_val->sampled_image->sampler;
1540 } else {
1541 struct vtn_value *val =
1542 vtn_push_value(b, w[2], vtn_value_type_access_chain);
1543 val->access_chain = chain;
1544 }
1545 break;
1546 }
1547
1548 case SpvOpCopyMemory: {
1549 struct vtn_value *dest = vtn_value(b, w[1], vtn_value_type_access_chain);
1550 struct vtn_value *src = vtn_value(b, w[2], vtn_value_type_access_chain);
1551
1552 vtn_variable_copy(b, dest->access_chain, src->access_chain);
1553 break;
1554 }
1555
1556 case SpvOpLoad: {
1557 struct vtn_access_chain *src =
1558 vtn_value(b, w[3], vtn_value_type_access_chain)->access_chain;
1559
1560 if (src->var->mode == vtn_variable_mode_image ||
1561 src->var->mode == vtn_variable_mode_sampler) {
1562 vtn_push_value(b, w[2], vtn_value_type_access_chain)->access_chain = src;
1563 return;
1564 }
1565
1566 struct vtn_value *val = vtn_push_value(b, w[2], vtn_value_type_ssa);
1567 val->ssa = vtn_variable_load(b, src);
1568 break;
1569 }
1570
1571 case SpvOpStore: {
1572 struct vtn_access_chain *dest =
1573 vtn_value(b, w[1], vtn_value_type_access_chain)->access_chain;
1574 struct vtn_ssa_value *src = vtn_ssa_value(b, w[2]);
1575 vtn_variable_store(b, src, dest);
1576 break;
1577 }
1578
1579 case SpvOpArrayLength: {
1580 struct vtn_access_chain *chain =
1581 vtn_value(b, w[3], vtn_value_type_access_chain)->access_chain;
1582
1583 const uint32_t offset = chain->var->type->offsets[w[4]];
1584 const uint32_t stride = chain->var->type->members[w[4]]->stride;
1585
1586 unsigned chain_idx;
1587 struct vtn_type *type;
1588 nir_ssa_def *index =
1589 get_vulkan_resource_index(b, chain, &type, &chain_idx);
1590
1591 nir_intrinsic_instr *instr =
1592 nir_intrinsic_instr_create(b->nb.shader,
1593 nir_intrinsic_get_buffer_size);
1594 instr->src[0] = nir_src_for_ssa(index);
1595 nir_ssa_dest_init(&instr->instr, &instr->dest, 1, 32, NULL);
1596 nir_builder_instr_insert(&b->nb, &instr->instr);
1597 nir_ssa_def *buf_size = &instr->dest.ssa;
1598
1599 /* array_length = max(buffer_size - offset, 0) / stride */
1600 nir_ssa_def *array_length =
1601 nir_idiv(&b->nb,
1602 nir_imax(&b->nb,
1603 nir_isub(&b->nb,
1604 buf_size,
1605 nir_imm_int(&b->nb, offset)),
1606 nir_imm_int(&b->nb, 0u)),
1607 nir_imm_int(&b->nb, stride));
1608
1609 struct vtn_value *val = vtn_push_value(b, w[2], vtn_value_type_ssa);
1610 val->ssa = vtn_create_ssa_value(b, glsl_uint_type());
1611 val->ssa->def = array_length;
1612 break;
1613 }
1614
1615 case SpvOpCopyMemorySized:
1616 default:
1617 unreachable("Unhandled opcode");
1618 }
1619 }