nsz Git - libfirm/blob - include/libfirm/irhooks.h

   1 /*
   2  * Copyright (C) 1995-2007 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   Generic hooks for various libFirm functions.
  23  * @author  Michael Beck
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_IR_IRHOOKS_H
  27 #define FIRM_IR_IRHOOKS_H
  28
  29 #include "firm_config.h"
  30 #include "irop.h"
  31 #include "irnode.h"
  32 #include "irgraph.h"
  33
  34 /**
  35  * options for the hook_merge_nodes hook
  36  */
  37 typedef enum {
  38   HOOK_OPT_DEAD_BLOCK,  /**< a block was removed because it's dead */
  39   HOOK_OPT_STG,         /**< straightening optimization */
  40   HOOK_OPT_IFSIM,       /**< if simplification */
  41   HOOK_OPT_CONST_EVAL,  /**< constant evaluation */
  42   HOOK_OPT_ALGSIM,      /**< algebraic simplification */
  43   HOOK_OPT_PHI,         /**< Phi optmization */
  44   HOOK_OPT_SYNC,        /**< Sync optmization */
  45   HOOK_OPT_WAW,         /**< Write-After-Write optimization */
  46   HOOK_OPT_WAR,         /**< Write-After-Read optimization */
  47   HOOK_OPT_RAW,         /**< Read-After-Write optimization */
  48   HOOK_OPT_RAR,         /**< Read-After-Read optimization */
  49   HOOK_OPT_RC,          /**< Read-a-Const optimization */
  50   HOOK_OPT_TUPLE,       /**< Tuple optimization */
  51   HOOK_OPT_ID,          /**< ID optimization */
  52   HOOK_OPT_CSE,         /**< common subexpression elimination */
  53   HOOK_OPT_STRENGTH_RED,/**< strength reduction */
  54   HOOK_OPT_ARCH_DEP,    /**< architecture dependent optimization */
  55   HOOK_OPT_REASSOC,     /**< reassociation */
  56   HOOK_OPT_POLY_CALL,   /**< polymorphic call optimization */
  57   HOOK_OPT_IF_CONV,     /**< an if conversion was tried */
  58   HOOK_OPT_FUNC_CALL,   /**< a real function call was removed */
  59   HOOK_OPT_CONFIRM,     /**< a value was substituted by another due to a Confirm */
  60   HOOK_OPT_CONFIRM_C,   /**< a value was substituted by a const due to a Confirm */
  61   HOOK_OPT_CONFIRM_E,   /**< a value was evaluated due to a Confirm */
  62   HOOK_OPT_EXC_REM,     /**< a exception edge was removed due to a Confirmation prove */
  63   HOOK_LOWERED,         /**< lowered */
  64   HOOK_BACKEND,         /**< a backend transformation */
  65   HOOK_OPT_LAST
  66 } hook_opt_kind;
  67
  68 typedef enum _if_result_t {
  69   IF_RESULT_SUCCESS         = 0,  /**< if conversion could be done */
  70   IF_RESULT_SIDE_EFFECT     = 1,  /**< if conversion failed because of side effect */
  71   IF_RESULT_SIDE_EFFECT_PHI = 2,  /**< if conversion failed because of Phi node found */
  72   IF_RESULT_TOO_DEEP        = 3,  /**< if conversion failed because of to deep DAG's */
  73   IF_RESULT_BAD_CF          = 4,  /**< if conversion failed because of bad control flow */
  74   IF_RESULT_DENIED          = 5,  /**< if conversion failed because of architecture deny */
  75   IF_RESULT_LAST
  76 } if_result_t;
  77
  78 /**
  79  * A generic function type.
  80  */
  81 typedef void (generic_func)(void);
  82
  83 /**
  84  * a hook entry
  85  */
  86 typedef struct hook_entry {
  87   /** A union of all possible hook types. */
  88   union {
  89     /** This hook is called, after a new ir_op was created. */
  90     void (*_hook_new_ir_op)(void *context, ir_op *op);
  91
  92     /** This hook is called, before am ir_op is destroyed. */
  93     void (*_hook_free_ir_op)(void *context, ir_op *op);
  94
  95     /** This hook is called, after a new IR-node was created and before it is optimized. */
  96     void (*_hook_new_node)(void *context, ir_graph *graph, ir_node *node);
  97
  98     /** This hook is called, before a node input was changed. */
  99     void (*_hook_set_irn_n)(void *context, ir_node *src,
 100                             int pos, ir_node *tgt, ir_node *old_tgt);
 101
 102     /** This hook is called, before a node is replaced (exchange()) by another. */
 103     void (*_hook_replace)(void *context, ir_node *old_node, ir_node *new_node);
 104
 105     /** This hook is called, before a node is changed into an Id node. */
 106     void (*_hook_turn_into_id)(void *context, ir_node *node);
 107
 108     /** This hook is called, after a new graph was created and before the first block
 109      *  on this graph is build. */
 110     void (*_hook_new_graph)(void *context, ir_graph *irg, ir_entity *ent);
 111
 112     /** This hook is called before a graph is freed. */
 113     void (*_hook_free_graph)(void *context, ir_graph *irg);
 114
 115     /** This hook is called before an irg walk is started. */
 116     void (*_hook_irg_walk)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);
 117
 118     /** This hook is called before an block wise irg walk is started. */
 119     void (*_hook_irg_walk_blkwise)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);
 120
 121     /** This hook is called before an block walk is started. */
 122     void (*_hook_irg_block_walk)(void *context, ir_graph *irg, ir_node *node, generic_func *pre, generic_func *post);
 123
 124     /** This hook is called, when debug info must be merged. */
 125     void (*_hook_merge_nodes)(void *context, ir_node **new_node_array, int new_num_entries,
 126                               ir_node **old_node_array, int old_num_entries, hook_opt_kind opt);
 127
 128     /** This hook is called, when reassociation is started/stopped. */
 129     void (*_hook_reassociate)(void *context, int start);
 130
 131     /** This hook is called, before a node is lowered. */
 132     void (*_hook_lower)(void *context, ir_node *node);
 133
 134     /** This hook is called, before a graph is inlined. */
 135     void (*_hook_inline)(void *context, ir_node *call, ir_graph *irg);
 136
 137     /** This hook is called, before tail recursion is applied to a graph. */
 138     void (*_hook_tail_rec)(void *context, ir_graph *irg, int n_calls);
 139
 140     /** This hook is called, before a node is replaced due to strength reduction */
 141     void (*_hook_strength_red)(void *context, ir_graph *irg, ir_node *node);
 142
 143     /** This hook is called, when dead node elimination is started/stopped. */
 144     void (*_hook_dead_node_elim)(void *context, ir_graph *irg, int start);
 145
 146     /** This hook is called, when a node is substituted during dead node elimination. */
 147     void (*_hook_dead_node_elim_subst)(void *context, ir_graph *irg, ir_node *old, ir_node *nw);
 148
 149     /** This hook is called after if conversion has run. */
 150     void (*_hook_if_conversion)(void *context, ir_graph *irg, ir_node *phi, int pos, ir_node *mux, if_result_t reason);
 151
 152     /** This hook is called after a call was detected as const call */
 153     void (*_hook_func_call)(void *context, ir_graph *irg, ir_node *call);
 154
 155     /** This hook is called after a Mul was replaced by a series of Shift and Add/Sub operations. */
 156     void (*_hook_arch_dep_replace_mul_with_shifts)(void *context, ir_node *irn);
 157
 158     /** This hook is called after a Div/Mod/DivMod by a constant value was replaced. */
 159     void (*_hook_arch_dep_replace_division_by_const)(void *context, ir_node *irn);
 160
 161     /** This hook is called after a new mode was registered. */
 162     void (*_hook_new_mode)(void *context, const ir_mode *tmpl, ir_mode *mode);
 163
 164     /** This hook is called after a new entity was created. */
 165     void (*_hook_new_entity)(void *context, ir_entity *ent);
 166
 167     /** This hook is called after a new type was created. */
 168     void (*_hook_new_type)(void *context, ir_type *tp);
 169
 170     /** This hook is called at the end of the node info dumper to dump additional node info. */
 171     void (*_hook_node_info)(void *context, FILE *f, const ir_node *n);
 172   } hook;
 173
 174   /** the context for every hook */
 175   void *context;
 176
 177   /** needed for chaining */
 178   struct hook_entry *next;
 179 } hook_entry_t;
 180
 181 /**
 182  * possible hooks
 183  */
 184 typedef enum {
 185   hook_new_ir_op,
 186   hook_free_ir_op,
 187   hook_new_node,
 188   hook_set_irn_n,
 189   hook_replace,
 190   hook_turn_into_id,
 191   hook_new_graph,
 192   hook_free_graph,
 193   hook_irg_walk,
 194   hook_irg_walk_blkwise,
 195   hook_irg_block_walk,
 196   hook_merge_nodes,
 197   hook_reassociate,
 198   hook_lower,
 199   hook_inline,
 200   hook_tail_rec,
 201   hook_strength_red,
 202   hook_dead_node_elim,
 203   hook_dead_node_elim_subst,
 204   hook_if_conversion,
 205   hook_func_call,
 206   hook_arch_dep_replace_mul_with_shifts,
 207   hook_arch_dep_replace_division_by_const,
 208   hook_new_mode,
 209   hook_new_entity,
 210   hook_new_type,
 211   hook_node_info,
 212   hook_last
 213 } hook_type_t;
 214
 215 /**
 216  * register a hook entry.
 217  *
 218  * @param hook   the hook type
 219  * @param entry  the hook entry
 220  */
 221 void register_hook(hook_type_t hook, hook_entry_t *entry);
 222
 223 /**
 224  * unregister a hook entry.
 225  *
 226  * @param hook   the hook type
 227  * @param entry  the hook entry
 228  */
 229 void unregister_hook(hook_type_t hook, hook_entry_t *entry);
 230
 231 #ifdef FIRM_ENABLE_HOOKS
 232
 233 extern hook_entry_t *hooks[hook_last];
 234
 235 /**
 236  * execute the hook what with the args args
 237  * Do not use this macro directly.
 238  */
 239 #define hook_exec(what, args) do {       \
 240   hook_entry_t *p;                       \
 241   for (p = hooks[what]; p; p = p->next){ \
 242     void *ctx = p->context;              \
 243     p->hook._##what args;                \
 244   }                                      \
 245 } while (0)
 246
 247 #else
 248
 249 #define hook_exec(what, args)
 250
 251 #endif /* FIRM_ENABLE_HOOKS */
 252
 253 #define hook_new_ir_op(op)                hook_exec(hook_new_ir_op, (ctx, op))
 254 #define hook_free_ir_op(op)               hook_exec(hook_free_ir_op, (ctx, op))
 255 #define hook_new_node(graph, node)        hook_exec(hook_new_node, (ctx, graph, node))
 256 #define hook_set_irn_n(src, pos, tgt, old_tgt) \
 257   hook_exec(hook_set_irn_n, (ctx, src, pos, tgt, old_tgt))
 258 #define hook_replace(old, nw)             hook_exec(hook_replace, (ctx, old, nw))
 259 #define hook_turn_into_id(node)           hook_exec(hook_turn_into_id, (ctx, node))
 260 #define hook_new_graph(irg, ent)          hook_exec(hook_new_graph, (ctx, irg, ent))
 261 #define hook_free_graph(irg)              hook_exec(hook_free_graph, (ctx, irg))
 262 #define hook_irg_walk(irg, pre, post)     hook_exec(hook_irg_walk, (ctx, irg, pre, post))
 263 #define hook_irg_walk_blkwise(irg, pre, post) \
 264   hook_exec(hook_irg_walk_blkwise, (ctx, irg, pre, post))
 265 #define hook_irg_block_walk(irg, node, pre, post) \
 266   hook_exec(hook_irg_block_walk, (ctx, irg, node, pre, post))
 267 #define hook_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt) \
 268   hook_exec(hook_merge_nodes, (ctx, new_node_array, new_num_entries, old_node_array, old_num_entries, opt))
 269 #define hook_reassociate(start)           hook_exec(hook_reassociate, (ctx, start))
 270 #define hook_lower(node)                  hook_exec(hook_lower, (ctx, node))
 271 #define hook_inline(call, irg)            hook_exec(hook_inline, (ctx, call, irg))
 272 #define hook_tail_rec(irg, n_calls)       hook_exec(hook_tail_rec, (ctx, irg, n_calls))
 273 #define hook_strength_red(irg, node) \
 274   hook_exec(hook_strength_red, (ctx, irg, node))
 275 #define hook_dead_node_elim(irg, start)   hook_exec(hook_dead_node_elim, (ctx, irg, start))
 276 #define hook_dead_node_elim_subst(irg, old, nw) \
 277    hook_exec(hook_dead_node_elim_subst, (ctx, irg, old, nw))
 278 #define hook_if_conversion(irg, phi, pos, mux, reason) \
 279   hook_exec(hook_if_conversion, (ctx, irg, phi, pos, mux, reason))
 280 #define hook_func_call(irg, call) \
 281   hook_exec(hook_func_call, (ctx, irg, call))
 282 #define hook_arch_dep_replace_mul_with_shifts(irn) \
 283   hook_exec(hook_arch_dep_replace_mul_with_shifts, (ctx, irn))
 284 #define hook_arch_dep_replace_division_by_const(irn) \
 285   hook_exec(hook_arch_dep_replace_division_by_const, (ctx, irn))
 286 #define hook_new_mode(tmpl, mode)         hook_exec(hook_new_mode, (ctx, tmpl, mode))
 287 #define hook_new_entity(ent)              hook_exec(hook_new_entity, (ctx, ent))
 288 #define hook_new_type(tp)                 hook_exec(hook_new_type, (ctx, tp))
 289 #define hook_node_info(F, node)           hook_exec(hook_node_info, (ctx, F, node))
 290
 291 /* the initializer, move to hooks_t.h some day */
 292 int firm_init_hooks(void);
 293
 294 #endif