nsz Git - libfirm/blob - include/libfirm/firmstat.h

   1 /*
   2  * Copyright (C) 1995-2007 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.
  23  * @author  Michael Beck
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_STAT_FIRMSTAT_H
  27 #define FIRM_STAT_FIRMSTAT_H
  28
  29 #include "irhooks.h"
  30
  31 /**
  32  * Statistic options, can be or'ed.
  33  */
  34 enum firmstat_options_t {
  35         FIRMSTAT_ENABLED         = 0x00000001,    /**< enable statistics */
  36         FIRMSTAT_PATTERN_ENABLED = 0x00000002,    /**< enable pattern calculation */
  37         FIRMSTAT_COUNT_STRONG_OP = 0x00000004,    /**< if set, count Mul/Div/Mod/DivMod by constant */
  38         FIRMSTAT_COUNT_DAG       = 0x00000008,    /**< if set, count DAG statistics */
  39         FIRMSTAT_COUNT_DELETED   = 0x00000010,    /**< if set, count deleted graphs */
  40         FIRMSTAT_COUNT_SELS      = 0x00000020,    /**< if set, count Sel(Sel(..)) differently */
  41         FIRMSTAT_COUNT_CONSTS    = 0x00000040,    /**< if set, count Const statistics */
  42         FIRMSTAT_COUNT_EXTBB     = 0x00000080,    /**< if set, count extended Basic Block statistics */
  43         FIRMSTAT_CSV_OUTPUT      = 0x10000000     /**< CSV output of some mini-statistic */
  44 };
  45
  46 /**
  47  * Additional flags for statistics.
  48  */
  49 enum firmstat_optimizations_t {
  50         FS_OPT_NEUTRAL_0  = HOOK_OPT_LAST,        /**< a op 0 = 0 op a = a */
  51         FS_OPT_NEUTRAL_1,                         /**< a op 1 = 1 op a = a */
  52         FS_OPT_ADD_A_A,                           /**< a + a = a * 2 */
  53         FS_OPT_ADD_A_MINUS_B,                     /**< a + -b = a - b */
  54         FS_OPT_ADD_SUB,                           /**< (a + x) - x = (a - x) + x */
  55         FS_OPT_ADD_MUL_A_X_A,                     /**< a * x + a = a * (x + 1) */
  56         FS_OPT_SUB_0_A,                           /**< 0 - a = -a */
  57         FS_OPT_SUB_MUL_A_X_A,                     /**< a * x - a = a * (x - 1) */
  58         FS_OPT_SUB_SUB_X_Y_Z,                     /**< (x - y) - z = x - (y + z) */
  59         FS_OPT_MUL_MINUS_1,                       /**< a * -1 = -a */
  60         FS_OPT_OR,                                /**< a | a = a | 0 = 0 | a = a */
  61         FS_OPT_AND,                               /**< a & 0b1...1 = 0b1...1 & a =  a & a = a */
  62         FS_OPT_EOR_A_A,                           /**< a ^ a = 0 */
  63         FS_OPT_EOR_TO_NOT_BOOL,                   /**< bool ^ 1 = !bool */
  64         FS_OPT_EOR_TO_NOT,                        /**< x ^ 0b1..1 = ~x */
  65         FS_OPT_NOT_CMP,                           /**< !(a cmp b) = a !cmp b */
  66         FS_OPT_OR_SHFT_TO_ROT,                    /**< (x << c) | (x >> (bits - c)) == Rot(x, c) */
  67         FS_OPT_REASSOC_SHIFT,                     /**< (x SHF c1) SHF c2 = x SHF (c1+c2) */
  68         FS_OPT_SHIFT_AND,                         /**< (a SHF c) AND (b SHF c) = (a AND b) SHF c */
  69         FS_OPT_SHIFT_OR,                          /**< (a SHF c) OR (b SHF c) = (a OR b) SHF c */
  70         FS_OPT_SHIFT_EOR,                         /**< (a SHF c) XOR (b SHF c) = (a XOR b) SHF c */
  71         FS_OPT_CONV,                              /**< a Conv could be removed */
  72         FS_OPT_CAST,                              /**< a Cast could be removed */
  73         FS_OPT_MIN_MAX_EQ,                        /**< Min(a,a) = Max(a,a) = a */
  74         FS_OPT_MUX_C,                             /**< Mux(C, f, t) = C ? t : f */
  75         FS_OPT_MUX_EQ,                            /**< Mux(v, x, x) = x */
  76         FS_OPT_MUX_TRANSFORM,                     /**< Mux(a, b, c) = b OR Mux(a,b, c) = c */
  77         FS_OPT_MUX_TO_MIN,                        /**< Mux(a < b, a, b) = Min(a,b) */
  78         FS_OPT_MUX_TO_MAX,                        /**< Mux(a > b, a, b) = Max(a,b) */
  79         FS_OPT_MUX_TO_ABS,                        /**< Mux(a > b, a, b) = Abs(a,b) */
  80         FS_OPT_MUX_TO_SHR,                        /**< Mux(a > b, a, b) = a >> b */
  81         FS_OPT_IDEM_UNARY,                        /**< Idempotent unary operation */
  82         FS_OPT_MINUS_NOT,                         /**< -(~x) = x + 1 */
  83         FS_OPT_NOT_MINUS_1,                       /**< ~(x - 1) = -x */
  84         FS_OPT_NOT_PLUS_1,                        /**< ~x + 1 = -x */
  85         FS_OPT_CONST_PHI,                         /**< Constant evaluation on Phi */
  86         FS_BE_IA32_LEA,                           /**< Lea was created */
  87         FS_BE_IA32_LOAD_LEA,                      /**< Load merged with a Lea */
  88         FS_BE_IA32_STORE_LEA,                     /**< Store merged with a Lea */
  89         FS_BE_IA32_AM_S,                          /**< Source address mode node created */
  90         FS_BE_IA32_AM_D,                          /**< Destination address mode node created */
  91         FS_BE_IA32_CJMP,                          /**< CJmp created to save a cmp/test */
  92         FS_BE_IA32_2ADDRCPY,                      /**< Copy created due to 2-Addresscode constraints */
  93         FS_BE_IA32_SPILL2ST,                      /**< Created Store for a Spill */
  94         FS_BE_IA32_RELOAD2LD,                     /**< Created Load for a Reload */
  95         FS_BE_IA32_SUB2NEGADD,                    /**< Created Neg-Add for a Sub due to 2-Addresscode constraints */
  96         FS_BE_IA32_LEA2ADD,                       /**< Transformed Lea back into Add */
  97         FS_OPT_MAX
  98 };
  99
 100 /**
 101  * Dump a snapshot of the statistic values.
 102  * Never called from libFirm should be called from user.
 103  *
 104  * @param name   base name of the statistic output file
 105  * @param phase  a phase name. Prefix will be firmstat-<phase>-
 106  */
 107 void stat_dump_snapshot(const char *name, const char *phase);
 108
 109 /**
 110  * initialize the statistics module.
 111  *
 112  * @param enable_options  a bitmask containing the statistic options
 113  */
 114 void firm_init_stat(unsigned enable_options);
 115
 116 /**
 117  * terminates the statistics module, frees all memory
 118  */
 119 void stat_term(void);
 120
 121 /**
 122  * returns 1 if statistic module is active, 0 otherwise
 123  */
 124 int stat_is_active(void);
 125
 126 #endif /* FIRM_STAT_FIRMSTAT_H */