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