3 * File name: ir/ir/irhooks.h
4 * Purpose: Generic hooks for various libFirm functions.
8 * Copyright: (C) 1998-2005 Universität Karlsruhe
9 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
15 * Generic hooks for various libFirm functions.
17 * @author Michael Beck
22 #include "firm_config.h"
28 * options for the hook_merge_nodes hook
31 HOOK_OPT_DEAD_BLOCK, /**< a block was removed because it's dead */
32 HOOK_OPT_STG, /**< straightening optimization */
33 HOOK_OPT_IFSIM, /**< if simplification */
34 HOOK_OPT_CONST_EVAL, /**< constant evaluation */
35 HOOK_OPT_ALGSIM, /**< algebraic simplification */
36 HOOK_OPT_PHI, /**< Phi optmization */
37 HOOK_OPT_WAW, /**< Write-After-Write optimization */
38 HOOK_OPT_WAR, /**< Write-After-Read optimization */
39 HOOK_OPT_RAW, /**< Read-After-Write optimization */
40 HOOK_OPT_RAR, /**< Read-After-Read optimization */
41 HOOK_OPT_RC, /**< Read-a-Const optimization */
42 HOOK_OPT_TUPLE, /**< Tuple optimization */
43 HOOK_OPT_ID, /**< ID optimization */
44 HOOK_OPT_CSE, /**< common subexpression elimination */
45 HOOK_OPT_STRENGTH_RED,/**< strength reduction */
46 HOOK_OPT_ARCH_DEP, /**< architecture dependent optimization */
47 HOOK_OPT_REASSOC, /**< reassociation */
48 HOOK_OPT_POLY_CALL, /**< polymorphic call optimization */
49 HOOK_OPT_IF_CONV, /**< an if conversion was tried */
50 HOOK_OPT_FUNC_CALL, /**< a real function call was removed */
51 HOOK_OPT_CONFIRM, /**< a value was substituted by another due to a Confirm */
52 HOOK_OPT_CONFIRM_C, /**< a value was substituted by a const due to a Confirm */
53 HOOK_OPT_CONFIRM_E, /**< a value was evaluated due to a Confirm */
54 HOOK_LOWERED, /**< lowered */
58 typedef enum _if_result_t {
59 IF_RESULT_SUCCESS = 0, /**< if conversion could be done */
60 IF_RESULT_SIDE_EFFECT = 1, /**< if conversion failed because of side effect */
61 IF_RESULT_SIDE_EFFECT_PHI = 2, /**< if conversion failed because of Phi node found */
62 IF_RESULT_TOO_DEEP = 3, /**< if conversion failed because of to deep DAG's */
63 IF_RESULT_BAD_CF = 4, /**< if conversion failed because of bad control flow */
64 IF_RESULT_DENIED = 5, /**< if conversion failed because of architecture deny */
69 * A generic function type.
71 typedef void (generic_func)(void);
76 typedef struct hook_entry {
77 /** a union of all possible hook types */
79 void (*_hook_new_ir_op)(void *context, ir_op *op);
80 void (*_hook_free_ir_op)(void *context, ir_op *op);
81 void (*_hook_new_node)(void *context, ir_graph *graph, ir_node *node);
82 void (*_hook_set_irn_n)(void *context, ir_node *src,
83 int pos, ir_node *tgt, ir_node *old_tgt);
84 void (*_hook_replaced)(void *context, ir_node *old_node, ir_node *new_node);
85 void (*_hook_turn_into_id)(void *context, ir_node *node);
86 void (*_hook_new_graph)(void *context, ir_graph *irg, entity *ent);
87 void (*_hook_free_graph)(void *context, ir_graph *irg);
88 void (*_hook_irg_walk)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);
89 void (*_hook_irg_walk_blkwise)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);
90 void (*_hook_irg_block_walk)(void *context, ir_graph *irg, ir_node *node, generic_func *pre, generic_func *post);
91 void (*_hook_merge_nodes)(void *context, ir_node **new_node_array, int new_num_entries,
92 ir_node **old_node_array, int old_num_entries, hook_opt_kind opt);
93 void (*_hook_reassociate)(void *context, int start);
94 void (*_hook_lower)(void *context, ir_node *node);
95 void (*_hook_inline)(void *context, ir_node *call, ir_graph *irg);
96 void (*_hook_tail_rec)(void *context, ir_graph *irg, int n_calls);
97 void (*_hook_strength_red)(void *context, ir_graph *irg, ir_node *strong, ir_node *cmp);
98 void (*_hook_dead_node_elim_start)(void *context, ir_graph *irg);
99 void (*_hook_dead_node_elim_stop)(void *context, ir_graph *irg);
100 void (*_hook_if_conversion)(void *context, ir_graph *irg, ir_node *phi, int pos, ir_node *mux, if_result_t reason);
101 void (*_hook_func_call)(void *context, ir_graph *irg, ir_node *call);
102 void (*_hook_arch_dep_replace_mul_with_shifts)(void *context, ir_node *irn);
103 void (*_hook_arch_dep_replace_div_by_const)(void *context, ir_node *irn);
104 void (*_hook_arch_dep_replace_mod_by_const)(void *context, ir_node *irn);
105 void (*_hook_arch_dep_replace_DivMod_by_const)(void *context, ir_node *irn);
106 void (*_hook_new_mode)(void *context, const ir_mode *tmpl, ir_mode *mode);
109 /** the context for every hook */
112 /** needed for chaining */
113 struct hook_entry *next;
129 hook_irg_walk_blkwise,
137 hook_dead_node_elim_start,
138 hook_dead_node_elim_stop,
141 hook_arch_dep_replace_mul_with_shifts,
142 hook_arch_dep_replace_div_by_const,
143 hook_arch_dep_replace_mod_by_const,
144 hook_arch_dep_replace_DivMod_by_const,
150 * register the hook entry.
152 * @param hook the hook type
153 * @param entry the hook entry
155 void register_hook(hook_type_t hook, hook_entry_t *entry);
157 #ifdef FIRM_ENABLE_HOOKS
159 extern hook_entry_t *hooks[hook_last];
162 * execute the hook what with the args args
163 * Do not use this macro directly.
165 #define hook_exec(what, args) do { \
167 for (p = hooks[what]; p; p = p->next){ \
168 void *ctx = p->context; \
169 p->hook._##what args; \
175 #define hook_exec(what, args)
177 #endif /* FIRM_ENABLE_HOOKS */
179 #define hook_new_ir_op(op) hook_exec(hook_new_ir_op, (ctx, op))
180 #define hook_free_ir_op(op) hook_exec(hook_free_ir_op, (ctx, op))
181 #define hook_new_node(graph, node) hook_exec(hook_new_node, (ctx, graph, node))
182 #define hook_set_irn_n(src, pos, tgt, old_tgt) \
183 hook_exec(hook_set_irn_n, (ctx, src, pos, tgt, old_tgt))
184 #define hook_replaced(old, nw) hook_exec(hook_replaced, (ctx, old, nw))
185 #define hook_turn_into_id(node) hook_exec(hook_turn_into_id, (ctx, node))
186 #define hook_new_graph(irg, ent) hook_exec(hook_new_graph, (ctx, irg, ent))
187 #define hook_free_graph(irg) hook_exec(hook_free_graph, (ctx, irg))
188 #define hook_irg_walk(irg, pre, post) hook_exec(hook_irg_walk, (ctx, irg, pre, post))
189 #define hook_irg_walk_blkwise(irg, pre, post) \
190 hook_exec(hook_irg_walk_blkwise, (ctx, irg, pre, post))
191 #define hook_irg_block_walk(irg, node, pre, post) \
192 hook_exec(hook_irg_block_walk, (ctx, irg, node, pre, post))
193 #define hook_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt) \
194 hook_exec(hook_merge_nodes, (ctx, new_node_array, new_num_entries, old_node_array, old_num_entries, opt))
195 #define hook_reassociate(start) hook_exec(hook_reassociate, (ctx, start))
196 #define hook_lower(node) hook_exec(hook_lower, (ctx, node))
197 #define hook_inline(call, irg) hook_exec(hook_inline, (ctx, call, irg))
198 #define hook_tail_rec(irg, n_calls) hook_exec(hook_tail_rec, (ctx, irg, n_calls))
199 #define hook_strength_red(irg, strong, cmp) \
200 hook_exec(hook_strength_red, (ctx, irg, strong, cmp))
201 #define hook_dead_node_elim_start(irg) hook_exec(hook_dead_node_elim_start, (ctx, irg))
202 #define hook_dead_node_elim_stop(irg) hook_exec(hook_dead_node_elim_stop, (ctx, irg))
203 #define hook_if_conversion(irg, phi, pos, mux, reason) \
204 hook_exec(hook_if_conversion, (ctx, irg, phi, pos, mux, reason))
205 #define hook_func_call(irg, call) \
206 hook_exec(hook_func_call, (ctx, irg, call))
207 #define hook_arch_dep_replace_mul_with_shifts(irn) \
208 hook_exec(hook_arch_dep_replace_mul_with_shifts, (ctx, irn))
209 #define hook_arch_dep_replace_div_by_const(irn) \
210 hook_exec(hook_arch_dep_replace_div_by_const, (ctx, irn))
211 #define hook_arch_dep_replace_mod_by_const(irn) \
212 hook_exec(hook_arch_dep_replace_mod_by_const, (ctx, irn))
213 #define hook_arch_dep_replace_DivMod_by_const(irn) \
214 hook_exec(hook_arch_dep_replace_DivMod_by_const, (ctx, irn))
215 #define hook_new_mode(tmpl, mode) hook_exec(hook_new_mode, (ctx, tmpl, mode))
217 /* the initializer, move to hooks_t.h some day */
218 int init_hooks(void);
220 #endif /* __IRHOOKS_H__ */