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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irflag.h
   4  * Purpose:     Flags to control optimizations.
   5  * Author:      Christian Schaefer, Goetz Lindenmaier
   6  * Modified by: Michael Beck
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1999-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /**
  14  * @file irflag.h
  15  *
  16  * Flags to customize the behavior of libfirm.
  17  *
  18  * @author Christian Schaefer
  19  *
  20  * There are the following groups of flags:
  21  * 1. Optimization flags.
  22  *    a)  There is a flag, 'optimize' to turn on/off all optimizations.
  23  *    b)  There are flags for each individual optimization.  Some flags turns
  24  *        transformations in several algorithms on/off.
  25  * 2. Normalization flags.
  26  *    These flags steer transformations of the ir that improve it, as removing
  27  *    dump Phi nodes (one predecessor, all preds are equal ...), Ids, Tuples ...
  28  * 3. Verbosity flags.
  29  *    a) Flags to steer the level of the information.
  30  *    b) Flags to steer in which phase information should be dumped.
  31  *
  32  */
  33
  34 #ifndef _IRFLAG_H_
  35 #define _IRFLAG_H_
  36
  37 /**
  38  * A container type to load/restore all optimizations
  39  */
  40 typedef unsigned optimization_state_t;
  41
  42 /**
  43  * This function enables/disables optimizations globally.
  44  *
  45  * If optimize == 0 no optimizations are performed at all.
  46  * Default: optimize == 1.
  47  */
  48 void set_optimize (int value);
  49 int  get_optimize(void);
  50
  51 /** This function enables/disables output of information about phases and
  52  *  controls the verbosity level.
  53  *
  54  *  0: no output at all.
  55  *  1: very short output
  56  *  >>1: very verbose output.
  57  */
  58 void set_firm_verbosity (int value);
  59 int  get_firm_verbosity (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  *  - refining the memory representation
  68  *  - remove store after load
  69  * Default: opt_constant_folding == 1.
  70  */
  71 void set_opt_constant_folding (int value);
  72
  73 /** Enables/Disables loop unrolling.
  74  *
  75  * If opt_loop_unrolling == 1 perform loop_unrolling.
  76  * See loop_unrolling.h.
  77  *
  78  * Default: opt_loop_unrolling = 1;
  79  */
  80 void set_opt_loop_unrolling (int value);
  81
  82 /** Enables/Disables output of information about loop unrolling.
  83  */
  84 void set_opt_loop_unrolling_verbose (int value);
  85
  86 /** Enables/Disables removal of redundant Loads and Stores.
  87  *
  88  *  - Remove Store that overwrites a just stored value (WAW).
  89  *  - Remove Store if it stores a value just loaded (WAR with the same value).
  90  *  - Remove Load that loads a value just saved (RAW with the same value).
  91  *  - remove Load that loads a value already loaded (RAR)
  92  *  - replace Load of constant values with constants (RC)
  93  */
  94 void set_opt_redundant_loadstore(int value);
  95
  96 /** Enables/Disables constant subexpression elimination.
  97  *
  98  * If opt_cse == 1 perform constant subexpression elimination.
  99  * Default: opt_cse == 1.
 100  */
 101 void set_opt_cse (int value);
 102
 103 /** Returns constant folding optimization setting. */
 104 int get_opt_cse(void);
 105
 106 /** Enables/Disables global constant subexpression elimination.
 107  *
 108  * If opt_global_cse == 1 and opt_cse == 1 perform intra procedure
 109  * constant subexpression elimination for floating nodes.  Intra
 110  * procedure cse gets the graph into state "floating".  It is necessary
 111  * to run pre/code motion to get the graph back into state "op_pin_state_pinned".
 112  * right after a call to local_optimize with global cse turned on.
 113  * Default: opt_global_cse == 0.
 114  */
 115 void set_opt_global_cse (int value);
 116
 117 /** Enables/Disables strength reduction.
 118  *
 119  * If opt_strength_red == 1 perform strength reduction.
 120  * See strenth_red.h.
 121  *
 122  * Default: opt_strength_red = 1;
 123  */
 124 void set_opt_strength_red (int value);
 125
 126 /** Enables/Disables output of information about strength reduction.
 127  */
 128 void set_opt_strength_red_verbose (int value);
 129
 130 /** Enables/Disables unreachable code elimination.
 131  *
 132  * If set, evaluate conditions of conditional branch and replace the
 133  * branch with a Jmp/Bad Tuple.
 134  *
 135  * If opt_unreachable_code == 1 replace nodes (except Block,
 136  * Phi and Tuple) with a Bad predecessor by the Bad node.
 137  * Default: opt_unreachable_code == 1.
 138  */
 139 void set_opt_unreachable_code(int value);
 140
 141 /** Enables/Disables control flow optimizations.
 142  *
 143  * Performs Straightening, if simplifications and loop simplifications.
 144  * Sets all separate control flow flags (control_flow_straightening,
 145  * weak_simplification, strong_simplification and critical_edges).
 146  */
 147 void set_opt_control_flow(int value);
 148
 149 /** Enables/Disables Straightening. */
 150 void set_opt_control_flow_straightening(int value);
 151
 152 /** Enables/Disables if simplifications in local optimizations. */
 153 void set_opt_control_flow_weak_simplification(int value);
 154
 155 /** Enables/Disables strong if and loop simplification (in optimize_cf). */
 156 void set_opt_control_flow_strong_simplification(int value);
 157
 158 /** Enables/Disables removal of critical control flow edges. */
 159 void set_opt_critical_edges(int value);
 160
 161 /** Enables/Disables reassociation.
 162  *
 163  * If opt_reassociation == 1 reassociation is performed.
 164  * Default: opt_reassociation == 1.
 165  */
 166 void set_opt_reassociation(int value);
 167
 168 /** Enables/Disables dead node elimination.
 169  *
 170  * If opt_dead_node_elimination == 1 deallocate all dead nodes
 171  * by copying the firm graph.
 172  * Default: opt_dead_node_elimination == 1. */
 173 void set_opt_dead_node_elimination (int value);
 174
 175 /** Enables/Disables dead method elimination.
 176  *
 177  * If opt_dead_method_elimination == 1 methods never called are
 178  * removed.
 179  * Default: opt_dead_method_elimination == 1. */
 180 void set_opt_dead_method_elimination (int value);
 181 void set_opt_dead_method_elimination_verbose (int value);
 182
 183 /** Enable/Disables inlining.
 184  *
 185  * If opt_inline == 1 the inlining transformation is performed.
 186  */
 187 void set_opt_inline (int value);
 188
 189 /** Enable/Disable optimization of dynamic method dispatch.
 190  *
 191  * This flag enables/disables the optimization of dynamic method dispatch.
 192  * If the flag is turned on Sel nodes can be replaced by Const nodes representing
 193  * the address of a function.
 194  */
 195 void set_opt_dyn_meth_dispatch (int value);
 196 int  get_opt_dyn_meth_dispatch (void);
 197
 198 /** Enable/Disable type optimization of cast nodes.
 199  *
 200  * Controls the optimizations in tropt.h.  Default: on.
 201  */
 202 void set_opt_optimize_class_casts (int value);
 203 int  get_opt_optimize_class_casts (void);
 204 void set_opt_optimize_class_casts_verbose (int value);
 205 int  get_opt_optimize_class_casts_verbose (void);
 206
 207 /** Restricts the behavior of cast optimization.
 208  *
 209  *  If set, downcast are not optimized if they might be
 210  *  illegal as in (Super)(Sub) (new Super()).  Default:
 211  *  0 == not suppressed.
 212  */
 213 void set_opt_suppress_downcast_optimization(int value);
 214 int  get_opt_suppress_downcast_optimization(void);
 215
 216 /** Enable/Disable optimization of tail-recursion calls.
 217  *
 218  * This flag enables/disables the optimization tail-recursion call.
 219  * If the flag is turned on tail-recursion calls are optimized into loops.
 220  */
 221 void set_opt_tail_recursion(int value);
 222 void set_opt_tail_recursion_verbose(int value);
 223
 224 /** Enable/Disable floating of fragile ops.
 225  *
 226  * This flags enables/disables the floating of fragile operations.
 227  * If this flag is on, fragile operations which are known to NOT raise
 228  * an exception can be place to other basic blocks.
 229  * Otherwise they remain in the block they were created.
 230  */
 231 void set_opt_fragile_ops(int value);
 232
 233 /**
 234  * Enable/Disable if conversion.
 235  *
 236  * If conversion tries to turn Conds into Mux nodes to eliminate
 237  * control flow.
 238  */
 239 void set_opt_if_conversion(int value);
 240
 241 /**
 242  * Enable/Disable real function call optimization.
 243  *
 244  * Real function call optimization detects "real functions" and
 245  * allows the floating of Call nodes.
 246  */
 247 void set_opt_real_function_call(int value);
 248
 249 /**
 250  * Enable/Disable Confirm node removal during local optimization.
 251  */
 252 void set_opt_remove_confirm(int value);
 253
 254 /**
 255  * Enable/Disable scalar replacement optimization.
 256  */
 257 void set_opt_scalar_replacement(int value);
 258 void set_opt_scalar_replacement_verbose(int value);
 259
 260 /** Enable/Disable normalizations of the firm representation.
 261  *
 262  *  This flag guards transformations that normalize the firm representation
 263  *  as removing Ids and Tuples, useless Phis, replacing SymConst(id) by
 264  *  Const(entity) and others.
 265  *  The transformations guarded by this flag are not guarded by flag
 266  *  "optimize".
 267  *  Many algorithms operating on firm can not deal with constructs in
 268  *  the non-normalized representation.
 269  *  default: 1
 270  *  @@@ ATTENTION: not all such transformations are guarded by a flag.
 271  */
 272 void set_opt_normalize (int value);
 273
 274
 275 /** Enable/Disable precise exception context. */
 276 void set_opt_precise_exc_context(int value);
 277
 278 /**
 279  * Save the current optimization state.
 280  */
 281 void save_optimization_state(optimization_state_t *state);
 282
 283 /**
 284  * Restore the current optimization state.
 285  */
 286 void restore_optimization_state(const optimization_state_t *state);
 287
 288 #endif /* _IRFLAG_H_ */