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   FIRMSTAT_CSV_OUTPUT      = 0x10000000         /**< CSV output of some mini-statistic */
  29 };
  30
  31 /**
  32  * Finish the statistics.
  33  * Never called from libFirm should be called from user.
  34  *
  35  * @param name   basename of the statistic output file
  36  */
  37 void stat_finish(const char *name);
  38
  39 #ifdef FIRM_STATISTICS
  40
  41 typedef enum {
  42   STAT_OPT_STG,                 /**< straightening optimization */
  43   STAT_OPT_IFSIM,               /**< if simplification */
  44   STAT_OPT_CONST_EVAL,          /**< constant evaluation */
  45   STAT_OPT_ALGSIM,              /**< algebraic simplification */
  46   STAT_OPT_PHI,                 /**< Phi optmization */
  47   STAT_OPT_WAW,                 /**< Write-After-Write optimization */
  48   STAT_OPT_WAR,                 /**< Write-After-Read optimization */
  49   STAT_OPT_RAW,                 /**< Read-After-Write optimization */
  50   STAT_OPT_RAR,                 /**< Read-After-Read optimization */
  51   STAT_OPT_RC,                  /**< Read-a-Const optimization */
  52   STAT_OPT_TUPLE,               /**< Tuple optimization */
  53   STAT_OPT_ID,                  /**< ID optimization */
  54   STAT_OPT_CSE,                 /**< common subexpression elimination */
  55   STAT_OPT_STRENGTH_RED,        /**< strenght reduction */
  56   STAT_OPT_ARCH_DEP,            /**< architecture dependant optimization */
  57   STAT_OPT_REASSOC,             /**< reassociation */
  58   STAT_OPT_POLY_CALL,           /**< polymorphic call optimization */
  59   STAT_LOWERED,                 /**< lowered */
  60
  61   STAT_OPT_MAX
  62 } stat_opt_kind;
  63
  64 /**
  65  * initialize the statistics module.
  66  *
  67  * @param enable_options  Bitmask containing the statistic options
  68  */
  69 void init_stat(unsigned enable_options);
  70
  71 /**
  72  * A new IR op is registered.
  73  */
  74 void stat_new_ir_op(const ir_op *op);
  75
  76 /**
  77  * An IR op is freed.
  78  */
  79 void stat_free_ir_op(const ir_op *op);
  80
  81 /**
  82  * A new node is created.
  83  */
  84 void stat_new_node(ir_node *node);
  85
  86 /**
  87  * A node is changed into a Id node
  88  */
  89 void stat_turn_into_id(ir_node *node);
  90
  91 /**
  92  * A new graph was created
  93  */
  94 void stat_new_graph(ir_graph *irg, entity *ent);
  95
  96 /**
  97  * A graph was deleted
  98  */
  99 void stat_free_graph(ir_graph *irg);
 100
 101 /**
 102  * A walk over a graph is initiated
 103  */
 104 void stat_irg_walk(ir_graph *irg, void *pre, void *post);
 105
 106 /**
 107  * A walk over a graph in block-wise order is initiated
 108  */
 109 void stat_irg_walk_blkwise(ir_graph *irg, void *pre, void *post);
 110
 111 /**
 112  * A walk over the graph's blocks is initiated
 113  */
 114 void stat_irg_block_walk(ir_graph *irg, const ir_node *node, void *pre, void *post);
 115
 116 /**
 117  * Some nodes were optimized into some others due to an optimization
 118  */
 119 void stat_merge_nodes(
 120     ir_node **new_node_array, int new_num_entries,
 121     ir_node **old_node_array, int old_num_entries,
 122     stat_opt_kind opt);
 123
 124 /**
 125  * Reassociation of nodes started/stopped.
 126  */
 127 void stat_reassociate(int start);
 128
 129 /**
 130  * A node was lowered into other nodes
 131  */
 132 void stat_lower(ir_node *node);
 133
 134 /**
 135  * A graph was inlined
 136  */
 137 void stat_inline(ir_node *call, ir_graph *irg);
 138
 139 /**
 140  * A graph with tail-recursions was optimized.
 141  */
 142 void stat_tail_rec(ir_graph *irg);
 143
 144 /**
 145  * Strength reduction was performed on an iteration variable.
 146  */
 147 void stat_strength_red(ir_graph *irg, ir_node *strong, ir_node *cmp);
 148
 149 /**
 150  * Start the dead node elimination.
 151  */
 152 void stat_dead_node_elim_start(ir_graph *irg);
 153
 154 /**
 155  * Stops the dead node elimination.
 156  */
 157 void stat_dead_node_elim_stop(ir_graph *irg);
 158
 159 /**
 160  * A multiply was replaced by a series of Shifts/Adds/Subs
 161  */
 162 void stat_arch_dep_replace_mul_with_shifts(ir_node *mul);
 163
 164 /**
 165  * A division was replaced by a series of Shifts/Muls
 166  */
 167 void stat_arch_dep_replace_div_by_const(ir_node *div);
 168
 169 /**
 170  * A modulo was replaced by a series of Shifts/Muls
 171  */
 172 void stat_arch_dep_replace_mod_by_const(ir_node *mod);
 173
 174 /**
 175  * A Divod was replaced by a series of Shifts/Muls
 176  */
 177 void stat_arch_dep_replace_DivMod_by_const(ir_node *divmod);
 178
 179 /**
 180  * helper: get an ir_op from an opcode
 181  *
 182  * @param code  the opcode
 183  *
 184  * @return  The associated ir_op or NULL if the opcode could not be found.
 185  */
 186 ir_op *stat_get_op_from_opcode(opcode code);
 187
 188 #else
 189
 190 #define init_stat(enable_options)
 191 #define stat_finish(name)
 192 #define stat_new_ir_op(op)
 193 #define stat_free_ir_op(op)
 194 #define stat_new_node(node)
 195 #define stat_turn_into_id(node)
 196 #define stat_new_graph(irg, ent)
 197 #define stat_free_graph(irg)
 198 #define stat_irg_walk(irg, pre, post)
 199 #define stat_irg_walk_blkwise(irg, pre, post)
 200 #define stat_irg_block_walk(irg, node, pre, post)
 201 #define stat_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt)
 202 #define stat_reassociate(start)
 203 #define stat_lower(node)
 204 #define stat_inline(call, irg)
 205 #define stat_tail_rec(irg)
 206 #define stat_strength_red(irg, strong, cmp)
 207 #define stat_dead_node_elim_start(irg)
 208 #define stat_dead_node_elim_stop(irg)
 209 #define stat_arch_dep_replace_mul_with_shifts(irn)
 210 #define stat_arch_dep_replace_div_by_const(irn)
 211 #define stat_arch_dep_replace_mod_by_const(irn)
 212 #define stat_arch_dep_replace_DivMod_by_const(irn)
 213
 214 #endif
 215
 216 #endif /* _FIRMSTAT_H_ */