libfirm/irhooks.h

Go to the documentation of this file.

/*
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

#ifndef FIRM_IR_IRHOOKS_H
#define FIRM_IR_IRHOOKS_H

#include "irop.h"
#include "irnode.h"
#include "irgraph.h"
#include "begin.h"

typedef enum {
    HOOK_OPT_DEAD_BLOCK,  
    HOOK_OPT_STG,         
    HOOK_OPT_IFSIM,       
    HOOK_OPT_CONST_EVAL,  
    HOOK_OPT_ALGSIM,      
    HOOK_OPT_PHI,         
    HOOK_OPT_SYNC,        
    HOOK_OPT_WAW,         
    HOOK_OPT_WAR,         
    HOOK_OPT_RAW,         
    HOOK_OPT_RAR,         
    HOOK_OPT_RC,          
    HOOK_OPT_TUPLE,       
    HOOK_OPT_ID,          
    HOOK_OPT_CSE,         
    HOOK_OPT_STRENGTH_RED,
    HOOK_OPT_ARCH_DEP,    
    HOOK_OPT_REASSOC,     
    HOOK_OPT_POLY_CALL,   
    HOOK_OPT_IF_CONV,     
    HOOK_OPT_FUNC_CALL,   
    HOOK_OPT_CONFIRM,     
    HOOK_OPT_CONFIRM_C,   
    HOOK_OPT_CONFIRM_E,   
    HOOK_OPT_EXC_REM,     
    HOOK_OPT_NORMALIZE,   
    HOOK_LOWERED,         
    HOOK_BACKEND,         
    HOOK_OPT_LAST
} hook_opt_kind;

typedef enum if_result_t {
    IF_RESULT_SUCCESS         = 0,  
    IF_RESULT_SIDE_EFFECT     = 1,  
    IF_RESULT_SIDE_EFFECT_PHI = 2,  
    IF_RESULT_TOO_DEEP        = 3,  
    IF_RESULT_BAD_CF          = 4,  
    IF_RESULT_DENIED          = 5,  
    IF_RESULT_LAST
} if_result_t;

typedef void (generic_func)(void);

typedef struct hook_entry {
    union {
        void (*_hook_new_ir_op)(void *context, ir_op *op);

        void (*_hook_free_ir_op)(void *context, ir_op *op);

        void (*_hook_new_node)(void *context, ir_graph *graph, ir_node *node);

        void (*_hook_set_irn_n)(void *context, ir_node *src,
                                int pos, ir_node *tgt, ir_node *old_tgt);

        void (*_hook_replace)(void *context, ir_node *old_node, ir_node *new_node);

        void (*_hook_turn_into_id)(void *context, ir_node *node);

        void (*_hook_normalize)(void *context, ir_node *node);

        void (*_hook_new_graph)(void *context, ir_graph *irg, ir_entity *ent);

        void (*_hook_free_graph)(void *context, ir_graph *irg);

        void (*_hook_irg_walk)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);

        void (*_hook_irg_walk_blkwise)(void *context, ir_graph *irg, generic_func *pre, generic_func *post);

        void (*_hook_irg_block_walk)(void *context, ir_graph *irg, ir_node *node, generic_func *pre, generic_func *post);

        void (*_hook_merge_nodes)(void *context, ir_node **new_node_array, int new_num_entries,
                                  ir_node **old_node_array, int old_num_entries, hook_opt_kind opt);

        void (*_hook_reassociate)(void *context, int start);

        void (*_hook_lower)(void *context, ir_node *node);

        void (*_hook_inline)(void *context, ir_node *call, ir_graph *irg);

        void (*_hook_tail_rec)(void *context, ir_graph *irg, int n_calls);

        void (*_hook_strength_red)(void *context, ir_graph *irg, ir_node *node);

        void (*_hook_dead_node_elim)(void *context, ir_graph *irg, int start);

        void (*_hook_dead_node_elim_subst)(void *context, ir_graph *irg, ir_node *old, ir_node *nw);

        void (*_hook_if_conversion)(void *context, ir_graph *irg, ir_node *phi, int pos, ir_node *mux, if_result_t reason);

        void (*_hook_func_call)(void *context, ir_graph *irg, ir_node *call);

        void (*_hook_arch_dep_replace_mul_with_shifts)(void *context, ir_node *irn);

        void (*_hook_arch_dep_replace_division_by_const)(void *context, ir_node *irn);

        void (*_hook_new_mode)(void *context, ir_mode *mode);

        void (*_hook_new_entity)(void *context, ir_entity *ent);

        void (*_hook_new_type)(void *context, ir_type *tp);

        void (*_hook_node_info)(void *context, FILE *f, const ir_node *n);
    } hook; 
    void *context;

    struct hook_entry *next;
} hook_entry_t;

typedef enum {
    hook_new_ir_op,            
    hook_free_ir_op,           
    hook_new_node,             
    hook_set_irn_n,            
    hook_replace,              
    hook_turn_into_id,         
    hook_normalize,            
    hook_new_graph,            
    hook_free_graph,           
    hook_irg_walk,             
    hook_irg_walk_blkwise,     
    hook_irg_block_walk,       
    hook_merge_nodes,          
    hook_reassociate,          
    hook_lower,                
    hook_inline,               
    hook_tail_rec,             
    hook_strength_red,         
    hook_dead_node_elim,       
    hook_dead_node_elim_subst, 
    hook_if_conversion,        
    hook_func_call,            
    hook_arch_dep_replace_mul_with_shifts,
    hook_arch_dep_replace_division_by_const,
    hook_new_mode,             
    hook_new_entity,           
    hook_new_type,             
    hook_node_info,            
    hook_last                  
} hook_type_t;

FIRM_API void register_hook(hook_type_t hook, hook_entry_t *entry);

FIRM_API void unregister_hook(hook_type_t hook, hook_entry_t *entry);

FIRM_API hook_entry_t *hooks[hook_last];

#define hook_exec(what, args) do {           \
  hook_entry_t *_p;                          \
  for (_p = hooks[what]; _p; _p = _p->next){ \
    void *hook_ctx_ = _p->context;           \
    _p->hook._##what args;                   \
  }                                          \
} while (0)

#define hook_new_ir_op(op)                hook_exec(hook_new_ir_op, (hook_ctx_, op))

#define hook_free_ir_op(op)               hook_exec(hook_free_ir_op, (hook_ctx_, op))

#define hook_new_node(graph, node)        hook_exec(hook_new_node, (hook_ctx_, graph, node))

#define hook_set_irn_n(src, pos, tgt, old_tgt) \
  hook_exec(hook_set_irn_n, (hook_ctx_, src, pos, tgt, old_tgt))

#define hook_replace(old, nw)             hook_exec(hook_replace, (hook_ctx_, old, nw))

#define hook_turn_into_id(node)           hook_exec(hook_turn_into_id, (hook_ctx_, node))

#define hook_normalize(node)              hook_exec(hook_normalize, (hook_ctx_, node))

#define hook_new_graph(irg, ent)          hook_exec(hook_new_graph, (hook_ctx_, irg, ent))

#define hook_free_graph(irg)              hook_exec(hook_free_graph, (hook_ctx_, irg))

#define hook_irg_walk(irg, pre, post)     hook_exec(hook_irg_walk, (hook_ctx_, irg, pre, post))

#define hook_irg_walk_blkwise(irg, pre, post) \
  hook_exec(hook_irg_walk_blkwise, (hook_ctx_, irg, pre, post))

#define hook_irg_block_walk(irg, node, pre, post) \
  hook_exec(hook_irg_block_walk, (hook_ctx_, irg, node, pre, post))

#define hook_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt) \
  hook_exec(hook_merge_nodes, (hook_ctx_, new_node_array, new_num_entries, old_node_array, old_num_entries, opt))

#define hook_reassociate(start)           hook_exec(hook_reassociate, (hook_ctx_, start))

#define hook_lower(node)                  hook_exec(hook_lower, (hook_ctx_, node))

#define hook_inline(call, irg)            hook_exec(hook_inline, (hook_ctx_, call, irg))

#define hook_tail_rec(irg, n_calls)       hook_exec(hook_tail_rec, (hook_ctx_, irg, n_calls))

#define hook_strength_red(irg, node) \
  hook_exec(hook_strength_red, (hook_ctx_, irg, node))

#define hook_dead_node_elim(irg, start)   hook_exec(hook_dead_node_elim, (hook_ctx_, irg, start))

#define hook_dead_node_elim_subst(irg, old, nw) \
   hook_exec(hook_dead_node_elim_subst, (hook_ctx_, irg, old, nw))

#define hook_if_conversion(irg, phi, pos, mux, reason) \
  hook_exec(hook_if_conversion, (hook_ctx_, irg, phi, pos, mux, reason))

#define hook_func_call(irg, call) \
  hook_exec(hook_func_call, (hook_ctx_, irg, call))

#define hook_arch_dep_replace_mul_with_shifts(irn) \
  hook_exec(hook_arch_dep_replace_mul_with_shifts, (hook_ctx_, irn))

#define hook_arch_dep_replace_division_by_const(irn) \
  hook_exec(hook_arch_dep_replace_division_by_const, (hook_ctx_, irn))

#define hook_new_mode(mode)               hook_exec(hook_new_mode, (hook_ctx_, mode))

#define hook_new_entity(ent)              hook_exec(hook_new_entity, (hook_ctx_, ent))

#define hook_new_type(tp)                 hook_exec(hook_new_type, (hook_ctx_, tp))

#define hook_node_info(F, node)           hook_exec(hook_node_info, (hook_ctx_, F, node))

#include "end.h"

#endif