2 * Copyright (C) 1995-2008 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 Flags to control optimizations.
23 * @author Christian Schaefer, Goetz Lindenmaier, Michael Beck
25 #ifndef FIRM_IR_IRFLAG_H
26 #define FIRM_IR_IRFLAG_H
28 #include "firm_types.h"
33 * @defgroup Optimization Flags
34 * Flags to customize the behavior of libfirm.
36 * There are the following groups of flags:
37 * 1. Optimization flags.
38 * a) There is a flag, 'optimize' to turn on/off all optimizations.
39 * b) There are flags for each individual optimization. Some flags turns
40 * transformations in several algorithms on/off.
41 * 2. Normalization flags.
42 * These flags steer transformations of the ir that improve it, as removing
43 * dump Phi nodes (one predecessor, all predecessors are equal ...), Ids, Tuples ...
45 * a) Flags to steer the level of the information.
46 * b) Flags to steer in which phase information should be dumped.
51 * A container type to load/restore all optimizations
53 typedef unsigned optimization_state_t;
56 * This function enables/disables optimizations globally.
58 * If optimize == 0 no optimizations are performed at all.
59 * Default: optimize == 1.
61 FIRM_API void set_optimize(int value);
62 FIRM_API int get_optimize(void);
64 /** Enables/Disables constant folding optimization.
66 * If opt_constant_folding == 1 perform
67 * constant expression evaluation (2 + 5 ==> 7, 3 < 2 ==> false)
68 * Default: opt_constant_folding == 1.
70 FIRM_API void set_opt_constant_folding(int value);
72 /** Enables/Disables algebraic simplifications.
74 * If opt_algebraic_simplification == 1 perform
75 * - algebraic simplification (a * 0 ==> 0, a or a ==> a)
76 * - simplification of tests ( !(a < b) ==> (a >= b))
77 * Default: opt_algebraic_simplification == 1.
79 FIRM_API void set_opt_algebraic_simplification(int value);
81 /** Enables/Disables common subexpression elimination.
83 * If opt_cse == 1 perform common subexpression elimination.
84 * Default: opt_cse == 1.
86 FIRM_API void set_opt_cse(int value);
88 /** Returns constant folding optimization setting. */
89 FIRM_API int get_opt_cse(void);
91 /** Enables/Disables global constant subexpression elimination.
93 * If opt_global_cse == 1 and opt_cse == 1 perform intra procedure
94 * constant subexpression elimination for floating nodes. Intra
95 * procedure cse gets the graph into state "floating". It is necessary
96 * to run pre/code motion to get the graph back into state "op_pin_state_pinned".
97 * right after a call to local_optimize with global cse turned on.
98 * Default: opt_global_cse == 0.
100 FIRM_API void set_opt_global_cse(int value);
102 /** Restricts the behavior of cast optimization.
104 * If set, downcast are not optimized if they might be
105 * illegal as in (Super)(Sub) (new Super()). Default:
106 * 0 == not suppressed.
108 FIRM_API void set_opt_suppress_downcast_optimization(int value);
109 FIRM_API int get_opt_suppress_downcast_optimization(void);
112 * Enable/Disable Global Null Pointer Test Elimination.
114 * In languages where it is illegal to dereference NULL pointer, doing
115 * so makes the pointer "valid non-null", else the program will stop
118 * This flag should be set for C style languages.
120 FIRM_API void set_opt_global_null_ptr_elimination(int value);
123 * Enable/Disable Automatic construction of Sync nodes during
126 * If this flags is set, sequential non-volatile Loads are automatically
127 * rearranged so that they can be executed in parallel by creating Sync nodes.
129 * This flag should be set for Java style languages.
131 FIRM_API void set_opt_auto_create_sync(int value);
133 /** Enable/Disable Alias analysis.
135 * If enabled, memory disambiguation by alias analysis is used.
137 FIRM_API void set_opt_alias_analysis(int value);
139 /** Enable/Disable closed world assumption.
141 * If enabled, optimizations expect to know the "whole world", i.e. no
142 * external types or callers exist.
143 * This enables some powerful optimizations.
145 FIRM_API void set_opt_closed_world(int value);
148 * Save the current optimization state.
150 FIRM_API void save_optimization_state(optimization_state_t *state);
153 * Restore the current optimization state.
155 FIRM_API void restore_optimization_state(const optimization_state_t *state);
158 * Switches ALL optimizations off.
160 FIRM_API void all_optimizations_off(void);
164 /** @ingroup irverify
165 * @defgroup irverify_flags Flags
166 * Enable/Disable automatic correctness tests
171 * Possible verification modes.
173 typedef enum firm_verification_t {
174 FIRM_VERIFICATION_OFF = 0, /**< do not verify nodes at all */
175 FIRM_VERIFICATION_ON = 1, /**< do node verification and assert on error in debug version */
176 FIRM_VERIFICATION_REPORT = 2, /**< do node verification, but report to stderr only */
177 FIRM_VERIFICATION_ERROR_ONLY = 3 /**< do node verification, but NEVER do assert nor report */
178 } firm_verification_t;
181 * Select verification of IR nodes and types.
183 * Per default the verification is in mode NODE_VERIFICATION_ASSERT.
184 * Turn the verification off during development to check partial
187 FIRM_API void do_node_verification(firm_verification_t mode);