* @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
#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.
* - 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.
* - 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
*/
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.
*
/** 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. */
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 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: extended basic block state. */
-typedef enum {
- ir_extblk_info_none = 0, /**< No extended basic block information is constructed. Default. */
- ir_extblk_info_valid = 1, /**< Extended basic block information is valid. */
- ir_extblk_info_invalid = 2 /**< Extended basic block information is constructed but invalid. */
-} irg_extblk_info_state;
-FIRM_API irg_extblk_info_state get_irg_extblk_state(const ir_graph *irg);
-FIRM_API void set_irg_extblk_inconsistent(ir_graph *irg);
-
-/** state: loopinfo_state
- * Loop information describes the loops within the control and
- * data flow of the procedure.
- */
-typedef enum {
- loopinfo_none = 0, /**< No loop information is constructed. Default. */
- loopinfo_constructed = 1, /**< Some kind of loop information is constructed. */
- loopinfo_valid = 2, /**< Loop information is valid. */
- loopinfo_cf = 4, /**< Loop information constructed for control flow only. */
- loopinfo_inter = 8, /**< Loop information for interprocedural view. */
-
- /** IntRAprocedural loop information constructed and valid. */
- loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
- /** IntRAprocedural loop information constructed and invalid. */
- loopinfo_inconsistent = loopinfo_constructed,
-
- /** IntERprocedural loop information constructed and valid. */
- loopinfo_ip_consistent = loopinfo_constructed | loopinfo_inter | loopinfo_valid,
- /** IntERprocedural loop information constructed and invalid. */
- loopinfo_ip_inconsistent = loopinfo_constructed | loopinfo_inter,
-
- /** IntRAprocedural control loop information constructed and valid. */
- loopinfo_cf_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_valid,
- /** IntRAprocedural control loop information constructed and invalid. */
- loopinfo_cf_inconsistent = loopinfo_constructed | loopinfo_cf,
-
- /** IntERprocedural control loop information constructed and valid. */
- loopinfo_cf_ip_consistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter | loopinfo_valid,
- /** IntERprocedural control loop information constructed and invalid. */
- loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
-} irg_loopinfo_state;
-
-/** Return the current loop information state. */
-FIRM_API irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
-
-/** Sets the current loop information state. */
-FIRM_API void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
-
-/** Sets the loop information state to the appropriate inconsistent state.
- * If state is 'none' does not change. */
-FIRM_API void set_irg_loopinfo_inconsistent(ir_graph *irg);
-/** Sets the loop information state to the appropriate inconsistent state.
- * If state is 'none' does not change.
- * Does this for all irgs. */
-FIRM_API void set_irp_loopinfo_inconsistent(void);
-
/** state: callee_information_state
* Call nodes contain a list of possible callees. This list must be
* computed by an analysis.
/** 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);
/**
* 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. */
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
#endif
/**
- * Graph State
+ * 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)
*/
typedef enum {
- IR_GRAPH_STATE_ARCH_DEP = 1U << 0, /**< should not construct more nodes which irarch potentially breaks down */
- IR_GRAPH_STATE_MODEB_LOWERED = 1U << 1, /**< the only node which may produce mode_b is Cmp */
+ /**
+ * Should not construct more nodes which irarch potentially breaks down
+ */
+ IR_GRAPH_STATE_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,
/**
* 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,
+ IR_GRAPH_STATE_NORMALISATION2 = 1U << 2,
+ /**
+ * 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 << 3,
+ /** graph contains no critical edges */
+ IR_GRAPH_STATE_NO_CRITICAL_EDGES = 1U << 4,
+ /** graph contains no Bad nodes */
+ IR_GRAPH_STATE_NO_BADS = 1U << 5,
/**
- * 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.
+ * 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_IMPLICIT_BITFIELD_MASKING = 1U << 3,
-
- IR_GRAPH_STATE_NO_CRITICAL_EDGES = 1U << 4,
- IR_GRAPH_STATE_NO_BAD_BLOCKS = 1U << 5,
- IR_GRAPH_STATE_NO_UNREACHABLE_BLOCKS = 1U << 6,
- IR_GRAPH_STATE_ONE_RETURN = 1U << 7,
- IR_GRAPH_STATE_CONSISTENT_DOMINANCE = 1U << 8,
- IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 9,
- IR_GRAPH_STATE_CONSISTENT_OUT_EDGES = 1U << 10,
- IR_GRAPH_STATE_CONSISTENT_OUTS = 1U << 11,
- IR_GRAPH_STATE_CONSISTENT_LOOPINFO = 1U << 12,
- IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE = 1U << 13,
- IR_GRAPH_STATE_VALID_EXTENDED_BLOCKS = 1U << 14,
- IR_GRAPH_STATE_BROKEN_FOR_VERIFIER = 1U << 15,
+ IR_GRAPH_STATE_NO_UNREACHABLE_CODE = 1U << 6,
+ /** graph contains at most one return */
+ IR_GRAPH_STATE_ONE_RETURN = 1U << 7,
+ /** dominance information about the graph is valid */
+ IR_GRAPH_STATE_CONSISTENT_DOMINANCE = 1U << 8,
+ /** postdominance information about the graph is valid */
+ IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 9,
+ /**
+ * 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 << 10,
+ /** outs (irouts) are computed and up to date */
+ IR_GRAPH_STATE_CONSISTENT_OUTS = 1U << 11,
+ /** loopinfo is computed and up to date */
+ IR_GRAPH_STATE_CONSISTENT_LOOPINFO = 1U << 12,
+ /** entity usage information is computed and up to date */
+ IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE = 1U << 13,
+ /** graph contains as many returns as possible */
+ IR_GRAPH_STATE_MANY_RETURNS = 1U << 14,
} ir_graph_state_t;
ENUM_BITSET(ir_graph_state_t)
-/** set some state flags on the graph (this does not clear the other flags) */
+/** Sets 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 */
+/** Clears 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 */
+/** Queries 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. */
+/** 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
FIRM_API void set_irg_fp_model(ir_graph *irg, unsigned model);
/**
- * Access custom graph data.
+ * 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.
(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.
(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
*/
FIRM_API size_t register_additional_graph_data(size_t size);
+/** @} */
+
#include "end.h"
#endif
projects / libfirm / blobdiff