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
;
232 if (src
->src
.is_ssa
) {
233 num_components
= src
->src
.ssa
->num_components
;
235 if (src
->src
.reg
.reg
->is_packed
)
236 num_components
= 4; /* can't check anything */
238 num_components
= src
->src
.reg
.reg
->num_components
;
240 for (unsigned i
= 0; i
< 4; i
++) {
241 validate_assert(state
, src
->swizzle
[i
] < 4);
243 if (nir_alu_instr_channel_used(instr
, index
, i
))
244 validate_assert(state
, src
->swizzle
[i
] < num_components
);
247 validate_src(&src
->src
, state
, 0, 0);
251 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
252 unsigned bit_size
, unsigned num_components
)
254 validate_assert(state
, dest
->reg
!= NULL
);
256 validate_assert(state
, dest
->parent_instr
== state
->instr
);
258 struct hash_entry
*entry2
;
259 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
261 validate_assert(state
, entry2
);
263 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
264 _mesa_set_add(reg_state
->defs
, dest
);
266 if (!dest
->reg
->is_global
) {
267 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
268 "writing to a register declared in a different function");
271 if (!dest
->reg
->is_packed
) {
273 validate_assert(state
, dest
->reg
->bit_size
== bit_size
);
275 validate_assert(state
, dest
->reg
->num_components
== num_components
);
278 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
279 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
280 "definitely out-of-bounds array access");
282 if (dest
->indirect
) {
283 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
284 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
285 "only one level of indirection allowed");
286 validate_src(dest
->indirect
, state
, 32, 1);
291 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
293 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
294 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
295 BITSET_SET(state
->ssa_defs_found
, def
->index
);
297 validate_assert(state
, def
->parent_instr
== state
->instr
);
299 validate_assert(state
, (def
->num_components
<= 4) ||
300 (def
->num_components
== 8) ||
301 (def
->num_components
== 16));
303 list_validate(&def
->uses
);
304 list_validate(&def
->if_uses
);
306 ssa_def_validate_state
*def_state
= ralloc(state
->ssa_defs
,
307 ssa_def_validate_state
);
308 def_state
->where_defined
= state
->impl
;
309 def_state
->uses
= _mesa_set_create(def_state
, _mesa_hash_pointer
,
310 _mesa_key_pointer_equal
);
311 def_state
->if_uses
= _mesa_set_create(def_state
, _mesa_hash_pointer
,
312 _mesa_key_pointer_equal
);
313 _mesa_hash_table_insert(state
->ssa_defs
, def
, def_state
);
317 validate_dest(nir_dest
*dest
, validate_state
*state
,
318 unsigned bit_size
, unsigned num_components
)
322 validate_assert(state
, dest
->ssa
.bit_size
== bit_size
);
324 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
325 validate_ssa_def(&dest
->ssa
, state
);
327 validate_reg_dest(&dest
->reg
, state
, bit_size
, num_components
);
332 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
334 nir_alu_dest
*dest
= &instr
->dest
;
337 dest
->dest
.is_ssa
? dest
->dest
.ssa
.num_components
338 : dest
->dest
.reg
.reg
->num_components
;
339 bool is_packed
= !dest
->dest
.is_ssa
&& dest
->dest
.reg
.reg
->is_packed
;
341 * validate that the instruction doesn't write to components not in the
344 validate_assert(state
, is_packed
|| !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
346 /* validate that saturate is only ever used on instructions with
347 * destinations of type float
349 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
350 validate_assert(state
,
351 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
355 validate_dest(&dest
->dest
, state
, 0, 0);
359 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
361 validate_assert(state
, instr
->op
< nir_num_opcodes
);
363 unsigned instr_bit_size
= 0;
364 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
365 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
366 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
367 if (nir_alu_type_get_type_size(src_type
)) {
368 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
369 } else if (instr_bit_size
) {
370 validate_assert(state
, src_bit_size
== instr_bit_size
);
372 instr_bit_size
= src_bit_size
;
375 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
376 /* 8-bit float isn't a thing */
377 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
381 validate_alu_src(instr
, i
, state
);
384 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
385 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
386 if (nir_alu_type_get_type_size(dest_type
)) {
387 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
388 } else if (instr_bit_size
) {
389 validate_assert(state
, dest_bit_size
== instr_bit_size
);
391 /* The only unsized thing is the destination so it's vacuously valid */
394 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
395 /* 8-bit float isn't a thing */
396 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
397 dest_bit_size
== 64);
400 validate_alu_dest(instr
, state
);
404 validate_deref_chain(nir_deref
*deref
, nir_variable_mode mode
,
405 validate_state
*state
)
407 validate_assert(state
, deref
->child
== NULL
|| ralloc_parent(deref
->child
) == deref
);
409 nir_deref
*parent
= NULL
;
410 while (deref
!= NULL
) {
411 switch (deref
->deref_type
) {
412 case nir_deref_type_array
:
413 if (mode
== nir_var_shared
) {
414 /* Shared variables have a bit more relaxed rules because we need
415 * to be able to handle array derefs on vectors. Fortunately,
416 * nir_lower_io handles these just fine.
418 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
419 glsl_type_is_matrix(parent
->type
) ||
420 glsl_type_is_vector(parent
->type
));
422 /* Most of NIR cannot handle array derefs on vectors */
423 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
424 glsl_type_is_matrix(parent
->type
));
426 validate_assert(state
, deref
->type
== glsl_get_array_element(parent
->type
));
427 if (nir_deref_as_array(deref
)->deref_array_type
==
428 nir_deref_array_type_indirect
)
429 validate_src(&nir_deref_as_array(deref
)->indirect
, state
, 32, 1);
432 case nir_deref_type_struct
:
433 assume(parent
); /* cannot happen: deref change starts w/ nir_deref_var */
434 validate_assert(state
, deref
->type
==
435 glsl_get_struct_field(parent
->type
,
436 nir_deref_as_struct(deref
)->index
));
439 case nir_deref_type_var
:
443 validate_assert(state
, !"Invalid deref type");
448 deref
= deref
->child
;
453 validate_var_use(nir_variable
*var
, validate_state
*state
)
455 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
456 validate_assert(state
, entry
);
457 if (var
->data
.mode
== nir_var_local
)
458 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
= nir_intrinsic_src_components(instr
, i
);
488 validate_assert(state
, components_read
> 0);
490 validate_src(&instr
->src
[i
], state
, bit_size
, components_read
);
493 unsigned num_vars
= nir_intrinsic_infos
[instr
->intrinsic
].num_variables
;
494 for (unsigned i
= 0; i
< num_vars
; i
++) {
495 validate_deref_var(instr
, instr
->variables
[i
], state
);
498 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
499 unsigned components_written
= nir_intrinsic_dest_components(instr
);
501 validate_assert(state
, components_written
> 0);
503 validate_dest(&instr
->dest
, state
, bit_size
, components_written
);
506 switch (instr
->intrinsic
) {
507 case nir_intrinsic_load_var
: {
508 const struct glsl_type
*type
=
509 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
510 validate_assert(state
, glsl_type_is_vector_or_scalar(type
) ||
511 (instr
->variables
[0]->var
->data
.mode
== nir_var_uniform
&&
512 glsl_get_base_type(type
) == GLSL_TYPE_SUBROUTINE
));
513 validate_assert(state
, instr
->num_components
== glsl_get_vector_elements(type
));
516 case nir_intrinsic_store_var
: {
517 const struct glsl_type
*type
=
518 nir_deref_tail(&instr
->variables
[0]->deref
)->type
;
519 validate_assert(state
, glsl_type_is_vector_or_scalar(type
) ||
520 (instr
->variables
[0]->var
->data
.mode
== nir_var_uniform
&&
521 glsl_get_base_type(type
) == GLSL_TYPE_SUBROUTINE
));
522 validate_assert(state
, instr
->num_components
== glsl_get_vector_elements(type
));
523 validate_assert(state
, instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_in
&&
524 instr
->variables
[0]->var
->data
.mode
!= nir_var_uniform
&&
525 instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_storage
);
526 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
529 case nir_intrinsic_copy_var
:
530 validate_assert(state
, nir_deref_tail(&instr
->variables
[0]->deref
)->type
==
531 nir_deref_tail(&instr
->variables
[1]->deref
)->type
);
532 validate_assert(state
, instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_in
&&
533 instr
->variables
[0]->var
->data
.mode
!= nir_var_uniform
&&
534 instr
->variables
[0]->var
->data
.mode
!= nir_var_shader_storage
);
542 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
544 bool src_type_seen
[nir_num_tex_src_types
];
545 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
546 src_type_seen
[i
] = false;
548 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
549 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
550 src_type_seen
[instr
->src
[i
].src_type
] = true;
551 validate_src(&instr
->src
[i
].src
, state
,
552 0, nir_tex_instr_src_size(instr
, i
));
555 if (instr
->texture
!= NULL
)
556 validate_deref_var(instr
, instr
->texture
, state
);
558 if (instr
->sampler
!= NULL
)
559 validate_deref_var(instr
, instr
->sampler
, state
);
561 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
565 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
567 if (instr
->return_deref
== NULL
) {
568 validate_assert(state
, glsl_type_is_void(instr
->callee
->return_type
));
570 validate_assert(state
, instr
->return_deref
->deref
.type
== instr
->callee
->return_type
);
571 validate_deref_var(instr
, instr
->return_deref
, state
);
574 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
576 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
577 validate_assert(state
, instr
->callee
->params
[i
].type
== instr
->params
[i
]->deref
.type
);
578 validate_deref_var(instr
, instr
->params
[i
], state
);
583 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
585 validate_ssa_def(&instr
->def
, state
);
589 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
591 validate_ssa_def(&instr
->def
, state
);
595 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
598 * don't validate the sources until we get to them from their predecessor
599 * basic blocks, to avoid validating an SSA use before its definition.
602 validate_dest(&instr
->dest
, state
, 0, 0);
604 exec_list_validate(&instr
->srcs
);
605 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
606 state
->block
->predecessors
->entries
);
610 validate_instr(nir_instr
*instr
, validate_state
*state
)
612 validate_assert(state
, instr
->block
== state
->block
);
614 state
->instr
= instr
;
616 switch (instr
->type
) {
617 case nir_instr_type_alu
:
618 validate_alu_instr(nir_instr_as_alu(instr
), state
);
621 case nir_instr_type_call
:
622 validate_call_instr(nir_instr_as_call(instr
), state
);
625 case nir_instr_type_intrinsic
:
626 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
629 case nir_instr_type_tex
:
630 validate_tex_instr(nir_instr_as_tex(instr
), state
);
633 case nir_instr_type_load_const
:
634 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
637 case nir_instr_type_phi
:
638 validate_phi_instr(nir_instr_as_phi(instr
), state
);
641 case nir_instr_type_ssa_undef
:
642 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
645 case nir_instr_type_jump
:
649 validate_assert(state
, !"Invalid ALU instruction type");
657 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
659 state
->instr
= &instr
->instr
;
661 validate_assert(state
, instr
->dest
.is_ssa
);
663 exec_list_validate(&instr
->srcs
);
664 nir_foreach_phi_src(src
, instr
) {
665 if (src
->pred
== pred
) {
666 validate_assert(state
, src
->src
.is_ssa
);
667 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
668 instr
->dest
.ssa
.num_components
);
678 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
680 nir_foreach_instr(instr
, succ
) {
681 if (instr
->type
!= nir_instr_type_phi
)
684 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
688 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
691 validate_block(nir_block
*block
, validate_state
*state
)
693 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
695 state
->block
= block
;
697 exec_list_validate(&block
->instr_list
);
698 nir_foreach_instr(instr
, block
) {
699 if (instr
->type
== nir_instr_type_phi
) {
700 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
701 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
704 if (instr
->type
== nir_instr_type_jump
) {
705 validate_assert(state
, instr
== nir_block_last_instr(block
));
708 validate_instr(instr
, state
);
711 validate_assert(state
, block
->successors
[0] != NULL
);
712 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
714 for (unsigned i
= 0; i
< 2; i
++) {
715 if (block
->successors
[i
] != NULL
) {
716 struct set_entry
*entry
=
717 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
718 validate_assert(state
, entry
);
720 validate_phi_srcs(block
, block
->successors
[i
], state
);
724 struct set_entry
*entry
;
725 set_foreach(block
->predecessors
, entry
) {
726 const nir_block
*pred
= entry
->key
;
727 validate_assert(state
, pred
->successors
[0] == block
||
728 pred
->successors
[1] == block
);
731 if (!exec_list_is_empty(&block
->instr_list
) &&
732 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
733 validate_assert(state
, block
->successors
[1] == NULL
);
734 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
735 switch (jump
->type
) {
736 case nir_jump_break
: {
738 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
739 validate_assert(state
, block
->successors
[0] == after
);
743 case nir_jump_continue
: {
744 nir_block
*first
= nir_loop_first_block(state
->loop
);
745 validate_assert(state
, block
->successors
[0] == first
);
749 case nir_jump_return
:
750 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
754 unreachable("bad jump type");
757 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
759 switch (state
->parent_node
->type
) {
760 case nir_cf_node_loop
: {
761 nir_block
*first
= nir_loop_first_block(state
->loop
);
762 validate_assert(state
, block
->successors
[0] == first
);
763 /* due to the hack for infinite loops, block->successors[1] may
764 * point to the block after the loop.
769 case nir_cf_node_if
: {
771 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
772 validate_assert(state
, block
->successors
[0] == after
);
773 validate_assert(state
, block
->successors
[1] == NULL
);
777 case nir_cf_node_function
:
778 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
779 validate_assert(state
, block
->successors
[1] == NULL
);
783 unreachable("unknown control flow node type");
786 if (next
->type
== nir_cf_node_if
) {
787 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
788 validate_assert(state
, block
->successors
[0] ==
789 nir_if_first_then_block(if_stmt
));
790 validate_assert(state
, block
->successors
[1] ==
791 nir_if_first_else_block(if_stmt
));
793 validate_assert(state
, next
->type
== nir_cf_node_loop
);
794 nir_loop
*loop
= nir_cf_node_as_loop(next
);
795 validate_assert(state
, block
->successors
[0] ==
796 nir_loop_first_block(loop
));
797 validate_assert(state
, block
->successors
[1] == NULL
);
804 validate_if(nir_if
*if_stmt
, validate_state
*state
)
806 state
->if_stmt
= if_stmt
;
808 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
809 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
810 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
812 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
813 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
814 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
816 validate_src(&if_stmt
->condition
, state
, 32, 1);
818 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
819 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
821 nir_cf_node
*old_parent
= state
->parent_node
;
822 state
->parent_node
= &if_stmt
->cf_node
;
824 exec_list_validate(&if_stmt
->then_list
);
825 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
826 validate_cf_node(cf_node
, state
);
829 exec_list_validate(&if_stmt
->else_list
);
830 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
831 validate_cf_node(cf_node
, state
);
834 state
->parent_node
= old_parent
;
835 state
->if_stmt
= NULL
;
839 validate_loop(nir_loop
*loop
, validate_state
*state
)
841 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
842 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
843 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
845 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
846 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
847 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
849 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
851 nir_cf_node
*old_parent
= state
->parent_node
;
852 state
->parent_node
= &loop
->cf_node
;
853 nir_loop
*old_loop
= state
->loop
;
856 exec_list_validate(&loop
->body
);
857 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
858 validate_cf_node(cf_node
, state
);
861 state
->parent_node
= old_parent
;
862 state
->loop
= old_loop
;
866 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
868 validate_assert(state
, node
->parent
== state
->parent_node
);
870 switch (node
->type
) {
871 case nir_cf_node_block
:
872 validate_block(nir_cf_node_as_block(node
), state
);
876 validate_if(nir_cf_node_as_if(node
), state
);
879 case nir_cf_node_loop
:
880 validate_loop(nir_cf_node_as_loop(node
), state
);
884 unreachable("Invalid CF node type");
889 prevalidate_reg_decl(nir_register
*reg
, bool is_global
, validate_state
*state
)
891 validate_assert(state
, reg
->is_global
== is_global
);
894 validate_assert(state
, reg
->index
< state
->shader
->reg_alloc
);
896 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
897 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
898 BITSET_SET(state
->regs_found
, reg
->index
);
900 list_validate(®
->uses
);
901 list_validate(®
->defs
);
902 list_validate(®
->if_uses
);
904 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
905 reg_state
->uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
906 _mesa_key_pointer_equal
);
907 reg_state
->if_uses
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
908 _mesa_key_pointer_equal
);
909 reg_state
->defs
= _mesa_set_create(reg_state
, _mesa_hash_pointer
,
910 _mesa_key_pointer_equal
);
912 reg_state
->where_defined
= is_global
? NULL
: state
->impl
;
914 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
918 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
920 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
923 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
925 nir_foreach_use(src
, reg
) {
926 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
927 validate_assert(state
, entry
);
928 _mesa_set_remove(reg_state
->uses
, entry
);
931 if (reg_state
->uses
->entries
!= 0) {
932 printf("extra entries in register uses:\n");
933 struct set_entry
*entry
;
934 set_foreach(reg_state
->uses
, entry
)
935 printf("%p\n", entry
->key
);
940 nir_foreach_if_use(src
, reg
) {
941 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
942 validate_assert(state
, entry
);
943 _mesa_set_remove(reg_state
->if_uses
, entry
);
946 if (reg_state
->if_uses
->entries
!= 0) {
947 printf("extra entries in register if_uses:\n");
948 struct set_entry
*entry
;
949 set_foreach(reg_state
->if_uses
, entry
)
950 printf("%p\n", entry
->key
);
955 nir_foreach_def(src
, reg
) {
956 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
957 validate_assert(state
, entry
);
958 _mesa_set_remove(reg_state
->defs
, entry
);
961 if (reg_state
->defs
->entries
!= 0) {
962 printf("extra entries in register defs:\n");
963 struct set_entry
*entry
;
964 set_foreach(reg_state
->defs
, entry
)
965 printf("%p\n", entry
->key
);
972 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
976 validate_assert(state
, is_global
== nir_variable_is_global(var
));
978 /* Must have exactly one mode set */
979 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
981 if (var
->data
.compact
) {
982 /* The "compact" flag is only valid on arrays of scalars. */
983 assert(glsl_type_is_array(var
->type
));
985 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
986 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
987 assert(glsl_type_is_array(type
));
988 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
990 assert(glsl_type_is_scalar(type
));
995 * TODO validate some things ir_validate.cpp does (requires more GLSL type
999 _mesa_hash_table_insert(state
->var_defs
, var
,
1000 is_global
? NULL
: state
->impl
);
1006 postvalidate_ssa_def(nir_ssa_def
*def
, void *void_state
)
1008 validate_state
*state
= void_state
;
1010 struct hash_entry
*entry
= _mesa_hash_table_search(state
->ssa_defs
, def
);
1013 ssa_def_validate_state
*def_state
= (ssa_def_validate_state
*)entry
->data
;
1015 nir_foreach_use(src
, def
) {
1016 struct set_entry
*entry
= _mesa_set_search(def_state
->uses
, src
);
1017 validate_assert(state
, entry
);
1018 _mesa_set_remove(def_state
->uses
, entry
);
1021 if (def_state
->uses
->entries
!= 0) {
1022 printf("extra entries in SSA def uses:\n");
1023 struct set_entry
*entry
;
1024 set_foreach(def_state
->uses
, entry
)
1025 printf("%p\n", entry
->key
);
1030 nir_foreach_if_use(src
, def
) {
1031 struct set_entry
*entry
= _mesa_set_search(def_state
->if_uses
, src
);
1032 validate_assert(state
, entry
);
1033 _mesa_set_remove(def_state
->if_uses
, entry
);
1036 if (def_state
->if_uses
->entries
!= 0) {
1037 printf("extra entries in SSA def uses:\n");
1038 struct set_entry
*entry
;
1039 set_foreach(def_state
->if_uses
, entry
)
1040 printf("%p\n", entry
->key
);
1049 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1051 validate_assert(state
, impl
->function
->impl
== impl
);
1052 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1054 validate_assert(state
, impl
->num_params
== impl
->function
->num_params
);
1055 for (unsigned i
= 0; i
< impl
->num_params
; i
++) {
1056 validate_assert(state
, impl
->params
[i
]->type
== impl
->function
->params
[i
].type
);
1057 validate_assert(state
, impl
->params
[i
]->data
.mode
== nir_var_param
);
1058 validate_assert(state
, impl
->params
[i
]->data
.location
== i
);
1059 validate_var_decl(impl
->params
[i
], false, state
);
1062 if (glsl_type_is_void(impl
->function
->return_type
)) {
1063 validate_assert(state
, impl
->return_var
== NULL
);
1065 validate_assert(state
, impl
->return_var
->type
== impl
->function
->return_type
);
1066 validate_assert(state
, impl
->return_var
->data
.mode
== nir_var_param
);
1067 validate_assert(state
, impl
->return_var
->data
.location
== -1);
1068 validate_var_decl(impl
->return_var
, false, state
);
1071 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1072 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1073 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1076 state
->parent_node
= &impl
->cf_node
;
1078 exec_list_validate(&impl
->locals
);
1079 nir_foreach_variable(var
, &impl
->locals
) {
1080 validate_var_decl(var
, false, state
);
1083 state
->regs_found
= realloc(state
->regs_found
,
1084 BITSET_WORDS(impl
->reg_alloc
) *
1085 sizeof(BITSET_WORD
));
1086 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1087 sizeof(BITSET_WORD
));
1088 exec_list_validate(&impl
->registers
);
1089 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1090 prevalidate_reg_decl(reg
, false, state
);
1093 state
->ssa_defs_found
= realloc(state
->ssa_defs_found
,
1094 BITSET_WORDS(impl
->ssa_alloc
) *
1095 sizeof(BITSET_WORD
));
1096 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1097 sizeof(BITSET_WORD
));
1098 exec_list_validate(&impl
->body
);
1099 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1100 validate_cf_node(node
, state
);
1103 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1104 postvalidate_reg_decl(reg
, state
);
1107 nir_foreach_block(block
, impl
) {
1108 nir_foreach_instr(instr
, block
)
1109 nir_foreach_ssa_def(instr
, postvalidate_ssa_def
, state
);
1114 validate_function(nir_function
*func
, validate_state
*state
)
1116 if (func
->impl
!= NULL
) {
1117 validate_assert(state
, func
->impl
->function
== func
);
1118 validate_function_impl(func
->impl
, state
);
1123 init_validate_state(validate_state
*state
)
1125 state
->regs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1126 _mesa_key_pointer_equal
);
1127 state
->ssa_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1128 _mesa_key_pointer_equal
);
1129 state
->ssa_defs_found
= NULL
;
1130 state
->regs_found
= NULL
;
1131 state
->var_defs
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1132 _mesa_key_pointer_equal
);
1133 state
->errors
= _mesa_hash_table_create(NULL
, _mesa_hash_pointer
,
1134 _mesa_key_pointer_equal
);
1137 state
->instr
= NULL
;
1142 destroy_validate_state(validate_state
*state
)
1144 _mesa_hash_table_destroy(state
->regs
, NULL
);
1145 _mesa_hash_table_destroy(state
->ssa_defs
, NULL
);
1146 free(state
->ssa_defs_found
);
1147 free(state
->regs_found
);
1148 _mesa_hash_table_destroy(state
->var_defs
, NULL
);
1149 _mesa_hash_table_destroy(state
->errors
, NULL
);
1153 dump_errors(validate_state
*state
)
1155 struct hash_table
*errors
= state
->errors
;
1157 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1159 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1161 if (_mesa_hash_table_num_entries(errors
) > 0) {
1162 fprintf(stderr
, "%d additional errors:\n",
1163 _mesa_hash_table_num_entries(errors
));
1164 struct hash_entry
*entry
;
1165 hash_table_foreach(errors
, entry
) {
1166 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1174 nir_validate_shader(nir_shader
*shader
)
1176 static int should_validate
= -1;
1177 if (should_validate
< 0)
1178 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1179 if (!should_validate
)
1182 validate_state state
;
1183 init_validate_state(&state
);
1185 state
.shader
= shader
;
1187 exec_list_validate(&shader
->uniforms
);
1188 nir_foreach_variable(var
, &shader
->uniforms
) {
1189 validate_var_decl(var
, true, &state
);
1192 exec_list_validate(&shader
->inputs
);
1193 nir_foreach_variable(var
, &shader
->inputs
) {
1194 validate_var_decl(var
, true, &state
);
1197 exec_list_validate(&shader
->outputs
);
1198 nir_foreach_variable(var
, &shader
->outputs
) {
1199 validate_var_decl(var
, true, &state
);
1202 exec_list_validate(&shader
->shared
);
1203 nir_foreach_variable(var
, &shader
->shared
) {
1204 validate_var_decl(var
, true, &state
);
1207 exec_list_validate(&shader
->globals
);
1208 nir_foreach_variable(var
, &shader
->globals
) {
1209 validate_var_decl(var
, true, &state
);
1212 exec_list_validate(&shader
->system_values
);
1213 nir_foreach_variable(var
, &shader
->system_values
) {
1214 validate_var_decl(var
, true, &state
);
1217 state
.regs_found
= realloc(state
.regs_found
,
1218 BITSET_WORDS(shader
->reg_alloc
) *
1219 sizeof(BITSET_WORD
));
1220 memset(state
.regs_found
, 0, BITSET_WORDS(shader
->reg_alloc
) *
1221 sizeof(BITSET_WORD
));
1222 exec_list_validate(&shader
->registers
);
1223 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1224 prevalidate_reg_decl(reg
, true, &state
);
1227 exec_list_validate(&shader
->functions
);
1228 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1229 validate_function(func
, &state
);
1232 foreach_list_typed(nir_register
, reg
, node
, &shader
->registers
) {
1233 postvalidate_reg_decl(reg
, &state
);
1236 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1237 dump_errors(&state
);
1239 destroy_validate_state(&state
);