# ifndef _IRNODE_H_
# define _IRNODE_H_
-/** Projection numbers of compare: use for Proj nodes! */
-/* @@@ there are numbers with normalized names below! */
+/**
+ * Projection numbers of compare: use for Proj nodes!
+ * @remark there are numbers with normalized names below!
+ */
typedef enum {
False = 0, /**< false */
Eq, /**< equal */
/** returns the number of predecessors without the block predecessor: */
int get_irn_arity (const ir_node *node);
+INLINE int get_irn_intra_arity (const ir_node *node);
+INLINE int get_irn_inter_arity (const ir_node *node);
/** Replaces the old in array by a new one that will contain the ins given in
the parameters. Conserves the block predecessor. It copies the array passed.
/* Access predecessor n */
/* get_irn_n removes Id predecessors. */
INLINE ir_node *get_irn_n (ir_node *node, int n);
+INLINE ir_node *get_irn_intra_n (ir_node *node, int n);
+INLINE ir_node *get_irn_inter_n (ir_node *node, int n);
INLINE void set_irn_n (ir_node *node, int n, ir_node *in);
/** Sets the mode struct of node */
INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
INLINE modecode get_irn_modecode (const ir_node *node);
/** Gets the ident for a string representation of the mode .*/
INLINE ident *get_irn_modeident (const ir_node *node);
+/** Gets the string representation of the mode .*/
+INLINE const char *get_irn_modename (const ir_node *node);
/** Gets the opcode struct of the node */
INLINE ir_op *get_irn_op (const ir_node *node);
/** Sets the opcode struct of the node. */
INLINE int irn_not_visited (const ir_node *node);
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
INLINE int irn_visited (const ir_node *node);
-INLINE void set_irn_link (ir_node *node, void *link);
-INLINE void *get_irn_link (const ir_node *node);
+INLINE void set_irn_link (ir_node *node, void *link);
+INLINE void *get_irn_link (const ir_node *node);
+
+/** Returns the ir_graph this node belongs to. Only valid if irg
+ * is in state pinned (irg is only stored in the block. */
+INLINE ir_graph *get_irn_irg (ir_node *node);
/** Outputs a unique number for this node if libfirm is compiled for
debugging, (configure with --enable-debug) else returns address
of node cast to long. */
-INLINE long get_irn_node_nr(const ir_node *node);
+INLINE long get_irn_node_nr (const ir_node *node);
-/** Returns the ir_graph this node belongs to. Only valid for
- * CallBegin, EndReg, EndExcept and Start */
-INLINE ir_graph *get_irn_irg(ir_node *node);
/**
* irnode constructor.
#define set_nodes_block set_nodes_Block
INLINE void set_nodes_Block (ir_node *node, ir_node *block);
-/** Projection numbers for result of Start node: use for Proj nodes! */
-/* @@@ old name convention! */
+/**
+ * Projection numbers for result of Start node: use for Proj nodes!
+ */
+typedef enum {
+ pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
+ pn_Start_M, /**< Projection on the initial memory. */
+ pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
+ pn_Start_P_globals, /**< Projection on the pointer to the data segment
+ containing _all_ global entities. */
+ pn_Start_T_args, /**< Projection on all arguments. */
+ pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
+ type of this method. */
+} pn_Start; /* Projection numbers for Start. */
+
+/**
+ * Projection numbers for result of Start node: use for Proj nodes!
+ * @remark This is the old name convention, don't use anymore.
+ */
typedef enum {
pns_initial_exec, /**< Projection on an executable, the initial control
flow. */
pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
type of this method. */
} pns_number; /* pns: Projection Number Start */
-typedef enum {
- pn_Start_X_initial_exec, /**< Projection on the initial control flow. */
- pn_Start_M, /**< Projection on the initial memory. */
- pn_Start_P_frame_base, /**< Projection on the frame base pointer. */
- pn_Start_P_globals, /**< Projection on the pointer to the data segment
- containing _all_ global entities. */
- pn_Start_T_args, /**< Projection on all arguments. */
- pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
- type of this method. */
-} pn_Start; /* Projection numbers for Start. */
+
+/** Test whether arbitrary node is frame pointer.
+ *
+ * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
+ * from Start. If so returns frame type, else Null. */
+type *is_frame_pointer(ir_node *n);
+
+/** Test whether arbitrary node is globals pointer.
+ *
+ * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
+ * from Start. If so returns global type, else Null. */
+type *is_globals_pointer(ir_node *n);
+
+/** Test whether arbitrary node is value arg base.
+ *
+ * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
+ * from Start. If so returns 1, else 0. */
+int is_value_arg_pointer(ir_node *n);
/* @@@ no more supported */
/* frees the memory. */
void remove_Block_cg_cfgpred_arr(ir_node * node);
-/* Start references the irg it is in. */
+/* Start references the irg it is in.
+ @@@ old -- use get_irn_irg instead! */
ir_graph *get_Start_irg(ir_node *node);
-void set_Start_irg(ir_node *node, ir_graph *irg);
INLINE int get_End_n_keepalives(ir_node *end);
INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
free_End frees these data structures. */
INLINE void free_End (ir_node *end);
-ir_graph *get_EndReg_irg (const ir_node *end);
-ir_graph *get_EndExcept_irg (const ir_node *end);
+/* @@@ old -- use get_irn_irg instead! */
+ir_graph *get_EndReg_irg (ir_node *end);
+ir_graph *get_EndExcept_irg (ir_node *end);
/* We distinguish three kinds of Cond nodes. These can be distinguished
by the mode of the selector operand and an internal flag of type cond_kind.
INLINE cond_kind get_Cond_kind (ir_node *node);
INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
+/**
+ * Projection numbers for conditions.
+ */
typedef enum {
pn_Cond_false, /**< Control flow if operand is "false". */
pn_Cond_true /**< Control flow if operand is "true". */
INLINE ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
INLINE void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
+/**
+ * Projection numbers for Raise.
+ */
typedef enum {
pn_Raise_X, /**< Execution result. */
pn_Raise_M /**< Memory result. */
linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
by the linker. Type_or_id_p is ident *. */
} symconst_kind;
+
typedef union type_or_id * type_or_id_p;
INLINE symconst_kind get_SymConst_kind (const ir_node *node);
INLINE void set_SymConst_kind (ir_node *node, symconst_kind num);
INLINE entity *get_Sel_entity (ir_node *node); /* entity to select */
INLINE void set_Sel_entity (ir_node *node, entity *ent);
-/** Projection numbers for result of Call node: use for Proj nodes! */
-/* @@@ old name convention! */
+/**
+ * Projection numbers for result of Call node: use for Proj nodes!
+ *
+ * @remark old name convention!
+ */
typedef enum {
pncl_memory = 0, /**< The memory result. */
pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
passed by value (for compound result types). */
} pncl_number; /* pncl: Projection Number CaLl */
+/**
+ * Projection numbers for result of Call node: use for Proj nodes!
+ */
typedef enum {
pn_Call_M_regular = 0, /**< The memory result. */
pn_Call_T_result = 2, /**< The tuple containing all (0, 1, 2, ...) results */
/** Gets the arity of a call. Identical to get_Call_n_params(). */
INLINE int get_Call_arity (ir_node *node);
-/* Set, get and remove the callee-analysis. */
+/* Set, get and remove the callee-analysis.
+ The array is only accessible if intformation is valid.
+ It contains NULL for called methods that are not within
+ the compilation unit. */
+int Call_has_callees (ir_node *node);
int get_Call_n_callees (ir_node * node);
entity *get_Call_callee (ir_node * node, int pos);
void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
ir_node *get_CallBegin_ptr (ir_node *node);
void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
+/* @@@ old -- use get_irn_irg instead! */
ir_graph *get_CallBegin_irg (ir_node *node);
ir_node *get_CallBegin_call (ir_node *node);
void set_CallBegin_call (ir_node *node, ir_node *call);
INLINE ir_node *get_Quot_mem (ir_node *node);
INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
+/**
+ * Projection numbers for Quot: use for Proj nodes!
+ */
typedef enum {
- pn_Quot_X_except, /**< Execution result if exception occured. */
pn_Quot_M, /**< Memory result. */
+ pn_Quot_X_except, /**< Execution result if exception occured. */
pn_Quot_res /**< Result of computation. */
} pn_Quot; /* Projection numbers for Quot. */
INLINE ir_node *get_DivMod_mem (ir_node *node);
INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
+/**
+ * Projection numbers for DivMod: use for Proj nodes!
+ */
typedef enum {
- pn_DivMod_X_except, /**< Execution result if exception occured. */
pn_DivMod_M, /**< Memory result. */
+ pn_DivMod_X_except, /**< Execution result if exception occured. */
pn_DivMod_res_div, /**< Result of computation a / b. */
pn_DivMod_res_mod /**< Result of computation a % b. */
} pn_DivMod; /* Projection numbers for DivMod. */
INLINE ir_node *get_Div_mem (ir_node *node);
INLINE void set_Div_mem (ir_node *node, ir_node *mem);
+/**
+ * Projection numbers for Div: use for Proj nodes!
+ */
typedef enum {
- pn_Div_X_except, /**< Execution result if exception occured. */
pn_Div_M, /**< Memory result. */
+ pn_Div_X_except, /**< Execution result if exception occured. */
pn_Div_res /**< Result of computation. */
} pn_Div; /* Projection numbers for Div. */
INLINE ir_node *get_Mod_mem (ir_node *node);
INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
+/**
+ * Projection numbers for Mod: use for Proj nodes!
+ */
typedef enum {
- pn_Mod_X_except, /**< Execution result if exception occured. */
pn_Mod_M, /**< Memory result. */
+ pn_Mod_X_except, /**< Execution result if exception occured. */
pn_Mod_res /**< Result of computation. */
} pn_Mod; /* Projection numbers for Mod. */
INLINE ir_node *get_Not_op (ir_node *node);
INLINE void set_Not_op (ir_node *node, ir_node *op);
-/* Projection numbers for Cmp are defined several times.
- The bit patterns are used for variouse tests, so don't change.
- The "unordered" values are possible results of comparing
- floating point numbers. */
+/**
+ * Projection numbers for Cmp are defined several times.
+ * The bit patterns are used for variouse tests, so don't change.
+ * The "unordered" values are possible results of comparing
+ * floating point numbers.
+ */
typedef enum {
pn_Cmp_False = 0, /**< false */
pn_Cmp_Eq, /**< equal */
INLINE type *get_Cast_type (ir_node *node);
INLINE void set_Cast_type (ir_node *node, type *to_tp);
+/* Returns true if n is Phi or Filter in interprocedural_view. */
+INLINE int is_Phi (ir_node *n);
+/* These routines also work for Filter nodes in interprocedural view. */
INLINE ir_node **get_Phi_preds_arr (ir_node *node);
INLINE int get_Phi_n_preds (ir_node *node);
INLINE ir_node *get_Phi_pred (ir_node *node, int pos);
int get_Filter_n_cg_preds(ir_node *node);
ir_node * get_Filter_cg_pred(ir_node *node, int pos);
+/**
+ * Projection numbers for Load: use for Proj nodes!
+ */
typedef enum {
- pn_Load_X_except, /**< Execution result if exception occured. */
pn_Load_M, /**< Memory result. */
+ pn_Load_X_except, /**< Execution result if exception occured. */
pn_Load_res /**< Result of load operation. */
} pn_Load; /* Projection numbers for Load. */
INLINE ir_node *get_Load_ptr (ir_node *node);
INLINE void set_Load_ptr (ir_node *node, ir_node *ptr);
+/**
+ * Projection numbers for Store: use for Proj nodes!
+ */
typedef enum {
- pn_Store_X_except, /**< Execution result if exception occured. */
- pn_Store_M /**< Memory result. */
+ pn_Store_M, /**< Memory result. */
+ pn_Store_X_except /**< Execution result if exception occured. */
} pn_Store; /* Projection numbers for Store. */
INLINE ir_node *get_Store_mem (ir_node *node);
INLINE ir_node *get_Store_value (ir_node *node);
INLINE void set_Store_value (ir_node *node, ir_node *value);
+/**
+ * Projection numbers for Alloc: use for Proj nodes!
+ */
typedef enum {
- pn_Alloc_X, /**< Execution result if exception occured. */
pn_Alloc_M, /**< Memory result. */
+ pn_Alloc_X_except, /**< Execution result if exception occured. */
pn_Alloc_res /**< Result of allocation. */
} pn_Alloc; /* Projection numbers for Alloc. */
INLINE type *get_Alloc_type (ir_node *node);
INLINE void set_Alloc_type (ir_node *node, type *tp);
-/** allocation place. */
+/** The allocation place. */
typedef enum {
stack_alloc, /**< Alloc allocates the object on the stack. */
heap_alloc /**< Alloc allocates the object on the heap. */
INLINE ir_node *get_Id_pred (ir_node *node);
INLINE void set_Id_pred (ir_node *node, ir_node *pred);
+/** Confirm has a single result and returns 'value' unchanged.
+ * The node expresses a restriction on 'value':
+ * 'value' 'cmp' 'bound' == true. */
+INLINE ir_node *get_Confirm_value (ir_node *node);
+INLINE void set_Confirm_value (ir_node *node, ir_node *value);
+INLINE ir_node *get_Confirm_bound (ir_node *node);
+INLINE void set_Confirm_bound (ir_node *node, ir_node *bound);
+INLINE pn_Cmp get_Confirm_cmp (ir_node *node);
+INLINE void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
/*
*
INLINE int is_no_Block (ir_node *node);
/** returns true if the node is a Block */
INLINE int is_Block (ir_node *node);
+/** returns true if node is a Unknown node. */
+INLINE int is_Unknown (ir_node *node);
/** returns true if node is a Proj node or a Filter node in
* intraprocedural view */
INLINE int is_Proj (const ir_node *node);
Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
int is_cfop(ir_node *node);
+/* @@@ old -- use get_irn_irg instead! */
+ir_graph *get_ip_cfop_irg(ir_node *n);
+
/** Returns true if the operation manipulates interprocedural control flow:
- CallBegin, EndReg, EndExcept */
+ CallBegin, EndReg, EndExcept */
int is_ip_cfop(ir_node *node);
/** Returns true if the operation can change the control flow because
- of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
- Bad. */
-ir_graph *get_ip_cfop_irg(ir_node *n);
-
+ of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
+ Bad. */
int is_fragile_op(ir_node *node);
/** Returns the memory operand of fragile operations. */
ir_node *get_fragile_op_mem(ir_node *node);
/** Output information about a mode */
#define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
/** Output information about a loop */
-#define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
+#define DDML(X) printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
/** Output information about a tarVal */
#define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));