#include <stddef.h>
#include "irop.h"
+#include "irextbb.h"
# ifndef _IRGRAPH_H_
# define _IRGRAPH_H_
-# include "tv.h"
# include "entity.h"
/* to resolve recursion between irnode.h and irgraph.h */
#endif
/**
- * @page ir_graph The struct ir_graph
+ * @page ir_graph The struct ir_graph
*
* This struct contains all information about a procedure.
* It's allocated directly to memory.
* *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 lokal
+ * 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 dataflow
+ * allocated arrays can not be represented as data flow
* edges. Therefore FIRM has to represent them in the stack
* frame.
*
* 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.
*
+ * *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.
*
- * Datastructures that are private to a graph:
+ * Data structures that are private to a graph:
*
* *obst An obstack that contains all nodes.
*
* Only needed for ir construction.
*
* params/n_loc An int giving the number of local variables in this
- * procedure. This is neede for ir construction. Name will
+ * procedure. This is needed for ir construction. Name will
* be changed.
*
* *value_table This hash table (pset) is used for global value numbering
ir_graph *get_current_ir_graph(void);
void set_current_ir_graph(ir_graph *graph);
-/** This flag indicate the current view. The behaviour of some methods
+/** This flag indicate the current view. The behavior of some methods
* (get_irn_*, set_irn_*) is influenced by this flag. */
int get_interprocedural_view(void);
void set_interprocedural_view(int state);
* - The start block containing a start node and Proj nodes for it's
* five results (X, M, P, P, T).
* - 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.
+ * after executing new_ir_graph() as predecessors need to be added to it.
* (Maturing a block means fixing it's number of predecessors.)
* - The current block, which is empty and also not matured.
*
- * Further it enters the global store into the datastructure of the start
- * block that contanis all valid values in this block (set_store()). This
- * datastructure is used to build the Phi nodes and removed after
+ * 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
+ * data structure is used to build the Phi nodes and removed after
* completion of the graph. There is no path from end to start in the
* graph after calling ir_graph.
*
entity *get_irg_entity (const ir_graph *irg);
void set_irg_entity (ir_graph *irg, entity *ent);
-type *get_irg_frame_type (const ir_graph *irg);
+type *get_irg_frame_type (ir_graph *irg);
void set_irg_frame_type (ir_graph *irg, type *ftp);
-/* To test for a frame type. O(#irgs) if ftp is class type. */
-int is_frame_type (const type *ftp);
ir_node *get_irg_start_block (const ir_graph *irg);
void set_irg_start_block (ir_graph *irg, ir_node *node);
/* The fields end_reg and end_except contain the end nodes of the
interprocedural view. If the view is not constructed they contain
- the nomal end node. */
+ the normal end node. */
ir_node *get_irg_end_reg (const ir_graph *irg);
void set_irg_end_reg (ir_graph *irg, ir_node *node);
/** Sets the node that represents the argument pointer. */
void set_irg_args (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. */
+void set_irg_proj_args (ir_graph *irg, ir_node **nodes);
+
/** Returns the current block of a graph. */
ir_node *get_irg_current_block (const ir_graph *irg);
/** Sets the current block of a graph. */
*
* To get the irgraph into phase_low all Sel nodes must be removed and
* replaced by explicit address computations. SymConst size and
- * typetag nodes must be removed (@@@ really?). Initialization of
+ * type tag nodes must be removed (@@@ really?). Initialization of
* memory allocated by Alloc must be explicit. @@@ More conditions?
*
*/
phase_low
} 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);
/** state: op_pin_state_pinned
op_pin_state get_irg_pinned (const ir_graph *irg);
/** state: outs_state
- Outs are the back edges or def-use edges.
- Values: outs_none, outs_consistent, outs_inconsistent
- 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. */
+ * Outs are the back edges or def-use edges of ir nodes.
+ * Values: outs_none, outs_consistent, outs_inconsistent */
typedef enum {
- outs_none,
- outs_consistent,
- outs_inconsistent
+ 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;
irg_outs_state get_irg_outs_state(const ir_graph *irg);
-void set_irg_outs_inconsistent(ir_graph *irg);
+void set_irg_outs_inconsistent(ir_graph *irg);
/** state: dom_state
- Signals the state of the dominator infomation.
- Values: dom_none, dom_consistent, dom_inconsistent
- dom_none: doms are not computed, no memory is allocated. The access routines
- may not be used.
- dom_consistent: dominator information is computed and correct,
- dom_inconsistent: dominator information is computed, memory is still allocated,
- but the graph has been changed since. Using the access routines is possible,
- obtained information may be incorrect. */
+ * Signals the state of the dominator information.
+ */
typedef enum {
- dom_none, /**< doms are not computed, no memory is allocated */
+ 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 */
+ dom_inconsistent /**< dominator information is computed but the graph has been changed since */
} irg_dom_state;
+
+/** returns the dom_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);
/** state: loopinfo_state
- Loop information describes the loops within the control and
- data flow of the procedure. */
+ * 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. */
are used in a switch. */
/** IntRAprocedural loop information constructed and valid. */
- loopinfo_consistent = loopinfo_constructed | loopinfo_valid,
+ loopinfo_consistent = loopinfo_constructed | loopinfo_for_firmjni | loopinfo_valid,
/** IntRAprocedural loop information constructed and invalid. */
loopinfo_inconsistent = loopinfo_constructed | loopinfo_for_firmjni,
loopinfo_cf_ip_inconsistent = loopinfo_constructed | loopinfo_cf | loopinfo_inter
} irg_loopinfo_state;
+/** Return the current loop information state. */
irg_loopinfo_state get_irg_loopinfo_state(const ir_graph *irg);
+
+/** Sets the current loop information state. */
void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
-/** Sets the loopinformation state to the appropriate inconsistent state.
- If state is 'none' does not change. */
+
+/** Sets the loop information state to the appropriate inconsistent state.
+ * If state is 'none' does not change. */
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. */
+void set_irp_loopinfo_inconsistent(void);
/** state: callee_information_state
* Call nodes contain a list of possible callees. This list must be
irg_callee_info_consistent,
irg_callee_info_inconsistent
} irg_callee_info_state;
+
+/** returns the callee_info_state of an IR graph. */
irg_callee_info_state get_irg_callee_info_state(const ir_graph *irg);
+
+/** sets the callee_info_state of an IR graph. */
void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
/** property:
/** Sets the inline property of a graph. */
void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
-/** A void * field to link arbritary information to the node. */
+/** additional graph flags:
+ * Tell about special properties of a graph. Some
+ * of these may be discovered by analyses.
+ */
+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);
+
+/**
+ * calling conventions
+ */
+typedef enum {
+ irg_cc_reg_param = 0x00000001, /**< Transmit parameters in registers, else the stack is used.
+ This flag may be set as default on some architectures. */
+ irg_cc_last_on_top = 0x00000002, /**< The last non-register parameter is transmitted on top of
+ the stack. This is equivalent to the stddecl or pascal
+ calling convention. If this flag is not set, the first
+ non-register parameter is used (cdecl calling convention) */
+ irg_cc_this_call = 0x00000004 /**< The first parameter is a this pointer and is transmitted
+ in a special way. */
+} irg_calling_convention;
+
+/** Returns the calling convention of a graph. */
+unsigned get_irg_calling_convention(const ir_graph *irg);
+
+/** Sets the calling convention of a graph. */
+void set_irg_calling_convention(ir_graph *irg, unsigned cc_mask);
+
+/** Gets the default calling convention for new constructed graphs. */
+unsigned get_firm_default_calling_convention(void);
+
+/** Sets the default calling convention for new constructed graphs. */
+void set_firm_default_calling_convention(unsigned cc_mask);
+
+/** A void * field to link arbitrary information to the node. */
void set_irg_link (ir_graph *irg, void *thing);
void *get_irg_link (const ir_graph *irg);
-/* increments visited by one */
+/** Increments visited flag by one.
+ * @see also: get_irn_visited() get_irg_block_visited(). */
void inc_irg_visited (ir_graph *irg);
unsigned long get_irg_visited (const ir_graph *irg);
void set_irg_visited (ir_graph *irg, unsigned long i);
+/** An interprocedural flag valid for all irgs.
+ * @see also: get_irn_visited() get_irg_block_visited(). */
unsigned long get_max_irg_visited (void);
void set_max_irg_visited (int val);
unsigned long inc_max_irg_visited (void);
-/* increments block_visited by one */
+/** Increments block_visited by one.
+ * @see also: get_irn_visited() get_irg_block_visited(). */
void inc_irg_block_visited (ir_graph *irg);
unsigned long get_irg_block_visited (const ir_graph *irg);
void set_irg_block_visited (ir_graph *irg, unsigned long i);
-/** put the proj's into the same block as its predecessors */
+/** move Proj nodes into the same block as its predecessors */
void normalize_proj_nodes(ir_graph *irg);
+/** set a description for local value n */
+void set_irg_loc_description(ir_graph *irg, int n, void *description);
+
+/** get the description for local value n */
+void *get_irg_loc_description(ir_graph *irg, int n);
+
/**
* Access custom graph data.
* The data must have been registered with
/**
* Request additional data to be allocated with an ir graph.
* @param size The size of the additional data required.
- * @return A positive number, if the opration was successful, which
+ * @return A positive number, if the operation was successful, which
* must be passed to the access macro get_irg_data(), 0 if the
* registration failed.
*/
projects / libfirm / blobdiff