/*
- * 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.
*
/**
* @file
* @brief Available Optimisations of libFirm.
- * @version $Id: cfopt.h 13543 2007-04-29 19:29:02Z beck $
+ * @version $Id$
*/
#ifndef FIRM_IROPTIMIZE_H
#define FIRM_IROPTIMIZE_H
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
+ *
+ * @return the newly created ir_graph pass
+ */
+ir_graph_pass_t *optimize_cf_pass(const char *name);
+
+/**
+ * Perform path-sensitive jump threading on the given graph.
+ *
+ * @param irg the graph
+ */
+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.
+ * eg. x < 5 && x < 6 becomes x < 5
*
* @param irg the graph
*/
-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
+ */
+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
*/
-void conv_opt(ir_graph *irg);
+ir_graph_pass_t *conv_opt_pass(const char *name);
/**
* Do the scalar replacement optimization.
* 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);
+
+/**
+ * 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
* 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);
+/**
+ * Creates an ir_graph pass for do_gvn_pre().
+ *
+ * @param name the name of this pass or NULL
+ *
+ * @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.
* 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
*/
/**
* The parameters structure.
*/
-typedef struct _opt_if_conv_info_t {
- int max_depth; /**< The maximum depth up to which expressions
- are examined when it has to be decided if they
- can be placed into another block. */
- arch_allow_ifconv_func allow_ifconv; /**< Evaluator function, if not set all possible Psi
- nodes will be created. */
-} opt_if_conv_info_t;
+struct ir_settings_if_conv_t {
+ int max_depth; /**< The maximum depth up to which expressions
+ are examined when it has to be decided if they
+ can be placed into another block. */
+ arch_allow_ifconv_func allow_ifconv; /**< Evaluator function, if not set all possible Psi
+ nodes will be created. */
+};
/**
* Perform If conversion on a graph.
* Cannot handle blocks with Bad control predecessors, so call it after control
* flow optimization.
*/
-void opt_if_conv(ir_graph *irg, const opt_if_conv_info_t *params);
+void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params);
-void opt_ldst2(ir_graph *irg);
+/**
+ * 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);
+
+/**
+ * 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().
+ *
+ * @param name the name of this pass or NULL
+ *
+ * @return the newly created ir_graph pass
+ */
+ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
+
+/*
+ * Check if we can replace the load by a given const from
+ * the const code irg.
+ *
+ * @param load the load to replace
+ * @param c the constant
+ *
+ * @return in the modes match or can be transformed using a reinterpret cast
+ * returns a copy of the constant (possibly Conv'ed) on the
+ * current_ir_graph
+ */
+ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
/**
* Load/Store optimization.
*
* 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
+ */
+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
*/
-void optimize_load_store(ir_graph *irg);
+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.
*/
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 */
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... */
*/
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.
*/
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
*/
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.
*
* 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
*/
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.
*/
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)
* 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
+ */
+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
*/
-void scalar_replacement_opt(ir_graph *irg);
+ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
/** 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.
*
*/
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.
- * Depends on the flag opt_tail_recursion.
+ * Can currently handle:
+ * - direct return value, i.e. return func().
+ * - additive return value, i.e. return x +/- func()
+ * - multiplicative return value, i.e. return x * func() or return -func()
+ *
+ * The current implementation must be run before optimize_funccalls(),
+ * because it expects the memory edges pointing to calls, which might be
+ * removed by optimize_funccalls().
*/
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);
*/
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.
*
*/
void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct);
-
/** Optimize casting between class types.
*
* class A { m(); }
*/
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.
+ *
+ * @param irg the graph to run on
+ */
+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.
+ *
+ * @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().
+ *
+ * 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);
+
+/**
+ * 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
+ * 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,
+ 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.
+ *
+ * @param irg The IR-graph to optimize.
+ *
+ * @return non-zero if the graph was transformed
+ */
+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
projects / libfirm / blobdiff