removed c99 style
[libfirm] / ir / ir / irflag.h
index c32bf82..acf4787 100644 (file)
  *        transformations in several algorithms on/off.
  * 2. Normalization flags.
  *    These flags steer transformations of the ir that improve it, as removing
- *    dump Phi nodes (one predecessor, all preds are equal ...), Ids, Tuples ...
+ *    dump Phi nodes (one predecessor, all predecessors are equal ...), Ids, Tuples ...
  * 3. Verbosity flags.
  *    a) Flags to steer the level of the information.
  *    b) Flags to steer in which phase information should be dumped.
  * 4. Verification flag
  *    This one controls the behavior of node and type verifications
  */
-#ifndef _IRFLAG_H_
-#define _IRFLAG_H_
+#ifndef _FIRM_IR_IRFLAG_H_
+#define _FIRM_IR_IRFLAG_H_
 
 #include "firm_types.h"
 
@@ -66,8 +66,6 @@ int  get_firm_verbosity (void);
  *  - constant expression evaluation (2 + 5 ==> 7, 3 < 2 ==> false)
  *  - algebraic simplification  (a * 0 ==> 0, a or a ==> a)
  *  - simplification of tests   ( !(a < b) ==> (a >= b))
- *  - refining the memory representation
- *  - remove store after load
  * Default: opt_constant_folding == 1.
  */
 void set_opt_constant_folding (int value);
@@ -157,9 +155,6 @@ void set_opt_control_flow_weak_simplification(int value);
 /** Enables/Disables strong if and loop simplification (in optimize_cf). */
 void set_opt_control_flow_strong_simplification(int value);
 
-/** Enables/Disables removal of critical control flow edges. */
-void set_opt_critical_edges(int value);
-
 /** Enables/Disables reassociation.
  *
  * If opt_reassociation == 1 reassociation is performed.
@@ -178,11 +173,12 @@ void set_opt_dead_node_elimination (int value);
  *
  * If opt_dead_method_elimination == 1 methods never called are
  * removed.
- * Default: opt_dead_method_elimination == 1. */
+ * Default: opt_dead_method_elimination == 1.
+ */
 void set_opt_dead_method_elimination (int value);
 void set_opt_dead_method_elimination_verbose (int value);
 
-/** Enable/Disables inlining.
+/** Enable/Disables method inlining.
  *
  * If opt_inline == 1 the inlining transformation is performed.
  */
@@ -239,14 +235,14 @@ void set_opt_fragile_ops(int value);
 void set_opt_if_conversion(int value);
 
 /**
- * Enable/Disable real function call optimization.
+ * Enable/Disable function call optimization.
  *
- * Real function call optimization detects "real functions" and
- * allows the floating of Call nodes. A "real function" is one that
+ * Function call optimization detects const and pure functions and
+ * allows the CSE of Call nodes. A const function is one that
  * do only evaluate it's parameters and did not read or write memory
- * to compute its results.
+ * to compute its results. Pure functions are allowed to read global memory.
  */
-void set_opt_real_function_call(int value);
+void set_opt_function_call(int value);
 
 /**
  * Enable/Disable Confirm node removal during local optimization.
@@ -263,7 +259,7 @@ void set_opt_scalar_replacement_verbose(int value);
  * Enable/Disable Null exception in Load and Store nodes only.
  *
  * If enabled, only Null pointer exception can occur at Load and
- * store nodes. If it can be proven that the address input of these
+ * store nodes. If it can be proved that the address input of these
  * nodes is non-null, the exception edge can safely be removed.
  * If disabled, other exceptions (like unaligned access, read-only memory,
  * etc.) can occur.
@@ -279,7 +275,7 @@ void set_opt_ldst_only_null_ptr_exceptions(int value);
  * pointers can only occur as input to Sel nodes.
  * If Null pointers are the only source for exceptions in Load and
  * Store nodes (as typical in high level languages), we can eliminate
- * exception edges form Load and Store as we can prove that the Sel
+ * exception edges from Load and Store when can prove that the Sel
  * nodes representing the Load/Store address have non-null inputs.
  * Enabling this flag enables this elimination.
  *
@@ -290,23 +286,35 @@ void set_opt_ldst_only_null_ptr_exceptions(int value);
  */
 void set_opt_sel_based_null_check_elim(int value);
 
+/**
+ * Enable/Disable Automatic construction of Sync nodes during
+ * Firm construction.
+ *
+ * If this flags is set, sequential non-volatile Loads are automatically
+ * rearranged so that they can be executed in parallel by creating Sync nodes.
+ *
+ * This flags should be set for Java style languages.
+ */
+void set_opt_auto_create_sync(int value);
+
 /** Enable/Disable normalizations of the firm representation.
  *
- *  This flag guards transformations that normalize the firm representation
+ *  This flag guards transformations that normalize the Firm representation
  *  as removing Ids and Tuples, useless Phis, replacing SymConst(id) by
  *  Const(entity) and others.
  *  The transformations guarded by this flag are not guarded by flag
  *  "optimize".
- *  Many algorithms operating on firm can not deal with constructs in
+ *  Many algorithms operating on Firm can not deal with constructs in
  *  the non-normalized representation.
- *  default: 1
- *  @@@ ATTENTION: not all such transformations are guarded by a flag.
+ *  default: ON
+ *
+ *  @note ATTENTION: not all such transformations are guarded by a flag.
  */
 void set_opt_normalize (int value);
 
 /** Enable/Disable precise exception context.
  *
- * If enabled, all exceptions form a barrier for value, as in the
+ * If enabled, all exceptions form a barrier for values, as in the
  * following example:
  *
  * @code
@@ -321,6 +329,14 @@ void set_opt_normalize (int value);
  */
 void set_opt_precise_exc_context(int value);
 
+/** Enable/Disable closed world assumption.
+ *
+ * If enabled, optimizations expect to know the "whole world", i.e. no
+ * external types or callers exist.
+ * This enables some powerful optimizations.
+ */
+void set_opt_closed_world(int value);
+
 /**
  * Save the current optimization state.
  */
@@ -346,11 +362,11 @@ typedef enum _firm_verification_t {
   FIRM_VERIFICATION_ERROR_ONLY = 3     /**< do node verification, but NEVER do assert nor report */
 } firm_verification_t;
 
-/** Select verification of nodes.
+/** Select verification of IR nodes and types.
  *
  *  Per default the  verification is in mode NODE_VERIFICATION_ASSERT.
  *  Turn the verification off during development to check partial implementations.
  */
 void do_node_verification(firm_verification_t mode);
 
-#endif /* _IRFLAG_H_ */
+#endif /* _FIRM_IR_IRFLAG_H_ */