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

   1 /*
   2  * Copyright (C) 1995-2008 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   Flags to control optimizations.
  23  * @author  Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  * @version $Id$
  25  * @brief
  26  * Flags to customize the behavior of libfirm.
  27  *
  28  * There are the following groups of flags:
  29  * 1. Optimization flags.
  30  *    a)  There is a flag, 'optimize' to turn on/off all optimizations.
  31  *    b)  There are flags for each individual optimization.  Some flags turns
  32  *        transformations in several algorithms on/off.
  33  * 2. Normalization flags.
  34  *    These flags steer transformations of the ir that improve it, as removing
  35  *    dump Phi nodes (one predecessor, all predecessors are equal ...), Ids, Tuples ...
  36  * 3. Verbosity flags.
  37  *    a) Flags to steer the level of the information.
  38  *    b) Flags to steer in which phase information should be dumped.
  39  * 4. Verification flag
  40  *    This one controls the behavior of node and type verifications
  41  */
  42 #ifndef FIRM_IR_IRFLAG_H
  43 #define FIRM_IR_IRFLAG_H
  44
  45 #include "firm_types.h"
  46 #include "begin.h"
  47
  48 /**
  49  * A container type to load/restore all optimizations
  50  */
  51 typedef unsigned optimization_state_t;
  52
  53 /**
  54  * This function enables/disables optimizations globally.
  55  *
  56  * If optimize == 0 no optimizations are performed at all.
  57  * Default: optimize == 1.
  58  */
  59 FIRM_API void set_optimize(int value);
  60 FIRM_API int get_optimize(void);
  61
  62 /** Enables/Disables constant folding optimization.
  63  *
  64  *  If opt_constant_folding == 1 perform
  65  *  constant expression evaluation (2 + 5 ==> 7, 3 < 2 ==> false)
  66  * Default: opt_constant_folding == 1.
  67  */
  68 FIRM_API void set_opt_constant_folding(int value);
  69
  70 /** Enables/Disables algebraic simplifications.
  71  *
  72  *  If opt_algebraic_simplification == 1 perform
  73  *  - algebraic simplification  (a * 0 ==> 0, a or a ==> a)
  74  *  - simplification of tests   ( !(a < b) ==> (a >= b))
  75  * Default: opt_algebraic_simplification == 1.
  76  */
  77 FIRM_API void set_opt_algebraic_simplification(int value);
  78
  79 /** Enables/Disables common subexpression elimination.
  80  *
  81  * If opt_cse == 1 perform common subexpression elimination.
  82  * Default: opt_cse == 1.
  83  */
  84 FIRM_API void set_opt_cse(int value);
  85
  86 /** Returns constant folding optimization setting. */
  87 FIRM_API int get_opt_cse(void);
  88
  89 /** Enables/Disables global constant subexpression elimination.
  90  *
  91  * If opt_global_cse == 1 and opt_cse == 1 perform intra procedure
  92  * constant subexpression elimination for floating nodes.  Intra
  93  * procedure cse gets the graph into state "floating".  It is necessary
  94  * to run pre/code motion to get the graph back into state "op_pin_state_pinned".
  95  * right after a call to local_optimize with global cse turned on.
  96  * Default: opt_global_cse == 0.
  97  */
  98 FIRM_API void set_opt_global_cse(int value);
  99
 100 /** Enables/Disables unreachable code elimination.
 101  *
 102  * If set, evaluate conditions of conditional branch and replace the
 103  * branch with a Jmp/Bad Tuple.
 104  *
 105  * If opt_unreachable_code == 1 replace nodes (except Block,
 106  * Phi and Tuple) with a Bad predecessor by the Bad node.
 107  * Default: opt_unreachable_code == 1.
 108  */
 109 FIRM_API void set_opt_unreachable_code(int value);
 110
 111 /** Enables/Disables control flow optimizations.
 112  *
 113  * Performs Straightening, if simplifications and loop simplifications.
 114  * Sets all separate control flow flags (control_flow_straightening,
 115  * weak_simplification, strong_simplification and critical_edges).
 116  */
 117 FIRM_API void set_opt_control_flow(int value);
 118
 119 /** Enables/Disables Straightening. */
 120 FIRM_API void set_opt_control_flow_straightening(int value);
 121
 122 /** Enables/Disables if simplifications in local optimizations. */
 123 FIRM_API void set_opt_control_flow_weak_simplification(int value);
 124
 125 /** Enables/Disables strong if and loop simplification (in optimize_cf). */
 126 FIRM_API void set_opt_control_flow_strong_simplification(int value);
 127
 128 /** Enable/Disable optimization of dynamic method dispatch.
 129  *
 130  * This flag enables/disables the optimization of dynamic method dispatch.
 131  * If the flag is turned on Sel nodes can be replaced by Const nodes representing
 132  * the address of a function.
 133  */
 134 FIRM_API void set_opt_dyn_meth_dispatch(int value);
 135 FIRM_API int get_opt_dyn_meth_dispatch(void);
 136
 137 /** Enable/Disable type optimization of cast nodes.
 138  *
 139  * Controls the optimizations in tropt.h.  Default: on.
 140  */
 141 FIRM_API void set_opt_optimize_class_casts(int value);
 142
 143 /** Restricts the behavior of cast optimization.
 144  *
 145  *  If set, downcast are not optimized if they might be
 146  *  illegal as in (Super)(Sub) (new Super()).  Default:
 147  *  0 == not suppressed.
 148  */
 149 FIRM_API void set_opt_suppress_downcast_optimization(int value);
 150 FIRM_API int get_opt_suppress_downcast_optimization(void);
 151
 152 /**
 153  * Enable/Disable Confirm node removal during local optimization.
 154  */
 155 FIRM_API void set_opt_remove_confirm(int value);
 156
 157 /**
 158  * Enable/Disable Null exception in Load and Store nodes only.
 159  *
 160  * If enabled, only Null pointer exception can occur at Load and
 161  * store nodes. If it can be proved that the address input of these
 162  * nodes is non-null, the exception edge can safely be removed.
 163  * If disabled, other exceptions (like unaligned access, read-only memory,
 164  * etc.) can occur.
 165  *
 166  * This flag is enabled by default.
 167  */
 168 FIRM_API void set_opt_ldst_only_null_ptr_exceptions(int value);
 169
 170 /**
 171  * Enable/Disable Selection based Null pointer check elimination.
 172  *
 173  * In languages, where all addresses are always Sel nodes, Null
 174  * pointers can only occur as input to Sel nodes.
 175  * If Null pointers are the only source for exceptions in Load and
 176  * Store nodes (as typical in high level languages), we can eliminate
 177  * exception edges from Load and Store when can prove that the Sel
 178  * nodes representing the Load/Store address have non-null inputs.
 179  * Enabling this flag enables this elimination.
 180  *
 181  * Enabling this flag is meaningless if ldst_non_null_exceptions is
 182  * enabled.
 183  *
 184  * This flag should be set for Java style languages.
 185  */
 186 FIRM_API void set_opt_sel_based_null_check_elim(int value);
 187
 188 /**
 189  * Enable/Disable Global Null Pointer Test Elimination.
 190  *
 191  * In languages where it is illegal to dereference NULL pointer, doing
 192  * so makes the pointer "valid non-null", else the program will stop
 193  * anyway by a fault.
 194  *
 195  * This flag should be set for C style languages.
 196  */
 197 FIRM_API void set_opt_global_null_ptr_elimination(int value);
 198
 199 /**
 200  * Enable/Disable Automatic construction of Sync nodes during
 201  * Firm construction.
 202  *
 203  * If this flags is set, sequential non-volatile Loads are automatically
 204  * rearranged so that they can be executed in parallel by creating Sync nodes.
 205  *
 206  * This flag should be set for Java style languages.
 207  */
 208 FIRM_API void set_opt_auto_create_sync(int value);
 209
 210 /** Enable/Disable normalizations of the firm representation.
 211  *
 212  *  This flag guards transformations that normalize the Firm representation
 213  *  as removing Ids and Tuples, useless Phis, replacing SymConst(id) by
 214  *  Const(entity) and others.
 215  *  The transformations guarded by this flag are not guarded by flag
 216  *  "optimize".
 217  *  Many algorithms operating on Firm can not deal with constructs in
 218  *  the non-normalized representation.
 219  *  default: ON
 220  *
 221  *  @note ATTENTION: not all such transformations are guarded by a flag.
 222  */
 223 FIRM_API void set_opt_normalize(int value);
 224
 225 /**
 226  * Enable/Disable ConvB() nodes with a "semantic behavior", i.e. a real
 227  * operation that must be executed.
 228  */
 229 FIRM_API void set_opt_allow_conv_b(int value);
 230
 231 /** Enable/Disable precise exception context.
 232  *
 233  * If enabled, all exceptions form a barrier for values, as in the
 234  * following example:
 235  *
 236  * @code
 237  * a = 1;
 238  * b = 3 / 0;
 239  * a = 2;
 240  * @endcode
 241  *
 242  * If precise exception handling is enabled, an exception handler see a == 1,
 243  * else it might see a == 2.
 244  * Enable this for languages with strict exception order like Java.
 245  */
 246 FIRM_API void set_opt_precise_exc_context(int value);
 247
 248 /** Enable/Disable Alias analysis.
 249  *
 250  * If enabled, memory disambiguation by alias analysis is used.
 251  */
 252 FIRM_API void set_opt_alias_analysis(int value);
 253
 254 /** Enable/Disable closed world assumption.
 255  *
 256  * If enabled, optimizations expect to know the "whole world", i.e. no
 257  * external types or callers exist.
 258  * This enables some powerful optimizations.
 259  */
 260 FIRM_API void set_opt_closed_world(int value);
 261
 262 /**
 263  * Save the current optimization state.
 264  */
 265 FIRM_API void save_optimization_state(optimization_state_t *state);
 266
 267 /**
 268  * Restore the current optimization state.
 269  */
 270 FIRM_API void restore_optimization_state(const optimization_state_t *state);
 271
 272 /**
 273  * Switches ALL optimizations off.
 274  */
 275 FIRM_API void all_optimizations_off(void);
 276
 277 /**
 278  * Possible verification modes.
 279  */
 280 typedef enum firm_verification_t {
 281   FIRM_VERIFICATION_OFF        = 0,     /**< do not verify nodes at all */
 282   FIRM_VERIFICATION_ON         = 1,     /**< do node verification and assert on error in debug version */
 283   FIRM_VERIFICATION_REPORT     = 2,     /**< do node verification, but report to stderr only */
 284   FIRM_VERIFICATION_ERROR_ONLY = 3      /**< do node verification, but NEVER do assert nor report */
 285 } firm_verification_t;
 286
 287 /** Select verification of IR nodes and types.
 288  *
 289  *  Per default the  verification is in mode NODE_VERIFICATION_ASSERT.
 290  *  Turn the verification off during development to check partial implementations.
 291  */
 292 FIRM_API void do_node_verification(firm_verification_t mode);
 293
 294 #include "end.h"
 295
 296 #endif