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