cleanup and fix some bugs in ir reader/writer
[libfirm] / include / libfirm / iroptimize.h
index c5e1a14..27f885d 100644 (file)
@@ -48,8 +48,6 @@ void optimize_cf(ir_graph *irg);
  * Creates an ir_graph pass for optimize_cf().
  *
  * @param name     the name of this pass or NULL
- * @param verify   should this pass be verified?
- * @param dump     should this pass result be dumped?
  *
  * @return  the newly created ir_graph pass
  */
@@ -222,7 +220,7 @@ void do_gvn_pre(ir_graph *irg);
 /**
  * Creates an ir_graph pass for do_gvn_pre().
  *
- * @param dump     should this pass result be dumped?
+ * @param name     the name of this pass or NULL
  *
  * @return  the newly created ir_graph pass
  */
@@ -273,7 +271,12 @@ void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params);
 ir_graph_pass_t *opt_if_conv_pass(
        const char *name, const ir_settings_if_conv_t *params);
 
-void opt_sync(ir_graph *irg);
+/**
+ * Tries to reduce dependencies for memory nodes where possible by parllelizing
+ * them and synchronising with Sync nodes
+ * @param irg   the graph where memory operations should be parallelised
+ */
+void opt_parallelize_mem(ir_graph *irg);
 
 /**
  * Creates an ir_graph pass for opt_sync().
@@ -282,7 +285,7 @@ void opt_sync(ir_graph *irg);
  *
  * @return  the newly created ir_graph pass
  */
-ir_graph_pass_t *opt_sync_pass(const char *name);
+ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
 
 /*
  * Check if we can replace the load by a given const from
@@ -509,6 +512,16 @@ ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
  */
 void proc_cloning(float threshold);
 
+/**
+ * Creates an ir_prog pass for proc_cloning().
+ *
+ * @param name        the name of this pass or NULL
+ * @param threshold   the threshold for cloning
+ *
+ * @return  the newly created ir_prog pass
+ */
+ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
+
 /**
  * Reassociation.
  *
@@ -733,10 +746,11 @@ 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".
+ * CLiff Click's combo algorithm from
+ *   "Combining Analyses, combining Optimizations".
  *
- * Does conditional constant propagation, unreachable code elimination and optimistic
- * global value numbering at once.
+ * Does conditional constant propagation, unreachable code elimination and
+ * optimistic global value numbering at once.
  *
  * @param irg  the graph to run on
  */
@@ -751,59 +765,112 @@ void combo(ir_graph *irg);
  */
 ir_graph_pass_t *combo_pass(const char *name);
 
-/** Inlines all small methods at call sites where the called address comes
- *  from a SymConst node that references the entity representing the called
- *  method.
- *
- *  The size argument is a rough measure for the code size of the method:
- *  Methods where the obstack containing the firm graph is smaller than
- *  size are inlined.  Further only a limited number of calls are inlined.
- *  If the method contains more than 1024 inlineable calls none will be
- *  inlined.
- *  Inlining is only performed if flags `optimize' and `inlineing' are set.
- *  The graph may not be in state phase_building.
- *  It is recommended to call local_optimize_graph() after inlining as this
- *  function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
- *  combination as control flow operation.
+/**
+ * Inlines all small methods at call sites where the called address comes
+ * from a SymConst node that references the entity representing the called
+ * method.
+ *
+ * @param irg  the graph
+ * @param size maximum function size
+ *
+ * The size argument is a rough measure for the code size of the method:
+ * Methods where the obstack containing the firm graph is smaller than
+ * size are inlined.  Further only a limited number of calls are inlined.
+ * If the method contains more than 1024 inlineable calls none will be
+ * inlined.
+ * Inlining is only performed if flags `optimize' and `inlineing' are set.
+ * The graph may not be in state phase_building.
+ * It is recommended to call local_optimize_graph() after inlining as this
+ * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
+ * combination as control flow operation.
  */
 void inline_small_irgs(ir_graph *irg, int size);
 
