remove obsolete comment
[libfirm] / ir / ir / irflag_t.h
index 601ad27..a963f9e 100644 (file)
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irgraph.c
- * Purpose:     Flags to control optimizations, inline implementation.
- * Author:      Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2004 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
 /**
- * @file irflag_t.h
- *
- * Inline implementation of Optimization flags.
- *
- * @author Michael Beck
+ * @file
+ * @brief    Flags to control optimizations, inline implementation.
+ * @author   Michael Beck, Sebastian Hack
  */
-#ifndef _IRFLAG_T_H_
-#define _IRFLAG_T_H_
+#ifndef FIRM_IR_IRFLAG_T_H
+#define FIRM_IR_IRFLAG_T_H
 
 #include "irflag.h"
 
 /**
- * current libFIRM optimizations
+ * libFIRM optimizations flags
  */
 typedef enum {
-  /** Common subexpression eliminations: Hash the nodes. */
-  OPT_CSE                                = 0x00000001,
-
-  /** Don't use block predecessor for comparison.
-   *  Default must be zero as code placement must
-   *  be run right after a local optimize walk with
-   *  opt_global_cse on. */
-  OPT_GLOBAL_CSE                         = 0x00000002,
-
-  /** Evaluate operations. */
-  OPT_CONSTANT_FOLDING                   = 0x00000004,
-
-  /** Bad node propagation. */
-  OPT_UNREACHABLE_CODE                   = 0x00000008,
-
-  /** */
-  OPT_CONTROL_FLOW_STRAIGHTENING         = 0x00000010,
-
-  /** */
-  OPT_CONTROL_FLOW_WEAK_SIMPLIFICATION   = 0x00000020,
-
-  /** */
-  OPT_CONTROL_FLOW_STRONG_SIMPLIFICATION = 0x00000040,
-
-  /** */
-  OPT_CRITICAL_EDGES                     = 0x00000080,
-
-  /** Reclaim memory. */
-  OPT_DEAD_NODE_ELIMINATION              = 0x00000100,
-
-  /** Reassociate nodes. */
-  OPT_REASSOCIATION                      = 0x00000200,
-
-  /** Do inlining transformation. */
-  OPT_INLINE                             = 0x00000400,
-
-  /** Remove dynamic method dispatch. */
-  OPT_DYN_METH_DISPATCH                  = 0x00000800,
-
-  /** Transformations that normalize the firm representation
-   *  as removing Ids and Tuples, useless Phis, SymConst(id) -> Const(entity) ...
-   */
-  OPT_NORMALIZE                          = 0x00001000,
-
-  /** Remove tail-recursion. */
-  OPT_TAIL_RECURSION                     = 0x00002000,
-
-  /** Free never called methods */
-  OPT_DEAD_METHOD_ELIMINATION            = 0x00004000,
-
-  /** precise exception context */
-  OPT_PRECISE_EXC_CONTEXT                = 0x00008000,
-
- /** EMPTY SLOT !!! TO BE ASSIGNED */
-
-  /** Do loop unrolling */
-  OPT_LOOP_UNROLLING                     = 0x00010000,
-
-  /** Do Strength reduction */
-  OPT_STRENGTH_RED                       = 0x00020000,
-
-  /** Optimize Loads and Stores */
-  OPT_REDUNDANT_LOADSTORE                = 0x00040000,
-
-  /** Optimize Fragile OPs */
-  OPT_FRAGILE_OPS                        = 0x00080000,
-
-  /** If conversion. */
-  OPT_IF_CONVERSION                      = 0x00100000,
-
-  /** Optimize real function calls. */
-  OPT_REAL_FUNC_CALL                     = 0x00200000,
-
-  /** Optimize cast nodes. */
-  OPT_CLASS_CASTS                        = 0x00400000,
-  OPT_SUPPRESS_DOWNCAST_OPT              = 0x00800000,
-
-  /** Turn off all optimizations. */
-  OPT_OPTIMIZED                          = 0x40000000,
-
+#define E_FLAG(name, value, def)    irf_##name = (1 << value),
+#define I_FLAG(name, value, def)    irf_##name = (1 << value),
+#define R_FLAG(name, value)
+
+#include "irflag_t.def"
+       irf_last
+#undef I_FLAG
+#undef E_FLAG
+#undef R_FLAG
 } libfirm_opts_t;
 
