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)
29 #include "c11/threads.h"
33 * This file checks for invalid IR indicating a bug somewhere in the compiler.
36 /* Since this file is just a pile of asserts, don't bother compiling it if
37 * we're not building a debug build.
42 * Per-register validation state.
47 * equivalent to the uses and defs in nir_register, but built up by the
48 * validator. At the end, we verify that the sets have the same entries.
50 struct set
*uses
, *if_uses
, *defs
;
51 nir_function_impl
*where_defined
; /* NULL for global registers */
57 /* map of register -> validation state (struct above) */
58 struct hash_table
*regs
;
60 /* the current shader being validated */
63 /* the current instruction being validated */
66 /* the current variable being validated */
69 /* the current basic block being validated */
72 /* the current if statement being validated */
75 /* the current loop being visited */
78 /* the parent of the current cf node being visited */
79 nir_cf_node
*parent_node
;
81 /* the current function implementation being validated */
82 nir_function_impl
*impl
;
84 /* Set of seen SSA sources */
87 /* bitset of ssa definitions we have found; used to check uniqueness */
88 BITSET_WORD
*ssa_defs_found
;
90 /* bitset of registers we have currently found; used to check uniqueness */
91 BITSET_WORD
*regs_found
;
93 /* map of variable -> function implementation where it is defined or NULL
94 * if it is a global variable
96 struct hash_table
*var_defs
;
98 /* map of instruction/var/etc to failed assert string */
99 struct hash_table
*errors
;
103 log_error(validate_state
*state
, const char *cond
, const char *file
, int line
)
114 char *msg
= ralloc_asprintf(state
->errors
, "error: %s (%s:%d)",
117 _mesa_hash_table_insert(state
->errors
, obj
, msg
);
120 #define validate_assert(state, cond) do { \
122 log_error(state, #cond, __FILE__, __LINE__); \
125 static void validate_src(nir_src
*src
, validate_state
*state
,
126 unsigned bit_sizes
, unsigned num_components
);
129 validate_reg_src(nir_src
*src
, validate_state
*state
,
130 unsigned bit_sizes
, unsigned num_components
)
132 validate_assert(state
, src
->reg
.reg
!= NULL
);
134 struct hash_entry
*entry
;
135 entry
= _mesa_hash_table_search(state
->regs
, src
->reg
.reg
);
136 validate_assert(state
, entry
);
138 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
141 _mesa_set_add(reg_state
->uses
, src
);
143 validate_assert(state
, state
->if_stmt
);
144 _mesa_set_add(reg_state
->if_uses
, src
);
147 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
148 "using a register declared in a different function");
151 validate_assert(state
, src
->reg
.reg
->bit_size
& bit_sizes
);
153 validate_assert(state
, src
->reg
.reg
->num_components
== num_components
);
155 validate_assert(state
, (src
->reg
.reg
->num_array_elems
== 0 ||
156 src
->reg
.base_offset
< src
->reg
.reg
->num_array_elems
) &&
157 "definitely out-of-bounds array access");
159 if (src
->reg
.indirect
) {
160 validate_assert(state
, src
->reg
.reg
->num_array_elems
!= 0);
161 validate_assert(state
, (src
->reg
.indirect
->is_ssa
||
162 src
->reg
.indirect
->reg
.indirect
== NULL
) &&
163 "only one level of indirection allowed");
164 validate_src(src
->reg
.indirect
, state
, 32, 1);
168 #define SET_PTR_BIT(ptr, bit) \
169 (void *)(((uintptr_t)(ptr)) | (((uintptr_t)1) << bit))
172 validate_ssa_src(nir_src
*src
, validate_state
*state
,
173 unsigned bit_sizes
, unsigned num_components
)
175 validate_assert(state
, src
->ssa
!= NULL
);
177 /* As we walk SSA defs, we add every use to this set. We need to make sure
178 * our use is seen in a use list.
180 struct set_entry
*entry
;
182 entry
= _mesa_set_search(state
->ssa_srcs
, src
);
184 entry
= _mesa_set_search(state
->ssa_srcs
, SET_PTR_BIT(src
, 0));
186 validate_assert(state
, entry
);
188 /* This will let us prove that we've seen all the sources */
190 _mesa_set_remove(state
->ssa_srcs
, entry
);
193 validate_assert(state
, src
->ssa
->bit_size
& bit_sizes
);
195 validate_assert(state
, src
->ssa
->num_components
== num_components
);
197 /* TODO validate that the use is dominated by the definition */
201 validate_src(nir_src
*src
, validate_state
*state
,
202 unsigned bit_sizes
, unsigned num_components
)
205 validate_assert(state
, src
->parent_instr
== state
->instr
);
207 validate_assert(state
, src
->parent_if
== state
->if_stmt
);
210 validate_ssa_src(src
, state
, bit_sizes
, num_components
);
212 validate_reg_src(src
, state
, bit_sizes
, num_components
);
216 validate_alu_src(nir_alu_instr
*instr
, unsigned index
, validate_state
*state
)
218 nir_alu_src
*src
= &instr
->src
[index
];
220 if (instr
->op
== nir_op_mov
)
221 assert(!src
->abs
&& !src
->negate
);
223 unsigned num_components
= nir_src_num_components(src
->src
);
224 for (unsigned i
= 0; i
< NIR_MAX_VEC_COMPONENTS
; i
++) {
225 validate_assert(state
, src
->swizzle
[i
] < NIR_MAX_VEC_COMPONENTS
);
227 if (nir_alu_instr_channel_used(instr
, index
, i
))
228 validate_assert(state
, src
->swizzle
[i
] < num_components
);
231 validate_src(&src
->src
, state
, 0, 0);
235 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
236 unsigned bit_sizes
, unsigned num_components
)
238 validate_assert(state
, dest
->reg
!= NULL
);
240 validate_assert(state
, dest
->parent_instr
== state
->instr
);
242 struct hash_entry
*entry2
;
243 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
245 validate_assert(state
, entry2
);
247 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
248 _mesa_set_add(reg_state
->defs
, dest
);
250 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
251 "writing to a register declared in a different function");
254 validate_assert(state
, dest
->reg
->bit_size
& bit_sizes
);
256 validate_assert(state
, dest
->reg
->num_components
== num_components
);
258 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
259 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
260 "definitely out-of-bounds array access");
262 if (dest
->indirect
) {
263 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
264 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
265 "only one level of indirection allowed");
266 validate_src(dest
->indirect
, state
, 32, 1);
271 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
273 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
274 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
275 BITSET_SET(state
->ssa_defs_found
, def
->index
);
277 validate_assert(state
, def
->parent_instr
== state
->instr
);
279 validate_assert(state
, (def
->num_components
<= 4) ||
280 (def
->num_components
== 8) ||
281 (def
->num_components
== 16));
283 list_validate(&def
->uses
);
284 nir_foreach_use(src
, def
) {
285 validate_assert(state
, src
->is_ssa
);
286 validate_assert(state
, src
->ssa
== def
);
287 bool already_seen
= false;
288 _mesa_set_search_and_add(state
->ssa_srcs
, src
, &already_seen
);
289 /* A nir_src should only appear once and only in one SSA def use list */
290 validate_assert(state
, !already_seen
);
293 list_validate(&def
->if_uses
);
294 nir_foreach_if_use(src
, def
) {
295 validate_assert(state
, src
->is_ssa
);
296 validate_assert(state
, src
->ssa
== def
);
297 bool already_seen
= false;
298 _mesa_set_search_and_add(state
->ssa_srcs
, SET_PTR_BIT(src
, 0),
300 /* A nir_src should only appear once and only in one SSA def use list */
301 validate_assert(state
, !already_seen
);
306 validate_dest(nir_dest
*dest
, validate_state
*state
,
307 unsigned bit_sizes
, unsigned num_components
)
311 validate_assert(state
, dest
->ssa
.bit_size
& bit_sizes
);
313 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
314 validate_ssa_def(&dest
->ssa
, state
);
316 validate_reg_dest(&dest
->reg
, state
, bit_sizes
, num_components
);
321 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
323 nir_alu_dest
*dest
= &instr
->dest
;
325 if (instr
->op
== nir_op_mov
)
326 assert(!dest
->saturate
);
328 unsigned dest_size
= nir_dest_num_components(dest
->dest
);
330 * validate that the instruction doesn't write to components not in the
333 validate_assert(state
, !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
335 /* validate that saturate is only ever used on instructions with
336 * destinations of type float
338 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
339 validate_assert(state
,
340 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
344 validate_dest(&dest
->dest
, state
, 0, 0);
348 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
350 validate_assert(state
, instr
->op
< nir_num_opcodes
);
352 unsigned instr_bit_size
= 0;
353 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
354 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
355 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
356 if (nir_alu_type_get_type_size(src_type
)) {
357 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
358 } else if (instr_bit_size
) {
359 validate_assert(state
, src_bit_size
== instr_bit_size
);
361 instr_bit_size
= src_bit_size
;
364 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
365 /* 8-bit float isn't a thing */
366 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
370 validate_alu_src(instr
, i
, state
);
373 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
374 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
375 if (nir_alu_type_get_type_size(dest_type
)) {
376 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
377 } else if (instr_bit_size
) {
378 validate_assert(state
, dest_bit_size
== instr_bit_size
);
380 /* The only unsized thing is the destination so it's vacuously valid */
383 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
384 /* 8-bit float isn't a thing */
385 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
386 dest_bit_size
== 64);
389 validate_alu_dest(instr
, state
);
393 validate_var_use(nir_variable
*var
, validate_state
*state
)
395 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
396 validate_assert(state
, entry
);
397 if (entry
&& var
->data
.mode
== nir_var_function_temp
)
398 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
402 validate_deref_instr(nir_deref_instr
*instr
, validate_state
*state
)
404 if (instr
->deref_type
== nir_deref_type_var
) {
405 /* Variable dereferences are stupid simple. */
406 validate_assert(state
, instr
->mode
== instr
->var
->data
.mode
);
407 validate_assert(state
, instr
->type
== instr
->var
->type
);
408 validate_var_use(instr
->var
, state
);
409 } else if (instr
->deref_type
== nir_deref_type_cast
) {
410 /* For cast, we simply have to trust the instruction. It's up to
411 * lowering passes and front/back-ends to make them sane.
413 validate_src(&instr
->parent
, state
, 0, 0);
415 /* We just validate that the type and mode are there */
416 validate_assert(state
, instr
->mode
);
417 validate_assert(state
, instr
->type
);
419 /* We require the parent to be SSA. This may be lifted in the future */
420 validate_assert(state
, instr
->parent
.is_ssa
);
422 /* The parent pointer value must have the same number of components
423 * as the destination.
425 validate_src(&instr
->parent
, state
, nir_dest_bit_size(instr
->dest
),
426 nir_dest_num_components(instr
->dest
));
428 nir_instr
*parent_instr
= instr
->parent
.ssa
->parent_instr
;
430 /* The parent must come from another deref instruction */
431 validate_assert(state
, parent_instr
->type
== nir_instr_type_deref
);
433 nir_deref_instr
*parent
= nir_instr_as_deref(parent_instr
);
435 validate_assert(state
, instr
->mode
== parent
->mode
);
437 switch (instr
->deref_type
) {
438 case nir_deref_type_struct
:
439 validate_assert(state
, glsl_type_is_struct_or_ifc(parent
->type
));
440 validate_assert(state
,
441 instr
->strct
.index
< glsl_get_length(parent
->type
));
442 validate_assert(state
, instr
->type
==
443 glsl_get_struct_field(parent
->type
, instr
->strct
.index
));
446 case nir_deref_type_array
:
447 case nir_deref_type_array_wildcard
:
448 if (instr
->mode
== nir_var_mem_ubo
||
449 instr
->mode
== nir_var_mem_ssbo
||
450 instr
->mode
== nir_var_mem_shared
||
451 instr
->mode
== nir_var_mem_global
) {
452 /* Shared variables and UBO/SSBOs have a bit more relaxed rules
453 * because we need to be able to handle array derefs on vectors.
454 * Fortunately, nir_lower_io handles these just fine.
456 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
457 glsl_type_is_matrix(parent
->type
) ||
458 glsl_type_is_vector(parent
->type
));
460 /* Most of NIR cannot handle array derefs on vectors */
461 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
462 glsl_type_is_matrix(parent
->type
));
464 validate_assert(state
,
465 instr
->type
== glsl_get_array_element(parent
->type
));
467 if (instr
->deref_type
== nir_deref_type_array
) {
468 validate_src(&instr
->arr
.index
, state
,
469 nir_dest_bit_size(instr
->dest
), 1);
473 case nir_deref_type_ptr_as_array
:
474 /* ptr_as_array derefs must have a parent that is either an array,
475 * ptr_as_array, or cast. If the parent is a cast, we get the stride
476 * information (if any) from the cast deref.
478 validate_assert(state
,
479 parent
->deref_type
== nir_deref_type_array
||
480 parent
->deref_type
== nir_deref_type_ptr_as_array
||
481 parent
->deref_type
== nir_deref_type_cast
);
482 validate_src(&instr
->arr
.index
, state
,
483 nir_dest_bit_size(instr
->dest
), 1);
487 unreachable("Invalid deref instruction type");
491 /* We intentionally don't validate the size of the destination because we
492 * want to let other compiler components such as SPIR-V decide how big
493 * pointers should be.
495 validate_dest(&instr
->dest
, state
, 0, 0);
497 /* Deref instructions as if conditions don't make sense because if
498 * conditions expect well-formed Booleans. If you want to compare with
499 * NULL, an explicit comparison operation should be used.
501 validate_assert(state
, list_empty(&instr
->dest
.ssa
.if_uses
));
505 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
507 unsigned dest_bit_size
= 0;
508 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
509 switch (instr
->intrinsic
) {
510 case nir_intrinsic_load_param
: {
511 unsigned param_idx
= nir_intrinsic_param_idx(instr
);
512 validate_assert(state
, param_idx
< state
->impl
->function
->num_params
);
513 nir_parameter
*param
= &state
->impl
->function
->params
[param_idx
];
514 validate_assert(state
, instr
->num_components
== param
->num_components
);
515 dest_bit_size
= param
->bit_size
;
519 case nir_intrinsic_load_deref
: {
520 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[0]);
521 validate_assert(state
, glsl_type_is_vector_or_scalar(src
->type
) ||
522 (src
->mode
== nir_var_uniform
&&
523 glsl_get_base_type(src
->type
) == GLSL_TYPE_SUBROUTINE
));
524 validate_assert(state
, instr
->num_components
==
525 glsl_get_vector_elements(src
->type
));
526 dest_bit_size
= glsl_get_bit_size(src
->type
);
527 /* Also allow 32-bit boolean load operations */
528 if (glsl_type_is_boolean(src
->type
))
533 case nir_intrinsic_store_deref
: {
534 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
535 validate_assert(state
, glsl_type_is_vector_or_scalar(dst
->type
));
536 validate_assert(state
, instr
->num_components
==
537 glsl_get_vector_elements(dst
->type
));
538 src_bit_sizes
[1] = glsl_get_bit_size(dst
->type
);
539 /* Also allow 32-bit boolean store operations */
540 if (glsl_type_is_boolean(dst
->type
))
541 src_bit_sizes
[1] |= 32;
542 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
543 nir_var_uniform
)) == 0);
544 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
548 case nir_intrinsic_copy_deref
: {
549 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
550 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[1]);
551 validate_assert(state
, glsl_get_bare_type(dst
->type
) ==
552 glsl_get_bare_type(src
->type
));
553 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
554 nir_var_uniform
)) == 0);
562 unsigned num_srcs
= nir_intrinsic_infos
[instr
->intrinsic
].num_srcs
;
563 for (unsigned i
= 0; i
< num_srcs
; i
++) {
564 unsigned components_read
= nir_intrinsic_src_components(instr
, i
);
566 validate_assert(state
, components_read
> 0);
568 validate_src(&instr
->src
[i
], state
, src_bit_sizes
[i
], components_read
);
571 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
572 unsigned components_written
= nir_intrinsic_dest_components(instr
);
573 unsigned bit_sizes
= nir_intrinsic_infos
[instr
->intrinsic
].dest_bit_sizes
;
575 validate_assert(state
, components_written
> 0);
577 if (dest_bit_size
&& bit_sizes
)
578 validate_assert(state
, dest_bit_size
& bit_sizes
);
580 dest_bit_size
= dest_bit_size
? dest_bit_size
: bit_sizes
;
582 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
587 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
589 bool src_type_seen
[nir_num_tex_src_types
];
590 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
591 src_type_seen
[i
] = false;
593 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
594 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
595 src_type_seen
[instr
->src
[i
].src_type
] = true;
596 validate_src(&instr
->src
[i
].src
, state
,
597 0, nir_tex_instr_src_size(instr
, i
));
599 switch (instr
->src
[i
].src_type
) {
600 case nir_tex_src_texture_deref
:
601 case nir_tex_src_sampler_deref
:
602 validate_assert(state
, instr
->src
[i
].src
.is_ssa
);
603 validate_assert(state
,
604 instr
->src
[i
].src
.ssa
->parent_instr
->type
== nir_instr_type_deref
);
611 if (nir_tex_instr_has_explicit_tg4_offsets(instr
)) {
612 validate_assert(state
, instr
->op
== nir_texop_tg4
);
613 validate_assert(state
, !src_type_seen
[nir_tex_src_offset
]);
616 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
620 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
622 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
624 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
625 validate_src(&instr
->params
[i
], state
,
626 instr
->callee
->params
[i
].bit_size
,
627 instr
->callee
->params
[i
].num_components
);
632 validate_const_value(nir_const_value
*val
, unsigned bit_size
,
633 validate_state
*state
)
635 /* In order for block copies to work properly for things like instruction
636 * comparisons and [de]serialization, we require the unused bits of the
637 * nir_const_value to be zero.
639 nir_const_value cmp_val
;
640 memset(&cmp_val
, 0, sizeof(cmp_val
));
646 cmp_val
.u8
= val
->u8
;
649 cmp_val
.u16
= val
->u16
;
652 cmp_val
.u32
= val
->u32
;
655 cmp_val
.u64
= val
->u64
;
658 validate_assert(state
, !"Invalid load_const bit size");
660 validate_assert(state
, memcmp(val
, &cmp_val
, sizeof(cmp_val
)) == 0);
664 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
666 validate_ssa_def(&instr
->def
, state
);
668 for (unsigned i
= 0; i
< instr
->def
.num_components
; i
++)
669 validate_const_value(&instr
->value
[i
], instr
->def
.bit_size
, state
);
673 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
675 validate_ssa_def(&instr
->def
, state
);
679 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
682 * don't validate the sources until we get to them from their predecessor
683 * basic blocks, to avoid validating an SSA use before its definition.
686 validate_dest(&instr
->dest
, state
, 0, 0);
688 exec_list_validate(&instr
->srcs
);
689 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
690 state
->block
->predecessors
->entries
);
694 validate_instr(nir_instr
*instr
, validate_state
*state
)
696 validate_assert(state
, instr
->block
== state
->block
);
698 state
->instr
= instr
;
700 switch (instr
->type
) {
701 case nir_instr_type_alu
:
702 validate_alu_instr(nir_instr_as_alu(instr
), state
);
705 case nir_instr_type_deref
:
706 validate_deref_instr(nir_instr_as_deref(instr
), state
);
709 case nir_instr_type_call
:
710 validate_call_instr(nir_instr_as_call(instr
), state
);
713 case nir_instr_type_intrinsic
:
714 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
717 case nir_instr_type_tex
:
718 validate_tex_instr(nir_instr_as_tex(instr
), state
);
721 case nir_instr_type_load_const
:
722 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
725 case nir_instr_type_phi
:
726 validate_phi_instr(nir_instr_as_phi(instr
), state
);
729 case nir_instr_type_ssa_undef
:
730 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
733 case nir_instr_type_jump
:
737 validate_assert(state
, !"Invalid ALU instruction type");
745 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
747 state
->instr
= &instr
->instr
;
749 validate_assert(state
, instr
->dest
.is_ssa
);
751 exec_list_validate(&instr
->srcs
);
752 nir_foreach_phi_src(src
, instr
) {
753 if (src
->pred
== pred
) {
754 validate_assert(state
, src
->src
.is_ssa
);
755 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
756 instr
->dest
.ssa
.num_components
);
766 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
768 nir_foreach_instr(instr
, succ
) {
769 if (instr
->type
!= nir_instr_type_phi
)
772 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
776 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
779 validate_block(nir_block
*block
, validate_state
*state
)
781 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
783 state
->block
= block
;
785 exec_list_validate(&block
->instr_list
);
786 nir_foreach_instr(instr
, block
) {
787 if (instr
->type
== nir_instr_type_phi
) {
788 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
789 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
792 if (instr
->type
== nir_instr_type_jump
) {
793 validate_assert(state
, instr
== nir_block_last_instr(block
));
796 validate_instr(instr
, state
);
799 validate_assert(state
, block
->successors
[0] != NULL
);
800 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
802 for (unsigned i
= 0; i
< 2; i
++) {
803 if (block
->successors
[i
] != NULL
) {
804 struct set_entry
*entry
=
805 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
806 validate_assert(state
, entry
);
808 validate_phi_srcs(block
, block
->successors
[i
], state
);
812 set_foreach(block
->predecessors
, entry
) {
813 const nir_block
*pred
= entry
->key
;
814 validate_assert(state
, pred
->successors
[0] == block
||
815 pred
->successors
[1] == block
);
818 if (!exec_list_is_empty(&block
->instr_list
) &&
819 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
820 validate_assert(state
, block
->successors
[1] == NULL
);
821 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
822 switch (jump
->type
) {
823 case nir_jump_break
: {
825 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
826 validate_assert(state
, block
->successors
[0] == after
);
830 case nir_jump_continue
: {
831 nir_block
*first
= nir_loop_first_block(state
->loop
);
832 validate_assert(state
, block
->successors
[0] == first
);
836 case nir_jump_return
:
837 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
841 unreachable("bad jump type");
844 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
846 switch (state
->parent_node
->type
) {
847 case nir_cf_node_loop
: {
848 nir_block
*first
= nir_loop_first_block(state
->loop
);
849 validate_assert(state
, block
->successors
[0] == first
);
850 /* due to the hack for infinite loops, block->successors[1] may
851 * point to the block after the loop.
856 case nir_cf_node_if
: {
858 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
859 validate_assert(state
, block
->successors
[0] == after
);
860 validate_assert(state
, block
->successors
[1] == NULL
);
864 case nir_cf_node_function
:
865 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
866 validate_assert(state
, block
->successors
[1] == NULL
);
870 unreachable("unknown control flow node type");
873 if (next
->type
== nir_cf_node_if
) {
874 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
875 validate_assert(state
, block
->successors
[0] ==
876 nir_if_first_then_block(if_stmt
));
877 validate_assert(state
, block
->successors
[1] ==
878 nir_if_first_else_block(if_stmt
));
880 validate_assert(state
, next
->type
== nir_cf_node_loop
);
881 nir_loop
*loop
= nir_cf_node_as_loop(next
);
882 validate_assert(state
, block
->successors
[0] ==
883 nir_loop_first_block(loop
));
884 validate_assert(state
, block
->successors
[1] == NULL
);
891 validate_if(nir_if
*if_stmt
, validate_state
*state
)
893 state
->if_stmt
= if_stmt
;
895 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
896 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
897 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
899 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
900 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
901 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
903 validate_src(&if_stmt
->condition
, state
, 0, 1);
905 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
906 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
908 nir_cf_node
*old_parent
= state
->parent_node
;
909 state
->parent_node
= &if_stmt
->cf_node
;
911 exec_list_validate(&if_stmt
->then_list
);
912 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
913 validate_cf_node(cf_node
, state
);
916 exec_list_validate(&if_stmt
->else_list
);
917 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
918 validate_cf_node(cf_node
, state
);
921 state
->parent_node
= old_parent
;
922 state
->if_stmt
= NULL
;
926 validate_loop(nir_loop
*loop
, validate_state
*state
)
928 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
929 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
930 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
932 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
933 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
934 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
936 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
938 nir_cf_node
*old_parent
= state
->parent_node
;
939 state
->parent_node
= &loop
->cf_node
;
940 nir_loop
*old_loop
= state
->loop
;
943 exec_list_validate(&loop
->body
);
944 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
945 validate_cf_node(cf_node
, state
);
948 state
->parent_node
= old_parent
;
949 state
->loop
= old_loop
;
953 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
955 validate_assert(state
, node
->parent
== state
->parent_node
);
957 switch (node
->type
) {
958 case nir_cf_node_block
:
959 validate_block(nir_cf_node_as_block(node
), state
);
963 validate_if(nir_cf_node_as_if(node
), state
);
966 case nir_cf_node_loop
:
967 validate_loop(nir_cf_node_as_loop(node
), state
);
971 unreachable("Invalid CF node type");
976 prevalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
978 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
979 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
980 BITSET_SET(state
->regs_found
, reg
->index
);
982 list_validate(®
->uses
);
983 list_validate(®
->defs
);
984 list_validate(®
->if_uses
);
986 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
987 reg_state
->uses
= _mesa_pointer_set_create(reg_state
);
988 reg_state
->if_uses
= _mesa_pointer_set_create(reg_state
);
989 reg_state
->defs
= _mesa_pointer_set_create(reg_state
);
991 reg_state
->where_defined
= state
->impl
;
993 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
997 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
999 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
1002 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
1004 nir_foreach_use(src
, reg
) {
1005 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
1006 validate_assert(state
, entry
);
1007 _mesa_set_remove(reg_state
->uses
, entry
);
1010 if (reg_state
->uses
->entries
!= 0) {
1011 printf("extra entries in register uses:\n");
1012 set_foreach(reg_state
->uses
, entry
)
1013 printf("%p\n", entry
->key
);
1018 nir_foreach_if_use(src
, reg
) {
1019 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
1020 validate_assert(state
, entry
);
1021 _mesa_set_remove(reg_state
->if_uses
, entry
);
1024 if (reg_state
->if_uses
->entries
!= 0) {
1025 printf("extra entries in register if_uses:\n");
1026 set_foreach(reg_state
->if_uses
, entry
)
1027 printf("%p\n", entry
->key
);
1032 nir_foreach_def(src
, reg
) {
1033 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
1034 validate_assert(state
, entry
);
1035 _mesa_set_remove(reg_state
->defs
, entry
);
1038 if (reg_state
->defs
->entries
!= 0) {
1039 printf("extra entries in register defs:\n");
1040 set_foreach(reg_state
->defs
, entry
)
1041 printf("%p\n", entry
->key
);
1048 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
1052 validate_assert(state
, is_global
== nir_variable_is_global(var
));
1054 /* Must have exactly one mode set */
1055 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
1057 if (var
->data
.compact
) {
1058 /* The "compact" flag is only valid on arrays of scalars. */
1059 assert(glsl_type_is_array(var
->type
));
1061 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
1062 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
1063 assert(glsl_type_is_array(type
));
1064 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
1066 assert(glsl_type_is_scalar(type
));
1070 if (var
->num_members
> 0) {
1071 const struct glsl_type
*without_array
= glsl_without_array(var
->type
);
1072 validate_assert(state
, glsl_type_is_struct_or_ifc(without_array
));
1073 validate_assert(state
, var
->num_members
== glsl_get_length(without_array
));
1074 validate_assert(state
, var
->members
!= NULL
);
1078 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1082 _mesa_hash_table_insert(state
->var_defs
, var
,
1083 is_global
? NULL
: state
->impl
);
1089 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1091 /* Resize the ssa_srcs set. It's likely that the size of this set will
1092 * never actually hit the number of SSA defs because we remove sources from
1093 * the set as we visit them. (It could actually be much larger because
1094 * each SSA def can be used more than once.) However, growing it now costs
1095 * us very little (the extra memory is already dwarfed by the SSA defs
1096 * themselves) and makes collisions much less likely.
1098 _mesa_set_resize(state
->ssa_srcs
, impl
->ssa_alloc
);
1100 validate_assert(state
, impl
->function
->impl
== impl
);
1101 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1103 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1104 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1105 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1108 state
->parent_node
= &impl
->cf_node
;
1110 exec_list_validate(&impl
->locals
);
1111 nir_foreach_variable(var
, &impl
->locals
) {
1112 validate_var_decl(var
, false, state
);
1115 state
->regs_found
= reralloc(state
->mem_ctx
, state
->regs_found
,
1116 BITSET_WORD
, BITSET_WORDS(impl
->reg_alloc
));
1117 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1118 sizeof(BITSET_WORD
));
1119 exec_list_validate(&impl
->registers
);
1120 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1121 prevalidate_reg_decl(reg
, state
);
1124 state
->ssa_defs_found
= reralloc(state
->mem_ctx
, state
->ssa_defs_found
,
1125 BITSET_WORD
, BITSET_WORDS(impl
->ssa_alloc
));
1126 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1127 sizeof(BITSET_WORD
));
1128 exec_list_validate(&impl
->body
);
1129 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1130 validate_cf_node(node
, state
);
1133 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1134 postvalidate_reg_decl(reg
, state
);
1137 if (state
->ssa_srcs
->entries
!= 0) {
1138 printf("extra dangling SSA sources:\n");
1139 set_foreach(state
->ssa_srcs
, entry
)
1140 printf("%p\n", entry
->key
);
1147 validate_function(nir_function
*func
, validate_state
*state
)
1149 if (func
->impl
!= NULL
) {
1150 validate_assert(state
, func
->impl
->function
== func
);
1151 validate_function_impl(func
->impl
, state
);
1156 init_validate_state(validate_state
*state
)
1158 state
->mem_ctx
= ralloc_context(NULL
);
1159 state
->regs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1160 state
->ssa_srcs
= _mesa_pointer_set_create(state
->mem_ctx
);
1161 state
->ssa_defs_found
= NULL
;
1162 state
->regs_found
= NULL
;
1163 state
->var_defs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1164 state
->errors
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1167 state
->instr
= NULL
;
1172 destroy_validate_state(validate_state
*state
)
1174 ralloc_free(state
->mem_ctx
);
1177 mtx_t fail_dump_mutex
= _MTX_INITIALIZER_NP
;
1180 dump_errors(validate_state
*state
, const char *when
)
1182 struct hash_table
*errors
= state
->errors
;
1184 /* Lock around dumping so that we get clean dumps in a multi-threaded
1187 mtx_lock(&fail_dump_mutex
);
1190 fprintf(stderr
, "NIR validation failed %s\n", when
);
1191 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1193 fprintf(stderr
, "NIR validation failed with %d errors:\n",
1194 _mesa_hash_table_num_entries(errors
));
1197 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1199 if (_mesa_hash_table_num_entries(errors
) > 0) {
1200 fprintf(stderr
, "%d additional errors:\n",
1201 _mesa_hash_table_num_entries(errors
));
1202 hash_table_foreach(errors
, entry
) {
1203 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1207 mtx_unlock(&fail_dump_mutex
);
1213 nir_validate_shader(nir_shader
*shader
, const char *when
)
1215 static int should_validate
= -1;
1216 if (should_validate
< 0)
1217 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1218 if (!should_validate
)
1221 validate_state state
;
1222 init_validate_state(&state
);
1224 state
.shader
= shader
;
1226 exec_list_validate(&shader
->uniforms
);
1227 nir_foreach_variable(var
, &shader
->uniforms
) {
1228 validate_var_decl(var
, true, &state
);
1231 exec_list_validate(&shader
->inputs
);
1232 nir_foreach_variable(var
, &shader
->inputs
) {
1233 validate_var_decl(var
, true, &state
);
1236 exec_list_validate(&shader
->outputs
);
1237 nir_foreach_variable(var
, &shader
->outputs
) {
1238 validate_var_decl(var
, true, &state
);
1241 exec_list_validate(&shader
->shared
);
1242 nir_foreach_variable(var
, &shader
->shared
) {
1243 validate_var_decl(var
, true, &state
);
1246 exec_list_validate(&shader
->globals
);
1247 nir_foreach_variable(var
, &shader
->globals
) {
1248 validate_var_decl(var
, true, &state
);
1251 exec_list_validate(&shader
->system_values
);
1252 nir_foreach_variable(var
, &shader
->system_values
) {
1253 validate_var_decl(var
, true, &state
);
1256 exec_list_validate(&shader
->functions
);
1257 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1258 validate_function(func
, &state
);
1261 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1262 dump_errors(&state
, when
);
1264 destroy_validate_state(&state
);