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_num_components(validate_state
*state
, unsigned num_components
)
131 validate_assert(state
, nir_num_components_valid(num_components
));
135 validate_reg_src(nir_src
*src
, validate_state
*state
,
136 unsigned bit_sizes
, unsigned num_components
)
138 validate_assert(state
, src
->reg
.reg
!= NULL
);
140 struct hash_entry
*entry
;
141 entry
= _mesa_hash_table_search(state
->regs
, src
->reg
.reg
);
142 validate_assert(state
, entry
);
144 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
147 _mesa_set_add(reg_state
->uses
, src
);
149 validate_assert(state
, state
->if_stmt
);
150 _mesa_set_add(reg_state
->if_uses
, src
);
153 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
154 "using a register declared in a different function");
157 validate_assert(state
, src
->reg
.reg
->bit_size
& bit_sizes
);
159 validate_assert(state
, src
->reg
.reg
->num_components
== num_components
);
161 validate_assert(state
, (src
->reg
.reg
->num_array_elems
== 0 ||
162 src
->reg
.base_offset
< src
->reg
.reg
->num_array_elems
) &&
163 "definitely out-of-bounds array access");
165 if (src
->reg
.indirect
) {
166 validate_assert(state
, src
->reg
.reg
->num_array_elems
!= 0);
167 validate_assert(state
, (src
->reg
.indirect
->is_ssa
||
168 src
->reg
.indirect
->reg
.indirect
== NULL
) &&
169 "only one level of indirection allowed");
170 validate_src(src
->reg
.indirect
, state
, 32, 1);
174 #define SET_PTR_BIT(ptr, bit) \
175 (void *)(((uintptr_t)(ptr)) | (((uintptr_t)1) << bit))
178 validate_ssa_src(nir_src
*src
, validate_state
*state
,
179 unsigned bit_sizes
, unsigned num_components
)
181 validate_assert(state
, src
->ssa
!= NULL
);
183 /* As we walk SSA defs, we add every use to this set. We need to make sure
184 * our use is seen in a use list.
186 struct set_entry
*entry
;
188 entry
= _mesa_set_search(state
->ssa_srcs
, src
);
190 entry
= _mesa_set_search(state
->ssa_srcs
, SET_PTR_BIT(src
, 0));
192 validate_assert(state
, entry
);
194 /* This will let us prove that we've seen all the sources */
196 _mesa_set_remove(state
->ssa_srcs
, entry
);
199 validate_assert(state
, src
->ssa
->bit_size
& bit_sizes
);
201 validate_assert(state
, src
->ssa
->num_components
== num_components
);
203 /* TODO validate that the use is dominated by the definition */
207 validate_src(nir_src
*src
, validate_state
*state
,
208 unsigned bit_sizes
, unsigned num_components
)
211 validate_assert(state
, src
->parent_instr
== state
->instr
);
213 validate_assert(state
, src
->parent_if
== state
->if_stmt
);
216 validate_ssa_src(src
, state
, bit_sizes
, num_components
);
218 validate_reg_src(src
, state
, bit_sizes
, num_components
);
222 validate_alu_src(nir_alu_instr
*instr
, unsigned index
, validate_state
*state
)
224 nir_alu_src
*src
= &instr
->src
[index
];
226 if (instr
->op
== nir_op_mov
)
227 assert(!src
->abs
&& !src
->negate
);
229 unsigned num_components
= nir_src_num_components(src
->src
);
230 for (unsigned i
= 0; i
< NIR_MAX_VEC_COMPONENTS
; i
++) {
231 validate_assert(state
, src
->swizzle
[i
] < NIR_MAX_VEC_COMPONENTS
);
233 if (nir_alu_instr_channel_used(instr
, index
, i
))
234 validate_assert(state
, src
->swizzle
[i
] < num_components
);
237 validate_src(&src
->src
, state
, 0, 0);
241 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
242 unsigned bit_sizes
, unsigned num_components
)
244 validate_assert(state
, dest
->reg
!= NULL
);
246 validate_assert(state
, dest
->parent_instr
== state
->instr
);
248 struct hash_entry
*entry2
;
249 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
251 validate_assert(state
, entry2
);
253 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
254 _mesa_set_add(reg_state
->defs
, dest
);
256 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
257 "writing to a register declared in a different function");
260 validate_assert(state
, dest
->reg
->bit_size
& bit_sizes
);
262 validate_assert(state
, dest
->reg
->num_components
== num_components
);
264 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
265 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
266 "definitely out-of-bounds array access");
268 if (dest
->indirect
) {
269 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
270 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
271 "only one level of indirection allowed");
272 validate_src(dest
->indirect
, state
, 32, 1);
277 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
279 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
280 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
281 BITSET_SET(state
->ssa_defs_found
, def
->index
);
283 validate_assert(state
, def
->parent_instr
== state
->instr
);
284 validate_num_components(state
, def
->num_components
);
286 list_validate(&def
->uses
);
287 nir_foreach_use(src
, def
) {
288 validate_assert(state
, src
->is_ssa
);
289 validate_assert(state
, src
->ssa
== def
);
290 bool already_seen
= false;
291 _mesa_set_search_and_add(state
->ssa_srcs
, src
, &already_seen
);
292 /* A nir_src should only appear once and only in one SSA def use list */
293 validate_assert(state
, !already_seen
);
296 list_validate(&def
->if_uses
);
297 nir_foreach_if_use(src
, def
) {
298 validate_assert(state
, src
->is_ssa
);
299 validate_assert(state
, src
->ssa
== def
);
300 bool already_seen
= false;
301 _mesa_set_search_and_add(state
->ssa_srcs
, SET_PTR_BIT(src
, 0),
303 /* A nir_src should only appear once and only in one SSA def use list */
304 validate_assert(state
, !already_seen
);
309 validate_dest(nir_dest
*dest
, validate_state
*state
,
310 unsigned bit_sizes
, unsigned num_components
)
314 validate_assert(state
, dest
->ssa
.bit_size
& bit_sizes
);
316 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
317 validate_ssa_def(&dest
->ssa
, state
);
319 validate_reg_dest(&dest
->reg
, state
, bit_sizes
, num_components
);
324 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
326 nir_alu_dest
*dest
= &instr
->dest
;
328 if (instr
->op
== nir_op_mov
)
329 assert(!dest
->saturate
);
331 unsigned dest_size
= nir_dest_num_components(dest
->dest
);
333 * validate that the instruction doesn't write to components not in the
336 validate_assert(state
, !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
338 /* validate that saturate is only ever used on instructions with
339 * destinations of type float
341 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
342 validate_assert(state
,
343 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
347 validate_dest(&dest
->dest
, state
, 0, 0);
351 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
353 validate_assert(state
, instr
->op
< nir_num_opcodes
);
355 unsigned instr_bit_size
= 0;
356 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
357 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
358 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
359 if (nir_alu_type_get_type_size(src_type
)) {
360 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
361 } else if (instr_bit_size
) {
362 validate_assert(state
, src_bit_size
== instr_bit_size
);
364 instr_bit_size
= src_bit_size
;
367 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
368 /* 8-bit float isn't a thing */
369 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
373 validate_alu_src(instr
, i
, state
);
376 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
377 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
378 if (nir_alu_type_get_type_size(dest_type
)) {
379 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
380 } else if (instr_bit_size
) {
381 validate_assert(state
, dest_bit_size
== instr_bit_size
);
383 /* The only unsized thing is the destination so it's vacuously valid */
386 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
387 /* 8-bit float isn't a thing */
388 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
389 dest_bit_size
== 64);
392 validate_alu_dest(instr
, state
);
396 validate_var_use(nir_variable
*var
, validate_state
*state
)
398 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
399 validate_assert(state
, entry
);
400 if (entry
&& var
->data
.mode
== nir_var_function_temp
)
401 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
405 validate_deref_instr(nir_deref_instr
*instr
, validate_state
*state
)
407 if (instr
->deref_type
== nir_deref_type_var
) {
408 /* Variable dereferences are stupid simple. */
409 validate_assert(state
, instr
->mode
== instr
->var
->data
.mode
);
410 validate_assert(state
, instr
->type
== instr
->var
->type
);
411 validate_var_use(instr
->var
, state
);
412 } else if (instr
->deref_type
== nir_deref_type_cast
) {
413 /* For cast, we simply have to trust the instruction. It's up to
414 * lowering passes and front/back-ends to make them sane.
416 validate_src(&instr
->parent
, state
, 0, 0);
418 /* We just validate that the type and mode are there */
419 validate_assert(state
, instr
->mode
);
420 validate_assert(state
, instr
->type
);
422 /* We require the parent to be SSA. This may be lifted in the future */
423 validate_assert(state
, instr
->parent
.is_ssa
);
425 /* The parent pointer value must have the same number of components
426 * as the destination.
428 validate_src(&instr
->parent
, state
, nir_dest_bit_size(instr
->dest
),
429 nir_dest_num_components(instr
->dest
));
431 nir_instr
*parent_instr
= instr
->parent
.ssa
->parent_instr
;
433 /* The parent must come from another deref instruction */
434 validate_assert(state
, parent_instr
->type
== nir_instr_type_deref
);
436 nir_deref_instr
*parent
= nir_instr_as_deref(parent_instr
);
438 validate_assert(state
, instr
->mode
== parent
->mode
);
440 switch (instr
->deref_type
) {
441 case nir_deref_type_struct
:
442 validate_assert(state
, glsl_type_is_struct_or_ifc(parent
->type
));
443 validate_assert(state
,
444 instr
->strct
.index
< glsl_get_length(parent
->type
));
445 validate_assert(state
, instr
->type
==
446 glsl_get_struct_field(parent
->type
, instr
->strct
.index
));
449 case nir_deref_type_array
:
450 case nir_deref_type_array_wildcard
:
451 if (instr
->mode
== nir_var_mem_ubo
||
452 instr
->mode
== nir_var_mem_ssbo
||
453 instr
->mode
== nir_var_mem_shared
||
454 instr
->mode
== nir_var_mem_global
) {
455 /* Shared variables and UBO/SSBOs have a bit more relaxed rules
456 * because we need to be able to handle array derefs on vectors.
457 * Fortunately, nir_lower_io handles these just fine.
459 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
460 glsl_type_is_matrix(parent
->type
) ||
461 glsl_type_is_vector(parent
->type
));
463 /* Most of NIR cannot handle array derefs on vectors */
464 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
465 glsl_type_is_matrix(parent
->type
));
467 validate_assert(state
,
468 instr
->type
== glsl_get_array_element(parent
->type
));
470 if (instr
->deref_type
== nir_deref_type_array
) {
471 validate_src(&instr
->arr
.index
, state
,
472 nir_dest_bit_size(instr
->dest
), 1);
476 case nir_deref_type_ptr_as_array
:
477 /* ptr_as_array derefs must have a parent that is either an array,
478 * ptr_as_array, or cast. If the parent is a cast, we get the stride
479 * information (if any) from the cast deref.
481 validate_assert(state
,
482 parent
->deref_type
== nir_deref_type_array
||
483 parent
->deref_type
== nir_deref_type_ptr_as_array
||
484 parent
->deref_type
== nir_deref_type_cast
);
485 validate_src(&instr
->arr
.index
, state
,
486 nir_dest_bit_size(instr
->dest
), 1);
490 unreachable("Invalid deref instruction type");
494 /* We intentionally don't validate the size of the destination because we
495 * want to let other compiler components such as SPIR-V decide how big
496 * pointers should be.
498 validate_dest(&instr
->dest
, state
, 0, 0);
500 /* Deref instructions as if conditions don't make sense because if
501 * conditions expect well-formed Booleans. If you want to compare with
502 * NULL, an explicit comparison operation should be used.
504 validate_assert(state
, list_is_empty(&instr
->dest
.ssa
.if_uses
));
506 /* Only certain modes can be used as sources for phi instructions. */
507 nir_foreach_use(use
, &instr
->dest
.ssa
) {
508 if (use
->parent_instr
->type
== nir_instr_type_phi
) {
509 validate_assert(state
, instr
->mode
== nir_var_mem_ubo
||
510 instr
->mode
== nir_var_mem_ssbo
||
511 instr
->mode
== nir_var_mem_shared
||
512 instr
->mode
== nir_var_mem_global
||
513 instr
->mode
== nir_var_mem_constant
);
519 vectorized_intrinsic(nir_intrinsic_instr
*intr
)
521 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[intr
->intrinsic
];
523 if (info
->dest_components
== 0)
526 for (unsigned i
= 0; i
< info
->num_srcs
; i
++)
527 if (info
->src_components
[i
] == 0)
534 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
536 unsigned dest_bit_size
= 0;
537 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
538 switch (instr
->intrinsic
) {
539 case nir_intrinsic_load_param
: {
540 unsigned param_idx
= nir_intrinsic_param_idx(instr
);
541 validate_assert(state
, param_idx
< state
->impl
->function
->num_params
);
542 nir_parameter
*param
= &state
->impl
->function
->params
[param_idx
];
543 validate_assert(state
, instr
->num_components
== param
->num_components
);
544 dest_bit_size
= param
->bit_size
;
548 case nir_intrinsic_load_deref
: {
549 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[0]);
551 validate_assert(state
, glsl_type_is_vector_or_scalar(src
->type
) ||
552 (src
->mode
== nir_var_uniform
&&
553 glsl_get_base_type(src
->type
) == GLSL_TYPE_SUBROUTINE
));
554 validate_assert(state
, instr
->num_components
==
555 glsl_get_vector_elements(src
->type
));
556 dest_bit_size
= glsl_get_bit_size(src
->type
);
557 /* Also allow 32-bit boolean load operations */
558 if (glsl_type_is_boolean(src
->type
))
563 case nir_intrinsic_store_deref
: {
564 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
566 validate_assert(state
, glsl_type_is_vector_or_scalar(dst
->type
));
567 validate_assert(state
, instr
->num_components
==
568 glsl_get_vector_elements(dst
->type
));
569 src_bit_sizes
[1] = glsl_get_bit_size(dst
->type
);
570 /* Also allow 32-bit boolean store operations */
571 if (glsl_type_is_boolean(dst
->type
))
572 src_bit_sizes
[1] |= 32;
573 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
574 nir_var_uniform
)) == 0);
575 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
579 case nir_intrinsic_copy_deref
: {
580 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
581 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[1]);
582 validate_assert(state
, glsl_get_bare_type(dst
->type
) ==
583 glsl_get_bare_type(src
->type
));
584 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
585 nir_var_uniform
)) == 0);
589 case nir_intrinsic_load_ubo_vec4
: {
590 int bit_size
= nir_dest_bit_size(instr
->dest
);
591 validate_assert(state
, bit_size
>= 8);
592 validate_assert(state
, (nir_intrinsic_component(instr
) +
593 instr
->num_components
) * (bit_size
/ 8) <= 16);
597 case nir_intrinsic_load_ubo
:
598 case nir_intrinsic_load_ssbo
:
599 case nir_intrinsic_load_shared
:
600 case nir_intrinsic_load_global
:
601 case nir_intrinsic_load_scratch
:
602 case nir_intrinsic_load_constant
:
603 /* These memory load operations must have alignments */
604 validate_assert(state
,
605 util_is_power_of_two_nonzero(nir_intrinsic_align_mul(instr
)));
606 validate_assert(state
, nir_intrinsic_align_offset(instr
) <
607 nir_intrinsic_align_mul(instr
));
610 case nir_intrinsic_load_uniform
:
611 case nir_intrinsic_load_input
:
612 case nir_intrinsic_load_per_vertex_input
:
613 case nir_intrinsic_load_interpolated_input
:
614 case nir_intrinsic_load_output
:
615 case nir_intrinsic_load_per_vertex_output
:
616 case nir_intrinsic_load_push_constant
:
617 /* All memory load operations must load at least a byte */
618 validate_assert(state
, nir_dest_bit_size(instr
->dest
) >= 8);
621 case nir_intrinsic_store_ssbo
:
622 case nir_intrinsic_store_shared
:
623 case nir_intrinsic_store_global
:
624 case nir_intrinsic_store_scratch
:
625 /* These memory store operations must also have alignments */
626 validate_assert(state
,
627 util_is_power_of_two_nonzero(nir_intrinsic_align_mul(instr
)));
628 validate_assert(state
, nir_intrinsic_align_offset(instr
) <
629 nir_intrinsic_align_mul(instr
));
632 case nir_intrinsic_store_output
:
633 case nir_intrinsic_store_per_vertex_output
:
634 /* All memory store operations must store at least a byte */
635 validate_assert(state
, nir_src_bit_size(instr
->src
[0]) >= 8);
642 if (instr
->num_components
> 0)
643 validate_num_components(state
, instr
->num_components
);
645 const nir_intrinsic_info
*info
= &nir_intrinsic_infos
[instr
->intrinsic
];
646 unsigned num_srcs
= info
->num_srcs
;
647 for (unsigned i
= 0; i
< num_srcs
; i
++) {
648 unsigned components_read
= nir_intrinsic_src_components(instr
, i
);
650 validate_num_components(state
, components_read
);
652 validate_src(&instr
->src
[i
], state
, src_bit_sizes
[i
], components_read
);
655 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
656 unsigned components_written
= nir_intrinsic_dest_components(instr
);
657 unsigned bit_sizes
= nir_intrinsic_infos
[instr
->intrinsic
].dest_bit_sizes
;
659 validate_num_components(state
, components_written
);
660 if (dest_bit_size
&& bit_sizes
)
661 validate_assert(state
, dest_bit_size
& bit_sizes
);
663 dest_bit_size
= dest_bit_size
? dest_bit_size
: bit_sizes
;
665 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
668 if (!vectorized_intrinsic(instr
))
669 validate_assert(state
, instr
->num_components
== 0);
673 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
675 bool src_type_seen
[nir_num_tex_src_types
];
676 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
677 src_type_seen
[i
] = false;
679 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
680 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
681 src_type_seen
[instr
->src
[i
].src_type
] = true;
682 validate_src(&instr
->src
[i
].src
, state
,
683 0, nir_tex_instr_src_size(instr
, i
));
685 switch (instr
->src
[i
].src_type
) {
686 case nir_tex_src_texture_deref
:
687 case nir_tex_src_sampler_deref
:
688 validate_assert(state
, instr
->src
[i
].src
.is_ssa
);
689 validate_assert(state
,
690 instr
->src
[i
].src
.ssa
->parent_instr
->type
== nir_instr_type_deref
);
697 if (nir_tex_instr_has_explicit_tg4_offsets(instr
)) {
698 validate_assert(state
, instr
->op
== nir_texop_tg4
);
699 validate_assert(state
, !src_type_seen
[nir_tex_src_offset
]);
702 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
706 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
708 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
710 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
711 validate_src(&instr
->params
[i
], state
,
712 instr
->callee
->params
[i
].bit_size
,
713 instr
->callee
->params
[i
].num_components
);
718 validate_const_value(nir_const_value
*val
, unsigned bit_size
,
719 validate_state
*state
)
721 /* In order for block copies to work properly for things like instruction
722 * comparisons and [de]serialization, we require the unused bits of the
723 * nir_const_value to be zero.
725 nir_const_value cmp_val
;
726 memset(&cmp_val
, 0, sizeof(cmp_val
));
732 cmp_val
.u8
= val
->u8
;
735 cmp_val
.u16
= val
->u16
;
738 cmp_val
.u32
= val
->u32
;
741 cmp_val
.u64
= val
->u64
;
744 validate_assert(state
, !"Invalid load_const bit size");
746 validate_assert(state
, memcmp(val
, &cmp_val
, sizeof(cmp_val
)) == 0);
750 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
752 validate_ssa_def(&instr
->def
, state
);
754 for (unsigned i
= 0; i
< instr
->def
.num_components
; i
++)
755 validate_const_value(&instr
->value
[i
], instr
->def
.bit_size
, state
);
759 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
761 validate_ssa_def(&instr
->def
, state
);
765 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
768 * don't validate the sources until we get to them from their predecessor
769 * basic blocks, to avoid validating an SSA use before its definition.
772 validate_dest(&instr
->dest
, state
, 0, 0);
774 exec_list_validate(&instr
->srcs
);
775 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
776 state
->block
->predecessors
->entries
);
780 validate_jump_instr(nir_jump_instr
*instr
, validate_state
*state
)
782 nir_block
*block
= state
->block
;
783 validate_assert(state
, &instr
->instr
== nir_block_last_instr(block
));
785 switch (instr
->type
) {
786 case nir_jump_return
:
787 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
788 validate_assert(state
, block
->successors
[1] == NULL
);
789 validate_assert(state
, instr
->target
== NULL
);
790 validate_assert(state
, instr
->else_target
== NULL
);
794 validate_assert(state
, state
->impl
->structured
);
795 validate_assert(state
, state
->loop
!= NULL
);
798 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
799 validate_assert(state
, block
->successors
[0] == after
);
801 validate_assert(state
, block
->successors
[1] == NULL
);
802 validate_assert(state
, instr
->target
== NULL
);
803 validate_assert(state
, instr
->else_target
== NULL
);
806 case nir_jump_continue
:
807 validate_assert(state
, state
->impl
->structured
);
808 validate_assert(state
, state
->loop
!= NULL
);
810 nir_block
*first
= nir_loop_first_block(state
->loop
);
811 validate_assert(state
, block
->successors
[0] == first
);
813 validate_assert(state
, block
->successors
[1] == NULL
);
814 validate_assert(state
, instr
->target
== NULL
);
815 validate_assert(state
, instr
->else_target
== NULL
);
819 validate_assert(state
, !state
->impl
->structured
);
820 validate_assert(state
, instr
->target
== block
->successors
[0]);
821 validate_assert(state
, instr
->target
!= NULL
);
822 validate_assert(state
, instr
->else_target
== NULL
);
825 case nir_jump_goto_if
:
826 validate_assert(state
, !state
->impl
->structured
);
827 validate_assert(state
, instr
->target
== block
->successors
[1]);
828 validate_assert(state
, instr
->else_target
== block
->successors
[0]);
829 validate_src(&instr
->condition
, state
, 0, 1);
830 validate_assert(state
, instr
->target
!= NULL
);
831 validate_assert(state
, instr
->else_target
!= NULL
);
835 validate_assert(state
, !"Invalid jump instruction type");
841 validate_instr(nir_instr
*instr
, validate_state
*state
)
843 validate_assert(state
, instr
->block
== state
->block
);
845 state
->instr
= instr
;
847 switch (instr
->type
) {
848 case nir_instr_type_alu
:
849 validate_alu_instr(nir_instr_as_alu(instr
), state
);
852 case nir_instr_type_deref
:
853 validate_deref_instr(nir_instr_as_deref(instr
), state
);
856 case nir_instr_type_call
:
857 validate_call_instr(nir_instr_as_call(instr
), state
);
860 case nir_instr_type_intrinsic
:
861 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
864 case nir_instr_type_tex
:
865 validate_tex_instr(nir_instr_as_tex(instr
), state
);
868 case nir_instr_type_load_const
:
869 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
872 case nir_instr_type_phi
:
873 validate_phi_instr(nir_instr_as_phi(instr
), state
);
876 case nir_instr_type_ssa_undef
:
877 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
880 case nir_instr_type_jump
:
881 validate_jump_instr(nir_instr_as_jump(instr
), state
);
885 validate_assert(state
, !"Invalid ALU instruction type");
893 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
895 state
->instr
= &instr
->instr
;
897 validate_assert(state
, instr
->dest
.is_ssa
);
899 exec_list_validate(&instr
->srcs
);
900 nir_foreach_phi_src(src
, instr
) {
901 if (src
->pred
== pred
) {
902 validate_assert(state
, src
->src
.is_ssa
);
903 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
904 instr
->dest
.ssa
.num_components
);
909 validate_assert(state
, !"Phi does not have a source corresponding to one "
910 "of its predecessor blocks");
914 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
916 nir_foreach_instr(instr
, succ
) {
917 if (instr
->type
!= nir_instr_type_phi
)
920 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
924 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
927 validate_block(nir_block
*block
, validate_state
*state
)
929 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
931 state
->block
= block
;
933 exec_list_validate(&block
->instr_list
);
934 nir_foreach_instr(instr
, block
) {
935 if (instr
->type
== nir_instr_type_phi
) {
936 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
937 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
940 validate_instr(instr
, state
);
943 validate_assert(state
, block
->successors
[0] != NULL
);
944 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
946 for (unsigned i
= 0; i
< 2; i
++) {
947 if (block
->successors
[i
] != NULL
) {
948 struct set_entry
*entry
=
949 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
950 validate_assert(state
, entry
);
952 validate_phi_srcs(block
, block
->successors
[i
], state
);
956 set_foreach(block
->predecessors
, entry
) {
957 const nir_block
*pred
= entry
->key
;
958 validate_assert(state
, pred
->successors
[0] == block
||
959 pred
->successors
[1] == block
);
962 if (!state
->impl
->structured
) {
963 validate_assert(state
, nir_block_ends_in_jump(block
));
964 } else if (!nir_block_ends_in_jump(block
)) {
965 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
967 switch (state
->parent_node
->type
) {
968 case nir_cf_node_loop
: {
969 nir_block
*first
= nir_loop_first_block(state
->loop
);
970 validate_assert(state
, block
->successors
[0] == first
);
971 /* due to the hack for infinite loops, block->successors[1] may
972 * point to the block after the loop.
977 case nir_cf_node_if
: {
979 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
980 validate_assert(state
, block
->successors
[0] == after
);
981 validate_assert(state
, block
->successors
[1] == NULL
);
985 case nir_cf_node_function
:
986 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
987 validate_assert(state
, block
->successors
[1] == NULL
);
991 unreachable("unknown control flow node type");
994 if (next
->type
== nir_cf_node_if
) {
995 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
996 validate_assert(state
, block
->successors
[0] ==
997 nir_if_first_then_block(if_stmt
));
998 validate_assert(state
, block
->successors
[1] ==
999 nir_if_first_else_block(if_stmt
));
1000 } else if (next
->type
== nir_cf_node_loop
) {
1001 nir_loop
*loop
= nir_cf_node_as_loop(next
);
1002 validate_assert(state
, block
->successors
[0] ==
1003 nir_loop_first_block(loop
));
1004 validate_assert(state
, block
->successors
[1] == NULL
);
1006 validate_assert(state
,
1007 !"Structured NIR cannot have consecutive blocks");
1014 validate_if(nir_if
*if_stmt
, validate_state
*state
)
1016 validate_assert(state
, state
->impl
->structured
);
1018 state
->if_stmt
= if_stmt
;
1020 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
1021 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
1022 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
1024 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
1025 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
1026 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
1028 validate_src(&if_stmt
->condition
, state
, 0, 1);
1030 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
1031 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
1033 nir_cf_node
*old_parent
= state
->parent_node
;
1034 state
->parent_node
= &if_stmt
->cf_node
;
1036 exec_list_validate(&if_stmt
->then_list
);
1037 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
1038 validate_cf_node(cf_node
, state
);
1041 exec_list_validate(&if_stmt
->else_list
);
1042 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
1043 validate_cf_node(cf_node
, state
);
1046 state
->parent_node
= old_parent
;
1047 state
->if_stmt
= NULL
;
1051 validate_loop(nir_loop
*loop
, validate_state
*state
)
1053 validate_assert(state
, state
->impl
->structured
);
1055 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
1056 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
1057 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
1059 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
1060 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
1061 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
1063 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
1065 nir_cf_node
*old_parent
= state
->parent_node
;
1066 state
->parent_node
= &loop
->cf_node
;
1067 nir_loop
*old_loop
= state
->loop
;
1070 exec_list_validate(&loop
->body
);
1071 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
1072 validate_cf_node(cf_node
, state
);
1075 state
->parent_node
= old_parent
;
1076 state
->loop
= old_loop
;
1080 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
1082 validate_assert(state
, node
->parent
== state
->parent_node
);
1084 switch (node
->type
) {
1085 case nir_cf_node_block
:
1086 validate_block(nir_cf_node_as_block(node
), state
);
1089 case nir_cf_node_if
:
1090 validate_if(nir_cf_node_as_if(node
), state
);
1093 case nir_cf_node_loop
:
1094 validate_loop(nir_cf_node_as_loop(node
), state
);
1098 unreachable("Invalid CF node type");
1103 prevalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
1105 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
1106 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
1107 validate_num_components(state
, reg
->num_components
);
1108 BITSET_SET(state
->regs_found
, reg
->index
);
1110 list_validate(®
->uses
);
1111 list_validate(®
->defs
);
1112 list_validate(®
->if_uses
);
1114 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
1115 reg_state
->uses
= _mesa_pointer_set_create(reg_state
);
1116 reg_state
->if_uses
= _mesa_pointer_set_create(reg_state
);
1117 reg_state
->defs
= _mesa_pointer_set_create(reg_state
);
1119 reg_state
->where_defined
= state
->impl
;
1121 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
1125 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
1127 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
1130 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
1132 nir_foreach_use(src
, reg
) {
1133 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
1134 validate_assert(state
, entry
);
1135 _mesa_set_remove(reg_state
->uses
, entry
);
1137 validate_assert(state
, reg_state
->uses
->entries
== 0);
1139 nir_foreach_if_use(src
, reg
) {
1140 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
1141 validate_assert(state
, entry
);
1142 _mesa_set_remove(reg_state
->if_uses
, entry
);
1144 validate_assert(state
, reg_state
->if_uses
->entries
== 0);
1146 nir_foreach_def(src
, reg
) {
1147 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
1148 validate_assert(state
, entry
);
1149 _mesa_set_remove(reg_state
->defs
, entry
);
1151 validate_assert(state
, reg_state
->defs
->entries
== 0);
1155 validate_var_decl(nir_variable
*var
, nir_variable_mode valid_modes
,
1156 validate_state
*state
)
1160 /* Must have exactly one mode set */
1161 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
1162 validate_assert(state
, var
->data
.mode
& valid_modes
);
1164 if (var
->data
.compact
) {
1165 /* The "compact" flag is only valid on arrays of scalars. */
1166 assert(glsl_type_is_array(var
->type
));
1168 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
1169 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
1170 assert(glsl_type_is_array(type
));
1171 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
1173 assert(glsl_type_is_scalar(type
));
1177 if (var
->num_members
> 0) {
1178 const struct glsl_type
*without_array
= glsl_without_array(var
->type
);
1179 validate_assert(state
, glsl_type_is_struct_or_ifc(without_array
));
1180 validate_assert(state
, var
->num_members
== glsl_get_length(without_array
));
1181 validate_assert(state
, var
->members
!= NULL
);
1184 if (var
->data
.per_view
)
1185 validate_assert(state
, glsl_type_is_array(var
->type
));
1188 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1192 _mesa_hash_table_insert(state
->var_defs
, var
,
1193 valid_modes
== nir_var_function_temp
?
1194 state
->impl
: NULL
);
1200 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1202 /* Resize the ssa_srcs set. It's likely that the size of this set will
1203 * never actually hit the number of SSA defs because we remove sources from
1204 * the set as we visit them. (It could actually be much larger because
1205 * each SSA def can be used more than once.) However, growing it now costs
1206 * us very little (the extra memory is already dwarfed by the SSA defs
1207 * themselves) and makes collisions much less likely.
1209 _mesa_set_resize(state
->ssa_srcs
, impl
->ssa_alloc
);
1211 validate_assert(state
, impl
->function
->impl
== impl
);
1212 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1214 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1215 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1216 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1219 state
->parent_node
= &impl
->cf_node
;
1221 exec_list_validate(&impl
->locals
);
1222 nir_foreach_function_temp_variable(var
, impl
) {
1223 validate_var_decl(var
, nir_var_function_temp
, state
);
1226 state
->regs_found
= reralloc(state
->mem_ctx
, state
->regs_found
,
1227 BITSET_WORD
, BITSET_WORDS(impl
->reg_alloc
));
1228 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1229 sizeof(BITSET_WORD
));
1230 exec_list_validate(&impl
->registers
);
1231 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1232 prevalidate_reg_decl(reg
, state
);
1235 state
->ssa_defs_found
= reralloc(state
->mem_ctx
, state
->ssa_defs_found
,
1236 BITSET_WORD
, BITSET_WORDS(impl
->ssa_alloc
));
1237 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1238 sizeof(BITSET_WORD
));
1239 exec_list_validate(&impl
->body
);
1240 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1241 validate_cf_node(node
, state
);
1244 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1245 postvalidate_reg_decl(reg
, state
);
1248 validate_assert(state
, state
->ssa_srcs
->entries
== 0);
1249 _mesa_set_clear(state
->ssa_srcs
, NULL
);
1253 validate_function(nir_function
*func
, validate_state
*state
)
1255 if (func
->impl
!= NULL
) {
1256 validate_assert(state
, func
->impl
->function
== func
);
1257 validate_function_impl(func
->impl
, state
);
1262 init_validate_state(validate_state
*state
)
1264 state
->mem_ctx
= ralloc_context(NULL
);
1265 state
->regs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1266 state
->ssa_srcs
= _mesa_pointer_set_create(state
->mem_ctx
);
1267 state
->ssa_defs_found
= NULL
;
1268 state
->regs_found
= NULL
;
1269 state
->var_defs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1270 state
->errors
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1273 state
->instr
= NULL
;
1278 destroy_validate_state(validate_state
*state
)
1280 ralloc_free(state
->mem_ctx
);
1283 mtx_t fail_dump_mutex
= _MTX_INITIALIZER_NP
;
1286 dump_errors(validate_state
*state
, const char *when
)
1288 struct hash_table
*errors
= state
->errors
;
1290 /* Lock around dumping so that we get clean dumps in a multi-threaded
1293 mtx_lock(&fail_dump_mutex
);
1296 fprintf(stderr
, "NIR validation failed %s\n", when
);
1297 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1299 fprintf(stderr
, "NIR validation failed with %d errors:\n",
1300 _mesa_hash_table_num_entries(errors
));
1303 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1305 if (_mesa_hash_table_num_entries(errors
) > 0) {
1306 fprintf(stderr
, "%d additional errors:\n",
1307 _mesa_hash_table_num_entries(errors
));
1308 hash_table_foreach(errors
, entry
) {
1309 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1313 mtx_unlock(&fail_dump_mutex
);
1319 nir_validate_shader(nir_shader
*shader
, const char *when
)
1321 static int should_validate
= -1;
1322 if (should_validate
< 0)
1323 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1324 if (!should_validate
)
1327 validate_state state
;
1328 init_validate_state(&state
);
1330 state
.shader
= shader
;
1332 nir_variable_mode valid_modes
=
1334 nir_var_shader_out
|
1335 nir_var_shader_temp
|
1338 nir_var_system_value
|
1340 nir_var_mem_shared
|
1341 nir_var_mem_constant
;
1343 exec_list_validate(&shader
->variables
);
1344 nir_foreach_variable_in_shader(var
, shader
)
1345 validate_var_decl(var
, valid_modes
, &state
);
1347 exec_list_validate(&shader
->functions
);
1348 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1349 validate_function(func
, &state
);
1352 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1353 dump_errors(&state
, when
);
1355 destroy_validate_state(&state
);