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 "irprog.h"
  24 #include "irgwalk.h"
  25 #include "counter.h"
  26
  27 /*
  28  * just be make some things clear :-), the
  29  * poor man "generics"
  30  */
  31 #define HASH_MAP(type) hmap_##type
  32
  33 typedef pset hmap_node_entry_t;
  34 typedef pset hmap_graph_entry_t;
  35 typedef pset hmap_opt_entry_t;
  36 typedef pset hmap_block_entry_t;
  37 typedef pset hmap_ir_op;
  38 typedef pset hmap_distrib_entry_t;
  39
  40
  41 /**
  42  * An entry for ir_nodes, used in ir_graph statistics.
  43  */
  44 typedef struct _node_entry_t {
  45   counter_t   cnt_alive;                /**< amount of nodes in this entry */
  46   counter_t   new_node;                 /**< amount of new nodes for this entry */
  47   counter_t   into_Id;                  /**< amount of nodes that turned into Id's for this entry */
  48   const ir_op *op;                      /**< the op for this entry */
  49 } node_entry_t;
  50
  51 /**
  52  * An entry for ir_graphs
  53  */
  54 typedef struct _graph_entry_t {
  55   HASH_MAP(node_entry_t)  *opcode_hash;                 /**< hash map containing the opcode counter */
  56   HASH_MAP(block_entry_t) *block_hash;                  /**< hash map countaining the block counter */
  57   counter_t               cnt_walked;                   /**< walker walked over the graph */
  58   counter_t               cnt_walked_blocks;            /**< walker walked over the graph blocks */
  59   counter_t               cnt_was_inlined;              /**< number of times other graph were inlined */
  60   counter_t               cnt_got_inlined;              /**< number of times this graph was inlined */
  61   counter_t               cnt_strength_red;             /**< number of times strength reduction was successful on this graph */
  62   counter_t               cnt_edges;                    /**< number of DF edges in this graph */
  63   HASH_MAP(opt_entry_t)   *opt_hash[STAT_OPT_MAX];      /**< hash maps containing opcode counter for optimizations */
  64   ir_graph                *irg;                         /**< the graph of this object */
  65   entity                  *ent;                         /**< the entity of this graph if one exists */
  66   unsigned                is_deleted:1;                 /**< set if this irg was deleted */
  67   unsigned                is_leaf:1;                    /**< set, if this irg is a leaf function */
  68   unsigned                is_recursive:1;               /**< set, if this irg has recursive calls */
  69   unsigned                is_chain_call:1;              /**< set, if this irg is a chain call */
  70 } graph_entry_t;
  71
  72 /**
  73  * An entry for optimized ir_nodes
  74  */
  75 typedef struct _opt_entry_t {
  76   counter_t   count;                    /**< optimization counter */
  77   const ir_op *op;                      /**< the op for this entry */
  78 } opt_entry_t;
  79
  80 /**
  81  * An entry for a block in a ir-graph
  82  */
  83 typedef struct _block_entry_t {
  84   counter_t  cnt_nodes;                 /**< the counter of nodes in this block */
  85   counter_t  cnt_edges;                 /**< the counter of edges in this block */
  86   counter_t  cnt_in_edges;              /**< the counter of edges incoming from other blocks to this block */
  87   counter_t  cnt_out_edges;             /**< the counter of edges outgoing from this block to other blocks */
  88   long       block_nr;                  /**< block nr */
  89 } block_entry_t;
  90
  91 /** forward */
  92 typedef struct _dumper_t dumper_t;
  93
  94 /**
  95  * handler for dumping an IRG
  96  *
  97  * @param dmp   the dumper
  98  * @param entry the IR-graph hash map entry
  99  */
 100 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
 101
 102 /**
 103  * handler for dumper init
 104  *
 105  * @param dmp   the dumper
 106  * @param name  name of the file to dump to
 107  */
 108 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
 109
 110 /**
 111  * handler for dumper finish
 112  *
 113  * @param dmp   the dumper
 114  */
 115 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
 116
 117
 118 /**
 119  * a dumper description
 120  */
 121 struct _dumper_t {
 122   dump_graph_FUNC         dump_graph;           /**< handler for dumping an irg */
 123   dump_init_FUNC          init;                 /**< handler for init */
 124   dump_finish_FUNC        finish;               /**< handler for finish */
 125   FILE                    *f;                   /**< the file to dump to */
 126   dumper_t                *next;                /**< link to the next dumper */
 127 };
 128
 129 /**
 130  * statistics info
 131  */
 132 typedef struct _statistic_info_t {
 133   struct obstack          cnts;                 /**< obstack containing the counters */
 134   HASH_MAP(graph_entry_t) *irg_hash;            /**< hash map containing the counter for irgs */
 135   HASH_MAP(ir_op)         *ir_op_hash;          /**< hash map containing all ir_ops (accessible by op_codes) */
 136   int                     recursive;            /**< flag for detecting recursive hook calls */
 137   int                     in_dead_node_elim;    /**< set, if dead node elimination runs */
 138   ir_op                   *op_Phi0;             /**< pseudo op for Phi0 */
 139   ir_op                   *op_PhiM;             /**< pseudo op for memory Phi */
 140   ir_op                   *op_MulC;             /**< pseudo op for multiplication by const */
 141   ir_op                   *op_DivC;             /**< pseudo op for division by const */
 142   ir_op                   *op_ModC;             /**< pseudo op for modulo by const */
 143   ir_op                   *op_DivModC;          /**< pseudo op for DivMod by const */
 144   dumper_t                *dumper;              /**< list of dumper */
 145   int                     enable;               /**< if set, statistic is enabled */
 146 } stat_info_t;
 147
 148 /**
 149  * An entry in a distribution table
 150  */
 151 typedef struct _distrib_entry_t {
 152   counter_t     cnt;            /**< the current count */
 153   const void    *object;        /**< the object which is counted */
 154 } distrib_entry_t;
 155
 156 /** The type of the hash function for objects in distribution tables. */
 157 typedef unsigned (*distrib_hash_fun)(const void *object);
 158
 159 /**
 160  * The distribution table.
 161  */
 162 typedef struct _distrib_tbl_t {
 163   struct obstack                cnts;           /**< obstack containing the distrib_entry_t entries */
 164   HASH_MAP(distrib_entry_t)     *hash_map;      /**< the hash map containing the distribution */
 165   distrib_hash_fun              hash_func;      /**< the hash function for object in this distribution */
 166   unsigned                      int_dist;       /**< non-zero, if it's a integer distribution */
 167 } distrib_tbl_t;
 168
 169 /* API for distribution tables */
 170
 171 /**
 172  * creates a new distribution table
 173  *
 174  * @param cmp_func   Compare function for objects in the distribution
 175  * @param hash_func  Hash function for objects in the distribution
 176  */
 177 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
 178
 179 /**
 180  * creates a new distribution table for an integer distribution
 181  */
 182 distrib_tbl_t *stat_new_int_distrib_tbl(void);
 183
 184 /**
 185  * destroys a distribution table
 186  */
 187 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
 188
 189 /**
 190  * adds a new object count into the distribution table
 191  */
 192 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
 193
 194 /**
 195  * adds a new key count into the integer distribution table
 196  */
 197 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
 198
 199 /**
 200  * calculates the mean value of a distribution
 201  */
 202 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
 203
 204 /** evaluates each entry of a distribution table */
 205 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry);
 206
 207 /**
 208  * iterates over all entries in a distribution table
 209  */
 210 void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval);
 211
 212 #endif /* _FIRMSTAT_T_H_ */