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)
32 * This file checks for invalid IR indicating a bug somewhere in the compiler.
35 /* Since this file is just a pile of asserts, don't bother compiling it if
36 * we're not building a debug build.
41 * Per-register validation state.
46 * equivalent to the uses and defs in nir_register, but built up by the
47 * validator. At the end, we verify that the sets have the same entries.
49 struct set
*uses
, *if_uses
, *defs
;
50 nir_function_impl
*where_defined
; /* NULL for global registers */
55 * equivalent to the uses in nir_ssa_def, but built up by the validator.
56 * At the end, we verify that the sets have the same entries.
58 struct set
*uses
, *if_uses
;
59 nir_function_impl
*where_defined
;
60 } ssa_def_validate_state
;
63 /* map of register -> validation state (struct above) */
64 struct hash_table
*regs
;
66 /* the current shader being validated */
69 /* the current instruction being validated */
72 /* the current variable being validated */
75 /* the current basic block being validated */
78 /* the current if statement being validated */
81 /* the current loop being visited */
84 /* the parent of the current cf node being visited */
85 nir_cf_node
*parent_node
;
87 /* the current function implementation being validated */
88 nir_function_impl
*impl
;
90 /* map of SSA value -> function implementation where it is defined */
91 struct hash_table
*ssa_defs
;
93 /* bitset of ssa definitions we have found; used to check uniqueness */
94 BITSET_WORD
*ssa_defs_found
;
96 /* bitset of registers we have currently found; used to check uniqueness */
97 BITSET_WORD
*regs_found
;
99 /* map of variable -> function implementation where it is defined or NULL
100 * if it is a global variable
102 struct hash_table
*var_defs
;
104 /* map of instruction/var/etc to failed assert string */
105 struct hash_table
*errors
;
109 log_error(validate_state
*state
, const char *cond
, const char *file
, int line
)
120 char *msg
= ralloc_asprintf(state
->errors
, "error: %s (%s:%d)",
123 _mesa_hash_table_insert(state
->errors
, obj
, msg
);
126 #define validate_assert(state, cond) do { \
128 log_error(state, #cond, __FILE__, __LINE__); \
131 static void validate_src(nir_src
*src
, validate_state
*state
,
132 unsigned bit_size
, unsigned num_components
);
135 validate_reg_src(nir_src
*src
, validate_state
*state
,
136 unsigned bit_size
, unsigned num_components
)
138 validate_assert(state
, src
->reg
.reg
!= NULL
);
140 struct hash_entry
*entry
;
141 entry
= _mesa_hash_table_search(state
->regs
, src
->reg
.reg
);
142 validate_assert(state
, entry
);
144 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
147 _mesa_set_add(reg_state
->uses
, src
);
149 validate_assert(state
, state
->if_stmt
);
150 _mesa_set_add(reg_state
->if_uses
, src
);
153 if (!src
->reg
.reg
->is_global
) {
154 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
155 "using a register declared in a different function");
158 if (!src
->reg
.reg
->is_packed
) {
160 validate_assert(state
, src
->reg
.reg
->bit_size
== bit_size
);
162 validate_assert(state
, src
->reg
.reg
->num_components
== num_components
);
165 validate_assert(state
, (src
->reg
.reg
->num_array_elems
== 0 ||
166 src
->reg
.base_offset
< src
->reg
.reg
->num_array_elems
) &&
167 "definitely out-of-bounds array access");
169 if (src
->reg
.indirect
) {
170 validate_assert(state
, src
->reg
.reg
->num_array_elems
!= 0);
171 validate_assert(state
, (src
->reg
.indirect
->is_ssa
||
172 src
->reg
.indirect
->reg
.indirect
== NULL
) &&
173 "only one level of indirection allowed");
174 validate_src(src
->reg
.indirect
, state
, 32, 1);
179 validate_ssa_src(nir_src
*src
, validate_state
*state
,
180 unsigned bit_size
, unsigned num_components
)
182 validate_assert(state
, src
->ssa
!= NULL
);
184 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, src
->ssa
);
186 validate_assert(state
, entry
);
191 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
193 validate_assert(state
, def_state
->where_defined
== state
->impl
&&
194 "using an SSA value defined in a different function");
197 _mesa_set_add(def_state
->uses
, src
);
199 validate_assert(state
, state
->if_stmt
);
200 _mesa_set_add(def_state
->if_uses
, src
);
204 validate_assert(state
, src
->ssa
->bit_size
== bit_size
);
206 validate_assert(state
, src
->ssa
->num_components
== num_components
);
208 /* TODO validate that the use is dominated by the definition */
212 validate_src(nir_src
*src
, validate_state
*state
,
213 unsigned bit_size
, unsigned num_components
)
216 validate_assert(state
, src
->parent_instr
== state
->instr
);
218 validate_assert(state
, src
->parent_if
== state
->if_stmt
);
221 validate_ssa_src(src
, state
, bit_size
, num_components
);
223 validate_reg_src(src
, state
, bit_size
, num_components
);
227 validate_alu_src(nir_alu_instr
*instr
, unsigned index
, validate_state
*state
)
229 nir_alu_src
*src
= &instr
->src
[index
];
231 unsigned num_components
= nir_src_num_components(src
->src
);
232 if (!src
->src
.is_ssa
&& src
->src
.reg
.reg
->is_packed
)
233 num_components
= NIR_MAX_VEC_COMPONENTS
; /* can't check anything */
234 for (unsigned i
= 0; i
< NIR_MAX_VEC_COMPONENTS
; i
++) {
235 validate_assert(state
, src
->swizzle
[i
] < NIR_MAX_VEC_COMPONENTS
);
237 if (nir_alu_instr_channel_used(instr
, index
, i
))
238 validate_assert(state
, src
->swizzle
[i
] < num_components
);
241 validate_src(&src
->src
, state
, 0, 0);
245 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
246 unsigned bit_size
, unsigned num_components
)
248 validate_assert(state
, dest
->reg
!= NULL
);
250 validate_assert(state
, dest
->parent_instr
== state
->instr
);
252 struct hash_entry
*entry2
;
253 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
255 validate_assert(state
, entry2
);
257 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
258 _mesa_set_add(reg_state
->defs
, dest
);
260 if (!dest
->reg
->is_global
) {
261 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
262 "writing to a register declared in a different function");
265 if (!dest
->reg
->is_packed
) {
267 validate_assert(state
, dest
->reg
->bit_size
== bit_size
);
269 validate_assert(state
, dest
->reg
->num_components
== num_components
);
272 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
273 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
274 "definitely out-of-bounds array access");
276 if (dest
->indirect
) {
277 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
278 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
279 "only one level of indirection allowed");
280 validate_src(dest
->indirect
, state
, 32, 1);
285 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
287 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
288 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
289 BITSET_SET(state
->ssa_defs_found
, def
->index
);
291 validate_assert(state
, def
->parent_instr
== state
->instr
);
293 validate_assert(state
, (def
->num_components
<= 4) ||
294 (def
->num_components
== 8) ||
295 (def
->num_components
== 16));
297 list_validate(&def
->uses
);
298 list_validate(&def
->if_uses
);
300 ssa_def_validate_state
*def_state
= ralloc(state
->ssa_defs
,
301 ssa_def_validate_state
);
302 def_state
->where_defined
= state
->impl
;
303 def_state
->uses
= _mesa_set_create(def_state
, _mesa_hash_pointer
,
304 _mesa_key_pointer_equal
);
305 def_state
->if_uses
= _mesa_set_create(def_state
, _mesa_hash_pointer
,
306 _mesa_key_pointer_equal
);
307 _mesa_hash_table_insert(state
->ssa_defs
, def
, def_state
);
311 validate_dest(nir_dest
*dest
, validate_state
*state
,
312 unsigned bit_size
, unsigned num_components
)
316 validate_assert(state
, dest
->ssa
.bit_size
== bit_size
);
318 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
319 validate_ssa_def(&dest
->ssa
, state
);
321 validate_reg_dest(&dest
->reg
, state
, bit_size
, num_components
);
326 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
328 nir_alu_dest
*dest
= &instr
->dest
;
330 unsigned dest_size
= nir_dest_num_components(dest
->dest
);
331 bool is_packed
= !dest
->dest
.is_ssa
&& dest
->dest
.reg
.reg
->is_packed
;
333 * validate that the instruction doesn't write to components not in the
336 validate_assert(state
, is_packed
|| !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
338 /* validate that saturate is only ever used on instructions with
339 * destinations of type float
341 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
342 validate_assert(state
,
343 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
347 validate_dest(&dest
->dest
, state
, 0, 0);
351 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
353 validate_assert(state
, instr
->op
< nir_num_opcodes
);
355 unsigned instr_bit_size
= 0;
356 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
357 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
358 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
359 if (nir_alu_type_get_type_size(src_type
)) {
360 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
361 } else if (instr_bit_size
) {
362 validate_assert(state
, src_bit_size
== instr_bit_size
);
364 instr_bit_size
= src_bit_size
;
367 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
368 /* 8-bit float isn't a thing */
369 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
373 validate_alu_src(instr
, i
, state
);
376 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
377 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
378 if (nir_alu_type_get_type_size(dest_type
)) {
379 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
380 } else if (instr_bit_size
) {
381 validate_assert(state
, dest_bit_size
== instr_bit_size
);
383 /* The only unsized thing is the destination so it's vacuously valid */
386 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
387 /* 8-bit float isn't a thing */
388 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
389 dest_bit_size
== 64);
392 validate_alu_dest(instr
, state
);
396 validate_var_use(nir_variable
*var
, validate_state
*state
)
398 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
399 validate_assert(state
, entry
);
400 if (var
->data
.mode
== nir_var_function
)
401 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
405 validate_deref_instr(nir_deref_instr
*instr
, validate_state
*state
)
407 if (instr
->deref_type
== nir_deref_type_var
) {
408 /* Variable dereferences are stupid simple. */
409 validate_assert(state
, instr
->mode
== instr
->var
->data
.mode
);
410 validate_assert(state
, instr
->type
== instr
->var
->type
);
411 validate_var_use(instr
->var
, state
);
412 } else if (instr
->deref_type
== nir_deref_type_cast
) {
413 /* For cast, we simply have to trust the instruction. It's up to
414 * lowering passes and front/back-ends to make them sane.
416 validate_src(&instr
->parent
, state
, 0, 0);
418 /* We just validate that the type and mode are there */
419 validate_assert(state
, instr
->mode
);
420 validate_assert(state
, instr
->type
);
422 /* We require the parent to be SSA. This may be lifted in the future */
423 validate_assert(state
, instr
->parent
.is_ssa
);
425 /* The parent pointer value must have the same number of components
426 * as the destination.
428 validate_src(&instr
->parent
, state
, nir_dest_bit_size(instr
->dest
),
429 nir_dest_num_components(instr
->dest
));
431 nir_instr
*parent_instr
= instr
->parent
.ssa
->parent_instr
;
433 /* The parent must come from another deref instruction */
434 validate_assert(state
, parent_instr
->type
== nir_instr_type_deref
);
436 nir_deref_instr
*parent
= nir_instr_as_deref(parent_instr
);
438 validate_assert(state
, instr
->mode
== parent
->mode
);
440 switch (instr
->deref_type
) {
441 case nir_deref_type_struct
:
442 validate_assert(state
, glsl_type_is_struct(parent
->type
));
443 validate_assert(state
,
444 instr
->strct
.index
< glsl_get_length(parent
->type
));
445 validate_assert(state
, instr
->type
==
446 glsl_get_struct_field(parent
->type
, instr
->strct
.index
));
449 case nir_deref_type_array
:
450 case nir_deref_type_array_wildcard
:
451 if (instr
->mode
== nir_var_ubo
||
452 instr
->mode
== nir_var_ssbo
||
453 instr
->mode
== nir_var_shared
) {
454 /* Shared variables and UBO/SSBOs have a bit more relaxed rules
455 * because we need to be able to handle array derefs on vectors.
456 * Fortunately, nir_lower_io handles these just fine.
458 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
459 glsl_type_is_matrix(parent
->type
) ||
460 glsl_type_is_vector(parent
->type
));
462 /* Most of NIR cannot handle array derefs on vectors */
463 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
464 glsl_type_is_matrix(parent
->type
));
466 validate_assert(state
,
467 instr
->type
== glsl_get_array_element(parent
->type
));
469 if (instr
->deref_type
== nir_deref_type_array
) {
470 validate_src(&instr
->arr
.index
, state
,
471 nir_dest_bit_size(instr
->dest
), 1);
475 case nir_deref_type_ptr_as_array
:
476 /* ptr_as_array derefs must have a parent that is either an array,
477 * ptr_as_array, or cast. If the parent is a cast, we get the stride
478 * information (if any) from the cast deref.
480 validate_assert(state
,
481 parent
->deref_type
== nir_deref_type_array
||
482 parent
->deref_type
== nir_deref_type_ptr_as_array
||
483 parent
->deref_type
== nir_deref_type_cast
);
484 validate_src(&instr
->arr
.index
, state
,
485 nir_dest_bit_size(instr
->dest
), 1);
489 unreachable("Invalid deref instruction type");
493 /* We intentionally don't validate the size of the destination because we
494 * want to let other compiler components such as SPIR-V decide how big
495 * pointers should be.
497 validate_dest(&instr
->dest
, state
, 0, 0);
499 /* Deref instructions as if conditions don't make sense because if
500 * conditions expect well-formed Booleans. If you want to compare with
501 * NULL, an explicit comparison operation should be used.
503 validate_assert(state
, list_empty(&instr
->dest
.ssa
.if_uses
));
507 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
509 unsigned dest_bit_size
= 0;
510 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
511 switch (instr
->intrinsic
) {
512 case nir_intrinsic_load_param
: {
513 unsigned param_idx
= nir_intrinsic_param_idx(instr
);
514 validate_assert(state
, param_idx
< state
->impl
->function
->num_params
);
515 nir_parameter
*param
= &state
->impl
->function
->params
[param_idx
];
516 validate_assert(state
, instr
->num_components
== param
->num_components
);
517 dest_bit_size
= param
->bit_size
;
521 case nir_intrinsic_load_deref
: {
522 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[0]);
523 validate_assert(state
, glsl_type_is_vector_or_scalar(src
->type
) ||
524 (src
->mode
== nir_var_uniform
&&
525 glsl_get_base_type(src
->type
) == GLSL_TYPE_SUBROUTINE
));
526 validate_assert(state
, instr
->num_components
==
527 glsl_get_vector_elements(src
->type
));
528 dest_bit_size
= glsl_get_bit_size(src
->type
);
532 case nir_intrinsic_store_deref
: {
533 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
534 validate_assert(state
, glsl_type_is_vector_or_scalar(dst
->type
));
535 validate_assert(state
, instr
->num_components
==
536 glsl_get_vector_elements(dst
->type
));
537 src_bit_sizes
[1] = glsl_get_bit_size(dst
->type
);
538 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
539 nir_var_uniform
)) == 0);
540 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
544 case nir_intrinsic_copy_deref
: {
545 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
546 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[1]);
547 validate_assert(state
, dst
->type
== src
->type
);
548 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
549 nir_var_uniform
)) == 0);
557 unsigned num_srcs
= nir_intrinsic_infos
[instr
->intrinsic
].num_srcs
;
558 for (unsigned i
= 0; i
< num_srcs
; i
++) {
559 unsigned components_read
= nir_intrinsic_src_components(instr
, i
);
561 validate_assert(state
, components_read
> 0);
563 validate_src(&instr
->src
[i
], state
, src_bit_sizes
[i
], components_read
);
566 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
567 unsigned components_written
= nir_intrinsic_dest_components(instr
);
569 validate_assert(state
, components_written
> 0);
571 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
576 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
578 bool src_type_seen
[nir_num_tex_src_types
];
579 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
580 src_type_seen
[i
] = false;
582 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
583 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
584 src_type_seen
[instr
->src
[i
].src_type
] = true;
585 validate_src(&instr
->src
[i
].src
, state
,
586 0, nir_tex_instr_src_size(instr
, i
));
589 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
593 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
595 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
597 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
598 validate_src(&instr
->params
[i
], state
,
599 instr
->callee
->params
[i
].bit_size
,
600 instr
->callee
->params
[i
].num_components
);
605 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
607 validate_ssa_def(&instr
->def
, state
);
611 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
613 validate_ssa_def(&instr
->def
, state
);
617 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
620 * don't validate the sources until we get to them from their predecessor
621 * basic blocks, to avoid validating an SSA use before its definition.
624 validate_dest(&instr
->dest
, state
, 0, 0);
626 exec_list_validate(&instr
->srcs
);
627 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
628 state
->block
->predecessors
->entries
);
632 validate_instr(nir_instr
*instr
, validate_state
*state
)
634 validate_assert(state
, instr
->block
== state
->block
);
636 state
->instr
= instr
;
638 switch (instr
->type
) {
639 case nir_instr_type_alu
:
640 validate_alu_instr(nir_instr_as_alu(instr
), state
);
643 case nir_instr_type_deref
:
644 validate_deref_instr(nir_instr_as_deref(instr
), state
);
647 case nir_instr_type_call
:
648 validate_call_instr(nir_instr_as_call(instr
), state
);
651 case nir_instr_type_intrinsic
:
652 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
655 case nir_instr_type_tex
:
656 validate_tex_instr(nir_instr_as_tex(instr
), state
);
659 case nir_instr_type_load_const
:
660 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
663 case nir_instr_type_phi
:
664 validate_phi_instr(nir_instr_as_phi(instr
), state
);
667 case nir_instr_type_ssa_undef
:
668 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
671 case nir_instr_type_jump
:
675 validate_assert(state
, !"Invalid ALU instruction type");
683 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
685 state
->instr
= &instr
->instr
;
687 validate_assert(state
, instr
->dest
.is_ssa
);
689 exec_list_validate(&instr
->srcs
);
690 nir_foreach_phi_src(src
, instr
) {
691 if (src
->pred
== pred
) {
692 validate_assert(state
, src
->src
.is_ssa
);
693 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
694 instr
->dest
.ssa
.num_components
);
704 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
706 nir_foreach_instr(instr
, succ
) {
707 if (instr
->type
!= nir_instr_type_phi
)
710 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
714 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
717 validate_block(nir_block
*block
, validate_state
*state
)
719 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
721 state
->block
= block
;
723 exec_list_validate(&block
->instr_list
);
724 nir_foreach_instr(instr
, block
) {
725 if (instr
->type
== nir_instr_type_phi
) {
726 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
727 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
730 if (instr
->type
== nir_instr_type_jump
) {
731 validate_assert(state
, instr
== nir_block_last_instr(block
));
734 validate_instr(instr
, state
);
737 validate_assert(state
, block
->successors
[0] != NULL
);
738 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
740 for (unsigned i
= 0; i
< 2; i
++) {
741 if (block
->successors
[i
] != NULL
) {
742 struct set_entry
*entry
=
743 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
744 validate_assert(state
, entry
);
746 validate_phi_srcs(block
, block
->successors
[i
], state
);
750 set_foreach(block
->predecessors
, entry
) {
751 const nir_block
*pred
= entry
->key
;
752 validate_assert(state
, pred
->successors
[0] == block
||
753 pred
->successors
[1] == block
);
756 if (!exec_list_is_empty(&block
->instr_list
) &&
757 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
758 validate_assert(state
, block
->successors
[1] == NULL
);
759 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
760 switch (jump
->type
) {
761 case nir_jump_break
: {
763 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
764 validate_assert(state
, block
->successors
[0] == after
);
768 case nir_jump_continue
: {
769 nir_block
*first
= nir_loop_first_block(state
->loop
);
770 validate_assert(state
, block
->successors
[0] == first
);
774 case nir_jump_return
:
775 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
779 unreachable("bad jump type");
782 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
784 switch (state
->parent_node
->type
) {
785 case nir_cf_node_loop
: {
786 nir_block
*first
= nir_loop_first_block(state
->loop
);
787 validate_assert(state
, block
->successors
[0] == first
);
788 /* due to the hack for infinite loops, block->successors[1] may
789 * point to the block after the loop.
794 case nir_cf_node_if
: {
796 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
797 validate_assert(state
, block
->successors
[0] == after
);
798 validate_assert(state
, block
->successors
[1] == NULL
);
802 case nir_cf_node_function
:
803 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
804 validate_assert(state
, block
->successors
[1] == NULL
);
808 unreachable("unknown control flow node type");
811 if (next
->type
== nir_cf_node_if
) {
812 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
813 validate_assert(state
, block
->successors
[0] ==
814 nir_if_first_then_block(if_stmt
));
815 validate_assert(state
, block
->successors
[1] ==
816 nir_if_first_else_block(if_stmt
));
818 validate_assert(state
, next
->type
== nir_cf_node_loop
);
819 nir_loop
*loop
= nir_cf_node_as_loop(next
);
820 validate_assert(state
, block
->successors
[0] ==
821 nir_loop_first_block(loop
));
822 validate_assert(state
, block
->successors
[1] == NULL
);
829 validate_if(nir_if
*if_stmt
, validate_state
*state
)
831 state
->if_stmt
= if_stmt
;
833 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
834 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
835 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
837 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
838 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
839 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
841 validate_src(&if_stmt
->condition
, state
, 0, 1);
843 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
844 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
846 nir_cf_node
*old_parent
= state
->parent_node
;
847 state
->parent_node
= &if_stmt
->cf_node
;
849 exec_list_validate(&if_stmt
->then_list
);
850 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
851 validate_cf_node(cf_node
, state
);
854 exec_list_validate(&if_stmt
->else_list
);
855 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
856 validate_cf_node(cf_node
, state
);
859 state
->parent_node
= old_parent
;
860 state
->if_stmt
= NULL
;
864 validate_loop(nir_loop
*loop
, validate_state
*state
)
866 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
867 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
868 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
870 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
871 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
872 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
874 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
876 nir_cf_node
*old_parent
= state
->parent_node
;
877 state
->parent_node
= &loop
->cf_node
;
878 nir_loop
*old_loop
= state
->loop
;
881 exec_list_validate(&loop
->body
);
882 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
883 validate_cf_node(cf_node
, state
);
886 state
->parent_node
= old_parent
;
887 state
->loop
= old_loop
;
891 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
893 validate_assert(state
, node
->parent
== state
->parent_node
);
895 switch (node
->type
) {
896 case nir_cf_node_block
:
897 validate_block(nir_cf_node_as_block(node
), state
);
901 validate_if(nir_cf_node_as_if(node
), state
);
904 case nir_cf_node_loop
:
905 validate_loop(nir_cf_node_as_loop(node
), state
);
909 unreachable("Invalid CF node type");
914 prevalidate_reg_decl(nir_register
*reg
, bool is_global
, validate_state
*state
)
916 validate_assert(state
, reg
->is_global
== is_global
);
919 validate_assert(state
, reg
->index
< state
->shader
->reg_alloc
);
921 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
922 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
923 BITSET_SET(state
->regs_found
, reg
->index
);
925 list_validate(®
->uses
);
926 list_validate(®
->defs
);
927 list_validate(®
->if_uses
);
929 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
930 reg_state
->uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
931 _mesa_key_pointer_equal
);
932 reg_state
->if_uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
933 _mesa_key_pointer_equal
);
934 reg_state
->defs
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
935 _mesa_key_pointer_equal
);
937 reg_state
->where_defined
= is_global
? NULL
: state
->impl
;
939 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
943 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
945 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
948 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
950 nir_foreach_use(src
, reg
) {
951 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
952 validate_assert(state
, entry
);
953 _mesa_set_remove(reg_state
->uses
, entry
);
956 if (reg_state
->uses
->entries
!= 0) {
957 printf("extra entries in register uses:\n");
958 set_foreach(reg_state
->uses
, entry
)
959 printf("%p\n", entry
->key
);
964 nir_foreach_if_use(src
, reg
) {
965 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
966 validate_assert(state
, entry
);
967 _mesa_set_remove(reg_state
->if_uses
, entry
);
970 if (reg_state
->if_uses
->entries
!= 0) {
971 printf("extra entries in register if_uses:\n");
972 set_foreach(reg_state
->if_uses
, entry
)
973 printf("%p\n", entry
->key
);
978 nir_foreach_def(src
, reg
) {
979 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
980 validate_assert(state
, entry
);
981 _mesa_set_remove(reg_state
->defs
, entry
);
984 if (reg_state
->defs
->entries
!= 0) {
985 printf("extra entries in register defs:\n");
986 set_foreach(reg_state
->defs
, entry
)
987 printf("%p\n", entry
->key
);
994 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
998 validate_assert(state
, is_global
== nir_variable_is_global(var
));
1000 /* Must have exactly one mode set */
1001 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
1003 if (var
->data
.compact
) {
1004 /* The "compact" flag is only valid on arrays of scalars. */
1005 assert(glsl_type_is_array(var
->type
));
1007 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
1008 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
1009 assert(glsl_type_is_array(type
));
1010 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
1012 assert(glsl_type_is_scalar(type
));
1016 if (var
->num_members
> 0) {
1017 const struct glsl_type
*without_array
= glsl_without_array(var
->type
);
1018 validate_assert(state
, glsl_type_is_struct(without_array
));
1019 validate_assert(state
, var
->num_members
== glsl_get_length(without_array
));
1020 validate_assert(state
, var
->members
!= NULL
);
1024 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1028 _mesa_hash_table_insert(state
->var_defs
, var
,
1029 is_global
? NULL
: state
->impl
);
1035 postvalidate_ssa_def(nir_ssa_def
*def
, void *void_state
)
1037 validate_state
*state
= void_state
;
1039 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, def
);
1042 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
1044 nir_foreach_use(src
, def
) {
1045 struct set_entry
*entry
= _mesa_set_search(def_state
->uses
, src
);
1046 validate_assert(state
, entry
);
1047 _mesa_set_remove(def_state
->uses
, entry
);
1050 if (def_state
->uses
->entries
!= 0) {
1051 printf("extra entries in SSA def uses:\n");
1052 set_foreach(def_state
->uses
, entry
)
1053 printf("%p\n", entry
->key
);
1058 nir_foreach_if_use(src
, def
) {
1059 struct set_entry
*entry
= _mesa_set_search(def_state
->if_uses
, src
);
1060 validate_assert(state
, entry
);
1061 _mesa_set_remove(def_state
->if_uses
, entry
);
1064 if (def_state
->if_uses
->entries
!= 0) {
1065 printf("extra entries in SSA def uses:\n");
1066 set_foreach(def_state
->if_uses
, entry
)
1067 printf("%p\n", entry
->key
);
1076 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1078 validate_assert(state
, impl
->function
->impl
== impl
);
1079 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1081 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1082 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1083 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1086 state
->parent_node
= &impl
->cf_node
;
1088 exec_list_validate(&impl
->locals
);
1089 nir_foreach_variable(var
, &impl
->locals
) {
1090 validate_var_decl(var
, false, state
);
1093 state
->regs_found
= realloc(state
->regs_found
,
1094 BITSET_WORDS(impl
->reg_alloc
) *
1095 sizeof(BITSET_WORD
));
1096 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1097 sizeof(BITSET_WORD
));
1098 exec_list_validate(&impl
->registers
);
1099 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1100 prevalidate_reg_decl(reg
, false, state
);
1103 state
->ssa_defs_found
= realloc(state
->ssa_defs_found
,
1104 BITSET_WORDS(impl
->ssa_alloc
) *
1105 sizeof(BITSET_WORD
));
1106 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1107 sizeof(BITSET_WORD
));
1108 exec_list_validate(&impl
->body
);
1109 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1110 validate_cf_node(node
, state
);
1113 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1114 postvalidate_reg_decl(reg
, state
);
1117 nir_foreach_block(block
, impl
) {
1118 nir_foreach_instr(instr
, block
)
1119 nir_foreach_ssa_def(instr
, postvalidate_ssa_def
, state
);
1124 validate_function(nir_function
*func
, validate_state
*state
)
1126 if (func
->impl
!= NULL
) {
1127 validate_assert(state
, func
->impl
->function
== func
);
1128 validate_function_impl(func
->impl
, state
);
1133 init_validate_state(validate_state
*state
)
1135 state
->regs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1136 _mesa_key_pointer_equal
);
1137 state
->ssa_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1138 _mesa_key_pointer_equal
);
1139 state
->ssa_defs_found
= NULL
;
1140 state
->regs_found
= NULL
;
1141 state
->var_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1142 _mesa_key_pointer_equal
);
1143 state
->errors
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1144 _mesa_key_pointer_equal
);
1147 state
->instr
= NULL
;
1152 destroy_validate_state(validate_state
*state
)
1154 _mesa_hash_table_destroy(state
->regs
, NULL
);
1155 _mesa_hash_table_destroy(state
->ssa_defs
, NULL
);
1156 free(state
->ssa_defs_found
);
1157 free(state
->regs_found
);
1158 _mesa_hash_table_destroy(state
->var_defs
, NULL
);
1159 _mesa_hash_table_destroy(state
->errors
, NULL
);
1163 dump_errors(validate_state
*state
, const char *when
)
1165 struct hash_table
*errors
= state
->errors
;
1168 fprintf(stderr
, "NIR validation failed %s\n", when
);
1169 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1171 fprintf(stderr
, "NIR validation failed with %d errors:\n",
1172 _mesa_hash_table_num_entries(errors
));
1175 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1177 if (_mesa_hash_table_num_entries(errors
) > 0) {
1178 fprintf(stderr
, "%d additional errors:\n",
1179 _mesa_hash_table_num_entries(errors
));
1180 hash_table_foreach(errors
, entry
) {
1181 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1189 nir_validate_shader(nir_shader
*shader
, const char *when
)
1191 static int should_validate
= -1;
1192 if (should_validate
< 0)
1193 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1194 if (!should_validate
)
1197 validate_state state
;
1198 init_validate_state(&state
);
1200 state
.shader
= shader
;
1202 exec_list_validate(&shader
->uniforms
);
1203 nir_foreach_variable(var
, &shader
->uniforms
) {
1204 validate_var_decl(var
, true, &state
);
1207 exec_list_validate(&shader
->inputs
);
1208 nir_foreach_variable(var
, &shader
->inputs
) {
1209 validate_var_decl(var
, true, &state
);
1212 exec_list_validate(&shader
->outputs
);
1213 nir_foreach_variable(var
, &shader
->outputs
) {
1214 validate_var_decl(var
, true, &state
);
1217 exec_list_validate(&shader
->shared
);
1218 nir_foreach_variable(var
, &shader
->shared
) {
1219 validate_var_decl(var
, true, &state
);
1222 exec_list_validate(&shader
->globals
);
1223 nir_foreach_variable(var
, &shader
->globals
) {
1224 validate_var_decl(var
, true, &state
);
1227 exec_list_validate(&shader
->system_values
);
1228 nir_foreach_variable(var
, &shader
->system_values
) {
1229 validate_var_decl(var
, true, &state
);
1232 state
.regs_found
= realloc(state
.regs_found
,
1233 BITSET_WORDS(shader
->reg_alloc
) *
1234 sizeof(BITSET_WORD
));
1235 memset(state
.regs_found
, 0, BITSET_WORDS(shader
->reg_alloc
) *
1236 sizeof(BITSET_WORD
));
1237 exec_list_validate(&shader
->registers
);
1238 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1239 prevalidate_reg_decl(reg
, true, &state
);
1242 exec_list_validate(&shader
->functions
);
1243 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1244 validate_function(func
, &state
);
1247 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1248 postvalidate_reg_decl(reg
, &state
);
1251 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1252 dump_errors(&state
, when
);
1254 destroy_validate_state(&state
);