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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/stat/firmstat_t.h
   4  * Purpose:     Statistics for Firm. Internal data structures.
   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_T_H_
  12 #define _FIRMSTAT_T_H_
  13
  14 /**
  15  * @file firmstat_t.h
  16  */
  17 #include "firmstat.h"
  18
  19 #include "irop_t.h"
  20 #include "irnode_t.h"
  21 #include "irgraph_t.h"
  22 #include "pset.h"
  23 #include "pdeq.h"
  24 #include "irprog.h"
  25 #include "irgwalk.h"
  26 #include "counter.h"
  27 #include "irhooks.h"
  28
  29 /* some useful macro. */
  30 #define ARR_SIZE(a)   (sizeof(a)/sizeof((a)[0]))
  31
  32 /*
  33  * just be make some things clear :-), the
  34  * poor man "generics"
  35  */
  36 #define HASH_MAP(type) hmap_##type
  37
  38 typedef pset hmap_node_entry_t;
  39 typedef pset hmap_graph_entry_t;
  40 typedef pset hmap_opt_entry_t;
  41 typedef pset hmap_block_entry_t;
  42 typedef pset hmap_ir_op;
  43 typedef pset hmap_distrib_entry_t;
  44
  45 /**
  46  * possible address marker values
  47  */
  48 enum adr_marker_t {
  49   MARK_ADDRESS_CALC     = 1,    /**< the node is an address expression */
  50   MARK_REF_ADR          = 2,    /**< the node is referenced by an address expression */
  51   MARK_REF_NON_ADR      = 4,    /**< the node is referenced by a non-address expression */
  52 };
  53
  54 /**
  55  * An entry in the address_mark set
  56  */
  57 typedef struct _address_mark_entry_t {
  58   ir_node  *node;               /**< the node which this entry belongs to, needed for compare */
  59   unsigned mark;                /**< the mark, a bitmask of enum adr_marker_t */
  60 } address_mark_entry_t;
  61
  62 /**
  63  * An entry for ir_nodes, used in ir_graph statistics.
  64  */
  65 typedef struct _node_entry_t {
  66   counter_t   cnt_alive;    /**< amount of nodes in this entry */
  67   counter_t   new_node;     /**< amount of new nodes for this entry */
  68   counter_t   into_Id;      /**< amount of nodes that turned into Id's for this entry */
  69   const ir_op *op;          /**< the op for this entry */
  70 } node_entry_t;
  71
  72 enum leaf_call_state_t {
  73   LCS_UNKNOWN       = 0,      /**< state is unknown yet */
  74   LCS_LEAF_CALL     = 1,      /**< only leaf functions will be called */
  75   LCS_NON_LEAF_CALL = 2,      /**< at least one non-leaf function will be called or indetermined */
  76 };
  77
  78 /**
  79  * An entry for ir_graphs. These numbers are calculated for every IR graph.
  80  */
  81 typedef struct _graph_entry_t {
  82   struct obstack          recalc_cnts;                  /**< obstack containing the counters that are recalculated */
  83   HASH_MAP(node_entry_t)  *opcode_hash;                 /**< hash map containing the opcode counter */
  84   HASH_MAP(block_entry_t) *block_hash;                  /**< hash map containing the block counter */
  85   HASH_MAP(block_entry_t) *extbb_hash;                  /**< hash map containing the extended block counter */
  86   counter_t               cnt_walked;                     /**< walker walked over the graph */
  87   counter_t               cnt_walked_blocks;            /**< walker walked over the graph blocks */
  88   counter_t               cnt_was_inlined;              /**< number of times other graph were inlined */
  89   counter_t               cnt_got_inlined;              /**< number of times this graph was inlined */
  90   counter_t               cnt_strength_red;             /**< number of times strength reduction was successful on this graph */
  91   counter_t               cnt_edges;                    /**< number of DF edges in this graph */
  92   counter_t               cnt_all_calls;                /**< number of all calls */
  93   counter_t               cnt_call_with_cnst_arg;       /**< number of calls with const args */
  94   counter_t               cnt_indirect_calls;           /**< number of indirect calls */
  95   counter_t               cnt_if_conv[IF_RESULT_LAST];  /**< number of if conversions */
  96   counter_t               cnt_real_func_call;           /**< number real function call optimization */
  97   unsigned                num_tail_recursion;           /**< number of tail recursion optimizations */
  98   HASH_MAP(opt_entry_t)   *opt_hash[FS_OPT_MAX];        /**< hash maps containing opcode counter for optimizations */
  99   ir_graph                *irg;                         /**< the graph of this object */
 100   entity                  *ent;                         /**< the entity of this graph if one exists */
 101   set                     *address_mark;                /**< a set containing the address marks of the nodes */
 102   unsigned                is_deleted:1;                 /**< set if this irg was deleted */
 103   unsigned                is_leaf:1;                    /**< set, if this irg is a leaf function */
 104   unsigned                is_leaf_call:2;               /**< set, if this irg calls only leaf functions */
 105   unsigned                is_recursive:1;               /**< set, if this irg has recursive calls */
 106   unsigned                is_chain_call:1;              /**< set, if this irg is a chain call */
 107   unsigned                is_analyzed:1;                /**< helper: set, if this irg was already analysed */
 108 } graph_entry_t;
 109
 110 /**
 111  * An entry for optimized ir_nodes
 112  */
 113 typedef struct _opt_entry_t {
 114   counter_t   count;    /**< optimization counter */
 115   const ir_op *op;      /**< the op for this entry */
 116 } opt_entry_t;
 117
 118 /**
 119  * An entry for a block or extended block in a ir-graph
 120  */
 121 typedef struct _block_entry_t {
 122   counter_t  cnt_nodes;     /**< the counter of nodes in this block */
 123   counter_t  cnt_edges;     /**< the counter of edges in this block */
 124   counter_t  cnt_in_edges;  /**< the counter of edges incoming from other blocks to this block */
 125   counter_t  cnt_out_edges; /**< the counter of edges outgoing from this block to other blocks */
 126   counter_t  cnt_phi_data;  /**< the counter of data Phi nodes in this block */
 127   long       block_nr;      /**< block nr */
 128 } block_entry_t;
 129
 130 /** An entry for an extended block in a ir-graph */
 131 typedef block_entry_t extbb_entry_t;
 132
 133 /**
 134  * Some potential interesting float values
 135  */
 136 typedef enum _float_classify_t {
 137   STAT_FC_0,                /**< the float value 0.0 */
 138   STAT_FC_1,                /**< the float value 1.0 */
 139   STAT_FC_2,                /**< the float value 2.0 */
 140   STAT_FC_0_5,              /**< the float value 0.5 */
 141   STAT_FC_EXACT,            /**< an exact value */
 142   STAT_FC_OTHER,            /**< all other values */
 143   STAT_FC_MAX               /**< last value */
 144 } float_classify_t;
 145
 146 /**
 147  * constant info
 148  */
 149 typedef struct _constant_info_t {
 150   counter_t  int_bits_count[32];  /**< distribution of bit sizes of integer constants */
 151   counter_t  floats[STAT_FC_MAX]; /**< floating point constants */
 152   counter_t  others;              /**< all other constants */
 153 } constant_info_t;
 154
 155 /** forward */
 156 typedef struct _dumper_t dumper_t;
 157
 158 /**
 159  * handler for dumping an IRG
 160  *
 161  * @param dmp   the dumper
 162  * @param entry the IR-graph hash map entry
 163  */
 164 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
 165
 166 /**
 167  * handler for dumper init
 168  *
 169  * @param dmp   the dumper
 170  * @param name  name of the file to dump to
 171  */
 172 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
 173
 174 /**
 175  * handler for dumper a constant info table
 176  *
 177  * @param dmp   the dumper
 178  */
 179 typedef void (*dump_const_table_FUNC)(dumper_t *dmp, const constant_info_t *tbl);
 180
 181 /**
 182  * handler for dumper finish
 183  *
 184  * @param dmp   the dumper
 185  */
 186 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
 187
 188 /**
 189  * statistics info
 190  */
 191 typedef struct _statistic_info_t {
 192   unsigned                stat_options;   /**< statistic options: field must be first */
 193   struct obstack          cnts;           /**< obstack containing the counters that are incremented */
 194   HASH_MAP(graph_entry_t) *irg_hash;      /**< hash map containing the counter for irgs */
 195   HASH_MAP(ir_op)         *ir_op_hash;    /**< hash map containing all ir_ops (accessible by op_codes) */
 196   pdeq                    *wait_q;        /**< wait queue for leaf call decision */
 197   int                     recursive;      /**< flag for detecting recursive hook calls */
 198   int                     in_dead_node_elim;    /**< set, if dead node elimination runs */
 199   ir_op                   *op_Phi0;       /**< pseudo op for Phi0 */
 200   ir_op                   *op_PhiM;       /**< pseudo op for memory Phi */
 201   ir_op                   *op_ProjM;      /**< pseudo op for memory Proj */
 202   ir_op                   *op_MulC;       /**< pseudo op for multiplication by const */
 203   ir_op                   *op_DivC;       /**< pseudo op for division by const */
 204   ir_op                   *op_ModC;       /**< pseudo op for modulo by const */
 205   ir_op                   *op_DivModC;    /**< pseudo op for DivMod by const */
 206   ir_op                   *op_SelSel;     /**< pseudo op for Sel(Sel) */
 207   ir_op                   *op_SelSelSel;  /**< pseudo op for Sel(Sel(Sel)) */
 208   dumper_t                *dumper;        /**< list of dumper */
 209   int                     reassoc_run;    /**< if set, reassociation is running */
 210   constant_info_t         const_info;     /**< statistic info for constants */
 211 } stat_info_t;
 212
 213 /**
 214  * a dumper description
 215  */
 216 struct _dumper_t {
 217   dump_graph_FUNC         dump_graph;     /**< handler for dumping an irg */
 218   dump_const_table_FUNC   dump_const_tbl; /**< handler for dumping a const table */
 219   dump_init_FUNC          init;           /**< handler for init */
 220   dump_finish_FUNC        finish;         /**< handler for finish */
 221   FILE                    *f;             /**< the file to dump to */
 222   stat_info_t             *status;        /**< access to the global status */
 223   dumper_t                *next;          /**< link to the next dumper */
 224 };
 225
 226 /**
 227  * helper: get an ir_op from an opcode
 228  */
 229 ir_op *stat_get_op_from_opcode(opcode code);
 230
 231 /**
 232  * An entry in a distribution table
 233  */
 234 typedef struct _distrib_entry_t {
 235   counter_t     cnt;            /**< the current count */
 236   const void    *object;        /**< the object which is counted */
 237 } distrib_entry_t;
 238
 239 /** The type of the hash function for objects in distribution tables. */
 240 typedef unsigned (*distrib_hash_fun)(const void *object);
 241
 242 /**
 243  * The distribution table.
 244  */
 245 typedef struct _distrib_tbl_t {
 246   struct obstack                cnts;           /**< obstack containing the distrib_entry_t entries */
 247   HASH_MAP(distrib_entry_t)     *hash_map;      /**< the hash map containing the distribution */
 248   distrib_hash_fun          hash_func;  /**< the hash function for object in this distribution */
 249   unsigned                      int_dist;       /**< non-zero, if it's a integer distribution */
 250 } distrib_tbl_t;
 251
 252 /* API for distribution tables */
 253
 254 /**
 255  * creates a new distribution table.
 256  *
 257  * @param cmp_func   Compare function for objects in the distribution
 258  * @param hash_func  Hash function for objects in the distribution
 259  */
 260 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
 261
 262 /**
 263  * creates a new distribution table for an integer distribution.
 264  */
 265 distrib_tbl_t *stat_new_int_distrib_tbl(void);
 266
 267 /**
 268  * destroys a distribution table.
 269  */
 270 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
 271
 272 /**
 273  * adds a new object count into the distribution table.
 274  */
 275 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
 276
 277 /**
 278  * adds a new key count into the integer distribution table.
 279  */
 280 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
 281
 282 /**
 283  * calculates the mean value of a distribution.
 284  */
 285 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
 286
 287 /** evaluates each entry of a distribution table. */
 288 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry);
 289
 290 /**
 291  * iterates over all entries in a distribution table
 292  */
 293 void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval);
 294
 295 /**
 296  * update info on Consts.
 297  *
 298  * @param node   The Const node
 299  * @param graph  The graph entry containing the call
 300  */
 301 void stat_update_const(stat_info_t *status, ir_node *node, graph_entry_t *graph);
 302
 303 /**
 304  * clears the const statistics for a new snapshot.
 305  */
 306 void stat_const_clear(stat_info_t *status);
 307
 308 /**
 309  * initialize the Const statistic.
 310  */
 311 void stat_init_const_cnt(stat_info_t *status);
 312
 313 /**
 314  * return a human readable name for an float classification
 315  */
 316 const char *stat_fc_name(float_classify_t classification);
 317
 318 #endif /* _FIRMSTAT_T_H_ */