nsz Git - libfirm/blob - ir/ir/iropt_t.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    iropt --- optimizations intertwined with IR construction -- private header.
  23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  * @version  $Id$
  25  */
  26 #ifndef FIRM_IR_IROPT_T_H
  27 #define FIRM_IR_IROPT_T_H
  28
  29 #include <stdbool.h>
  30 #include "irop_t.h"
  31 #include "iropt.h"
  32 #include "irnode_t.h"
  33 #include "pset.h"
  34 #include "tv.h"
  35
  36 /**
  37  * Calculate a hash value of a node.
  38  *
  39  * @param node  The IR-node
  40  */
  41 unsigned ir_node_hash(const ir_node *node);
  42
  43 /**
  44  * equivalent_node() returns a node equivalent to input n. It skips all nodes that
  45  * perform no actual computation, as, e.g., the Id nodes.  It does not create
  46  * new nodes.  It is therefore safe to free n if the node returned is not n.
  47  * If a node returns a Tuple we can not just skip it.  If the size of the
  48  * in array fits, we transform n into a tuple (e.g., Div).
  49  */
  50 ir_node *equivalent_node(ir_node *n);
  51
  52 /**
  53  * Creates a new value table used for storing CSE identities.
  54  * The value table is used to identify common expressions.
  55  *
  56  */
  57 pset *new_identities(void);
  58
  59 /**
  60  * Deletes a identities value table.
  61  *
  62  * @param value_table  the identity set
  63  */
  64 void del_identities(pset *value_table);
  65
  66 /**
  67  * Add a node to the identities value table.
  68  */
  69 void add_identities(pset *value_table, ir_node *node);
  70
  71 /**
  72  * Compare function for two nodes in the hash table. Gets two
  73  * nodes as parameters.  Returns 0 if the nodes are a cse.
  74  */
  75 int identities_cmp(const void *elt, const void *key);
  76
  77 /**
  78  * Return the canonical node computing the same value as n.
  79  * Looks up the node in a hash table, enters it in the table
  80  * if it isn't there yet.
  81  */
  82 ir_node *identify_remember(pset *value_table, ir_node *n);
  83
  84 /** Visit each node in the value table of a graph. */
  85 void visit_all_identities(ir_graph *irg, irg_walk_func visit, void *env);
  86
  87 /**
  88  * Normalize a node by putting constants (and operands with larger
  89  * node index) on the right (operator side).
  90  *
  91  * @param n   The node to normalize
  92  */
  93 void ir_normalize_node(ir_node *n);
  94
  95 ir_node *optimize_node(ir_node *n);
  96
  97 ir_node *optimize_in_place_2(ir_node *n);
  98
  99 /**
 100  * The value_of operation.
 101  * This operation returns for every IR node an associated tarval if existing,
 102  * returning tarval_bad otherwise.
 103  * No calculations are done here, just a lookup.
 104  */
 105 typedef tarval *(*value_of_func)(const ir_node *self);
 106
 107 extern value_of_func value_of_ptr;
 108
 109 /**
 110  * Set a new value_of function.
 111  *
 112  * @param func  the function, NULL restores the default behavior
 113  */
 114 void set_value_of_func(value_of_func func);
 115
 116 /**
 117  * Returns the associated tarval of a node.
 118  */
 119 static inline tarval *value_of(const ir_node *n)
 120 {
 121         return value_of_ptr(n);
 122 }
 123
 124 /**
 125  * Sets the default operations for an ir_op_ops.
 126  *
 127  * @param code   the opcode for the default operation
 128  * @param ops    the operations initialized
 129  *
 130  * @return
 131  *    The operations.
 132  */
 133 ir_op_ops *firm_set_default_operations(ir_opcode code, ir_op_ops *ops);
 134
 135 /**
 136  * Returns true if a == -b
 137  */
 138 bool is_negated_value(ir_node *a, ir_node *b);
 139
 140 #endif