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 extern "C" {
  40 #include "hash_table.h"
  41 }
  42
  43 static unsigned int hash_func(const void *key)
  44 {
  45    return (unsigned int)(uintptr_t)key;
  46 }
  47
  48 static int hash_compare_func(const void *key1, const void *key2)
  49 {
  50    return key1 == key2 ? 0 : 1;
  51 }
  52
  53
  54 class ir_validate : public ir_hierarchical_visitor {
  55 public:
  56    ir_validate()
  57    {
  58       this->ht = hash_table_ctor(0, hash_func, hash_compare_func);
  59
  60       this->callback = ir_validate::validate_ir;
  61       this->data = ht;
  62    }
  63
  64    ~ir_validate()
  65    {
  66       hash_table_dtor(this->ht);
  67    }
  68
  69    virtual ir_visitor_status visit(ir_variable *v);
  70
  71    static void validate_ir(ir_instruction *ir, void *data);
  72
  73    struct hash_table *ht;
  74 };
  75
  76 ir_visitor_status
  77 ir_validate::visit(ir_variable *ir)
  78 {
  79    /* An ir_variable is the one thing that can (and will) appear multiple times
  80     * in an IR tree.
  81     */
  82    (void) ir;
  83    return visit_continue;
  84 }
  85
  86 void
  87 ir_validate::validate_ir(ir_instruction *ir, void *data)
  88 {
  89    struct hash_table *ht = (struct hash_table *) data;
  90
  91    if (hash_table_find(ht, ir)) {
  92       printf("Instruction node present twice in ir tree:\n");
  93       ir->print();
  94       printf("\n");
  95       abort();
  96    }
  97    hash_table_insert(ht, ir, ir);
  98 }
  99
 100 void
 101 validate_ir_tree(exec_list *instructions)
 102 {
 103    ir_validate v;
 104
 105    v.run(instructions);
 106 }