-extern optimization_state_t libFIRM_opt;
-extern optimization_state_t libFIRM_verb;
-
-extern int firm_verbosity_level;
-
-
-/** Returns constant folding optimization setting. */
-static INLINE int _get_opt_cse(void)
-{
-  return libFIRM_opt & OPT_CSE;
-}
-
-/** Returns constant subexpression elimination setting. */
-static INLINE int get_opt_global_cse(void)
-{
-  return libFIRM_opt & OPT_GLOBAL_CSE;
-}
-
-static INLINE int get_opt_loop_unrolling(void)
-{
-  return libFIRM_opt & OPT_LOOP_UNROLLING;
-}
-
-/** Returns verbosity for loop unrolling.   */
-static INLINE int get_opt_loop_unrolling_verbose(void)
-{
-  return libFIRM_verb & OPT_LOOP_UNROLLING;
-}
-
-static INLINE int get_opt_strength_red(void)
-{
-  return libFIRM_opt & OPT_STRENGTH_RED;
-}
-
-/** Returns verbosity for strength reduction.   */
-static INLINE int get_opt_strength_red_verbose(void)
-{
-  return libFIRM_verb & OPT_STRENGTH_RED;
-}
-
-/** Returns global constant subexpression elimination setting. */
-static INLINE int get_opt_constant_folding(void)
-{
-  return libFIRM_opt & OPT_CONSTANT_FOLDING;
-}
-
-/** Returns global constant subexpression elimination setting. */
-static INLINE int get_opt_redundant_LoadStore(void)
-{
-  return libFIRM_opt & OPT_REDUNDANT_LOADSTORE;
-}
-
-/** Returns unreachable code elimination setting. */
-static INLINE int get_opt_unreachable_code(void)
-{
-  return libFIRM_opt & OPT_UNREACHABLE_CODE;
-}
-
-/** Returns Straightening setting. */
-static INLINE int get_opt_control_flow_straightening(void)
-{
-  return libFIRM_opt & OPT_CONTROL_FLOW_STRAIGHTENING;
-}
-
-/** Returns if simplifications in local optimizations setting. */
-static INLINE int get_opt_control_flow_weak_simplification(void)
-{
-  return libFIRM_opt & OPT_CONTROL_FLOW_WEAK_SIMPLIFICATION;
-}
-
-/** Returns strong if and loop simplification setting */
-static INLINE int get_opt_control_flow_strong_simplification(void)
-{
-  return libFIRM_opt & OPT_CONTROL_FLOW_STRONG_SIMPLIFICATION;
-}
-
-/** Returns whether critical edges are removed */
-static INLINE int get_opt_critical_edges(void)
-{
-  return libFIRM_opt & OPT_CRITICAL_EDGES;
-}
-
-/** Returns reassociation setting. */
-static INLINE int get_opt_reassociation(void)
-{
-  return libFIRM_opt & OPT_REASSOCIATION;
-}
-
-/** Returns dead node elimination setting. */
-static INLINE int get_opt_dead_node_elimination(void)
-{
-  return libFIRM_opt & OPT_DEAD_NODE_ELIMINATION;
-}
-
-/** Returns dead method elimination setting. */
-static INLINE int get_opt_dead_method_elimination(void)
-{
-  return libFIRM_opt & OPT_DEAD_METHOD_ELIMINATION;
-}
-
-/** Returns dead method elimination setting. */
-static INLINE int get_opt_dead_method_elimination_verbose(void)
-{
-  return libFIRM_verb & OPT_DEAD_METHOD_ELIMINATION;
-}
-
-/** Returns global optimization setting */
-static INLINE int get_opt_optimize(void)
-{
-  return libFIRM_opt & OPT_OPTIMIZED;
-}
-
-static INLINE int _get_firm_verbosity (void) {
-  return firm_verbosity_level;
-}
-
-/** Returns inlining setting. */
-static INLINE int get_opt_inline(void)
-{
-  return libFIRM_opt & OPT_INLINE;
-}
-
-static INLINE int _get_opt_dyn_meth_dispatch(void)
-{
-  return libFIRM_opt & OPT_DYN_METH_DISPATCH;
-}
+/**
+ * libFIRM running flags
+ */
+typedef enum {
+#define E_FLAG(name, value, def)
+#define I_FLAG(name, value, def)
+#define R_FLAG(name, value)         ir_rf_##name = (1 << value),
 
-static INLINE int _get_opt_optimize_class_casts (void) {
-  return libFIRM_opt & OPT_CLASS_CASTS;
-}
+#include "irflag_t.def"
+       ir_rf_last
+#undef I_FLAG
+#undef E_FLAG
+#undef R_FLAG
+} libfirm_running_t;
 
