src/glsl/ir_validate.cpp

   1 /*
   2  * Copyright © 2010 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
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 /**
  25  * \file ir_validate.cpp
  26  *
  27  * Attempts to verify that various invariants of the IR tree are true.
  28  *
  29  * In particular, at the moment it makes sure that no single
  30  * ir_instruction node except for ir_variable appears multiple times
  31  * in the ir tree.  ir_variable does appear multiple times: Once as a
  32  * declaration in an exec_list, and multiple times as the endpoint of
  33  * a dereference chain.
  34  */
  35
  36 #include <inttypes.h>
  37 #include "ir.h"
  38 #include "ir_hierarchical_visitor.h"
  39 #include "program/hash_table.h"
  40 #include "glsl_types.h"
  41
  42 class ir_validate : public ir_hierarchical_visitor {
  43 public:
  44    ir_validate()
  45    {
  46       this->ht = hash_table_ctor(0, hash_table_pointer_hash,
  47                                  hash_table_pointer_compare);
  48
  49       this->current_function = NULL;
  50
  51       this->callback = ir_validate::validate_ir;
  52       this->data = ht;
  53    }
  54
  55    ~ir_validate()
  56    {
  57       hash_table_dtor(this->ht);
  58    }
  59
  60    virtual ir_visitor_status visit(ir_variable *v);
  61    virtual ir_visitor_status visit(ir_dereference_variable *ir);
  62    virtual ir_visitor_status visit(ir_if *ir);
  63
  64    virtual ir_visitor_status visit_leave(ir_loop *ir);
  65    virtual ir_visitor_status visit_enter(ir_function *ir);
  66    virtual ir_visitor_status visit_leave(ir_function *ir);
  67    virtual ir_visitor_status visit_enter(ir_function_signature *ir);
  68
  69    virtual ir_visitor_status visit_leave(ir_expression *ir);
  70    virtual ir_visitor_status visit_leave(ir_swizzle *ir);
  71
  72    virtual ir_visitor_status visit_enter(ir_assignment *ir);
  73    virtual ir_visitor_status visit_enter(ir_call *ir);
  74
  75    static void validate_ir(ir_instruction *ir, void *data);
  76
  77    ir_function *current_function;
  78
  79    struct hash_table *ht;
  80 };
  81
  82
  83 ir_visitor_status
  84 ir_validate::visit(ir_dereference_variable *ir)
  85 {
  86    if ((ir->var == NULL) || (ir->var->as_variable() == NULL)) {
  87       printf("ir_dereference_variable @ %p does not specify a variable %p\n",
  88              (void *) ir, (void *) ir->var);
  89       abort();
  90    }
  91
  92    if (hash_table_find(ht, ir->var) == NULL) {
  93       printf("ir_dereference_variable @ %p specifies undeclared variable "
  94              "`%s' @ %p\n",
  95              (void *) ir, ir->var->name, (void *) ir->var);
  96       abort();
  97    }
  98
  99    this->validate_ir(ir, this->data);
 100
 101    return visit_continue;
 102 }
 103
 104 ir_visitor_status
 105 ir_validate::visit(ir_if *ir)
 106 {
 107    if (ir->condition->type != glsl_type::bool_type) {
 108       printf("ir_if condition %s type instead of bool.\n",
 109              ir->condition->type->name);
 110       ir->print();
 111       printf("\n");
 112       abort();
 113    }
 114
 115    return visit_continue;
 116 }
 117
 118
 119 ir_visitor_status
 120 ir_validate::visit_leave(ir_loop *ir)
 121 {
 122    if (ir->counter != NULL) {
 123       if ((ir->from == NULL) || (ir->from == NULL) || (ir->increment == NULL)) {
 124          printf("ir_loop has invalid loop controls:\n"
 125                 "    counter:   %p\n"
 126                 "    from:      %p\n"
 127                 "    to:        %p\n"
 128                 "    increment: %p\n",
 129                 (void *) ir->counter, (void *) ir->from, (void *) ir->to,
 130                 (void *) ir->increment);
 131          abort();
 132       }
 133
 134       if ((ir->cmp < ir_binop_less) || (ir->cmp > ir_binop_nequal)) {
 135          printf("ir_loop has invalid comparitor %d\n", ir->cmp);
 136          abort();
 137       }
 138    } else {
 139       if ((ir->from != NULL) || (ir->from != NULL) || (ir->increment != NULL)) {
 140          printf("ir_loop has invalid loop controls:\n"
 141                 "    counter:   %p\n"
 142                 "    from:      %p\n"
 143                 "    to:        %p\n"
 144                 "    increment: %p\n",
 145                 (void *) ir->counter, (void *) ir->from, (void *) ir->to,
 146                 (void *) ir->increment);
 147          abort();
 148       }
 149    }
 150
 151    return visit_continue;
 152 }
 153
 154
 155 ir_visitor_status
 156 ir_validate::visit_enter(ir_function *ir)
 157 {
 158    /* Function definitions cannot be nested.
 159     */
 160    if (this->current_function != NULL) {
 161       printf("Function definition nested inside another function "
 162              "definition:\n");
 163       printf("%s %p inside %s %p\n",
 164              ir->name, (void *) ir,
 165              this->current_function->name, (void *) this->current_function);
 166       abort();
 167    }
 168
 169    /* Store the current function hierarchy being traversed.  This is used
 170     * by the function signature visitor to ensure that the signatures are
 171     * linked with the correct functions.
 172     */
 173    this->current_function = ir;
 174
 175    this->validate_ir(ir, this->data);
 176
 177    /* Verify that all of the things stored in the list of signatures are,
 178     * in fact, function signatures.
 179     */
 180    foreach_list(node, &ir->signatures) {
 181       ir_instruction *sig = (ir_instruction *) node;
 182
 183       if (sig->ir_type != ir_type_function_signature) {
 184          printf("Non-signature in signature list of function `%s'\n",
 185                 ir->name);
 186          abort();
 187       }
 188    }
 189
 190    return visit_continue;
 191 }
 192
 193 ir_visitor_status
 194 ir_validate::visit_leave(ir_function *ir)
 195 {
 196    assert(ralloc_parent(ir->name) == ir);
 197
 198    this->current_function = NULL;
 199    return visit_continue;
 200 }
 201
 202 ir_visitor_status
 203 ir_validate::visit_enter(ir_function_signature *ir)
 204 {
 205    if (this->current_function != ir->function()) {
 206       printf("Function signature nested inside wrong function "
 207              "definition:\n");
 208       printf("%p inside %s %p instead of %s %p\n",
 209              (void *) ir,
 210              this->current_function->name, (void *) this->current_function,
 211              ir->function_name(), (void *) ir->function());
 212       abort();
 213    }
 214
 215    if (ir->return_type == NULL) {
 216       printf("Function signature %p for function %s has NULL return type.\n",
 217              (void *) ir, ir->function_name());
 218       abort();
 219    }
 220
 221    this->validate_ir(ir, this->data);
 222
 223    return visit_continue;
 224 }
 225
 226 ir_visitor_status
 227 ir_validate::visit_leave(ir_expression *ir)
 228 {
 229    switch (ir->operation) {
 230    case ir_unop_bit_not:
 231       assert(ir->operands[0]->type == ir->type);
 232       break;
 233    case ir_unop_logic_not:
 234       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 235       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 236       break;
 237
 238    case ir_unop_neg:
 239    case ir_unop_abs:
 240    case ir_unop_sign:
 241    case ir_unop_rcp:
 242    case ir_unop_rsq:
 243    case ir_unop_sqrt:
 244       assert(ir->type == ir->operands[0]->type);
 245       break;
 246
 247    case ir_unop_exp:
 248    case ir_unop_log:
 249    case ir_unop_exp2:
 250    case ir_unop_log2:
 251       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 252       assert(ir->type == ir->operands[0]->type);
 253       break;
 254
 255    case ir_unop_f2i:
 256       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 257       assert(ir->type->base_type == GLSL_TYPE_INT);
 258       break;
 259    case ir_unop_i2f:
 260       assert(ir->operands[0]->type->base_type == GLSL_TYPE_INT);
 261       assert(ir->type->base_type == GLSL_TYPE_FLOAT);
 262       break;
 263    case ir_unop_f2b:
 264       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 265       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 266       break;
 267    case ir_unop_b2f:
 268       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 269       assert(ir->type->base_type == GLSL_TYPE_FLOAT);
 270       break;
 271    case ir_unop_i2b:
 272       assert(ir->operands[0]->type->base_type == GLSL_TYPE_INT);
 273       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 274       break;
 275    case ir_unop_b2i:
 276       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 277       assert(ir->type->base_type == GLSL_TYPE_INT);
 278       break;
 279    case ir_unop_u2f:
 280       assert(ir->operands[0]->type->base_type == GLSL_TYPE_UINT);
 281       assert(ir->type->base_type == GLSL_TYPE_FLOAT);
 282       break;
 283    case ir_unop_i2u:
 284       assert(ir->operands[0]->type->base_type == GLSL_TYPE_INT);
 285       assert(ir->type->base_type == GLSL_TYPE_UINT);
 286       break;
 287    case ir_unop_u2i:
 288       assert(ir->operands[0]->type->base_type == GLSL_TYPE_UINT);
 289       assert(ir->type->base_type == GLSL_TYPE_INT);
 290       break;
 291
 292    case ir_unop_any:
 293       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 294       assert(ir->type == glsl_type::bool_type);
 295       break;
 296
 297    case ir_unop_trunc:
 298    case ir_unop_round_even:
 299    case ir_unop_ceil:
 300    case ir_unop_floor:
 301    case ir_unop_fract:
 302    case ir_unop_sin:
 303    case ir_unop_cos:
 304    case ir_unop_sin_reduced:
 305    case ir_unop_cos_reduced:
 306    case ir_unop_dFdx:
 307    case ir_unop_dFdy:
 308       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 309       assert(ir->operands[0]->type == ir->type);
 310       break;
 311
 312    case ir_unop_noise:
 313       /* XXX what can we assert here? */
 314       break;
 315
 316    case ir_binop_add:
 317    case ir_binop_sub:
 318    case ir_binop_mul:
 319    case ir_binop_div:
 320    case ir_binop_mod:
 321    case ir_binop_min:
 322    case ir_binop_max:
 323    case ir_binop_pow:
 324       if (ir->operands[0]->type->is_scalar())
 325          assert(ir->operands[1]->type == ir->type);
 326       else if (ir->operands[1]->type->is_scalar())
 327          assert(ir->operands[0]->type == ir->type);
 328       else if (ir->operands[0]->type->is_vector() &&
 329                ir->operands[1]->type->is_vector()) {
 330          assert(ir->operands[0]->type == ir->operands[1]->type);
 331          assert(ir->operands[0]->type == ir->type);
 332       }
 333       break;
 334
 335    case ir_binop_less:
 336    case ir_binop_greater:
 337    case ir_binop_lequal:
 338    case ir_binop_gequal:
 339    case ir_binop_equal:
 340    case ir_binop_nequal:
 341       /* The semantics of the IR operators differ from the GLSL <, >, <=, >=,
 342        * ==, and != operators.  The IR operators perform a component-wise
 343        * comparison on scalar or vector types and return a boolean scalar or
 344        * vector type of the same size.
 345        */
 346       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 347       assert(ir->operands[0]->type == ir->operands[1]->type);
 348       assert(ir->operands[0]->type->is_vector()
 349              || ir->operands[0]->type->is_scalar());
 350       assert(ir->operands[0]->type->vector_elements
 351              == ir->type->vector_elements);
 352       break;
 353
 354    case ir_binop_all_equal:
 355    case ir_binop_any_nequal:
 356       /* GLSL == and != operate on scalars, vectors, matrices and arrays, and
 357        * return a scalar boolean.  The IR matches that.
 358        */
 359       assert(ir->type == glsl_type::bool_type);
 360       assert(ir->operands[0]->type == ir->operands[1]->type);
 361       break;
 362
 363    case ir_binop_lshift:
 364    case ir_binop_rshift:
 365       assert(ir->operands[0]->type->is_integer() &&
 366              ir->operands[1]->type->is_integer());
 367       if (ir->operands[0]->type->is_scalar()) {
 368           assert(ir->operands[1]->type->is_scalar());
 369       }
 370       if (ir->operands[0]->type->is_vector() &&
 371           ir->operands[1]->type->is_vector()) {
 372           assert(ir->operands[0]->type->components() ==
 373                  ir->operands[1]->type->components());
 374       }
 375       assert(ir->type == ir->operands[0]->type);
 376       break;
 377
 378    case ir_binop_bit_and:
 379    case ir_binop_bit_xor:
 380    case ir_binop_bit_or:
 381        assert(ir->operands[0]->type->base_type ==
 382               ir->operands[1]->type->base_type);
 383        assert(ir->type->is_integer());
 384        if (ir->operands[0]->type->is_vector() &&
 385            ir->operands[1]->type->is_vector()) {
 386            assert(ir->operands[0]->type->vector_elements ==
 387                   ir->operands[1]->type->vector_elements);
 388        }
 389        break;
 390
 391    case ir_binop_logic_and:
 392    case ir_binop_logic_xor:
 393    case ir_binop_logic_or:
 394       assert(ir->type == glsl_type::bool_type);
 395       assert(ir->operands[0]->type == glsl_type::bool_type);
 396       assert(ir->operands[1]->type == glsl_type::bool_type);
 397       break;
 398
 399    case ir_binop_dot:
 400       assert(ir->type == glsl_type::float_type);
 401       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 402       assert(ir->operands[0]->type->is_vector());
 403       assert(ir->operands[0]->type == ir->operands[1]->type);
 404       break;
 405
 406    case ir_quadop_vector:
 407       /* The vector operator collects some number of scalars and generates a
 408        * vector from them.
 409        *
 410        *  - All of the operands must be scalar.
 411        *  - Number of operands must matche the size of the resulting vector.
 412        *  - Base type of the operands must match the base type of the result.
 413        */
 414       assert(ir->type->is_vector());
 415       switch (ir->type->vector_elements) {
 416       case 2:
 417          assert(ir->operands[0]->type->is_scalar());
 418          assert(ir->operands[0]->type->base_type == ir->type->base_type);
 419          assert(ir->operands[1]->type->is_scalar());
 420          assert(ir->operands[1]->type->base_type == ir->type->base_type);
 421          assert(ir->operands[2] == NULL);
 422          assert(ir->operands[3] == NULL);
 423          break;
 424       case 3:
 425          assert(ir->operands[0]->type->is_scalar());
 426          assert(ir->operands[0]->type->base_type == ir->type->base_type);
 427          assert(ir->operands[1]->type->is_scalar());
 428          assert(ir->operands[1]->type->base_type == ir->type->base_type);
 429          assert(ir->operands[2]->type->is_scalar());
 430          assert(ir->operands[2]->type->base_type == ir->type->base_type);
 431          assert(ir->operands[3] == NULL);
 432          break;
 433       case 4:
 434          assert(ir->operands[0]->type->is_scalar());
 435          assert(ir->operands[0]->type->base_type == ir->type->base_type);
 436          assert(ir->operands[1]->type->is_scalar());
 437          assert(ir->operands[1]->type->base_type == ir->type->base_type);
 438          assert(ir->operands[2]->type->is_scalar());
 439          assert(ir->operands[2]->type->base_type == ir->type->base_type);
 440          assert(ir->operands[3]->type->is_scalar());
 441          assert(ir->operands[3]->type->base_type == ir->type->base_type);
 442          break;
 443       default:
 444          /* The is_vector assertion above should prevent execution from ever
 445           * getting here.
 446           */
 447          assert(!"Should not get here.");
 448          break;
 449       }
 450    }
 451
 452    return visit_continue;
 453 }
 454
 455 ir_visitor_status
 456 ir_validate::visit_leave(ir_swizzle *ir)
 457 {
 458    int chans[4] = {ir->mask.x, ir->mask.y, ir->mask.z, ir->mask.w};
 459
 460    for (unsigned int i = 0; i < ir->type->vector_elements; i++) {
 461       if (chans[i] >= ir->val->type->vector_elements) {
 462          printf("ir_swizzle @ %p specifies a channel not present "
 463                 "in the value.\n", (void *) ir);
 464          ir->print();
 465          abort();
 466       }
 467    }
 468
 469    return visit_continue;
 470 }
 471
 472 ir_visitor_status
 473 ir_validate::visit(ir_variable *ir)
 474 {
 475    /* An ir_variable is the one thing that can (and will) appear multiple times
 476     * in an IR tree.  It is added to the hashtable so that it can be used
 477     * in the ir_dereference_variable handler to ensure that a variable is
 478     * declared before it is dereferenced.
 479     */
 480    if (ir->name)
 481       assert(ralloc_parent(ir->name) == ir);
 482
 483    hash_table_insert(ht, ir, ir);
 484
 485
 486    /* If a variable is an array, verify that the maximum array index is in
 487     * bounds.  There was once an error in AST-to-HIR conversion that set this
 488     * to be out of bounds.
 489     */
 490    if (ir->type->array_size() > 0) {
 491       if (ir->max_array_access >= ir->type->length) {
 492          printf("ir_variable has maximum access out of bounds (%d vs %d)\n",
 493                 ir->max_array_access, ir->type->length - 1);
 494          ir->print();
 495          abort();
 496       }
 497    }
 498
 499    return visit_continue;
 500 }
 501
 502 ir_visitor_status
 503 ir_validate::visit_enter(ir_assignment *ir)
 504 {
 505    const ir_dereference *const lhs = ir->lhs;
 506    if (lhs->type->is_scalar() || lhs->type->is_vector()) {
 507       if (ir->write_mask == 0) {
 508          printf("Assignment LHS is %s, but write mask is 0:\n",
 509                 lhs->type->is_scalar() ? "scalar" : "vector");
 510          ir->print();
 511          abort();
 512       }
 513
 514       int lhs_components = 0;
 515       for (int i = 0; i < 4; i++) {
 516          if (ir->write_mask & (1 << i))
 517             lhs_components++;
 518       }
 519
 520       if (lhs_components != ir->rhs->type->vector_elements) {
 521          printf("Assignment count of LHS write mask channels enabled not\n"
 522                 "matching RHS vector size (%d LHS, %d RHS).\n",
 523                 lhs_components, ir->rhs->type->vector_elements);
 524          ir->print();
 525          abort();
 526       }
 527    }
 528
 529    this->validate_ir(ir, this->data);
 530
 531    return visit_continue;
 532 }
 533
 534 ir_visitor_status
 535 ir_validate::visit_enter(ir_call *ir)
 536 {
 537    ir_function_signature *const callee = ir->get_callee();
 538
 539    if (callee->ir_type != ir_type_function_signature) {
 540       printf("IR called by ir_call is not ir_function_signature!\n");
 541       abort();
 542    }
 543
 544    return visit_continue;
 545 }
 546
 547 void
 548 ir_validate::validate_ir(ir_instruction *ir, void *data)
 549 {
 550    struct hash_table *ht = (struct hash_table *) data;
 551
 552    if (hash_table_find(ht, ir)) {
 553       printf("Instruction node present twice in ir tree:\n");
 554       ir->print();
 555       printf("\n");
 556       abort();
 557    }
 558    hash_table_insert(ht, ir, ir);
 559 }
 560
 561 void
 562 check_node_type(ir_instruction *ir, void *data)
 563 {
 564    (void) data;
 565
 566    if (ir->ir_type <= ir_type_unset || ir->ir_type >= ir_type_max) {
 567       printf("Instruction node with unset type\n");
 568       ir->print(); printf("\n");
 569    }
 570    assert(ir->type != glsl_type::error_type);
 571 }
 572
 573 void
 574 validate_ir_tree(exec_list *instructions)
 575 {
 576    ir_validate v;
 577
 578    v.run(instructions);
 579
 580    foreach_iter(exec_list_iterator, iter, *instructions) {
 581       ir_instruction *ir = (ir_instruction *)iter.get();
 582
 583       visit_tree(ir, check_node_type, NULL);
 584    }
 585 }