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