doxygen comment updated
[libfirm] / ir / stat / firmstat_t.h
index da1d282..5bed7fe 100644 (file)
@@ -39,9 +39,34 @@ typedef pset hmap_node_entry_t;
 typedef pset hmap_graph_entry_t;
 typedef pset hmap_opt_entry_t;
 typedef pset hmap_block_entry_t;
+typedef pset hmap_be_block_entry_t;
+typedef pset hmap_reg_pressure_entry_t;
+typedef pset hmap_perm_stat_entry_t;
+typedef pset hmap_perm_class_entry_t;
 typedef pset hmap_ir_op;
 typedef pset hmap_distrib_entry_t;
 
+/**
+ * An entry in a distribution table
+ */
+typedef struct _distrib_entry_t {
+  counter_t     cnt;       /**< the current count */
+  const void *object;   /**< the object which is counted */
+} distrib_entry_t;
+
+/** The type of the hash function for objects in distribution tables. */
+typedef unsigned (*distrib_hash_fun)(const void *object);
+
+/**
+ * The distribution table.
+ */
+typedef struct _distrib_tbl_t {
+  struct obstack               cnts;       /**< obstack containing the distrib_entry_t entries */
+  HASH_MAP(distrib_entry_t)    *hash_map;  /**< the hash map containing the distribution */
+  distrib_hash_fun          hash_func;  /**< the hash function for object in this distribution */
+  unsigned                  int_dist;   /**< non-zero, if it's a integer distribution */
+} distrib_tbl_t;
+
 /**
  * possible address marker values
  */
@@ -75,34 +100,59 @@ enum leaf_call_state_t {
   LCS_NON_LEAF_CALL = 2,      /**< at least one non-leaf function will be called or indetermined */
 };
 
