Fixed typos, improved docu

[libfirm] / ir / stat / firmstat_t.h

diff --git a/ir/stat/firmstat_t.h b/ir/stat/firmstat_t.h
index 5ba3a9a..ac51b8d 100644 (file)
--- a/ir/stat/firmstat_t.h
+++ b/ir/stat/firmstat_t.h
@@ -25,7 +25,6 @@
 #include "irgwalk.h"
 #include "counter.h"
 #include "irhooks.h"
-#include "ident.h"
 
 /* some useful macro. */
 #define ARR_SIZE(a)   (sizeof(a)/sizeof((a)[0]))
@@ -146,8 +145,8 @@ typedef struct _opt_entry_t {
  * An entry for register pressure.
  */
 typedef struct _reg_pressure_entry_t {
-  ident *id_name;    /**< name of the register class */
-  int    pressure;   /**< the register pressure for this class */
+  const char *class_name; /**< name of the register class */
+  int         pressure;   /**< the register pressure for this class */
 } reg_pressure_entry_t;
 
 /**
@@ -167,7 +166,7 @@ typedef struct _perm_stat_entry_t {
  * An entry for permutation statistics per class.
  */
 typedef struct _perm_class_entry_t {
-  ident                       *id_name;    /**< name of the register class */
+  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;
@@ -290,6 +289,8 @@ 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 */
 };
 
 /**
@@ -327,6 +328,33 @@ 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.
  */
@@ -368,4 +396,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_ */