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_STG, /**< straightening optimization */
32 HOOK_OPT_IFSIM, /**< if simplification */
33 HOOK_OPT_CONST_EVAL, /**< constant evaluation */
34 HOOK_OPT_ALGSIM, /**< algebraic simplification */
35 HOOK_OPT_PHI, /**< Phi optmization */
36 HOOK_OPT_WAW, /**< Write-After-Write optimization */
37 HOOK_OPT_WAR, /**< Write-After-Read optimization */
38 HOOK_OPT_RAW, /**< Read-After-Write optimization */
39 HOOK_OPT_RAR, /**< Read-After-Read optimization */
40 HOOK_OPT_RC, /**< Read-a-Const optimization */
41 HOOK_OPT_TUPLE, /**< Tuple optimization */
42 HOOK_OPT_ID, /**< ID optimization */
43 HOOK_OPT_CSE, /**< common subexpression elimination */
44 HOOK_OPT_STRENGTH_RED,/**< strength reduction */
45 HOOK_OPT_ARCH_DEP, /**< architecture dependent optimization */
46 HOOK_OPT_REASSOC, /**< reassociation */
47 HOOK_OPT_POLY_CALL, /**< polymorphic call optimization */
48 HOOK_OPT_IF_CONV, /**< an if conversion was tried */
49 HOOK_OPT_FUNC_CALL, /**< a real function call was removed */
50 HOOK_LOWERED, /**< lowered */
54 typedef enum _if_result_t {
55 IF_RESULT_SUCCESS = 0, /**< if conversion could be done */
56 IF_RESULT_SIDE_EFFECT = 1, /**< if conversion failed because of side effect */
57 IF_RESULT_SIDE_EFFECT_PHI = 2, /**< if conversion failed because of Phi node found */
58 IF_RESULT_TOO_DEEP = 3, /**< if conversion failed because of to deep DAG's */
59 IF_RESULT_BAD_CF = 4, /**< if conversion failed because of bad control flow */
60 IF_RESULT_DENIED = 5, /**< if conversion failed because of architecture deny */
67 typedef struct hook_entry {
68 /** a union of all possible hook types */
70 void (*_hook_new_ir_op)(void *context, ir_op *op);
71 void (*_hook_free_ir_op)(void *context, ir_op *op);
72 void (*_hook_new_node)(void *context, ir_graph *graph, ir_node *node);
73 void (*_hook_set_irn_n)(void *context, ir_node *src,
74 int pos, ir_node *tgt, ir_node *old_tgt);
75 void (*_hook_replaced)(void *context, ir_node *old_node, ir_node *new_node);
76 void (*_hook_turn_into_id)(void *context, ir_node *node);
77 void (*_hook_new_graph)(void *context, ir_graph *irg, entity *ent);
78 void (*_hook_free_graph)(void *context, ir_graph *irg);
79 void (*_hook_irg_walk)(void *context, ir_graph *irg, void *pre, void *post);
80 void (*_hook_irg_walk_blkwise)(void *context, ir_graph *irg, void *pre, void *post);
81 void (*_hook_irg_block_walk)(void *context, ir_graph *irg, ir_node *node, void *pre, void *post);
82 void (*_hook_merge_nodes)(void *context, ir_node **new_node_array, int new_num_entries,
83 ir_node **old_node_array, int old_num_entries, hook_opt_kind opt);
84 void (*_hook_reassociate)(void *context, int start);
85 void (*_hook_lower)(void *context, ir_node *node);
86 void (*_hook_inline)(void *context, ir_node *call, ir_graph *irg);
87 void (*_hook_tail_rec)(void *context, ir_graph *irg, int n_calls);
88 void (*_hook_strength_red)(void *context, ir_graph *irg, ir_node *strong, ir_node *cmp);
89 void (*_hook_dead_node_elim_start)(void *context, ir_graph *irg);
90 void (*_hook_dead_node_elim_stop)(void *context, ir_graph *irg);
91 void (*_hook_if_conversion)(void *context, ir_graph *irg, ir_node *phi, int pos, ir_node *mux, if_result_t reason);
92 void (*_hook_func_call)(void *context, ir_graph *irg, ir_node *call);
93 void (*_hook_arch_dep_replace_mul_with_shifts)(void *context, ir_node *irn);
94 void (*_hook_arch_dep_replace_div_by_const)(void *context, ir_node *irn);
95 void (*_hook_arch_dep_replace_mod_by_const)(void *context, ir_node *irn);
96 void (*_hook_arch_dep_replace_DivMod_by_const)(void *context, ir_node *irn);
99 /** the context for every hook */
102 /** needed for chaining */
103 struct hook_entry *next;
119 hook_irg_walk_blkwise,
127 hook_dead_node_elim_start,
128 hook_dead_node_elim_stop,
131 hook_arch_dep_replace_mul_with_shifts,
132 hook_arch_dep_replace_div_by_const,
133 hook_arch_dep_replace_mod_by_const,
134 hook_arch_dep_replace_DivMod_by_const,
139 * register the hook entry.
141 * @param hook the hook type
142 * @rapam entry the hook entry
144 void register_hook(hook_type_t hook, hook_entry_t *entry);
146 #ifdef FIRM_ENABLE_HOOKS
148 extern hook_entry_t *hooks[hook_last];
151 * execute the hook what with the args args
152 * Do not use this macro directly.
154 #define hook_exec(what, args) do { \
156 for (p = hooks[what]; p; p = p->next){ \
157 void *ctx = p->context; \
158 p->hook._##what args; \
164 #define hook_exec(what, args)
166 #endif /* FIRM_ENABLE_HOOKS */
168 #define hook_new_ir_op(op) hook_exec(hook_new_ir_op, (ctx, op))
169 #define hook_free_ir_op(op) hook_exec(hook_free_ir_op, (ctx, op))
170 #define hook_new_node(graph, node) hook_exec(hook_new_node, (ctx, graph, node))
171 #define hook_set_irn_n(src, pos, tgt, old_tgt) \
172 hook_exec(hook_set_irn_n, (ctx, src, pos, tgt, old_tgt))
173 #define hook_replaced(old, nw) hook_exec(hook_replaced, (ctx, old, nw))
174 #define hook_turn_into_id(node) hook_exec(hook_turn_into_id, (ctx, node))
175 #define hook_new_graph(irg, ent) hook_exec(hook_new_graph, (ctx, irg, ent))
176 #define hook_free_graph(irg) hook_exec(hook_free_graph, (ctx, irg))
177 #define hook_irg_walk(irg, pre, post) hook_exec(hook_irg_walk, (ctx, irg, pre, post))
178 #define hook_irg_walk_blkwise(irg, pre, post) \
179 hook_exec(hook_irg_walk_blkwise, (ctx, irg, pre, post))
180 #define hook_irg_block_walk(irg, node, pre, post) \
181 hook_exec(hook_irg_block_walk, (ctx, irg, node, pre, post))
182 #define hook_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt) \
183 hook_exec(hook_merge_nodes, (ctx, new_node_array, new_num_entries, old_node_array, old_num_entries, opt))
184 #define hook_reassociate(start) hook_exec(hook_reassociate, (ctx, start))
185 #define hook_lower(node) hook_exec(hook_lower, (ctx, node))
186 #define hook_inline(call, irg) hook_exec(hook_inline, (ctx, call, irg))
187 #define hook_tail_rec(irg, n_calls) hook_exec(hook_tail_rec, (ctx, irg, n_calls))
188 #define hook_strength_red(irg, strong, cmp) \
189 hook_exec(hook_strength_red, (ctx, irg, strong, cmp))
190 #define hook_dead_node_elim_start(irg) hook_exec(hook_dead_node_elim_start, (ctx, irg))
191 #define hook_dead_node_elim_stop(irg) hook_exec(hook_dead_node_elim_stop, (ctx, irg))
192 #define hook_if_conversion(irg, phi, pos, mux, reason) \
193 hook_exec(hook_if_conversion, (ctx, irg, phi, pos, mux, reason))
194 #define hook_func_call(irg, call) \
195 hook_exec(hook_func_call, (ctx, irg, call))
196 #define hook_arch_dep_replace_mul_with_shifts(irn) \
197 hook_exec(hook_arch_dep_replace_mul_with_shifts, (ctx, irn))
198 #define hook_arch_dep_replace_div_by_const(irn) \
199 hook_exec(hook_arch_dep_replace_div_by_const, (ctx, irn))
200 #define hook_arch_dep_replace_mod_by_const(irn) \
201 hook_exec(hook_arch_dep_replace_mod_by_const, (ctx, irn))
202 #define hook_arch_dep_replace_DivMod_by_const(irn) \
203 hook_exec(hook_arch_dep_replace_DivMod_by_const, (ctx, irn))
205 /* the initializer, move to hooks_t.h some day */
206 int init_hooks(void);
208 #endif /* __IRHOOKS_H__ */