+/**
+ * Graph counter indexes. The first one are accumulated once, the other are always deleted before an
+ * snapshot is taken.
+ */
+enum graph_counter_names {
+  gcnt_acc_walked,               /**< walker walked over the graph, accumulated */
+  gcnt_acc_walked_blocks,        /**< walker walked over the graph blocks, accumulated */
+  gcnt_acc_was_inlined,          /**< number of times other graph were inlined, accumulated */
+  gcnt_acc_got_inlined,          /**< number of times this graph was inlined, accumulated */
+  gcnt_acc_strength_red,         /**< number of times strength reduction was successful on this graph, accumulated */
+  gcnt_acc_real_func_call,       /**< number real function call optimization, accumulated */
+
+  /* --- non-accumulated values from here */
+  _gcnt_non_acc,                 /**< first non-accumulated counter */
+
+  gcnt_edges = _gcnt_non_acc,    /**< number of DF edges in this graph */
+  gcnt_all_calls,                /**< number of all calls */
+  gcnt_call_with_cnst_arg,       /**< number of calls with const args */
+  gcnt_indirect_calls,           /**< number of indirect calls */
+  gcnt_pure_adr_ops,             /**< number of pure address operation */
+  gcnt_all_adr_ops,              /**< number of all address operation */
+  gcnt_global_adr,               /**< number of global load/store addresses. */
+  gcnt_local_adr,                /**< number of local load/store addresses. */
+  gcnt_param_adr,                /**< number of parameter load/store addresses. */
+  gcnt_this_adr,                 /**< number of this load/store addresses. */
+  gcnt_other_adr,                /**< number of other load/store addresses. */
+  gcnt_if_conv,                  /**< number of if conversions */
+
+  /* --- must be the last enum constant --- */
+  _gcnt_last = gcnt_if_conv + IF_RESULT_LAST                 /**< number of counters */
+};
+
 /**
  * An entry for ir_graphs. These numbers are calculated for every IR graph.
  */
 typedef struct _graph_entry_t {
-  HASH_MAP(node_entry_t)  *opcode_hash;                 /**< hash map containing the opcode counter */
-  HASH_MAP(block_entry_t) *block_hash;                  /**< hash map containing the block counter */
-  counter_t               cnt_walked;                    /**< walker walked over the graph */
-  counter_t               cnt_walked_blocks;            /**< walker walked over the graph blocks */
-  counter_t               cnt_was_inlined;              /**< number of times other graph were inlined */
-  counter_t               cnt_got_inlined;              /**< number of times this graph was inlined */
-  counter_t               cnt_strength_red;             /**< number of times strength reduction was successful on this graph */
-  counter_t               cnt_edges;                    /**< number of DF edges in this graph */
-  counter_t               cnt_all_calls;                /**< number of all calls */
-  counter_t               cnt_call_with_cnst_arg;       /**< number of calls with const args */
-  counter_t               cnt_indirect_calls;           /**< number of indirect calls */
-  counter_t               cnt_if_conv[IF_RESULT_LAST];  /**< number of if conversions */
-  counter_t               cnt_real_func_call;           /**< number real function call optimization */
-  unsigned                num_tail_recursion;           /**< number of tail recursion optimizations */
-  HASH_MAP(opt_entry_t)   *opt_hash[FS_OPT_MAX];        /**< hash maps containing opcode counter for optimizations */
-  ir_graph                *irg;                         /**< the graph of this object */
-  entity                  *ent;                         /**< the entity of this graph if one exists */
-  set                     *address_mark;                /**< a set containing the address marks of the nodes */
-  unsigned                is_deleted:1;                 /**< set if this irg was deleted */
-  unsigned                is_leaf:1;                    /**< set, if this irg is a leaf function */
-  unsigned                is_leaf_call:2;               /**< set, if this irg calls only leaf functions */
-  unsigned                is_recursive:1;               /**< set, if this irg has recursive calls */
-  unsigned                is_chain_call:1;              /**< set, if this irg is a chain call */
-  unsigned                is_analyzed:1;                /**< helper: set, if this irg was already analysed */
+  struct obstack             recalc_cnts;                  /**< obstack containing the counters that are recalculated */
+  HASH_MAP(node_entry_t)     *opcode_hash;                 /**< hash map containing the opcode counter */
+  HASH_MAP(block_entry_t)    *block_hash;                  /**< hash map containing the block counter */
+  HASH_MAP(block_entry_t)    *extbb_hash;                  /**< hash map containing the extended block counter */
+  HASH_MAP(be_block_entry_t) *be_block_hash;               /**< hash map containing backend block information */
+  counter_t                  cnt[_gcnt_last];               /**< counter */
+  unsigned                   num_tail_recursion;           /**< number of tail recursion optimizations */
+  HASH_MAP(opt_entry_t)      *opt_hash[FS_OPT_MAX];        /**< hash maps containing opcode counter for optimizations */
+  ir_graph                   *irg;                         /**< the graph of this object */
+  ir_entity                  *ent;                         /**< the entity of this graph if one exists */
+  set                        *address_mark;                /**< a set containing the address marks of the nodes */
+  unsigned                   is_deleted:1;                 /**< set if this irg was deleted */
+  unsigned                   is_leaf:1;                    /**< set, if this irg is a leaf function */
+  unsigned                   is_leaf_call:2;               /**< set, if this irg calls only leaf functions */
+  unsigned                   is_recursive:1;               /**< set, if this irg has recursive calls */
+  unsigned                   is_chain_call:1;              /**< set, if this irg is a chain call */
+  unsigned                   is_analyzed:1;                /**< helper: set, if this irg was already analysed */
 } graph_entry_t;
 
 /**
@@ -114,17 +164,72 @@ typedef struct _opt_entry_t {
 } opt_entry_t;
 
 /**
- * An entry for a block in a ir-graph
+ * An entry for register pressure.
+ */
+typedef struct _reg_pressure_entry_t {
+  const char *class_name; /**< name of the register class */
+  int         pressure;   /**< the register pressure for this class */
+} reg_pressure_entry_t;
+
+/**
+ * An entry for permutation statistics.
+ */
+typedef struct _perm_stat_entry_t {
+  ir_node       *perm;       /**< the perm node */
+  int            size;       /**< complete size */
+  int            real_size;  /**< number of pairs with different registers */
+  int            n_copies;   /**< number of copies created for lowering */
+  int            n_exchg;    /**< number of exchanges created for lowering */
+  distrib_tbl_t *cycles;     /**< distribution of cycle lengths */
+  distrib_tbl_t *chains;     /**< distribution of chain lengths */
+} perm_stat_entry_t;
+
+/**
+ * An entry for permutation statistics per class.
+ */
+typedef struct _perm_class_entry_t {
+  const char                  *class_name; /**< name of the register class */
+  int                          n_regs;     /**< number of register in this class */
+  HASH_MAP(perm_stat_entry_t) *perm_stat;  /**< statistics about all perm nodes of this class */
+} perm_class_entry_t;
+
+/**
+ * An entry for a block or extended block in a ir-graph
+ */
+typedef struct _be_block_entry_t {
+  long                           block_nr;         /**< block nr */
+  distrib_tbl_t                  *sched_ready;     /**< distribution of ready nodes per block */
+  /**< the highest register pressures for this block for each register class */
+  HASH_MAP(reg_pressure_entry_t) *reg_pressure;
+  HASH_MAP(perm_class_entry_t)   *perm_class_stat; /**< statistics about perm nodes for each register class */
+} be_block_entry_t;
+
+/**
+ * Block counter indexes. The first one are accumulated once, the other are always deleted before an
+ * snapshot is taken.
+ */
+enum block_counter_names {
+  bcnt_nodes,     /**< the counter of nodes in this block */
+  bcnt_edges,     /**< the counter of edges in this block */
+  bcnt_in_edges,  /**< the counter of edges incoming from other blocks to this block */
+  bcnt_out_edges, /**< the counter of edges outgoing from this block to other blocks */
+  bcnt_phi_data,  /**< the counter of data Phi nodes in this block */
+
+  /* --- must be the last enum constant --- */
+  _bcnt_last      /**< number of counters */
+};
+
+/**
+ * An entry for a block or extended block in a ir-graph
  */
 typedef struct _block_entry_t {
-  counter_t  cnt_nodes;     /**< the counter of nodes in this block */
-  counter_t  cnt_edges;     /**< the counter of edges in this block */
-  counter_t  cnt_in_edges;  /**< the counter of edges incoming from other blocks to this block */
-  counter_t  cnt_out_edges; /**< the counter of edges outgoing from this block to other blocks */
-  counter_t  cnt_phi_data;  /**< the counter of data Phi nodes in this block */
-  long       block_nr;      /**< block nr */
+  counter_t       cnt[_bcnt_last];  /**< counter */
+  long            block_nr;         /**< block nr */
 } block_entry_t;
 
