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