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

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