- add prototype for combo()

[libfirm] / include / libfirm / iroptimize.h

diff --git a/include/libfirm/iroptimize.h b/include/libfirm/iroptimize.h
index 1b8dfb8..41e09ae 100644 (file)
--- a/include/libfirm/iroptimize.h
+++ b/include/libfirm/iroptimize.h
@@ -159,10 +159,6 @@ void optimize_funccalls(int force_run, check_alloc_entity_func callback);
  * 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);
 
@@ -172,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
  */
@@ -417,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.
  *
@@ -505,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