2 * Copyright © 2014 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
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
24 * Connor Abbott (cwabbott0@gmail.com)
29 #include "c11/threads.h"
33 * This file checks for invalid IR indicating a bug somewhere in the compiler.
36 /* Since this file is just a pile of asserts, don't bother compiling it if
37 * we're not building a debug build.
42 * Per-register validation state.
47 * equivalent to the uses and defs in nir_register, but built up by the
48 * validator. At the end, we verify that the sets have the same entries.
50 struct set
*uses
, *if_uses
, *defs
;
51 nir_function_impl
*where_defined
; /* NULL for global registers */
56 * equivalent to the uses in nir_ssa_def, but built up by the validator.
57 * At the end, we verify that the sets have the same entries.
59 struct set
*uses
, *if_uses
;
60 nir_function_impl
*where_defined
;
61 } ssa_def_validate_state
;
66 /* map of register -> validation state (struct above) */
67 struct hash_table
*regs
;
69 /* the current shader being validated */
72 /* the current instruction being validated */
75 /* the current variable being validated */
78 /* the current basic block being validated */
81 /* the current if statement being validated */
84 /* the current loop being visited */
87 /* the parent of the current cf node being visited */
88 nir_cf_node
*parent_node
;
90 /* the current function implementation being validated */
91 nir_function_impl
*impl
;
93 /* map of SSA value -> function implementation where it is defined */
94 struct hash_table
*ssa_defs
;
96 /* bitset of ssa definitions we have found; used to check uniqueness */
97 BITSET_WORD
*ssa_defs_found
;
99 /* bitset of registers we have currently found; used to check uniqueness */
100 BITSET_WORD
*regs_found
;
102 /* map of variable -> function implementation where it is defined or NULL
103 * if it is a global variable
105 struct hash_table
*var_defs
;
107 /* map of instruction/var/etc to failed assert string */
108 struct hash_table
*errors
;
112 log_error(validate_state
*state
, const char *cond
, const char *file
, int line
)
123 char *msg
= ralloc_asprintf(state
->errors
, "error: %s (%s:%d)",
126 _mesa_hash_table_insert(state
->errors
, obj
, msg
);
129 #define validate_assert(state, cond) do { \
131 log_error(state, #cond, __FILE__, __LINE__); \
134 static void validate_src(nir_src
*src
, validate_state
*state
,
135 unsigned bit_sizes
, unsigned num_components
);
138 validate_reg_src(nir_src
*src
, validate_state
*state
,
139 unsigned bit_sizes
, unsigned num_components
)
141 validate_assert(state
, src
->reg
.reg
!= NULL
);
143 struct hash_entry
*entry
;
144 entry
= _mesa_hash_table_search(state
->regs
, src
->reg
.reg
);
145 validate_assert(state
, entry
);
147 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
150 _mesa_set_add(reg_state
->uses
, src
);
152 validate_assert(state
, state
->if_stmt
);
153 _mesa_set_add(reg_state
->if_uses
, src
);
156 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
157 "using a register declared in a different function");
160 validate_assert(state
, src
->reg
.reg
->bit_size
& bit_sizes
);
162 validate_assert(state
, src
->reg
.reg
->num_components
== num_components
);
164 validate_assert(state
, (src
->reg
.reg
->num_array_elems
== 0 ||
165 src
->reg
.base_offset
< src
->reg
.reg
->num_array_elems
) &&
166 "definitely out-of-bounds array access");
168 if (src
->reg
.indirect
) {
169 validate_assert(state
, src
->reg
.reg
->num_array_elems
!= 0);
170 validate_assert(state
, (src
->reg
.indirect
->is_ssa
||
171 src
->reg
.indirect
->reg
.indirect
== NULL
) &&
172 "only one level of indirection allowed");
173 validate_src(src
->reg
.indirect
, state
, 32, 1);
178 validate_ssa_src(nir_src
*src
, validate_state
*state
,
179 unsigned bit_sizes
, unsigned num_components
)
181 validate_assert(state
, src
->ssa
!= NULL
);
183 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, src
->ssa
);
185 validate_assert(state
, entry
);
190 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
192 validate_assert(state
, def_state
->where_defined
== state
->impl
&&
193 "using an SSA value defined in a different function");
196 _mesa_set_add(def_state
->uses
, src
);
198 validate_assert(state
, state
->if_stmt
);
199 _mesa_set_add(def_state
->if_uses
, src
);
203 validate_assert(state
, src
->ssa
->bit_size
& bit_sizes
);
205 validate_assert(state
, src
->ssa
->num_components
== num_components
);
207 /* TODO validate that the use is dominated by the definition */
211 validate_src(nir_src
*src
, validate_state
*state
,
212 unsigned bit_sizes
, unsigned num_components
)
215 validate_assert(state
, src
->parent_instr
== state
->instr
);
217 validate_assert(state
, src
->parent_if
== state
->if_stmt
);
220 validate_ssa_src(src
, state
, bit_sizes
, num_components
);
222 validate_reg_src(src
, state
, bit_sizes
, num_components
);
226 validate_alu_src(nir_alu_instr
*instr
, unsigned index
, validate_state
*state
)
228 nir_alu_src
*src
= &instr
->src
[index
];
230 unsigned num_components
= nir_src_num_components(src
->src
);
231 for (unsigned i
= 0; i
< NIR_MAX_VEC_COMPONENTS
; i
++) {
232 validate_assert(state
, src
->swizzle
[i
] < NIR_MAX_VEC_COMPONENTS
);
234 if (nir_alu_instr_channel_used(instr
, index
, i
))
235 validate_assert(state
, src
->swizzle
[i
] < num_components
);
238 validate_src(&src
->src
, state
, 0, 0);
242 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
243 unsigned bit_sizes
, unsigned num_components
)
245 validate_assert(state
, dest
->reg
!= NULL
);
247 validate_assert(state
, dest
->parent_instr
== state
->instr
);
249 struct hash_entry
*entry2
;
250 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
252 validate_assert(state
, entry2
);
254 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
255 _mesa_set_add(reg_state
->defs
, dest
);
257 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
258 "writing to a register declared in a different function");
261 validate_assert(state
, dest
->reg
->bit_size
& bit_sizes
);
263 validate_assert(state
, dest
->reg
->num_components
== num_components
);
265 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
266 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
267 "definitely out-of-bounds array access");
269 if (dest
->indirect
) {
270 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
271 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
272 "only one level of indirection allowed");
273 validate_src(dest
->indirect
, state
, 32, 1);
278 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
280 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
281 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
282 BITSET_SET(state
->ssa_defs_found
, def
->index
);
284 validate_assert(state
, def
->parent_instr
== state
->instr
);
286 validate_assert(state
, (def
->num_components
<= 4) ||
287 (def
->num_components
== 8) ||
288 (def
->num_components
== 16));
290 list_validate(&def
->uses
);
291 list_validate(&def
->if_uses
);
293 ssa_def_validate_state
*def_state
= ralloc(state
->ssa_defs
,
294 ssa_def_validate_state
);
295 def_state
->where_defined
= state
->impl
;
296 def_state
->uses
= _mesa_pointer_set_create(def_state
);
297 def_state
->if_uses
= _mesa_pointer_set_create(def_state
);
298 _mesa_hash_table_insert(state
->ssa_defs
, def
, def_state
);
302 validate_dest(nir_dest
*dest
, validate_state
*state
,
303 unsigned bit_sizes
, unsigned num_components
)
307 validate_assert(state
, dest
->ssa
.bit_size
& bit_sizes
);
309 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
310 validate_ssa_def(&dest
->ssa
, state
);
312 validate_reg_dest(&dest
->reg
, state
, bit_sizes
, num_components
);
317 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
319 nir_alu_dest
*dest
= &instr
->dest
;
321 unsigned dest_size
= nir_dest_num_components(dest
->dest
);
323 * validate that the instruction doesn't write to components not in the
326 validate_assert(state
, !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
328 /* validate that saturate is only ever used on instructions with
329 * destinations of type float
331 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
332 validate_assert(state
,
333 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
337 validate_dest(&dest
->dest
, state
, 0, 0);
341 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
343 validate_assert(state
, instr
->op
< nir_num_opcodes
);
345 unsigned instr_bit_size
= 0;
346 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
347 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
348 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
349 if (nir_alu_type_get_type_size(src_type
)) {
350 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
351 } else if (instr_bit_size
) {
352 validate_assert(state
, src_bit_size
== instr_bit_size
);
354 instr_bit_size
= src_bit_size
;
357 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
358 /* 8-bit float isn't a thing */
359 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
363 validate_alu_src(instr
, i
, state
);
366 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
367 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
368 if (nir_alu_type_get_type_size(dest_type
)) {
369 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
370 } else if (instr_bit_size
) {
371 validate_assert(state
, dest_bit_size
== instr_bit_size
);
373 /* The only unsized thing is the destination so it's vacuously valid */
376 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
377 /* 8-bit float isn't a thing */
378 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
379 dest_bit_size
== 64);
382 validate_alu_dest(instr
, state
);
386 validate_var_use(nir_variable
*var
, validate_state
*state
)
388 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
389 validate_assert(state
, entry
);
390 if (var
->data
.mode
== nir_var_function_temp
)
391 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
395 validate_deref_instr(nir_deref_instr
*instr
, validate_state
*state
)
397 if (instr
->deref_type
== nir_deref_type_var
) {
398 /* Variable dereferences are stupid simple. */
399 validate_assert(state
, instr
->mode
== instr
->var
->data
.mode
);
400 validate_assert(state
, instr
->type
== instr
->var
->type
);
401 validate_var_use(instr
->var
, state
);
402 } else if (instr
->deref_type
== nir_deref_type_cast
) {
403 /* For cast, we simply have to trust the instruction. It's up to
404 * lowering passes and front/back-ends to make them sane.
406 validate_src(&instr
->parent
, state
, 0, 0);
408 /* We just validate that the type and mode are there */
409 validate_assert(state
, instr
->mode
);
410 validate_assert(state
, instr
->type
);
412 /* We require the parent to be SSA. This may be lifted in the future */
413 validate_assert(state
, instr
->parent
.is_ssa
);
415 /* The parent pointer value must have the same number of components
416 * as the destination.
418 validate_src(&instr
->parent
, state
, nir_dest_bit_size(instr
->dest
),
419 nir_dest_num_components(instr
->dest
));
421 nir_instr
*parent_instr
= instr
->parent
.ssa
->parent_instr
;
423 /* The parent must come from another deref instruction */
424 validate_assert(state
, parent_instr
->type
== nir_instr_type_deref
);
426 nir_deref_instr
*parent
= nir_instr_as_deref(parent_instr
);
428 validate_assert(state
, instr
->mode
== parent
->mode
);
430 switch (instr
->deref_type
) {
431 case nir_deref_type_struct
:
432 validate_assert(state
, glsl_type_is_struct_or_ifc(parent
->type
));
433 validate_assert(state
,
434 instr
->strct
.index
< glsl_get_length(parent
->type
));
435 validate_assert(state
, instr
->type
==
436 glsl_get_struct_field(parent
->type
, instr
->strct
.index
));
439 case nir_deref_type_array
:
440 case nir_deref_type_array_wildcard
:
441 if (instr
->mode
== nir_var_mem_ubo
||
442 instr
->mode
== nir_var_mem_ssbo
||
443 instr
->mode
== nir_var_mem_shared
||
444 instr
->mode
== nir_var_mem_global
) {
445 /* Shared variables and UBO/SSBOs have a bit more relaxed rules
446 * because we need to be able to handle array derefs on vectors.
447 * Fortunately, nir_lower_io handles these just fine.
449 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
450 glsl_type_is_matrix(parent
->type
) ||
451 glsl_type_is_vector(parent
->type
));
453 /* Most of NIR cannot handle array derefs on vectors */
454 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
455 glsl_type_is_matrix(parent
->type
));
457 validate_assert(state
,
458 instr
->type
== glsl_get_array_element(parent
->type
));
460 if (instr
->deref_type
== nir_deref_type_array
) {
461 validate_src(&instr
->arr
.index
, state
,
462 nir_dest_bit_size(instr
->dest
), 1);
466 case nir_deref_type_ptr_as_array
:
467 /* ptr_as_array derefs must have a parent that is either an array,
468 * ptr_as_array, or cast. If the parent is a cast, we get the stride
469 * information (if any) from the cast deref.
471 validate_assert(state
,
472 parent
->deref_type
== nir_deref_type_array
||
473 parent
->deref_type
== nir_deref_type_ptr_as_array
||
474 parent
->deref_type
== nir_deref_type_cast
);
475 validate_src(&instr
->arr
.index
, state
,
476 nir_dest_bit_size(instr
->dest
), 1);
480 unreachable("Invalid deref instruction type");
484 /* We intentionally don't validate the size of the destination because we
485 * want to let other compiler components such as SPIR-V decide how big
486 * pointers should be.
488 validate_dest(&instr
->dest
, state
, 0, 0);
490 /* Deref instructions as if conditions don't make sense because if
491 * conditions expect well-formed Booleans. If you want to compare with
492 * NULL, an explicit comparison operation should be used.
494 validate_assert(state
, list_empty(&instr
->dest
.ssa
.if_uses
));
498 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
500 unsigned dest_bit_size
= 0;
501 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
502 switch (instr
->intrinsic
) {
503 case nir_intrinsic_load_param
: {
504 unsigned param_idx
= nir_intrinsic_param_idx(instr
);
505 validate_assert(state
, param_idx
< state
->impl
->function
->num_params
);
506 nir_parameter
*param
= &state
->impl
->function
->params
[param_idx
];
507 validate_assert(state
, instr
->num_components
== param
->num_components
);
508 dest_bit_size
= param
->bit_size
;
512 case nir_intrinsic_load_deref
: {
513 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[0]);
514 validate_assert(state
, glsl_type_is_vector_or_scalar(src
->type
) ||
515 (src
->mode
== nir_var_uniform
&&
516 glsl_get_base_type(src
->type
) == GLSL_TYPE_SUBROUTINE
));
517 validate_assert(state
, instr
->num_components
==
518 glsl_get_vector_elements(src
->type
));
519 dest_bit_size
= glsl_get_bit_size(src
->type
);
520 /* Also allow 32-bit boolean load operations */
521 if (glsl_type_is_boolean(src
->type
))
526 case nir_intrinsic_store_deref
: {
527 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
528 validate_assert(state
, glsl_type_is_vector_or_scalar(dst
->type
));
529 validate_assert(state
, instr
->num_components
==
530 glsl_get_vector_elements(dst
->type
));
531 src_bit_sizes
[1] = glsl_get_bit_size(dst
->type
);
532 /* Also allow 32-bit boolean store operations */
533 if (glsl_type_is_boolean(dst
->type
))
534 src_bit_sizes
[1] |= 32;
535 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
536 nir_var_uniform
)) == 0);
537 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
541 case nir_intrinsic_copy_deref
: {
542 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
543 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[1]);
544 validate_assert(state
, glsl_get_bare_type(dst
->type
) ==
545 glsl_get_bare_type(src
->type
));
546 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
547 nir_var_uniform
)) == 0);
555 unsigned num_srcs
= nir_intrinsic_infos
[instr
->intrinsic
].num_srcs
;
556 for (unsigned i
= 0; i
< num_srcs
; i
++) {
557 unsigned components_read
= nir_intrinsic_src_components(instr
, i
);
559 validate_assert(state
, components_read
> 0);
561 validate_src(&instr
->src
[i
], state
, src_bit_sizes
[i
], components_read
);
564 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
565 unsigned components_written
= nir_intrinsic_dest_components(instr
);
566 unsigned bit_sizes
= nir_intrinsic_infos
[instr
->intrinsic
].dest_bit_sizes
;
568 validate_assert(state
, components_written
> 0);
570 if (dest_bit_size
&& bit_sizes
)
571 validate_assert(state
, dest_bit_size
& bit_sizes
);
573 dest_bit_size
= dest_bit_size
? dest_bit_size
: bit_sizes
;
575 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
580 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
582 bool src_type_seen
[nir_num_tex_src_types
];
583 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
584 src_type_seen
[i
] = false;
586 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
587 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
588 src_type_seen
[instr
->src
[i
].src_type
] = true;
589 validate_src(&instr
->src
[i
].src
, state
,
590 0, nir_tex_instr_src_size(instr
, i
));
592 switch (instr
->src
[i
].src_type
) {
593 case nir_tex_src_texture_deref
:
594 case nir_tex_src_sampler_deref
:
595 validate_assert(state
, instr
->src
[i
].src
.is_ssa
);
596 validate_assert(state
,
597 instr
->src
[i
].src
.ssa
->parent_instr
->type
== nir_instr_type_deref
);
604 if (nir_tex_instr_has_explicit_tg4_offsets(instr
)) {
605 validate_assert(state
, instr
->op
== nir_texop_tg4
);
606 validate_assert(state
, !src_type_seen
[nir_tex_src_offset
]);
609 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
613 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
615 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
617 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
618 validate_src(&instr
->params
[i
], state
,
619 instr
->callee
->params
[i
].bit_size
,
620 instr
->callee
->params
[i
].num_components
);
625 validate_const_value(nir_const_value
*val
, unsigned bit_size
,
626 validate_state
*state
)
628 /* In order for block copies to work properly for things like instruction
629 * comparisons and [de]serialization, we require the unused bits of the
630 * nir_const_value to be zero.
632 nir_const_value cmp_val
;
633 memset(&cmp_val
, 0, sizeof(cmp_val
));
639 cmp_val
.u8
= val
->u8
;
642 cmp_val
.u16
= val
->u16
;
645 cmp_val
.u32
= val
->u32
;
648 cmp_val
.u64
= val
->u64
;
651 validate_assert(state
, !"Invalid load_const bit size");
653 validate_assert(state
, memcmp(val
, &cmp_val
, sizeof(cmp_val
)) == 0);
657 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
659 validate_ssa_def(&instr
->def
, state
);
661 for (unsigned i
= 0; i
< instr
->def
.num_components
; i
++)
662 validate_const_value(&instr
->value
[i
], instr
->def
.bit_size
, state
);
666 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
668 validate_ssa_def(&instr
->def
, state
);
672 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
675 * don't validate the sources until we get to them from their predecessor
676 * basic blocks, to avoid validating an SSA use before its definition.
679 validate_dest(&instr
->dest
, state
, 0, 0);
681 exec_list_validate(&instr
->srcs
);
682 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
683 state
->block
->predecessors
->entries
);
687 validate_instr(nir_instr
*instr
, validate_state
*state
)
689 validate_assert(state
, instr
->block
== state
->block
);
691 state
->instr
= instr
;
693 switch (instr
->type
) {
694 case nir_instr_type_alu
:
695 validate_alu_instr(nir_instr_as_alu(instr
), state
);
698 case nir_instr_type_deref
:
699 validate_deref_instr(nir_instr_as_deref(instr
), state
);
702 case nir_instr_type_call
:
703 validate_call_instr(nir_instr_as_call(instr
), state
);
706 case nir_instr_type_intrinsic
:
707 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
710 case nir_instr_type_tex
:
711 validate_tex_instr(nir_instr_as_tex(instr
), state
);
714 case nir_instr_type_load_const
:
715 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
718 case nir_instr_type_phi
:
719 validate_phi_instr(nir_instr_as_phi(instr
), state
);
722 case nir_instr_type_ssa_undef
:
723 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
726 case nir_instr_type_jump
:
730 validate_assert(state
, !"Invalid ALU instruction type");
738 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
740 state
->instr
= &instr
->instr
;
742 validate_assert(state
, instr
->dest
.is_ssa
);
744 exec_list_validate(&instr
->srcs
);
745 nir_foreach_phi_src(src
, instr
) {
746 if (src
->pred
== pred
) {
747 validate_assert(state
, src
->src
.is_ssa
);
748 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
749 instr
->dest
.ssa
.num_components
);
759 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
761 nir_foreach_instr(instr
, succ
) {
762 if (instr
->type
!= nir_instr_type_phi
)
765 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
769 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
772 validate_block(nir_block
*block
, validate_state
*state
)
774 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
776 state
->block
= block
;
778 exec_list_validate(&block
->instr_list
);
779 nir_foreach_instr(instr
, block
) {
780 if (instr
->type
== nir_instr_type_phi
) {
781 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
782 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
785 if (instr
->type
== nir_instr_type_jump
) {
786 validate_assert(state
, instr
== nir_block_last_instr(block
));
789 validate_instr(instr
, state
);
792 validate_assert(state
, block
->successors
[0] != NULL
);
793 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
795 for (unsigned i
= 0; i
< 2; i
++) {
796 if (block
->successors
[i
] != NULL
) {
797 struct set_entry
*entry
=
798 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
799 validate_assert(state
, entry
);
801 validate_phi_srcs(block
, block
->successors
[i
], state
);
805 set_foreach(block
->predecessors
, entry
) {
806 const nir_block
*pred
= entry
->key
;
807 validate_assert(state
, pred
->successors
[0] == block
||
808 pred
->successors
[1] == block
);
811 if (!exec_list_is_empty(&block
->instr_list
) &&
812 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
813 validate_assert(state
, block
->successors
[1] == NULL
);
814 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
815 switch (jump
->type
) {
816 case nir_jump_break
: {
818 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
819 validate_assert(state
, block
->successors
[0] == after
);
823 case nir_jump_continue
: {
824 nir_block
*first
= nir_loop_first_block(state
->loop
);
825 validate_assert(state
, block
->successors
[0] == first
);
829 case nir_jump_return
:
830 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
834 unreachable("bad jump type");
837 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
839 switch (state
->parent_node
->type
) {
840 case nir_cf_node_loop
: {
841 nir_block
*first
= nir_loop_first_block(state
->loop
);
842 validate_assert(state
, block
->successors
[0] == first
);
843 /* due to the hack for infinite loops, block->successors[1] may
844 * point to the block after the loop.
849 case nir_cf_node_if
: {
851 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
852 validate_assert(state
, block
->successors
[0] == after
);
853 validate_assert(state
, block
->successors
[1] == NULL
);
857 case nir_cf_node_function
:
858 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
859 validate_assert(state
, block
->successors
[1] == NULL
);
863 unreachable("unknown control flow node type");
866 if (next
->type
== nir_cf_node_if
) {
867 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
868 validate_assert(state
, block
->successors
[0] ==
869 nir_if_first_then_block(if_stmt
));
870 validate_assert(state
, block
->successors
[1] ==
871 nir_if_first_else_block(if_stmt
));
873 validate_assert(state
, next
->type
== nir_cf_node_loop
);
874 nir_loop
*loop
= nir_cf_node_as_loop(next
);
875 validate_assert(state
, block
->successors
[0] ==
876 nir_loop_first_block(loop
));
877 validate_assert(state
, block
->successors
[1] == NULL
);
884 validate_if(nir_if
*if_stmt
, validate_state
*state
)
886 state
->if_stmt
= if_stmt
;
888 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
889 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
890 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
892 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
893 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
894 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
896 validate_src(&if_stmt
->condition
, state
, 0, 1);
898 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
899 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
901 nir_cf_node
*old_parent
= state
->parent_node
;
902 state
->parent_node
= &if_stmt
->cf_node
;
904 exec_list_validate(&if_stmt
->then_list
);
905 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
906 validate_cf_node(cf_node
, state
);
909 exec_list_validate(&if_stmt
->else_list
);
910 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
911 validate_cf_node(cf_node
, state
);
914 state
->parent_node
= old_parent
;
915 state
->if_stmt
= NULL
;
919 validate_loop(nir_loop
*loop
, validate_state
*state
)
921 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
922 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
923 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
925 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
926 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
927 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
929 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
931 nir_cf_node
*old_parent
= state
->parent_node
;
932 state
->parent_node
= &loop
->cf_node
;
933 nir_loop
*old_loop
= state
->loop
;
936 exec_list_validate(&loop
->body
);
937 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
938 validate_cf_node(cf_node
, state
);
941 state
->parent_node
= old_parent
;
942 state
->loop
= old_loop
;
946 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
948 validate_assert(state
, node
->parent
== state
->parent_node
);
950 switch (node
->type
) {
951 case nir_cf_node_block
:
952 validate_block(nir_cf_node_as_block(node
), state
);
956 validate_if(nir_cf_node_as_if(node
), state
);
959 case nir_cf_node_loop
:
960 validate_loop(nir_cf_node_as_loop(node
), state
);
964 unreachable("Invalid CF node type");
969 prevalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
971 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
972 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
973 BITSET_SET(state
->regs_found
, reg
->index
);
975 list_validate(®
->uses
);
976 list_validate(®
->defs
);
977 list_validate(®
->if_uses
);
979 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
980 reg_state
->uses
= _mesa_pointer_set_create(reg_state
);
981 reg_state
->if_uses
= _mesa_pointer_set_create(reg_state
);
982 reg_state
->defs
= _mesa_pointer_set_create(reg_state
);
984 reg_state
->where_defined
= state
->impl
;
986 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
990 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
992 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
995 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
997 nir_foreach_use(src
, reg
) {
998 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
999 validate_assert(state
, entry
);
1000 _mesa_set_remove(reg_state
->uses
, entry
);
1003 if (reg_state
->uses
->entries
!= 0) {
1004 printf("extra entries in register uses:\n");
1005 set_foreach(reg_state
->uses
, entry
)
1006 printf("%p\n", entry
->key
);
1011 nir_foreach_if_use(src
, reg
) {
1012 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
1013 validate_assert(state
, entry
);
1014 _mesa_set_remove(reg_state
->if_uses
, entry
);
1017 if (reg_state
->if_uses
->entries
!= 0) {
1018 printf("extra entries in register if_uses:\n");
1019 set_foreach(reg_state
->if_uses
, entry
)
1020 printf("%p\n", entry
->key
);
1025 nir_foreach_def(src
, reg
) {
1026 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
1027 validate_assert(state
, entry
);
1028 _mesa_set_remove(reg_state
->defs
, entry
);
1031 if (reg_state
->defs
->entries
!= 0) {
1032 printf("extra entries in register defs:\n");
1033 set_foreach(reg_state
->defs
, entry
)
1034 printf("%p\n", entry
->key
);
1041 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
1045 validate_assert(state
, is_global
== nir_variable_is_global(var
));
1047 /* Must have exactly one mode set */
1048 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
1050 if (var
->data
.compact
) {
1051 /* The "compact" flag is only valid on arrays of scalars. */
1052 assert(glsl_type_is_array(var
->type
));
1054 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
1055 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
1056 assert(glsl_type_is_array(type
));
1057 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
1059 assert(glsl_type_is_scalar(type
));
1063 if (var
->num_members
> 0) {
1064 const struct glsl_type
*without_array
= glsl_without_array(var
->type
);
1065 validate_assert(state
, glsl_type_is_struct_or_ifc(without_array
));
1066 validate_assert(state
, var
->num_members
== glsl_get_length(without_array
));
1067 validate_assert(state
, var
->members
!= NULL
);
1071 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1075 _mesa_hash_table_insert(state
->var_defs
, var
,
1076 is_global
? NULL
: state
->impl
);
1082 postvalidate_ssa_def(nir_ssa_def
*def
, void *void_state
)
1084 validate_state
*state
= void_state
;
1086 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, def
);
1089 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
1091 nir_foreach_use(src
, def
) {
1092 struct set_entry
*entry
= _mesa_set_search(def_state
->uses
, src
);
1093 validate_assert(state
, entry
);
1094 _mesa_set_remove(def_state
->uses
, entry
);
1097 if (def_state
->uses
->entries
!= 0) {
1098 printf("extra entries in SSA def uses:\n");
1099 set_foreach(def_state
->uses
, entry
)
1100 printf("%p\n", entry
->key
);
1105 nir_foreach_if_use(src
, def
) {
1106 struct set_entry
*entry
= _mesa_set_search(def_state
->if_uses
, src
);
1107 validate_assert(state
, entry
);
1108 _mesa_set_remove(def_state
->if_uses
, entry
);
1111 if (def_state
->if_uses
->entries
!= 0) {
1112 printf("extra entries in SSA def uses:\n");
1113 set_foreach(def_state
->if_uses
, entry
)
1114 printf("%p\n", entry
->key
);
1123 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1125 validate_assert(state
, impl
->function
->impl
== impl
);
1126 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1128 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1129 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1130 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1133 state
->parent_node
= &impl
->cf_node
;
1135 exec_list_validate(&impl
->locals
);
1136 nir_foreach_variable(var
, &impl
->locals
) {
1137 validate_var_decl(var
, false, state
);
1140 state
->regs_found
= reralloc(state
->mem_ctx
, state
->regs_found
,
1141 BITSET_WORD
, BITSET_WORDS(impl
->reg_alloc
));
1142 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1143 sizeof(BITSET_WORD
));
1144 exec_list_validate(&impl
->registers
);
1145 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1146 prevalidate_reg_decl(reg
, state
);
1149 state
->ssa_defs_found
= reralloc(state
->mem_ctx
, state
->ssa_defs_found
,
1150 BITSET_WORD
, BITSET_WORDS(impl
->ssa_alloc
));
1151 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1152 sizeof(BITSET_WORD
));
1153 exec_list_validate(&impl
->body
);
1154 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1155 validate_cf_node(node
, state
);
1158 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1159 postvalidate_reg_decl(reg
, state
);
1162 nir_foreach_block(block
, impl
) {
1163 nir_foreach_instr(instr
, block
)
1164 nir_foreach_ssa_def(instr
, postvalidate_ssa_def
, state
);
1169 validate_function(nir_function
*func
, validate_state
*state
)
1171 if (func
->impl
!= NULL
) {
1172 validate_assert(state
, func
->impl
->function
== func
);
1173 validate_function_impl(func
->impl
, state
);
1178 init_validate_state(validate_state
*state
)
1180 state
->mem_ctx
= ralloc_context(NULL
);
1181 state
->regs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1182 state
->ssa_defs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1183 state
->ssa_defs_found
= NULL
;
1184 state
->regs_found
= NULL
;
1185 state
->var_defs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1186 state
->errors
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1189 state
->instr
= NULL
;
1194 destroy_validate_state(validate_state
*state
)
1196 ralloc_free(state
->mem_ctx
);
1199 mtx_t fail_dump_mutex
= _MTX_INITIALIZER_NP
;
1202 dump_errors(validate_state
*state
, const char *when
)
1204 struct hash_table
*errors
= state
->errors
;
1206 /* Lock around dumping so that we get clean dumps in a multi-threaded
1209 mtx_lock(&fail_dump_mutex
);
1212 fprintf(stderr
, "NIR validation failed %s\n", when
);
1213 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1215 fprintf(stderr
, "NIR validation failed with %d errors:\n",
1216 _mesa_hash_table_num_entries(errors
));
1219 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1221 if (_mesa_hash_table_num_entries(errors
) > 0) {
1222 fprintf(stderr
, "%d additional errors:\n",
1223 _mesa_hash_table_num_entries(errors
));
1224 hash_table_foreach(errors
, entry
) {
1225 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1229 mtx_unlock(&fail_dump_mutex
);
1235 nir_validate_shader(nir_shader
*shader
, const char *when
)
1237 static int should_validate
= -1;
1238 if (should_validate
< 0)
1239 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1240 if (!should_validate
)
1243 validate_state state
;
1244 init_validate_state(&state
);
1246 state
.shader
= shader
;
1248 exec_list_validate(&shader
->uniforms
);
1249 nir_foreach_variable(var
, &shader
->uniforms
) {
1250 validate_var_decl(var
, true, &state
);
1253 exec_list_validate(&shader
->inputs
);
1254 nir_foreach_variable(var
, &shader
->inputs
) {
1255 validate_var_decl(var
, true, &state
);
1258 exec_list_validate(&shader
->outputs
);
1259 nir_foreach_variable(var
, &shader
->outputs
) {
1260 validate_var_decl(var
, true, &state
);
1263 exec_list_validate(&shader
->shared
);
1264 nir_foreach_variable(var
, &shader
->shared
) {
1265 validate_var_decl(var
, true, &state
);
1268 exec_list_validate(&shader
->globals
);
1269 nir_foreach_variable(var
, &shader
->globals
) {
1270 validate_var_decl(var
, true, &state
);
1273 exec_list_validate(&shader
->system_values
);
1274 nir_foreach_variable(var
, &shader
->system_values
) {
1275 validate_var_decl(var
, true, &state
);
1278 exec_list_validate(&shader
->functions
);
1279 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1280 validate_function(func
, &state
);
1283 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1284 dump_errors(&state
, when
);
1286 destroy_validate_state(&state
);