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