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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/stat/firmstat.h
   4  * Purpose:     Statistics for Firm.
   5  * Author:      Michael Beck
   6  * Created:
   7  * CVS-ID:      $Id$
   8  * Copyright:   (c) 2004 Universität Karlsruhe
   9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  10  */
  11 #ifndef _FIRMSTAT_H_
  12 #define _FIRMSTAT_H_
  13
  14 /**
  15  * @file firmstat.h
  16  */
  17 #include "irhooks.h"
  18
  19 /**
  20  * Statistic options, can be or'ed.
  21  */
  22 enum firmstat_options_t {
  23   FIRMSTAT_ENABLED         = 0x00000001,    /**< enable statistics */
  24   FIRMSTAT_PATTERN_ENABLED = 0x00000002,    /**< enable pattern calculation */
  25   FIRMSTAT_COUNT_STRONG_OP = 0x00000004,    /**< if set, count Mul/Div/Mod/DivMod by constant */
  26   FIRMSTAT_COUNT_DAG       = 0x00000008,    /**< if set, count DAG statistics */
  27   FIRMSTAT_COUNT_DELETED   = 0x00000010,    /**< if set, count deleted graphs */
  28   FIRMSTAT_COUNT_SELS      = 0x00000020,    /**< if set, count Sel(Sel(..)) differently */
  29   FIRMSTAT_COUNT_CONSTS    = 0x00000040,    /**< if set, count Const statistics */
  30   FIRMSTAT_COUNT_EXTBB     = 0x00000080,    /**< if set, count extended Basic Block statistics */
  31   FIRMSTAT_CSV_OUTPUT      = 0x10000000     /**< CSV output of some mini-statistic */
  32 };
  33
  34 /**
  35  * Additional flags for statistics.
  36  */
  37 enum firmstat_optimizations_t {
  38   FS_OPT_NEUTRAL_0  = HOOK_OPT_LAST,        /**< a op 0 = 0 op a = a */
  39   FS_OPT_NEUTRAL_1,                         /**< a op 1 = 1 op a = a */
  40   FS_OPT_ADD_A_A,                           /**< a + a = a * 2 */
  41   FS_OPT_ADD_A_MINUS_B,                     /**< a + -b = a - b */
  42   FS_OPT_ADD_SUB,                           /**< (a + x) - x = (a - x) + x */
  43   FS_OPT_ADD_MUL_A_X_A,                     /**< a * x + a = a * (x + 1) */
  44   FS_OPT_SUB_0_A,                           /**< 0 - a = -a */
  45   FS_OPT_SUB_MUL_A_X_A,                     /**< a * x - a = a * (x - 1) */
  46   FS_OPT_SUB_SUB_X_Y_Z,                     /**< (x - y) - z = x - (y + z) */
  47   FS_OPT_MUL_MINUS_1,                       /**< a * -1 = -a */
  48   FS_OPT_OR,                                /**< a | a = a | 0 = 0 | a = a */
  49   FS_OPT_AND,                               /**< a & 0b1...1 = 0b1...1 & a =  a & a = a */
  50   FS_OPT_EOR_A_A,                           /**< a ^ a = 0 */
  51   FS_OPT_EOR_TO_NOT_BOOL,                   /**< bool ^ 1 = !bool */
  52   FS_OPT_EOR_TO_NOT,                        /**< x ^ 0b1..1 = ~x */
  53   FS_OPT_NOT_CMP,                           /**< !(a cmp b) = a !cmp b */
  54   FS_OPT_OR_SHFT_TO_ROT,                    /**< (x << c) | (x >> (bits - c)) == Rot(x, c) */
  55   FS_OPT_REASSOC_SHIFT,                     /**< (x SHF c1) SHF c2 = x SHF (c1+c2) */
  56   FS_OPT_CONV,                              /**< a Conv could be removed */
  57   FS_OPT_CAST,                              /**< a Cast could be removed */
  58   FS_OPT_MIN_MAX_EQ,                        /**< Min(a,a) = Max(a,a) = a */
  59   FS_OPT_MUX_C,                             /**< Mux(C, f, t) = C ? t : f */
  60   FS_OPT_MUX_EQ,                            /**< Mux(v, x, x) = x */
  61   FS_OPT_MUX_TRANSFORM,                     /**< Mux(a, b, c) = b OR Mux(a,b, c) = c */
  62   FS_OPT_MUX_TO_MIN,                        /**< Mux(a < b, a, b) = Min(a,b) */
  63   FS_OPT_MUX_TO_MAX,                        /**< Mux(a > b, a, b) = Max(a,b) */
  64   FS_OPT_MUX_TO_ABS,                        /**< Mux(a > b, a, b) = Abs(a,b) */
  65   FS_OPT_MUX_TO_SHR,                        /**< Mux(a > b, a, b) = a >> b */
  66   FS_BE_IA32_LEA,                           /**< Lea was created */
  67   FS_BE_IA32_LOAD_LEA,                      /**< Load merged with a Lea */
  68   FS_BE_IA32_STORE_LEA,                     /**< Store merged with a Lea */
  69   FS_BE_IA32_AM_S,                          /**< Source address mode node created */
  70   FS_BE_IA32_AM_D,                          /**< Destination address mode node created */
  71   FS_BE_IA32_CJMP,                          /**< CJmp created to save a cmp/test */
  72   FS_BE_IA32_2ADDRCPY,                      /**< Copy created due to 2-Addresscode constraints */
  73   FS_BE_IA32_SPILL2ST,                      /**< Created Store for a Spill */
  74   FS_BE_IA32_RELOAD2LD,                     /**< Created Load for a Reload */
  75   FS_BE_IA32_SUB2NEGADD,                    /**< Created Neg-Add for a Sub due to 2-Addresscode constraints */
  76   FS_BE_IA32_LEA2ADD,                       /**< Transformed Lea back into Add */
  77   FS_OPT_MAX
  78 };
  79
  80 /**
  81  * Dump a snapshot of the statistic values.
  82  * Never called from libFirm should be called from user.
  83  *
  84  * @param name   base name of the statistic output file
  85  * @param phase  a phase name. Prefix will be firmstat-<phase>-
  86  */
  87 void stat_dump_snapshot(const char *name, const char *phase);
  88
  89 /**
  90  * initialize the statistics module.
  91  *
  92  * @param enable_options  a bitmask containing the statistic options
  93  */
  94 void firm_init_stat(unsigned enable_options);
  95
  96 /**
  97  * terminates the statistics module, frees all memory
  98  */
  99 void stat_term(void);
 100
 101 /**
 102  * returns 1 if statistic module is active, 0 otherwise
 103  */
 104 int stat_is_active(void);
 105
 106
 107 #endif /* _FIRMSTAT_H_ */