+/**
+ * Creates an ir_graph pass for inline_small_irgs().
+ *
+ * @param name   the name of this pass or NULL
+ * @param size   maximum function size
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
 
-/** Inlineing with a different heuristic than inline_small_irgs().
+/**
+ * Inlineing with a different heuristic than inline_small_irgs().
  *
- *  Inlines leave functions.  If inlinening creates new leave
- *  function inlines these, too. (If g calls f, and f calls leave h,
- *  h is first inlined in f and then f in g.)
+ * Inlines leave functions.  If inlinening creates new leave
+ * function inlines these, too. (If g calls f, and f calls leave h,
+ * h is first inlined in f and then f in g.)
  *
- *  Then inlines all small functions (this is not recursive).
+ * Then inlines all small functions (this is not recursive).
  *
- *  For a heuristic this inlineing uses firm node counts.  It does
- *  not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
- *  If the ignore_runtime flag is set, calls to functions marked with the
- *  mtp_property_runtime property are ignored.
+ * For a heuristic this inlineing uses firm node counts.  It does
+ * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
+ * If the ignore_runtime flag is set, calls to functions marked with the
+ * mtp_property_runtime property are ignored.
  *
- *  @param maxsize         Do not inline any calls if a method has more than
- *                         maxsize firm nodes.  It may reach this limit by
- *                         inlineing.
- *  @param leavesize       Inline leave functions if they have less than leavesize
- *                         nodes.
- *  @param size            Inline all function smaller than size.
- *  @param ignore_runtime  count a function only calling runtime functions as
- *                         leave
+ * @param maxsize         Do not inline any calls if a method has more than
+ *                        maxsize firm nodes.  It may reach this limit by
+ *                        inlineing.
+ * @param leavesize       Inline leave functions if they have less than leavesize
+ *                        nodes.
+ * @param size            Inline all function smaller than size.
+ * @param ignore_runtime  count a function only calling runtime functions as
+ *                        leave
  */
 void inline_leave_functions(unsigned maxsize, unsigned leavesize,
                unsigned size, int ignore_runtime);
 
+/**
+ * Creates an ir_prog pass for inline_leave_functions().
+ *
+ * @param name            the name of this pass or NULL
+ * @param maxsize         Do not inline any calls if a method has more than
+ *                        maxsize firm nodes.  It may reach this limit by
+ *                        inlineing.
+ * @param leavesize       Inline leave functions if they have less than leavesize
+ *                        nodes.
+ * @param size            Inline all function smaller than size.
+ * @param ignore_runtime  count a function only calling runtime functions as
+ *                        leave
+ *
+ * @return  the newly created ir_prog pass
+ */
+ir_prog_pass_t *inline_leave_functions_pass(
+       const char *name, unsigned maxsize, unsigned leavesize,
+       unsigned size, int ignore_runtime);
+
+typedef void (*opt_ptr)(ir_graph *irg);
+
 /**
  * Heuristic inliner. Calculates a benefice value for every call and inlines
  * those calls with a value higher than the threshold.
  *
- * @param maxsize      Do not inline any calls if a method has more than
- *                     maxsize firm nodes.  It may reach this limit by
- *                     inlineing.
- * @param threshold    inlining threshold
+ * @param maxsize             Do not inline any calls if a method has more than
+ *                            maxsize firm nodes.  It may reach this limit by
+ *                            inlining.
+ * @param inline_threshold    inlining threshold
+ * @param after_inline_opt    optimizations performed immediately after inlining
+ *                            some calls
  */
-void inline_functions(unsigned maxsize, int inline_threshold);
+void inline_functions(unsigned maxsize, int inline_threshold,
+                      opt_ptr after_inline_opt);
+
+/**
+ * Creates an ir_prog pass for inline_functions().
+ *
+ * @param name               the name of this pass or NULL
+ * @param maxsize            Do not inline any calls if a method has more than
+ *                           maxsize firm nodes.  It may reach this limit by
+       *                     inlineing.
+ * @param inline_threshold   inlining threshold
+ *
+ * @return  the newly created ir_prog pass
+ */
+ir_prog_pass_t *inline_functions_pass(
+       const char *name, unsigned maxsize, int inline_threshold,
+       opt_ptr after_inline_opt);
 
 /**
  * Combines congruent blocks into one.
@@ -814,4 +881,29 @@ void inline_functions(unsigned maxsize, int inline_threshold);
  */
 int shape_blocks(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for shape_blocks().
+ *
+ * @param name   the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *shape_blocks_pass(const char *name);
+
+/**
+ * Perform loop inversion on a given graph.
+ * Loop inversion transform a head controlled loop (like while(...) {} and
+ * for(...) {}) into a foot controlled loop (do {} while(...)).
+ */
+void do_loop_inversion(ir_graph *irg);
+
+/**
+ * Perform loop peeling on a given graph.
+ */
+void do_loop_peeling(ir_graph *irg);
+
+typedef ir_type *(*get_Alloc_func)(ir_node *n);
+/** Set a new get_Alloc_func and returns the old one. */
+get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
+
 #endif