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 local variable -> function implementation where it is defined */
100 struct hash_table
*var_defs
;
102 /* map of instruction/var/etc to failed assert string */
103 struct hash_table
*errors
;
107 log_error(validate_state
*state
, const char *cond
, const char *file
, int line
)
118 char *msg
= ralloc_asprintf(state
->errors
, "error: %s (%s:%d)",
121 _mesa_hash_table_insert(state
->errors
, obj
, msg
);
124 #define validate_assert(state, cond) do { \
126 log_error(state, #cond, __FILE__, __LINE__); \
129 static void validate_src(nir_src
*src
, validate_state
*state
,
130 unsigned bit_size
, unsigned num_components
);
133 validate_reg_src(nir_src
*src
, validate_state
*state
,
134 unsigned bit_size
, unsigned num_components
)
136 validate_assert(state
, src
->reg
.reg
!= NULL
);
138 struct hash_entry
*entry
;
139 entry
= _mesa_hash_table_search(state
->regs
, src
->reg
.reg
);
140 validate_assert(state
, entry
);
142 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
145 _mesa_set_add(reg_state
->uses
, src
);
147 validate_assert(state
, state
->if_stmt
);
148 _mesa_set_add(reg_state
->if_uses
, src
);
151 if (!src
->reg
.reg
->is_global
) {
152 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
153 "using a register declared in a different function");
156 if (!src
->reg
.reg
->is_packed
) {
158 validate_assert(state
, src
->reg
.reg
->bit_size
== bit_size
);
160 validate_assert(state
, src
->reg
.reg
->num_components
== num_components
);
163 validate_assert(state
, (src
->reg
.reg
->num_array_elems
== 0 ||
164 src
->reg
.base_offset
< src
->reg
.reg
->num_array_elems
) &&
165 "definitely out-of-bounds array access");
167 if (src
->reg
.indirect
) {
168 validate_assert(state
, src
->reg
.reg
->num_array_elems
!= 0);
169 validate_assert(state
, (src
->reg
.indirect
->is_ssa
||
170 src
->reg
.indirect
->reg
.indirect
== NULL
) &&
171 "only one level of indirection allowed");
172 validate_src(src
->reg
.indirect
, state
, 32, 1);
177 validate_ssa_src(nir_src
*src
, validate_state
*state
,
178 unsigned bit_size
, unsigned num_components
)
180 validate_assert(state
, src
->ssa
!= NULL
);
182 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, src
->ssa
);
184 validate_assert(state
, entry
);
189 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
191 validate_assert(state
, def_state
->where_defined
== state
->impl
&&
192 "using an SSA value defined in a different function");
195 _mesa_set_add(def_state
->uses
, src
);
197 validate_assert(state
, state
->if_stmt
);
198 _mesa_set_add(def_state
->if_uses
, src
);
202 validate_assert(state
, src
->ssa
->bit_size
== bit_size
);
204 validate_assert(state
, src
->ssa
->num_components
== num_components
);
206 /* TODO validate that the use is dominated by the definition */
210 validate_src(nir_src
*src
, validate_state
*state
,
211 unsigned bit_size
, unsigned num_components
)
214 validate_assert(state
, src
->parent_instr
== state
->instr
);
216 validate_assert(state
, src
->parent_if
== state
->if_stmt
);
219 validate_ssa_src(src
, state
, bit_size
, num_components
);
221 validate_reg_src(src
, state
, bit_size
, num_components
);
225 validate_alu_src(nir_alu_instr
*instr
, unsigned index
, validate_state
*state
)
227 nir_alu_src
*src
= &instr
->src
[index
];
229 unsigned num_components
;
230 if (src
->src
.is_ssa
) {
231 num_components
= src
->src
.ssa
->num_components
;
233 if (src
->src
.reg
.reg
->is_packed
)
234 num_components
= 4; /* can't check anything */
236 num_components
= src
->src
.reg
.reg
->num_components
;
238 for (unsigned i
= 0; i
< 4; i
++) {
239 validate_assert(state
, src
->swizzle
[i
] < 4);
241 if (nir_alu_instr_channel_used(instr
, index
, i
))
242 validate_assert(state
, src
->swizzle
[i
] < num_components
);
245 validate_src(&src
->src
, state
, 0, 0);
249 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
250 unsigned bit_size
, unsigned num_components
)
252 validate_assert(state
, dest
->reg
!= NULL
);
254 validate_assert(state
, dest
->parent_instr
== state
->instr
);
256 struct hash_entry
*entry2
;
257 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
259 validate_assert(state
, entry2
);
261 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
262 _mesa_set_add(reg_state
->defs
, dest
);
264 if (!dest
->reg
->is_global
) {
265 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
266 "writing to a register declared in a different function");
269 if (!dest
->reg
->is_packed
) {
271 validate_assert(state
, dest
->reg
->bit_size
== bit_size
);
273 validate_assert(state
, dest
->reg
->num_components
== num_components
);
276 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
277 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
278 "definitely out-of-bounds array access");
280 if (dest
->indirect
) {
281 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
282 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
283 "only one level of indirection allowed");
284 validate_src(dest
->indirect
, state
, 32, 1);
289 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
291 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
292 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
293 BITSET_SET(state
->ssa_defs_found
, def
->index
);
295 validate_assert(state
, def
->parent_instr
== state
->instr
);
297 validate_assert(state
, (def
->num_components
<= 4) ||
298 (def
->num_components
== 8) ||
299 (def
->num_components
== 16));
301 list_validate(&def
->uses
);
302 list_validate(&def
->if_uses
);
304 ssa_def_validate_state
*def_state
= ralloc(state
->ssa_defs
,
305 ssa_def_validate_state
);
306 def_state
->where_defined
= state
->impl
;
307 def_state
->uses
= _mesa_set_create(def_state
, _mesa_hash_pointer
,
308 _mesa_key_pointer_equal
);
309 def_state
->if_uses
= _mesa_set_create(def_state
, _mesa_hash_pointer
,
310 _mesa_key_pointer_equal
);
311 _mesa_hash_table_insert(state
->ssa_defs
, def
, def_state
);
315 validate_dest(nir_dest
*dest
, validate_state
*state
,
316 unsigned bit_size
, unsigned num_components
)
320 validate_assert(state
, dest
->ssa
.bit_size
== bit_size
);
322 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
323 validate_ssa_def(&dest
->ssa
, state
);
325 validate_reg_dest(&dest
->reg
, state
, bit_size
, num_components
);
330 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
332 nir_alu_dest
*dest
= &instr
->dest
;
335 dest
->dest
.is_ssa
? dest
->dest
.ssa
.num_components
336 : dest
->dest
.reg
.reg
->num_components
;
337 bool is_packed
= !dest
->dest
.is_ssa
&& dest
->dest
.reg
.reg
->is_packed
;
339 * validate that the instruction doesn't write to components not in the
342 validate_assert(state
, is_packed
|| !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
344 /* validate that saturate is only ever used on instructions with
345 * destinations of type float
347 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
348 validate_assert(state
,
349 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
353 validate_dest(&dest
->dest
, state
, 0, 0);
357 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
359 validate_assert(state
, instr
->op
< nir_num_opcodes
);
361 unsigned instr_bit_size
= 0;
362 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
363 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
364 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
365 if (nir_alu_type_get_type_size(src_type
)) {
366 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
367 } else if (instr_bit_size
) {
368 validate_assert(state
, src_bit_size
== instr_bit_size
);
370 instr_bit_size
= src_bit_size
;
373 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
374 /* 8-bit float isn't a thing */
375 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
379 validate_alu_src(instr
, i
, state
);
382 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
383 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
384 if (nir_alu_type_get_type_size(dest_type
)) {
385 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
386 } else if (instr_bit_size
) {
387 validate_assert(state
, dest_bit_size
== instr_bit_size
);
389 /* The only unsized thing is the destination so it's vacuously valid */
392 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
393 /* 8-bit float isn't a thing */
394 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
395 dest_bit_size
== 64);
398 validate_alu_dest(instr
, state
);
402 validate_deref_chain(nir_deref
*deref
, nir_variable_mode mode
,
403 validate_state
*state
)
405 validate_assert(state
, deref
->child
== NULL
|| ralloc_parent(deref
->child
) == deref
);
407 nir_deref
*parent
= NULL
;
408 while (deref
!= NULL
) {
409 switch (deref
->deref_type
) {
410 case nir_deref_type_array
:
411 if (mode
== nir_var_shared
) {
412 /* Shared variables have a bit more relaxed rules because we need
413 * to be able to handle array derefs on vectors. Fortunately,
414 * nir_lower_io handles these just fine.
416 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
417 glsl_type_is_matrix(parent
->type
) ||
418 glsl_type_is_vector(parent
->type
));
420 /* Most of NIR cannot handle array derefs on vectors */
421 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
422 glsl_type_is_matrix(parent
->type
));
424 validate_assert(state
, deref
->type
== glsl_get_array_element(parent
->type
));
425 if (nir_deref_as_array(deref
)->deref_array_type
==
426 nir_deref_array_type_indirect
)
427 validate_src(&nir_deref_as_array(deref
)->indirect
, state
, 32, 1);
430 case nir_deref_type_struct
:
431 assume(parent
); /* cannot happen: deref change starts w/ nir_deref_var */
432 validate_assert(state
, deref
->type
==
433 glsl_get_struct_field(parent
->type
,
434 nir_deref_as_struct(deref
)->index
));
437 case nir_deref_type_var
:
441 validate_assert(state
, !"Invalid deref type");
446 deref
= deref
->child
;
451 validate_var_use(nir_variable
*var
, validate_state
*state
)
453 if (var
->data
.mode
== nir_var_local
) {
454 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
456 validate_assert(state
, entry
);
457 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
462 validate_deref_var(void *parent_mem_ctx
, nir_deref_var
*deref
, validate_state
*state
)
464 validate_assert(state
, deref
!= NULL
);
465 validate_assert(state
, ralloc_parent(deref
) == parent_mem_ctx
);
466 validate_assert(state
, deref
->deref
.type
== deref
->var
->type
);
468 validate_var_use(deref
->var
, state
);
470 validate_deref_chain(&deref
->deref
, deref
->var
->data
.mode
, state
);
474 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
476 unsigned bit_size
= 0;
477 if (instr
->intrinsic
== nir_intrinsic_load_var
||
478 instr
->intrinsic
== nir_intrinsic_store_var
) {
479 const struct glsl_type
*type
=
480 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
481 bit_size
= glsl_get_bit_size(type
);
484 unsigned num_srcs
= nir_intrinsic_infos
[instr
->intrinsic
].num_srcs
;
485 for (unsigned i
= 0; i
< num_srcs
; i
++) {
486 unsigned components_read
=
487 nir_intrinsic_infos
[instr
->intrinsic
].src_components
[i
];
488 if (components_read
== 0)
489 components_read
= instr
->num_components
;
491 validate_assert(state
, components_read
> 0);
493 validate_src(&instr
->src
[i
], state
, bit_size
, components_read
);
496 unsigned num_vars
= nir_intrinsic_infos
[instr
->intrinsic
].num_variables
;
497 for (unsigned i
= 0; i
< num_vars
; i
++) {
498 validate_deref_var(instr
, instr
->variables
[i
], state
);
501 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
502 unsigned components_written
=
503 nir_intrinsic_infos
[instr
->intrinsic
].dest_components
;
504 if (components_written
== 0)
505 components_written
= instr
->num_components
;
507 validate_assert(state
, components_written
> 0);
509 validate_dest(&instr
->dest
, state
, bit_size
, components_written
);
512 switch (instr
->intrinsic
) {
513 case nir_intrinsic_load_var
: {
514 const struct glsl_type
*type
=
515 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
516 validate_assert(state
, glsl_type_is_vector_or_scalar(type
) ||
517 (instr
->variables
[0]->var
->data
.mode
== nir_var_uniform
&&
518 glsl_get_base_type(type
) == GLSL_TYPE_SUBROUTINE
));
519 validate_assert(state
, instr
->num_components
== glsl_get_vector_elements(type
));
522 case nir_intrinsic_store_var
: {
523 const struct glsl_type
*type
=
524 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
525 validate_assert(state
, glsl_type_is_vector_or_scalar(type
) ||
526 (instr
->variables
[0]->var
->data
.mode
== nir_var_uniform
&&
527 glsl_get_base_type(type
) == GLSL_TYPE_SUBROUTINE
));
528 validate_assert(state
, instr
->num_components
== glsl_get_vector_elements(type
));
529 validate_assert(state
, instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_in
&&
530 instr
->variables
[0]->var
->data
.mode
!= nir_var_uniform
&&
531 instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_storage
);
532 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
535 case nir_intrinsic_copy_var
:
536 validate_assert(state
, nir_deref_tail(&instr
->variables
[0]->deref
)->type
==
537 nir_deref_tail(&instr
->variables
[1]->deref
)->type
);
538 validate_assert(state
, instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_in
&&
539 instr
->variables
[0]->var
->data
.mode
!= nir_var_uniform
&&
540 instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_storage
);
548 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
550 bool src_type_seen
[nir_num_tex_src_types
];
551 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
552 src_type_seen
[i
] = false;
554 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
555 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
556 src_type_seen
[instr
->src
[i
].src_type
] = true;
557 validate_src(&instr
->src
[i
].src
, state
,
558 0, nir_tex_instr_src_size(instr
, i
));
561 if (instr
->texture
!= NULL
)
562 validate_deref_var(instr
, instr
->texture
, state
);
564 if (instr
->sampler
!= NULL
)
565 validate_deref_var(instr
, instr
->sampler
, state
);
567 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
571 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
573 if (instr
->return_deref
== NULL
) {
574 validate_assert(state
, glsl_type_is_void(instr
->callee
->return_type
));
576 validate_assert(state
, instr
->return_deref
->deref
.type
== instr
->callee
->return_type
);
577 validate_deref_var(instr
, instr
->return_deref
, state
);
580 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
582 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
583 validate_assert(state
, instr
->callee
->params
[i
].type
== instr
->params
[i
]->deref
.type
);
584 validate_deref_var(instr
, instr
->params
[i
], state
);
589 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
591 validate_ssa_def(&instr
->def
, state
);
595 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
597 validate_ssa_def(&instr
->def
, state
);
601 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
604 * don't validate the sources until we get to them from their predecessor
605 * basic blocks, to avoid validating an SSA use before its definition.
608 validate_dest(&instr
->dest
, state
, 0, 0);
610 exec_list_validate(&instr
->srcs
);
611 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
612 state
->block
->predecessors
->entries
);
616 validate_instr(nir_instr
*instr
, validate_state
*state
)
618 validate_assert(state
, instr
->block
== state
->block
);
620 state
->instr
= instr
;
622 switch (instr
->type
) {
623 case nir_instr_type_alu
:
624 validate_alu_instr(nir_instr_as_alu(instr
), state
);
627 case nir_instr_type_call
:
628 validate_call_instr(nir_instr_as_call(instr
), state
);
631 case nir_instr_type_intrinsic
:
632 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
635 case nir_instr_type_tex
:
636 validate_tex_instr(nir_instr_as_tex(instr
), state
);
639 case nir_instr_type_load_const
:
640 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
643 case nir_instr_type_phi
:
644 validate_phi_instr(nir_instr_as_phi(instr
), state
);
647 case nir_instr_type_ssa_undef
:
648 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
651 case nir_instr_type_jump
:
655 validate_assert(state
, !"Invalid ALU instruction type");
663 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
665 state
->instr
= &instr
->instr
;
667 validate_assert(state
, instr
->dest
.is_ssa
);
669 exec_list_validate(&instr
->srcs
);
670 nir_foreach_phi_src(src
, instr
) {
671 if (src
->pred
== pred
) {
672 validate_assert(state
, src
->src
.is_ssa
);
673 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
674 instr
->dest
.ssa
.num_components
);
684 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
686 nir_foreach_instr(instr
, succ
) {
687 if (instr
->type
!= nir_instr_type_phi
)
690 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
694 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
697 validate_block(nir_block
*block
, validate_state
*state
)
699 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
701 state
->block
= block
;
703 exec_list_validate(&block
->instr_list
);
704 nir_foreach_instr(instr
, block
) {
705 if (instr
->type
== nir_instr_type_phi
) {
706 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
707 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
710 if (instr
->type
== nir_instr_type_jump
) {
711 validate_assert(state
, instr
== nir_block_last_instr(block
));
714 validate_instr(instr
, state
);
717 validate_assert(state
, block
->successors
[0] != NULL
);
718 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
720 for (unsigned i
= 0; i
< 2; i
++) {
721 if (block
->successors
[i
] != NULL
) {
722 struct set_entry
*entry
=
723 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
724 validate_assert(state
, entry
);
726 validate_phi_srcs(block
, block
->successors
[i
], state
);
730 struct set_entry
*entry
;
731 set_foreach(block
->predecessors
, entry
) {
732 const nir_block
*pred
= entry
->key
;
733 validate_assert(state
, pred
->successors
[0] == block
||
734 pred
->successors
[1] == block
);
737 if (!exec_list_is_empty(&block
->instr_list
) &&
738 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
739 validate_assert(state
, block
->successors
[1] == NULL
);
740 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
741 switch (jump
->type
) {
742 case nir_jump_break
: {
744 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
745 validate_assert(state
, block
->successors
[0] == after
);
749 case nir_jump_continue
: {
750 nir_block
*first
= nir_loop_first_block(state
->loop
);
751 validate_assert(state
, block
->successors
[0] == first
);
755 case nir_jump_return
:
756 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
760 unreachable("bad jump type");
763 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
765 switch (state
->parent_node
->type
) {
766 case nir_cf_node_loop
: {
767 nir_block
*first
= nir_loop_first_block(state
->loop
);
768 validate_assert(state
, block
->successors
[0] == first
);
769 /* due to the hack for infinite loops, block->successors[1] may
770 * point to the block after the loop.
775 case nir_cf_node_if
: {
777 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
778 validate_assert(state
, block
->successors
[0] == after
);
779 validate_assert(state
, block
->successors
[1] == NULL
);
783 case nir_cf_node_function
:
784 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
785 validate_assert(state
, block
->successors
[1] == NULL
);
789 unreachable("unknown control flow node type");
792 if (next
->type
== nir_cf_node_if
) {
793 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
794 validate_assert(state
, block
->successors
[0] ==
795 nir_if_first_then_block(if_stmt
));
796 validate_assert(state
, block
->successors
[1] ==
797 nir_if_first_else_block(if_stmt
));
799 validate_assert(state
, next
->type
== nir_cf_node_loop
);
800 nir_loop
*loop
= nir_cf_node_as_loop(next
);
801 validate_assert(state
, block
->successors
[0] ==
802 nir_loop_first_block(loop
));
803 validate_assert(state
, block
->successors
[1] == NULL
);
810 validate_if(nir_if
*if_stmt
, validate_state
*state
)
812 state
->if_stmt
= if_stmt
;
814 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
815 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
816 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
818 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
819 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
820 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
822 validate_src(&if_stmt
->condition
, state
, 32, 1);
824 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
825 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
827 nir_cf_node
*old_parent
= state
->parent_node
;
828 state
->parent_node
= &if_stmt
->cf_node
;
830 exec_list_validate(&if_stmt
->then_list
);
831 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
832 validate_cf_node(cf_node
, state
);
835 exec_list_validate(&if_stmt
->else_list
);
836 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
837 validate_cf_node(cf_node
, state
);
840 state
->parent_node
= old_parent
;
841 state
->if_stmt
= NULL
;
845 validate_loop(nir_loop
*loop
, validate_state
*state
)
847 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
848 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
849 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
851 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
852 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
853 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
855 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
857 nir_cf_node
*old_parent
= state
->parent_node
;
858 state
->parent_node
= &loop
->cf_node
;
859 nir_loop
*old_loop
= state
->loop
;
862 exec_list_validate(&loop
->body
);
863 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
864 validate_cf_node(cf_node
, state
);
867 state
->parent_node
= old_parent
;
868 state
->loop
= old_loop
;
872 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
874 validate_assert(state
, node
->parent
== state
->parent_node
);
876 switch (node
->type
) {
877 case nir_cf_node_block
:
878 validate_block(nir_cf_node_as_block(node
), state
);
882 validate_if(nir_cf_node_as_if(node
), state
);
885 case nir_cf_node_loop
:
886 validate_loop(nir_cf_node_as_loop(node
), state
);
890 unreachable("Invalid CF node type");
895 prevalidate_reg_decl(nir_register
*reg
, bool is_global
, validate_state
*state
)
897 validate_assert(state
, reg
->is_global
== is_global
);
900 validate_assert(state
, reg
->index
< state
->shader
->reg_alloc
);
902 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
903 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
904 BITSET_SET(state
->regs_found
, reg
->index
);
906 list_validate(®
->uses
);
907 list_validate(®
->defs
);
908 list_validate(®
->if_uses
);
910 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
911 reg_state
->uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
912 _mesa_key_pointer_equal
);
913 reg_state
->if_uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
914 _mesa_key_pointer_equal
);
915 reg_state
->defs
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
916 _mesa_key_pointer_equal
);
918 reg_state
->where_defined
= is_global
? NULL
: state
->impl
;
920 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
924 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
926 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
929 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
931 nir_foreach_use(src
, reg
) {
932 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
933 validate_assert(state
, entry
);
934 _mesa_set_remove(reg_state
->uses
, entry
);
937 if (reg_state
->uses
->entries
!= 0) {
938 printf("extra entries in register uses:\n");
939 struct set_entry
*entry
;
940 set_foreach(reg_state
->uses
, entry
)
941 printf("%p\n", entry
->key
);
946 nir_foreach_if_use(src
, reg
) {
947 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
948 validate_assert(state
, entry
);
949 _mesa_set_remove(reg_state
->if_uses
, entry
);
952 if (reg_state
->if_uses
->entries
!= 0) {
953 printf("extra entries in register if_uses:\n");
954 struct set_entry
*entry
;
955 set_foreach(reg_state
->if_uses
, entry
)
956 printf("%p\n", entry
->key
);
961 nir_foreach_def(src
, reg
) {
962 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
963 validate_assert(state
, entry
);
964 _mesa_set_remove(reg_state
->defs
, entry
);
967 if (reg_state
->defs
->entries
!= 0) {
968 printf("extra entries in register defs:\n");
969 struct set_entry
*entry
;
970 set_foreach(reg_state
->defs
, entry
)
971 printf("%p\n", entry
->key
);
978 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
982 validate_assert(state
, is_global
== nir_variable_is_global(var
));
984 /* Must have exactly one mode set */
985 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
987 if (var
->data
.compact
) {
988 /* The "compact" flag is only valid on arrays of scalars. */
989 assert(glsl_type_is_array(var
->type
));
991 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
992 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
993 assert(glsl_type_is_array(type
));
994 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
996 assert(glsl_type_is_scalar(type
));
1001 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1006 _mesa_hash_table_insert(state
->var_defs
, var
, state
->impl
);
1013 postvalidate_ssa_def(nir_ssa_def
*def
, void *void_state
)
1015 validate_state
*state
= void_state
;
1017 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, def
);
1020 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
1022 nir_foreach_use(src
, def
) {
1023 struct set_entry
*entry
= _mesa_set_search(def_state
->uses
, src
);
1024 validate_assert(state
, entry
);
1025 _mesa_set_remove(def_state
->uses
, entry
);
1028 if (def_state
->uses
->entries
!= 0) {
1029 printf("extra entries in SSA def uses:\n");
1030 struct set_entry
*entry
;
1031 set_foreach(def_state
->uses
, entry
)
1032 printf("%p\n", entry
->key
);
1037 nir_foreach_if_use(src
, def
) {
1038 struct set_entry
*entry
= _mesa_set_search(def_state
->if_uses
, src
);
1039 validate_assert(state
, entry
);
1040 _mesa_set_remove(def_state
->if_uses
, entry
);
1043 if (def_state
->if_uses
->entries
!= 0) {
1044 printf("extra entries in SSA def uses:\n");
1045 struct set_entry
*entry
;
1046 set_foreach(def_state
->if_uses
, entry
)
1047 printf("%p\n", entry
->key
);
1056 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1058 validate_assert(state
, impl
->function
->impl
== impl
);
1059 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1061 validate_assert(state
, impl
->num_params
== impl
->function
->num_params
);
1062 for (unsigned i
= 0; i
< impl
->num_params
; i
++) {
1063 validate_assert(state
, impl
->params
[i
]->type
== impl
->function
->params
[i
].type
);
1064 validate_assert(state
, impl
->params
[i
]->data
.mode
== nir_var_param
);
1065 validate_assert(state
, impl
->params
[i
]->data
.location
== i
);
1066 validate_var_decl(impl
->params
[i
], false, state
);
1069 if (glsl_type_is_void(impl
->function
->return_type
)) {
1070 validate_assert(state
, impl
->return_var
== NULL
);
1072 validate_assert(state
, impl
->return_var
->type
== impl
->function
->return_type
);
1073 validate_assert(state
, impl
->return_var
->data
.mode
== nir_var_param
);
1074 validate_assert(state
, impl
->return_var
->data
.location
== -1);
1075 validate_var_decl(impl
->return_var
, false, state
);
1078 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1079 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1080 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1083 state
->parent_node
= &impl
->cf_node
;
1085 exec_list_validate(&impl
->locals
);
1086 nir_foreach_variable(var
, &impl
->locals
) {
1087 validate_var_decl(var
, false, state
);
1090 state
->regs_found
= realloc(state
->regs_found
,
1091 BITSET_WORDS(impl
->reg_alloc
) *
1092 sizeof(BITSET_WORD
));
1093 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1094 sizeof(BITSET_WORD
));
1095 exec_list_validate(&impl
->registers
);
1096 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1097 prevalidate_reg_decl(reg
, false, state
);
1100 state
->ssa_defs_found
= realloc(state
->ssa_defs_found
,
1101 BITSET_WORDS(impl
->ssa_alloc
) *
1102 sizeof(BITSET_WORD
));
1103 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1104 sizeof(BITSET_WORD
));
1105 exec_list_validate(&impl
->body
);
1106 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1107 validate_cf_node(node
, state
);
1110 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1111 postvalidate_reg_decl(reg
, state
);
1114 nir_foreach_block(block
, impl
) {
1115 nir_foreach_instr(instr
, block
)
1116 nir_foreach_ssa_def(instr
, postvalidate_ssa_def
, state
);
1121 validate_function(nir_function
*func
, validate_state
*state
)
1123 if (func
->impl
!= NULL
) {
1124 validate_assert(state
, func
->impl
->function
== func
);
1125 validate_function_impl(func
->impl
, state
);
1130 init_validate_state(validate_state
*state
)
1132 state
->regs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1133 _mesa_key_pointer_equal
);
1134 state
->ssa_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1135 _mesa_key_pointer_equal
);
1136 state
->ssa_defs_found
= NULL
;
1137 state
->regs_found
= NULL
;
1138 state
->var_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1139 _mesa_key_pointer_equal
);
1140 state
->errors
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1141 _mesa_key_pointer_equal
);
1144 state
->instr
= NULL
;
1149 destroy_validate_state(validate_state
*state
)
1151 _mesa_hash_table_destroy(state
->regs
, NULL
);
1152 _mesa_hash_table_destroy(state
->ssa_defs
, NULL
);
1153 free(state
->ssa_defs_found
);
1154 free(state
->regs_found
);
1155 _mesa_hash_table_destroy(state
->var_defs
, NULL
);
1156 _mesa_hash_table_destroy(state
->errors
, NULL
);
1160 dump_errors(validate_state
*state
)
1162 struct hash_table
*errors
= state
->errors
;
1164 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1166 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1168 if (_mesa_hash_table_num_entries(errors
) > 0) {
1169 fprintf(stderr
, "%d additional errors:\n",
1170 _mesa_hash_table_num_entries(errors
));
1171 struct hash_entry
*entry
;
1172 hash_table_foreach(errors
, entry
) {
1173 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1181 nir_validate_shader(nir_shader
*shader
)
1183 static int should_validate
= -1;
1184 if (should_validate
< 0)
1185 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1186 if (!should_validate
)
1189 validate_state state
;
1190 init_validate_state(&state
);
1192 state
.shader
= shader
;
1194 exec_list_validate(&shader
->uniforms
);
1195 nir_foreach_variable(var
, &shader
->uniforms
) {
1196 validate_var_decl(var
, true, &state
);
1199 exec_list_validate(&shader
->inputs
);
1200 nir_foreach_variable(var
, &shader
->inputs
) {
1201 validate_var_decl(var
, true, &state
);
1204 exec_list_validate(&shader
->outputs
);
1205 nir_foreach_variable(var
, &shader
->outputs
) {
1206 validate_var_decl(var
, true, &state
);
1209 exec_list_validate(&shader
->shared
);
1210 nir_foreach_variable(var
, &shader
->shared
) {
1211 validate_var_decl(var
, true, &state
);
1214 exec_list_validate(&shader
->globals
);
1215 nir_foreach_variable(var
, &shader
->globals
) {
1216 validate_var_decl(var
, true, &state
);
1219 exec_list_validate(&shader
->system_values
);
1220 nir_foreach_variable(var
, &shader
->system_values
) {
1221 validate_var_decl(var
, true, &state
);
1224 state
.regs_found
= realloc(state
.regs_found
,
1225 BITSET_WORDS(shader
->reg_alloc
) *
1226 sizeof(BITSET_WORD
));
1227 memset(state
.regs_found
, 0, BITSET_WORDS(shader
->reg_alloc
) *
1228 sizeof(BITSET_WORD
));
1229 exec_list_validate(&shader
->registers
);
1230 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1231 prevalidate_reg_decl(reg
, true, &state
);
1234 exec_list_validate(&shader
->functions
);
1235 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1236 validate_function(func
, &state
);
1239 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1240 postvalidate_reg_decl(reg
, &state
);
1243 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1244 dump_errors(&state
);
1246 destroy_validate_state(&state
);