+/** An entry for an extended block in a ir-graph */
+typedef block_entry_t extbb_entry_t;
+
 /**
  * Some potential interesting float values
  */
@@ -184,8 +289,9 @@ typedef void (*dump_finish_FUNC)(dumper_t *dmp);
  * statistics info
  */
 typedef struct _statistic_info_t {
-  int                     stat_options;          /**< statistic options: must be first */
-  struct obstack          cnts;           /**< obstack containing the counters */
+  unsigned                stat_options;          /**< statistic options: field must be first */
+  struct obstack          cnts;           /**< obstack containing the counters that are incremented */
+  struct obstack          be_data;        /**< obstack containing backend statistics data */
   HASH_MAP(graph_entry_t) *irg_hash;      /**< hash map containing the counter for irgs */
   HASH_MAP(ir_op)         *ir_op_hash;    /**< hash map containing all ir_ops (accessible by op_codes) */
   pdeq                    *wait_q;        /**< wait queue for leaf call decision */
@@ -216,33 +322,14 @@ struct _dumper_t {
   FILE                    *f;             /**< the file to dump to */
   stat_info_t             *status;        /**< access to the global status */
   dumper_t                *next;          /**< link to the next dumper */
+  pset                    *func_map;      /**< pset containing all registered functions */
+  unsigned                tag;            /**< the id tag of the dumper */
 };
 
 /**
  * helper: get an ir_op from an opcode
  */
-ir_op *stat_get_op_from_opcode(opcode code);
-
-/**
- * An entry in a distribution table
- */
-typedef struct _distrib_entry_t {
-  counter_t    cnt;            /**< the current count */
-  const void   *object;        /**< the object which is counted */
-} distrib_entry_t;
-
-/** The type of the hash function for objects in distribution tables. */
-typedef unsigned (*distrib_hash_fun)(const void *object);
-
-/**
- * The distribution table.
- */
-typedef struct _distrib_tbl_t {
-  struct obstack               cnts;           /**< obstack containing the distrib_entry_t entries */
-  HASH_MAP(distrib_entry_t)    *hash_map;      /**< the hash map containing the distribution */
-  distrib_hash_fun          hash_func; /**< the hash function for object in this distribution */
-  unsigned                     int_dist;       /**< non-zero, if it's a integer distribution */
-} distrib_tbl_t;
+ir_op *stat_get_op_from_opcode(ir_opcode code);
 
 /* API for distribution tables */
 
@@ -274,18 +361,50 @@ void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_
  */
 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
 
+/**
+ * increases object count by one
+ */
+void stat_inc_distrib_tbl(distrib_tbl_t *tbl, const void *object);
+
+/**
+ * increases key count by one
+ */
+void stat_inc_int_distrib_tbl(distrib_tbl_t *tbl, int key);
+
+/**
+ * inserts a new object with count 0 into the distribution table
+ * if object is already present, nothing happens
+ */
+void stat_insert_distrib_tbl(distrib_tbl_t *tbl, const void *object);
+
+/**
+ * inserts a new key with count 0 into the integer distribution table
+ * if key is already present, nothing happens
+ */
+void stat_insert_int_distrib_tbl(distrib_tbl_t *tbl, int key);
+
+/**
+ * returns the sum over all counters in a distribution table
+ */
+int stat_get_count_distrib_tbl(distrib_tbl_t *tbl);
+
 /**
  * calculates the mean value of a distribution.
  */
 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
 
+/**
+ * calculates the average value of a distribution
+ */
+double stat_calc_avg_distrib_tbl(distrib_tbl_t *tbl);
+
 /** evaluates each entry of a distribution table. */
-typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry);
+typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry, void *env);
 
 /**
  * iterates over all entries in a distribution table
  */
