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 unsigned num_components
= nir_src_num_components(src
->src
);
221 for (unsigned i
= 0; i
< NIR_MAX_VEC_COMPONENTS
; i
++) {
222 validate_assert(state
, src
->swizzle
[i
] < NIR_MAX_VEC_COMPONENTS
);
224 if (nir_alu_instr_channel_used(instr
, index
, i
))
225 validate_assert(state
, src
->swizzle
[i
] < num_components
);
228 validate_src(&src
->src
, state
, 0, 0);
232 validate_reg_dest(nir_reg_dest
*dest
, validate_state
*state
,
233 unsigned bit_sizes
, unsigned num_components
)
235 validate_assert(state
, dest
->reg
!= NULL
);
237 validate_assert(state
, dest
->parent_instr
== state
->instr
);
239 struct hash_entry
*entry2
;
240 entry2
= _mesa_hash_table_search(state
->regs
, dest
->reg
);
242 validate_assert(state
, entry2
);
244 reg_validate_state
*reg_state
= (reg_validate_state
*) entry2
->data
;
245 _mesa_set_add(reg_state
->defs
, dest
);
247 validate_assert(state
, reg_state
->where_defined
== state
->impl
&&
248 "writing to a register declared in a different function");
251 validate_assert(state
, dest
->reg
->bit_size
& bit_sizes
);
253 validate_assert(state
, dest
->reg
->num_components
== num_components
);
255 validate_assert(state
, (dest
->reg
->num_array_elems
== 0 ||
256 dest
->base_offset
< dest
->reg
->num_array_elems
) &&
257 "definitely out-of-bounds array access");
259 if (dest
->indirect
) {
260 validate_assert(state
, dest
->reg
->num_array_elems
!= 0);
261 validate_assert(state
, (dest
->indirect
->is_ssa
|| dest
->indirect
->reg
.indirect
== NULL
) &&
262 "only one level of indirection allowed");
263 validate_src(dest
->indirect
, state
, 32, 1);
268 validate_ssa_def(nir_ssa_def
*def
, validate_state
*state
)
270 validate_assert(state
, def
->index
< state
->impl
->ssa_alloc
);
271 validate_assert(state
, !BITSET_TEST(state
->ssa_defs_found
, def
->index
));
272 BITSET_SET(state
->ssa_defs_found
, def
->index
);
274 validate_assert(state
, def
->parent_instr
== state
->instr
);
276 validate_assert(state
, (def
->num_components
<= 4) ||
277 (def
->num_components
== 8) ||
278 (def
->num_components
== 16));
280 list_validate(&def
->uses
);
281 nir_foreach_use(src
, def
) {
282 validate_assert(state
, src
->is_ssa
);
283 validate_assert(state
, src
->ssa
== def
);
284 bool already_seen
= false;
285 _mesa_set_search_and_add(state
->ssa_srcs
, src
, &already_seen
);
286 /* A nir_src should only appear once and only in one SSA def use list */
287 validate_assert(state
, !already_seen
);
290 list_validate(&def
->if_uses
);
291 nir_foreach_if_use(src
, def
) {
292 validate_assert(state
, src
->is_ssa
);
293 validate_assert(state
, src
->ssa
== def
);
294 bool already_seen
= false;
295 _mesa_set_search_and_add(state
->ssa_srcs
, SET_PTR_BIT(src
, 0),
297 /* A nir_src should only appear once and only in one SSA def use list */
298 validate_assert(state
, !already_seen
);
303 validate_dest(nir_dest
*dest
, validate_state
*state
,
304 unsigned bit_sizes
, unsigned num_components
)
308 validate_assert(state
, dest
->ssa
.bit_size
& bit_sizes
);
310 validate_assert(state
, dest
->ssa
.num_components
== num_components
);
311 validate_ssa_def(&dest
->ssa
, state
);
313 validate_reg_dest(&dest
->reg
, state
, bit_sizes
, num_components
);
318 validate_alu_dest(nir_alu_instr
*instr
, validate_state
*state
)
320 nir_alu_dest
*dest
= &instr
->dest
;
322 unsigned dest_size
= nir_dest_num_components(dest
->dest
);
324 * validate that the instruction doesn't write to components not in the
327 validate_assert(state
, !(dest
->write_mask
& ~((1 << dest_size
) - 1)));
329 /* validate that saturate is only ever used on instructions with
330 * destinations of type float
332 nir_alu_instr
*alu
= nir_instr_as_alu(state
->instr
);
333 validate_assert(state
,
334 (nir_alu_type_get_base_type(nir_op_infos
[alu
->op
].output_type
) ==
338 validate_dest(&dest
->dest
, state
, 0, 0);
342 validate_alu_instr(nir_alu_instr
*instr
, validate_state
*state
)
344 validate_assert(state
, instr
->op
< nir_num_opcodes
);
346 unsigned instr_bit_size
= 0;
347 for (unsigned i
= 0; i
< nir_op_infos
[instr
->op
].num_inputs
; i
++) {
348 nir_alu_type src_type
= nir_op_infos
[instr
->op
].input_types
[i
];
349 unsigned src_bit_size
= nir_src_bit_size(instr
->src
[i
].src
);
350 if (nir_alu_type_get_type_size(src_type
)) {
351 validate_assert(state
, src_bit_size
== nir_alu_type_get_type_size(src_type
));
352 } else if (instr_bit_size
) {
353 validate_assert(state
, src_bit_size
== instr_bit_size
);
355 instr_bit_size
= src_bit_size
;
358 if (nir_alu_type_get_base_type(src_type
) == nir_type_float
) {
359 /* 8-bit float isn't a thing */
360 validate_assert(state
, src_bit_size
== 16 || src_bit_size
== 32 ||
364 validate_alu_src(instr
, i
, state
);
367 nir_alu_type dest_type
= nir_op_infos
[instr
->op
].output_type
;
368 unsigned dest_bit_size
= nir_dest_bit_size(instr
->dest
.dest
);
369 if (nir_alu_type_get_type_size(dest_type
)) {
370 validate_assert(state
, dest_bit_size
== nir_alu_type_get_type_size(dest_type
));
371 } else if (instr_bit_size
) {
372 validate_assert(state
, dest_bit_size
== instr_bit_size
);
374 /* The only unsized thing is the destination so it's vacuously valid */
377 if (nir_alu_type_get_base_type(dest_type
) == nir_type_float
) {
378 /* 8-bit float isn't a thing */
379 validate_assert(state
, dest_bit_size
== 16 || dest_bit_size
== 32 ||
380 dest_bit_size
== 64);
383 validate_alu_dest(instr
, state
);
387 validate_var_use(nir_variable
*var
, validate_state
*state
)
389 struct hash_entry
*entry
= _mesa_hash_table_search(state
->var_defs
, var
);
390 validate_assert(state
, entry
);
391 if (var
->data
.mode
== nir_var_function_temp
)
392 validate_assert(state
, (nir_function_impl
*) entry
->data
== state
->impl
);
396 validate_deref_instr(nir_deref_instr
*instr
, validate_state
*state
)
398 if (instr
->deref_type
== nir_deref_type_var
) {
399 /* Variable dereferences are stupid simple. */
400 validate_assert(state
, instr
->mode
== instr
->var
->data
.mode
);
401 validate_assert(state
, instr
->type
== instr
->var
->type
);
402 validate_var_use(instr
->var
, state
);
403 } else if (instr
->deref_type
== nir_deref_type_cast
) {
404 /* For cast, we simply have to trust the instruction. It's up to
405 * lowering passes and front/back-ends to make them sane.
407 validate_src(&instr
->parent
, state
, 0, 0);
409 /* We just validate that the type and mode are there */
410 validate_assert(state
, instr
->mode
);
411 validate_assert(state
, instr
->type
);
413 /* We require the parent to be SSA. This may be lifted in the future */
414 validate_assert(state
, instr
->parent
.is_ssa
);
416 /* The parent pointer value must have the same number of components
417 * as the destination.
419 validate_src(&instr
->parent
, state
, nir_dest_bit_size(instr
->dest
),
420 nir_dest_num_components(instr
->dest
));
422 nir_instr
*parent_instr
= instr
->parent
.ssa
->parent_instr
;
424 /* The parent must come from another deref instruction */
425 validate_assert(state
, parent_instr
->type
== nir_instr_type_deref
);
427 nir_deref_instr
*parent
= nir_instr_as_deref(parent_instr
);
429 validate_assert(state
, instr
->mode
== parent
->mode
);
431 switch (instr
->deref_type
) {
432 case nir_deref_type_struct
:
433 validate_assert(state
, glsl_type_is_struct_or_ifc(parent
->type
));
434 validate_assert(state
,
435 instr
->strct
.index
< glsl_get_length(parent
->type
));
436 validate_assert(state
, instr
->type
==
437 glsl_get_struct_field(parent
->type
, instr
->strct
.index
));
440 case nir_deref_type_array
:
441 case nir_deref_type_array_wildcard
:
442 if (instr
->mode
== nir_var_mem_ubo
||
443 instr
->mode
== nir_var_mem_ssbo
||
444 instr
->mode
== nir_var_mem_shared
||
445 instr
->mode
== nir_var_mem_global
) {
446 /* Shared variables and UBO/SSBOs have a bit more relaxed rules
447 * because we need to be able to handle array derefs on vectors.
448 * Fortunately, nir_lower_io handles these just fine.
450 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
451 glsl_type_is_matrix(parent
->type
) ||
452 glsl_type_is_vector(parent
->type
));
454 /* Most of NIR cannot handle array derefs on vectors */
455 validate_assert(state
, glsl_type_is_array(parent
->type
) ||
456 glsl_type_is_matrix(parent
->type
));
458 validate_assert(state
,
459 instr
->type
== glsl_get_array_element(parent
->type
));
461 if (instr
->deref_type
== nir_deref_type_array
) {
462 validate_src(&instr
->arr
.index
, state
,
463 nir_dest_bit_size(instr
->dest
), 1);
467 case nir_deref_type_ptr_as_array
:
468 /* ptr_as_array derefs must have a parent that is either an array,
469 * ptr_as_array, or cast. If the parent is a cast, we get the stride
470 * information (if any) from the cast deref.
472 validate_assert(state
,
473 parent
->deref_type
== nir_deref_type_array
||
474 parent
->deref_type
== nir_deref_type_ptr_as_array
||
475 parent
->deref_type
== nir_deref_type_cast
);
476 validate_src(&instr
->arr
.index
, state
,
477 nir_dest_bit_size(instr
->dest
), 1);
481 unreachable("Invalid deref instruction type");
485 /* We intentionally don't validate the size of the destination because we
486 * want to let other compiler components such as SPIR-V decide how big
487 * pointers should be.
489 validate_dest(&instr
->dest
, state
, 0, 0);
491 /* Deref instructions as if conditions don't make sense because if
492 * conditions expect well-formed Booleans. If you want to compare with
493 * NULL, an explicit comparison operation should be used.
495 validate_assert(state
, list_empty(&instr
->dest
.ssa
.if_uses
));
499 validate_intrinsic_instr(nir_intrinsic_instr
*instr
, validate_state
*state
)
501 unsigned dest_bit_size
= 0;
502 unsigned src_bit_sizes
[NIR_INTRINSIC_MAX_INPUTS
] = { 0, };
503 switch (instr
->intrinsic
) {
504 case nir_intrinsic_load_param
: {
505 unsigned param_idx
= nir_intrinsic_param_idx(instr
);
506 validate_assert(state
, param_idx
< state
->impl
->function
->num_params
);
507 nir_parameter
*param
= &state
->impl
->function
->params
[param_idx
];
508 validate_assert(state
, instr
->num_components
== param
->num_components
);
509 dest_bit_size
= param
->bit_size
;
513 case nir_intrinsic_load_deref
: {
514 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[0]);
515 validate_assert(state
, glsl_type_is_vector_or_scalar(src
->type
) ||
516 (src
->mode
== nir_var_uniform
&&
517 glsl_get_base_type(src
->type
) == GLSL_TYPE_SUBROUTINE
));
518 validate_assert(state
, instr
->num_components
==
519 glsl_get_vector_elements(src
->type
));
520 dest_bit_size
= glsl_get_bit_size(src
->type
);
521 /* Also allow 32-bit boolean load operations */
522 if (glsl_type_is_boolean(src
->type
))
527 case nir_intrinsic_store_deref
: {
528 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
529 validate_assert(state
, glsl_type_is_vector_or_scalar(dst
->type
));
530 validate_assert(state
, instr
->num_components
==
531 glsl_get_vector_elements(dst
->type
));
532 src_bit_sizes
[1] = glsl_get_bit_size(dst
->type
);
533 /* Also allow 32-bit boolean store operations */
534 if (glsl_type_is_boolean(dst
->type
))
535 src_bit_sizes
[1] |= 32;
536 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
537 nir_var_uniform
)) == 0);
538 validate_assert(state
, (nir_intrinsic_write_mask(instr
) & ~((1 << instr
->num_components
) - 1)) == 0);
542 case nir_intrinsic_copy_deref
: {
543 nir_deref_instr
*dst
= nir_src_as_deref(instr
->src
[0]);
544 nir_deref_instr
*src
= nir_src_as_deref(instr
->src
[1]);
545 validate_assert(state
, glsl_get_bare_type(dst
->type
) ==
546 glsl_get_bare_type(src
->type
));
547 validate_assert(state
, (dst
->mode
& (nir_var_shader_in
|
548 nir_var_uniform
)) == 0);
556 unsigned num_srcs
= nir_intrinsic_infos
[instr
->intrinsic
].num_srcs
;
557 for (unsigned i
= 0; i
< num_srcs
; i
++) {
558 unsigned components_read
= nir_intrinsic_src_components(instr
, i
);
560 validate_assert(state
, components_read
> 0);
562 validate_src(&instr
->src
[i
], state
, src_bit_sizes
[i
], components_read
);
565 if (nir_intrinsic_infos
[instr
->intrinsic
].has_dest
) {
566 unsigned components_written
= nir_intrinsic_dest_components(instr
);
567 unsigned bit_sizes
= nir_intrinsic_infos
[instr
->intrinsic
].dest_bit_sizes
;
569 validate_assert(state
, components_written
> 0);
571 if (dest_bit_size
&& bit_sizes
)
572 validate_assert(state
, dest_bit_size
& bit_sizes
);
574 dest_bit_size
= dest_bit_size
? dest_bit_size
: bit_sizes
;
576 validate_dest(&instr
->dest
, state
, dest_bit_size
, components_written
);
581 validate_tex_instr(nir_tex_instr
*instr
, validate_state
*state
)
583 bool src_type_seen
[nir_num_tex_src_types
];
584 for (unsigned i
= 0; i
< nir_num_tex_src_types
; i
++)
585 src_type_seen
[i
] = false;
587 for (unsigned i
= 0; i
< instr
->num_srcs
; i
++) {
588 validate_assert(state
, !src_type_seen
[instr
->src
[i
].src_type
]);
589 src_type_seen
[instr
->src
[i
].src_type
] = true;
590 validate_src(&instr
->src
[i
].src
, state
,
591 0, nir_tex_instr_src_size(instr
, i
));
593 switch (instr
->src
[i
].src_type
) {
594 case nir_tex_src_texture_deref
:
595 case nir_tex_src_sampler_deref
:
596 validate_assert(state
, instr
->src
[i
].src
.is_ssa
);
597 validate_assert(state
,
598 instr
->src
[i
].src
.ssa
->parent_instr
->type
== nir_instr_type_deref
);
605 if (nir_tex_instr_has_explicit_tg4_offsets(instr
)) {
606 validate_assert(state
, instr
->op
== nir_texop_tg4
);
607 validate_assert(state
, !src_type_seen
[nir_tex_src_offset
]);
610 validate_dest(&instr
->dest
, state
, 0, nir_tex_instr_dest_size(instr
));
614 validate_call_instr(nir_call_instr
*instr
, validate_state
*state
)
616 validate_assert(state
, instr
->num_params
== instr
->callee
->num_params
);
618 for (unsigned i
= 0; i
< instr
->num_params
; i
++) {
619 validate_src(&instr
->params
[i
], state
,
620 instr
->callee
->params
[i
].bit_size
,
621 instr
->callee
->params
[i
].num_components
);
626 validate_const_value(nir_const_value
*val
, unsigned bit_size
,
627 validate_state
*state
)
629 /* In order for block copies to work properly for things like instruction
630 * comparisons and [de]serialization, we require the unused bits of the
631 * nir_const_value to be zero.
633 nir_const_value cmp_val
;
634 memset(&cmp_val
, 0, sizeof(cmp_val
));
640 cmp_val
.u8
= val
->u8
;
643 cmp_val
.u16
= val
->u16
;
646 cmp_val
.u32
= val
->u32
;
649 cmp_val
.u64
= val
->u64
;
652 validate_assert(state
, !"Invalid load_const bit size");
654 validate_assert(state
, memcmp(val
, &cmp_val
, sizeof(cmp_val
)) == 0);
658 validate_load_const_instr(nir_load_const_instr
*instr
, validate_state
*state
)
660 validate_ssa_def(&instr
->def
, state
);
662 for (unsigned i
= 0; i
< instr
->def
.num_components
; i
++)
663 validate_const_value(&instr
->value
[i
], instr
->def
.bit_size
, state
);
667 validate_ssa_undef_instr(nir_ssa_undef_instr
*instr
, validate_state
*state
)
669 validate_ssa_def(&instr
->def
, state
);
673 validate_phi_instr(nir_phi_instr
*instr
, validate_state
*state
)
676 * don't validate the sources until we get to them from their predecessor
677 * basic blocks, to avoid validating an SSA use before its definition.
680 validate_dest(&instr
->dest
, state
, 0, 0);
682 exec_list_validate(&instr
->srcs
);
683 validate_assert(state
, exec_list_length(&instr
->srcs
) ==
684 state
->block
->predecessors
->entries
);
688 validate_instr(nir_instr
*instr
, validate_state
*state
)
690 validate_assert(state
, instr
->block
== state
->block
);
692 state
->instr
= instr
;
694 switch (instr
->type
) {
695 case nir_instr_type_alu
:
696 validate_alu_instr(nir_instr_as_alu(instr
), state
);
699 case nir_instr_type_deref
:
700 validate_deref_instr(nir_instr_as_deref(instr
), state
);
703 case nir_instr_type_call
:
704 validate_call_instr(nir_instr_as_call(instr
), state
);
707 case nir_instr_type_intrinsic
:
708 validate_intrinsic_instr(nir_instr_as_intrinsic(instr
), state
);
711 case nir_instr_type_tex
:
712 validate_tex_instr(nir_instr_as_tex(instr
), state
);
715 case nir_instr_type_load_const
:
716 validate_load_const_instr(nir_instr_as_load_const(instr
), state
);
719 case nir_instr_type_phi
:
720 validate_phi_instr(nir_instr_as_phi(instr
), state
);
723 case nir_instr_type_ssa_undef
:
724 validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr
), state
);
727 case nir_instr_type_jump
:
731 validate_assert(state
, !"Invalid ALU instruction type");
739 validate_phi_src(nir_phi_instr
*instr
, nir_block
*pred
, validate_state
*state
)
741 state
->instr
= &instr
->instr
;
743 validate_assert(state
, instr
->dest
.is_ssa
);
745 exec_list_validate(&instr
->srcs
);
746 nir_foreach_phi_src(src
, instr
) {
747 if (src
->pred
== pred
) {
748 validate_assert(state
, src
->src
.is_ssa
);
749 validate_src(&src
->src
, state
, instr
->dest
.ssa
.bit_size
,
750 instr
->dest
.ssa
.num_components
);
760 validate_phi_srcs(nir_block
*block
, nir_block
*succ
, validate_state
*state
)
762 nir_foreach_instr(instr
, succ
) {
763 if (instr
->type
!= nir_instr_type_phi
)
766 validate_phi_src(nir_instr_as_phi(instr
), block
, state
);
770 static void validate_cf_node(nir_cf_node
*node
, validate_state
*state
);
773 validate_block(nir_block
*block
, validate_state
*state
)
775 validate_assert(state
, block
->cf_node
.parent
== state
->parent_node
);
777 state
->block
= block
;
779 exec_list_validate(&block
->instr_list
);
780 nir_foreach_instr(instr
, block
) {
781 if (instr
->type
== nir_instr_type_phi
) {
782 validate_assert(state
, instr
== nir_block_first_instr(block
) ||
783 nir_instr_prev(instr
)->type
== nir_instr_type_phi
);
786 if (instr
->type
== nir_instr_type_jump
) {
787 validate_assert(state
, instr
== nir_block_last_instr(block
));
790 validate_instr(instr
, state
);
793 validate_assert(state
, block
->successors
[0] != NULL
);
794 validate_assert(state
, block
->successors
[0] != block
->successors
[1]);
796 for (unsigned i
= 0; i
< 2; i
++) {
797 if (block
->successors
[i
] != NULL
) {
798 struct set_entry
*entry
=
799 _mesa_set_search(block
->successors
[i
]->predecessors
, block
);
800 validate_assert(state
, entry
);
802 validate_phi_srcs(block
, block
->successors
[i
], state
);
806 set_foreach(block
->predecessors
, entry
) {
807 const nir_block
*pred
= entry
->key
;
808 validate_assert(state
, pred
->successors
[0] == block
||
809 pred
->successors
[1] == block
);
812 if (!exec_list_is_empty(&block
->instr_list
) &&
813 nir_block_last_instr(block
)->type
== nir_instr_type_jump
) {
814 validate_assert(state
, block
->successors
[1] == NULL
);
815 nir_jump_instr
*jump
= nir_instr_as_jump(nir_block_last_instr(block
));
816 switch (jump
->type
) {
817 case nir_jump_break
: {
819 nir_cf_node_as_block(nir_cf_node_next(&state
->loop
->cf_node
));
820 validate_assert(state
, block
->successors
[0] == after
);
824 case nir_jump_continue
: {
825 nir_block
*first
= nir_loop_first_block(state
->loop
);
826 validate_assert(state
, block
->successors
[0] == first
);
830 case nir_jump_return
:
831 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
835 unreachable("bad jump type");
838 nir_cf_node
*next
= nir_cf_node_next(&block
->cf_node
);
840 switch (state
->parent_node
->type
) {
841 case nir_cf_node_loop
: {
842 nir_block
*first
= nir_loop_first_block(state
->loop
);
843 validate_assert(state
, block
->successors
[0] == first
);
844 /* due to the hack for infinite loops, block->successors[1] may
845 * point to the block after the loop.
850 case nir_cf_node_if
: {
852 nir_cf_node_as_block(nir_cf_node_next(state
->parent_node
));
853 validate_assert(state
, block
->successors
[0] == after
);
854 validate_assert(state
, block
->successors
[1] == NULL
);
858 case nir_cf_node_function
:
859 validate_assert(state
, block
->successors
[0] == state
->impl
->end_block
);
860 validate_assert(state
, block
->successors
[1] == NULL
);
864 unreachable("unknown control flow node type");
867 if (next
->type
== nir_cf_node_if
) {
868 nir_if
*if_stmt
= nir_cf_node_as_if(next
);
869 validate_assert(state
, block
->successors
[0] ==
870 nir_if_first_then_block(if_stmt
));
871 validate_assert(state
, block
->successors
[1] ==
872 nir_if_first_else_block(if_stmt
));
874 validate_assert(state
, next
->type
== nir_cf_node_loop
);
875 nir_loop
*loop
= nir_cf_node_as_loop(next
);
876 validate_assert(state
, block
->successors
[0] ==
877 nir_loop_first_block(loop
));
878 validate_assert(state
, block
->successors
[1] == NULL
);
885 validate_if(nir_if
*if_stmt
, validate_state
*state
)
887 state
->if_stmt
= if_stmt
;
889 validate_assert(state
, !exec_node_is_head_sentinel(if_stmt
->cf_node
.node
.prev
));
890 nir_cf_node
*prev_node
= nir_cf_node_prev(&if_stmt
->cf_node
);
891 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
893 validate_assert(state
, !exec_node_is_tail_sentinel(if_stmt
->cf_node
.node
.next
));
894 nir_cf_node
*next_node
= nir_cf_node_next(&if_stmt
->cf_node
);
895 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
897 validate_src(&if_stmt
->condition
, state
, 0, 1);
899 validate_assert(state
, !exec_list_is_empty(&if_stmt
->then_list
));
900 validate_assert(state
, !exec_list_is_empty(&if_stmt
->else_list
));
902 nir_cf_node
*old_parent
= state
->parent_node
;
903 state
->parent_node
= &if_stmt
->cf_node
;
905 exec_list_validate(&if_stmt
->then_list
);
906 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->then_list
) {
907 validate_cf_node(cf_node
, state
);
910 exec_list_validate(&if_stmt
->else_list
);
911 foreach_list_typed(nir_cf_node
, cf_node
, node
, &if_stmt
->else_list
) {
912 validate_cf_node(cf_node
, state
);
915 state
->parent_node
= old_parent
;
916 state
->if_stmt
= NULL
;
920 validate_loop(nir_loop
*loop
, validate_state
*state
)
922 validate_assert(state
, !exec_node_is_head_sentinel(loop
->cf_node
.node
.prev
));
923 nir_cf_node
*prev_node
= nir_cf_node_prev(&loop
->cf_node
);
924 validate_assert(state
, prev_node
->type
== nir_cf_node_block
);
926 validate_assert(state
, !exec_node_is_tail_sentinel(loop
->cf_node
.node
.next
));
927 nir_cf_node
*next_node
= nir_cf_node_next(&loop
->cf_node
);
928 validate_assert(state
, next_node
->type
== nir_cf_node_block
);
930 validate_assert(state
, !exec_list_is_empty(&loop
->body
));
932 nir_cf_node
*old_parent
= state
->parent_node
;
933 state
->parent_node
= &loop
->cf_node
;
934 nir_loop
*old_loop
= state
->loop
;
937 exec_list_validate(&loop
->body
);
938 foreach_list_typed(nir_cf_node
, cf_node
, node
, &loop
->body
) {
939 validate_cf_node(cf_node
, state
);
942 state
->parent_node
= old_parent
;
943 state
->loop
= old_loop
;
947 validate_cf_node(nir_cf_node
*node
, validate_state
*state
)
949 validate_assert(state
, node
->parent
== state
->parent_node
);
951 switch (node
->type
) {
952 case nir_cf_node_block
:
953 validate_block(nir_cf_node_as_block(node
), state
);
957 validate_if(nir_cf_node_as_if(node
), state
);
960 case nir_cf_node_loop
:
961 validate_loop(nir_cf_node_as_loop(node
), state
);
965 unreachable("Invalid CF node type");
970 prevalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
972 validate_assert(state
, reg
->index
< state
->impl
->reg_alloc
);
973 validate_assert(state
, !BITSET_TEST(state
->regs_found
, reg
->index
));
974 BITSET_SET(state
->regs_found
, reg
->index
);
976 list_validate(®
->uses
);
977 list_validate(®
->defs
);
978 list_validate(®
->if_uses
);
980 reg_validate_state
*reg_state
= ralloc(state
->regs
, reg_validate_state
);
981 reg_state
->uses
= _mesa_pointer_set_create(reg_state
);
982 reg_state
->if_uses
= _mesa_pointer_set_create(reg_state
);
983 reg_state
->defs
= _mesa_pointer_set_create(reg_state
);
985 reg_state
->where_defined
= state
->impl
;
987 _mesa_hash_table_insert(state
->regs
, reg
, reg_state
);
991 postvalidate_reg_decl(nir_register
*reg
, validate_state
*state
)
993 struct hash_entry
*entry
= _mesa_hash_table_search(state
->regs
, reg
);
996 reg_validate_state
*reg_state
= (reg_validate_state
*) entry
->data
;
998 nir_foreach_use(src
, reg
) {
999 struct set_entry
*entry
= _mesa_set_search(reg_state
->uses
, src
);
1000 validate_assert(state
, entry
);
1001 _mesa_set_remove(reg_state
->uses
, entry
);
1004 if (reg_state
->uses
->entries
!= 0) {
1005 printf("extra entries in register uses:\n");
1006 set_foreach(reg_state
->uses
, entry
)
1007 printf("%p\n", entry
->key
);
1012 nir_foreach_if_use(src
, reg
) {
1013 struct set_entry
*entry
= _mesa_set_search(reg_state
->if_uses
, src
);
1014 validate_assert(state
, entry
);
1015 _mesa_set_remove(reg_state
->if_uses
, entry
);
1018 if (reg_state
->if_uses
->entries
!= 0) {
1019 printf("extra entries in register if_uses:\n");
1020 set_foreach(reg_state
->if_uses
, entry
)
1021 printf("%p\n", entry
->key
);
1026 nir_foreach_def(src
, reg
) {
1027 struct set_entry
*entry
= _mesa_set_search(reg_state
->defs
, src
);
1028 validate_assert(state
, entry
);
1029 _mesa_set_remove(reg_state
->defs
, entry
);
1032 if (reg_state
->defs
->entries
!= 0) {
1033 printf("extra entries in register defs:\n");
1034 set_foreach(reg_state
->defs
, entry
)
1035 printf("%p\n", entry
->key
);
1042 validate_var_decl(nir_variable
*var
, bool is_global
, validate_state
*state
)
1046 validate_assert(state
, is_global
== nir_variable_is_global(var
));
1048 /* Must have exactly one mode set */
1049 validate_assert(state
, util_is_power_of_two_nonzero(var
->data
.mode
));
1051 if (var
->data
.compact
) {
1052 /* The "compact" flag is only valid on arrays of scalars. */
1053 assert(glsl_type_is_array(var
->type
));
1055 const struct glsl_type
*type
= glsl_get_array_element(var
->type
);
1056 if (nir_is_per_vertex_io(var
, state
->shader
->info
.stage
)) {
1057 assert(glsl_type_is_array(type
));
1058 assert(glsl_type_is_scalar(glsl_get_array_element(type
)));
1060 assert(glsl_type_is_scalar(type
));
1064 if (var
->num_members
> 0) {
1065 const struct glsl_type
*without_array
= glsl_without_array(var
->type
);
1066 validate_assert(state
, glsl_type_is_struct_or_ifc(without_array
));
1067 validate_assert(state
, var
->num_members
== glsl_get_length(without_array
));
1068 validate_assert(state
, var
->members
!= NULL
);
1072 * TODO validate some things ir_validate.cpp does (requires more GLSL type
1076 _mesa_hash_table_insert(state
->var_defs
, var
,
1077 is_global
? NULL
: state
->impl
);
1083 validate_function_impl(nir_function_impl
*impl
, validate_state
*state
)
1085 /* Resize the ssa_srcs set. It's likely that the size of this set will
1086 * never actually hit the number of SSA defs because we remove sources from
1087 * the set as we visit them. (It could actually be much larger because
1088 * each SSA def can be used more than once.) However, growing it now costs
1089 * us very little (the extra memory is already dwarfed by the SSA defs
1090 * themselves) and makes collisions much less likely.
1092 _mesa_set_resize(state
->ssa_srcs
, impl
->ssa_alloc
);
1094 validate_assert(state
, impl
->function
->impl
== impl
);
1095 validate_assert(state
, impl
->cf_node
.parent
== NULL
);
1097 validate_assert(state
, exec_list_is_empty(&impl
->end_block
->instr_list
));
1098 validate_assert(state
, impl
->end_block
->successors
[0] == NULL
);
1099 validate_assert(state
, impl
->end_block
->successors
[1] == NULL
);
1102 state
->parent_node
= &impl
->cf_node
;
1104 exec_list_validate(&impl
->locals
);
1105 nir_foreach_variable(var
, &impl
->locals
) {
1106 validate_var_decl(var
, false, state
);
1109 state
->regs_found
= reralloc(state
->mem_ctx
, state
->regs_found
,
1110 BITSET_WORD
, BITSET_WORDS(impl
->reg_alloc
));
1111 memset(state
->regs_found
, 0, BITSET_WORDS(impl
->reg_alloc
) *
1112 sizeof(BITSET_WORD
));
1113 exec_list_validate(&impl
->registers
);
1114 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1115 prevalidate_reg_decl(reg
, state
);
1118 state
->ssa_defs_found
= reralloc(state
->mem_ctx
, state
->ssa_defs_found
,
1119 BITSET_WORD
, BITSET_WORDS(impl
->ssa_alloc
));
1120 memset(state
->ssa_defs_found
, 0, BITSET_WORDS(impl
->ssa_alloc
) *
1121 sizeof(BITSET_WORD
));
1122 exec_list_validate(&impl
->body
);
1123 foreach_list_typed(nir_cf_node
, node
, node
, &impl
->body
) {
1124 validate_cf_node(node
, state
);
1127 foreach_list_typed(nir_register
, reg
, node
, &impl
->registers
) {
1128 postvalidate_reg_decl(reg
, state
);
1131 if (state
->ssa_srcs
->entries
!= 0) {
1132 printf("extra dangling SSA sources:\n");
1133 set_foreach(state
->ssa_srcs
, entry
)
1134 printf("%p\n", entry
->key
);
1141 validate_function(nir_function
*func
, validate_state
*state
)
1143 if (func
->impl
!= NULL
) {
1144 validate_assert(state
, func
->impl
->function
== func
);
1145 validate_function_impl(func
->impl
, state
);
1150 init_validate_state(validate_state
*state
)
1152 state
->mem_ctx
= ralloc_context(NULL
);
1153 state
->regs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1154 state
->ssa_srcs
= _mesa_pointer_set_create(state
->mem_ctx
);
1155 state
->ssa_defs_found
= NULL
;
1156 state
->regs_found
= NULL
;
1157 state
->var_defs
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1158 state
->errors
= _mesa_pointer_hash_table_create(state
->mem_ctx
);
1161 state
->instr
= NULL
;
1166 destroy_validate_state(validate_state
*state
)
1168 ralloc_free(state
->mem_ctx
);
1171 mtx_t fail_dump_mutex
= _MTX_INITIALIZER_NP
;
1174 dump_errors(validate_state
*state
, const char *when
)
1176 struct hash_table
*errors
= state
->errors
;
1178 /* Lock around dumping so that we get clean dumps in a multi-threaded
1181 mtx_lock(&fail_dump_mutex
);
1184 fprintf(stderr
, "NIR validation failed %s\n", when
);
1185 fprintf(stderr
, "%d errors:\n", _mesa_hash_table_num_entries(errors
));
1187 fprintf(stderr
, "NIR validation failed with %d errors:\n",
1188 _mesa_hash_table_num_entries(errors
));
1191 nir_print_shader_annotated(state
->shader
, stderr
, errors
);
1193 if (_mesa_hash_table_num_entries(errors
) > 0) {
1194 fprintf(stderr
, "%d additional errors:\n",
1195 _mesa_hash_table_num_entries(errors
));
1196 hash_table_foreach(errors
, entry
) {
1197 fprintf(stderr
, "%s\n", (char *)entry
->data
);
1201 mtx_unlock(&fail_dump_mutex
);
1207 nir_validate_shader(nir_shader
*shader
, const char *when
)
1209 static int should_validate
= -1;
1210 if (should_validate
< 0)
1211 should_validate
= env_var_as_boolean("NIR_VALIDATE", true);
1212 if (!should_validate
)
1215 validate_state state
;
1216 init_validate_state(&state
);
1218 state
.shader
= shader
;
1220 exec_list_validate(&shader
->uniforms
);
1221 nir_foreach_variable(var
, &shader
->uniforms
) {
1222 validate_var_decl(var
, true, &state
);
1225 exec_list_validate(&shader
->inputs
);
1226 nir_foreach_variable(var
, &shader
->inputs
) {
1227 validate_var_decl(var
, true, &state
);
1230 exec_list_validate(&shader
->outputs
);
1231 nir_foreach_variable(var
, &shader
->outputs
) {
1232 validate_var_decl(var
, true, &state
);
1235 exec_list_validate(&shader
->shared
);
1236 nir_foreach_variable(var
, &shader
->shared
) {
1237 validate_var_decl(var
, true, &state
);
1240 exec_list_validate(&shader
->globals
);
1241 nir_foreach_variable(var
, &shader
->globals
) {
1242 validate_var_decl(var
, true, &state
);
1245 exec_list_validate(&shader
->system_values
);
1246 nir_foreach_variable(var
, &shader
->system_values
) {
1247 validate_var_decl(var
, true, &state
);
1250 exec_list_validate(&shader
->functions
);
1251 foreach_list_typed(nir_function
, func
, node
, &shader
->functions
) {
1252 validate_function(func
, &state
);
1255 if (_mesa_hash_table_num_entries(state
.errors
) > 0)
1256 dump_errors(&state
, when
);
1258 destroy_validate_state(&state
);