docu: further improvements

[libfirm] / include / libfirm / firmstat.h

diff --git a/include/libfirm/firmstat.h b/include/libfirm/firmstat.h
index 9151f74..5c01bf3 100644 (file)
--- a/include/libfirm/firmstat.h
+++ b/include/libfirm/firmstat.h
@@ -21,12 +21,12 @@
  * @file
  * @brief   Statistics for Firm.
  * @author  Michael Beck
- * @version $Id$
  */
 #ifndef FIRM_STAT_FIRMSTAT_H
 #define FIRM_STAT_FIRMSTAT_H
 
 #include "irhooks.h"
+#include "begin.h"
 
 /**
  * Statistic options, can be or'ed.
@@ -34,7 +34,7 @@
 enum firmstat_options_t {
        FIRMSTAT_ENABLED         = 0x00000001,    /**< enable statistics */
        FIRMSTAT_PATTERN_ENABLED = 0x00000002,    /**< enable pattern calculation */
-       FIRMSTAT_COUNT_STRONG_OP = 0x00000004,    /**< if set, count Mul/Div/Mod/DivMod by constant */
+       FIRMSTAT_COUNT_STRONG_OP = 0x00000004,    /**< if set, count Mul/Div/Mod by constant */
        FIRMSTAT_COUNT_DAG       = 0x00000008,    /**< if set, count DAG statistics */
        FIRMSTAT_COUNT_DELETED   = 0x00000010,    /**< if set, count deleted graphs */
        FIRMSTAT_COUNT_SELS      = 0x00000020,    /**< if set, count Sel(Sel(..)) differently */
@@ -82,6 +82,8 @@ enum firmstat_optimizations_t {
        FS_OPT_CONV,                              /**< a Conv could be removed */
        FS_OPT_CAST,                              /**< a Cast could be removed */
        FS_OPT_MIN_MAX_EQ,                        /**< Min(a,a) = Max(a,a) = a */
+       FS_OPT_MUX_COMBINE,                       /**< two Mux nodes where combined into one */
+       FS_OPT_MUX_CONV,                          /**< MuxI(sel, 1, 0) = (I)sel */
        FS_OPT_MUX_BOOL,                          /**< Muxb(sel, true, false) = sel */
        FS_OPT_MUX_NOT_BOOL,                      /**< Muxb(sel, false, true) = Not(sel) */
        FS_OPT_MUX_OR_BOOL,                       /**< Muxb(sel, true, x) = Or(sel, x) */
@@ -93,7 +95,6 @@ enum firmstat_optimizations_t {
        FS_OPT_MUX_TRANSFORM,                     /**< Mux(t ==/!= f, t, f) = f/t, Mux(t ==/!= 0, -t, t) = -t/t */
        FS_OPT_MUX_TO_MIN,                        /**< Mux(a < b, a, b) = Min(a,b) */
        FS_OPT_MUX_TO_MAX,                        /**< Mux(a > b, a, b) = Max(a,b) */
-       FS_OPT_MUX_TO_ABS,                        /**< Mux(a > 0, a, -a) = Abs(a) */
        FS_OPT_MUX_TO_BITOP,                      /**< Mux((a & 2^x) ==/!= 0, 2^x, 0) = (a & 2^x) (xor 2^x) */
        FS_OPT_IDEM_UNARY,                        /**< Idempotent unary operation */
        FS_OPT_MINUS_NOT,                         /**< -(~x) = x + 1 */
@@ -101,7 +102,6 @@ enum firmstat_optimizations_t {
        FS_OPT_NOT_PLUS_1,                        /**< ~x + 1 = -x */
        FS_OPT_ADD_X_NOT_X,                       /**< ~x + x = -1 */
        FS_OPT_FP_INV_MUL,                        /**< x / y = x * (1.0/y) */
-       FS_OPT_ABS_MINUS_X,                       /**< Abs(-x) = Abs(x) */
        FS_OPT_CONST_PHI,                         /**< Constant evaluation on Phi */
        FS_OPT_PREDICATE,                         /**< Predicate optimization */
        FS_OPT_DEMORGAN,                          /**< optimization using DeMorgan's law */
@@ -121,6 +121,7 @@ enum firmstat_optimizations_t {
        FS_OPT_COMBO_CF,                          /**< Combo: removed conditional control flow */
        FS_OPT_COMBO_FOLLOWER,                    /**< Combo: replaced a follower */
        FS_OPT_COMBO_CONGRUENT,                   /**< Combo: replaced by congruent */
+       FS_OPT_JUMPTHREADING,                     /**< Jump threading: removed conditional control flow */
        FS_OPT_RTS_ABS,                           /**< RTS optimization: call to abs() replaced */
        FS_OPT_RTS_ALLOCA,                        /**< RTS optimization: call to alloca() replaced */
        FS_OPT_RTS_SQRT,                          /**< RTS optimization: call to sqrt() replaced */
@@ -165,26 +166,41 @@ enum firmstat_optimizations_t {
  * Dump a snapshot of the statistic values.
  * Never called from libFirm should be called from user.
  *
- * @param name   base name of the statistic output file
- * @param phase  a phase name. Prefix will be firmstat-<phase>-
+ * @param fname  base name of the statistic output file
+ * @param phase  a phase name. Prefix will be firmstat-\<phase\>-
  */
-void stat_dump_snapshot(const char *name, const char *phase);
+FIRM_API void stat_dump_snapshot(const char *fname, const char *phase);
+
+/**
+ * Creates an ir_prog pass for stat_dump_snapshot().
+ *
+ * @param name    the name of this pass or NULL
+ * @param fname   base name of the statistic output file
+ * @param phase   a phase name. Prefix will be firmstat-\<phase\>-
+ *
+ * @return  the newly created ir_prog pass
+ */
+FIRM_API ir_prog_pass_t *stat_dump_snapshot_pass(
+       const char *name, const char *fname, const char *phase);
 
 /**
  * initialize the statistics module.
+ * Should be called directly after ir_init
  *
  * @param enable_options  a bitmask containing the statistic options
  */
-void firm_init_stat(unsigned enable_options);
+FIRM_API void firm_init_stat(unsigned enable_options);
 
 /**
  * terminates the statistics module, frees all memory
  */
-void stat_term(void);
+FIRM_API void stat_term(void);
 
 /**
  * returns 1 if statistic module is active, 0 otherwise
  */
-int stat_is_active(void);
+FIRM_API int stat_is_active(void);
+
+#include "end.h"
 
-#endif /* FIRM_STAT_FIRMSTAT_H */
+#endif