src/glsl/nir/nir_validate.c

   1 /*
   2  * Copyright © 2014 Intel Corporation
   3  *
   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:
  10  *
  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
  13  * Software.
  14  *
  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
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Connor Abbott (cwabbott0@gmail.com)
  25  *
  26  */
  27
  28 #include "nir.h"
  29 #include <assert.h>
  30
  31 /*
  32  * This file checks for invalid IR indicating a bug somewhere in the compiler.
  33  */
  34
  35 /* Since this file is just a pile of asserts, don't bother compiling it if
  36  * we're not building a debug build.
  37  */
  38 #ifdef DEBUG
  39
  40 /*
  41  * Per-register validation state.
  42  */
  43
  44 typedef struct {
  45    /*
  46     * equivalent to the uses and defs in nir_register, but built up by the
  47     * validator. At the end, we verify that the sets have the same entries.
  48     */
  49    struct set *uses, *if_uses, *defs;
  50    nir_function_impl *where_defined; /* NULL for global registers */
  51 } reg_validate_state;
  52
  53 typedef struct {
  54    /*
  55     * equivalent to the uses in nir_ssa_def, but built up by the validator.
  56     * At the end, we verify that the sets have the same entries.
  57     */
  58    struct set *uses, *if_uses;
  59    nir_function_impl *where_defined;
  60 } ssa_def_validate_state;
  61
  62 typedef struct {
  63    /* map of register -> validation state (struct above) */
  64    struct hash_table *regs;
  65
  66    /* the current shader being validated */
  67    nir_shader *shader;
  68
  69    /* the current instruction being validated */
  70    nir_instr *instr;
  71
  72    /* the current basic block being validated */
  73    nir_block *block;
  74
  75    /* the current if statement being validated */
  76    nir_if *if_stmt;
  77
  78    /* the current loop being visited */
  79    nir_loop *loop;
  80
  81    /* the parent of the current cf node being visited */
  82    nir_cf_node *parent_node;
  83
  84    /* the current function implementation being validated */
  85    nir_function_impl *impl;
  86
  87    /* map of SSA value -> function implementation where it is defined */
  88    struct hash_table *ssa_defs;
  89
  90    /* bitset of ssa definitions we have found; used to check uniqueness */
  91    BITSET_WORD *ssa_defs_found;
  92
  93    /* bitset of registers we have currently found; used to check uniqueness */
  94    BITSET_WORD *regs_found;
  95
  96    /* map of local variable -> function implementation where it is defined */
  97    struct hash_table *var_defs;
  98 } validate_state;
  99
 100 static void validate_src(nir_src *src, validate_state *state);
 101
 102 static void
 103 validate_reg_src(nir_src *src, validate_state *state)
 104 {
 105    assert(src->reg.reg != NULL);
 106
 107    struct hash_entry *entry;
 108    entry = _mesa_hash_table_search(state->regs, src->reg.reg);
 109    assert(entry);
 110
 111    reg_validate_state *reg_state = (reg_validate_state *) entry->data;
 112
 113    if (state->instr) {
 114       _mesa_set_add(reg_state->uses, src);
 115    } else {
 116       assert(state->if_stmt);
 117       _mesa_set_add(reg_state->if_uses, src);
 118    }
 119
 120    if (!src->reg.reg->is_global) {
 121       assert(reg_state->where_defined == state->impl &&
 122              "using a register declared in a different function");
 123    }
 124
 125    assert((src->reg.reg->num_array_elems == 0 ||
 126           src->reg.base_offset < src->reg.reg->num_array_elems) &&
 127           "definitely out-of-bounds array access");
 128
 129    if (src->reg.indirect) {
 130       assert(src->reg.reg->num_array_elems != 0);
 131       assert((src->reg.indirect->is_ssa ||
 132               src->reg.indirect->reg.indirect == NULL) &&
 133              "only one level of indirection allowed");
 134       validate_src(src->reg.indirect, state);
 135    }
 136 }
 137
 138 static void
 139 validate_ssa_src(nir_src *src, validate_state *state)
 140 {
 141    assert(src->ssa != NULL);
 142
 143    struct hash_entry *entry = _mesa_hash_table_search(state->ssa_defs, src->ssa);
 144
 145    assert(entry);
 146
 147    ssa_def_validate_state *def_state = (ssa_def_validate_state *)entry->data;
 148
 149    assert(def_state->where_defined == state->impl &&
 150           "using an SSA value defined in a different function");
 151
 152    if (state->instr) {
 153       _mesa_set_add(def_state->uses, src);
 154    } else {
 155       assert(state->if_stmt);
 156       _mesa_set_add(def_state->if_uses, src);
 157    }
 158
 159    /* TODO validate that the use is dominated by the definition */
 160 }
 161
 162 static void
 163 validate_src(nir_src *src, validate_state *state)
 164 {
 165    if (state->instr)
 166       assert(src->parent_instr == state->instr);
 167    else
 168       assert(src->parent_if == state->if_stmt);
 169
 170    if (src->is_ssa)
 171       validate_ssa_src(src, state);
 172    else
 173       validate_reg_src(src, state);
 174 }
 175
 176 static void
 177 validate_alu_src(nir_alu_instr *instr, unsigned index, validate_state *state)
 178 {
 179    nir_alu_src *src = &instr->src[index];
 180
 181    unsigned num_components;
 182    if (src->src.is_ssa)
 183       num_components = src->src.ssa->num_components;
 184    else {
 185       if (src->src.reg.reg->is_packed)
 186          num_components = 4; /* can't check anything */
 187       else
 188          num_components = src->src.reg.reg->num_components;
 189    }
 190    for (unsigned i = 0; i < 4; i++) {
 191       assert(src->swizzle[i] < 4);
 192
 193       if (nir_alu_instr_channel_used(instr, index, i))
 194          assert(src->swizzle[i] < num_components);
 195    }
 196
 197    validate_src(&src->src, state);
 198 }
 199
 200 static void
 201 validate_reg_dest(nir_reg_dest *dest, validate_state *state)
 202 {
 203    assert(dest->reg != NULL);
 204
 205    assert(dest->parent_instr == state->instr);
 206
 207    struct hash_entry *entry2;
 208    entry2 = _mesa_hash_table_search(state->regs, dest->reg);
 209
 210    assert(entry2);
 211
 212    reg_validate_state *reg_state = (reg_validate_state *) entry2->data;
 213    _mesa_set_add(reg_state->defs, dest);
 214
 215    if (!dest->reg->is_global) {
 216       assert(reg_state->where_defined == state->impl &&
 217              "writing to a register declared in a different function");
 218    }
 219
 220    assert((dest->reg->num_array_elems == 0 ||
 221           dest->base_offset < dest->reg->num_array_elems) &&
 222           "definitely out-of-bounds array access");
 223
 224    if (dest->indirect) {
 225       assert(dest->reg->num_array_elems != 0);
 226       assert((dest->indirect->is_ssa || dest->indirect->reg.indirect == NULL) &&
 227              "only one level of indirection allowed");
 228       validate_src(dest->indirect, state);
 229    }
 230 }
 231
 232 static void
 233 validate_ssa_def(nir_ssa_def *def, validate_state *state)
 234 {
 235    assert(def->index < state->impl->ssa_alloc);
 236    assert(!BITSET_TEST(state->ssa_defs_found, def->index));
 237    BITSET_SET(state->ssa_defs_found, def->index);
 238
 239    assert(def->parent_instr == state->instr);
 240
 241    assert(def->num_components <= 4);
 242
 243    list_validate(&def->uses);
 244    list_validate(&def->if_uses);
 245
 246    ssa_def_validate_state *def_state = ralloc(state->ssa_defs,
 247                                               ssa_def_validate_state);
 248    def_state->where_defined = state->impl;
 249    def_state->uses = _mesa_set_create(def_state, _mesa_hash_pointer,
 250                                       _mesa_key_pointer_equal);
 251    def_state->if_uses = _mesa_set_create(def_state, _mesa_hash_pointer,
 252                                          _mesa_key_pointer_equal);
 253    _mesa_hash_table_insert(state->ssa_defs, def, def_state);
 254 }
 255
 256 static void
 257 validate_dest(nir_dest *dest, validate_state *state)
 258 {
 259    if (dest->is_ssa)
 260       validate_ssa_def(&dest->ssa, state);
 261    else
 262       validate_reg_dest(&dest->reg, state);
 263 }
 264
 265 static void
 266 validate_alu_dest(nir_alu_dest *dest, validate_state *state)
 267 {
 268    unsigned dest_size =
 269       dest->dest.is_ssa ? dest->dest.ssa.num_components
 270                         : dest->dest.reg.reg->num_components;
 271    bool is_packed = !dest->dest.is_ssa && dest->dest.reg.reg->is_packed;
 272    /*
 273     * validate that the instruction doesn't write to components not in the
 274     * register/SSA value
 275     */
 276    assert(is_packed || !(dest->write_mask & ~((1 << dest_size) - 1)));
 277
 278    /* validate that saturate is only ever used on instructions with
 279     * destinations of type float
 280     */
 281    nir_alu_instr *alu = nir_instr_as_alu(state->instr);
 282    assert(nir_op_infos[alu->op].output_type == nir_type_float ||
 283           !dest->saturate);
 284
 285    validate_dest(&dest->dest, state);
 286 }
 287
 288 static void
 289 validate_alu_instr(nir_alu_instr *instr, validate_state *state)
 290 {
 291    assert(instr->op < nir_num_opcodes);
 292
 293    validate_alu_dest(&instr->dest, state);
 294
 295    for (unsigned i = 0; i < nir_op_infos[instr->op].num_inputs; i++) {
 296       validate_alu_src(instr, i, state);
 297    }
 298 }
 299
 300 static void
 301 validate_deref_chain(nir_deref *deref, validate_state *state)
 302 {
 303    assert(deref->child == NULL || ralloc_parent(deref->child) == deref);
 304
 305    nir_deref *parent = NULL;
 306    while (deref != NULL) {
 307       switch (deref->deref_type) {
 308       case nir_deref_type_array:
 309          assert(deref->type == glsl_get_array_element(parent->type));
 310          if (nir_deref_as_array(deref)->deref_array_type ==
 311              nir_deref_array_type_indirect)
 312             validate_src(&nir_deref_as_array(deref)->indirect, state);
 313          break;
 314
 315       case nir_deref_type_struct:
 316          assert(deref->type ==
 317                 glsl_get_struct_field(parent->type,
 318                                       nir_deref_as_struct(deref)->index));
 319          break;
 320
 321       case nir_deref_type_var:
 322          break;
 323
 324       default:
 325          assert(!"Invalid deref type");
 326          break;
 327       }
 328
 329       parent = deref;
 330       deref = deref->child;
 331    }
 332 }
 333
 334 static void
 335 validate_var_use(nir_variable *var, validate_state *state)
 336 {
 337    if (var->data.mode == nir_var_local) {
 338       struct hash_entry *entry = _mesa_hash_table_search(state->var_defs, var);
 339
 340       assert(entry);
 341       assert((nir_function_impl *) entry->data == state->impl);
 342    }
 343 }
 344
 345 static void
 346 validate_deref_var(void *parent_mem_ctx, nir_deref_var *deref, validate_state *state)
 347 {
 348    assert(deref != NULL);
 349    assert(ralloc_parent(deref) == parent_mem_ctx);
 350    assert(deref->deref.type == deref->var->type);
 351
 352    validate_var_use(deref->var, state);
 353
 354    validate_deref_chain(&deref->deref, state);
 355 }
 356
 357 static void
 358 validate_intrinsic_instr(nir_intrinsic_instr *instr, validate_state *state)
 359 {
 360    unsigned num_srcs = nir_intrinsic_infos[instr->intrinsic].num_srcs;
 361    for (unsigned i = 0; i < num_srcs; i++) {
 362       unsigned components_read =
 363          nir_intrinsic_infos[instr->intrinsic].src_components[i];
 364       if (components_read == 0)
 365          components_read = instr->num_components;
 366
 367       assert(components_read > 0);
 368
 369       if (instr->src[i].is_ssa) {
 370          assert(components_read <= instr->src[i].ssa->num_components);
 371       } else if (!instr->src[i].reg.reg->is_packed) {
 372          assert(components_read <= instr->src[i].reg.reg->num_components);
 373       }
 374
 375       validate_src(&instr->src[i], state);
 376    }
 377
 378    if (nir_intrinsic_infos[instr->intrinsic].has_dest) {
 379       unsigned components_written =
 380          nir_intrinsic_infos[instr->intrinsic].dest_components;
 381       if (components_written == 0)
 382          components_written = instr->num_components;
 383
 384       assert(components_written > 0);
 385
 386       if (instr->dest.is_ssa) {
 387          assert(components_written <= instr->dest.ssa.num_components);
 388       } else if (!instr->dest.reg.reg->is_packed) {
 389          assert(components_written <= instr->dest.reg.reg->num_components);
 390       }
 391
 392       validate_dest(&instr->dest, state);
 393    }
 394
 395    unsigned num_vars = nir_intrinsic_infos[instr->intrinsic].num_variables;
 396    for (unsigned i = 0; i < num_vars; i++) {
 397       validate_deref_var(instr, instr->variables[i], state);
 398    }
 399
 400    switch (instr->intrinsic) {
 401    case nir_intrinsic_load_var: {
 402       const struct glsl_type *type =
 403          nir_deref_tail(&instr->variables[0]->deref)->type;
 404       assert(glsl_type_is_vector_or_scalar(type) ||
 405              (instr->variables[0]->var->data.mode == nir_var_uniform &&
 406               glsl_get_base_type(type) == GLSL_TYPE_SUBROUTINE));
 407       assert(instr->num_components == glsl_get_vector_elements(type));
 408       assert(instr->variables[0]->var->data.mode != nir_var_shader_out);
 409       break;
 410    }
 411    case nir_intrinsic_store_var: {
 412       const struct glsl_type *type =
 413          nir_deref_tail(&instr->variables[0]->deref)->type;
 414       assert(glsl_type_is_vector_or_scalar(type) ||
 415              (instr->variables[0]->var->data.mode == nir_var_uniform &&
 416               glsl_get_base_type(type) == GLSL_TYPE_SUBROUTINE));
 417       assert(instr->num_components == glsl_get_vector_elements(type));
 418       assert(instr->variables[0]->var->data.mode != nir_var_shader_in &&
 419              instr->variables[0]->var->data.mode != nir_var_uniform &&
 420              instr->variables[0]->var->data.mode != nir_var_shader_storage);
 421       break;
 422    }
 423    case nir_intrinsic_copy_var:
 424       assert(nir_deref_tail(&instr->variables[0]->deref)->type ==
 425              nir_deref_tail(&instr->variables[1]->deref)->type);
 426       assert(instr->variables[0]->var->data.mode != nir_var_shader_in &&
 427              instr->variables[0]->var->data.mode != nir_var_uniform &&
 428              instr->variables[0]->var->data.mode != nir_var_shader_storage);
 429       assert(instr->variables[1]->var->data.mode != nir_var_shader_out);
 430       break;
 431    default:
 432       break;
 433    }
 434 }
 435
 436 static void
 437 validate_tex_instr(nir_tex_instr *instr, validate_state *state)
 438 {
 439    validate_dest(&instr->dest, state);
 440
 441    bool src_type_seen[nir_num_tex_src_types];
 442    for (unsigned i = 0; i < nir_num_tex_src_types; i++)
 443       src_type_seen[i] = false;
 444
 445    for (unsigned i = 0; i < instr->num_srcs; i++) {
 446       assert(!src_type_seen[instr->src[i].src_type]);
 447       src_type_seen[instr->src[i].src_type] = true;
 448       validate_src(&instr->src[i].src, state);
 449    }
 450
 451    if (instr->sampler != NULL)
 452       validate_deref_var(instr, instr->sampler, state);
 453 }
 454
 455 static void
 456 validate_call_instr(nir_call_instr *instr, validate_state *state)
 457 {
 458    if (instr->return_deref == NULL)
 459       assert(glsl_type_is_void(instr->callee->return_type));
 460    else
 461       assert(instr->return_deref->deref.type == instr->callee->return_type);
 462
 463    assert(instr->num_params == instr->callee->num_params);
 464
 465    for (unsigned i = 0; i < instr->num_params; i++) {
 466       assert(instr->callee->params[i].type == instr->params[i]->deref.type);
 467       validate_deref_var(instr, instr->params[i], state);
 468    }
 469
 470    validate_deref_var(instr, instr->return_deref, state);
 471 }
 472
 473 static void
 474 validate_load_const_instr(nir_load_const_instr *instr, validate_state *state)
 475 {
 476    validate_ssa_def(&instr->def, state);
 477 }
 478
 479 static void
 480 validate_ssa_undef_instr(nir_ssa_undef_instr *instr, validate_state *state)
 481 {
 482    validate_ssa_def(&instr->def, state);
 483 }
 484
 485 static void
 486 validate_phi_instr(nir_phi_instr *instr, validate_state *state)
 487 {
 488    /*
 489     * don't validate the sources until we get to them from their predecessor
 490     * basic blocks, to avoid validating an SSA use before its definition.
 491     */
 492
 493    validate_dest(&instr->dest, state);
 494
 495    exec_list_validate(&instr->srcs);
 496    assert(exec_list_length(&instr->srcs) ==
 497           state->block->predecessors->entries);
 498 }
 499
 500 static void
 501 validate_instr(nir_instr *instr, validate_state *state)
 502 {
 503    assert(instr->block == state->block);
 504
 505    state->instr = instr;
 506
 507    switch (instr->type) {
 508    case nir_instr_type_alu:
 509       validate_alu_instr(nir_instr_as_alu(instr), state);
 510       break;
 511
 512    case nir_instr_type_call:
 513       validate_call_instr(nir_instr_as_call(instr), state);
 514       break;
 515
 516    case nir_instr_type_intrinsic:
 517       validate_intrinsic_instr(nir_instr_as_intrinsic(instr), state);
 518       break;
 519
 520    case nir_instr_type_tex:
 521       validate_tex_instr(nir_instr_as_tex(instr), state);
 522       break;
 523
 524    case nir_instr_type_load_const:
 525       validate_load_const_instr(nir_instr_as_load_const(instr), state);
 526       break;
 527
 528    case nir_instr_type_phi:
 529       validate_phi_instr(nir_instr_as_phi(instr), state);
 530       break;
 531
 532    case nir_instr_type_ssa_undef:
 533       validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr), state);
 534       break;
 535
 536    case nir_instr_type_jump:
 537       break;
 538
 539    default:
 540       assert(!"Invalid ALU instruction type");
 541       break;
 542    }
 543
 544    state->instr = NULL;
 545 }
 546
 547 static void
 548 validate_phi_src(nir_phi_instr *instr, nir_block *pred, validate_state *state)
 549 {
 550    state->instr = &instr->instr;
 551
 552    assert(instr->dest.is_ssa);
 553
 554    exec_list_validate(&instr->srcs);
 555    nir_foreach_phi_src(instr, src) {
 556       if (src->pred == pred) {
 557          assert(src->src.is_ssa);
 558          assert(src->src.ssa->num_components ==
 559                 instr->dest.ssa.num_components);
 560
 561          validate_src(&src->src, state);
 562          state->instr = NULL;
 563          return;
 564       }
 565    }
 566
 567    abort();
 568 }
 569
 570 static void
 571 validate_phi_srcs(nir_block *block, nir_block *succ, validate_state *state)
 572 {
 573    nir_foreach_instr(succ, instr) {
 574       if (instr->type != nir_instr_type_phi)
 575          break;
 576
 577       validate_phi_src(nir_instr_as_phi(instr), block, state);
 578    }
 579 }
 580
 581 static void validate_cf_node(nir_cf_node *node, validate_state *state);
 582
 583 static void
 584 validate_block(nir_block *block, validate_state *state)
 585 {
 586    assert(block->cf_node.parent == state->parent_node);
 587
 588    state->block = block;
 589
 590    exec_list_validate(&block->instr_list);
 591    nir_foreach_instr(block, instr) {
 592       if (instr->type == nir_instr_type_phi) {
 593          assert(instr == nir_block_first_instr(block) ||
 594                 nir_instr_prev(instr)->type == nir_instr_type_phi);
 595       }
 596
 597       if (instr->type == nir_instr_type_jump) {
 598          assert(instr == nir_block_last_instr(block));
 599       }
 600
 601       validate_instr(instr, state);
 602    }
 603
 604    assert(block->successors[0] != NULL);
 605    assert(block->successors[0] != block->successors[1]);
 606
 607    for (unsigned i = 0; i < 2; i++) {
 608       if (block->successors[i] != NULL) {
 609          struct set_entry *entry =
 610             _mesa_set_search(block->successors[i]->predecessors, block);
 611          assert(entry);
 612
 613          validate_phi_srcs(block, block->successors[i], state);
 614       }
 615    }
 616
 617    struct set_entry *entry;
 618    set_foreach(block->predecessors, entry) {
 619       const nir_block *pred = entry->key;
 620       assert(pred->successors[0] == block ||
 621              pred->successors[1] == block);
 622    }
 623
 624    if (!exec_list_is_empty(&block->instr_list) &&
 625        nir_block_last_instr(block)->type == nir_instr_type_jump) {
 626       assert(block->successors[1] == NULL);
 627       nir_jump_instr *jump = nir_instr_as_jump(nir_block_last_instr(block));
 628       switch (jump->type) {
 629       case nir_jump_break: {
 630          nir_block *after =
 631             nir_cf_node_as_block(nir_cf_node_next(&state->loop->cf_node));
 632          assert(block->successors[0] == after);
 633          break;
 634       }
 635
 636       case nir_jump_continue: {
 637          nir_block *first =
 638             nir_cf_node_as_block(nir_loop_first_cf_node(state->loop));
 639          assert(block->successors[0] == first);
 640          break;
 641       }
 642
 643       case nir_jump_return:
 644          assert(block->successors[0] == state->impl->end_block);
 645          break;
 646
 647       default:
 648          unreachable("bad jump type");
 649       }
 650    } else {
 651       nir_cf_node *next = nir_cf_node_next(&block->cf_node);
 652       if (next == NULL) {
 653          switch (state->parent_node->type) {
 654          case nir_cf_node_loop: {
 655             nir_block *first =
 656                nir_cf_node_as_block(nir_loop_first_cf_node(state->loop));
 657             assert(block->successors[0] == first);
 658             /* due to the hack for infinite loops, block->successors[1] may
 659              * point to the block after the loop.
 660              */
 661             break;
 662          }
 663
 664          case nir_cf_node_if: {
 665             nir_block *after =
 666                nir_cf_node_as_block(nir_cf_node_next(state->parent_node));
 667             assert(block->successors[0] == after);
 668             assert(block->successors[1] == NULL);
 669             break;
 670          }
 671
 672          case nir_cf_node_function:
 673             assert(block->successors[0] == state->impl->end_block);
 674             assert(block->successors[1] == NULL);
 675             break;
 676
 677          default:
 678             unreachable("unknown control flow node type");
 679          }
 680       } else {
 681          if (next->type == nir_cf_node_if) {
 682             nir_if *if_stmt = nir_cf_node_as_if(next);
 683             assert(&block->successors[0]->cf_node ==
 684                    nir_if_first_then_node(if_stmt));
 685             assert(&block->successors[1]->cf_node ==
 686                    nir_if_first_else_node(if_stmt));
 687          } else {
 688             assert(next->type == nir_cf_node_loop);
 689             nir_loop *loop = nir_cf_node_as_loop(next);
 690             assert(&block->successors[0]->cf_node ==
 691                    nir_loop_first_cf_node(loop));
 692             assert(block->successors[1] == NULL);
 693          }
 694       }
 695    }
 696 }
 697
 698 static void
 699 validate_if(nir_if *if_stmt, validate_state *state)
 700 {
 701    state->if_stmt = if_stmt;
 702
 703    assert(!exec_node_is_head_sentinel(if_stmt->cf_node.node.prev));
 704    nir_cf_node *prev_node = nir_cf_node_prev(&if_stmt->cf_node);
 705    assert(prev_node->type == nir_cf_node_block);
 706
 707    assert(!exec_node_is_tail_sentinel(if_stmt->cf_node.node.next));
 708    nir_cf_node *next_node = nir_cf_node_next(&if_stmt->cf_node);
 709    assert(next_node->type == nir_cf_node_block);
 710
 711    validate_src(&if_stmt->condition, state);
 712
 713    assert(!exec_list_is_empty(&if_stmt->then_list));
 714    assert(!exec_list_is_empty(&if_stmt->else_list));
 715
 716    nir_cf_node *old_parent = state->parent_node;
 717    state->parent_node = &if_stmt->cf_node;
 718
 719    exec_list_validate(&if_stmt->then_list);
 720    foreach_list_typed(nir_cf_node, cf_node, node, &if_stmt->then_list) {
 721       validate_cf_node(cf_node, state);
 722    }
 723
 724    exec_list_validate(&if_stmt->else_list);
 725    foreach_list_typed(nir_cf_node, cf_node, node, &if_stmt->else_list) {
 726       validate_cf_node(cf_node, state);
 727    }
 728
 729    state->parent_node = old_parent;
 730    state->if_stmt = NULL;
 731 }
 732
 733 static void
 734 validate_loop(nir_loop *loop, validate_state *state)
 735 {
 736    assert(!exec_node_is_head_sentinel(loop->cf_node.node.prev));
 737    nir_cf_node *prev_node = nir_cf_node_prev(&loop->cf_node);
 738    assert(prev_node->type == nir_cf_node_block);
 739
 740    assert(!exec_node_is_tail_sentinel(loop->cf_node.node.next));
 741    nir_cf_node *next_node = nir_cf_node_next(&loop->cf_node);
 742    assert(next_node->type == nir_cf_node_block);
 743
 744    assert(!exec_list_is_empty(&loop->body));
 745
 746    nir_cf_node *old_parent = state->parent_node;
 747    state->parent_node = &loop->cf_node;
 748    nir_loop *old_loop = state->loop;
 749    state->loop = loop;
 750
 751    exec_list_validate(&loop->body);
 752    foreach_list_typed(nir_cf_node, cf_node, node, &loop->body) {
 753       validate_cf_node(cf_node, state);
 754    }
 755
 756    state->parent_node = old_parent;
 757    state->loop = old_loop;
 758 }
 759
 760 static void
 761 validate_cf_node(nir_cf_node *node, validate_state *state)
 762 {
 763    assert(node->parent == state->parent_node);
 764
 765    switch (node->type) {
 766    case nir_cf_node_block:
 767       validate_block(nir_cf_node_as_block(node), state);
 768       break;
 769
 770    case nir_cf_node_if:
 771       validate_if(nir_cf_node_as_if(node), state);
 772       break;
 773
 774    case nir_cf_node_loop:
 775       validate_loop(nir_cf_node_as_loop(node), state);
 776       break;
 777
 778    default:
 779       unreachable("Invalid CF node type");
 780    }
 781 }
 782
 783 static void
 784 prevalidate_reg_decl(nir_register *reg, bool is_global, validate_state *state)
 785 {
 786    assert(reg->is_global == is_global);
 787
 788    if (is_global)
 789       assert(reg->index < state->shader->reg_alloc);
 790    else
 791       assert(reg->index < state->impl->reg_alloc);
 792    assert(!BITSET_TEST(state->regs_found, reg->index));
 793    BITSET_SET(state->regs_found, reg->index);
 794
 795    list_validate(&reg->uses);
 796    list_validate(&reg->defs);
 797    list_validate(&reg->if_uses);
 798
 799    reg_validate_state *reg_state = ralloc(state->regs, reg_validate_state);
 800    reg_state->uses = _mesa_set_create(reg_state, _mesa_hash_pointer,
 801                                       _mesa_key_pointer_equal);
 802    reg_state->if_uses = _mesa_set_create(reg_state, _mesa_hash_pointer,
 803                                          _mesa_key_pointer_equal);
 804    reg_state->defs = _mesa_set_create(reg_state, _mesa_hash_pointer,
 805                                       _mesa_key_pointer_equal);
 806
 807    reg_state->where_defined = is_global ? NULL : state->impl;
 808
 809    _mesa_hash_table_insert(state->regs, reg, reg_state);
 810 }
 811
 812 static void
 813 postvalidate_reg_decl(nir_register *reg, validate_state *state)
 814 {
 815    struct hash_entry *entry = _mesa_hash_table_search(state->regs, reg);
 816
 817    reg_validate_state *reg_state = (reg_validate_state *) entry->data;
 818
 819    nir_foreach_use(reg, src) {
 820       struct set_entry *entry = _mesa_set_search(reg_state->uses, src);
 821       assert(entry);
 822       _mesa_set_remove(reg_state->uses, entry);
 823    }
 824
 825    if (reg_state->uses->entries != 0) {
 826       printf("extra entries in register uses:\n");
 827       struct set_entry *entry;
 828       set_foreach(reg_state->uses, entry)
 829          printf("%p\n", entry->key);
 830
 831       abort();
 832    }
 833
 834    nir_foreach_if_use(reg, src) {
 835       struct set_entry *entry = _mesa_set_search(reg_state->if_uses, src);
 836       assert(entry);
 837       _mesa_set_remove(reg_state->if_uses, entry);
 838    }
 839
 840    if (reg_state->if_uses->entries != 0) {
 841       printf("extra entries in register if_uses:\n");
 842       struct set_entry *entry;
 843       set_foreach(reg_state->if_uses, entry)
 844          printf("%p\n", entry->key);
 845
 846       abort();
 847    }
 848
 849    nir_foreach_def(reg, src) {
 850       struct set_entry *entry = _mesa_set_search(reg_state->defs, src);
 851       assert(entry);
 852       _mesa_set_remove(reg_state->defs, entry);
 853    }
 854
 855    if (reg_state->defs->entries != 0) {
 856       printf("extra entries in register defs:\n");
 857       struct set_entry *entry;
 858       set_foreach(reg_state->defs, entry)
 859          printf("%p\n", entry->key);
 860
 861       abort();
 862    }
 863 }
 864
 865 static void
 866 validate_var_decl(nir_variable *var, bool is_global, validate_state *state)
 867 {
 868    assert(is_global != (var->data.mode == nir_var_local));
 869
 870    /*
 871     * TODO validate some things ir_validate.cpp does (requires more GLSL type
 872     * support)
 873     */
 874
 875    if (!is_global) {
 876       _mesa_hash_table_insert(state->var_defs, var, state->impl);
 877    }
 878 }
 879
 880 static bool
 881 postvalidate_ssa_def(nir_ssa_def *def, void *void_state)
 882 {
 883    validate_state *state = void_state;
 884
 885    struct hash_entry *entry = _mesa_hash_table_search(state->ssa_defs, def);
 886    ssa_def_validate_state *def_state = (ssa_def_validate_state *)entry->data;
 887
 888    nir_foreach_use(def, src) {
 889       struct set_entry *entry = _mesa_set_search(def_state->uses, src);
 890       assert(entry);
 891       _mesa_set_remove(def_state->uses, entry);
 892    }
 893
 894    if (def_state->uses->entries != 0) {
 895       printf("extra entries in register uses:\n");
 896       struct set_entry *entry;
 897       set_foreach(def_state->uses, entry)
 898          printf("%p\n", entry->key);
 899
 900       abort();
 901    }
 902
 903    nir_foreach_if_use(def, src) {
 904       struct set_entry *entry = _mesa_set_search(def_state->if_uses, src);
 905       assert(entry);
 906       _mesa_set_remove(def_state->if_uses, entry);
 907    }
 908
 909    if (def_state->if_uses->entries != 0) {
 910       printf("extra entries in register uses:\n");
 911       struct set_entry *entry;
 912       set_foreach(def_state->if_uses, entry)
 913          printf("%p\n", entry->key);
 914
 915       abort();
 916    }
 917
 918    return true;
 919 }
 920
 921 static bool
 922 postvalidate_ssa_defs_block(nir_block *block, void *state)
 923 {
 924    nir_foreach_instr(block, instr)
 925       nir_foreach_ssa_def(instr, postvalidate_ssa_def, state);
 926
 927    return true;
 928 }
 929
 930 static void
 931 validate_function_impl(nir_function_impl *impl, validate_state *state)
 932 {
 933    assert(impl->overload->impl == impl);
 934    assert(impl->cf_node.parent == NULL);
 935
 936    assert(impl->num_params == impl->overload->num_params);
 937    for (unsigned i = 0; i < impl->num_params; i++)
 938       assert(impl->params[i]->type == impl->overload->params[i].type);
 939
 940    if (glsl_type_is_void(impl->overload->return_type))
 941       assert(impl->return_var == NULL);
 942    else
 943       assert(impl->return_var->type == impl->overload->return_type);
 944
 945    assert(exec_list_is_empty(&impl->end_block->instr_list));
 946    assert(impl->end_block->successors[0] == NULL);
 947    assert(impl->end_block->successors[1] == NULL);
 948
 949    state->impl = impl;
 950    state->parent_node = &impl->cf_node;
 951
 952    exec_list_validate(&impl->locals);
 953    nir_foreach_variable(var, &impl->locals) {
 954       validate_var_decl(var, false, state);
 955    }
 956
 957    state->regs_found = realloc(state->regs_found,
 958                                BITSET_WORDS(impl->reg_alloc) *
 959                                sizeof(BITSET_WORD));
 960    memset(state->regs_found, 0, BITSET_WORDS(impl->reg_alloc) *
 961                                 sizeof(BITSET_WORD));
 962    exec_list_validate(&impl->registers);
 963    foreach_list_typed(nir_register, reg, node, &impl->registers) {
 964       prevalidate_reg_decl(reg, false, state);
 965    }
 966
 967    state->ssa_defs_found = realloc(state->ssa_defs_found,
 968                                    BITSET_WORDS(impl->ssa_alloc) *
 969                                    sizeof(BITSET_WORD));
 970    memset(state->ssa_defs_found, 0, BITSET_WORDS(impl->ssa_alloc) *
 971                                     sizeof(BITSET_WORD));
 972    exec_list_validate(&impl->body);
 973    foreach_list_typed(nir_cf_node, node, node, &impl->body) {
 974       validate_cf_node(node, state);
 975    }
 976
 977    foreach_list_typed(nir_register, reg, node, &impl->registers) {
 978       postvalidate_reg_decl(reg, state);
 979    }
 980
 981    nir_foreach_block(impl, postvalidate_ssa_defs_block, state);
 982 }
 983
 984 static void
 985 validate_function_overload(nir_function_overload *overload,
 986                            validate_state *state)
 987 {
 988    if (overload->impl != NULL)
 989       validate_function_impl(overload->impl, state);
 990 }
 991
 992 static void
 993 validate_function(nir_function *func, validate_state *state)
 994 {
 995    exec_list_validate(&func->overload_list);
 996    foreach_list_typed(nir_function_overload, overload, node, &func->overload_list) {
 997       assert(overload->function == func);
 998       validate_function_overload(overload, state);
 999    }
1000 }
1001
1002 static void
1003 init_validate_state(validate_state *state)
1004 {
1005    state->regs = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1006                                          _mesa_key_pointer_equal);
1007    state->ssa_defs = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1008                                              _mesa_key_pointer_equal);
1009    state->ssa_defs_found = NULL;
1010    state->regs_found = NULL;
1011    state->var_defs = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1012                                              _mesa_key_pointer_equal);
1013    state->loop = NULL;
1014 }
1015
1016 static void
1017 destroy_validate_state(validate_state *state)
1018 {
1019    _mesa_hash_table_destroy(state->regs, NULL);
1020    _mesa_hash_table_destroy(state->ssa_defs, NULL);
1021    free(state->ssa_defs_found);
1022    free(state->regs_found);
1023    _mesa_hash_table_destroy(state->var_defs, NULL);
1024 }
1025
1026 void
1027 nir_validate_shader(nir_shader *shader)
1028 {
1029    validate_state state;
1030    init_validate_state(&state);
1031
1032    state.shader = shader;
1033
1034    exec_list_validate(&shader->uniforms);
1035    nir_foreach_variable(var, &shader->uniforms) {
1036       validate_var_decl(var, true, &state);
1037    }
1038
1039    exec_list_validate(&shader->inputs);
1040    nir_foreach_variable(var, &shader->inputs) {
1041      validate_var_decl(var, true, &state);
1042    }
1043
1044    exec_list_validate(&shader->outputs);
1045    nir_foreach_variable(var, &shader->outputs) {
1046      validate_var_decl(var, true, &state);
1047    }
1048
1049    exec_list_validate(&shader->globals);
1050    nir_foreach_variable(var, &shader->globals) {
1051      validate_var_decl(var, true, &state);
1052    }
1053
1054    exec_list_validate(&shader->system_values);
1055    nir_foreach_variable(var, &shader->system_values) {
1056      validate_var_decl(var, true, &state);
1057    }
1058
1059    state.regs_found = realloc(state.regs_found,
1060                               BITSET_WORDS(shader->reg_alloc) *
1061                               sizeof(BITSET_WORD));
1062    memset(state.regs_found, 0, BITSET_WORDS(shader->reg_alloc) *
1063                                sizeof(BITSET_WORD));
1064    exec_list_validate(&shader->registers);
1065    foreach_list_typed(nir_register, reg, node, &shader->registers) {
1066       prevalidate_reg_decl(reg, true, &state);
1067    }
1068
1069    exec_list_validate(&shader->functions);
1070    foreach_list_typed(nir_function, func, node, &shader->functions) {
1071       validate_function(func, &state);
1072    }
1073
1074    foreach_list_typed(nir_register, reg, node, &shader->registers) {
1075       postvalidate_reg_decl(reg, &state);
1076    }
1077
1078    destroy_validate_state(&state);
1079 }
1080
1081 #endif /* NDEBUG */