* @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.
*
* - proj_args The proj nodes of the args node.
*
- * - bad The Bad node is an auxiliary node. It is needed only once,
- * so there is this globally reachable node.
- *
* - no_mem The NoMem node is an auxiliary node. It is needed only once,
* so there is this globally reachable node.
*
* - 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.
*/
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.
*
/** Sets the frame type of an IR graph. */
FIRM_API void set_irg_frame_type(ir_graph *irg, ir_type *ftp);
-/** Returns the value parameter type of an IR graph. */
-FIRM_API ir_type *get_irg_value_param_type(ir_graph *irg);
-
/** Returns the start block of an IR graph. */
FIRM_API ir_node *get_irg_start_block(const ir_graph *irg);
/** Sets the start block of an IR graph. */
/** Sets the node that represents the argument pointer of the given IR graph. */
FIRM_API void set_irg_args(ir_graph *irg, ir_node *node);
-/** Returns the Bad node of the given IR graph. Use new_Bad() instead!! */
-FIRM_API ir_node *get_irg_bad(const ir_graph *irg);
-FIRM_API void set_irg_bad(ir_graph *irg, ir_node *node);
-
-/** Returns the NoMem node of the given IR graph. Use new_NoMem() instead!! */
+/** Returns the NoMem node of the given IR graph. */
FIRM_API ir_node *get_irg_no_mem(const ir_graph *irg);
FIRM_API void set_irg_no_mem(ir_graph *irg, ir_node *node);
* smaller than get_irp_last_idx()
* Note: you cannot use this number for get_irp_irg()
*/
-FIRM_API int get_irg_idx(const ir_graph *irg);
+FIRM_API size_t get_irg_idx(const ir_graph *irg);
/**
* Get the node for an index.
* index.
* @note The node you got might be dead.
*/
-FIRM_API ir_node *get_idx_irn(ir_graph *irg, unsigned 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;
-FIRM_API irg_outs_state get_irg_outs_state(const ir_graph *irg);
-FIRM_API void set_irg_outs_inconsistent(ir_graph *irg);
-
-/** 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: dom_state
- * Signals the state of the dominator / post dominator information.
- */
-typedef enum {
- dom_none, /**< dominator are not computed, no memory is allocated */
- dom_consistent, /**< dominator information is computed and correct */
- dom_inconsistent /**< dominator information is computed but the graph has been changed since */
-} irg_dom_state;
-
-/** returns the dominator state of an IR graph. */
-FIRM_API irg_dom_state get_irg_dom_state(const ir_graph *irg);
-
-/** returns the post dominator state of an IR graph. */
-FIRM_API irg_dom_state get_irg_postdom_state(const ir_graph *irg);
-
-/** sets the dominator and post dominator state of an IR graph to inconsistent. */
-FIRM_API void set_irg_doms_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.
* if 2 parties try to use the flags.
*/
typedef enum ir_resources_t {
- /* local (irg) resources */
IR_RESOURCE_NONE = 0,
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. */
IR_RESOURCE_IRN_LINK = 1 << 3, /**< IR-node link fields are used. */
IR_RESOURCE_LOOP_LINK = 1 << 4, /**< IR-loop link fields are used. */
- IR_RESOURCE_PHI_LIST = 1 << 5, /**< Block Phi lists are used. */
- IR_RESOURCE_IRG_LINK = 1 << 6, /**< IR-graph link fields used. */
-
- /* global (irp) resources */
- IR_RESOURCE_ENTITY_LINK = 1 << 8, /**< IR-entity link fields are used. */
- IR_RESOURCE_TYPE_VISITED = 1 << 9, /**< type visited flags */
-
- /* masks */
- IR_RESOURCE_LOCAL_MASK = 0x00FF, /**< Mask for all local resources. */
- IR_RESOURCE_GLOBAL_MASK = 0xFF00 /**< Mask for all global resources. */
+ IR_RESOURCE_PHI_LIST = 1 << 5 /**< Block Phi lists are used. */
} ir_resources_t;
ENUM_BITSET(ir_resources_t)
#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_KEEP_MUX = 1U << 0, /**< should perform no further optimisations on Mux nodes */
- IR_GRAPH_STATE_ARCH_DEP = 1U << 1, /**< should not construct more nodes which irarch potentially breaks down */
- IR_GRAPH_STATE_BCONV_ALLOWED = 1U << 2, /**< Conv(mode_b) to Iu is allowed as set command */
+ /**
+ * 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,
+ /**
+ * 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,
+ /**
+ * Allow 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,
+ /** graph contains no critical edges */
+ IR_GRAPH_STATE_NO_CRITICAL_EDGES = 1U << 5,
+ /** graph contains no Bad nodes */
+ IR_GRAPH_STATE_NO_BADS = 1U << 6,
+ /**
+ * 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,
+ /** graph contains at most one return */
+ IR_GRAPH_STATE_ONE_RETURN = 1U << 8,
+ /** dominance information about the graph is valid */
+ IR_GRAPH_STATE_CONSISTENT_DOMINANCE = 1U << 9,
+ /** postdominance information about the graph is valid */
+ IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE = 1U << 10,
+ /**
+ * 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,
+ /** outs (irouts) are computed and up to date */
+ IR_GRAPH_STATE_CONSISTENT_OUTS = 1U << 12,
+ /** loopinfo is computed and up to date */
+ IR_GRAPH_STATE_CONSISTENT_LOOPINFO = 1U << 13,
+ /** 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,
+ /** graph contains as many returns as possible */
+ IR_GRAPH_STATE_MANY_RETURNS = 1U << 16,
} ir_graph_state_t;
ENUM_BITSET(ir_graph_state_t)
*/
FIRM_API size_t register_additional_graph_data(size_t size);
+/** @} */
+
#include "end.h"
#endif
projects / libfirm / blobdiff