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_WAW,         /**< Write-After-Write optimization */
  38   HOOK_OPT_WAR,         /**< Write-After-Read optimization */
  39   HOOK_OPT_RAW,         /**< Read-After-Write optimization */
  40   HOOK_OPT_RAR,         /**< Read-After-Read optimization */
  41   HOOK_OPT_RC,          /**< Read-a-Const optimization */
  42   HOOK_OPT_TUPLE,       /**< Tuple optimization */
  43   HOOK_OPT_ID,          /**< ID optimization */
  44   HOOK_OPT_CSE,         /**< common subexpression elimination */
  45   HOOK_OPT_STRENGTH_RED,/**< strength reduction */
  46   HOOK_OPT_ARCH_DEP,    /**< architecture dependent optimization */
  47   HOOK_OPT_REASSOC,     /**< reassociation */
  48   HOOK_OPT_POLY_CALL,   /**< polymorphic call optimization */
  49   HOOK_OPT_IF_CONV,     /**< an if conversion was tried */
  50   HOOK_OPT_FUNC_CALL,   /**< a real function call was removed */
  51   HOOK_OPT_CONFIRM,     /**< a value was substituted by another due to a Confirm */
  52   HOOK_OPT_CONFIRM_C,   /**< a value was substituted by a const due to a Confirm */
  53   HOOK_OPT_CONFIRM_E,   /**< a value was evaluated due to a Confirm */
  54   HOOK_LOWERED,         /**< lowered */
  55   HOOK_OPT_LAST
  56 } hook_opt_kind;
  57
  58 typedef enum _if_result_t {
  59   IF_RESULT_SUCCESS         = 0,  /**< if conversion could be done */
  60   IF_RESULT_SIDE_EFFECT     = 1,  /**< if conversion failed because of side effect */
  61   IF_RESULT_SIDE_EFFECT_PHI = 2,  /**< if conversion failed because of Phi node found */
  62   IF_RESULT_TOO_DEEP        = 3,  /**< if conversion failed because of to deep DAG's */
  63   IF_RESULT_BAD_CF          = 4,  /**< if conversion failed because of bad control flow */
  64   IF_RESULT_DENIED          = 5,  /**< if conversion failed because of architecture deny */
  65   IF_RESULT_LAST
  66 } if_result_t;
  67
  68 /**
  69  * a hook entry
  70  */
  71 typedef struct hook_entry {
  72   /** a union of all possible hook types */
  73   union {
  74     void (*_hook_new_ir_op)(void *context, ir_op *op);
  75     void (*_hook_free_ir_op)(void *context, ir_op *op);
  76     void (*_hook_new_node)(void *context, ir_graph *graph, ir_node *node);
  77     void (*_hook_set_irn_n)(void *context, ir_node *src,
  78                             int pos, ir_node *tgt, ir_node *old_tgt);
  79     void (*_hook_replaced)(void *context, ir_node *old_node, ir_node *new_node);
  80     void (*_hook_turn_into_id)(void *context, ir_node *node);
  81     void (*_hook_new_graph)(void *context, ir_graph *irg, entity *ent);
  82     void (*_hook_free_graph)(void *context, ir_graph *irg);
  83     void (*_hook_irg_walk)(void *context, ir_graph *irg, void *pre, void *post);
  84     void (*_hook_irg_walk_blkwise)(void *context, ir_graph *irg, void *pre, void *post);
  85     void (*_hook_irg_block_walk)(void *context, ir_graph *irg, ir_node *node, void *pre, void *post);
  86     void (*_hook_merge_nodes)(void *context, ir_node **new_node_array, int new_num_entries,
  87                               ir_node **old_node_array, int old_num_entries, hook_opt_kind opt);
  88     void (*_hook_reassociate)(void *context, int start);
  89     void (*_hook_lower)(void *context, ir_node *node);
  90     void (*_hook_inline)(void *context, ir_node *call, ir_graph *irg);
  91     void (*_hook_tail_rec)(void *context, ir_graph *irg, int n_calls);
  92     void (*_hook_strength_red)(void *context, ir_graph *irg, ir_node *strong, ir_node *cmp);
  93     void (*_hook_dead_node_elim_start)(void *context, ir_graph *irg);
  94     void (*_hook_dead_node_elim_stop)(void *context, ir_graph *irg);
  95     void (*_hook_if_conversion)(void *context, ir_graph *irg, ir_node *phi, int pos, ir_node *mux, if_result_t reason);
  96     void (*_hook_func_call)(void *context, ir_graph *irg, ir_node *call);
  97     void (*_hook_arch_dep_replace_mul_with_shifts)(void *context, ir_node *irn);
  98     void (*_hook_arch_dep_replace_div_by_const)(void *context, ir_node *irn);
  99     void (*_hook_arch_dep_replace_mod_by_const)(void *context, ir_node *irn);
 100     void (*_hook_arch_dep_replace_DivMod_by_const)(void *context, ir_node *irn);
 101     void (*_hook_new_mode)(void *context, const ir_mode *tmpl, ir_mode *mode);
 102   } hook;
 103
 104   /** the context for every hook */
 105   void *context;
 106
 107   /** needed for chaining */
 108   struct hook_entry *next;
 109 } hook_entry_t;
 110
 111 /**
 112  * possible hooks
 113  */
 114 typedef enum {
 115   hook_new_ir_op,
 116   hook_free_ir_op,
 117   hook_new_node,
 118   hook_set_irn_n,
 119   hook_replaced,
 120   hook_turn_into_id,
 121   hook_new_graph,
 122   hook_free_graph,
 123   hook_irg_walk,
 124   hook_irg_walk_blkwise,
 125   hook_irg_block_walk,
 126   hook_merge_nodes,
 127   hook_reassociate,
 128   hook_lower,
 129   hook_inline,
 130   hook_tail_rec,
 131   hook_strength_red,
 132   hook_dead_node_elim_start,
 133   hook_dead_node_elim_stop,
 134   hook_if_conversion,
 135   hook_func_call,
 136   hook_arch_dep_replace_mul_with_shifts,
 137   hook_arch_dep_replace_div_by_const,
 138   hook_arch_dep_replace_mod_by_const,
 139   hook_arch_dep_replace_DivMod_by_const,
 140   hook_new_mode,
 141   hook_last,
 142 } hook_type_t;
 143
 144 /**
 145  * register the hook entry.
 146  *
 147  * @param hook   the hook type
 148  * @param entry  the hook entry
 149  */
 150 void register_hook(hook_type_t hook, hook_entry_t *entry);
 151
 152 #ifdef FIRM_ENABLE_HOOKS
 153
 154 extern hook_entry_t *hooks[hook_last];
 155
 156 /**
 157  * execute the hook what with the args args
 158  * Do not use this macro directly.
 159  */
 160 #define hook_exec(what, args) do {       \
 161   hook_entry_t *p;                       \
 162   for (p = hooks[what]; p; p = p->next){ \
 163     void *ctx = p->context;              \
 164     p->hook._##what args;                \
 165   }                                      \
 166 } while (0)
 167
 168 #else
 169
 170 #define hook_exec(what, args)
 171
 172 #endif /* FIRM_ENABLE_HOOKS */
 173
 174 #define hook_new_ir_op(op)                hook_exec(hook_new_ir_op, (ctx, op))
 175 #define hook_free_ir_op(op)               hook_exec(hook_free_ir_op, (ctx, op))
 176 #define hook_new_node(graph, node)        hook_exec(hook_new_node, (ctx, graph, node))
 177 #define hook_set_irn_n(src, pos, tgt, old_tgt) \
 178   hook_exec(hook_set_irn_n, (ctx, src, pos, tgt, old_tgt))
 179 #define hook_replaced(old, nw)            hook_exec(hook_replaced, (ctx, old, nw))
 180 #define hook_turn_into_id(node)           hook_exec(hook_turn_into_id, (ctx, node))
 181 #define hook_new_graph(irg, ent)          hook_exec(hook_new_graph, (ctx, irg, ent))
 182 #define hook_free_graph(irg)              hook_exec(hook_free_graph, (ctx, irg))
 183 #define hook_irg_walk(irg, pre, post)     hook_exec(hook_irg_walk, (ctx, irg, pre, post))
 184 #define hook_irg_walk_blkwise(irg, pre, post) \
 185   hook_exec(hook_irg_walk_blkwise, (ctx, irg, pre, post))
 186 #define hook_irg_block_walk(irg, node, pre, post) \
 187   hook_exec(hook_irg_block_walk, (ctx, irg, node, pre, post))
 188 #define hook_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt) \
 189   hook_exec(hook_merge_nodes, (ctx, new_node_array, new_num_entries, old_node_array, old_num_entries, opt))
 190 #define hook_reassociate(start)           hook_exec(hook_reassociate, (ctx, start))
 191 #define hook_lower(node)                  hook_exec(hook_lower, (ctx, node))
 192 #define hook_inline(call, irg)            hook_exec(hook_inline, (ctx, call, irg))
 193 #define hook_tail_rec(irg, n_calls)       hook_exec(hook_tail_rec, (ctx, irg, n_calls))
 194 #define hook_strength_red(irg, strong, cmp) \
 195   hook_exec(hook_strength_red, (ctx, irg, strong, cmp))
 196 #define hook_dead_node_elim_start(irg)    hook_exec(hook_dead_node_elim_start, (ctx, irg))
 197 #define hook_dead_node_elim_stop(irg)     hook_exec(hook_dead_node_elim_stop, (ctx, irg))
 198 #define hook_if_conversion(irg, phi, pos, mux, reason) \
 199   hook_exec(hook_if_conversion, (ctx, irg, phi, pos, mux, reason))
 200 #define hook_func_call(irg, call) \
 201   hook_exec(hook_func_call, (ctx, irg, call))
 202 #define hook_arch_dep_replace_mul_with_shifts(irn) \
 203   hook_exec(hook_arch_dep_replace_mul_with_shifts, (ctx, irn))
 204 #define hook_arch_dep_replace_div_by_const(irn) \
 205   hook_exec(hook_arch_dep_replace_div_by_const, (ctx, irn))
 206 #define hook_arch_dep_replace_mod_by_const(irn) \
 207   hook_exec(hook_arch_dep_replace_mod_by_const, (ctx, irn))
 208 #define hook_arch_dep_replace_DivMod_by_const(irn) \
 209   hook_exec(hook_arch_dep_replace_DivMod_by_const, (ctx, irn))
 210 #define hook_new_mode(tmpl, mode)         hook_exec(hook_new_mode, (ctx, tmpl, mode))
 211
 212 /* the initializer, move to hooks_t.h some day */
 213 int init_hooks(void);
 214
 215 #endif /* __IRHOOKS_H__ */