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 behaviour 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 removal of redundant Loads and Stores.
  74  *
  75  *  - Remove Store that overwrites a just stored value (WAW).
  76  *  - Remove Store if it stores a value just loaded (WAR with the same value).
  77  *  - Remove Load that loads a value just saved (RAW with the same value).
  78  */
  79 void set_opt_redundant_LoadStore(int value);
  80
  81 /** Enables/Disables constant subexpression elimination.
  82  *
  83  * If opt_cse == 1 perform constant subexpression elimination.
  84  * Default: opt_cse == 1.
  85  */
  86 void set_opt_cse (int value);
  87
  88 /** Enables/Disables global constant subexpression elimination.
  89  *
  90  * If opt_global_cse == 1 and opt_cse == 1 perform intra procedure
  91  * constant subexpression elimination for floating nodes.  Intra
  92  * procedure cse gets the graph into state "floating".  It is necessary
  93  * to run pre/code motion to get the graph back into state "op_pin_state_pinned".
  94  * right after a call to local_optimize with global cse turned on.
  95  * Default: opt_global_cse == 0.
  96  */
  97 void set_opt_global_cse (int value);
  98
  99 /** Enables/Disables strength reduction.
 100  *
 101  * If opt_strength_red == 1 perform strength reduction.
 102  * See strenth_red.h.
 103  *
 104  * Default: opt_strength_red = 1;
 105  */
 106 void set_opt_strength_red (int value);
 107
 108 /** Enables/Disables output of information about strength reduction.
 109  */
 110 void set_opt_strength_red_verbose (int value);
 111
 112 /** Enables/Disables unreachable code elimination.
 113  *
 114  * If set, evaluate conditions of conditional branch and replace the
 115  * branch with a Jmp/Bad Tuple.
 116  *
 117  * If opt_unreachable_code == 1 replace nodes (except Block,
 118  * Phi and Tuple) with a Bad predecessor by the Bad node.
 119  * Default: opt_unreachable_code == 1.
 120  */
 121 void set_opt_unreachable_code(int value);
 122
 123 /** Enables/Disables control flow optimizations.
 124  *
 125  * Performs Straightening, if simplifications and loop simplifications.
 126  * Sets all separate control flow flags (control_flow_straightening,
 127  * weak_simplification, strong_simplification and critical_edges).
 128  */
 129 void set_opt_control_flow(int value);
 130
 131 /** Enables/Disables Straightening. */
 132 void set_opt_control_flow_straightening(int value);
 133
 134 /** Enables/Disables if simplifications in local optimizations. */
 135 void set_opt_control_flow_weak_simplification(int value);
 136
 137 /** Enables/Disables strong if and loop simplification (in optimize_cf). */
 138 void set_opt_control_flow_strong_simplification(int value);
 139
 140 /** Enables/Disables removal of critical control flow edges. */
 141 void set_opt_critical_edges(int value);
 142
 143 /** Enables/Disables reassociation.
 144  *
 145  * If opt_reassociation == 1 reassociation is performed.
 146  * Default: opt_reassociation == 1.
 147  */
 148 void set_opt_reassociation(int value);
 149
 150 /** Enables/Disables dead node elimination.
 151  *
 152  * If opt_dead_node_elimination == 1 deallocate all dead nodes
 153  * by copying the firm graph.
 154  * Default: opt_dead_node_elimination == 1. */
 155 void set_opt_dead_node_elimination (int value);
 156
 157 /** Enables/Disables dead method elimination.
 158  *
 159  * If opt_dead_method_elimination == 1 methods never called are
 160  * removed.
 161  * Default: opt_dead_method_elimination == 1. */
 162 void set_opt_dead_method_elimination (int value);
 163 void set_opt_dead_method_elimination_verbose (int value);
 164
 165 /** Enable/Disables inlining.
 166  *
 167  * If opt_inline == 1 the inlining transformation is performed.
 168  */
 169 void set_opt_inline (int value);
 170
 171 /** Enable/Disable optimization of dynamic method dispatch
 172  *
 173  * This flag enables/disables the optimization of dynamic method dispatch.
 174  * If the flag is turned on Sel nodes can be replaced by Const nodes representing
 175  * the address of a function.
 176  */
 177 void set_opt_dyn_meth_dispatch (int value);
 178
 179 /** Enable/Disable optimization of tail-recursion calls.
 180  *
 181  * This flag enables/disables the optimization tail-recursion call.
 182  * If the flag is turned on tail-recursion calls are optimized into loops.
 183  */
 184 void set_opt_tail_recursion(int value);
 185 void set_opt_tail_recursion_verbose(int value);
 186
 187
 188 /** Enable/Disable normalizations of the firm representation.
 189  *
 190  *  This flag guards transformations that normalize the firm representation
 191  *  as removing Ids and Tuples, useless Phis, replacing SymConst(id) by
 192  *  Const(entity) and others.
 193  *  The transformations guarded by this flag are not guarded by flag
 194  *  "optimize".
 195  *  Many algorithms operating on firm can not deal with constructs in
 196  *  the non-normalized representation.
 197  *  default: 1
 198  *  @@@ ATTENTION: not all such transformations are guarded by a flag.
 199  */
 200 void set_opt_normalize (int value);
 201
 202
 203 /** Enable/Disable precise exception context. */
 204 void set_opt_precise_exc_context(int value);
 205
 206 /**
 207  * Save the current optimization state.
 208  */
 209 void save_optimization_state(optimization_state_t *state);
 210
 211 /**
 212  * Restore the current optimization state.
 213  */
 214 void restore_optimization_state(const optimization_state_t *state);
 215
 216 #endif