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

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Statistics for Firm. Internal data structures.
  23  * @author  Michael Beck
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_STAT_FIRMSTAT_T_H
  27 #define FIRM_STAT_FIRMSTAT_T_H
  28
  29 #include "firmstat.h"
  30
  31 #include "irop_t.h"
  32 #include "irnode_t.h"
  33 #include "irgraph_t.h"
  34 #include "pset.h"
  35 #include "pdeq.h"
  36 #include "irprog.h"
  37 #include "irgwalk.h"
  38 #include "counter.h"
  39 #include "irhooks.h"
  40
  41 /* some useful macro. */
  42 #define ARR_SIZE(a)   (sizeof(a)/sizeof((a)[0]))
  43
  44 /*
  45  * just be make some things clear :-), the
  46  * poor man "generics"
  47  */
  48 #define HASH_MAP(type) hmap_##type
  49
  50 typedef pset hmap_node_entry_t;
  51 typedef pset hmap_graph_entry_t;
  52 typedef pset hmap_opt_entry_t;
  53 typedef pset hmap_block_entry_t;
  54 typedef pset hmap_be_block_entry_t;
  55 typedef pset hmap_reg_pressure_entry_t;
  56 typedef pset hmap_perm_stat_entry_t;
  57 typedef pset hmap_perm_class_entry_t;
  58 typedef pset hmap_ir_op;
  59 typedef pset hmap_distrib_entry_t;
  60
  61 /**
  62  * An entry in a distribution table
  63  */
  64 typedef struct _distrib_entry_t {
  65         counter_t        cnt;       /**< the current count */
  66         const void *object;   /**< the object which is counted */
  67 } distrib_entry_t;
  68
  69 /** The type of the hash function for objects in distribution tables. */
  70 typedef unsigned (*distrib_hash_fun)(const void *object);
  71
  72 /**
  73  * The distribution table.
  74  */
  75 typedef struct _distrib_tbl_t {
  76         struct obstack            cnts;       /**< obstack containing the distrib_entry_t entries */
  77         HASH_MAP(distrib_entry_t) *hash_map;  /**< the hash map containing the distribution */
  78         distrib_hash_fun          hash_func;  /**< the hash function for object in this distribution */
  79         unsigned                  int_dist;   /**< non-zero, if it's a integer distribution */
  80 } distrib_tbl_t;
  81
  82 /**
  83  * possible address marker values
  84  */
  85 enum adr_marker_t {
  86         MARK_ADDRESS_CALC     = 1,    /**< the node is an address expression */
  87         MARK_REF_ADR          = 2,    /**< the node is referenced by an address expression */
  88         MARK_REF_NON_ADR      = 4,    /**< the node is referenced by a non-address expression */
  89 };
  90
  91 /**
  92  * An entry in the address_mark set
  93  */
  94 typedef struct _address_mark_entry_t {
  95   ir_node  *node;               /**< the node which this entry belongs to, needed for compare */
  96   unsigned mark;                /**< the mark, a bitmask of enum adr_marker_t */
  97 } address_mark_entry_t;
  98
  99 /**
 100  * An entry for ir_nodes, used in ir_graph statistics.
 101  */
 102 typedef struct _node_entry_t {
 103         counter_t   cnt_alive;    /**< amount of nodes in this entry */
 104         counter_t   new_node;     /**< amount of new nodes for this entry */
 105         counter_t   into_Id;      /**< amount of nodes that turned into Id's for this entry */
 106         const ir_op *op;          /**< the op for this entry */
 107 } node_entry_t;
 108
 109 enum leaf_call_state_t {
 110         LCS_UNKNOWN       = 0,      /**< state is unknown yet */
 111         LCS_LEAF_CALL     = 1,      /**< only leaf functions will be called */
 112         LCS_NON_LEAF_CALL = 2,      /**< at least one non-leaf function will be called or indetermined */
 113 };
 114
 115 /**
 116  * Graph counter indexes. The first one are accumulated once, the other are always deleted before an
 117  * snapshot is taken.
 118  */
 119 enum graph_counter_names {
 120         gcnt_acc_walked,               /**< walker walked over the graph, accumulated */
 121         gcnt_acc_walked_blocks,        /**< walker walked over the graph blocks, accumulated */
 122         gcnt_acc_was_inlined,          /**< number of times other graph were inlined, accumulated */
 123         gcnt_acc_got_inlined,          /**< number of times this graph was inlined, accumulated */
 124         gcnt_acc_strength_red,         /**< number of times strength reduction was successful on this graph, accumulated */
 125         gcnt_acc_real_func_call,       /**< number real function call optimization, accumulated */
 126
 127         /* --- non-accumulated values from here */
 128         _gcnt_non_acc,                 /**< first non-accumulated counter */
 129
 130         gcnt_edges = _gcnt_non_acc,    /**< number of DF edges in this graph */
 131         gcnt_all_calls,                /**< number of all calls */
 132         gcnt_call_with_cnst_arg,       /**< number of calls with const args */
 133         gcnt_call_with_all_cnst_arg,   /**< number of calls with all const args */
 134         gcnt_call_with_local_adr,      /**< number of calls with address of local var args */
 135         gcnt_indirect_calls,           /**< number of indirect calls */
 136         gcnt_external_calls,           /**< number of external calls */
 137         gcnt_pure_adr_ops,             /**< number of pure address operation */
 138         gcnt_all_adr_ops,              /**< number of all address operation */
 139         gcnt_global_adr,               /**< number of global load/store addresses. */
 140         gcnt_local_adr,                /**< number of local load/store addresses. */
 141         gcnt_param_adr,                /**< number of parameter load/store addresses. */
 142         gcnt_this_adr,                 /**< number of this load/store addresses. */
 143         gcnt_other_adr,                /**< number of other load/store addresses. */
 144         gcnt_if_conv,                  /**< number of if conversions */
 145
 146         /* --- must be the last enum constant --- */
 147         _gcnt_last = gcnt_if_conv + IF_RESULT_LAST                 /**< number of counters */
 148 };
 149
 150 /**
 151  * An entry for ir_graphs. These numbers are calculated for every IR graph.
 152  */
 153 typedef struct _graph_entry_t {
 154         struct obstack             recalc_cnts;                  /**< obstack containing the counters that are recalculated */
 155         HASH_MAP(node_entry_t)     *opcode_hash;                 /**< hash map containing the opcode counter */
 156         HASH_MAP(block_entry_t)    *block_hash;                  /**< hash map containing the block counter */
 157         HASH_MAP(block_entry_t)    *extbb_hash;                  /**< hash map containing the extended block counter */
 158         HASH_MAP(be_block_entry_t) *be_block_hash;               /**< hash map containing backend block information */
 159         counter_t                  cnt[_gcnt_last];               /**< counter */
 160         unsigned                   num_tail_recursion;           /**< number of tail recursion optimizations */
 161         HASH_MAP(opt_entry_t)      *opt_hash[FS_OPT_MAX];        /**< hash maps containing opcode counter for optimizations */
 162         ir_graph                   *irg;                         /**< the graph of this object */
 163         ir_entity                  *ent;                         /**< the entity of this graph if one exists */
 164         set                        *address_mark;                /**< a set containing the address marks of the nodes */
 165         unsigned                   is_deleted:1;                 /**< set if this irg was deleted */
 166         unsigned                   is_leaf:1;                    /**< set, if this irg is a leaf function */
 167         unsigned                   is_leaf_call:2;               /**< set, if this irg calls only leaf functions */
 168         unsigned                   is_recursive:1;               /**< set, if this irg has recursive calls */
 169         unsigned                   is_chain_call:1;              /**< set, if this irg is a chain call */
 170         unsigned                   is_analyzed:1;                /**< helper: set, if this irg was already analysed */
 171 } graph_entry_t;
 172
 173 /**
 174  * An entry for optimized ir_nodes
 175  */
 176 typedef struct _opt_entry_t {
 177         counter_t   count;    /**< optimization counter */
 178         const ir_op *op;      /**< the op for this entry */
 179 } opt_entry_t;
 180
 181 /**
 182  * An entry for register pressure.
 183  */
 184 typedef struct _reg_pressure_entry_t {
 185         const char *class_name; /**< name of the register class */
 186         int         pressure;   /**< the register pressure for this class */
 187 } reg_pressure_entry_t;
 188
 189 /**
 190  * An entry for permutation statistics.
 191  */
 192 typedef struct _perm_stat_entry_t {
 193         ir_node       *perm;       /**< the perm node */
 194         int            size;       /**< complete size */
 195         int            real_size;  /**< number of pairs with different registers */
 196         int            n_copies;   /**< number of copies created for lowering */
 197         int            n_exchg;    /**< number of exchanges created for lowering */
 198         distrib_tbl_t *cycles;     /**< distribution of cycle lengths */
 199         distrib_tbl_t *chains;     /**< distribution of chain lengths */
 200 } perm_stat_entry_t;
 201
 202 /**
 203  * An entry for permutation statistics per class.
 204  */
 205 typedef struct _perm_class_entry_t {
 206         const char                  *class_name; /**< name of the register class */
 207         int                          n_regs;     /**< number of register in this class */
 208         HASH_MAP(perm_stat_entry_t) *perm_stat;  /**< statistics about all perm nodes of this class */
 209 } perm_class_entry_t;
 210
 211 /**
 212  * An entry for a block or extended block in a ir-graph
 213  */
 214 typedef struct _be_block_entry_t {
 215         long                           block_nr;         /**< block nr */
 216         distrib_tbl_t                  *sched_ready;     /**< distribution of ready nodes per block */
 217         /**< the highest register pressures for this block for each register class */
 218         HASH_MAP(reg_pressure_entry_t) *reg_pressure;
 219         HASH_MAP(perm_class_entry_t)   *perm_class_stat; /**< statistics about perm nodes for each register class */
 220 } be_block_entry_t;
 221
 222 /**
 223  * Block counter indexes. The first one are accumulated once, the other are always deleted before an
 224  * snapshot is taken.
 225  */
 226 enum block_counter_names {
 227         bcnt_nodes,     /**< the counter of nodes in this block */
 228         bcnt_edges,     /**< the counter of edges in this block */
 229         bcnt_in_edges,  /**< the counter of edges incoming from other blocks to this block */
 230         bcnt_out_edges, /**< the counter of edges outgoing from this block to other blocks */
 231         bcnt_phi_data,  /**< the counter of data Phi nodes in this block */
 232
 233         /* --- must be the last enum constant --- */
 234         _bcnt_last      /**< number of counters */
 235 };
 236
 237 /**
 238  * An entry for a block or extended block in a ir-graph
 239  */
 240 typedef struct _block_entry_t {
 241         counter_t       cnt[_bcnt_last];  /**< counter */
 242         long            block_nr;         /**< block nr */
 243         unsigned        is_start:1;       /**< set, if it's the Start block. */
 244         unsigned        is_end:1;         /**< set, if it's the End block. */
 245 } block_entry_t;
 246
 247 /** An entry for an extended block in a ir-graph */
 248 typedef block_entry_t extbb_entry_t;
 249
 250 /**
 251  * Some potential interesting float values
 252  */
 253 typedef enum _float_classify_t {
 254         STAT_FC_0,                /**< the float value 0.0 */
 255         STAT_FC_1,                /**< the float value 1.0 */
 256         STAT_FC_2,                /**< the float value 2.0 */
 257         STAT_FC_0_5,              /**< the float value 0.5 */
 258         STAT_FC_EXACT,            /**< an exact value */
 259         STAT_FC_OTHER,            /**< all other values */
 260         STAT_FC_MAX               /**< last value */
 261 } float_classify_t;
 262
 263 /**
 264  * constant info
 265  */
 266 typedef struct _constant_info_t {
 267         counter_t  int_bits_count[32];  /**< distribution of bit sizes of integer constants */
 268         counter_t  floats[STAT_FC_MAX]; /**< floating point constants */
 269         counter_t  others;              /**< all other constants */
 270 } constant_info_t;
 271
 272 /** forward */
 273 typedef struct _dumper_t dumper_t;
 274
 275 /**
 276  * handler for dumping an IRG
 277  *
 278  * @param dmp   the dumper
 279  * @param entry the IR-graph hash map entry
 280  */
 281 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
 282
 283 /**
 284  * handler for dumper a constant info table
 285  *
 286  * @param dmp   the dumper
 287  */
 288 typedef void (*dump_const_table_FUNC)(dumper_t *dmp, const constant_info_t *tbl);
 289
 290 /**
 291  * dumps the parameter distribution table
 292  */
 293 typedef void (*dump_param_tbl_FUNC)(dumper_t *dmp, const distrib_tbl_t *tbl, graph_entry_t *global);
 294
 295 /**
 296  * dumps the optimizations counter
 297  */
 298 typedef void (*dump_opt_cnt_FUNC)(dumper_t *dumper, const counter_t *tbl, unsigned len);
 299
 300 /**
 301  * handler for dumper init
 302  *
 303  * @param dmp   the dumper
 304  * @param name  name of the file to dump to
 305  */
 306 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
 307
 308 /**
 309  * handler for dumper finish
 310  *
 311  * @param dmp   the dumper
 312  */
 313 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
 314
 315 /**
 316  * statistics info
 317  */
 318 typedef struct _statistic_info_t {
 319         unsigned                stat_options;        /**< statistic options: field must be first */
 320         struct obstack          cnts;                /**< obstack containing the counters that are incremented */
 321         struct obstack          be_data;             /**< obstack containing backend statistics data */
 322         HASH_MAP(graph_entry_t) *irg_hash;           /**< hash map containing the counter for irgs */
 323         HASH_MAP(ir_op)         *ir_op_hash;         /**< hash map containing all ir_ops (accessible by op_codes) */
 324         pdeq                    *wait_q;             /**< wait queue for leaf call decision */
 325         unsigned                recursive:1;         /**< flag for detecting recursive hook calls */
 326         unsigned                in_dead_node_elim:1; /**< flag for dead node elimination runs */
 327         ir_op                   *op_Phi0;            /**< pseudo op for Phi0 */
 328         ir_op                   *op_PhiM;            /**< pseudo op for memory Phi */
 329         ir_op                   *op_ProjM;           /**< pseudo op for memory Proj */
 330         ir_op                   *op_MulC;            /**< pseudo op for multiplication by const */
 331         ir_op                   *op_DivC;            /**< pseudo op for division by const */
 332         ir_op                   *op_ModC;            /**< pseudo op for modulo by const */
 333         ir_op                   *op_DivModC;         /**< pseudo op for DivMod by const */
 334         ir_op                   *op_SelSel;          /**< pseudo op for Sel(Sel) */
 335         ir_op                   *op_SelSelSel;       /**< pseudo op for Sel(Sel(Sel)) */
 336         dumper_t                *dumper;             /**< list of dumper */
 337         int                     reassoc_run;         /**< if set, reassociation is running */
 338         constant_info_t         const_info;          /**< statistic info for constants */
 339         distrib_tbl_t           *dist_param_cnt;     /**< distribution table for call parameters */
 340
 341         counter_t               num_opts[FS_OPT_MAX];/**< count optimizations */
 342 } stat_info_t;
 343
 344 /**
 345  * a dumper description
 346  */
 347 struct _dumper_t {
 348         dump_graph_FUNC         dump_graph;     /**< handler for dumping an irg */
 349         dump_const_table_FUNC   dump_const_tbl; /**< handler for dumping a const table */
 350         dump_param_tbl_FUNC     dump_param_tbl; /**< handler for dumping the Call parameter table */
 351         dump_opt_cnt_FUNC       dump_opt_cnt;   /**< handler for dumping the optimization table. */
 352         dump_init_FUNC          init;           /**< handler for init */
 353         dump_finish_FUNC        finish;         /**< handler for finish */
 354         FILE                    *f;             /**< the file to dump to */
 355         stat_info_t             *status;        /**< access to the global status */
 356         dumper_t                *next;          /**< link to the next dumper */
 357         pset                    *func_map;      /**< pset containing all registered functions */
 358         unsigned                tag;            /**< the id tag of the dumper */
 359 };
 360
 361 /**
 362  * helper: get an ir_op from an opcode
 363  */
 364 ir_op *stat_get_op_from_opcode(ir_opcode code);
 365
 366 /* API for distribution tables */
 367
 368 /**
 369  * creates a new distribution table.
 370  *
 371  * @param cmp_func   Compare function for objects in the distribution
 372  * @param hash_func  Hash function for objects in the distribution
 373  */
 374 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
 375
 376 /**
 377  * creates a new distribution table for an integer distribution.
 378  */
 379 distrib_tbl_t *stat_new_int_distrib_tbl(void);
 380
 381 /**
 382  * destroys a distribution table.
 383  */
 384 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
 385
 386 /**
 387  * adds a new object count into the distribution table.
 388  */
 389 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
 390
 391 /**
 392  * adds a new key count into the integer distribution table.
 393  */
 394 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
 395
 396 /**
 397  * increases object count by one
 398  */
 399 void stat_inc_distrib_tbl(distrib_tbl_t *tbl, const void *object);
 400
 401 /**
 402  * increases key count by one
 403  */
 404 void stat_inc_int_distrib_tbl(distrib_tbl_t *tbl, int key);
 405
 406 /**
 407  * inserts a new object with count 0 into the distribution table
 408  * if object is already present, nothing happens
 409  */
 410 void stat_insert_distrib_tbl(distrib_tbl_t *tbl, const void *object);
 411
 412 /**
 413  * inserts a new key with count 0 into the integer distribution table
 414  * if key is already present, nothing happens
 415  */
 416 void stat_insert_int_distrib_tbl(distrib_tbl_t *tbl, int key);
 417
 418 /**
 419  * returns the sum over all counters in a distribution table
 420  */
 421 int stat_get_count_distrib_tbl(distrib_tbl_t *tbl);
 422
 423 /**
 424  * calculates the mean value of a distribution.
 425  */
 426 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
 427
 428 /**
 429  * calculates the average value of a distribution
 430  */
 431 double stat_calc_avg_distrib_tbl(distrib_tbl_t *tbl);
 432
 433 /** evaluates each entry of a distribution table. */
 434 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry, void *env);
 435
 436 /**
 437  * iterates over all entries in a distribution table
 438  */
 439 void stat_iterate_distrib_tbl(const distrib_tbl_t *tbl, eval_distrib_entry_fun eval, void *env);
 440
 441 /**
 442  * update info on Consts.
 443  *
 444  * @param node   The Const node
 445  * @param graph  The graph entry containing the call
 446  */
 447 void stat_update_const(stat_info_t *status, ir_node *node, graph_entry_t *graph);
 448
 449 /**
 450  * clears the const statistics for a new snapshot.
 451  */
 452 void stat_const_clear(stat_info_t *status);
 453
 454 /**
 455  * initialize the Const statistic.
 456  */
 457 void stat_init_const_cnt(stat_info_t *status);
 458
 459 /**
 460  * return a human readable name for an float classification
 461  */
 462 const char *stat_fc_name(float_classify_t classification);
 463
 464 /**
 465  * Update the register pressure of a block
 466  *
 467  * @param irg        the irg containing the block
 468  * @param block      the block for which the reg pressure should be set
 469  * @param pressure   the pressure
 470  * @param class_name the name of the register class
 471  */
 472 void stat_be_block_regpressure(ir_graph *irg, ir_node *block, int pressure, const char *class_name);
 473
 474 /**
 475  * Update the distribution of ready nodes of a block
 476  *
 477  * @param irg        the irg containing the block
 478  * @param block      the block for which the reg pressure should be set
 479  * @param num_ready  the number of ready nodes
 480  */
 481 void stat_be_block_sched_ready(ir_graph *irg, ir_node *block, int num_ready);
 482
 483 /**
 484  * Update the permutation statistic of a block
 485  *
 486  * @param class_name the name of the register class
 487  * @param perm       the perm node
 488  * @param block      the block containing the perm
 489  * @param size       the size of the perm
 490  * @param real_size  number of pairs with different registers
 491  */
 492 void stat_be_block_stat_perm(const char *class_name, int n_regs, ir_node *perm, ir_node *block,
 493                              int size, int real_size);
 494
 495 /**
 496  * Update the permutation statistic of a single perm
 497  *
 498  * @param class_name the name of the register class
 499  * @param perm       the perm node
 500  * @param block      the block containing the perm
 501  * @param is_chain   1 if chain, 0 if cycle
 502  * @param size       length of the cycle/chain
 503  * @param n_ops      the number of ops representing this cycle/chain after lowering
 504  */
 505 void stat_be_block_stat_permcycle(const char *class_name, ir_node *perm, ir_node *block,
 506                                   int is_chain, int size, int n_ops);
 507
 508 /**
 509  * Register an additional function for all dumper.  This function
 510  * is called in dump_snapshot once for each graph_entry and dumper.
 511  *
 512  * @param func  the dump function to register
 513  */
 514 void stat_register_dumper_func(dump_graph_FUNC func);
 515
 516 #endif /* FIRM_STAT_FIRMSTAT_T_H */