2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Statistics for Firm.
23 * @author Michael Beck
26 #ifndef FIRM_STAT_FIRMSTAT_H
27 #define FIRM_STAT_FIRMSTAT_H
32 * Statistic options, can be or'ed.
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 */
47 * Additional flags for statistics.
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_MINUS_SUB, /**< - (a - b) = b - a */
58 FS_OPT_SUB_MINUS, /**< a - (-b) = a + b */
59 FS_OPT_SUB_MUL_A_X_A, /**< a * x - a = a * (x - 1) */
60 FS_OPT_SUB_SUB_X_Y_Z, /**< (x - y) - z = x - (y + z) */
61 FS_OPT_SUB_C_NOT_X, /**< c - ~a = a + (c+1) */
62 FS_OPT_SUB_TO_ADD, /**< (-a) - b = -(a + b), a - (b - c) = a + (c - b), a - (b * C) -> a + (b * -C) */
63 FS_OPT_MUL_MINUS, /**< (-a) * (b - c) -> a * (c - b) */
64 FS_OPT_MUL_MINUS_1, /**< a * -1 = -a */
65 FS_OPT_MINUS_MUL_C, /**< (-a) * C = a * (-C) */
66 FS_OPT_MUL_MINUS_MINUS, /**< (-a) * (-b) = a * b */
67 FS_OPT_OR, /**< a | a = a | 0 = 0 | a = a */
68 FS_OPT_AND, /**< a & 0b1...1 = 0b1...1 & a = a & a = a */
69 FS_OPT_TO_EOR, /**< (a|b) & ~(a&b) = a^b */
70 FS_OPT_EOR_A_A, /**< a ^ a = 0 */
71 FS_OPT_EOR_TO_NOT_BOOL, /**< bool ^ 1 = !bool */
72 FS_OPT_EOR_TO_NOT, /**< x ^ 0b1..1 = ~x, (a ^ b) & b -> ~a & b */
73 FS_OPT_NOT_CMP, /**< !(a cmp b) = a !cmp b */
74 FS_OPT_OR_SHFT_TO_ROT, /**< (x << c) | (x >> (bits - c)) == Rot(x, c) */
75 FS_OPT_REASSOC_SHIFT, /**< (x SHF c1) SHF c2 = x SHF (c1+c2) */
76 FS_OPT_SHIFT_AND, /**< (a SHF c) AND (b SHF c) = (a AND b) SHF c */
77 FS_OPT_SHIFT_OR, /**< (a SHF c) OR (b SHF c) = (a OR b) SHF c */
78 FS_OPT_SHIFT_EOR, /**< (a SHF c) XOR (b SHF c) = (a XOR b) SHF c */
79 FS_OPT_CONV, /**< a Conv could be removed */
80 FS_OPT_CAST, /**< a Cast could be removed */
81 FS_OPT_MIN_MAX_EQ, /**< Min(a,a) = Max(a,a) = a */
82 FS_OPT_MUX_C, /**< Mux(C, f, t) = C ? t : f */
83 FS_OPT_MUX_EQ, /**< Mux(v, x, x) = x */
84 FS_OPT_MUX_TRANSFORM, /**< Mux(a, b, c) = b OR Mux(a,b, c) = c */
85 FS_OPT_MUX_TO_MIN, /**< Mux(a < b, a, b) = Min(a,b) */
86 FS_OPT_MUX_TO_MAX, /**< Mux(a > b, a, b) = Max(a,b) */
87 FS_OPT_MUX_TO_ABS, /**< Mux(a > b, a, b) = Abs(a,b) */
88 FS_OPT_MUX_TO_SHR, /**< Mux(a > b, a, b) = a >> b */
89 FS_OPT_IDEM_UNARY, /**< Idempotent unary operation */
90 FS_OPT_MINUS_NOT, /**< -(~x) = x + 1 */
91 FS_OPT_NOT_MINUS_1, /**< ~(x - 1) = -x */
92 FS_OPT_NOT_PLUS_1, /**< ~x + 1 = -x */
93 FS_OPT_ADD_X_NOT_X, /**< ~x + x = -1 */
94 FS_OPT_FP_INV_MUL, /**< x / y = x * (1.0/y) */
95 FS_OPT_CONST_PHI, /**< Constant evaluation on Phi */
96 FS_OPT_PREDICATE, /**< Predicate optimization */
97 FS_OPT_DEMORGAN, /**< optimization using DeMorgan's law */
98 FS_OPT_CMP_OP_OP, /**< CMP optimization: Cmp(OP(x), OP(y)) = Cmp(x, y) */
99 FS_OPT_CMP_OP_C, /**< CMP optimization: Cmp(OP(x), c1) = Cmp(x, c2) */
100 FS_OPT_CMP_CONV_CONV, /**< CMP optimization: Cmp(Conv(x), Conv(y)) = Cmp(x, y) */
101 FS_OPT_CMP_CONV, /**< CMP optimization: Cmp(Conv(x), Conv(y)) = Cmp(Conv(x), y) */
102 FS_OPT_CMP_TO_BOOL, /**< CMP optimization: Cmp(x, y) = BoolOP(x, y) */
103 FS_OPT_CMP_CNST_MAGN, /**< CMP optimization: reduced magnitude of a const */
104 FS_OPT_CMP_SHF_TO_AND, /**< CMP optimization: transformed shift into And */
105 FS_OPT_CMP_MOD_TO_AND, /**< CMP optimization: transformed Mod into And */
106 FS_BE_IA32_LEA, /**< Lea was created */
107 FS_BE_IA32_LOAD_LEA, /**< Load merged with a Lea */
108 FS_BE_IA32_STORE_LEA, /**< Store merged with a Lea */
109 FS_BE_IA32_AM_S, /**< Source address mode node created */
110 FS_BE_IA32_AM_D, /**< Destination address mode node created */
111 FS_BE_IA32_CJMP, /**< CJmp created to save a cmp/test */
112 FS_BE_IA32_2ADDRCPY, /**< Copy created due to 2-Addresscode constraints */
113 FS_BE_IA32_SPILL2ST, /**< Created Store for a Spill */
114 FS_BE_IA32_RELOAD2LD, /**< Created Load for a Reload */
115 FS_BE_IA32_SUB2NEGADD, /**< Created Neg-Add for a Sub due to 2-Addresscode constraints */
116 FS_BE_IA32_LEA2ADD, /**< Transformed Lea back into Add */
121 * Dump a snapshot of the statistic values.
122 * Never called from libFirm should be called from user.
124 * @param name base name of the statistic output file
125 * @param phase a phase name. Prefix will be firmstat-<phase>-
127 void stat_dump_snapshot(const char *name, const char *phase);
130 * initialize the statistics module.
132 * @param enable_options a bitmask containing the statistic options
134 void firm_init_stat(unsigned enable_options);
137 * terminates the statistics module, frees all memory
139 void stat_term(void);
142 * returns 1 if statistic module is active, 0 otherwise
144 int stat_is_active(void);
146 #endif /* FIRM_STAT_FIRMSTAT_H */