-static INLINE int _get_opt_optimize_class_casts_verbose (void) {
-  return libFIRM_verb & OPT_CLASS_CASTS;
-}
+extern optimization_state_t libFIRM_opt, libFIRM_running, libFIRM_verb;
+extern firm_verification_t opt_do_node_verification;
 
-static INLINE int _get_opt_suppress_downcast_optimization (void) {
-  return libFIRM_opt & OPT_SUPPRESS_DOWNCAST_OPT;
-}
+/** initialises the flags */
+void firm_init_flags(void);
 
-static INLINE int get_opt_normalize(void)
-{
-  return libFIRM_opt & OPT_NORMALIZE;
+/* generate the getter functions for external access */
+#define E_FLAG(name, value, def)                    \
+static inline int get_opt_##name##_(void) {         \
+  return libFIRM_opt & irf_##name;                  \
 }
 
-/** Returns tail-recursion setting. */
-static INLINE int get_opt_tail_recursion(void)
-{
-  return libFIRM_opt & OPT_TAIL_RECURSION;
+/* generate the getter functions for internal access */
+#define I_FLAG(name, value, def)                   \
+static inline int get_opt_##name(void) {           \
+  return libFIRM_opt & irf_##name;                 \
 }
 
-/** Returns tail-recursion setting. */
-static INLINE int get_opt_tail_recursion_verbose(void)
-{
-  return libFIRM_verb & OPT_TAIL_RECURSION;
+/* generate getter and setter functions for running flags */
+#define R_FLAG(name, value)                        \
+static inline int is_##name##_running(void) {      \
+  return libFIRM_running & ir_rf_##name;           \
+}                                                  \
+static inline void set_##name##_running(int flag) {\
+  if (flag) libFIRM_running |= ir_rf_##name;       \
+  else      libFIRM_running &= ~ir_rf_##name;      \
 }
 
-/** Returns precise exception context setting. */
-static INLINE int get_opt_precise_exc_context(void)
-{
-  return libFIRM_opt & OPT_PRECISE_EXC_CONTEXT;
-}
+#include "irflag_t.def"
 
-/** Returns fragile ops setting. */
-static INLINE int get_opt_fragile_ops(void)
-{
-  return libFIRM_opt & OPT_FRAGILE_OPS;
-}
+#undef I_FLAG
+#undef E_FLAG
+#undef R_FLAG
 
-/** Returns if conversion setting. */
-static INLINE int get_opt_if_conversion(void)
+static inline int get_optimize_(void)
 {
-  return libFIRM_opt & OPT_IF_CONVERSION;
+       return get_opt_optimize();
 }
 
-/** Returns real function call optimization setting. */
-static INLINE int get_opt_real_func_call(void)
+static inline firm_verification_t get_node_verification_mode(void)
 {
-  return libFIRM_opt & OPT_REAL_FUNC_CALL;
+       return opt_do_node_verification;
 }
 
-#define get_opt_cse()                            _get_opt_cse()
-#define get_firm_verbosity()                     _get_firm_verbosity()
-#define get_opt_dyn_meth_dispatch()              _get_opt_dyn_meth_dispatch()
-#define get_opt_optimize_class_casts()           _get_opt_optimize_class_casts()
-#define get_opt_optimize_class_casts_verbose()   _get_opt_optimize_class_casts_verbose()
-#define get_opt_suppress_downcast_optimization() _get_opt_suppress_downcast_optimization()
+#define get_optimize()                           get_optimize_()
+#define get_opt_cse()                            get_opt_cse_()
+#define get_opt_suppress_downcast_optimization() get_opt_suppress_downcast_optimization_()
 
-#endif /* _IRFLAG_T_H_ */
+#endif