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