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 "hash_table.h"
  40
  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
  63    virtual ir_visitor_status visit_enter(ir_function *ir);
  64    virtual ir_visitor_status visit_leave(ir_function *ir);
  65    virtual ir_visitor_status visit_enter(ir_function_signature *ir);
  66
  67    static void validate_ir(ir_instruction *ir, void *data);
  68
  69    ir_function *current_function;
  70
  71    struct hash_table *ht;
  72 };
  73
  74
  75 ir_visitor_status
  76 ir_validate::visit(ir_dereference_variable *ir)
  77 {
  78    if ((ir->var == NULL) || (ir->var->as_variable() == NULL)) {
  79       printf("ir_dereference_variable @ %p does not specify a variable %p\n",
  80              ir, ir->var);
  81       abort();
  82    }
  83
  84    if (hash_table_find(ht, ir->var) == NULL) {
  85       printf("ir_dereference_variable @ %p specifies undeclared variable "
  86              "`%s' @ %p\n",
  87              ir, ir->var->name, ir->var);
  88       abort();
  89    }
  90
  91    this->validate_ir(ir, this->data);
  92
  93    return visit_continue;
  94 }
  95
  96
  97 ir_visitor_status
  98 ir_validate::visit_enter(ir_function *ir)
  99 {
 100    /* Function definitions cannot be nested.
 101     */
 102    if (this->current_function != NULL) {
 103       printf("Function definition nested inside another function "
 104              "definition:\n");
 105       printf("%s %p inside %s %p\n",
 106              ir->name, ir,
 107              this->current_function->name, this->current_function);
 108       abort();
 109    }
 110
 111    /* Store the current function hierarchy being traversed.  This is used
 112     * by the function signature visitor to ensure that the signatures are
 113     * linked with the correct functions.
 114     */
 115    this->current_function = ir;
 116
 117    this->validate_ir(ir, this->data);
 118
 119    return visit_continue;
 120 }
 121
 122 ir_visitor_status
 123 ir_validate::visit_leave(ir_function *ir)
 124 {
 125    (void) ir;
 126
 127    this->current_function = NULL;
 128    return visit_continue;
 129 }
 130
 131 ir_visitor_status
 132 ir_validate::visit_enter(ir_function_signature *ir)
 133 {
 134    if (this->current_function != ir->function()) {
 135       printf("Function signature nested inside wrong function "
 136              "definition:\n");
 137       printf("%p inside %s %p instead of %s %p\n",
 138              ir,
 139              this->current_function->name, this->current_function,
 140              ir->function_name(), ir->function());
 141       abort();
 142    }
 143
 144    this->validate_ir(ir, this->data);
 145
 146    return visit_continue;
 147 }
 148
 149 ir_visitor_status
 150 ir_validate::visit(ir_variable *ir)
 151 {
 152    /* An ir_variable is the one thing that can (and will) appear multiple times
 153     * in an IR tree.  It is added to the hashtable so that it can be used
 154     * in the ir_dereference_variable handler to ensure that a variable is
 155     * declared before it is dereferenced.
 156     */
 157    hash_table_insert(ht, ir, ir);
 158    return visit_continue;
 159 }
 160
 161 void
 162 ir_validate::validate_ir(ir_instruction *ir, void *data)
 163 {
 164    struct hash_table *ht = (struct hash_table *) data;
 165
 166    if (hash_table_find(ht, ir)) {
 167       printf("Instruction node present twice in ir tree:\n");
 168       ir->print();
 169       printf("\n");
 170       abort();
 171    }
 172    hash_table_insert(ht, ir, ir);
 173 }
 174
 175 void
 176 check_node_type(ir_instruction *ir, void *data)
 177 {
 178    if (ir->ir_type <= ir_type_unset || ir->ir_type >= ir_type_max) {
 179       printf("Instruction node with unset type\n");
 180       ir->print(); printf("\n");
 181    }
 182 }
 183
 184 void
 185 validate_ir_tree(exec_list *instructions)
 186 {
 187    ir_validate v;
 188
 189    v.run(instructions);
 190
 191    foreach_iter(exec_list_iterator, iter, *instructions) {
 192       ir_instruction *ir = (ir_instruction *)iter.get();
 193
 194       visit_tree(ir, check_node_type, NULL);
 195    }
 196 }