-void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval);
+void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval, void *env);
 
 /**
  * update info on Consts.
@@ -310,4 +429,56 @@ void stat_init_const_cnt(stat_info_t *status);
  */
 const char *stat_fc_name(float_classify_t classification);
 
+/**
+ * Update the register pressure of a block
+ *
+ * @param irg        the irg containing the block
+ * @param block      the block for which the reg pressure should be set
+ * @param pressure   the pressure
+ * @param class_name the name of the register class
+ */
+void stat_be_block_regpressure(ir_graph *irg, ir_node *block, int pressure, const char *class_name);
+
+/**
+ * Update the distribution of ready nodes of a block
+ *
+ * @param irg        the irg containing the block
+ * @param block      the block for which the reg pressure should be set
+ * @param num_ready  the number of ready nodes
+ */
+void stat_be_block_sched_ready(ir_graph *irg, ir_node *block, int num_ready);
+
+/**
+ * Update the permutation statistic of a block
+ *
+ * @param class_name the name of the register class
+ * @param perm       the perm node
+ * @param block      the block containing the perm
+ * @param size       the size of the perm
+ * @param real_size  number of pairs with different registers
+ */
+void stat_be_block_stat_perm(const char *class_name, int n_regs, ir_node *perm, ir_node *block,
+                             int size, int real_size);
+
+/**
+ * Update the permutation statistic of a single perm
+ *
+ * @param class_name the name of the register class
+ * @param perm       the perm node
+ * @param block      the block containing the perm
+ * @param is_chain   1 if chain, 0 if cycle
+ * @param size       length of the cycle/chain
+ * @param n_ops      the number of ops representing this cycle/chain after lowering
+ */
+void stat_be_block_stat_permcycle(const char *class_name, ir_node *perm, ir_node *block,
+                                  int is_chain, int size, int n_ops);
+
+/**
+ * Register an additional function for all dumper.  This function
+ * is called in dump_snapshot once for each graph_entry and dumper.
+ *
+ * @param func  the dump function to register
+ */
+void stat_register_dumper_func(dump_graph_FUNC func);
+
 #endif /* _FIRMSTAT_T_H_ */