zink/spirv: implement discard
[mesa.git] / src / gallium / drivers / zink / nir_to_spirv / spirv_builder.c
1 /*
2 * Copyright 2018 Collabora Ltd.
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 * on the rights to use, copy, modify, merge, publish, distribute, sub
8 * license, and/or sell copies of the Software, and to permit persons to whom
9 * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
21 * USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23
24 #include "spirv_builder.h"
25
26 #include "util/macros.h"
27 #include "util/u_bitcast.h"
28 #include "util/u_memory.h"
29 #include "util/hash_table.h"
30
31 #include <stdbool.h>
32 #include <inttypes.h>
33 #include <string.h>
34
35 static bool
36 spirv_buffer_grow(struct spirv_buffer *b, size_t needed)
37 {
38 size_t new_room = MAX3(64, (b->room * 3) / 2, needed);
39
40 uint32_t *new_words = realloc(b->words, new_room * sizeof(uint32_t));
41 if (!new_words)
42 return false;
43
44 b->words = new_words;
45 b->room = new_room;
46 return true;
47 }
48
49 static inline bool
50 spirv_buffer_prepare(struct spirv_buffer *b, size_t needed)
51 {
52 needed += b->num_words;
53 if (b->room >= b->num_words + needed)
54 return true;
55
56 return spirv_buffer_grow(b, needed);
57 }
58
59 static inline void
60 spirv_buffer_emit_word(struct spirv_buffer *b, uint32_t word)
61 {
62 assert(b->num_words < b->room);
63 b->words[b->num_words++] = word;
64 }
65
66 static int
67 spirv_buffer_emit_string(struct spirv_buffer *b, const char *str)
68 {
69 int pos = 0;
70 uint32_t word = 0;
71 while (str[pos] != '\0') {
72 word |= str[pos] << (8 * (pos % 4));
73 if (++pos % 4 == 0) {
74 spirv_buffer_prepare(b, 1);
75 spirv_buffer_emit_word(b, word);
76 word = 0;
77 }
78 }
79
80 spirv_buffer_prepare(b, 1);
81 spirv_buffer_emit_word(b, word);
82
83 return 1 + pos / 4;
84 }
85
86 void
87 spirv_builder_emit_cap(struct spirv_builder *b, SpvCapability cap)
88 {
89 spirv_buffer_prepare(&b->capabilities, 2);
90 spirv_buffer_emit_word(&b->capabilities, SpvOpCapability | (2 << 16));
91 spirv_buffer_emit_word(&b->capabilities, cap);
92 }
93
94 void
95 spirv_builder_emit_source(struct spirv_builder *b, SpvSourceLanguage lang,
96 uint32_t version)
97 {
98 spirv_buffer_prepare(&b->debug_names, 3);
99 spirv_buffer_emit_word(&b->debug_names, SpvOpSource | (3 << 16));
100 spirv_buffer_emit_word(&b->debug_names, lang);
101 spirv_buffer_emit_word(&b->debug_names, version);
102 }
103
104 void
105 spirv_builder_emit_mem_model(struct spirv_builder *b,
106 SpvAddressingModel addr_model,
107 SpvMemoryModel mem_model)
108 {
109 spirv_buffer_prepare(&b->memory_model, 3);
110 spirv_buffer_emit_word(&b->memory_model, SpvOpMemoryModel | (3 << 16));
111 spirv_buffer_emit_word(&b->memory_model, addr_model);
112 spirv_buffer_emit_word(&b->memory_model, mem_model);
113 }
114
115 void
116 spirv_builder_emit_entry_point(struct spirv_builder *b,
117 SpvExecutionModel exec_model, SpvId entry_point,
118 const char *name, const SpvId interfaces[],
119 size_t num_interfaces)
120 {
121 size_t pos = b->entry_points.num_words;
122 spirv_buffer_prepare(&b->entry_points, 3);
123 spirv_buffer_emit_word(&b->entry_points, SpvOpEntryPoint);
124 spirv_buffer_emit_word(&b->entry_points, exec_model);
125 spirv_buffer_emit_word(&b->entry_points, entry_point);
126 int len = spirv_buffer_emit_string(&b->entry_points, name);
127 b->entry_points.words[pos] |= (3 + len + num_interfaces) << 16;
128 spirv_buffer_prepare(&b->entry_points, num_interfaces);
129 for (int i = 0; i < num_interfaces; ++i)
130 spirv_buffer_emit_word(&b->entry_points, interfaces[i]);
131 }
132
133 void
134 spirv_builder_emit_exec_mode(struct spirv_builder *b, SpvId entry_point,
135 SpvExecutionMode exec_mode)
136 {
137 spirv_buffer_prepare(&b->exec_modes, 3);
138 spirv_buffer_emit_word(&b->exec_modes, SpvOpExecutionMode | (3 << 16));
139 spirv_buffer_emit_word(&b->exec_modes, entry_point);
140 spirv_buffer_emit_word(&b->exec_modes, exec_mode);
141 }
142
143 void
144 spirv_builder_emit_name(struct spirv_builder *b, SpvId target,
145 const char *name)
146 {
147 size_t pos = b->debug_names.num_words;
148 spirv_buffer_prepare(&b->debug_names, 2);
149 spirv_buffer_emit_word(&b->debug_names, SpvOpName);
150 spirv_buffer_emit_word(&b->debug_names, target);
151 int len = spirv_buffer_emit_string(&b->debug_names, name);
152 b->debug_names.words[pos] |= (2 + len) << 16;
153 }
154
155 static void
156 emit_decoration(struct spirv_builder *b, SpvId target,
157 SpvDecoration decoration, const uint32_t extra_operands[],
158 size_t num_extra_operands)
159 {
160 int words = 3 + num_extra_operands;
161 spirv_buffer_prepare(&b->decorations, words);
162 spirv_buffer_emit_word(&b->decorations, SpvOpDecorate | (words << 16));
163 spirv_buffer_emit_word(&b->decorations, target);
164 spirv_buffer_emit_word(&b->decorations, decoration);
165 for (int i = 0; i < num_extra_operands; ++i)
166 spirv_buffer_emit_word(&b->decorations, extra_operands[i]);
167 }
168
169 void
170 spirv_builder_emit_decoration(struct spirv_builder *b, SpvId target,
171 SpvDecoration decoration)
172 {
173 emit_decoration(b, target, decoration, NULL, 0);
174 }
175
176 void
177 spirv_builder_emit_location(struct spirv_builder *b, SpvId target,
178 uint32_t location)
179 {
180 uint32_t args[] = { location };
181 emit_decoration(b, target, SpvDecorationLocation, args, ARRAY_SIZE(args));
182 }
183
184 void
185 spirv_builder_emit_component(struct spirv_builder *b, SpvId target,
186 uint32_t component)
187 {
188 uint32_t args[] = { component };
189 emit_decoration(b, target, SpvDecorationComponent, args, ARRAY_SIZE(args));
190 }
191
192 void
193 spirv_builder_emit_builtin(struct spirv_builder *b, SpvId target,
194 SpvBuiltIn builtin)
195 {
196 uint32_t args[] = { builtin };
197 emit_decoration(b, target, SpvDecorationBuiltIn, args, ARRAY_SIZE(args));
198 }
199
200 void
201 spirv_builder_emit_descriptor_set(struct spirv_builder *b, SpvId target,
202 uint32_t descriptor_set)
203 {
204 uint32_t args[] = { descriptor_set };
205 emit_decoration(b, target, SpvDecorationDescriptorSet, args,
206 ARRAY_SIZE(args));
207 }
208
209 void
210 spirv_builder_emit_binding(struct spirv_builder *b, SpvId target,
211 uint32_t binding)
212 {
213 uint32_t args[] = { binding };
214 emit_decoration(b, target, SpvDecorationBinding, args, ARRAY_SIZE(args));
215 }
216
217 void
218 spirv_builder_emit_array_stride(struct spirv_builder *b, SpvId target,
219 uint32_t stride)
220 {
221 uint32_t args[] = { stride };
222 emit_decoration(b, target, SpvDecorationArrayStride, args, ARRAY_SIZE(args));
223 }
224
225 static void
226 emit_member_decoration(struct spirv_builder *b, SpvId target, uint32_t member,
227 SpvDecoration decoration, const uint32_t extra_operands[],
228 size_t num_extra_operands)
229 {
230 int words = 4 + num_extra_operands;
231 spirv_buffer_prepare(&b->decorations, words);
232 spirv_buffer_emit_word(&b->decorations,
233 SpvOpMemberDecorate | (words << 16));
234 spirv_buffer_emit_word(&b->decorations, target);
235 spirv_buffer_emit_word(&b->decorations, member);
236 spirv_buffer_emit_word(&b->decorations, decoration);
237 for (int i = 0; i < num_extra_operands; ++i)
238 spirv_buffer_emit_word(&b->decorations, extra_operands[i]);
239 }
240
241 void
242 spirv_builder_emit_member_offset(struct spirv_builder *b, SpvId target,
243 uint32_t member, uint32_t offset)
244 {
245 uint32_t args[] = { offset };
246 emit_member_decoration(b, target, member, SpvDecorationOffset,
247 args, ARRAY_SIZE(args));
248 }
249
250 SpvId
251 spirv_builder_emit_undef(struct spirv_builder *b, SpvId result_type)
252 {
253 SpvId result = spirv_builder_new_id(b);
254 spirv_buffer_prepare(&b->instructions, 3);
255 spirv_buffer_emit_word(&b->instructions, SpvOpUndef | (3 << 16));
256 spirv_buffer_emit_word(&b->instructions, result_type);
257 spirv_buffer_emit_word(&b->instructions, result);
258 return result;
259 }
260
261 void
262 spirv_builder_function(struct spirv_builder *b, SpvId result,
263 SpvId return_type,
264 SpvFunctionControlMask function_control,
265 SpvId function_type)
266 {
267 spirv_buffer_prepare(&b->instructions, 5);
268 spirv_buffer_emit_word(&b->instructions, SpvOpFunction | (5 << 16));
269 spirv_buffer_emit_word(&b->instructions, return_type);
270 spirv_buffer_emit_word(&b->instructions, result);
271 spirv_buffer_emit_word(&b->instructions, function_control);
272 spirv_buffer_emit_word(&b->instructions, function_type);
273 }
274
275 void
276 spirv_builder_function_end(struct spirv_builder *b)
277 {
278 spirv_buffer_prepare(&b->instructions, 1);
279 spirv_buffer_emit_word(&b->instructions, SpvOpFunctionEnd | (1 << 16));
280 }
281
282 void
283 spirv_builder_label(struct spirv_builder *b, SpvId label)
284 {
285 spirv_buffer_prepare(&b->instructions, 2);
286 spirv_buffer_emit_word(&b->instructions, SpvOpLabel | (2 << 16));
287 spirv_buffer_emit_word(&b->instructions, label);
288 }
289
290 void
291 spirv_builder_return(struct spirv_builder *b)
292 {
293 spirv_buffer_prepare(&b->instructions, 1);
294 spirv_buffer_emit_word(&b->instructions, SpvOpReturn | (1 << 16));
295 }
296
297 SpvId
298 spirv_builder_emit_load(struct spirv_builder *b, SpvId result_type,
299 SpvId pointer)
300 {
301 return spirv_builder_emit_unop(b, SpvOpLoad, result_type, pointer);
302 }
303
304 void
305 spirv_builder_emit_store(struct spirv_builder *b, SpvId pointer, SpvId object)
306 {
307 spirv_buffer_prepare(&b->instructions, 3);
308 spirv_buffer_emit_word(&b->instructions, SpvOpStore | (3 << 16));
309 spirv_buffer_emit_word(&b->instructions, pointer);
310 spirv_buffer_emit_word(&b->instructions, object);
311 }
312
313 SpvId
314 spirv_builder_emit_access_chain(struct spirv_builder *b, SpvId result_type,
315 SpvId base, const SpvId indexes[],
316 size_t num_indexes)
317 {
318 SpvId result = spirv_builder_new_id(b);
319
320 int words = 4 + num_indexes;
321 spirv_buffer_prepare(&b->instructions, words);
322 spirv_buffer_emit_word(&b->instructions, SpvOpAccessChain | (words << 16));
323 spirv_buffer_emit_word(&b->instructions, result_type);
324 spirv_buffer_emit_word(&b->instructions, result);
325 spirv_buffer_emit_word(&b->instructions, base);
326 for (int i = 0; i < num_indexes; ++i)
327 spirv_buffer_emit_word(&b->instructions, indexes[i]);
328 return result;
329 }
330
331
332 SpvId
333 spirv_builder_emit_unop(struct spirv_builder *b, SpvOp op, SpvId result_type,
334 SpvId operand)
335 {
336 SpvId result = spirv_builder_new_id(b);
337 spirv_buffer_prepare(&b->instructions, 4);
338 spirv_buffer_emit_word(&b->instructions, op | (4 << 16));
339 spirv_buffer_emit_word(&b->instructions, result_type);
340 spirv_buffer_emit_word(&b->instructions, result);
341 spirv_buffer_emit_word(&b->instructions, operand);
342 return result;
343 }
344
345 SpvId
346 spirv_builder_emit_binop(struct spirv_builder *b, SpvOp op, SpvId result_type,
347 SpvId operand0, SpvId operand1)
348 {
349 SpvId result = spirv_builder_new_id(b);
350 spirv_buffer_prepare(&b->instructions, 5);
351 spirv_buffer_emit_word(&b->instructions, op | (5 << 16));
352 spirv_buffer_emit_word(&b->instructions, result_type);
353 spirv_buffer_emit_word(&b->instructions, result);
354 spirv_buffer_emit_word(&b->instructions, operand0);
355 spirv_buffer_emit_word(&b->instructions, operand1);
356 return result;
357 }
358
359 SpvId
360 spirv_builder_emit_triop(struct spirv_builder *b, SpvOp op, SpvId result_type,
361 SpvId operand0, SpvId operand1, SpvId operand2)
362 {
363 SpvId result = spirv_builder_new_id(b);
364 spirv_buffer_prepare(&b->instructions, 6);
365 spirv_buffer_emit_word(&b->instructions, op | (6 << 16));
366 spirv_buffer_emit_word(&b->instructions, result_type);
367 spirv_buffer_emit_word(&b->instructions, result);
368 spirv_buffer_emit_word(&b->instructions, operand0);
369 spirv_buffer_emit_word(&b->instructions, operand1);
370 spirv_buffer_emit_word(&b->instructions, operand2);
371 return result;
372 }
373
374 SpvId
375 spirv_builder_emit_composite_extract(struct spirv_builder *b, SpvId result_type,
376 SpvId composite, const uint32_t indexes[],
377 size_t num_indexes)
378 {
379 SpvId result = spirv_builder_new_id(b);
380
381 assert(num_indexes > 0);
382 int words = 4 + num_indexes;
383 spirv_buffer_prepare(&b->instructions, words);
384 spirv_buffer_emit_word(&b->instructions,
385 SpvOpCompositeExtract | (words << 16));
386 spirv_buffer_emit_word(&b->instructions, result_type);
387 spirv_buffer_emit_word(&b->instructions, result);
388 spirv_buffer_emit_word(&b->instructions, composite);
389 for (int i = 0; i < num_indexes; ++i)
390 spirv_buffer_emit_word(&b->instructions, indexes[i]);
391 return result;
392 }
393
394 SpvId
395 spirv_builder_emit_composite_construct(struct spirv_builder *b,
396 SpvId result_type,
397 const SpvId constituents[],
398 size_t num_constituents)
399 {
400 SpvId result = spirv_builder_new_id(b);
401
402 assert(num_constituents > 0);
403 int words = 3 + num_constituents;
404 spirv_buffer_prepare(&b->instructions, words);
405 spirv_buffer_emit_word(&b->instructions,
406 SpvOpCompositeConstruct | (words << 16));
407 spirv_buffer_emit_word(&b->instructions, result_type);
408 spirv_buffer_emit_word(&b->instructions, result);
409 for (int i = 0; i < num_constituents; ++i)
410 spirv_buffer_emit_word(&b->instructions, constituents[i]);
411 return result;
412 }
413
414 SpvId
415 spirv_builder_emit_vector_shuffle(struct spirv_builder *b, SpvId result_type,
416 SpvId vector_1, SpvId vector_2,
417 const uint32_t components[],
418 size_t num_components)
419 {
420 SpvId result = spirv_builder_new_id(b);
421
422 assert(num_components > 0);
423 int words = 5 + num_components;
424 spirv_buffer_prepare(&b->instructions, words);
425 spirv_buffer_emit_word(&b->instructions, SpvOpVectorShuffle | (words << 16));
426 spirv_buffer_emit_word(&b->instructions, result_type);
427 spirv_buffer_emit_word(&b->instructions, result);
428 spirv_buffer_emit_word(&b->instructions, vector_1);
429 spirv_buffer_emit_word(&b->instructions, vector_2);
430 for (int i = 0; i < num_components; ++i)
431 spirv_buffer_emit_word(&b->instructions, components[i]);
432 return result;
433 }
434
435 void
436 spirv_builder_emit_branch(struct spirv_builder *b, SpvId label)
437 {
438 spirv_buffer_prepare(&b->instructions, 2);
439 spirv_buffer_emit_word(&b->instructions, SpvOpBranch | (2 << 16));
440 spirv_buffer_emit_word(&b->instructions, label);
441 }
442
443 void
444 spirv_builder_emit_selection_merge(struct spirv_builder *b, SpvId merge_block,
445 SpvSelectionControlMask selection_control)
446 {
447 spirv_buffer_prepare(&b->instructions, 3);
448 spirv_buffer_emit_word(&b->instructions, SpvOpSelectionMerge | (3 << 16));
449 spirv_buffer_emit_word(&b->instructions, merge_block);
450 spirv_buffer_emit_word(&b->instructions, selection_control);
451 }
452
453 void
454 spirv_builder_emit_branch_conditional(struct spirv_builder *b, SpvId condition,
455 SpvId true_label, SpvId false_label)
456 {
457 spirv_buffer_prepare(&b->instructions, 4);
458 spirv_buffer_emit_word(&b->instructions, SpvOpBranchConditional | (4 << 16));
459 spirv_buffer_emit_word(&b->instructions, condition);
460 spirv_buffer_emit_word(&b->instructions, true_label);
461 spirv_buffer_emit_word(&b->instructions, false_label);
462 }
463
464 SpvId
465 spirv_builder_emit_phi(struct spirv_builder *b, SpvId result_type,
466 size_t num_vars, size_t *position)
467 {
468 SpvId result = spirv_builder_new_id(b);
469
470 assert(num_vars > 0);
471 int words = 3 + 2 * num_vars;
472 spirv_buffer_prepare(&b->instructions, words);
473 spirv_buffer_emit_word(&b->instructions, SpvOpPhi | (words << 16));
474 spirv_buffer_emit_word(&b->instructions, result_type);
475 spirv_buffer_emit_word(&b->instructions, result);
476 *position = b->instructions.num_words;
477 for (int i = 0; i < 2 * num_vars; ++i)
478 spirv_buffer_emit_word(&b->instructions, 0);
479 return result;
480 }
481
482 void
483 spirv_builder_set_phi_operand(struct spirv_builder *b, size_t position,
484 size_t index, SpvId variable, SpvId parent)
485 {
486 b->instructions.words[position + index * 2 + 0] = variable;
487 b->instructions.words[position + index * 2 + 1] = parent;
488 }
489
490 void
491 spirv_builder_emit_kill(struct spirv_builder *b)
492 {
493 spirv_buffer_prepare(&b->instructions, 1);
494 spirv_buffer_emit_word(&b->instructions, SpvOpKill | (1 << 16));
495 }
496
497 SpvId
498 spirv_builder_emit_image_sample_implicit_lod(struct spirv_builder *b,
499 SpvId result_type,
500 SpvId sampled_image,
501 SpvId coordinate)
502 {
503 SpvId result = spirv_builder_new_id(b);
504 spirv_buffer_prepare(&b->instructions, 5);
505 spirv_buffer_emit_word(&b->instructions, SpvOpImageSampleImplicitLod | (5 << 16));
506 spirv_buffer_emit_word(&b->instructions, result_type);
507 spirv_buffer_emit_word(&b->instructions, result);
508 spirv_buffer_emit_word(&b->instructions, sampled_image);
509 spirv_buffer_emit_word(&b->instructions, coordinate);
510 return result;
511 }
512
513 SpvId
514 spirv_builder_emit_image_sample_proj_implicit_lod(struct spirv_builder *b,
515 SpvId result_type,
516 SpvId sampled_image,
517 SpvId coordinate)
518 {
519 SpvId result = spirv_builder_new_id(b);
520 spirv_buffer_prepare(&b->instructions, 5);
521 spirv_buffer_emit_word(&b->instructions, SpvOpImageSampleProjImplicitLod | (5 << 16));
522 spirv_buffer_emit_word(&b->instructions, result_type);
523 spirv_buffer_emit_word(&b->instructions, result);
524 spirv_buffer_emit_word(&b->instructions, sampled_image);
525 spirv_buffer_emit_word(&b->instructions, coordinate);
526 return result;
527 }
528
529 SpvId
530 spirv_builder_emit_ext_inst(struct spirv_builder *b, SpvId result_type,
531 SpvId set, uint32_t instruction,
532 const SpvId *args, size_t num_args)
533 {
534 SpvId result = spirv_builder_new_id(b);
535
536 int words = 5 + num_args;
537 spirv_buffer_prepare(&b->instructions, words);
538 spirv_buffer_emit_word(&b->instructions, SpvOpExtInst | (words << 16));
539 spirv_buffer_emit_word(&b->instructions, result_type);
540 spirv_buffer_emit_word(&b->instructions, result);
541 spirv_buffer_emit_word(&b->instructions, set);
542 spirv_buffer_emit_word(&b->instructions, instruction);
543 for (int i = 0; i < num_args; ++i)
544 spirv_buffer_emit_word(&b->instructions, args[i]);
545 return result;
546 }
547
548 struct spirv_type {
549 SpvOp op;
550 uint32_t args[8];
551 size_t num_args;
552
553 SpvId type;
554 };
555
556 static uint32_t
557 non_aggregate_type_hash(const void *arg)
558 {
559 const struct spirv_type *type = arg;
560
561 uint32_t hash = _mesa_fnv32_1a_offset_bias;
562 hash = _mesa_fnv32_1a_accumulate(hash, type->op);
563 hash = _mesa_fnv32_1a_accumulate_block(hash, type->args, sizeof(uint32_t) *
564 type->num_args);
565 return hash;
566 }
567
568 static bool
569 non_aggregate_type_equals(const void *a, const void *b)
570 {
571 const struct spirv_type *ta = a, *tb = b;
572
573 if (ta->op != tb->op)
574 return false;
575
576 assert(ta->num_args == tb->num_args);
577 return memcmp(ta->args, tb->args, sizeof(uint32_t) * ta->num_args) == 0;
578 }
579
580 static SpvId
581 get_type_def(struct spirv_builder *b, SpvOp op, const uint32_t args[],
582 size_t num_args)
583 {
584 /* According to the SPIR-V specification:
585 *
586 * "Two different type <id>s form, by definition, two different types. It
587 * is valid to declare multiple aggregate type <id>s having the same
588 * opcode and operands. This is to allow multiple instances of aggregate
589 * types with the same structure to be decorated differently. (Different
590 * decorations are not required; two different aggregate type <id>s are
591 * allowed to have identical declarations and decorations, and will still
592 * be two different types.) Non-aggregate types are different: It is
593 * invalid to declare multiple type <id>s for the same scalar, vector, or
594 * matrix type. That is, non-aggregate type declarations must all have
595 * different opcodes or operands. (Note that non-aggregate types cannot
596 * be decorated in ways that affect their type.)"
597 *
598 * ..so, we need to prevent the same non-aggregate type to be re-defined
599 * with a new <id>. We do this by putting the definitions in a hash-map, so
600 * we can easily look up and reuse them.
601 */
602
603 struct spirv_type key;
604 assert(num_args < ARRAY_SIZE(key.args));
605 key.op = op;
606 memcpy(&key.args, args, sizeof(uint32_t) * num_args);
607 key.num_args = num_args;
608
609 struct hash_entry *entry;
610 if (b->types) {
611 entry = _mesa_hash_table_search(b->types, &key);
612 if (entry)
613 return ((struct spirv_type *)entry->data)->type;
614 } else {
615 b->types = _mesa_hash_table_create(NULL, non_aggregate_type_hash,
616 non_aggregate_type_equals);
617 assert(b->types);
618 }
619
620 struct spirv_type *type = CALLOC_STRUCT(spirv_type);
621 if (!type)
622 return 0;
623
624 type->op = op;
625 memcpy(&type->args, args, sizeof(uint32_t) * num_args);
626 type->num_args = num_args;
627
628 type->type = spirv_builder_new_id(b);
629 spirv_buffer_prepare(&b->types_const_defs, 2 + num_args);
630 spirv_buffer_emit_word(&b->types_const_defs, op | ((2 + num_args) << 16));
631 spirv_buffer_emit_word(&b->types_const_defs, type->type);
632 for (int i = 0; i < num_args; ++i)
633 spirv_buffer_emit_word(&b->types_const_defs, args[i]);
634
635 entry = _mesa_hash_table_insert(b->types, type, type);
636 assert(entry);
637
638 return ((struct spirv_type *)entry->data)->type;
639 }
640
641 SpvId
642 spirv_builder_type_void(struct spirv_builder *b)
643 {
644 return get_type_def(b, SpvOpTypeVoid, NULL, 0);
645 }
646
647 SpvId
648 spirv_builder_type_bool(struct spirv_builder *b)
649 {
650 return get_type_def(b, SpvOpTypeBool, NULL, 0);
651 }
652
653 SpvId
654 spirv_builder_type_int(struct spirv_builder *b, unsigned width)
655 {
656 uint32_t args[] = { width, 1 };
657 return get_type_def(b, SpvOpTypeInt, args, ARRAY_SIZE(args));
658 }
659
660 SpvId
661 spirv_builder_type_uint(struct spirv_builder *b, unsigned width)
662 {
663 uint32_t args[] = { width, 0 };
664 return get_type_def(b, SpvOpTypeInt, args, ARRAY_SIZE(args));
665 }
666
667 SpvId
668 spirv_builder_type_float(struct spirv_builder *b, unsigned width)
669 {
670 uint32_t args[] = { width };
671 return get_type_def(b, SpvOpTypeFloat, args, ARRAY_SIZE(args));
672 }
673
674 SpvId
675 spirv_builder_type_image(struct spirv_builder *b, SpvId sampled_type,
676 SpvDim dim, bool depth, bool arrayed, bool ms,
677 unsigned sampled, SpvImageFormat image_format)
678 {
679 assert(sampled < 3);
680 uint32_t args[] = {
681 sampled_type, dim, depth ? 1 : 0, arrayed ? 1 : 0, ms ? 1 : 0, sampled,
682 image_format
683 };
684 return get_type_def(b, SpvOpTypeImage, args, ARRAY_SIZE(args));
685 }
686
687 SpvId
688 spirv_builder_type_sampled_image(struct spirv_builder *b, SpvId image_type)
689 {
690 uint32_t args[] = { image_type };
691 return get_type_def(b, SpvOpTypeSampledImage, args, ARRAY_SIZE(args));
692 }
693
694 SpvId
695 spirv_builder_type_pointer(struct spirv_builder *b,
696 SpvStorageClass storage_class, SpvId type)
697 {
698 uint32_t args[] = { storage_class, type };
699 return get_type_def(b, SpvOpTypePointer, args, ARRAY_SIZE(args));
700 }
701
702 SpvId
703 spirv_builder_type_vector(struct spirv_builder *b, SpvId component_type,
704 unsigned component_count)
705 {
706 assert(component_count > 1);
707 uint32_t args[] = { component_type, component_count };
708 return get_type_def(b, SpvOpTypeVector, args, ARRAY_SIZE(args));
709 }
710
711 SpvId
712 spirv_builder_type_array(struct spirv_builder *b, SpvId component_type,
713 SpvId length)
714 {
715 SpvId type = spirv_builder_new_id(b);
716 spirv_buffer_prepare(&b->types_const_defs, 4);
717 spirv_buffer_emit_word(&b->types_const_defs, SpvOpTypeArray | (4 << 16));
718 spirv_buffer_emit_word(&b->types_const_defs, type);
719 spirv_buffer_emit_word(&b->types_const_defs, component_type);
720 spirv_buffer_emit_word(&b->types_const_defs, length);
721 return type;
722 }
723
724 SpvId
725 spirv_builder_type_struct(struct spirv_builder *b, const SpvId member_types[],
726 size_t num_member_types)
727 {
728 int words = 2 + num_member_types;
729 SpvId type = spirv_builder_new_id(b);
730 spirv_buffer_prepare(&b->types_const_defs, words);
731 spirv_buffer_emit_word(&b->types_const_defs, SpvOpTypeStruct | (words << 16));
732 spirv_buffer_emit_word(&b->types_const_defs, type);
733 for (int i = 0; i < num_member_types; ++i)
734 spirv_buffer_emit_word(&b->types_const_defs, member_types[i]);
735 return type;
736 }
737
738 SpvId
739 spirv_builder_type_function(struct spirv_builder *b, SpvId return_type,
740 const SpvId parameter_types[],
741 size_t num_parameter_types)
742 {
743 int words = 3 + num_parameter_types;
744 SpvId type = spirv_builder_new_id(b);
745 spirv_buffer_prepare(&b->types_const_defs, words);
746 spirv_buffer_emit_word(&b->types_const_defs, SpvOpTypeFunction | (words << 16));
747 spirv_buffer_emit_word(&b->types_const_defs, type);
748 spirv_buffer_emit_word(&b->types_const_defs, return_type);
749 for (int i = 0; i < num_parameter_types; ++i)
750 spirv_buffer_emit_word(&b->types_const_defs, parameter_types[i]);
751 return type;
752 }
753
754 static SpvId
755 get_const_def(struct spirv_builder *b, SpvOp op, SpvId type,
756 const uint32_t args[], size_t num_args)
757 {
758 /* TODO: reuse constants */
759 SpvId result = spirv_builder_new_id(b);
760 spirv_buffer_prepare(&b->types_const_defs, 3 + num_args);
761 spirv_buffer_emit_word(&b->types_const_defs, op | ((3 + num_args) << 16));
762 spirv_buffer_emit_word(&b->types_const_defs, type);
763 spirv_buffer_emit_word(&b->types_const_defs, result);
764 for (int i = 0; i < num_args; ++i)
765 spirv_buffer_emit_word(&b->types_const_defs, args[i]);
766 return result;
767 }
768
769 SpvId
770 spirv_builder_const_bool(struct spirv_builder *b, bool val)
771 {
772 return get_const_def(b, val ? SpvOpConstantTrue : SpvOpConstantFalse,
773 spirv_builder_type_bool(b), NULL, 0);
774 }
775
776 SpvId
777 spirv_builder_const_int(struct spirv_builder *b, int width, int32_t val)
778 {
779 assert(width <= 32);
780 uint32_t args[] = { val };
781 return get_const_def(b, SpvOpConstant, spirv_builder_type_int(b, width),
782 args, ARRAY_SIZE(args));
783 }
784
785 SpvId
786 spirv_builder_const_uint(struct spirv_builder *b, int width, uint32_t val)
787 {
788 assert(width <= 32);
789 uint32_t args[] = { val };
790 return get_const_def(b, SpvOpConstant, spirv_builder_type_uint(b, width),
791 args, ARRAY_SIZE(args));
792 }
793
794 SpvId
795 spirv_builder_const_float(struct spirv_builder *b, int width, float val)
796 {
797 assert(width <= 32);
798 uint32_t args[] = { u_bitcast_f2u(val) };
799 return get_const_def(b, SpvOpConstant, spirv_builder_type_float(b, width),
800 args, ARRAY_SIZE(args));
801 }
802
803 SpvId
804 spirv_builder_const_composite(struct spirv_builder *b, SpvId result_type,
805 const SpvId constituents[],
806 size_t num_constituents)
807 {
808 return get_const_def(b, SpvOpConstantComposite, result_type,
809 (const uint32_t *)constituents,
810 num_constituents);
811 }
812
813 SpvId
814 spirv_builder_emit_var(struct spirv_builder *b, SpvId type,
815 SpvStorageClass storage_class)
816 {
817 assert(storage_class != SpvStorageClassGeneric);
818 struct spirv_buffer *buf = storage_class != SpvStorageClassFunction ?
819 &b->types_const_defs : &b->instructions;
820
821 SpvId ret = spirv_builder_new_id(b);
822 spirv_buffer_prepare(buf, 4);
823 spirv_buffer_emit_word(buf, SpvOpVariable | (4 << 16));
824 spirv_buffer_emit_word(buf, type);
825 spirv_buffer_emit_word(buf, ret);
826 spirv_buffer_emit_word(buf, storage_class);
827 return ret;
828 }
829
830 SpvId
831 spirv_builder_import(struct spirv_builder *b, const char *name)
832 {
833 SpvId result = spirv_builder_new_id(b);
834 size_t pos = b->imports.num_words;
835 spirv_buffer_prepare(&b->imports, 2);
836 spirv_buffer_emit_word(&b->imports, SpvOpExtInstImport);
837 spirv_buffer_emit_word(&b->imports, result);
838 int len = spirv_buffer_emit_string(&b->imports, name);
839 b->imports.words[pos] |= (2 + len) << 16;
840 return result;
841 }
842
843 size_t
844 spirv_builder_get_num_words(struct spirv_builder *b)
845 {
846 const size_t header_size = 5;
847 return header_size +
848 b->capabilities.num_words +
849 b->imports.num_words +
850 b->memory_model.num_words +
851 b->entry_points.num_words +
852 b->exec_modes.num_words +
853 b->debug_names.num_words +
854 b->decorations.num_words +
855 b->types_const_defs.num_words +
856 b->instructions.num_words;
857 }
858
859 size_t
860 spirv_builder_get_words(struct spirv_builder *b, uint32_t *words,
861 size_t num_words)
862 {
863 assert(num_words >= spirv_builder_get_num_words(b));
864
865 size_t written = 0;
866 words[written++] = SpvMagicNumber;
867 words[written++] = 0x00010000;
868 words[written++] = 0;
869 words[written++] = b->prev_id + 1;
870 words[written++] = 0;
871
872 const struct spirv_buffer *buffers[] = {
873 &b->capabilities,
874 &b->imports,
875 &b->memory_model,
876 &b->entry_points,
877 &b->exec_modes,
878 &b->debug_names,
879 &b->decorations,
880 &b->types_const_defs,
881 &b->instructions
882 };
883
884 for (int i = 0; i < ARRAY_SIZE(buffers); ++i) {
885 const struct spirv_buffer *buffer = buffers[i];
886 for (int j = 0; j < buffer->num_words; ++j)
887 words[written++] = buffer->words[j];
888 }
889
890 assert(written == spirv_builder_get_num_words(b));
891 return written;
892 }