- removed verify and dump parameters from passes
[libfirm] / include / libfirm / iroptimize.h
index 567f49b..3a1cd6a 100644 (file)
 void optimize_cf(ir_graph *irg);
 
 /**
- * Perform partial conditional evaluation on the given graph.
+ * 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
+ */
+ir_graph_pass_t *optimize_cf_pass(const char *name, int verify, int dump);
+
+/**
+ * Perform path-sensitive jump threading on the given graph.
  *
  * @param irg  the graph
  */
-void opt_cond_eval(ir_graph* irg);
+void opt_jumpthreading(ir_graph* irg);
+
+/**
+ * Creates an ir_graph pass for opt_jumpthreading().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
 
 /**
  * Try to simplify boolean expression in the given ir graph.
@@ -59,12 +79,32 @@ void opt_cond_eval(ir_graph* irg);
  */
 void opt_bool(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for opt_bool().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_bool_pass(const char *name);
+
 /**
  * Try to reduce the number of conv nodes in the given ir graph.
  *
  * @param irg  the graph
+ *
+ * @return non-zero if the optimization could be applied, 0 else
  */
-void conv_opt(ir_graph *irg);
+int conv_opt(ir_graph *irg);
+
+/**
+ * Creates an ir_graph pass for conv_opt().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *conv_opt_pass(const char *name);
 
 /**
  * Do the scalar replacement optimization.
@@ -151,6 +191,23 @@ void escape_analysis(int run_scalar_replace, check_alloc_entity_func callback);
  */
 void optimize_funccalls(int force_run, check_alloc_entity_func callback);
 
+/**
+ * Creates an ir_prog pass for optimize_funccalls().
+ *
+ * @param name       the name of this pass or NULL
+ * @param force_run  if non-zero, an optimization run is started even
+ *                   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
+ *
+ * @return  the newly created ir_prog pass
+ */
+ir_prog_pass_t *optimize_funccalls_pass(
+       const char *name,
+       int force_run, check_alloc_entity_func callback);
+
 /**
  * Does Partial Redundancy Elimination combined with
  * Global Value Numbering.
@@ -162,6 +219,15 @@ void optimize_funccalls(int force_run, check_alloc_entity_func callback);
  */
 void do_gvn_pre(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for do_gvn_pre().
+ *
+ * @param dump     should this pass result be dumped?
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *do_gvn_pre_pass(const char *name);
+
 /**
  * This function is called to evaluate, if a mux can build
  * of the current architecture.
@@ -196,8 +262,28 @@ struct ir_settings_if_conv_t {
  */
 void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params);
 
+/**
+ * Creates an ir_graph pass for opt_if_conv().
+ *
+ * @param name     the name of this pass or NULL
+ * @param params   The parameters for the if conversion.
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_if_conv_pass(
+       const char *name, const ir_settings_if_conv_t *params);
+
 void opt_sync(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for opt_sync().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_sync_pass(const char *name);
+
 /*
  * Check if we can replace the load by a given const from
  * the const code irg.
@@ -235,14 +321,50 @@ ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
  *
  * Store after Load: A Store after a Load is removed, if the
  *   Store doesn't have an exception handler.
+ *
+ * @return non-zero if the optimization could be applied, 0 else
  */
-void optimize_load_store(ir_graph *irg);
+int optimize_load_store(ir_graph *irg);
+
+/**
+ * Creates an ir_graph pass for optimize_load_store().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *optimize_load_store_pass(const char *name);
+
+/**
+ * New experimental alternative to optimize_load_store.
+ * Based on a dataflow analysis, so load/stores are moved out of loops
+ * where possible
+ */
+int opt_ldst(ir_graph *irg);
+
+/**
+ * Creates an ir_graph pass for opt_ldst().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_ldst_pass(const char *name);
 
 /**
  * Do Loop unrolling in the given graph.
  */
 void optimize_loop_unrolling(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for optimize_loop_unrolling().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *optimize_loop_unrolling_pass(const char *name);
+
 /**
  * Optimize the frame type of an irg by removing
  * never touched entities.
@@ -255,6 +377,15 @@ void optimize_loop_unrolling(ir_graph *irg);
  */
 void opt_frame_irg(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for opt_frame_irg().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_frame_irg_pass(const char *name);
+
 /** Possible flags for the Operator Scalar Replacement. */
 typedef enum osr_flags {
        osr_flag_none               = 0,  /**< no additional flags */
@@ -330,6 +461,16 @@ typedef enum osr_flags {
  */
 void opt_osr(ir_graph *irg, unsigned flags);
 
+/**
+ * Creates an ir_graph pass for remove_phi_cycles().
+ *
+ * @param name     the name of this pass or NULL
+ * @param flags    set of osr_flags
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
+
 /**
  * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
  * non-Phi node.
@@ -342,6 +483,16 @@ void opt_osr(ir_graph *irg, unsigned flags);
  */
 void remove_phi_cycles(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for remove_phi_cycles().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
+
+
 /** A default threshold. */
 #define DEFAULT_CLONE_THRESHOLD 300
 
@@ -372,9 +523,18 @@ void proc_cloning(float threshold);
  * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
  * Addressing Expressions.
  *
+ * @return non-zero if the optimization could be applied, 0 else
+ */
+int optimize_reassociation(ir_graph *irg);
+
+/**
+ * Creates an ir_graph pass for optimize_reassociation().
  *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
  */
-void optimize_reassociation(ir_graph *irg);
+ir_graph_pass_t *optimize_reassociation_pass(const char *name);
 
 /**
  * Normalize the Returns of a graph by creating a new End block
@@ -398,6 +558,15 @@ void optimize_reassociation(ir_graph *irg);
  */
 void normalize_one_return(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for normalize_one_return().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *normalize_one_return_pass(const char *name);
+
 /**
  * Normalize the Returns of a graph by moving
  * the Returns upwards as much as possible.
@@ -420,6 +589,15 @@ void normalize_one_return(ir_graph *irg);
  */
 void normalize_n_returns(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for normalize_n_returns().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *normalize_n_returns_pass(const char *name);
+
 /**
  * Do the scalar replacement optimization.
  * Replace local compound entities (like structures and arrays)
@@ -431,6 +609,15 @@ void normalize_n_returns(ir_graph *irg);
  */
 int scalar_replacement_opt(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for scalar_replacement_opt().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
+
 /** Performs strength reduction for the passed graph. */
 void reduce_strength(ir_graph *irg);
 
@@ -452,6 +639,15 @@ void reduce_strength(ir_graph *irg);
  */
 int opt_tail_rec_irg(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for opt_tail_rec_irg().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
+
 /**
  * Optimize tail-recursion calls for all IR-Graphs.
  * Can currently handle:
@@ -465,6 +661,15 @@ int opt_tail_rec_irg(ir_graph *irg);
  */
 void opt_tail_recursion(void);
 
+/**
+ * Creates an ir_prog pass for opt_tail_recursion().
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_prog pass
+ */
+ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
+
 /** This is the type for a method, that returns a pointer type to
  *  tp.  This is needed in the normalization. */
 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
@@ -496,7 +701,6 @@ typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
  */
 void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
 
-
 /**  Insert Casts so that class type casts conform exactly with the type hierarchy
  *   in given graph.
  *
@@ -506,7 +710,6 @@ void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
  */
 void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct);
 
-
 /** Optimize casting between class types.
  *
  *    class A { m(); }
@@ -539,4 +742,76 @@ void optimize_class_casts(void);
  */
 void combo(ir_graph *irg);
 
+/**
+ * Creates an ir_graph pass for combo.
+ *
+ * @param name     the name of this pass or NULL
+ *
+ * @return  the newly created ir_graph pass
+ */
+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.
+ */
+void inline_small_irgs(ir_graph *irg, int size);
+
+
+/** 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.)
+ *
+ *  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.
+ *
+ *  @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);
+
+/**
+ * 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
+ */
+void inline_functions(unsigned maxsize, int inline_threshold);
+
+/**
+ * Combines congruent blocks into one.
+ *
+ * @param irg   The IR-graph to optimize.
+ *
+ * @return non-zero if the graph was transformed
+ */
+int shape_blocks(ir_graph *irg);
+
 #endif