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  * @brief
  25  * Flags to customize the behavior of libfirm.
  26  *
  27  * There are the following groups of flags:
  28  * 1. Optimization flags.
  29  *    a)  There is a flag, 'optimize' to turn on/off all optimizations.
  30  *    b)  There are flags for each individual optimization.  Some flags turns
  31  *        transformations in several algorithms on/off.
  32  * 2. Normalization flags.
  33  *    These flags steer transformations of the ir that improve it, as removing
  34  *    dump Phi nodes (one predecessor, all predecessors are equal ...), Ids, Tuples ...
  35  * 3. Verbosity flags.
  36  *    a) Flags to steer the level of the information.
  37  *    b) Flags to steer in which phase information should be dumped.
  38  * 4. Verification flag
  39  *    This one controls the behavior of node and type verifications
  40  */
  41 #ifndef FIRM_IR_IRFLAG_H
  42 #define FIRM_IR_IRFLAG_H
  43
  44 #include "firm_types.h"
  45 #include "begin.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 FIRM_API void set_optimize(int value);
  59 FIRM_API 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  * Default: opt_constant_folding == 1.
  66  */
  67 FIRM_API void set_opt_constant_folding(int value);
  68
  69 /** Enables/Disables algebraic simplifications.
  70  *
  71  *  If opt_algebraic_simplification == 1 perform
  72  *  - algebraic simplification  (a * 0 ==> 0, a or a ==> a)
  73  *  - simplification of tests   ( !(a < b) ==> (a >= b))
  74  * Default: opt_algebraic_simplification == 1.
  75  */
  76 FIRM_API void set_opt_algebraic_simplification(int value);
  77
  78 /** Enables/Disables common subexpression elimination.
  79  *
  80  * If opt_cse == 1 perform common subexpression elimination.
  81  * Default: opt_cse == 1.
  82  */
  83 FIRM_API void set_opt_cse(int value);
  84
  85 /** Returns constant folding optimization setting. */
  86 FIRM_API int get_opt_cse(void);
  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 FIRM_API void set_opt_global_cse(int value);
  98
  99 /** Restricts the behavior of cast optimization.
 100  *
 101  *  If set, downcast are not optimized if they might be
 102  *  illegal as in (Super)(Sub) (new Super()).  Default:
 103  *  0 == not suppressed.
 104  */
 105 FIRM_API void set_opt_suppress_downcast_optimization(int value);
 106 FIRM_API int get_opt_suppress_downcast_optimization(void);
 107
 108 /**
 109  * Enable/Disable Null exception in Load and Store nodes only.
 110  *
 111  * If enabled, only Null pointer exception can occur at Load and
 112  * store nodes. If it can be proved that the address input of these
 113  * nodes is non-null, the exception edge can safely be removed.
 114  * If disabled, other exceptions (like unaligned access, read-only memory,
 115  * etc.) can occur.
 116  *
 117  * This flag is enabled by default.
 118  */
 119 FIRM_API void set_opt_ldst_only_null_ptr_exceptions(int value);
 120
 121 /**
 122  * Enable/Disable Global Null Pointer Test Elimination.
 123  *
 124  * In languages where it is illegal to dereference NULL pointer, doing
 125  * so makes the pointer "valid non-null", else the program will stop
 126  * anyway by a fault.
 127  *
 128  * This flag should be set for C style languages.
 129  */
 130 FIRM_API void set_opt_global_null_ptr_elimination(int value);
 131
 132 /**
 133  * Enable/Disable Automatic construction of Sync nodes during
 134  * Firm construction.
 135  *
 136  * If this flags is set, sequential non-volatile Loads are automatically
 137  * rearranged so that they can be executed in parallel by creating Sync nodes.
 138  *
 139  * This flag should be set for Java style languages.
 140  */
 141 FIRM_API void set_opt_auto_create_sync(int value);
 142
 143 /** Enable/Disable Alias analysis.
 144  *
 145  * If enabled, memory disambiguation by alias analysis is used.
 146  */
 147 FIRM_API void set_opt_alias_analysis(int value);
 148
 149 /** Enable/Disable closed world assumption.
 150  *
 151  * If enabled, optimizations expect to know the "whole world", i.e. no
 152  * external types or callers exist.
 153  * This enables some powerful optimizations.
 154  */
 155 FIRM_API void set_opt_closed_world(int value);
 156
 157 /**
 158  * Save the current optimization state.
 159  */
 160 FIRM_API void save_optimization_state(optimization_state_t *state);
 161
 162 /**
 163  * Restore the current optimization state.
 164  */
 165 FIRM_API void restore_optimization_state(const optimization_state_t *state);
 166
 167 /**
 168  * Switches ALL optimizations off.
 169  */
 170 FIRM_API void all_optimizations_off(void);
 171
 172 /**
 173  * Possible verification modes.
 174  */
 175 typedef enum firm_verification_t {
 176   FIRM_VERIFICATION_OFF        = 0, /**< do not verify nodes at all */
 177   FIRM_VERIFICATION_ON         = 1, /**< do node verification and assert on error in debug version */
 178   FIRM_VERIFICATION_REPORT     = 2, /**< do node verification, but report to stderr only */
 179   FIRM_VERIFICATION_ERROR_ONLY = 3  /**< do node verification, but NEVER do assert nor report */
 180 } firm_verification_t;
 181
 182 /**
 183  * Select verification of IR nodes and types.
 184  *
 185  * Per default the  verification is in mode NODE_VERIFICATION_ASSERT.
 186  * Turn the verification off during development to check partial
 187  * implementations.
 188  */
 189 FIRM_API void do_node_verification(firm_verification_t mode);
 190
 191 #include "end.h"
 192
 193 #endif