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
  74    static void validate_ir(ir_instruction *ir, void *data);
  75
  76    ir_function *current_function;
  77
  78    struct hash_table *ht;
  79 };
  80
  81
  82 ir_visitor_status
  83 ir_validate::visit(ir_dereference_variable *ir)
  84 {
  85    if ((ir->var == NULL) || (ir->var->as_variable() == NULL)) {
  86       printf("ir_dereference_variable @ %p does not specify a variable %p\n",
  87              (void *) ir, (void *) ir->var);
  88       abort();
  89    }
  90
  91    if (hash_table_find(ht, ir->var) == NULL) {
  92       printf("ir_dereference_variable @ %p specifies undeclared variable "
  93              "`%s' @ %p\n",
  94              (void *) ir, ir->var->name, (void *) ir->var);
  95       abort();
  96    }
  97
  98    this->validate_ir(ir, this->data);
  99
 100    return visit_continue;
 101 }
 102
 103 ir_visitor_status
 104 ir_validate::visit(ir_if *ir)
 105 {
 106    if (ir->condition->type != glsl_type::bool_type) {
 107       printf("ir_if condition %s type instead of bool.\n",
 108              ir->condition->type->name);
 109       ir->print();
 110       printf("\n");
 111       abort();
 112    }
 113
 114    return visit_continue;
 115 }
 116
 117
 118 ir_visitor_status
 119 ir_validate::visit_leave(ir_loop *ir)
 120 {
 121    if (ir->counter != NULL) {
 122       if ((ir->from == NULL) || (ir->from == NULL) || (ir->increment == NULL)) {
 123          printf("ir_loop has invalid loop controls:\n"
 124                 "    counter:   %p\n"
 125                 "    from:      %p\n"
 126                 "    to:        %p\n"
 127                 "    increment: %p\n",
 128                 (void *) ir->counter, (void *) ir->from, (void *) ir->to,
 129                 (void *) ir->increment);
 130          abort();
 131       }
 132
 133       if ((ir->cmp < ir_binop_less) || (ir->cmp > ir_binop_nequal)) {
 134          printf("ir_loop has invalid comparitor %d\n", ir->cmp);
 135          abort();
 136       }
 137    } else {
 138       if ((ir->from != NULL) || (ir->from != NULL) || (ir->increment != NULL)) {
 139          printf("ir_loop has invalid loop controls:\n"
 140                 "    counter:   %p\n"
 141                 "    from:      %p\n"
 142                 "    to:        %p\n"
 143                 "    increment: %p\n",
 144                 (void *) ir->counter, (void *) ir->from, (void *) ir->to,
 145                 (void *) ir->increment);
 146          abort();
 147       }
 148    }
 149
 150    return visit_continue;
 151 }
 152
 153
 154 ir_visitor_status
 155 ir_validate::visit_enter(ir_function *ir)
 156 {
 157    /* Function definitions cannot be nested.
 158     */
 159    if (this->current_function != NULL) {
 160       printf("Function definition nested inside another function "
 161              "definition:\n");
 162       printf("%s %p inside %s %p\n",
 163              ir->name, (void *) ir,
 164              this->current_function->name, (void *) this->current_function);
 165       abort();
 166    }
 167
 168    /* Store the current function hierarchy being traversed.  This is used
 169     * by the function signature visitor to ensure that the signatures are
 170     * linked with the correct functions.
 171     */
 172    this->current_function = ir;
 173
 174    this->validate_ir(ir, this->data);
 175
 176    return visit_continue;
 177 }
 178
 179 ir_visitor_status
 180 ir_validate::visit_leave(ir_function *ir)
 181 {
 182    assert(talloc_parent(ir->name) == ir);
 183
 184    this->current_function = NULL;
 185    return visit_continue;
 186 }
 187
 188 ir_visitor_status
 189 ir_validate::visit_enter(ir_function_signature *ir)
 190 {
 191    if (this->current_function != ir->function()) {
 192       printf("Function signature nested inside wrong function "
 193              "definition:\n");
 194       printf("%p inside %s %p instead of %s %p\n",
 195              (void *) ir,
 196              this->current_function->name, (void *) this->current_function,
 197              ir->function_name(), (void *) ir->function());
 198       abort();
 199    }
 200
 201    this->validate_ir(ir, this->data);
 202
 203    return visit_continue;
 204 }
 205
 206 ir_visitor_status
 207 ir_validate::visit_leave(ir_expression *ir)
 208 {
 209    switch (ir->operation) {
 210    case ir_unop_bit_not:
 211       assert(ir->operands[0]->type == ir->type);
 212       break;
 213    case ir_unop_logic_not:
 214       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 215       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 216       break;
 217
 218    case ir_unop_neg:
 219    case ir_unop_abs:
 220    case ir_unop_sign:
 221    case ir_unop_rcp:
 222    case ir_unop_rsq:
 223    case ir_unop_sqrt:
 224       assert(ir->type == ir->operands[0]->type);
 225       break;
 226
 227    case ir_unop_exp:
 228    case ir_unop_log:
 229    case ir_unop_exp2:
 230    case ir_unop_log2:
 231       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 232       assert(ir->type == ir->operands[0]->type);
 233       break;
 234
 235    case ir_unop_f2i:
 236       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 237       assert(ir->type->base_type == GLSL_TYPE_INT);
 238       break;
 239    case ir_unop_i2f:
 240       assert(ir->operands[0]->type->base_type == GLSL_TYPE_INT);
 241       assert(ir->type->base_type == GLSL_TYPE_FLOAT);
 242       break;
 243    case ir_unop_f2b:
 244       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 245       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 246       break;
 247    case ir_unop_b2f:
 248       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 249       assert(ir->type->base_type == GLSL_TYPE_FLOAT);
 250       break;
 251    case ir_unop_i2b:
 252       assert(ir->operands[0]->type->base_type == GLSL_TYPE_INT);
 253       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 254       break;
 255    case ir_unop_b2i:
 256       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 257       assert(ir->type->base_type == GLSL_TYPE_INT);
 258       break;
 259    case ir_unop_u2f:
 260       assert(ir->operands[0]->type->base_type == GLSL_TYPE_UINT);
 261       assert(ir->type->base_type == GLSL_TYPE_FLOAT);
 262       break;
 263
 264    case ir_unop_any:
 265       assert(ir->operands[0]->type->base_type == GLSL_TYPE_BOOL);
 266       assert(ir->type == glsl_type::bool_type);
 267       break;
 268
 269    case ir_unop_trunc:
 270    case ir_unop_ceil:
 271    case ir_unop_floor:
 272    case ir_unop_fract:
 273    case ir_unop_sin:
 274    case ir_unop_cos:
 275    case ir_unop_dFdx:
 276    case ir_unop_dFdy:
 277       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 278       assert(ir->operands[0]->type == ir->type);
 279       break;
 280
 281    case ir_unop_noise:
 282       /* XXX what can we assert here? */
 283       break;
 284
 285    case ir_binop_add:
 286    case ir_binop_sub:
 287    case ir_binop_mul:
 288    case ir_binop_div:
 289    case ir_binop_mod:
 290    case ir_binop_min:
 291    case ir_binop_max:
 292    case ir_binop_pow:
 293       if (ir->operands[0]->type->is_scalar())
 294          assert(ir->operands[1]->type == ir->type);
 295       else if (ir->operands[1]->type->is_scalar())
 296          assert(ir->operands[0]->type == ir->type);
 297       else if (ir->operands[0]->type->is_vector() &&
 298                ir->operands[1]->type->is_vector()) {
 299          assert(ir->operands[0]->type == ir->operands[1]->type);
 300          assert(ir->operands[0]->type == ir->type);
 301       }
 302       break;
 303
 304    case ir_binop_less:
 305    case ir_binop_greater:
 306    case ir_binop_lequal:
 307    case ir_binop_gequal:
 308    case ir_binop_equal:
 309    case ir_binop_nequal:
 310       /* The semantics of the IR operators differ from the GLSL <, >, <=, >=,
 311        * ==, and != operators.  The IR operators perform a component-wise
 312        * comparison on scalar or vector types and return a boolean scalar or
 313        * vector type of the same size.
 314        */
 315       assert(ir->type->base_type == GLSL_TYPE_BOOL);
 316       assert(ir->operands[0]->type == ir->operands[1]->type);
 317       assert(ir->operands[0]->type->is_vector()
 318              || ir->operands[0]->type->is_scalar());
 319       assert(ir->operands[0]->type->vector_elements
 320              == ir->type->vector_elements);
 321       break;
 322
 323    case ir_binop_all_equal:
 324    case ir_binop_any_nequal:
 325       /* GLSL == and != operate on scalars, vectors, matrices and arrays, and
 326        * return a scalar boolean.  The IR matches that.
 327        */
 328       assert(ir->type == glsl_type::bool_type);
 329       assert(ir->operands[0]->type == ir->operands[1]->type);
 330       break;
 331
 332    case ir_binop_lshift:
 333    case ir_binop_rshift:
 334    case ir_binop_bit_and:
 335    case ir_binop_bit_xor:
 336    case ir_binop_bit_or:
 337       assert(ir->operands[0]->type == ir->operands[1]->type);
 338       assert(ir->type == ir->operands[0]->type);
 339       assert(ir->type->base_type == GLSL_TYPE_INT ||
 340              ir->type->base_type == GLSL_TYPE_UINT);
 341       break;
 342
 343    case ir_binop_logic_and:
 344    case ir_binop_logic_xor:
 345    case ir_binop_logic_or:
 346       assert(ir->type == glsl_type::bool_type);
 347       assert(ir->operands[0]->type == glsl_type::bool_type);
 348       assert(ir->operands[1]->type == glsl_type::bool_type);
 349       break;
 350
 351    case ir_binop_dot:
 352       assert(ir->type == glsl_type::float_type);
 353       assert(ir->operands[0]->type->base_type == GLSL_TYPE_FLOAT);
 354       assert(ir->operands[0]->type->is_vector());
 355       assert(ir->operands[0]->type == ir->operands[1]->type);
 356       break;
 357
 358    case ir_binop_cross:
 359       assert(ir->operands[0]->type == glsl_type::vec3_type);
 360       assert(ir->operands[1]->type == glsl_type::vec3_type);
 361       assert(ir->type == glsl_type::vec3_type);
 362       break;
 363    }
 364
 365    return visit_continue;
 366 }
 367
 368 ir_visitor_status
 369 ir_validate::visit_leave(ir_swizzle *ir)
 370 {
 371    int chans[4] = {ir->mask.x, ir->mask.y, ir->mask.z, ir->mask.w};
 372
 373    for (unsigned int i = 0; i < ir->type->vector_elements; i++) {
 374       if (chans[i] >= ir->val->type->vector_elements) {
 375          printf("ir_swizzle @ %p specifies a channel not present "
 376                 "in the value.\n", (void *) ir);
 377          ir->print();
 378          abort();
 379       }
 380    }
 381
 382    return visit_continue;
 383 }
 384
 385 ir_visitor_status
 386 ir_validate::visit(ir_variable *ir)
 387 {
 388    /* An ir_variable is the one thing that can (and will) appear multiple times
 389     * in an IR tree.  It is added to the hashtable so that it can be used
 390     * in the ir_dereference_variable handler to ensure that a variable is
 391     * declared before it is dereferenced.
 392     */
 393    if (ir->name)
 394       assert(talloc_parent(ir->name) == ir);
 395
 396    hash_table_insert(ht, ir, ir);
 397    return visit_continue;
 398 }
 399
 400 ir_visitor_status
 401 ir_validate::visit_enter(ir_assignment *ir)
 402 {
 403    const ir_dereference *const lhs = ir->lhs;
 404    if (lhs->type->is_scalar() || lhs->type->is_vector()) {
 405       if (ir->write_mask == 0) {
 406          printf("Assignment LHS is %s, but write mask is 0:\n",
 407                 lhs->type->is_scalar() ? "scalar" : "vector");
 408          ir->print();
 409          abort();
 410       }
 411
 412       int lhs_components = 0;
 413       for (int i = 0; i < 4; i++) {
 414          if (ir->write_mask & (1 << i))
 415             lhs_components++;
 416       }
 417
 418       if (lhs_components != ir->rhs->type->vector_elements) {
 419          printf("Assignment count of LHS write mask channels enabled not\n"
 420                 "matching RHS vector size (%d LHS, %d RHS).\n",
 421                 lhs_components, ir->rhs->type->vector_elements);
 422          ir->print();
 423          abort();
 424       }
 425    }
 426
 427    this->validate_ir(ir, this->data);
 428
 429    return visit_continue;
 430 }
 431
 432 void
 433 ir_validate::validate_ir(ir_instruction *ir, void *data)
 434 {
 435    struct hash_table *ht = (struct hash_table *) data;
 436
 437    if (hash_table_find(ht, ir)) {
 438       printf("Instruction node present twice in ir tree:\n");
 439       ir->print();
 440       printf("\n");
 441       abort();
 442    }
 443    hash_table_insert(ht, ir, ir);
 444 }
 445
 446 void
 447 check_node_type(ir_instruction *ir, void *data)
 448 {
 449    (void) data;
 450
 451    if (ir->ir_type <= ir_type_unset || ir->ir_type >= ir_type_max) {
 452       printf("Instruction node with unset type\n");
 453       ir->print(); printf("\n");
 454    }
 455    assert(ir->type != glsl_type::error_type);
 456 }
 457
 458 void
 459 validate_ir_tree(exec_list *instructions)
 460 {
 461    ir_validate v;
 462
 463    v.run(instructions);
 464
 465    foreach_iter(exec_list_iterator, iter, *instructions) {
 466       ir_instruction *ir = (ir_instruction *)iter.get();
 467
 468       visit_tree(ir, check_node_type, NULL);
 469    }
 470 }