nsz Git - libfirm/blob - ir/stat/firmstat.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/stat/firmstat.h
   4  * Purpose:     Statistics for Firm.
   5  * Author:      Michael Beck
   6  * Created:
   7  * CVS-ID:      $Id$
   8  * Copyright:   (c) 2004 Universität Karlsruhe
   9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  10  */
  11 #ifndef _FIRMSTAT_H_
  12 #define _FIRMSTAT_H_
  13
  14 /**
  15  * @file firmstat.h
  16  */
  17 #include "irop.h"
  18 #include "irnode.h"
  19 #include "irgraph.h"
  20
  21 /**
  22  * Statistic options, can be or'ed.
  23  */
  24 enum firmstat_options_t {
  25   FIRMSTAT_ENABLED         = 0x00000001,        /**< enable statistics */
  26   FIRMSTAT_PATTERN_ENABLED = 0x00000002,        /**< enable pattern calculation */
  27   FIRMSTAT_COUNT_STRONG_OP = 0x00000004,        /**< if set, count Mul/Div/Mod/DivMod by constant */
  28 };
  29
  30 /**
  31  * Finish the statistics.
  32  * Never called from libFirm should be called from user.
  33  *
  34  * @param name   basename of the statistic output file
  35  */
  36 void stat_finish(const char *name);
  37
  38 #ifdef FIRM_STATISTICS
  39
  40 typedef enum {
  41   STAT_OPT_STG,                 /**< straightening optimization */
  42   STAT_OPT_IFSIM,               /**< if simplification */
  43   STAT_OPT_ALGSIM,              /**< algebraic simplification */
  44   STAT_OPT_PHI,                 /**< Phi optmization */
  45   STAT_OPT_WAW,                 /**< Write-After-Write optimization */
  46   STAT_OPT_WAR,                 /**< Write-After-Read optimization */
  47   STAT_OPT_RAW,                 /**< Read-After-Write optimization */
  48   STAT_OPT_RAR,                 /**< Read-After-Read optimization */
  49   STAT_OPT_TUPLE,               /**< Tuple optimization */
  50   STAT_OPT_ID,                  /**< ID optimization */
  51   STAT_OPT_CONST_EVAL,          /**< constant evaluation */
  52   STAT_OPT_STRENGTH_RED,        /**< strenght reduction */
  53   STAT_LOWERED,                 /**< lowered */
  54
  55   STAT_OPT_MAX
  56 } stat_opt_kind;
  57
  58 /**
  59  * initialize the statistics module.
  60  *
  61  * @param enable_options  Bitmask containing the statistic options
  62  */
  63 void init_stat(unsigned enable_options);
  64
  65 /**
  66  * A new IR op is registered.
  67  */
  68 void stat_new_ir_op(const ir_op *op);
  69
  70 /**
  71  * An IR op is freed.
  72  */
  73 void stat_free_ir_op(const ir_op *op);
  74
  75 /**
  76  * A new node is created.
  77  */
  78 void stat_new_node(ir_node *node);
  79
  80 /**
  81  * A node is changed into a Id node
  82  */
  83 void stat_turn_into_id(ir_node *node);
  84
  85 /**
  86  * A new graph was created
  87  */
  88 void stat_new_graph(ir_graph *irg, entity *ent);
  89
  90 /**
  91  * A graph was deleted
  92  */
  93 void stat_free_graph(ir_graph *irg);
  94
  95 /**
  96  * A walk over a graph is initiated
  97  */
  98 void stat_irg_walk(ir_graph *irg, void *pre, void *post);
  99
 100 /**
 101  * A walk over a graph in block-wise order is initiated
 102  */
 103 void stat_irg_walk_blkwise(ir_graph *irg, void *pre, void *post);
 104
 105 /**
 106  * A walk over the graph's blocks is initiated
 107  */
 108 void stat_irg_block_walk(ir_graph *irg, const ir_node *node, void *pre, void *post);
 109
 110 /**
 111  * Some nodes were optimized into some others due to an optimization
 112  */
 113 void stat_merge_nodes(
 114     ir_node **new_node_array, int new_num_entries,
 115     ir_node **old_node_array, int old_num_entries,
 116     stat_opt_kind opt);
 117
 118 /**
 119  * A node was lowered into other nodes
 120  */
 121 void stat_lower(ir_node *node);
 122
 123 /**
 124  * A graph was inlined
 125  */
 126 void stat_inline(ir_node *call, ir_graph *irg);
 127
 128 /**
 129  * A graph with tail-recursions was optimized.
 130  */
 131 void stat_tail_rec(ir_graph *irg);
 132
 133 /**
 134  * Strength reduction was performed on an iteration variable.
 135  */
 136 void stat_strength_red(ir_graph *irg, ir_node *strong, ir_node *cmp);
 137
 138 /**
 139  * Start the dead node elimination.
 140  */
 141 void stat_dead_node_elim_start(ir_graph *irg);
 142
 143 /**
 144  * Stops the dead node elimination.
 145  */
 146 void stat_dead_node_elim_stop(ir_graph *irg);
 147
 148 /**
 149  * helper: get an ir_op from an opcode
 150  *
 151  * @param code  the opcode
 152  *
 153  * @return  The associated ir_op or NULL if the opcode could not be found.
 154  */
 155 ir_op *stat_get_op_from_opcode(opcode code);
 156
 157 #else
 158
 159 #define init_stat(enable_options)
 160 #define stat_finish(name)
 161 #define stat_new_ir_op(op)
 162 #define stat_free_ir_op(op)
 163 #define stat_new_node(node)
 164 #define stat_turn_into_id(node)
 165 #define stat_new_graph(irg, ent)
 166 #define stat_free_graph(irg)
 167 #define stat_irg_walk(irg, pre, post)
 168 #define stat_irg_walk_blkwise(irg, pre, post)
 169 #define stat_irg_block_walk(irg, node, pre, post)
 170 #define stat_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt)
 171 #define stat_lower(node)
 172 #define stat_inline(call, irg)
 173 #define stat_tail_rec(irg)
 174 #define stat_strength_red(irg, strong, cmp)
 175 #define stat_dead_node_elim_start(irg)
 176 #define stat_dead_node_elim_stop(irg)
 177
 178 #endif
 179
 180 #endif /* _FIRMSTAT_H_ */