- add prototype for combo()

[libfirm] / include / libfirm / iroptimize.h

diff --git a/include/libfirm/iroptimize.h b/include/libfirm/iroptimize.h
index 86b59bb..41e09ae 100644 (file)
--- a/include/libfirm/iroptimize.h
+++ b/include/libfirm/iroptimize.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -51,6 +51,14 @@ void optimize_cf(ir_graph *irg);
  */
 void opt_cond_eval(ir_graph* irg);
 
+/**
+ * Try to simplify boolean expression in the given ir graph.
+ * eg. x < 5 && x < 6 becomes x < 5
+ *
+ * @param irg  the graph
+ */
+void opt_bool(ir_graph *irg);
+
 /**
  * Try to reduce the number of conv nodes in the given ir graph.
  *
@@ -132,14 +140,16 @@ void escape_analysis(int run_scalar_replace, check_alloc_entity_func callback);
  *                   if no const function graph was detected.
  *                   Else calls are only optimized if at least one
  *                   const function graph was detected.
+ * @param callback   a callback function to check whether a
+ *                   given entity is a allocation call
  *
- * If the fontend created external entities with the irg_const_function
+ * If the frontend created external entities with the irg_const_function
  * property set, the force_run parameter should be set, else
  * should be unset.
  *
  * @note This optimization destroys the link fields of nodes.
  */
-void optimize_funccalls(int force_run);
+void optimize_funccalls(int force_run, check_alloc_entity_func callback);
 
 /**
  * Does Partial Redundancy Elimination combined with
@@ -149,10 +159,6 @@ void optimize_funccalls(int force_run);
  * Based on VanDrunen and Hosking 2004.
  *
  * @param irg  the graph
- *
- * @note
- * Currently completely broken because the used sets do NOT
- * preserve the topological sort of its elements.
  */
 void do_gvn_pre(ir_graph *irg);
 
@@ -162,7 +168,7 @@ void do_gvn_pre(ir_graph *irg);
  * If it returns non-zero, a mux is created, else the code
  * is not modified.
  * @param sel        A selector of a Cond.
- * @param phi_list   List of Phi nodes about to be converted (linked via link field)
+ * @param phi_list   List of Phi nodes about to be converted (linked via get_Phi_next() field)
  * @param i          First data predecessor involved in if conversion
  * @param j          Second data predecessor involved in if conversion
  */
@@ -241,7 +247,9 @@ typedef enum osr_flags {
        osr_flag_none               = 0,  /**< no additional flags */
        osr_flag_lftr_with_ov_check = 1,  /**< do linear function test replacement
                                               only if no overflow can occur. */
-       osr_flag_ignore_x86_shift   = 2   /**< ignore Multiplications by 2, 4, 8 */
+       osr_flag_ignore_x86_shift   = 2,  /**< ignore Multiplications by 2, 4, 8 */
+       osr_flag_keep_reg_pressure  = 4   /**< do NOT increase register pressure by introducing new
+                                              induction variables. */
 } osr_flags;
 
 /* FirmJNI cannot handle identical enum values... */
@@ -405,15 +413,23 @@ void normalize_n_returns(ir_graph *irg);
  * with atomic values if possible. Does not handle classes yet.
  *
  * @param irg  the graph which should be optimized
+ *
+ * @return non-zero, if at least one entity was replaced
  */
-void scalar_replacement_opt(ir_graph *irg);
+int scalar_replacement_opt(ir_graph *irg);
 
 /** Performs strength reduction for the passed graph. */
 void reduce_strength(ir_graph *irg);
 
 /**
- * Optimizes simple tail-recursion calls by
- * converting them into loops. Depends on the flag opt_tail_recursion.
+ * Optimizes tail-recursion calls by converting them into loops.
+ * Depends on the flag opt_tail_recursion.
+ * Currently supports the following forms:
+ *  - return func();
+ *  - return x + func();
+ *  - return func() - x;
+ *  - return x * func();
+ *  - return -func();
  *
  * Does not work for Calls that use the exception stuff.
  *
@@ -493,4 +509,12 @@ void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct)
  */
 void optimize_class_casts(void);
 
+/**
+ * CLiff Click's combo algorithm from "Combining Analyses, combining Optimizations".
+ *
+ * Does conditional constant propagation, unreachable code elimination and optimistic
+ * global value numbering at once.
+ */
+void combo(ir_graph *irg);
+
 #endif