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_sizes
, unsigned num_components
);
135 validate_reg_src(nir_src
*src
, validate_state
*state
,
136 unsigned bit_sizes
, 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_sizes
);
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_sizes
, 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_sizes
);
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_sizes
, 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_sizes
, num_components
);
223 validate_reg_src(src
, state
, bit_sizes
, 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_sizes
, 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_sizes
);
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_pointer_set_create(def_state
);
304 def_state
->if_uses
= _mesa_pointer_set_create(def_state
);
305 _mesa_hash_table_insert(state
->ssa_defs
, def
, def_state
);
309 validate_dest(nir_dest
*dest
, validate_state
*state
,
310 unsigned bit_sizes
, unsigned num_components
)
314 validate_assert(state
, dest
->ssa
.bit_size
& bit_sizes
);
316 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
317 validate_ssa_def(&dest
->ssa
, state
);
319 validate_reg_dest(&dest
->reg
, state
, bit_sizes
, num_components
);
324 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
326 nir_alu_dest
*dest
= &instr
->dest
;
328 unsigned dest_size
= nir_dest_num_components(dest
->dest
);
329 bool is_packed
= !dest
->dest
.is_ssa
&& dest
->dest
.reg
.reg
->is_packed
;
331 * validate that the instruction doesn't write to components not in the
334 validate_assert(state
, is_packed
|| !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
336 /* validate that saturate is only ever used on instructions with
337 * destinations of type float
339 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
340 validate_assert(state
,
341 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
345 validate_dest(&dest
->dest
, state
, 0, 0);
349 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
351 validate_assert(state
, instr
->op
< nir_num_opcodes
);
353 unsigned instr_bit_size
= 0;
354 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
355 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
356 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
357 if (nir_alu_type_get_type_size(src_type
)) {
358 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
359 } else if (instr_bit_size
) {
360 validate_assert(state
, src_bit_size
== instr_bit_size
);
362 instr_bit_size
= src_bit_size
;
365 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
366 /* 8-bit float isn't a thing */
367 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
371 validate_alu_src(instr
, i
, state
);
374 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
375 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
376 if (nir_alu_type_get_type_size(dest_type
)) {
377 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
378 } else if (instr_bit_size
) {
379 validate_assert(state
, dest_bit_size
== instr_bit_size
);
381 /* The only unsized thing is the destination so it's vacuously valid */
384 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
385 /* 8-bit float isn't a thing */
386 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
387 dest_bit_size
== 64);
390 validate_alu_dest(instr
, state
);
394 validate_var_use(nir_variable
*var
, validate_state
*state
)
396 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
397 validate_assert(state
, entry
);
398 if (var
->data
.mode
== nir_var_function_temp
)
399 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
403 validate_deref_instr(nir_deref_instr
*instr
, validate_state
*state
)
405 if (instr
->deref_type
== nir_deref_type_var
) {
406 /* Variable dereferences are stupid simple. */
407 validate_assert(state
, instr
->mode
== instr
->var
->data
.mode
);
408 validate_assert(state
, instr
->type
== instr
->var
->type
);
409 validate_var_use(instr
->var
, state
);
410 } else if (instr
->deref_type
== nir_deref_type_cast
) {
411 /* For cast, we simply have to trust the instruction. It's up to
412 * lowering passes and front/back-ends to make them sane.
414 validate_src(&instr
->parent
, state
, 0, 0);
416 /* We just validate that the type and mode are there */
417 validate_assert(state
, instr
->mode
);
418 validate_assert(state
, instr
->type
);
420 /* We require the parent to be SSA. This may be lifted in the future */
421 validate_assert(state
, instr
->parent
.is_ssa
);
423 /* The parent pointer value must have the same number of components
424 * as the destination.
426 validate_src(&instr
->parent
, state
, nir_dest_bit_size(instr
->dest
),
427 nir_dest_num_components(instr
->dest
));
429 nir_instr
*parent_instr
= instr
->parent
.ssa
->parent_instr
;
431 /* The parent must come from another deref instruction */
432 validate_assert(state
, parent_instr
->type
== nir_instr_type_deref
);
434 nir_deref_instr
*parent
= nir_instr_as_deref(parent_instr
);
436 validate_assert(state
, instr
->mode
== parent
->mode
);
438 switch (instr
->deref_type
) {
439 case nir_deref_type_struct
:
440 validate_assert(state
, glsl_type_is_struct_or_ifc(parent
->type
));
441 validate_assert(state
,
442 instr
->strct
.index
< glsl_get_length(parent
->type
));
443 validate_assert(state
, instr
->type
==
444 glsl_get_struct_field(parent
->type
, instr
->strct
.index
));
447 case nir_deref_type_array
:
448 case nir_deref_type_array_wildcard
:
449 if (instr
->mode
== nir_var_mem_ubo
||
450 instr
->mode
== nir_var_mem_ssbo
||
451 instr
->mode
== nir_var_mem_shared
||
452 instr
->mode
== nir_var_mem_global
) {
453 /* Shared variables and UBO/SSBOs have a bit more relaxed rules
454 * because we need to be able to handle array derefs on vectors.
455 * Fortunately, nir_lower_io handles these just fine.
457 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
458 glsl_type_is_matrix(parent
->type
) ||
459 glsl_type_is_vector(parent
->type
));
461 /* Most of NIR cannot handle array derefs on vectors */
462 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
463 glsl_type_is_matrix(parent
->type
));
465 validate_assert(state
,
466 instr
->type
== glsl_get_array_element(parent
->type
));
468 if (instr
->deref_type
== nir_deref_type_array
) {
469 validate_src(&instr
->arr
.index
, state
,
470 nir_dest_bit_size(instr
->dest
), 1);
474 case nir_deref_type_ptr_as_array
:
475 /* ptr_as_array derefs must have a parent that is either an array,
476 * ptr_as_array, or cast. If the parent is a cast, we get the stride
477 * information (if any) from the cast deref.
479 validate_assert(state
,
480 parent
->deref_type
== nir_deref_type_array
||
481 parent
->deref_type
== nir_deref_type_ptr_as_array
||
482 parent
->deref_type
== nir_deref_type_cast
);
483 validate_src(&instr
->arr
.index
, state
,
484 nir_dest_bit_size(instr
->dest
), 1);
488 unreachable("Invalid deref instruction type");
492 /* We intentionally don't validate the size of the destination because we
493 * want to let other compiler components such as SPIR-V decide how big
494 * pointers should be.
496 validate_dest(&instr
->dest
, state
, 0, 0);
498 /* Deref instructions as if conditions don't make sense because if
499 * conditions expect well-formed Booleans. If you want to compare with
500 * NULL, an explicit comparison operation should be used.
502 validate_assert(state
, list_empty(&instr
->dest
.ssa
.if_uses
));
506 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
508 unsigned dest_bit_size
= 0;
509 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
510 switch (instr
->intrinsic
) {
511 case nir_intrinsic_load_param
: {
512 unsigned param_idx
= nir_intrinsic_param_idx(instr
);
513 validate_assert(state
, param_idx
< state
->impl
->function
->num_params
);
514 nir_parameter
*param
= &state
->impl
->function
->params
[param_idx
];
515 validate_assert(state
, instr
->num_components
== param
->num_components
);
516 dest_bit_size
= param
->bit_size
;
520 case nir_intrinsic_load_deref
: {
521 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[0]);
522 validate_assert(state
, glsl_type_is_vector_or_scalar(src
->type
) ||
523 (src
->mode
== nir_var_uniform
&&
524 glsl_get_base_type(src
->type
) == GLSL_TYPE_SUBROUTINE
));
525 validate_assert(state
, instr
->num_components
==
526 glsl_get_vector_elements(src
->type
));
527 dest_bit_size
= glsl_get_bit_size(src
->type
);
531 case nir_intrinsic_store_deref
: {
532 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
533 validate_assert(state
, glsl_type_is_vector_or_scalar(dst
->type
));
534 validate_assert(state
, instr
->num_components
==
535 glsl_get_vector_elements(dst
->type
));
536 src_bit_sizes
[1] = glsl_get_bit_size(dst
->type
);
537 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
538 nir_var_uniform
)) == 0);
539 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
543 case nir_intrinsic_copy_deref
: {
544 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
545 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[1]);
546 validate_assert(state
, glsl_get_bare_type(dst
->type
) ==
547 glsl_get_bare_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
);
568 unsigned bit_sizes
= nir_intrinsic_infos
[instr
->intrinsic
].dest_bit_sizes
;
570 validate_assert(state
, components_written
> 0);
572 if (dest_bit_size
&& bit_sizes
)
573 validate_assert(state
, dest_bit_size
& bit_sizes
);
575 dest_bit_size
= dest_bit_size
? dest_bit_size
: bit_sizes
;
577 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
582 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
584 bool src_type_seen
[nir_num_tex_src_types
];
585 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
586 src_type_seen
[i
] = false;
588 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
589 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
590 src_type_seen
[instr
->src
[i
].src_type
] = true;
591 validate_src(&instr
->src
[i
].src
, state
,
592 0, nir_tex_instr_src_size(instr
, i
));
595 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
599 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
601 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
603 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
604 validate_src(&instr
->params
[i
], state
,
605 instr
->callee
->params
[i
].bit_size
,
606 instr
->callee
->params
[i
].num_components
);
611 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
613 validate_ssa_def(&instr
->def
, state
);
617 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
619 validate_ssa_def(&instr
->def
, state
);
623 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
626 * don't validate the sources until we get to them from their predecessor
627 * basic blocks, to avoid validating an SSA use before its definition.
630 validate_dest(&instr
->dest
, state
, 0, 0);
632 exec_list_validate(&instr
->srcs
);
633 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
634 state
->block
->predecessors
->entries
);
638 validate_instr(nir_instr
*instr
, validate_state
*state
)
640 validate_assert(state
, instr
->block
== state
->block
);
642 state
->instr
= instr
;
644 switch (instr
->type
) {
645 case nir_instr_type_alu
:
646 validate_alu_instr(nir_instr_as_alu(instr
), state
);
649 case nir_instr_type_deref
:
650 validate_deref_instr(nir_instr_as_deref(instr
), state
);
653 case nir_instr_type_call
:
654 validate_call_instr(nir_instr_as_call(instr
), state
);
657 case nir_instr_type_intrinsic
:
658 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
661 case nir_instr_type_tex
:
662 validate_tex_instr(nir_instr_as_tex(instr
), state
);
665 case nir_instr_type_load_const
:
666 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
669 case nir_instr_type_phi
:
670 validate_phi_instr(nir_instr_as_phi(instr
), state
);
673 case nir_instr_type_ssa_undef
:
674 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
677 case nir_instr_type_jump
:
681 validate_assert(state
, !"Invalid ALU instruction type");
689 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
691 state
->instr
= &instr
->instr
;
693 validate_assert(state
, instr
->dest
.is_ssa
);
695 exec_list_validate(&instr
->srcs
);
696 nir_foreach_phi_src(src
, instr
) {
697 if (src
->pred
== pred
) {
698 validate_assert(state
, src
->src
.is_ssa
);
699 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
700 instr
->dest
.ssa
.num_components
);
710 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
712 nir_foreach_instr(instr
, succ
) {
713 if (instr
->type
!= nir_instr_type_phi
)
716 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
720 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
723 validate_block(nir_block
*block
, validate_state
*state
)
725 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
727 state
->block
= block
;
729 exec_list_validate(&block
->instr_list
);
730 nir_foreach_instr(instr
, block
) {
731 if (instr
->type
== nir_instr_type_phi
) {
732 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
733 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
736 if (instr
->type
== nir_instr_type_jump
) {
737 validate_assert(state
, instr
== nir_block_last_instr(block
));
740 validate_instr(instr
, state
);
743 validate_assert(state
, block
->successors
[0] != NULL
);
744 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
746 for (unsigned i
= 0; i
< 2; i
++) {
747 if (block
->successors
[i
] != NULL
) {
748 struct set_entry
*entry
=
749 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
750 validate_assert(state
, entry
);
752 validate_phi_srcs(block
, block
->successors
[i
], state
);
756 set_foreach(block
->predecessors
, entry
) {
757 const nir_block
*pred
= entry
->key
;
758 validate_assert(state
, pred
->successors
[0] == block
||
759 pred
->successors
[1] == block
);
762 if (!exec_list_is_empty(&block
->instr_list
) &&
763 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
764 validate_assert(state
, block
->successors
[1] == NULL
);
765 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
766 switch (jump
->type
) {
767 case nir_jump_break
: {
769 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
770 validate_assert(state
, block
->successors
[0] == after
);
774 case nir_jump_continue
: {
775 nir_block
*first
= nir_loop_first_block(state
->loop
);
776 validate_assert(state
, block
->successors
[0] == first
);
780 case nir_jump_return
:
781 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
785 unreachable("bad jump type");
788 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
790 switch (state
->parent_node
->type
) {
791 case nir_cf_node_loop
: {
792 nir_block
*first
= nir_loop_first_block(state
->loop
);
793 validate_assert(state
, block
->successors
[0] == first
);
794 /* due to the hack for infinite loops, block->successors[1] may
795 * point to the block after the loop.
800 case nir_cf_node_if
: {
802 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
803 validate_assert(state
, block
->successors
[0] == after
);
804 validate_assert(state
, block
->successors
[1] == NULL
);
808 case nir_cf_node_function
:
809 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
810 validate_assert(state
, block
->successors
[1] == NULL
);
814 unreachable("unknown control flow node type");
817 if (next
->type
== nir_cf_node_if
) {
818 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
819 validate_assert(state
, block
->successors
[0] ==
820 nir_if_first_then_block(if_stmt
));
821 validate_assert(state
, block
->successors
[1] ==
822 nir_if_first_else_block(if_stmt
));
824 validate_assert(state
, next
->type
== nir_cf_node_loop
);
825 nir_loop
*loop
= nir_cf_node_as_loop(next
);
826 validate_assert(state
, block
->successors
[0] ==
827 nir_loop_first_block(loop
));
828 validate_assert(state
, block
->successors
[1] == NULL
);
835 validate_if(nir_if
*if_stmt
, validate_state
*state
)
837 state
->if_stmt
= if_stmt
;
839 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
840 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
841 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
843 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
844 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
845 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
847 validate_src(&if_stmt
->condition
, state
, 0, 1);
849 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
850 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
852 nir_cf_node
*old_parent
= state
->parent_node
;
853 state
->parent_node
= &if_stmt
->cf_node
;
855 exec_list_validate(&if_stmt
->then_list
);
856 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
857 validate_cf_node(cf_node
, state
);
860 exec_list_validate(&if_stmt
->else_list
);
861 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
862 validate_cf_node(cf_node
, state
);
865 state
->parent_node
= old_parent
;
866 state
->if_stmt
= NULL
;
870 validate_loop(nir_loop
*loop
, validate_state
*state
)
872 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
873 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
874 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
876 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
877 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
878 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
880 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
882 nir_cf_node
*old_parent
= state
->parent_node
;
883 state
->parent_node
= &loop
->cf_node
;
884 nir_loop
*old_loop
= state
->loop
;
887 exec_list_validate(&loop
->body
);
888 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
889 validate_cf_node(cf_node
, state
);
892 state
->parent_node
= old_parent
;
893 state
->loop
= old_loop
;
897 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
899 validate_assert(state
, node
->parent
== state
->parent_node
);
901 switch (node
->type
) {
902 case nir_cf_node_block
:
903 validate_block(nir_cf_node_as_block(node
), state
);
907 validate_if(nir_cf_node_as_if(node
), state
);
910 case nir_cf_node_loop
:
911 validate_loop(nir_cf_node_as_loop(node
), state
);
915 unreachable("Invalid CF node type");
920 prevalidate_reg_decl(nir_register
*reg
, bool is_global
, validate_state
*state
)
922 validate_assert(state
, reg
->is_global
== is_global
);
925 validate_assert(state
, reg
->index
< state
->shader
->reg_alloc
);
927 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
928 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
929 BITSET_SET(state
->regs_found
, reg
->index
);
931 list_validate(®
->uses
);
932 list_validate(®
->defs
);
933 list_validate(®
->if_uses
);
935 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
936 reg_state
->uses
= _mesa_pointer_set_create(reg_state
);
937 reg_state
->if_uses
= _mesa_pointer_set_create(reg_state
);
938 reg_state
->defs
= _mesa_pointer_set_create(reg_state
);
940 reg_state
->where_defined
= is_global
? NULL
: state
->impl
;
942 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
946 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
948 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
951 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
953 nir_foreach_use(src
, reg
) {
954 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
955 validate_assert(state
, entry
);
956 _mesa_set_remove(reg_state
->uses
, entry
);
959 if (reg_state
->uses
->entries
!= 0) {
960 printf("extra entries in register uses:\n");
961 set_foreach(reg_state
->uses
, entry
)
962 printf("%p\n", entry
->key
);
967 nir_foreach_if_use(src
, reg
) {
968 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
969 validate_assert(state
, entry
);
970 _mesa_set_remove(reg_state
->if_uses
, entry
);
973 if (reg_state
->if_uses
->entries
!= 0) {
974 printf("extra entries in register if_uses:\n");
975 set_foreach(reg_state
->if_uses
, entry
)
976 printf("%p\n", entry
->key
);
981 nir_foreach_def(src
, reg
) {
982 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
983 validate_assert(state
, entry
);
984 _mesa_set_remove(reg_state
->defs
, entry
);
987 if (reg_state
->defs
->entries
!= 0) {
988 printf("extra entries in register defs:\n");
989 set_foreach(reg_state
->defs
, entry
)
990 printf("%p\n", entry
->key
);
997 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
1001 validate_assert(state
, is_global
== nir_variable_is_global(var
));
1003 /* Must have exactly one mode set */
1004 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
1006 if (var
->data
.compact
) {
1007 /* The "compact" flag is only valid on arrays of scalars. */
1008 assert(glsl_type_is_array(var
->type
));
1010 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
1011 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
1012 assert(glsl_type_is_array(type
));
1013 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
1015 assert(glsl_type_is_scalar(type
));
1019 if (var
->num_members
> 0) {
1020 const struct glsl_type
*without_array
= glsl_without_array(var
->type
);
1021 validate_assert(state
, glsl_type_is_struct_or_ifc(without_array
));
1022 validate_assert(state
, var
->num_members
== glsl_get_length(without_array
));
1023 validate_assert(state
, var
->members
!= NULL
);
1027 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1031 _mesa_hash_table_insert(state
->var_defs
, var
,
1032 is_global
? NULL
: state
->impl
);
1038 postvalidate_ssa_def(nir_ssa_def
*def
, void *void_state
)
1040 validate_state
*state
= void_state
;
1042 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, def
);
1045 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
1047 nir_foreach_use(src
, def
) {
1048 struct set_entry
*entry
= _mesa_set_search(def_state
->uses
, src
);
1049 validate_assert(state
, entry
);
1050 _mesa_set_remove(def_state
->uses
, entry
);
1053 if (def_state
->uses
->entries
!= 0) {
1054 printf("extra entries in SSA def uses:\n");
1055 set_foreach(def_state
->uses
, entry
)
1056 printf("%p\n", entry
->key
);
1061 nir_foreach_if_use(src
, def
) {
1062 struct set_entry
*entry
= _mesa_set_search(def_state
->if_uses
, src
);
1063 validate_assert(state
, entry
);
1064 _mesa_set_remove(def_state
->if_uses
, entry
);
1067 if (def_state
->if_uses
->entries
!= 0) {
1068 printf("extra entries in SSA def uses:\n");
1069 set_foreach(def_state
->if_uses
, entry
)
1070 printf("%p\n", entry
->key
);
1079 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1081 validate_assert(state
, impl
->function
->impl
== impl
);
1082 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1084 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1085 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1086 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1089 state
->parent_node
= &impl
->cf_node
;
1091 exec_list_validate(&impl
->locals
);
1092 nir_foreach_variable(var
, &impl
->locals
) {
1093 validate_var_decl(var
, false, state
);
1096 state
->regs_found
= realloc(state
->regs_found
,
1097 BITSET_WORDS(impl
->reg_alloc
) *
1098 sizeof(BITSET_WORD
));
1099 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1100 sizeof(BITSET_WORD
));
1101 exec_list_validate(&impl
->registers
);
1102 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1103 prevalidate_reg_decl(reg
, false, state
);
1106 state
->ssa_defs_found
= realloc(state
->ssa_defs_found
,
1107 BITSET_WORDS(impl
->ssa_alloc
) *
1108 sizeof(BITSET_WORD
));
1109 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1110 sizeof(BITSET_WORD
));
1111 exec_list_validate(&impl
->body
);
1112 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1113 validate_cf_node(node
, state
);
1116 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1117 postvalidate_reg_decl(reg
, state
);
1120 nir_foreach_block(block
, impl
) {
1121 nir_foreach_instr(instr
, block
)
1122 nir_foreach_ssa_def(instr
, postvalidate_ssa_def
, state
);
1127 validate_function(nir_function
*func
, validate_state
*state
)
1129 if (func
->impl
!= NULL
) {
1130 validate_assert(state
, func
->impl
->function
== func
);
1131 validate_function_impl(func
->impl
, state
);
1136 init_validate_state(validate_state
*state
)
1138 state
->regs
= _mesa_pointer_hash_table_create(NULL
);
1139 state
->ssa_defs
= _mesa_pointer_hash_table_create(NULL
);
1140 state
->ssa_defs_found
= NULL
;
1141 state
->regs_found
= NULL
;
1142 state
->var_defs
= _mesa_pointer_hash_table_create(NULL
);
1143 state
->errors
= _mesa_pointer_hash_table_create(NULL
);
1146 state
->instr
= NULL
;
1151 destroy_validate_state(validate_state
*state
)
1153 _mesa_hash_table_destroy(state
->regs
, NULL
);
1154 _mesa_hash_table_destroy(state
->ssa_defs
, NULL
);
1155 free(state
->ssa_defs_found
);
1156 free(state
->regs_found
);
1157 _mesa_hash_table_destroy(state
->var_defs
, NULL
);
1158 _mesa_hash_table_destroy(state
->errors
, NULL
);
1162 dump_errors(validate_state
*state
, const char *when
)
1164 struct hash_table
*errors
= state
->errors
;
1167 fprintf(stderr
, "NIR validation failed %s\n", when
);
1168 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1170 fprintf(stderr
, "NIR validation failed with %d errors:\n",
1171 _mesa_hash_table_num_entries(errors
));
1174 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1176 if (_mesa_hash_table_num_entries(errors
) > 0) {
1177 fprintf(stderr
, "%d additional errors:\n",
1178 _mesa_hash_table_num_entries(errors
));
1179 hash_table_foreach(errors
, entry
) {
1180 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1188 nir_validate_shader(nir_shader
*shader
, const char *when
)
1190 static int should_validate
= -1;
1191 if (should_validate
< 0)
1192 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1193 if (!should_validate
)
1196 validate_state state
;
1197 init_validate_state(&state
);
1199 state
.shader
= shader
;
1201 exec_list_validate(&shader
->uniforms
);
1202 nir_foreach_variable(var
, &shader
->uniforms
) {
1203 validate_var_decl(var
, true, &state
);
1206 exec_list_validate(&shader
->inputs
);
1207 nir_foreach_variable(var
, &shader
->inputs
) {
1208 validate_var_decl(var
, true, &state
);
1211 exec_list_validate(&shader
->outputs
);
1212 nir_foreach_variable(var
, &shader
->outputs
) {
1213 validate_var_decl(var
, true, &state
);
1216 exec_list_validate(&shader
->shared
);
1217 nir_foreach_variable(var
, &shader
->shared
) {
1218 validate_var_decl(var
, true, &state
);
1221 exec_list_validate(&shader
->globals
);
1222 nir_foreach_variable(var
, &shader
->globals
) {
1223 validate_var_decl(var
, true, &state
);
1226 exec_list_validate(&shader
->system_values
);
1227 nir_foreach_variable(var
, &shader
->system_values
) {
1228 validate_var_decl(var
, true, &state
);
1231 state
.regs_found
= realloc(state
.regs_found
,
1232 BITSET_WORDS(shader
->reg_alloc
) *
1233 sizeof(BITSET_WORD
));
1234 memset(state
.regs_found
, 0, BITSET_WORDS(shader
->reg_alloc
) *
1235 sizeof(BITSET_WORD
));
1236 exec_list_validate(&shader
->registers
);
1237 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1238 prevalidate_reg_decl(reg
, true, &state
);
1241 exec_list_validate(&shader
->functions
);
1242 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1243 validate_function(func
, &state
);
1246 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1247 postvalidate_reg_decl(reg
, &state
);
1250 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1251 dump_errors(&state
, when
);
1253 destroy_validate_state(&state
);