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
= 4; /* can't check anything */
234 for (unsigned i
= 0; i
< 4; i
++) {
235 validate_assert(state
, src
->swizzle
[i
] < 4);
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_deref_chain(nir_deref
*deref
, nir_variable_mode mode
,
397 validate_state
*state
)
399 validate_assert(state
, deref
->child
== NULL
|| ralloc_parent(deref
->child
) == deref
);
401 nir_deref
*parent
= NULL
;
402 while (deref
!= NULL
) {
403 switch (deref
->deref_type
) {
404 case nir_deref_type_array
:
405 if (mode
== nir_var_shared
) {
406 /* Shared variables have a bit more relaxed rules because we need
407 * to be able to handle array derefs on vectors. Fortunately,
408 * nir_lower_io handles these just fine.
410 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
411 glsl_type_is_matrix(parent
->type
) ||
412 glsl_type_is_vector(parent
->type
));
414 /* Most of NIR cannot handle array derefs on vectors */
415 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
416 glsl_type_is_matrix(parent
->type
));
418 validate_assert(state
, deref
->type
== glsl_get_array_element(parent
->type
));
419 if (nir_deref_as_array(deref
)->deref_array_type
==
420 nir_deref_array_type_indirect
)
421 validate_src(&nir_deref_as_array(deref
)->indirect
, state
, 32, 1);
424 case nir_deref_type_struct
:
425 assume(parent
); /* cannot happen: deref change starts w/ nir_deref_var */
426 validate_assert(state
, deref
->type
==
427 glsl_get_struct_field(parent
->type
,
428 nir_deref_as_struct(deref
)->index
));
431 case nir_deref_type_var
:
435 validate_assert(state
, !"Invalid deref type");
440 deref
= deref
->child
;
445 validate_var_use(nir_variable
*var
, validate_state
*state
)
447 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
448 validate_assert(state
, entry
);
449 if (var
->data
.mode
== nir_var_local
)
450 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
454 validate_deref_var(void *parent_mem_ctx
, nir_deref_var
*deref
, validate_state
*state
)
456 validate_assert(state
, deref
!= NULL
);
457 validate_assert(state
, ralloc_parent(deref
) == parent_mem_ctx
);
458 validate_assert(state
, deref
->deref
.type
== deref
->var
->type
);
460 validate_var_use(deref
->var
, state
);
462 validate_deref_chain(&deref
->deref
, deref
->var
->data
.mode
, state
);
466 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
468 unsigned dest_bit_size
= 0;
469 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
470 switch (instr
->intrinsic
) {
471 case nir_intrinsic_load_var
: {
472 const struct glsl_type
*type
=
473 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
474 validate_assert(state
, glsl_type_is_vector_or_scalar(type
) ||
475 (instr
->variables
[0]->var
->data
.mode
== nir_var_uniform
&&
476 glsl_get_base_type(type
) == GLSL_TYPE_SUBROUTINE
));
477 validate_assert(state
, instr
->num_components
==
478 glsl_get_vector_elements(type
));
479 dest_bit_size
= glsl_get_bit_size(type
);
483 case nir_intrinsic_store_var
: {
484 const struct glsl_type
*type
=
485 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
486 validate_assert(state
, glsl_type_is_vector_or_scalar(type
) ||
487 (instr
->variables
[0]->var
->data
.mode
== nir_var_uniform
&&
488 glsl_get_base_type(type
) == GLSL_TYPE_SUBROUTINE
));
489 validate_assert(state
, instr
->num_components
== glsl_get_vector_elements(type
));
490 src_bit_sizes
[0] = glsl_get_bit_size(type
);
491 validate_assert(state
, instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_in
&&
492 instr
->variables
[0]->var
->data
.mode
!= nir_var_uniform
&&
493 instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_storage
);
494 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
498 case nir_intrinsic_copy_var
:
499 validate_assert(state
, nir_deref_tail(&instr
->variables
[0]->deref
)->type
==
500 nir_deref_tail(&instr
->variables
[1]->deref
)->type
);
501 validate_assert(state
, instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_in
&&
502 instr
->variables
[0]->var
->data
.mode
!= nir_var_uniform
&&
503 instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_storage
);
510 unsigned num_srcs
= nir_intrinsic_infos
[instr
->intrinsic
].num_srcs
;
511 for (unsigned i
= 0; i
< num_srcs
; i
++) {
512 unsigned components_read
= nir_intrinsic_src_components(instr
, i
);
514 validate_assert(state
, components_read
> 0);
516 validate_src(&instr
->src
[i
], state
, src_bit_sizes
[i
], components_read
);
519 unsigned num_vars
= nir_intrinsic_infos
[instr
->intrinsic
].num_variables
;
520 for (unsigned i
= 0; i
< num_vars
; i
++) {
521 validate_deref_var(instr
, instr
->variables
[i
], state
);
524 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
525 unsigned components_written
= nir_intrinsic_dest_components(instr
);
527 validate_assert(state
, components_written
> 0);
529 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
534 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
536 bool src_type_seen
[nir_num_tex_src_types
];
537 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
538 src_type_seen
[i
] = false;
540 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
541 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
542 src_type_seen
[instr
->src
[i
].src_type
] = true;
543 validate_src(&instr
->src
[i
].src
, state
,
544 0, nir_tex_instr_src_size(instr
, i
));
547 if (instr
->texture
!= NULL
)
548 validate_deref_var(instr
, instr
->texture
, state
);
550 if (instr
->sampler
!= NULL
)
551 validate_deref_var(instr
, instr
->sampler
, state
);
553 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
557 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
559 if (instr
->return_deref
== NULL
) {
560 validate_assert(state
, glsl_type_is_void(instr
->callee
->return_type
));
562 validate_assert(state
, instr
->return_deref
->deref
.type
== instr
->callee
->return_type
);
563 validate_deref_var(instr
, instr
->return_deref
, state
);
566 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
568 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
569 validate_assert(state
, instr
->callee
->params
[i
].type
== instr
->params
[i
]->deref
.type
);
570 validate_deref_var(instr
, instr
->params
[i
], state
);
575 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
577 validate_ssa_def(&instr
->def
, state
);
581 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
583 validate_ssa_def(&instr
->def
, state
);
587 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
590 * don't validate the sources until we get to them from their predecessor
591 * basic blocks, to avoid validating an SSA use before its definition.
594 validate_dest(&instr
->dest
, state
, 0, 0);
596 exec_list_validate(&instr
->srcs
);
597 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
598 state
->block
->predecessors
->entries
);
602 validate_instr(nir_instr
*instr
, validate_state
*state
)
604 validate_assert(state
, instr
->block
== state
->block
);
606 state
->instr
= instr
;
608 switch (instr
->type
) {
609 case nir_instr_type_alu
:
610 validate_alu_instr(nir_instr_as_alu(instr
), state
);
613 case nir_instr_type_call
:
614 validate_call_instr(nir_instr_as_call(instr
), state
);
617 case nir_instr_type_intrinsic
:
618 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
621 case nir_instr_type_tex
:
622 validate_tex_instr(nir_instr_as_tex(instr
), state
);
625 case nir_instr_type_load_const
:
626 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
629 case nir_instr_type_phi
:
630 validate_phi_instr(nir_instr_as_phi(instr
), state
);
633 case nir_instr_type_ssa_undef
:
634 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
637 case nir_instr_type_jump
:
641 validate_assert(state
, !"Invalid ALU instruction type");
649 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
651 state
->instr
= &instr
->instr
;
653 validate_assert(state
, instr
->dest
.is_ssa
);
655 exec_list_validate(&instr
->srcs
);
656 nir_foreach_phi_src(src
, instr
) {
657 if (src
->pred
== pred
) {
658 validate_assert(state
, src
->src
.is_ssa
);
659 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
660 instr
->dest
.ssa
.num_components
);
670 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
672 nir_foreach_instr(instr
, succ
) {
673 if (instr
->type
!= nir_instr_type_phi
)
676 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
680 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
683 validate_block(nir_block
*block
, validate_state
*state
)
685 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
687 state
->block
= block
;
689 exec_list_validate(&block
->instr_list
);
690 nir_foreach_instr(instr
, block
) {
691 if (instr
->type
== nir_instr_type_phi
) {
692 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
693 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
696 if (instr
->type
== nir_instr_type_jump
) {
697 validate_assert(state
, instr
== nir_block_last_instr(block
));
700 validate_instr(instr
, state
);
703 validate_assert(state
, block
->successors
[0] != NULL
);
704 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
706 for (unsigned i
= 0; i
< 2; i
++) {
707 if (block
->successors
[i
] != NULL
) {
708 struct set_entry
*entry
=
709 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
710 validate_assert(state
, entry
);
712 validate_phi_srcs(block
, block
->successors
[i
], state
);
716 struct set_entry
*entry
;
717 set_foreach(block
->predecessors
, entry
) {
718 const nir_block
*pred
= entry
->key
;
719 validate_assert(state
, pred
->successors
[0] == block
||
720 pred
->successors
[1] == block
);
723 if (!exec_list_is_empty(&block
->instr_list
) &&
724 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
725 validate_assert(state
, block
->successors
[1] == NULL
);
726 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
727 switch (jump
->type
) {
728 case nir_jump_break
: {
730 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
731 validate_assert(state
, block
->successors
[0] == after
);
735 case nir_jump_continue
: {
736 nir_block
*first
= nir_loop_first_block(state
->loop
);
737 validate_assert(state
, block
->successors
[0] == first
);
741 case nir_jump_return
:
742 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
746 unreachable("bad jump type");
749 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
751 switch (state
->parent_node
->type
) {
752 case nir_cf_node_loop
: {
753 nir_block
*first
= nir_loop_first_block(state
->loop
);
754 validate_assert(state
, block
->successors
[0] == first
);
755 /* due to the hack for infinite loops, block->successors[1] may
756 * point to the block after the loop.
761 case nir_cf_node_if
: {
763 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
764 validate_assert(state
, block
->successors
[0] == after
);
765 validate_assert(state
, block
->successors
[1] == NULL
);
769 case nir_cf_node_function
:
770 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
771 validate_assert(state
, block
->successors
[1] == NULL
);
775 unreachable("unknown control flow node type");
778 if (next
->type
== nir_cf_node_if
) {
779 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
780 validate_assert(state
, block
->successors
[0] ==
781 nir_if_first_then_block(if_stmt
));
782 validate_assert(state
, block
->successors
[1] ==
783 nir_if_first_else_block(if_stmt
));
785 validate_assert(state
, next
->type
== nir_cf_node_loop
);
786 nir_loop
*loop
= nir_cf_node_as_loop(next
);
787 validate_assert(state
, block
->successors
[0] ==
788 nir_loop_first_block(loop
));
789 validate_assert(state
, block
->successors
[1] == NULL
);
796 validate_if(nir_if
*if_stmt
, validate_state
*state
)
798 state
->if_stmt
= if_stmt
;
800 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
801 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
802 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
804 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
805 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
806 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
808 validate_src(&if_stmt
->condition
, state
, 32, 1);
810 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
811 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
813 nir_cf_node
*old_parent
= state
->parent_node
;
814 state
->parent_node
= &if_stmt
->cf_node
;
816 exec_list_validate(&if_stmt
->then_list
);
817 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
818 validate_cf_node(cf_node
, state
);
821 exec_list_validate(&if_stmt
->else_list
);
822 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
823 validate_cf_node(cf_node
, state
);
826 state
->parent_node
= old_parent
;
827 state
->if_stmt
= NULL
;
831 validate_loop(nir_loop
*loop
, validate_state
*state
)
833 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
834 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
835 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
837 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
838 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
839 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
841 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
843 nir_cf_node
*old_parent
= state
->parent_node
;
844 state
->parent_node
= &loop
->cf_node
;
845 nir_loop
*old_loop
= state
->loop
;
848 exec_list_validate(&loop
->body
);
849 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
850 validate_cf_node(cf_node
, state
);
853 state
->parent_node
= old_parent
;
854 state
->loop
= old_loop
;
858 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
860 validate_assert(state
, node
->parent
== state
->parent_node
);
862 switch (node
->type
) {
863 case nir_cf_node_block
:
864 validate_block(nir_cf_node_as_block(node
), state
);
868 validate_if(nir_cf_node_as_if(node
), state
);
871 case nir_cf_node_loop
:
872 validate_loop(nir_cf_node_as_loop(node
), state
);
876 unreachable("Invalid CF node type");
881 prevalidate_reg_decl(nir_register
*reg
, bool is_global
, validate_state
*state
)
883 validate_assert(state
, reg
->is_global
== is_global
);
886 validate_assert(state
, reg
->index
< state
->shader
->reg_alloc
);
888 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
889 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
890 BITSET_SET(state
->regs_found
, reg
->index
);
892 list_validate(®
->uses
);
893 list_validate(®
->defs
);
894 list_validate(®
->if_uses
);
896 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
897 reg_state
->uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
898 _mesa_key_pointer_equal
);
899 reg_state
->if_uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
900 _mesa_key_pointer_equal
);
901 reg_state
->defs
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
902 _mesa_key_pointer_equal
);
904 reg_state
->where_defined
= is_global
? NULL
: state
->impl
;
906 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
910 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
912 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
915 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
917 nir_foreach_use(src
, reg
) {
918 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
919 validate_assert(state
, entry
);
920 _mesa_set_remove(reg_state
->uses
, entry
);
923 if (reg_state
->uses
->entries
!= 0) {
924 printf("extra entries in register uses:\n");
925 struct set_entry
*entry
;
926 set_foreach(reg_state
->uses
, entry
)
927 printf("%p\n", entry
->key
);
932 nir_foreach_if_use(src
, reg
) {
933 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
934 validate_assert(state
, entry
);
935 _mesa_set_remove(reg_state
->if_uses
, entry
);
938 if (reg_state
->if_uses
->entries
!= 0) {
939 printf("extra entries in register if_uses:\n");
940 struct set_entry
*entry
;
941 set_foreach(reg_state
->if_uses
, entry
)
942 printf("%p\n", entry
->key
);
947 nir_foreach_def(src
, reg
) {
948 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
949 validate_assert(state
, entry
);
950 _mesa_set_remove(reg_state
->defs
, entry
);
953 if (reg_state
->defs
->entries
!= 0) {
954 printf("extra entries in register defs:\n");
955 struct set_entry
*entry
;
956 set_foreach(reg_state
->defs
, entry
)
957 printf("%p\n", entry
->key
);
964 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
968 validate_assert(state
, is_global
== nir_variable_is_global(var
));
970 /* Must have exactly one mode set */
971 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
973 if (var
->data
.compact
) {
974 /* The "compact" flag is only valid on arrays of scalars. */
975 assert(glsl_type_is_array(var
->type
));
977 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
978 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
979 assert(glsl_type_is_array(type
));
980 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
982 assert(glsl_type_is_scalar(type
));
987 * TODO validate some things ir_validate.cpp does (requires more GLSL type
991 _mesa_hash_table_insert(state
->var_defs
, var
,
992 is_global
? NULL
: state
->impl
);
998 postvalidate_ssa_def(nir_ssa_def
*def
, void *void_state
)
1000 validate_state
*state
= void_state
;
1002 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, def
);
1005 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
1007 nir_foreach_use(src
, def
) {
1008 struct set_entry
*entry
= _mesa_set_search(def_state
->uses
, src
);
1009 validate_assert(state
, entry
);
1010 _mesa_set_remove(def_state
->uses
, entry
);
1013 if (def_state
->uses
->entries
!= 0) {
1014 printf("extra entries in SSA def uses:\n");
1015 struct set_entry
*entry
;
1016 set_foreach(def_state
->uses
, entry
)
1017 printf("%p\n", entry
->key
);
1022 nir_foreach_if_use(src
, def
) {
1023 struct set_entry
*entry
= _mesa_set_search(def_state
->if_uses
, src
);
1024 validate_assert(state
, entry
);
1025 _mesa_set_remove(def_state
->if_uses
, entry
);
1028 if (def_state
->if_uses
->entries
!= 0) {
1029 printf("extra entries in SSA def uses:\n");
1030 struct set_entry
*entry
;
1031 set_foreach(def_state
->if_uses
, entry
)
1032 printf("%p\n", entry
->key
);
1041 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1043 validate_assert(state
, impl
->function
->impl
== impl
);
1044 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1046 validate_assert(state
, impl
->num_params
== impl
->function
->num_params
);
1047 for (unsigned i
= 0; i
< impl
->num_params
; i
++) {
1048 validate_assert(state
, impl
->params
[i
]->type
== impl
->function
->params
[i
].type
);
1049 validate_assert(state
, impl
->params
[i
]->data
.mode
== nir_var_param
);
1050 validate_assert(state
, impl
->params
[i
]->data
.location
== i
);
1051 validate_var_decl(impl
->params
[i
], false, state
);
1054 if (glsl_type_is_void(impl
->function
->return_type
)) {
1055 validate_assert(state
, impl
->return_var
== NULL
);
1057 validate_assert(state
, impl
->return_var
->type
== impl
->function
->return_type
);
1058 validate_assert(state
, impl
->return_var
->data
.mode
== nir_var_param
);
1059 validate_assert(state
, impl
->return_var
->data
.location
== -1);
1060 validate_var_decl(impl
->return_var
, false, state
);
1063 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1064 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1065 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1068 state
->parent_node
= &impl
->cf_node
;
1070 exec_list_validate(&impl
->locals
);
1071 nir_foreach_variable(var
, &impl
->locals
) {
1072 validate_var_decl(var
, false, state
);
1075 state
->regs_found
= realloc(state
->regs_found
,
1076 BITSET_WORDS(impl
->reg_alloc
) *
1077 sizeof(BITSET_WORD
));
1078 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1079 sizeof(BITSET_WORD
));
1080 exec_list_validate(&impl
->registers
);
1081 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1082 prevalidate_reg_decl(reg
, false, state
);
1085 state
->ssa_defs_found
= realloc(state
->ssa_defs_found
,
1086 BITSET_WORDS(impl
->ssa_alloc
) *
1087 sizeof(BITSET_WORD
));
1088 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1089 sizeof(BITSET_WORD
));
1090 exec_list_validate(&impl
->body
);
1091 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1092 validate_cf_node(node
, state
);
1095 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1096 postvalidate_reg_decl(reg
, state
);
1099 nir_foreach_block(block
, impl
) {
1100 nir_foreach_instr(instr
, block
)
1101 nir_foreach_ssa_def(instr
, postvalidate_ssa_def
, state
);
1106 validate_function(nir_function
*func
, validate_state
*state
)
1108 if (func
->impl
!= NULL
) {
1109 validate_assert(state
, func
->impl
->function
== func
);
1110 validate_function_impl(func
->impl
, state
);
1115 init_validate_state(validate_state
*state
)
1117 state
->regs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1118 _mesa_key_pointer_equal
);
1119 state
->ssa_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1120 _mesa_key_pointer_equal
);
1121 state
->ssa_defs_found
= NULL
;
1122 state
->regs_found
= NULL
;
1123 state
->var_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1124 _mesa_key_pointer_equal
);
1125 state
->errors
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1126 _mesa_key_pointer_equal
);
1129 state
->instr
= NULL
;
1134 destroy_validate_state(validate_state
*state
)
1136 _mesa_hash_table_destroy(state
->regs
, NULL
);
1137 _mesa_hash_table_destroy(state
->ssa_defs
, NULL
);
1138 free(state
->ssa_defs_found
);
1139 free(state
->regs_found
);
1140 _mesa_hash_table_destroy(state
->var_defs
, NULL
);
1141 _mesa_hash_table_destroy(state
->errors
, NULL
);
1145 dump_errors(validate_state
*state
)
1147 struct hash_table
*errors
= state
->errors
;
1149 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1151 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1153 if (_mesa_hash_table_num_entries(errors
) > 0) {
1154 fprintf(stderr
, "%d additional errors:\n",
1155 _mesa_hash_table_num_entries(errors
));
1156 struct hash_entry
*entry
;
1157 hash_table_foreach(errors
, entry
) {
1158 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1166 nir_validate_shader(nir_shader
*shader
)
1168 static int should_validate
= -1;
1169 if (should_validate
< 0)
1170 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1171 if (!should_validate
)
1174 validate_state state
;
1175 init_validate_state(&state
);
1177 state
.shader
= shader
;
1179 exec_list_validate(&shader
->uniforms
);
1180 nir_foreach_variable(var
, &shader
->uniforms
) {
1181 validate_var_decl(var
, true, &state
);
1184 exec_list_validate(&shader
->inputs
);
1185 nir_foreach_variable(var
, &shader
->inputs
) {
1186 validate_var_decl(var
, true, &state
);
1189 exec_list_validate(&shader
->outputs
);
1190 nir_foreach_variable(var
, &shader
->outputs
) {
1191 validate_var_decl(var
, true, &state
);
1194 exec_list_validate(&shader
->shared
);
1195 nir_foreach_variable(var
, &shader
->shared
) {
1196 validate_var_decl(var
, true, &state
);
1199 exec_list_validate(&shader
->globals
);
1200 nir_foreach_variable(var
, &shader
->globals
) {
1201 validate_var_decl(var
, true, &state
);
1204 exec_list_validate(&shader
->system_values
);
1205 nir_foreach_variable(var
, &shader
->system_values
) {
1206 validate_var_decl(var
, true, &state
);
1209 state
.regs_found
= realloc(state
.regs_found
,
1210 BITSET_WORDS(shader
->reg_alloc
) *
1211 sizeof(BITSET_WORD
));
1212 memset(state
.regs_found
, 0, BITSET_WORDS(shader
->reg_alloc
) *
1213 sizeof(BITSET_WORD
));
1214 exec_list_validate(&shader
->registers
);
1215 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1216 prevalidate_reg_decl(reg
, true, &state
);
1219 exec_list_validate(&shader
->functions
);
1220 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1221 validate_function(func
, &state
);
1224 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1225 postvalidate_reg_decl(reg
, &state
);
1228 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1229 dump_errors(&state
);
1231 destroy_validate_state(&state
);