tree-wide: remove trailing backslash
[mesa.git] / src / compiler / nir / nir_builder.h
1 /*
2 * Copyright © 2014-2015 Broadcom
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
24 #ifndef NIR_BUILDER_H
25 #define NIR_BUILDER_H
26
27 #include "nir_control_flow.h"
28
29 struct exec_list;
30
31 typedef struct nir_builder {
32 nir_cursor cursor;
33
34 /* Whether new ALU instructions will be marked "exact" */
35 bool exact;
36
37 nir_shader *shader;
38 nir_function_impl *impl;
39 } nir_builder;
40
41 static inline void
42 nir_builder_init(nir_builder *build, nir_function_impl *impl)
43 {
44 memset(build, 0, sizeof(*build));
45 build->exact = false;
46 build->impl = impl;
47 build->shader = impl->function->shader;
48 }
49
50 static inline void
51 nir_builder_init_simple_shader(nir_builder *build, void *mem_ctx,
52 gl_shader_stage stage,
53 const nir_shader_compiler_options *options)
54 {
55 build->shader = nir_shader_create(mem_ctx, stage, options, NULL);
56 nir_function *func = nir_function_create(build->shader, "main");
57 build->exact = false;
58 build->impl = nir_function_impl_create(func);
59 build->cursor = nir_after_cf_list(&build->impl->body);
60 }
61
62 static inline void
63 nir_builder_instr_insert(nir_builder *build, nir_instr *instr)
64 {
65 nir_instr_insert(build->cursor, instr);
66
67 /* Move the cursor forward. */
68 build->cursor = nir_after_instr(instr);
69 }
70
71 static inline nir_instr *
72 nir_builder_last_instr(nir_builder *build)
73 {
74 assert(build->cursor.option == nir_cursor_after_instr);
75 return build->cursor.instr;
76 }
77
78 static inline void
79 nir_builder_cf_insert(nir_builder *build, nir_cf_node *cf)
80 {
81 nir_cf_node_insert(build->cursor, cf);
82 }
83
84 static inline bool
85 nir_builder_is_inside_cf(nir_builder *build, nir_cf_node *cf_node)
86 {
87 nir_block *block = nir_cursor_current_block(build->cursor);
88 for (nir_cf_node *n = &block->cf_node; n; n = n->parent) {
89 if (n == cf_node)
90 return true;
91 }
92 return false;
93 }
94
95 static inline nir_if *
96 nir_push_if(nir_builder *build, nir_ssa_def *condition)
97 {
98 nir_if *nif = nir_if_create(build->shader);
99 nif->condition = nir_src_for_ssa(condition);
100 nir_builder_cf_insert(build, &nif->cf_node);
101 build->cursor = nir_before_cf_list(&nif->then_list);
102 return nif;
103 }
104
105 static inline nir_if *
106 nir_push_else(nir_builder *build, nir_if *nif)
107 {
108 if (nif) {
109 assert(nir_builder_is_inside_cf(build, &nif->cf_node));
110 } else {
111 nir_block *block = nir_cursor_current_block(build->cursor);
112 nif = nir_cf_node_as_if(block->cf_node.parent);
113 }
114 build->cursor = nir_before_cf_list(&nif->else_list);
115 return nif;
116 }
117
118 static inline void
119 nir_pop_if(nir_builder *build, nir_if *nif)
120 {
121 if (nif) {
122 assert(nir_builder_is_inside_cf(build, &nif->cf_node));
123 } else {
124 nir_block *block = nir_cursor_current_block(build->cursor);
125 nif = nir_cf_node_as_if(block->cf_node.parent);
126 }
127 build->cursor = nir_after_cf_node(&nif->cf_node);
128 }
129
130 static inline nir_ssa_def *
131 nir_if_phi(nir_builder *build, nir_ssa_def *then_def, nir_ssa_def *else_def)
132 {
133 nir_block *block = nir_cursor_current_block(build->cursor);
134 nir_if *nif = nir_cf_node_as_if(nir_cf_node_prev(&block->cf_node));
135
136 nir_phi_instr *phi = nir_phi_instr_create(build->shader);
137
138 nir_phi_src *src = ralloc(phi, nir_phi_src);
139 src->pred = nir_if_last_then_block(nif);
140 src->src = nir_src_for_ssa(then_def);
141 exec_list_push_tail(&phi->srcs, &src->node);
142
143 src = ralloc(phi, nir_phi_src);
144 src->pred = nir_if_last_else_block(nif);
145 src->src = nir_src_for_ssa(else_def);
146 exec_list_push_tail(&phi->srcs, &src->node);
147
148 assert(then_def->num_components == else_def->num_components);
149 assert(then_def->bit_size == else_def->bit_size);
150 nir_ssa_dest_init(&phi->instr, &phi->dest,
151 then_def->num_components, then_def->bit_size, NULL);
152
153 nir_builder_instr_insert(build, &phi->instr);
154
155 return &phi->dest.ssa;
156 }
157
158 static inline nir_loop *
159 nir_push_loop(nir_builder *build)
160 {
161 nir_loop *loop = nir_loop_create(build->shader);
162 nir_builder_cf_insert(build, &loop->cf_node);
163 build->cursor = nir_before_cf_list(&loop->body);
164 return loop;
165 }
166
167 static inline void
168 nir_pop_loop(nir_builder *build, nir_loop *loop)
169 {
170 if (loop) {
171 assert(nir_builder_is_inside_cf(build, &loop->cf_node));
172 } else {
173 nir_block *block = nir_cursor_current_block(build->cursor);
174 loop = nir_cf_node_as_loop(block->cf_node.parent);
175 }
176 build->cursor = nir_after_cf_node(&loop->cf_node);
177 }
178
179 static inline nir_ssa_def *
180 nir_ssa_undef(nir_builder *build, unsigned num_components, unsigned bit_size)
181 {
182 nir_ssa_undef_instr *undef =
183 nir_ssa_undef_instr_create(build->shader, num_components, bit_size);
184 if (!undef)
185 return NULL;
186
187 nir_instr_insert(nir_before_cf_list(&build->impl->body), &undef->instr);
188
189 return &undef->def;
190 }
191
192 static inline nir_ssa_def *
193 nir_build_imm(nir_builder *build, unsigned num_components,
194 unsigned bit_size, nir_const_value value)
195 {
196 nir_load_const_instr *load_const =
197 nir_load_const_instr_create(build->shader, num_components, bit_size);
198 if (!load_const)
199 return NULL;
200
201 load_const->value = value;
202
203 nir_builder_instr_insert(build, &load_const->instr);
204
205 return &load_const->def;
206 }
207
208 static inline nir_ssa_def *
209 nir_imm_float(nir_builder *build, float x)
210 {
211 nir_const_value v;
212
213 memset(&v, 0, sizeof(v));
214 v.f32[0] = x;
215
216 return nir_build_imm(build, 1, 32, v);
217 }
218
219 static inline nir_ssa_def *
220 nir_imm_double(nir_builder *build, double x)
221 {
222 nir_const_value v;
223
224 memset(&v, 0, sizeof(v));
225 v.f64[0] = x;
226
227 return nir_build_imm(build, 1, 64, v);
228 }
229
230 static inline nir_ssa_def *
231 nir_imm_vec4(nir_builder *build, float x, float y, float z, float w)
232 {
233 nir_const_value v;
234
235 memset(&v, 0, sizeof(v));
236 v.f32[0] = x;
237 v.f32[1] = y;
238 v.f32[2] = z;
239 v.f32[3] = w;
240
241 return nir_build_imm(build, 4, 32, v);
242 }
243
244 static inline nir_ssa_def *
245 nir_imm_int(nir_builder *build, int x)
246 {
247 nir_const_value v;
248
249 memset(&v, 0, sizeof(v));
250 v.i32[0] = x;
251
252 return nir_build_imm(build, 1, 32, v);
253 }
254
255 static inline nir_ssa_def *
256 nir_imm_int64(nir_builder *build, int64_t x)
257 {
258 nir_const_value v;
259
260 memset(&v, 0, sizeof(v));
261 v.i64[0] = x;
262
263 return nir_build_imm(build, 1, 64, v);
264 }
265
266 static inline nir_ssa_def *
267 nir_imm_ivec4(nir_builder *build, int x, int y, int z, int w)
268 {
269 nir_const_value v;
270
271 memset(&v, 0, sizeof(v));
272 v.i32[0] = x;
273 v.i32[1] = y;
274 v.i32[2] = z;
275 v.i32[3] = w;
276
277 return nir_build_imm(build, 4, 32, v);
278 }
279
280 static inline nir_ssa_def *
281 nir_build_alu(nir_builder *build, nir_op op, nir_ssa_def *src0,
282 nir_ssa_def *src1, nir_ssa_def *src2, nir_ssa_def *src3)
283 {
284 const nir_op_info *op_info = &nir_op_infos[op];
285 nir_alu_instr *instr = nir_alu_instr_create(build->shader, op);
286 if (!instr)
287 return NULL;
288
289 instr->exact = build->exact;
290
291 instr->src[0].src = nir_src_for_ssa(src0);
292 if (src1)
293 instr->src[1].src = nir_src_for_ssa(src1);
294 if (src2)
295 instr->src[2].src = nir_src_for_ssa(src2);
296 if (src3)
297 instr->src[3].src = nir_src_for_ssa(src3);
298
299 /* Guess the number of components the destination temporary should have
300 * based on our input sizes, if it's not fixed for the op.
301 */
302 unsigned num_components = op_info->output_size;
303 if (num_components == 0) {
304 for (unsigned i = 0; i < op_info->num_inputs; i++) {
305 if (op_info->input_sizes[i] == 0)
306 num_components = MAX2(num_components,
307 instr->src[i].src.ssa->num_components);
308 }
309 }
310 assert(num_components != 0);
311
312 /* Figure out the bitwidth based on the source bitwidth if the instruction
313 * is variable-width.
314 */
315 unsigned bit_size = nir_alu_type_get_type_size(op_info->output_type);
316 if (bit_size == 0) {
317 for (unsigned i = 0; i < op_info->num_inputs; i++) {
318 unsigned src_bit_size = instr->src[i].src.ssa->bit_size;
319 if (nir_alu_type_get_type_size(op_info->input_types[i]) == 0) {
320 if (bit_size)
321 assert(src_bit_size == bit_size);
322 else
323 bit_size = src_bit_size;
324 } else {
325 assert(src_bit_size ==
326 nir_alu_type_get_type_size(op_info->input_types[i]));
327 }
328 }
329 }
330
331 /* When in doubt, assume 32. */
332 if (bit_size == 0)
333 bit_size = 32;
334
335 /* Make sure we don't swizzle from outside of our source vector (like if a
336 * scalar value was passed into a multiply with a vector).
337 */
338 for (unsigned i = 0; i < op_info->num_inputs; i++) {
339 for (unsigned j = instr->src[i].src.ssa->num_components; j < 4; j++) {
340 instr->src[i].swizzle[j] = instr->src[i].src.ssa->num_components - 1;
341 }
342 }
343
344 nir_ssa_dest_init(&instr->instr, &instr->dest.dest, num_components,
345 bit_size, NULL);
346 instr->dest.write_mask = (1 << num_components) - 1;
347
348 nir_builder_instr_insert(build, &instr->instr);
349
350 return &instr->dest.dest.ssa;
351 }
352
353 #include "nir_builder_opcodes.h"
354
355 static inline nir_ssa_def *
356 nir_vec(nir_builder *build, nir_ssa_def **comp, unsigned num_components)
357 {
358 switch (num_components) {
359 case 4:
360 return nir_vec4(build, comp[0], comp[1], comp[2], comp[3]);
361 case 3:
362 return nir_vec3(build, comp[0], comp[1], comp[2]);
363 case 2:
364 return nir_vec2(build, comp[0], comp[1]);
365 case 1:
366 return comp[0];
367 default:
368 unreachable("bad component count");
369 return NULL;
370 }
371 }
372
373 /**
374 * Similar to nir_fmov, but takes a nir_alu_src instead of a nir_ssa_def.
375 */
376 static inline nir_ssa_def *
377 nir_fmov_alu(nir_builder *build, nir_alu_src src, unsigned num_components)
378 {
379 nir_alu_instr *mov = nir_alu_instr_create(build->shader, nir_op_fmov);
380 nir_ssa_dest_init(&mov->instr, &mov->dest.dest, num_components,
381 nir_src_bit_size(src.src), NULL);
382 mov->exact = build->exact;
383 mov->dest.write_mask = (1 << num_components) - 1;
384 mov->src[0] = src;
385 nir_builder_instr_insert(build, &mov->instr);
386
387 return &mov->dest.dest.ssa;
388 }
389
390 static inline nir_ssa_def *
391 nir_imov_alu(nir_builder *build, nir_alu_src src, unsigned num_components)
392 {
393 nir_alu_instr *mov = nir_alu_instr_create(build->shader, nir_op_imov);
394 nir_ssa_dest_init(&mov->instr, &mov->dest.dest, num_components,
395 nir_src_bit_size(src.src), NULL);
396 mov->exact = build->exact;
397 mov->dest.write_mask = (1 << num_components) - 1;
398 mov->src[0] = src;
399 nir_builder_instr_insert(build, &mov->instr);
400
401 return &mov->dest.dest.ssa;
402 }
403
404 /**
405 * Construct an fmov or imov that reswizzles the source's components.
406 */
407 static inline nir_ssa_def *
408 nir_swizzle(nir_builder *build, nir_ssa_def *src, const unsigned swiz[4],
409 unsigned num_components, bool use_fmov)
410 {
411 nir_alu_src alu_src = { NIR_SRC_INIT };
412 alu_src.src = nir_src_for_ssa(src);
413 for (unsigned i = 0; i < num_components; i++)
414 alu_src.swizzle[i] = swiz[i];
415
416 return use_fmov ? nir_fmov_alu(build, alu_src, num_components) :
417 nir_imov_alu(build, alu_src, num_components);
418 }
419
420 /* Selects the right fdot given the number of components in each source. */
421 static inline nir_ssa_def *
422 nir_fdot(nir_builder *build, nir_ssa_def *src0, nir_ssa_def *src1)
423 {
424 assert(src0->num_components == src1->num_components);
425 switch (src0->num_components) {
426 case 1: return nir_fmul(build, src0, src1);
427 case 2: return nir_fdot2(build, src0, src1);
428 case 3: return nir_fdot3(build, src0, src1);
429 case 4: return nir_fdot4(build, src0, src1);
430 default:
431 unreachable("bad component size");
432 }
433
434 return NULL;
435 }
436
437 static inline nir_ssa_def *
438 nir_bany_inequal(nir_builder *b, nir_ssa_def *src0, nir_ssa_def *src1)
439 {
440 switch (src0->num_components) {
441 case 1: return nir_ine(b, src0, src1);
442 case 2: return nir_bany_inequal2(b, src0, src1);
443 case 3: return nir_bany_inequal3(b, src0, src1);
444 case 4: return nir_bany_inequal4(b, src0, src1);
445 default:
446 unreachable("bad component size");
447 }
448 }
449
450 static inline nir_ssa_def *
451 nir_bany(nir_builder *b, nir_ssa_def *src)
452 {
453 return nir_bany_inequal(b, src, nir_imm_int(b, 0));
454 }
455
456 static inline nir_ssa_def *
457 nir_channel(nir_builder *b, nir_ssa_def *def, unsigned c)
458 {
459 unsigned swizzle[4] = {c, c, c, c};
460 return nir_swizzle(b, def, swizzle, 1, false);
461 }
462
463 static inline nir_ssa_def *
464 nir_channels(nir_builder *b, nir_ssa_def *def, unsigned mask)
465 {
466 unsigned num_channels = 0, swizzle[4] = { 0, 0, 0, 0 };
467
468 for (unsigned i = 0; i < 4; i++) {
469 if ((mask & (1 << i)) == 0)
470 continue;
471 swizzle[num_channels++] = i;
472 }
473
474 return nir_swizzle(b, def, swizzle, num_channels, false);
475 }
476
477 /**
478 * Turns a nir_src into a nir_ssa_def * so it can be passed to
479 * nir_build_alu()-based builder calls.
480 *
481 * See nir_ssa_for_alu_src() for alu instructions.
482 */
483 static inline nir_ssa_def *
484 nir_ssa_for_src(nir_builder *build, nir_src src, int num_components)
485 {
486 if (src.is_ssa && src.ssa->num_components == num_components)
487 return src.ssa;
488
489 nir_alu_src alu = { NIR_SRC_INIT };
490 alu.src = src;
491 for (int j = 0; j < 4; j++)
492 alu.swizzle[j] = j;
493
494 return nir_imov_alu(build, alu, num_components);
495 }
496
497 /**
498 * Similar to nir_ssa_for_src(), but for alu srcs, respecting the
499 * nir_alu_src's swizzle.
500 */
501 static inline nir_ssa_def *
502 nir_ssa_for_alu_src(nir_builder *build, nir_alu_instr *instr, unsigned srcn)
503 {
504 static uint8_t trivial_swizzle[4] = { 0, 1, 2, 3 };
505 nir_alu_src *src = &instr->src[srcn];
506 unsigned num_components = nir_ssa_alu_instr_src_components(instr, srcn);
507
508 if (src->src.is_ssa && (src->src.ssa->num_components == num_components) &&
509 !src->abs && !src->negate &&
510 (memcmp(src->swizzle, trivial_swizzle, num_components) == 0))
511 return src->src.ssa;
512
513 return nir_imov_alu(build, *src, num_components);
514 }
515
516 static inline nir_ssa_def *
517 nir_load_var(nir_builder *build, nir_variable *var)
518 {
519 const unsigned num_components = glsl_get_vector_elements(var->type);
520
521 nir_intrinsic_instr *load =
522 nir_intrinsic_instr_create(build->shader, nir_intrinsic_load_var);
523 load->num_components = num_components;
524 load->variables[0] = nir_deref_var_create(load, var);
525 nir_ssa_dest_init(&load->instr, &load->dest, num_components,
526 glsl_get_bit_size(var->type), NULL);
527 nir_builder_instr_insert(build, &load->instr);
528 return &load->dest.ssa;
529 }
530
531 static inline nir_ssa_def *
532 nir_load_deref_var(nir_builder *build, nir_deref_var *deref)
533 {
534 const struct glsl_type *type = nir_deref_tail(&deref->deref)->type;
535 const unsigned num_components = glsl_get_vector_elements(type);
536
537 nir_intrinsic_instr *load =
538 nir_intrinsic_instr_create(build->shader, nir_intrinsic_load_var);
539 load->num_components = num_components;
540 load->variables[0] = nir_deref_var_clone(deref, load);
541 nir_ssa_dest_init(&load->instr, &load->dest, num_components,
542 glsl_get_bit_size(type), NULL);
543 nir_builder_instr_insert(build, &load->instr);
544 return &load->dest.ssa;
545 }
546
547 static inline void
548 nir_store_var(nir_builder *build, nir_variable *var, nir_ssa_def *value,
549 unsigned writemask)
550 {
551 const unsigned num_components = glsl_get_vector_elements(var->type);
552
553 nir_intrinsic_instr *store =
554 nir_intrinsic_instr_create(build->shader, nir_intrinsic_store_var);
555 store->num_components = num_components;
556 nir_intrinsic_set_write_mask(store, writemask);
557 store->variables[0] = nir_deref_var_create(store, var);
558 store->src[0] = nir_src_for_ssa(value);
559 nir_builder_instr_insert(build, &store->instr);
560 }
561
562 static inline void
563 nir_store_deref_var(nir_builder *build, nir_deref_var *deref,
564 nir_ssa_def *value, unsigned writemask)
565 {
566 const unsigned num_components =
567 glsl_get_vector_elements(nir_deref_tail(&deref->deref)->type);
568
569 nir_intrinsic_instr *store =
570 nir_intrinsic_instr_create(build->shader, nir_intrinsic_store_var);
571 store->num_components = num_components;
572 store->const_index[0] = writemask & ((1 << num_components) - 1);
573 store->variables[0] = nir_deref_var_clone(deref, store);
574 store->src[0] = nir_src_for_ssa(value);
575 nir_builder_instr_insert(build, &store->instr);
576 }
577
578 static inline void
579 nir_copy_deref_var(nir_builder *build, nir_deref_var *dest, nir_deref_var *src)
580 {
581 assert(nir_deref_tail(&dest->deref)->type ==
582 nir_deref_tail(&src->deref)->type);
583
584 nir_intrinsic_instr *copy =
585 nir_intrinsic_instr_create(build->shader, nir_intrinsic_copy_var);
586 copy->variables[0] = nir_deref_var_clone(dest, copy);
587 copy->variables[1] = nir_deref_var_clone(src, copy);
588 nir_builder_instr_insert(build, &copy->instr);
589 }
590
591 static inline void
592 nir_copy_var(nir_builder *build, nir_variable *dest, nir_variable *src)
593 {
594 nir_intrinsic_instr *copy =
595 nir_intrinsic_instr_create(build->shader, nir_intrinsic_copy_var);
596 copy->variables[0] = nir_deref_var_create(copy, dest);
597 copy->variables[1] = nir_deref_var_create(copy, src);
598 nir_builder_instr_insert(build, &copy->instr);
599 }
600
601 /* Generic builder for system values. */
602 static inline nir_ssa_def *
603 nir_load_system_value(nir_builder *build, nir_intrinsic_op op, int index)
604 {
605 nir_intrinsic_instr *load = nir_intrinsic_instr_create(build->shader, op);
606 load->num_components = nir_intrinsic_infos[op].dest_components;
607 load->const_index[0] = index;
608 nir_ssa_dest_init(&load->instr, &load->dest,
609 nir_intrinsic_infos[op].dest_components, 32, NULL);
610 nir_builder_instr_insert(build, &load->instr);
611 return &load->dest.ssa;
612 }
613
614 /* Generate custom builders for system values. */
615 #define INTRINSIC(name, num_srcs, src_components, has_dest, dest_components, \
616 num_variables, num_indices, idx0, idx1, idx2, flags)
617 #define LAST_INTRINSIC(name)
618
619 #define DEFINE_SYSTEM_VALUE(name) \
620 static inline nir_ssa_def * \
621 nir_load_##name(nir_builder *build) \
622 { \
623 return nir_load_system_value(build, nir_intrinsic_load_##name, 0); \
624 }
625
626 #include "nir_intrinsics.h"
627
628 static inline nir_ssa_def *
629 nir_load_barycentric(nir_builder *build, nir_intrinsic_op op,
630 unsigned interp_mode)
631 {
632 nir_intrinsic_instr *bary = nir_intrinsic_instr_create(build->shader, op);
633 nir_ssa_dest_init(&bary->instr, &bary->dest, 2, 32, NULL);
634 nir_intrinsic_set_interp_mode(bary, interp_mode);
635 nir_builder_instr_insert(build, &bary->instr);
636 return &bary->dest.ssa;
637 }
638
639 static inline void
640 nir_jump(nir_builder *build, nir_jump_type jump_type)
641 {
642 nir_jump_instr *jump = nir_jump_instr_create(build->shader, jump_type);
643 nir_builder_instr_insert(build, &jump->instr);
644 }
645
646 #endif /* NIR_BUILDER_H */