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    for (unsigned i = 0; i < nir_op_infos[instr->op].num_inputs; i++) {
 294       validate_alu_src(instr, i, state);
 295    }
 296
 297    validate_alu_dest(&instr->dest, state);
 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    unsigned num_vars = nir_intrinsic_infos[instr->intrinsic].num_variables;
 379    for (unsigned i = 0; i < num_vars; i++) {
 380       validate_deref_var(instr, instr->variables[i], state);
 381    }
 382
 383    if (nir_intrinsic_infos[instr->intrinsic].has_dest) {
 384       unsigned components_written =
 385          nir_intrinsic_infos[instr->intrinsic].dest_components;
 386       if (components_written == 0)
 387          components_written = instr->num_components;
 388
 389       assert(components_written > 0);
 390
 391       if (instr->dest.is_ssa) {
 392          assert(components_written <= instr->dest.ssa.num_components);
 393       } else if (!instr->dest.reg.reg->is_packed) {
 394          assert(components_written <= instr->dest.reg.reg->num_components);
 395       }
 396
 397       validate_dest(&instr->dest, 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       break;
 409    }
 410    case nir_intrinsic_store_var: {
 411       const struct glsl_type *type =
 412          nir_deref_tail(&instr->variables[0]->deref)->type;
 413       assert(glsl_type_is_vector_or_scalar(type) ||
 414              (instr->variables[0]->var->data.mode == nir_var_uniform &&
 415               glsl_get_base_type(type) == GLSL_TYPE_SUBROUTINE));
 416       assert(instr->num_components == glsl_get_vector_elements(type));
 417       assert(instr->variables[0]->var->data.mode != nir_var_shader_in &&
 418              instr->variables[0]->var->data.mode != nir_var_uniform &&
 419              instr->variables[0]->var->data.mode != nir_var_shader_storage);
 420       break;
 421    }
 422    case nir_intrinsic_copy_var:
 423       assert(nir_deref_tail(&instr->variables[0]->deref)->type ==
 424              nir_deref_tail(&instr->variables[1]->deref)->type);
 425       assert(instr->variables[0]->var->data.mode != nir_var_shader_in &&
 426              instr->variables[0]->var->data.mode != nir_var_uniform &&
 427              instr->variables[0]->var->data.mode != nir_var_shader_storage);
 428       break;
 429    default:
 430       break;
 431    }
 432 }
 433
 434 static void
 435 validate_tex_instr(nir_tex_instr *instr, validate_state *state)
 436 {
 437    bool src_type_seen[nir_num_tex_src_types];
 438    for (unsigned i = 0; i < nir_num_tex_src_types; i++)
 439       src_type_seen[i] = false;
 440
 441    for (unsigned i = 0; i < instr->num_srcs; i++) {
 442       assert(!src_type_seen[instr->src[i].src_type]);
 443       src_type_seen[instr->src[i].src_type] = true;
 444       validate_src(&instr->src[i].src, state);
 445    }
 446
 447    if (instr->sampler != NULL)
 448       validate_deref_var(instr, instr->sampler, state);
 449
 450    validate_dest(&instr->dest, state);
 451 }
 452
 453 static void
 454 validate_call_instr(nir_call_instr *instr, validate_state *state)
 455 {
 456    if (instr->return_deref == NULL)
 457       assert(glsl_type_is_void(instr->callee->return_type));
 458    else
 459       assert(instr->return_deref->deref.type == instr->callee->return_type);
 460
 461    assert(instr->num_params == instr->callee->num_params);
 462
 463    for (unsigned i = 0; i < instr->num_params; i++) {
 464       assert(instr->callee->params[i].type == instr->params[i]->deref.type);
 465       validate_deref_var(instr, instr->params[i], state);
 466    }
 467
 468    validate_deref_var(instr, instr->return_deref, state);
 469 }
 470
 471 static void
 472 validate_load_const_instr(nir_load_const_instr *instr, validate_state *state)
 473 {
 474    validate_ssa_def(&instr->def, state);
 475 }
 476
 477 static void
 478 validate_ssa_undef_instr(nir_ssa_undef_instr *instr, validate_state *state)
 479 {
 480    validate_ssa_def(&instr->def, state);
 481 }
 482
 483 static void
 484 validate_phi_instr(nir_phi_instr *instr, validate_state *state)
 485 {
 486    /*
 487     * don't validate the sources until we get to them from their predecessor
 488     * basic blocks, to avoid validating an SSA use before its definition.
 489     */
 490
 491    validate_dest(&instr->dest, state);
 492
 493    exec_list_validate(&instr->srcs);
 494    assert(exec_list_length(&instr->srcs) ==
 495           state->block->predecessors->entries);
 496 }
 497
 498 static void
 499 validate_instr(nir_instr *instr, validate_state *state)
 500 {
 501    assert(instr->block == state->block);
 502
 503    state->instr = instr;
 504
 505    switch (instr->type) {
 506    case nir_instr_type_alu:
 507       validate_alu_instr(nir_instr_as_alu(instr), state);
 508       break;
 509
 510    case nir_instr_type_call:
 511       validate_call_instr(nir_instr_as_call(instr), state);
 512       break;
 513
 514    case nir_instr_type_intrinsic:
 515       validate_intrinsic_instr(nir_instr_as_intrinsic(instr), state);
 516       break;
 517
 518    case nir_instr_type_tex:
 519       validate_tex_instr(nir_instr_as_tex(instr), state);
 520       break;
 521
 522    case nir_instr_type_load_const:
 523       validate_load_const_instr(nir_instr_as_load_const(instr), state);
 524       break;
 525
 526    case nir_instr_type_phi:
 527       validate_phi_instr(nir_instr_as_phi(instr), state);
 528       break;
 529
 530    case nir_instr_type_ssa_undef:
 531       validate_ssa_undef_instr(nir_instr_as_ssa_undef(instr), state);
 532       break;
 533
 534    case nir_instr_type_jump:
 535       break;
 536
 537    default:
 538       assert(!"Invalid ALU instruction type");
 539       break;
 540    }
 541
 542    state->instr = NULL;
 543 }
 544
 545 static void
 546 validate_phi_src(nir_phi_instr *instr, nir_block *pred, validate_state *state)
 547 {
 548    state->instr = &instr->instr;
 549
 550    assert(instr->dest.is_ssa);
 551
 552    exec_list_validate(&instr->srcs);
 553    nir_foreach_phi_src(instr, src) {
 554       if (src->pred == pred) {
 555          assert(src->src.is_ssa);
 556          assert(src->src.ssa->num_components ==
 557                 instr->dest.ssa.num_components);
 558
 559          validate_src(&src->src, state);
 560          state->instr = NULL;
 561          return;
 562       }
 563    }
 564
 565    abort();
 566 }
 567
 568 static void
 569 validate_phi_srcs(nir_block *block, nir_block *succ, validate_state *state)
 570 {
 571    nir_foreach_instr(succ, instr) {
 572       if (instr->type != nir_instr_type_phi)
 573          break;
 574
 575       validate_phi_src(nir_instr_as_phi(instr), block, state);
 576    }
 577 }
 578
 579 static void validate_cf_node(nir_cf_node *node, validate_state *state);
 580
 581 static void
 582 validate_block(nir_block *block, validate_state *state)
 583 {
 584    assert(block->cf_node.parent == state->parent_node);
 585
 586    state->block = block;
 587
 588    exec_list_validate(&block->instr_list);
 589    nir_foreach_instr(block, instr) {
 590       if (instr->type == nir_instr_type_phi) {
 591          assert(instr == nir_block_first_instr(block) ||
 592                 nir_instr_prev(instr)->type == nir_instr_type_phi);
 593       }
 594
 595       if (instr->type == nir_instr_type_jump) {
 596          assert(instr == nir_block_last_instr(block));
 597       }
 598
 599       validate_instr(instr, state);
 600    }
 601
 602    assert(block->successors[0] != NULL);
 603    assert(block->successors[0] != block->successors[1]);
 604
 605    for (unsigned i = 0; i < 2; i++) {
 606       if (block->successors[i] != NULL) {
 607          struct set_entry *entry =
 608             _mesa_set_search(block->successors[i]->predecessors, block);
 609          assert(entry);
 610
 611          validate_phi_srcs(block, block->successors[i], state);
 612       }
 613    }
 614
 615    struct set_entry *entry;
 616    set_foreach(block->predecessors, entry) {
 617       const nir_block *pred = entry->key;
 618       assert(pred->successors[0] == block ||
 619              pred->successors[1] == block);
 620    }
 621
 622    if (!exec_list_is_empty(&block->instr_list) &&
 623        nir_block_last_instr(block)->type == nir_instr_type_jump) {
 624       assert(block->successors[1] == NULL);
 625       nir_jump_instr *jump = nir_instr_as_jump(nir_block_last_instr(block));
 626       switch (jump->type) {
 627       case nir_jump_break: {
 628          nir_block *after =
 629             nir_cf_node_as_block(nir_cf_node_next(&state->loop->cf_node));
 630          assert(block->successors[0] == after);
 631          break;
 632       }
 633
 634       case nir_jump_continue: {
 635          nir_block *first =
 636             nir_cf_node_as_block(nir_loop_first_cf_node(state->loop));
 637          assert(block->successors[0] == first);
 638          break;
 639       }
 640
 641       case nir_jump_return:
 642          assert(block->successors[0] == state->impl->end_block);
 643          break;
 644
 645       default:
 646          unreachable("bad jump type");
 647       }
 648    } else {
 649       nir_cf_node *next = nir_cf_node_next(&block->cf_node);
 650       if (next == NULL) {
 651          switch (state->parent_node->type) {
 652          case nir_cf_node_loop: {
 653             nir_block *first =
 654                nir_cf_node_as_block(nir_loop_first_cf_node(state->loop));
 655             assert(block->successors[0] == first);
 656             /* due to the hack for infinite loops, block->successors[1] may
 657              * point to the block after the loop.
 658              */
 659             break;
 660          }
 661
 662          case nir_cf_node_if: {
 663             nir_block *after =
 664                nir_cf_node_as_block(nir_cf_node_next(state->parent_node));
 665             assert(block->successors[0] == after);
 666             assert(block->successors[1] == NULL);
 667             break;
 668          }
 669
 670          case nir_cf_node_function:
 671             assert(block->successors[0] == state->impl->end_block);
 672             assert(block->successors[1] == NULL);
 673             break;
 674
 675          default:
 676             unreachable("unknown control flow node type");
 677          }
 678       } else {
 679          if (next->type == nir_cf_node_if) {
 680             nir_if *if_stmt = nir_cf_node_as_if(next);
 681             assert(&block->successors[0]->cf_node ==
 682                    nir_if_first_then_node(if_stmt));
 683             assert(&block->successors[1]->cf_node ==
 684                    nir_if_first_else_node(if_stmt));
 685          } else {
 686             assert(next->type == nir_cf_node_loop);
 687             nir_loop *loop = nir_cf_node_as_loop(next);
 688             assert(&block->successors[0]->cf_node ==
 689                    nir_loop_first_cf_node(loop));
 690             assert(block->successors[1] == NULL);
 691          }
 692       }
 693    }
 694 }
 695
 696 static void
 697 validate_if(nir_if *if_stmt, validate_state *state)
 698 {
 699    state->if_stmt = if_stmt;
 700
 701    assert(!exec_node_is_head_sentinel(if_stmt->cf_node.node.prev));
 702    nir_cf_node *prev_node = nir_cf_node_prev(&if_stmt->cf_node);
 703    assert(prev_node->type == nir_cf_node_block);
 704
 705    assert(!exec_node_is_tail_sentinel(if_stmt->cf_node.node.next));
 706    nir_cf_node *next_node = nir_cf_node_next(&if_stmt->cf_node);
 707    assert(next_node->type == nir_cf_node_block);
 708
 709    validate_src(&if_stmt->condition, state);
 710
 711    assert(!exec_list_is_empty(&if_stmt->then_list));
 712    assert(!exec_list_is_empty(&if_stmt->else_list));
 713
 714    nir_cf_node *old_parent = state->parent_node;
 715    state->parent_node = &if_stmt->cf_node;
 716
 717    exec_list_validate(&if_stmt->then_list);
 718    foreach_list_typed(nir_cf_node, cf_node, node, &if_stmt->then_list) {
 719       validate_cf_node(cf_node, state);
 720    }
 721
 722    exec_list_validate(&if_stmt->else_list);
 723    foreach_list_typed(nir_cf_node, cf_node, node, &if_stmt->else_list) {
 724       validate_cf_node(cf_node, state);
 725    }
 726
 727    state->parent_node = old_parent;
 728    state->if_stmt = NULL;
 729 }
 730
 731 static void
 732 validate_loop(nir_loop *loop, validate_state *state)
 733 {
 734    assert(!exec_node_is_head_sentinel(loop->cf_node.node.prev));
 735    nir_cf_node *prev_node = nir_cf_node_prev(&loop->cf_node);
 736    assert(prev_node->type == nir_cf_node_block);
 737
 738    assert(!exec_node_is_tail_sentinel(loop->cf_node.node.next));
 739    nir_cf_node *next_node = nir_cf_node_next(&loop->cf_node);
 740    assert(next_node->type == nir_cf_node_block);
 741
 742    assert(!exec_list_is_empty(&loop->body));
 743
 744    nir_cf_node *old_parent = state->parent_node;
 745    state->parent_node = &loop->cf_node;
 746    nir_loop *old_loop = state->loop;
 747    state->loop = loop;
 748
 749    exec_list_validate(&loop->body);
 750    foreach_list_typed(nir_cf_node, cf_node, node, &loop->body) {
 751       validate_cf_node(cf_node, state);
 752    }
 753
 754    state->parent_node = old_parent;
 755    state->loop = old_loop;
 756 }
 757
 758 static void
 759 validate_cf_node(nir_cf_node *node, validate_state *state)
 760 {
 761    assert(node->parent == state->parent_node);
 762
 763    switch (node->type) {
 764    case nir_cf_node_block:
 765       validate_block(nir_cf_node_as_block(node), state);
 766       break;
 767
 768    case nir_cf_node_if:
 769       validate_if(nir_cf_node_as_if(node), state);
 770       break;
 771
 772    case nir_cf_node_loop:
 773       validate_loop(nir_cf_node_as_loop(node), state);
 774       break;
 775
 776    default:
 777       unreachable("Invalid CF node type");
 778    }
 779 }
 780
 781 static void
 782 prevalidate_reg_decl(nir_register *reg, bool is_global, validate_state *state)
 783 {
 784    assert(reg->is_global == is_global);
 785
 786    if (is_global)
 787       assert(reg->index < state->shader->reg_alloc);
 788    else
 789       assert(reg->index < state->impl->reg_alloc);
 790    assert(!BITSET_TEST(state->regs_found, reg->index));
 791    BITSET_SET(state->regs_found, reg->index);
 792
 793    list_validate(&reg->uses);
 794    list_validate(&reg->defs);
 795    list_validate(&reg->if_uses);
 796
 797    reg_validate_state *reg_state = ralloc(state->regs, reg_validate_state);
 798    reg_state->uses = _mesa_set_create(reg_state, _mesa_hash_pointer,
 799                                       _mesa_key_pointer_equal);
 800    reg_state->if_uses = _mesa_set_create(reg_state, _mesa_hash_pointer,
 801                                          _mesa_key_pointer_equal);
 802    reg_state->defs = _mesa_set_create(reg_state, _mesa_hash_pointer,
 803                                       _mesa_key_pointer_equal);
 804
 805    reg_state->where_defined = is_global ? NULL : state->impl;
 806
 807    _mesa_hash_table_insert(state->regs, reg, reg_state);
 808 }
 809
 810 static void
 811 postvalidate_reg_decl(nir_register *reg, validate_state *state)
 812 {
 813    struct hash_entry *entry = _mesa_hash_table_search(state->regs, reg);
 814
 815    reg_validate_state *reg_state = (reg_validate_state *) entry->data;
 816
 817    nir_foreach_use(reg, src) {
 818       struct set_entry *entry = _mesa_set_search(reg_state->uses, src);
 819       assert(entry);
 820       _mesa_set_remove(reg_state->uses, entry);
 821    }
 822
 823    if (reg_state->uses->entries != 0) {
 824       printf("extra entries in register uses:\n");
 825       struct set_entry *entry;
 826       set_foreach(reg_state->uses, entry)
 827          printf("%p\n", entry->key);
 828
 829       abort();
 830    }
 831
 832    nir_foreach_if_use(reg, src) {
 833       struct set_entry *entry = _mesa_set_search(reg_state->if_uses, src);
 834       assert(entry);
 835       _mesa_set_remove(reg_state->if_uses, entry);
 836    }
 837
 838    if (reg_state->if_uses->entries != 0) {
 839       printf("extra entries in register if_uses:\n");
 840       struct set_entry *entry;
 841       set_foreach(reg_state->if_uses, entry)
 842          printf("%p\n", entry->key);
 843
 844       abort();
 845    }
 846
 847    nir_foreach_def(reg, src) {
 848       struct set_entry *entry = _mesa_set_search(reg_state->defs, src);
 849       assert(entry);
 850       _mesa_set_remove(reg_state->defs, entry);
 851    }
 852
 853    if (reg_state->defs->entries != 0) {
 854       printf("extra entries in register defs:\n");
 855       struct set_entry *entry;
 856       set_foreach(reg_state->defs, entry)
 857          printf("%p\n", entry->key);
 858
 859       abort();
 860    }
 861 }
 862
 863 static void
 864 validate_var_decl(nir_variable *var, bool is_global, validate_state *state)
 865 {
 866    assert(is_global != (var->data.mode == nir_var_local));
 867
 868    /*
 869     * TODO validate some things ir_validate.cpp does (requires more GLSL type
 870     * support)
 871     */
 872
 873    if (!is_global) {
 874       _mesa_hash_table_insert(state->var_defs, var, state->impl);
 875    }
 876 }
 877
 878 static bool
 879 postvalidate_ssa_def(nir_ssa_def *def, void *void_state)
 880 {
 881    validate_state *state = void_state;
 882
 883    struct hash_entry *entry = _mesa_hash_table_search(state->ssa_defs, def);
 884    ssa_def_validate_state *def_state = (ssa_def_validate_state *)entry->data;
 885
 886    nir_foreach_use(def, src) {
 887       struct set_entry *entry = _mesa_set_search(def_state->uses, src);
 888       assert(entry);
 889       _mesa_set_remove(def_state->uses, entry);
 890    }
 891
 892    if (def_state->uses->entries != 0) {
 893       printf("extra entries in register uses:\n");
 894       struct set_entry *entry;
 895       set_foreach(def_state->uses, entry)
 896          printf("%p\n", entry->key);
 897
 898       abort();
 899    }
 900
 901    nir_foreach_if_use(def, src) {
 902       struct set_entry *entry = _mesa_set_search(def_state->if_uses, src);
 903       assert(entry);
 904       _mesa_set_remove(def_state->if_uses, entry);
 905    }
 906
 907    if (def_state->if_uses->entries != 0) {
 908       printf("extra entries in register uses:\n");
 909       struct set_entry *entry;
 910       set_foreach(def_state->if_uses, entry)
 911          printf("%p\n", entry->key);
 912
 913       abort();
 914    }
 915
 916    return true;
 917 }
 918
 919 static bool
 920 postvalidate_ssa_defs_block(nir_block *block, void *state)
 921 {
 922    nir_foreach_instr(block, instr)
 923       nir_foreach_ssa_def(instr, postvalidate_ssa_def, state);
 924
 925    return true;
 926 }
 927
 928 static void
 929 validate_function_impl(nir_function_impl *impl, validate_state *state)
 930 {
 931    assert(impl->overload->impl == impl);
 932    assert(impl->cf_node.parent == NULL);
 933
 934    assert(impl->num_params == impl->overload->num_params);
 935    for (unsigned i = 0; i < impl->num_params; i++)
 936       assert(impl->params[i]->type == impl->overload->params[i].type);
 937
 938    if (glsl_type_is_void(impl->overload->return_type))
 939       assert(impl->return_var == NULL);
 940    else
 941       assert(impl->return_var->type == impl->overload->return_type);
 942
 943    assert(exec_list_is_empty(&impl->end_block->instr_list));
 944    assert(impl->end_block->successors[0] == NULL);
 945    assert(impl->end_block->successors[1] == NULL);
 946
 947    state->impl = impl;
 948    state->parent_node = &impl->cf_node;
 949
 950    exec_list_validate(&impl->locals);
 951    nir_foreach_variable(var, &impl->locals) {
 952       validate_var_decl(var, false, state);
 953    }
 954
 955    state->regs_found = realloc(state->regs_found,
 956                                BITSET_WORDS(impl->reg_alloc) *
 957                                sizeof(BITSET_WORD));
 958    memset(state->regs_found, 0, BITSET_WORDS(impl->reg_alloc) *
 959                                 sizeof(BITSET_WORD));
 960    exec_list_validate(&impl->registers);
 961    foreach_list_typed(nir_register, reg, node, &impl->registers) {
 962       prevalidate_reg_decl(reg, false, state);
 963    }
 964
 965    state->ssa_defs_found = realloc(state->ssa_defs_found,
 966                                    BITSET_WORDS(impl->ssa_alloc) *
 967                                    sizeof(BITSET_WORD));
 968    memset(state->ssa_defs_found, 0, BITSET_WORDS(impl->ssa_alloc) *
 969                                     sizeof(BITSET_WORD));
 970    exec_list_validate(&impl->body);
 971    foreach_list_typed(nir_cf_node, node, node, &impl->body) {
 972       validate_cf_node(node, state);
 973    }
 974
 975    foreach_list_typed(nir_register, reg, node, &impl->registers) {
 976       postvalidate_reg_decl(reg, state);
 977    }
 978
 979    nir_foreach_block(impl, postvalidate_ssa_defs_block, state);
 980 }
 981
 982 static void
 983 validate_function_overload(nir_function_overload *overload,
 984                            validate_state *state)
 985 {
 986    if (overload->impl != NULL)
 987       validate_function_impl(overload->impl, state);
 988 }
 989
 990 static void
 991 validate_function(nir_function *func, validate_state *state)
 992 {
 993    exec_list_validate(&func->overload_list);
 994    foreach_list_typed(nir_function_overload, overload, node, &func->overload_list) {
 995       assert(overload->function == func);
 996       validate_function_overload(overload, state);
 997    }
 998 }
 999
