2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief iropt --- optimizations intertwined with IR construction -- private header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_IR_IROPT_T_H
27 #define FIRM_IR_IROPT_T_H
37 * Calculate a hash value of a node.
39 * @param node The IR-node
41 unsigned ir_node_hash(const ir_node *node);
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).
50 ir_node *equivalent_node(ir_node *n);
53 * Creates a new value table used for storing CSE identities.
54 * The value table is used to identify common expressions.
56 void new_identities(ir_graph *irg);
59 * Deletes a identities value table.
61 * @param value_table the identity set
63 void del_identities(ir_graph *irg);
66 * Add a node to the identities value table.
68 void add_identities(ir_node *node);
71 * Compare function for two nodes in the hash table. Gets two
72 * nodes as parameters. Returns 0 if the nodes are a cse.
74 int identities_cmp(const void *elt, const void *key);
77 * Return the canonical node computing the same value as n.
78 * Looks up the node in a hash table, enters it in the table
79 * if it isn't there yet.
81 ir_node *identify_remember(ir_node *n);
83 /** Visit each node in the value table of a graph. */
84 void visit_all_identities(ir_graph *irg, irg_walk_func visit, void *env);
87 * Normalize a node by putting constants (and operands with larger
88 * node index) on the right (operator side).
90 * @param n The node to normalize
92 void ir_normalize_node(ir_node *n);
94 ir_node *optimize_node(ir_node *n);
96 ir_node *optimize_in_place_2(ir_node *n);
99 * The value_of operation.
100 * This operation returns for every IR node an associated tarval if existing,
101 * returning tarval_bad otherwise.
102 * No calculations are done here, just a lookup.
104 typedef ir_tarval *(*value_of_func)(const ir_node *self);
106 extern value_of_func value_of_ptr;
109 * Set a new value_of function.
111 * @param func the function, NULL restores the default behavior
113 void set_value_of_func(value_of_func func);
116 * Returns the associated tarval of a node.
118 static inline ir_tarval *value_of(const ir_node *n)
120 return value_of_ptr(n);
124 * Sets the default operations for an ir_op_ops.
126 * @param code the opcode for the default operation
127 * @param ops the operations initialized
132 ir_op_ops *firm_set_default_operations(unsigned code, ir_op_ops *ops);
135 * Returns true if a == -b
137 bool is_negated_value(ir_node *a, ir_node *b);
141 /** NOTE: Survive DCE is considered a bad hack - don't use */
142 typedef struct survive_dce_t survive_dce_t;
145 * Make a new Survive DCE environment.
146 * NOTE: Survive DCE is considered a bad hack - don't use
148 survive_dce_t *new_survive_dce(void);
151 * Free a Survive DCE environment.
152 * NOTE: Survive DCE is considered a bad hack - don't use
154 void free_survive_dce(survive_dce_t *sd);
157 * Register a node pointer to be patched upon DCE.
158 * When DCE occurs, the node pointer specified by @p place will be
159 * patched to the new address of the node it is pointing to.
161 * @param sd The Survive DCE environment.
162 * @param place The address of the node pointer.
164 void survive_dce_register_irn(survive_dce_t *sd, ir_node **place);