src/glsl/opt_dead_functions.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 opt_dead_functions.cpp
  26  *
  27  * Eliminates unused functions from the linked program.
  28  */
  29
  30 #include "ir.h"
  31 #include "ir_visitor.h"
  32 #include "ir_expression_flattening.h"
  33 #include "glsl_types.h"
  34
  35 class signature_entry : public exec_node
  36 {
  37 public:
  38    signature_entry(ir_function_signature *sig)
  39    {
  40       this->signature = sig;
  41       this->used = false;
  42    }
  43
  44    ir_function_signature *signature;
  45    bool used;
  46 };
  47
  48 class ir_dead_functions_visitor : public ir_hierarchical_visitor {
  49 public:
  50    ir_dead_functions_visitor()
  51    {
  52       this->mem_ctx = ralloc_context(NULL);
  53    }
  54
  55    ~ir_dead_functions_visitor()
  56    {
  57       ralloc_free(this->mem_ctx);
  58    }
  59
  60    virtual ir_visitor_status visit_enter(ir_function_signature *);
  61    virtual ir_visitor_status visit_enter(ir_call *);
  62
  63    signature_entry *get_signature_entry(ir_function_signature *var);
  64
  65    bool (*predicate)(ir_instruction *ir);
  66
  67    /* List of signature_entry */
  68    exec_list signature_list;
  69    void *mem_ctx;
  70 };
  71
  72
  73 signature_entry *
  74 ir_dead_functions_visitor::get_signature_entry(ir_function_signature *sig)
  75 {
  76    foreach_iter(exec_list_iterator, iter, this->signature_list) {
  77       signature_entry *entry = (signature_entry *)iter.get();
  78       if (entry->signature == sig)
  79          return entry;
  80    }
  81
  82    signature_entry *entry = new(mem_ctx) signature_entry(sig);
  83    this->signature_list.push_tail(entry);
  84    return entry;
  85 }
  86
  87
  88 ir_visitor_status
  89 ir_dead_functions_visitor::visit_enter(ir_function_signature *ir)
  90 {
  91    signature_entry *entry = this->get_signature_entry(ir);
  92
  93    if (strcmp(ir->function_name(), "main") == 0) {
  94       entry->used = true;
  95    }
  96
  97
  98
  99    return visit_continue;
 100 }
 101
 102
 103 ir_visitor_status
 104 ir_dead_functions_visitor::visit_enter(ir_call *ir)
 105 {
 106    signature_entry *entry = this->get_signature_entry(ir->callee);
 107
 108    entry->used = true;
 109
 110    return visit_continue;
 111 }
 112
 113 bool
 114 do_dead_functions(exec_list *instructions)
 115 {
 116    ir_dead_functions_visitor v;
 117    bool progress = false;
 118
 119    visit_list_elements(&v, instructions);
 120
 121    /* Now that we've figured out which function signatures are used, remove
 122     * the unused ones, and remove function definitions that have no more
 123     * signatures.
 124     */
 125     foreach_iter(exec_list_iterator, iter, v.signature_list) {
 126       signature_entry *entry = (signature_entry *)iter.get();
 127
 128       if (!entry->used) {
 129          entry->signature->remove();
 130          delete entry->signature;
 131          progress = true;
 132       }
 133       delete(entry);
 134    }
 135
 136    /* We don't just do this above when we nuked a signature because of
 137     * const pointers.
 138     */
 139    foreach_iter(exec_list_iterator, iter, *instructions) {
 140       ir_instruction *ir = (ir_instruction *)iter.get();
 141       ir_function *func = ir->as_function();
 142
 143       if (func && func->signatures.is_empty()) {
 144          /* At this point (post-linking), the symbol table is no
 145           * longer in use, so not removing the function from the
 146           * symbol table should be OK.
 147           */
 148          func->remove();
 149          delete func;
 150          progress = true;
 151       }
 152    }
 153
 154    return progress;
 155 }