1000 static void
1001 init_validate_state(validate_state *state)
1002 {
1003    state->regs = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1004                                          _mesa_key_pointer_equal);
1005    state->ssa_defs = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1006                                              _mesa_key_pointer_equal);
1007    state->ssa_defs_found = NULL;
1008    state->regs_found = NULL;
1009    state->var_defs = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1010                                              _mesa_key_pointer_equal);
1011    state->loop = NULL;
1012 }
1013
1014 static void
1015 destroy_validate_state(validate_state *state)
1016 {
1017    _mesa_hash_table_destroy(state->regs, NULL);
1018    _mesa_hash_table_destroy(state->ssa_defs, NULL);
1019    free(state->ssa_defs_found);
1020    free(state->regs_found);
1021    _mesa_hash_table_destroy(state->var_defs, NULL);
1022 }
1023
1024 void
1025 nir_validate_shader(nir_shader *shader)
1026 {
1027    validate_state state;
1028    init_validate_state(&state);
1029
1030    state.shader = shader;
1031
1032    exec_list_validate(&shader->uniforms);
1033    nir_foreach_variable(var, &shader->uniforms) {
1034       validate_var_decl(var, true, &state);
1035    }
1036
1037    exec_list_validate(&shader->inputs);
1038    nir_foreach_variable(var, &shader->inputs) {
1039      validate_var_decl(var, true, &state);
1040    }
1041
1042    exec_list_validate(&shader->outputs);
1043    nir_foreach_variable(var, &shader->outputs) {
1044      validate_var_decl(var, true, &state);
1045    }
1046
1047    exec_list_validate(&shader->globals);
1048    nir_foreach_variable(var, &shader->globals) {
1049      validate_var_decl(var, true, &state);
1050    }
1051
1052    exec_list_validate(&shader->system_values);
1053    nir_foreach_variable(var, &shader->system_values) {
1054      validate_var_decl(var, true, &state);
1055    }
1056
1057    state.regs_found = realloc(state.regs_found,
1058                               BITSET_WORDS(shader->reg_alloc) *
1059                               sizeof(BITSET_WORD));
1060    memset(state.regs_found, 0, BITSET_WORDS(shader->reg_alloc) *
1061                                sizeof(BITSET_WORD));
1062    exec_list_validate(&shader->registers);
1063    foreach_list_typed(nir_register, reg, node, &shader->registers) {
1064       prevalidate_reg_decl(reg, true, &state);
1065    }
1066
1067    exec_list_validate(&shader->functions);
1068    foreach_list_typed(nir_function, func, node, &shader->functions) {
1069       validate_function(func, &state);
1070    }
1071
1072    foreach_list_typed(nir_register, reg, node, &shader->registers) {
1073       postvalidate_reg_decl(reg, &state);
1074    }
1075
1076    destroy_validate_state(&state);
1077 }
1078
1079 #endif /* NDEBUG */