X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firgraph.h;h=3c892c25f3937494922178ead67ddc8c4aec91c5;hb=64252961a7d41265ff28353949e63f0662a1cd03;hp=117d80f363b9aa3cb591dfc1f0720d0ed2a81bae;hpb=4b295e5bec7e358e114e2585b1d16f33a11559a0;p=libfirm diff --git a/include/libfirm/irgraph.h b/include/libfirm/irgraph.h index 117d80f36..3c892c25f 100644 --- a/include/libfirm/irgraph.h +++ b/include/libfirm/irgraph.h @@ -21,7 +21,6 @@ * @file * @brief Entry point to the representation of procedure code. * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier - * @version $Id$ */ #ifndef FIRM_IR_IRGRAPH_H #define FIRM_IR_IRGRAPH_H @@ -32,7 +31,7 @@ #include "begin.h" /** - * @page ir_graph The struct ir_graph + * @defgroup ir_graph Procedure Graph * * This struct contains all information about a procedure. * It's allocated directly to memory. @@ -106,18 +105,9 @@ * - visited A int used as flag to traverse the ir_graph. * * - block_visited A int used as a flag to traverse block nodes in the graph. - */ - -/** Global variable holding the current ir graph. * - * This global variable is used by the ir construction - * interface in ircons and by the optimizations. - * Further it is set by all walker functions. + * @{ */ -FIRM_API ir_graph *current_ir_graph; - -FIRM_API ir_graph *get_current_ir_graph(void); -FIRM_API void set_current_ir_graph(ir_graph *graph); /** * Create a new ir graph to build ir for a procedure. @@ -140,7 +130,7 @@ FIRM_API void set_current_ir_graph(ir_graph *graph); * - The end block containing an end node. This block is not matured * after executing new_ir_graph() as predecessors need to be added to it. * (Maturing a block means fixing its number of predecessors.) - * - The current block, which is empty and also not matured. + * - The current block, which is empty and matured. * * Further it enters the global store into the data structure of the start * block that contains all valid values in this block (set_store()). This @@ -168,8 +158,6 @@ FIRM_API ir_graph *new_ir_graph(ir_entity *ent, int n_loc); */ FIRM_API void free_ir_graph(ir_graph *irg); -/* --- access routines for all ir_graph attributes --- */ - /** * Checks whether a pointer points to a ir graph. * @@ -233,6 +221,7 @@ FIRM_API void set_irg_args(ir_graph *irg, ir_node *node); /** Returns the NoMem node of the given IR graph. */ FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg); +/** Sets the NoMem node of graph @p irg. */ FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node); /** Returns the number of value numbers of an IR graph. */ @@ -249,55 +238,16 @@ FIRM_API long get_irg_graph_nr(const ir_graph *irg); FIRM_API size_t get_irg_idx(const ir_graph *irg); /** - * Get the node for an index. + * Returns the node for an index. * @param irg The graph. * @param idx The index you want the node for. * @return The node with that index or NULL, if there is no node with that * index. * @note The node you got might be dead. + * @see get_irn_idx() */ FIRM_API ir_node *get_idx_irn(const ir_graph *irg, unsigned idx); - -/******************************************************************************/ -/* States of an ir_graph. */ -/******************************************************************************/ - -/* - information associated with the graph. Optimizations invalidate these - states. */ - -/** The states of an ir graph. - * - * state phase values: phase_building, phase_high, phase_low, phase_backend. - * - * The graph is in phase_building during construction of the irgraph. - * The construction is finished by a call to finalize_cons(). - * - * Finalize_cons() sets the state to phase_high. All standard Firm nodes are - * allowed. - * - * To get the irgraph into phase_low all Sel nodes must be removed and - * replaced by explicit address computations. SymConst size and - * type tag nodes must be removed (@@@ really?). Initialization of - * memory allocated by Alloc must be explicit. @@@ More conditions? - * - * phase_backend is set if architecture specific machine nodes are inserted - * (and probably most standard Firm are removed). - */ -typedef enum { - phase_building, /**< The graph is still being constructed. */ - phase_high, /**< The construction of the graph is finish, high level nodes may be present. */ - phase_low, /**< High level nodes are removed. */ - phase_backend /**< The graph is taken by the backend. Machine specific nodes may be present. */ -} irg_phase_state; - -/** Returns the phase_state of an IR graph. */ -FIRM_API irg_phase_state get_irg_phase_state(const ir_graph *irg); - -/** Sets the phase state of an IR graph. */ -FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state); - /** state: op_pin_state_pinned The graph is "op_pin_state_pinned" if all nodes are associated with a basic block. It is in state "op_pin_state_floats" if nodes are in arbitrary blocks. In state @@ -307,16 +257,6 @@ FIRM_API void set_irg_phase_state(ir_graph *irg, irg_phase_state state); The enum op_pin_state is defined in irop.h. */ FIRM_API op_pin_state get_irg_pinned(const ir_graph *irg); -/** state: outs_state - * Outs are the back edges or def-use edges of ir nodes. - * Values: outs_none, outs_consistent, outs_inconsistent */ -typedef enum { - outs_none, /**< Outs are not computed, no memory is allocated. */ - outs_consistent, /**< Outs are computed and correct. */ - outs_inconsistent /**< Outs have been computed, memory is still allocated, - but the graph has been changed since. */ -} irg_outs_state; - /** state: callee_information_state * Call nodes contain a list of possible callees. This list must be * computed by an analysis. @@ -336,60 +276,38 @@ FIRM_API irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg); /** Sets the callee_info_state of an IR graph. */ FIRM_API void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s); -/** property: - * Tells how to handle an ir graph in inlining. - */ -typedef enum { - irg_inline_any, /**< No restriction on inlining. Default. */ - irg_inline_forbidden, /**< The graph must not be inlined. */ - irg_inline_recomended, /**< The graph should be inlined. */ - irg_inline_forced, /**< The graph must be inlined. */ - irg_inline_forced_no_body /**< The graph must be inlined. No body is allowed - to be emitted. */ -} irg_inline_property; - -/** Returns the inline property of a graph. */ -FIRM_API irg_inline_property get_irg_inline_property(const ir_graph *irg); -/** Sets the inline property of a graph. */ -FIRM_API void set_irg_inline_property(ir_graph *irg, irg_inline_property s); - -/** - * Returns the mask of the additional graph properties. - * The properties are automatically inherited from the method type - * if they were not set using set_irg_additional_properties() or - * set_irg_additional_properties(). - * - * @return a bitset of mtp_additional_properties values - */ -FIRM_API mtp_additional_properties get_irg_additional_properties(const ir_graph *irg); - -/** Sets the mask of the additional graph properties. */ -FIRM_API void set_irg_additional_properties(ir_graph *irg, - mtp_additional_properties property_mask); - -/** Sets one additional graph property. */ -FIRM_API void add_irg_additional_properties(ir_graph *irg, - mtp_additional_properties flag); - /** A void * field to link arbitrary information to the node. */ FIRM_API void set_irg_link(ir_graph *irg, void *thing); +/** Return void* field previously set by set_irg_link() */ FIRM_API void *get_irg_link(const ir_graph *irg); -/** Increments visited flag by one. - * @see also: get_irn_visited() get_irg_block_visited(). */ +/** Increments node visited counter by one. + * @see @ref visited_counters, irn_visited(), mark_irn_visited() */ FIRM_API void inc_irg_visited(ir_graph *irg); +/** Returns node visited counter. + * @see @ref visited_counters */ FIRM_API ir_visited_t get_irg_visited(const ir_graph *irg); +/** Sets node visited counter. + * @see @ref visited_counters */ FIRM_API void set_irg_visited(ir_graph *irg, ir_visited_t i); -/** An interprocedural flag valid for all irgs. - * @see also: get_irn_visited() get_irg_block_visited(). */ +/** Returns interprocedural node visited counter. + * @see @ref visited_counters */ FIRM_API ir_visited_t get_max_irg_visited(void); +/** Sets interprocedural node visited counter. + * @see @ref visited_counters */ FIRM_API void set_max_irg_visited(int val); +/** Increment interprocedural node visited counter by one. + * @see @ref visited_counters */ FIRM_API ir_visited_t inc_max_irg_visited(void); -/** Increments block_visited by one. - * @see also: get_irn_visited() get_irg_block_visited(). */ +/** Increments block visited counter by one. + * @see @ref visited_counters, Block_block_visited(), mark_Block_block_visited() */ FIRM_API void inc_irg_block_visited(ir_graph *irg); +/** Returns block visited counter. + * @see @ref visited_counters */ FIRM_API ir_visited_t get_irg_block_visited(const ir_graph *irg); +/** Sets block visited counter. + * @see @ref visited_counters */ FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i); /** @@ -398,8 +316,7 @@ FIRM_API void set_irg_block_visited(ir_graph *irg, ir_visited_t i); * if 2 parties try to use the flags. */ typedef enum ir_resources_t { - /* local (irg) resources */ - IR_RESOURCE_NONE = 0, + IR_RESOURCE_NONE = 0, /**< no resource */ IR_RESOURCE_BLOCK_VISITED = 1 << 0, /**< Block visited flags are used. */ IR_RESOURCE_BLOCK_MARK = 1 << 1, /**< Block mark bits are used. */ IR_RESOURCE_IRN_VISITED = 1 << 2, /**< IR-node visited flags are used. */ @@ -410,8 +327,17 @@ typedef enum ir_resources_t { ENUM_BITSET(ir_resources_t) #ifndef NDEBUG +/** + * Reserves resources of a graph. + * + * This is a debug tool: All code should properly allocate the resources it uses + * so if two interlocked algorithms use the same resources that bug will get + * detected. + */ FIRM_API void ir_reserve_resources(ir_graph *irg, ir_resources_t resources); +/** Frees previously reserved resources. */ FIRM_API void ir_free_resources(ir_graph *irg, ir_resources_t resources); +/** Returns currently reserved resources. */ FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg); #else #define ir_reserve_resources(irg,resources) (void)0 @@ -420,90 +346,145 @@ FIRM_API ir_resources_t ir_resources_reserved(const ir_graph *irg); #endif /** - * graph state. This is used for 2 things: - * - stating properties about a graph - * - disallow certain transformations for the graph (typically highlevel - * constructs are disallowed after lowering them) + * graph constraints: + * These are typically used when lowering a graph for a target machine, + * typically you get stricter constraints the closer you get to a real + * machine. */ -typedef enum { +typedef enum ir_graph_constraints_t { /** * Should not construct more nodes which irarch potentially breaks down */ - IR_GRAPH_STATE_ARCH_DEP = 1U << 0, + IR_GRAPH_CONSTRAINT_ARCH_DEP = 1U << 0, /** * mode_b nodes have been lowered so you should not create any new nodes * with mode_b (except for Cmp) */ - IR_GRAPH_STATE_MODEB_LOWERED = 1U << 1, + IR_GRAPH_CONSTRAINT_MODEB_LOWERED = 1U << 1, /** * There are normalisations where there is no "best" representative. * In this case we first normalise into 1 direction (!NORMALISATION2) and * later in the other (NORMALISATION2). */ - IR_GRAPH_STATE_NORMALISATION2 = 1U << 2, - /** - * Define the semantic of Load(Sel(x)), if x has a bit offset (Bitfields!). - * Normally, the frontend is responsible for bitfield masking operations. - * Set IMPLICIT_BITFIELD_MASKING, if the lowering phase must insert masking - * operations. - */ - IR_GRAPH_STATE_IMPLICIT_BITFIELD_MASKING = 1U << 3, + IR_GRAPH_CONSTRAINT_NORMALISATION2 = 1U << 2, /** - * Allow localopts to remove edges to unreachable code. + * Allows localopts to remove edges to unreachable code. * Warning: It is only safe to enable this when you are sure that you * apply all localopts to the fixpunkt. (=in optimize_graph_df) */ - IR_GRAPH_STATE_OPTIMIZE_UNREACHABLE_CODE = 1U << 4, + IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE = 1U << 3, + /** + * The graph is being constructed: We have a current_block set, + * and blocks contain mapping of variable numbers to current + * values. + */ + IR_GRAPH_CONSTRAINT_CONSTRUCTION = 1U << 4, + /** + * Intermediate language constructs not supported by the backend have + * been lowered. + */ + IR_GRAPH_CONSTRAINT_TARGET_LOWERED = 1U << 5, + /** + * We have a backend graph: all data values have register constraints + * annotated. + */ + IR_GRAPH_CONSTRAINT_BACKEND = 1U << 6, +} ir_graph_constraints_t; +ENUM_BITSET(ir_graph_constraints_t) + +/** sets @p constraints on the graph @p irg */ +FIRM_API void add_irg_constraints(ir_graph *irg, + ir_graph_constraints_t constraints); +/** clears some graph constraints */ +FIRM_API void clear_irg_constraints(ir_graph *irg, + ir_graph_constraints_t constraints); +/** queries whether @p irg is at least as constrained as @p constraints. */ +FIRM_API int irg_is_constrained(const ir_graph *irg, + ir_graph_constraints_t constraints); + +/** + * graph state. They properties about a graph. + * Graph transformations may destroy these properties and have to explicitely + * state when they did not affect some properties and want to keep them. + */ +typedef enum ir_graph_properties_t { + IR_GRAPH_PROPERTIES_NONE = 0, /** graph contains no critical edges */ - IR_GRAPH_STATE_NO_CRITICAL_EDGES = 1U << 5, + IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES = 1U << 0, /** graph contains no Bad nodes */ - IR_GRAPH_STATE_NO_BADS = 1U << 6, + IR_GRAPH_PROPERTY_NO_BADS = 1U << 1, + /** No tuple nodes exist in the graph */ + IR_GRAPH_PROPERTY_NO_TUPLES = 1U << 2, /** * there exists no (obviously) unreachable code in the graph. * Unreachable in this context is code that you can't reach by following * execution flow from the start block. */ - IR_GRAPH_STATE_NO_UNREACHABLE_CODE = 1U << 7, + IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE = 1U << 3, /** graph contains at most one return */ - IR_GRAPH_STATE_ONE_RETURN = 1U << 8, + IR_GRAPH_PROPERTY_ONE_RETURN = 1U << 4, /** dominance information about the graph is valid */ - IR_GRAPH_STATE_CONSISTENT_DOMINANCE = 1U << 9, + IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE = 1U << 5, /** postdominance information about the graph is valid */ - IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 10, + IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE = 1U << 6, + /** dominance frontiers information is calculated */ + IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS = 1U << 7, /** * out edges (=iredges) are enable and there is no dead code that can be * reached by following them */ - IR_GRAPH_STATE_CONSISTENT_OUT_EDGES = 1U << 11, + IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES = 1U << 8, /** outs (irouts) are computed and up to date */ - IR_GRAPH_STATE_CONSISTENT_OUTS = 1U << 12, + IR_GRAPH_PROPERTY_CONSISTENT_OUTS = 1U << 9, /** loopinfo is computed and up to date */ - IR_GRAPH_STATE_CONSISTENT_LOOPINFO = 1U << 13, + IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO = 1U << 10, /** entity usage information is computed and up to date */ - IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE = 1U << 14, - /** extended basic blocks have been formed and are up to date */ - IR_GRAPH_STATE_VALID_EXTENDED_BLOCKS = 1U << 15, -} ir_graph_state_t; -ENUM_BITSET(ir_graph_state_t) - -/** set some state flags on the graph (this does not clear the other flags) */ -FIRM_API void set_irg_state(ir_graph *irg, ir_graph_state_t state); -/** clear some state flags of the graph */ -FIRM_API void clear_irg_state(ir_graph *irg, ir_graph_state_t state); -/** query whether a set of graph state flags are activated */ -FIRM_API int is_irg_state(const ir_graph *irg, ir_graph_state_t state); - -/** Set a description for local value n. */ + IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE = 1U << 11, + /** graph contains as many returns as possible */ + IR_GRAPH_PROPERTY_MANY_RETURNS = 1U << 12, + + /** + * List of all graph properties that are only affected by control flow + * changes. + */ + IR_GRAPH_PROPERTIES_CONTROL_FLOW = + IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES + | IR_GRAPH_PROPERTY_ONE_RETURN + | IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE + | IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO + | IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE + | IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE + | IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS, + + /** + * List of all graph properties. + */ + IR_GRAPH_PROPERTIES_ALL = + IR_GRAPH_PROPERTIES_CONTROL_FLOW + | IR_GRAPH_PROPERTY_NO_BADS + | IR_GRAPH_PROPERTY_NO_TUPLES + | IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES + | IR_GRAPH_PROPERTY_CONSISTENT_OUTS + | IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE + | IR_GRAPH_PROPERTY_MANY_RETURNS, + +} ir_graph_properties_t; +ENUM_BITSET(ir_graph_properties_t) + +/** sets some state properties on the graph */ +FIRM_API void add_irg_properties(ir_graph *irg, ir_graph_properties_t props); +/** clears some graph properties */ +FIRM_API void clear_irg_properties(ir_graph *irg, ir_graph_properties_t props); +/** queries whether @p irg has the @p props properties set */ +FIRM_API int irg_has_properties(const ir_graph *irg, + ir_graph_properties_t props); + +/** Sets a description for local value n. */ FIRM_API void set_irg_loc_description(ir_graph *irg, int n, void *description); -/** Get the description for local value n. */ +/** Returns the description for local value n. */ FIRM_API void *get_irg_loc_description(ir_graph *irg, int n); -/** Returns a estimated node count of the irg. This count is updated - * after every irg_walk_graph(). - */ -FIRM_API unsigned get_irg_estimated_node_cnt(const ir_graph *irg); - /** Returns the last irn index for this graph. */ FIRM_API unsigned get_irg_last_idx(const ir_graph *irg); @@ -514,7 +495,20 @@ FIRM_API unsigned get_irg_fp_model(const ir_graph *irg); FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model); /** - * Access custom graph data. + * Ensures that a graph fulfills all properties stated in @p state. + * Performs graph transformations if necessary. + */ +FIRM_API void assure_irg_properties(ir_graph *irg, ir_graph_properties_t props); + +/** + * Invalidates all graph properties/analysis data except the ones specified + * in @p props. + * This should be called after a transformation phase. + */ +FIRM_API void confirm_irg_properties(ir_graph *irg, ir_graph_properties_t props); + +/** + * Accesses custom graph data. * The data must have been registered with * register_additional_graph_data() before. * @param graph The graph to get the data from. @@ -526,7 +520,7 @@ FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model); (assert(off > 0 && "Invalid graph data offset"), (type *) ((char *) (graph) - (off))) /** - * Get the pointer to the node some custom data belongs to. + * Returns the pointer to the node some custom data belongs to. * @param data The pointer to the custom data. * @param off The number as returned by register_additional_graph_data(). * @return A pointer to the ir node the custom data belongs to. @@ -535,7 +529,7 @@ FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model); (assert(off > 0 && "Invalid graph data offset"), (ir_graph *) ((char *) (data) + (off))) /** - * Request additional data to be allocated with an ir graph. + * Requests additional data to be allocated with an ir graph. * @param size The size of the additional data required. * @return A positive number, if the operation was successful, which * must be passed to the access macro get_irg_data(), 0 if the @@ -543,6 +537,8 @@ FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model); */ FIRM_API size_t register_additional_graph_data(size_t size); +/** @} */ + #include "end.h" #endif