*
* @author Martin Trapp, Christian Schaefer
*/
+#ifndef _FIRM_IR_IRGRAPH_H_
+#define _FIRM_IR_IRGRAPH_H_
#include <stddef.h>
+#include "firm_types.h"
#include "irop.h"
+#include "iropt.h"
#include "irextbb.h"
-
-# ifndef _IRGRAPH_H_
-# define _IRGRAPH_H_
-# include "entity.h"
-
-/* to resolve recursion between irnode.h and irgraph.h */
-#ifndef _IR_NODE_TYPEDEF_
-#define _IR_NODE_TYPEDEF_
-typedef struct ir_node ir_node;
-#endif
-
-/* to resolve recursion between entity.h and irgraph.h */
-#ifndef _IR_GRAPH_TYPEDEF_
-#define _IR_GRAPH_TYPEDEF_
-typedef struct ir_graph ir_graph;
-#endif
+#include "type.h"
/**
* @page ir_graph The struct ir_graph
*
- * This struct contains all information about a procedure.
- * It's allocated directly to memory.
+ * This struct contains all information about a procedure.
+ * It's allocated directly to memory.
*
- * The fields of ir_graph:
+ * The fields of ir_graph:
*
- * *ent The entity describing this procedure.
+ * - ent The entity describing this procedure.
*
- * The beginning and end of a graph:
+ * The beginning and end of a graph:
*
- * *start_block This ir_node is the block that contains the unique
- * start node of the procedure. With it it contains
- * the Proj's on starts results.
- * Further all Const nodes are placed in the start block.
- * *start This ir_node is the unique start node of the procedure.
+ * - start_block This ir_node is the block that contains the unique
+ * start node of the procedure. With it it contains
+ * the Proj's on starts results.
+ * Further all Const nodes are placed in the start block.
+ * - start This ir_node is the unique start node of the procedure.
*
- * *end_block This ir_node is the block that contains the unique
- * end node of the procedure. This block contains no
- * further nodes.
- * *end This ir_node is the unique end node of the procedure.
+ * - end_block This ir_node is the block that contains the unique
+ * end node of the procedure. This block contains no
+ * further nodes.
+ * - end This ir_node is the unique end node of the procedure.
*
- * The following nodes are Projs from the start node, held in ir_graph for
- * simple access:
+ * The following nodes are Projs from the Start node, held in ir_graph for
+ * simple access:
*
- * *frame The ir_node producing the pointer to the stack frame of
- * the procedure as output. This is the Proj node on the
- * third output of the start node. This output of the start
- * node is tagged as pns_frame_base. In FIRM most local
- * variables are modeled as data flow edges. Static
- * allocated arrays can not be represented as data flow
- * edges. Therefore FIRM has to represent them in the stack
- * frame.
+ * - frame The ir_node producing the pointer to the stack frame of
+ * the procedure as output. This is the Proj node on the
+ * third output of the start node. This output of the start
+ * node is tagged as pns_frame_base. In FIRM most local
+ * variables are modeled as data flow edges. Static
+ * allocated arrays can not be represented as data flow
+ * edges. Therefore FIRM has to represent them in the stack
+ * frame.
*
- * *globals This models a pointer to a space in the memory where
- * _all_ global things are held. Select from this pointer
- * with a Sel node the pointer to a global variable /
- * procedure / compiler known function... .
+ * - globals This models a pointer to a space in the memory where
+ * _all_ global things are held. Select from this pointer
+ * with a Sel node the pointer to a global variable /
+ * procedure / compiler known function... .
*
- * *args The ir_node that produces the arguments of the method as
- * it's result. This is a Proj node on the fourth output of
- * the start node. This output is tagged as pn_Start_T_args.
+ * - tls This models a pointer to a space in the memory where
+ * thread local things are held. Select from this pointer
+ * with a Sel node the pointer to a thread local variable.
*
- * *proj_args The proj nodes of the args node.
+ * - args The ir_node that produces the arguments of the method as
+ * it's result. This is a Proj node on the fourth output of
+ * the start node. This output is tagged as pn_Start_T_args.
*
- * *bad The Bad node is an auxiliary node. It is needed only once,
- * so there is this globally reachable node.
+ * - proj_args The proj nodes of the args node.
*
- * *no_mem The NoMem node is an auxiliary node. It is needed only once,
- * so there is this globally reachable node.
+ * - bad The Bad node is an auxiliary node. It is needed only once,
+ * so there is this globally reachable node.
*
- * Data structures that are private to a graph:
+ * - no_mem The NoMem node is an auxiliary node. It is needed only once,
+ * so there is this globally reachable node.
*
- * *obst An obstack that contains all nodes.
+ * Data structures that are private to a graph:
*
- * *current_block A pointer to the current block. Any node created with
- * one of the node constructors (new_<opcode>) are assigned
- * to this block. It can be set with set_cur_block(block).
- * Only needed for ir construction.
+ * - obst An obstack that contains all nodes.
*
- * params/n_loc An int giving the number of local variables in this
- * procedure. This is needed for ir construction. Name will
- * be changed.
+ * - current_block A pointer to the current block. Any node created with
+ * one of the node constructors (new_<opcode>) are assigned
+ * to this block. It can be set with set_cur_block(block).
+ * Only needed for ir construction.
*
- * *value_table This hash table (pset) is used for global value numbering
- * for optimizing use in iropt.c.
+ * - params/n_loc An int giving the number of local variables in this
+ * procedure. This is needed for ir construction. Name will
+ * be changed.
*
- * *Phi_in_stack; a stack needed for automatic Phi construction, needed only
- * during ir construction.
+ * - value_table This hash table (pset) is used for global value numbering
+ * for optimizing use in iropt.c.
*
- * visited A int used as flag to traverse the ir_graph.
+ * - Phi_in_stack; a stack needed for automatic Phi construction, needed only
+ * during ir construction.
*
- * block_visited A int used as a flag to traverse block nodes in the graph.
+ * - isited 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.
* procedure:
*
* - The start block containing a start node and Proj nodes for it's
- * five results (X, M, P, P, T).
+ * seven results (X, M, P, P, P, T, P).
* - 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 it's number of predecessors.)
*
* @see new_pseudo_ir_graph()
*/
-ir_graph *new_ir_graph (entity *ent, int n_loc);
+ir_graph *new_ir_graph (ir_entity *ent, int n_loc);
/** Frees the passed irgraph.
* Deallocates all nodes in this graph and the ir_graph structure.
/* #define get_irg_entity get_irg_ent */
/* #define set_irg_entity set_irg_ent */
-entity *get_irg_entity (const ir_graph *irg);
-void set_irg_entity (ir_graph *irg, entity *ent);
+ir_entity *get_irg_entity (const ir_graph *irg);
+void set_irg_entity (ir_graph *irg, ir_entity *ent);
-type *get_irg_frame_type (ir_graph *irg);
-void set_irg_frame_type (ir_graph *irg, type *ftp);
+ir_type *get_irg_frame_type (ir_graph *irg);
+void set_irg_frame_type (ir_graph *irg, ir_type *ftp);
ir_node *get_irg_start_block (const ir_graph *irg);
void set_irg_start_block (ir_graph *irg, ir_node *node);
ir_node *get_irg_end_except (const ir_graph *irg);
void set_irg_end_except (ir_graph *irg, ir_node *node);
-
-/* @@@ oblivious, no more supported. */
-ir_node *get_irg_cstore (const ir_graph *irg);
-void set_irg_cstore (ir_graph *irg, ir_node *node);
-/* end oblivious */
-
/** Returns the node that represents the frame pointer. */
ir_node *get_irg_frame (const ir_graph *irg);
/** Sets the node that represents the frame pointer. */
/** Sets the node that represents the global pointer. */
void set_irg_globals (ir_graph *irg, ir_node *node);
+/** Returns the node that represents the tls pointer. */
+ir_node *get_irg_tls (const ir_graph *irg);
+/** Sets the node that represents the tls pointer. */
+void set_irg_tls (ir_graph *irg, ir_node *node);
+
/** Returns the node that represents the initial memory. */
ir_node *get_irg_initial_mem (const ir_graph *irg);
/** Sets the node that represents the initial memory. */
/** Sets the node that represents the argument pointer. */
void set_irg_args (ir_graph *irg, ir_node *node);
+/** Returns the node that represents the value parameter base pointer. */
+ir_node *get_irg_value_param_base (const ir_graph *irg);
+/** Sets the node that represents the value parameter base pointer. */
+void set_irg_value_param_base (ir_graph *irg, ir_node *node);
+
/** Returns an array of the nodes of the argument pointer. */
ir_node **get_irg_proj_args (const ir_graph *irg);
/** Sets the array of the nodes of the argument pointer. */
/** The states of an ir graph.
*
- * state phase values: phase_building, phase_high, phase_low.
+ * 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 Firm nodes are
+ * 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
* 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,
phase_high,
- phase_low
+ phase_low,
+ phase_backend
} irg_phase_state;
/** returns the phase_state of an IR graph. */
irg_phase_state get_irg_phase_state (const ir_graph *irg);
/** sets the phase state of an IR graph. */
-void set_irg_phase_low(ir_graph *irg);
+void set_irg_phase_state(ir_graph *irg, irg_phase_state state);
+
+#define set_irg_phase_low(irg) set_irg_phase_state(irg, phase_low)
/** state: op_pin_state_pinned
The graph is "op_pin_state_pinned" if all nodes are associated with a basic block.
irg_outs_state get_irg_outs_state(const ir_graph *irg);
void set_irg_outs_inconsistent(ir_graph *irg);
+/** state: extended basic block state. */
+typedef enum {
+ extblk_none = 0, /**< No extended basic block information is constructed. Default. */
+ extblk_valid = 1, /**< Extended basic block information is valid. */
+ extblk_invalid = 2 /**< Extended basic block information is constructed but invalid. */
+} irg_extblk_state;
+irg_extblk_state get_irg_extblk_state(const ir_graph *irg);
+void set_irg_extblk_inconsistent(ir_graph *irg);
+
/** state: dom_state
- * Signals the state of the dominator information.
+ * Signals the state of the dominator / post dominator information.
*/
typedef enum {
dom_none, /**< dominator are not computed, no memory is allocated */
dom_inconsistent /**< dominator information is computed but the graph has been changed since */
} irg_dom_state;
-/** returns the dom_state of an IR graph. */
+/** returns the dominator state of an IR graph. */
irg_dom_state get_irg_dom_state(const ir_graph *irg);
-/** sets the dom_state of an IR graph. */
-void set_irg_dom_inconsistent(ir_graph *irg);
+/** returns the post dominator state of an IR graph. */
+irg_dom_state get_irg_postdom_state(const ir_graph *irg);
+
+/** sets the dominator and post dominator state of an IR graph to inconsistent. */
+void set_irg_doms_inconsistent(ir_graph *irg);
/** state: loopinfo_state
* Loop information describes the loops within the control and
* Tells how to handle an ir graph in inlineing.
*/
typedef enum {
- irg_inline_any, /**< No restriction on inlineing. Default. */
- irg_inline_forbidden, /**< The graph may not be inlined. */
- irg_inline_recomended, /**< The graph should be inlined. */
- irg_inline_forced /**< The graph must be inlined. */
+ irg_inline_any, /**< No restriction on inlineing. Default. */
+ irg_inline_forbidden, /**< The graph may 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. */
/** Sets the inline property of a graph. */
void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
-/** additional graph flags:
- * Tell about special properties of a graph. Some
- * of these may be discovered by analyses.
+/**
+ * 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_property().
*/
-typedef enum {
- irg_const_function = 0x00000001, /**< This graph did not access memory and calculates
- its return values solely from its parameters.
- GCC: __attribute__((const)). */
- irg_pure_function = 0x00000002, /**< This graph did NOT write to memory and calculates
- its return values solely form its parameters and
- the memory they points to (or global vars).
- GCC: __attribute__((pure)). */
- irg_noreturn_function = 0x00000004, /**< This graph did not return due to an aborting system
- call.
- GCC: __attribute__((noreturn)). */
- irg_nothrow_function = 0x00000008, /**< This graph cannot throw an exception.
- GCC: __attribute__((nothrow)). */
- irg_naked_function = 0x00000010, /**< This graph is naked.
- GCC: __attribute__((naked)). */
- irg_malloc_function = 0x00000020 /**< This graph returns newly allocate memory.
- GCC: __attribute__((malloc)). */
-} irg_additional_property;
-
-/** Returns the mask of the additional graph properties. */
unsigned get_irg_additional_properties(const ir_graph *irg);
/** Sets the mask of the additional graph properties. */
void set_irg_additional_properties(ir_graph *irg, unsigned property_mask);
/** Sets one additional graph property. */
-void set_irg_additional_property(ir_graph *irg, irg_additional_property flag);
+void set_irg_additional_property(ir_graph *irg, mtp_additional_property flag);
/** A void * field to link arbitrary information to the node. */
void set_irg_link (ir_graph *irg, void *thing);
unsigned long get_irg_block_visited (const ir_graph *irg);
void set_irg_block_visited (ir_graph *irg, unsigned long i);
+/** Flags indicating whether or not we are inside an irg/block walk. */
+void set_inside_block_walk(ir_graph *irg);
+void clear_inside_block_walk(ir_graph *irg);
+unsigned inside_block_walk(const ir_graph *irg);
+void set_inside_irg_walk(ir_graph *irg);
+void clear_inside_irg_walk(ir_graph *irg);
+unsigned inside_irg_walk(const ir_graph *irg);
+
/** move Proj nodes into the same block as its predecessors */
void normalize_proj_nodes(ir_graph *irg);
/** get the description for local value n */
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().
+ */
+unsigned get_irg_estimated_node_cnt(const ir_graph *irg);
+
+/** Returns the last irn index for this graph. */
+unsigned get_irg_last_idx(const ir_graph *irg);
+
+/** Returns the floating point model of this graph. */
+unsigned get_irg_fp_model(const ir_graph *irg);
+
+/** Sets a floating point model for this graph. */
+void set_irg_fp_model(ir_graph *irg, unsigned model);
+
/**
* Access custom graph data.
* The data must have been registered with
*/
size_t register_additional_graph_data(size_t size);
-# endif /* _IRGRAPH_H_ */
+#endif /* _FIRM_IR_IRGRAPH_H_ */
projects / libfirm / blobdiff