X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;ds=sidebyside;f=include%2Flibfirm%2Firoptimize.h;h=d8be4c8baed0cac94b9863b2e5db1d7ff3e0a476;hb=cdcd17c48e951c6e0201c58b94aaf52a8769703c;hp=e699b62828996e60d52f610f071a5084b31d8a92;hpb=eada6d3620247ce8cde35a2303b286a33b4dd445;p=libfirm diff --git a/include/libfirm/iroptimize.h b/include/libfirm/iroptimize.h index e699b6282..d8be4c8ba 100644 --- a/include/libfirm/iroptimize.h +++ b/include/libfirm/iroptimize.h @@ -20,7 +20,6 @@ /** * @file * @brief Available Optimisations of libFirm. - * @version $Id$ */ #ifndef FIRM_IROPTIMIZE_H #define FIRM_IROPTIMIZE_H @@ -29,6 +28,11 @@ #include "nodeops.h" #include "begin.h" +/** + * @defgroup iroptimize Transformations and Optimisations + * @{ + */ + /** * Control flow optimization. * @@ -39,10 +43,6 @@ * Independent of compiler flag it removes Tuples from cf edges, * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End. * Destroys backedge information. - * - * @bug Chokes on Id nodes if called in a certain order with other - * optimizations. Call local_optimize_graph() before to remove - * Ids. */ FIRM_API void optimize_cf(ir_graph *irg); @@ -72,7 +72,7 @@ FIRM_API void opt_jumpthreading(ir_graph* irg); FIRM_API ir_graph_pass_t *opt_jumpthreading_pass(const char *name); /** - * Try to simplify boolean expression in the given ir graph. + * Simplifies boolean expression in the given ir graph. * eg. x < 5 && x < 6 becomes x < 5 * * @param irg the graph @@ -89,13 +89,11 @@ FIRM_API void opt_bool(ir_graph *irg); FIRM_API ir_graph_pass_t *opt_bool_pass(const char *name); /** - * Try to reduce the number of conv nodes in the given ir graph. + * Reduces 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 */ -FIRM_API int conv_opt(ir_graph *irg); +FIRM_API void conv_opt(ir_graph *irg); /** * Creates an ir_graph pass for conv_opt(). @@ -106,15 +104,6 @@ FIRM_API int conv_opt(ir_graph *irg); */ FIRM_API ir_graph_pass_t *conv_opt_pass(const char *name); -/** - * Do the scalar replacement optimization. - * Make a date flow analyze and split the - * data flow edges. - * - * @param irg the graph which should be optimized - */ -FIRM_API void data_flow_scalar_replacement_opt(ir_graph *irg); - /** * A callback that checks whether a entity is an allocation * routine. @@ -122,7 +111,7 @@ FIRM_API void data_flow_scalar_replacement_opt(ir_graph *irg); typedef int (*check_alloc_entity_func)(ir_entity *ent); /** - * Do simple and fast escape analysis for one graph. + * Performs simple and fast escape analysis for one graph. * * @param irg the graph * @param callback a callback function to check whether a @@ -132,7 +121,7 @@ FIRM_API void escape_enalysis_irg(ir_graph *irg, check_alloc_entity_func callback); /** - * Do simple and fast escape analysis for all graphs. + * Performs simple and fast escape analysis for all graphs. * * This optimization implements a simple and fast but inexact * escape analysis. Some addresses might be marked as 'escaped' even @@ -177,39 +166,16 @@ FIRM_API void escape_analysis(int run_scalar_replace, * graphs. * * If callee information is valid, we also optimize polymorphic Calls. - * - * @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 - * - * 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. */ -FIRM_API void optimize_funccalls(int force_run, - check_alloc_entity_func callback); +FIRM_API void optimize_funccalls(void); /** * 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 */ -FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name, - int force_run, - check_alloc_entity_func callback); +FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name); /** * Does Partial Redundancy Elimination combined with @@ -280,7 +246,7 @@ FIRM_API void opt_parallelize_mem(ir_graph *irg); */ FIRM_API 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. * @@ -317,10 +283,8 @@ FIRM_API 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 */ -FIRM_API int optimize_load_store(ir_graph *irg); +FIRM_API void optimize_load_store(ir_graph *irg); /** * Creates an ir_graph pass for optimize_load_store(). @@ -336,7 +300,7 @@ FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name); * Based on a dataflow analysis, so load/stores are moved out of loops * where possible */ -FIRM_API int opt_ldst(ir_graph *irg); +FIRM_API void opt_ldst(ir_graph *irg); /** * Creates an ir_graph pass for opt_ldst(). @@ -352,7 +316,7 @@ FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name); * * @param irg The graph whose loops will be processed * - * This function did not change the graph, only it's frame type. + * This function did not change the graph, only its frame type. * The layout state of the frame type will be set to layout_undefined * if entities were removed. */ @@ -364,7 +328,7 @@ FIRM_API void loop_optimization(ir_graph *irg); * * @param irg The graph whose frame type will be optimized * - * This function did not change the graph, only it's frame type. + * This function did not change the graph, only its frame type. * The layout state of the frame type will be set to layout_undefined * if entities were removed. */ @@ -389,13 +353,11 @@ typedef enum osr_flags { induction variables. */ } osr_flags; -/* FirmJNI cannot handle identical enum values... */ - /** default setting */ #define osr_flag_default osr_flag_lftr_with_ov_check /** - * Do the Operator Scalar Replacement optimization and linear + * Performs the Operator Scalar Replacement optimization and linear * function test replacement for loop control. * Can be switched off using the set_opt_strength_red() flag. * In that case, only remove_phi_cycles() is executed. @@ -490,7 +452,7 @@ FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name); #define DEFAULT_CLONE_THRESHOLD 20 /** - * Do procedure cloning. Evaluate a heuristic weight for every + * Performs procedure cloning. Evaluate a heuristic weight for every * Call(..., Const, ...). If the weight is bigger than threshold, * clone the entity and fix the calls. * @@ -525,10 +487,8 @@ FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, 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 */ -FIRM_API int optimize_reassociation(ir_graph *irg); +FIRM_API void optimize_reassociation(ir_graph *irg); /** * Creates an ir_graph pass for optimize_reassociation(). @@ -602,15 +562,13 @@ FIRM_API void normalize_n_returns(ir_graph *irg); FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name); /** - * Do the scalar replacement optimization. - * Replace local compound entities (like structures and arrays) + * Performs the scalar replacement optimization. + * Replaces 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 */ -FIRM_API int scalar_replacement_opt(ir_graph *irg); +FIRM_API void scalar_replacement_opt(ir_graph *irg); /** * Creates an ir_graph pass for scalar_replacement_opt(). @@ -621,9 +579,6 @@ FIRM_API int scalar_replacement_opt(ir_graph *irg); */ FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name); -/** Performs strength reduction for the passed graph. */ -FIRM_API void reduce_strength(ir_graph *irg); - /** * Optimizes tail-recursion calls by converting them into loops. * Depends on the flag opt_tail_recursion. @@ -637,10 +592,8 @@ FIRM_API void reduce_strength(ir_graph *irg); * Does not work for Calls that use the exception stuff. * * @param irg the graph to be optimized - * - * @return non-zero if the optimization could be applied, 0 else */ -FIRM_API int opt_tail_rec_irg(ir_graph *irg); +FIRM_API void opt_tail_rec_irg(ir_graph *irg); /** * Creates an ir_graph pass for opt_tail_rec_irg(). @@ -790,8 +743,8 @@ FIRM_API 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 inlining creates new leave - * function inlines these, too. (If g calls f, and f calls leave h, + * Inlines leaf functions. If inlining creates new leafs + * function inlines these, too. (If g calls f, and f calls leaf h, * h is first inlined in f and then f in g.) * * Then inlines all small functions (this is not recursive). @@ -804,34 +757,35 @@ FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size); * @param maxsize Do not inline any calls if a method has more than * maxsize firm nodes. It may reach this limit by * inlining. - * @param leavesize Inline leave functions if they have less than leavesize + * @param leafsize Inline leaf functions if they have less than leafsize * nodes. * @param size Inline all function smaller than size. * @param ignore_runtime count a function only calling runtime functions as - * leave + * leaf */ -FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize, +FIRM_API void inline_leaf_functions(unsigned maxsize, unsigned leafsize, unsigned size, int ignore_runtime); /** - * Creates an ir_prog pass for inline_leave_functions(). + * Creates an ir_prog pass for inline_leaf_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 * inlining. - * @param leavesize Inline leave functions if they have less than leavesize + * @param leafsize Inline leaf functions if they have less than leafsize * nodes. * @param size Inline all function smaller than size. * @param ignore_runtime count a function only calling runtime functions as - * leave + * leaf * * @return the newly created ir_prog pass */ -FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name, - unsigned maxsize, unsigned leavesize, unsigned size, +FIRM_API ir_prog_pass_t *inline_leaf_functions_pass(const char *name, + unsigned maxsize, unsigned leafsize, unsigned size, int ignore_runtime); +/** pointer to an optimization function */ typedef void (*opt_ptr)(ir_graph *irg); /** @@ -870,10 +824,8 @@ FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name, * Combines congruent blocks into one. * * @param irg The IR-graph to optimize. - * - * @return non-zero if the graph was transformed */ -FIRM_API int shape_blocks(ir_graph *irg); +FIRM_API void shape_blocks(ir_graph *irg); /** * Creates an ir_graph pass for shape_blocks(). @@ -930,10 +882,6 @@ FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name); */ FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name); -typedef ir_type *(*get_Alloc_func)(ir_node *n); -/** Set a new get_Alloc_func and returns the old one. */ -FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf); - /** * Creates an ir_graph pass for set_vrp_data() * @@ -1050,7 +998,7 @@ FIRM_API void place_code(ir_graph *irg); FIRM_API ir_graph_pass_t *place_code_pass(const char *name); /** - * Determine information about the values of nodes and perform simplifications + * Determines information about the values of nodes and perform simplifications * using this information. This optimization performs a data-flow analysis to * find the minimal fixpoint. */ @@ -1070,7 +1018,7 @@ FIRM_API void fixpoint_vrp(ir_graph*); FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name); /** - * Check, if the value of a node is != 0. + * Checks if the value of a node is != 0. * * This is a often needed case, so we handle here Confirm * nodes too. @@ -1079,10 +1027,10 @@ FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name); * @param confirm if n is confirmed to be != 0, returns * the the Confirm-node, else NULL */ -FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm); +FIRM_API int value_not_zero(const ir_node *n, const ir_node **confirm); /** - * Check, if the value of a node cannot represent a NULL pointer. + * Checks if the value of a node cannot represent a NULL pointer. * * - If option sel_based_null_check_elim is enabled, all * Sel nodes can be skipped. @@ -1094,10 +1042,10 @@ FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm); * @param confirm if n is confirmed to be != NULL, returns * the the Confirm-node, else NULL */ -FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm); +FIRM_API int value_not_null(const ir_node *n, const ir_node **confirm); /** - * Check, if the value of a node can be confirmed >= 0 or <= 0, + * Checks if the value of a node can be confirmed >= 0 or <= 0, * If the mode of the value did not honor signed zeros, else * check for >= 0 or < 0. * @@ -1106,16 +1054,40 @@ FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm); FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n); /** - * Return the value of a Cmp if one or both predecessors - * are Confirm nodes. + * Returns the value of a Cmp if one or both predecessors are Confirm nodes. * - * @param cmp the compare node that will be evaluated - * @param left the left operand of the Cmp - * @param right the right operand of the Cmp - * @param pnc the compare relation + * @param cmp the compare node that will be evaluated + * @param left the left operand of the Cmp + * @param right the right operand of the Cmp + * @param relation the compare relation */ FIRM_API ir_tarval *computed_value_Cmp_Confirm( - ir_node *cmp, ir_node *left, ir_node *right, pn_Cmp pnc); + const ir_node *cmp, ir_node *left, ir_node *right, ir_relation relation); + +/** Type of callbacks for creating entities of the compiler library */ +typedef ir_entity *(*compilerlib_entity_creator_t)(ident *id, ir_type *mt); + +/** + * Sets the compilerlib entity creation callback that is used to create + * compilerlib function entities. + * + * @param cb the new compilerlib entity creation callback + */ +FIRM_API void set_compilerlib_entity_creator(compilerlib_entity_creator_t cb); + +/** Returns the compilerlib entity creation callback. */ +FIRM_API compilerlib_entity_creator_t get_compilerlib_entity_creator(void); + +/** + * Constructs the entity for a given function using the current compilerlib + * entity creation callback. + * + * @param id the identifier of the compilerlib function + * @param mt the method type of the compilerlib function + */ +FIRM_API ir_entity *create_compilerlib_entity(ident *id, ir_type *mt); + +/** @} */ #include "end.h"