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 Generic hooks for various libFirm functions.
23 * @author Michael Beck
25 #ifndef FIRM_IR_IRHOOKS_H
26 #define FIRM_IR_IRHOOKS_H
34 * options for the hook_merge_nodes hook
37 HOOK_OPT_DEAD_BLOCK, /**< a block was removed because it's dead */
38 HOOK_OPT_STG, /**< straightening optimization */
39 HOOK_OPT_IFSIM, /**< if simplification */
40 HOOK_OPT_CONST_EVAL, /**< constant evaluation */
41 HOOK_OPT_ALGSIM, /**< algebraic simplification */
42 HOOK_OPT_PHI, /**< Phi optimization */
43 HOOK_OPT_SYNC, /**< Sync optimization */
44 HOOK_OPT_WAW, /**< Write-After-Write optimization */
45 HOOK_OPT_WAR, /**< Write-After-Read optimization */
46 HOOK_OPT_RAW, /**< Read-After-Write optimization */
47 HOOK_OPT_RAR, /**< Read-After-Read optimization */
48 HOOK_OPT_RC, /**< Read-a-Const optimization */
49 HOOK_OPT_TUPLE, /**< Tuple optimization */
50 HOOK_OPT_ID, /**< ID optimization */
51 HOOK_OPT_CSE, /**< common subexpression elimination */
52 HOOK_OPT_STRENGTH_RED,/**< strength reduction */
53 HOOK_OPT_ARCH_DEP, /**< architecture dependent optimization */
54 HOOK_OPT_REASSOC, /**< reassociation */
55 HOOK_OPT_POLY_CALL, /**< polymorphic call optimization */
56 HOOK_OPT_IF_CONV, /**< an if conversion was tried */
57 HOOK_OPT_FUNC_CALL, /**< a real function call was removed */
58 HOOK_OPT_CONFIRM, /**< a value was substituted by another due to a Confirm */
59 HOOK_OPT_CONFIRM_C, /**< a value was substituted by a const due to a Confirm */
60 HOOK_OPT_CONFIRM_E, /**< a value was evaluated due to a Confirm */
61 HOOK_OPT_EXC_REM, /**< a exception edge was removed due to a Confirmation prove */
62 HOOK_OPT_NORMALIZE, /**< a commutative node was normalized */
63 HOOK_LOWERED, /**< lowered */
64 HOOK_BACKEND, /**< a backend transformation */
68 /** Result of an if-conversion attempt */
69 typedef enum if_result_t {
70 IF_RESULT_SUCCESS = 0, /**< if conversion could be done */
71 IF_RESULT_SIDE_EFFECT = 1, /**< if conversion failed because of side effect */
72 IF_RESULT_SIDE_EFFECT_PHI = 2, /**< if conversion failed because of Phi node found */
73 IF_RESULT_TOO_DEEP = 3, /**< if conversion failed because of to deep DAG's */
74 IF_RESULT_BAD_CF = 4, /**< if conversion failed because of bad control flow */
75 IF_RESULT_DENIED = 5, /**< if conversion failed because of architecture deny */
80 * A generic function type.
82 typedef void (generic_func)(void);
87 typedef struct hook_entry {
88 /** A union of all possible hook types. */
90 /** This hook is called, after a new ir_op was created. */
91 void (*_hook_new_ir_op)(void *context, ir_op *op);
93 /** This hook is called, before am ir_op is destroyed. */
94 void (*_hook_free_ir_op)(void *context, ir_op *op);
96 /** This hook is called, after a new IR-node was created and before it is optimized. */
97 void (*_hook_new_node)(void *context, ir_graph *graph, ir_node *node);
99 /** This hook is called, before a node input was changed. */
100 void (*_hook_set_irn_n)(void *context, ir_node *src,
101 int pos, ir_node *tgt, ir_node *old_tgt);
103 /** This hook is called, before a node is replaced (exchange()) by another. */
104 void (*_hook_replace)(void *context, ir_node *old_node, ir_node *new_node);
106 /** This hook is called, before a node is changed into an Id node. */
107 void (*_hook_turn_into_id)(void *context, ir_node *node);
109 /** This hook is called, after a commutative node was normalized. */
110 void (*_hook_normalize)(void *context, ir_node *node);
112 /** This hook is called, after a new graph was created and before the first block
113 * on this graph is build. */
114 void (*_hook_new_graph)(void *context, ir_graph *irg, ir_entity *ent);
116 /** This hook is called before a graph is freed. */
117 void (*_hook_free_graph)(void *context, ir_graph *irg);
119 /** This hook is called before an irg walk is started. */
120 void (*_hook_irg_walk)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);
122 /** This hook is called before an block wise irg walk is started. */
123 void (*_hook_irg_walk_blkwise)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);
125 /** This hook is called before an block walk is started. */
126 void (*_hook_irg_block_walk)(void *context, ir_graph *irg, ir_node *node, generic_func *pre, generic_func *post);
128 /** This hook is called, when debug info must be merged. */
129 void (*_hook_merge_nodes)(void *context, ir_node **new_node_array, int new_num_entries,
130 ir_node **old_node_array, int old_num_entries, hook_opt_kind opt);
132 /** This hook is called, when reassociation is started/stopped. */
133 void (*_hook_reassociate)(void *context, int start);
135 /** This hook is called, before a node is lowered. */
136 void (*_hook_lower)(void *context, ir_node *node);
138 /** This hook is called, before a graph is inlined. */
139 void (*_hook_inline)(void *context, ir_node *call, ir_graph *irg);
141 /** This hook is called, before tail recursion is applied to a graph. */
142 void (*_hook_tail_rec)(void *context, ir_graph *irg, int n_calls);
144 /** This hook is called, before a node is replaced due to strength reduction */
145 void (*_hook_strength_red)(void *context, ir_graph *irg, ir_node *node);
147 /** This hook is called, when dead node elimination is started/stopped. */
148 void (*_hook_dead_node_elim)(void *context, ir_graph *irg, int start);
150 /** This hook is called, when a node is substituted during dead node elimination. */
151 void (*_hook_dead_node_elim_subst)(void *context, ir_graph *irg, ir_node *old, ir_node *nw);
153 /** This hook is called after if conversion has run. */
154 void (*_hook_if_conversion)(void *context, ir_graph *irg, ir_node *phi, int pos, ir_node *mux, if_result_t reason);
156 /** This hook is called after a call was detected as const call */
157 void (*_hook_func_call)(void *context, ir_graph *irg, ir_node *call);
159 /** This hook is called after a Mul was replaced by a series of Shift and Add/Sub operations. */
160 void (*_hook_arch_dep_replace_mul_with_shifts)(void *context, ir_node *irn);
162 /** This hook is called after a Div/Mod by a constant value was replaced. */
163 void (*_hook_arch_dep_replace_division_by_const)(void *context, ir_node *irn);
165 /** This hook is called after a new mode was registered. */
166 void (*_hook_new_mode)(void *context, ir_mode *mode);
168 /** This hook is called after a new entity was created. */
169 void (*_hook_new_entity)(void *context, ir_entity *ent);
171 /** This hook is called after a new type was created. */
172 void (*_hook_new_type)(void *context, ir_type *tp);
174 /** This hook is called at the end of the node info dumper to dump additional node info. */
175 void (*_hook_node_info)(void *context, FILE *f, const ir_node *n);
178 /** the context for every hook */
181 /** needed for chaining */
182 struct hook_entry *next;
189 hook_new_ir_op, /**< type for hook_new_ir_op() hook */
190 hook_free_ir_op, /**< type for hook_free_ir_op() hook */
191 hook_new_node, /**< type for hook_new_node() hook */
192 hook_set_irn_n, /**< type for hook_set_irn_n() hook */
193 hook_replace, /**< type for hook_replace() hook */
194 hook_turn_into_id, /**< type for hook_turn_into_id() hook */
195 hook_normalize, /**< type for hook_normalize() hook */
196 hook_new_graph, /**< type for hook_new_graph() hook */
197 hook_free_graph, /**< type for hook_free_graph() hook */
198 hook_irg_walk, /**< type for hook_irg_walk() hook */
199 hook_irg_walk_blkwise, /**< type for hook_irg_walk_blkwise() hook */
200 hook_irg_block_walk, /**< type for hook_irg_block_walk() hook */
201 hook_merge_nodes, /**< type for hook_merge_nodes() hook */
202 hook_reassociate, /**< type for hook_reassociate() hook */
203 hook_lower, /**< type for hook_lower() hook */
204 hook_inline, /**< type for hook_inline() hook */
205 hook_tail_rec, /**< type for hook_tail_rec() hook */
206 hook_strength_red, /**< type for hook_strength_red() hook */
207 hook_dead_node_elim, /**< type for hook_dead_node_elim() hook */
208 hook_dead_node_elim_subst, /**< type for hook_dead_node_elim_subst() hook */
209 hook_if_conversion, /**< type for hook_if_conversion() hook */
210 hook_func_call, /**< type for hook_func_call() hook */
211 /** type for hook_arch_dep_replace_mul_with_shifts() hook */
212 hook_arch_dep_replace_mul_with_shifts,
213 /** type for hook_arch_dep_replace_division_by_const() hook */
214 hook_arch_dep_replace_division_by_const,
215 hook_new_mode, /**< type for hook_new_mode() hook */
216 hook_new_entity, /**< type for hook_new_entity() hook */
217 hook_new_type, /**< type for hook_new_type() hook */
218 hook_node_info, /**< type for hook_node_info() hook */
219 hook_last /**< last hook type */
223 * register a hook entry.
225 * @param hook the hook type
226 * @param entry the hook entry
228 FIRM_API void register_hook(hook_type_t hook, hook_entry_t *entry);
231 * unregister a hook entry.
233 * @param hook the hook type
234 * @param entry the hook entry
236 FIRM_API void unregister_hook(hook_type_t hook, hook_entry_t *entry);
238 /** Global list of registerd hooks. */
239 FIRM_API hook_entry_t *hooks[hook_last];
242 * Executes the hook @p what with the args @p args
243 * Do not use this macro directly.
245 #define hook_exec(what, args) do { \
247 for (_p = hooks[what]; _p; _p = _p->next){ \
248 void *hook_ctx_ = _p->context; \
249 _p->hook._##what args; \
253 /** Called when a new node opcode has been created */
254 #define hook_new_ir_op(op) hook_exec(hook_new_ir_op, (hook_ctx_, op))
255 /** Called when a node opcode has been freed */
256 #define hook_free_ir_op(op) hook_exec(hook_free_ir_op, (hook_ctx_, op))
257 /** Called after a new node has been created */
258 #define hook_new_node(graph, node) hook_exec(hook_new_node, (hook_ctx_, graph, node))
259 /** Called when a nodes input is changed */
260 #define hook_set_irn_n(src, pos, tgt, old_tgt) \
261 hook_exec(hook_set_irn_n, (hook_ctx_, src, pos, tgt, old_tgt))
262 /** Called when a node is replaced */
263 #define hook_replace(old, nw) hook_exec(hook_replace, (hook_ctx_, old, nw))
264 /** Called when a node is turned into an Id node */
265 #define hook_turn_into_id(node) hook_exec(hook_turn_into_id, (hook_ctx_, node))
266 /** Called when a node is normalized */
267 #define hook_normalize(node) hook_exec(hook_normalize, (hook_ctx_, node))
268 /** Called after a new graph has been created */
269 #define hook_new_graph(irg, ent) hook_exec(hook_new_graph, (hook_ctx_, irg, ent))
270 /** Called after a graph has been freed */
271 #define hook_free_graph(irg) hook_exec(hook_free_graph, (hook_ctx_, irg))
272 /** Called before a graph walk is started */
273 #define hook_irg_walk(irg, pre, post) hook_exec(hook_irg_walk, (hook_ctx_, irg, pre, post))
274 /** Called before a blockwise graph walk is started */
275 #define hook_irg_walk_blkwise(irg, pre, post) \
276 hook_exec(hook_irg_walk_blkwise, (hook_ctx_, irg, pre, post))
277 /** Called before a block walk is started */
278 #define hook_irg_block_walk(irg, node, pre, post) \
279 hook_exec(hook_irg_block_walk, (hook_ctx_, irg, node, pre, post))
280 /** Called before 2 nodes get merged */
281 #define hook_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt) \
282 hook_exec(hook_merge_nodes, (hook_ctx_, new_node_array, new_num_entries, old_node_array, old_num_entries, opt))
283 /** Called before node inputs get reassociated */
284 #define hook_reassociate(start) hook_exec(hook_reassociate, (hook_ctx_, start))
285 /** Called before a node gets lowered */
286 #define hook_lower(node) hook_exec(hook_lower, (hook_ctx_, node))
287 /** Called before a graph is inlined */
288 #define hook_inline(call, irg) hook_exec(hook_inline, (hook_ctx_, call, irg))
289 /** Called before tail recursion is performed */
290 #define hook_tail_rec(irg, n_calls) hook_exec(hook_tail_rec, (hook_ctx_, irg, n_calls))
291 /** Called before strength reduction is performed */
292 #define hook_strength_red(irg, node) \
293 hook_exec(hook_strength_red, (hook_ctx_, irg, node))
294 /** Called before dead node elimination is performed */
295 #define hook_dead_node_elim(irg, start) hook_exec(hook_dead_node_elim, (hook_ctx_, irg, start))
296 /** Called when a node is substituted during dead code elimination */
297 #define hook_dead_node_elim_subst(irg, old, nw) \
298 hook_exec(hook_dead_node_elim_subst, (hook_ctx_, irg, old, nw))
299 /** Called when if-conversion creates a Mux node */
300 #define hook_if_conversion(irg, phi, pos, mux, reason) \
301 hook_exec(hook_if_conversion, (hook_ctx_, irg, phi, pos, mux, reason))
302 /** Called when a function call is optimized */
303 #define hook_func_call(irg, call) \
304 hook_exec(hook_func_call, (hook_ctx_, irg, call))
305 /** Called when a mul is replaced with shifts */
306 #define hook_arch_dep_replace_mul_with_shifts(irn) \
307 hook_exec(hook_arch_dep_replace_mul_with_shifts, (hook_ctx_, irn))
308 /** Called when a dvision by constant is replaced */
309 #define hook_arch_dep_replace_division_by_const(irn) \
310 hook_exec(hook_arch_dep_replace_division_by_const, (hook_ctx_, irn))
311 /** Called when a new mode has been created */
312 #define hook_new_mode(mode) hook_exec(hook_new_mode, (hook_ctx_, mode))
313 /** Called when a new entity has been created */
314 #define hook_new_entity(ent) hook_exec(hook_new_entity, (hook_ctx_, ent))
315 /** Called when a new type has been created */
316 #define hook_new_type(tp) hook_exec(hook_new_type, (hook_ctx_, tp))
317 /** Called at the end of the node info dumper to dump additional node info. */
318 #define hook_node_info(F, node) hook_exec(hook_node_info, (hook_ctx_, F, node))