* Copyright: (c) 1998-2003 Universität Karlsruhe
* Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
*/
-# ifndef _IRNODE_H_
-# define _IRNODE_H_
+#ifndef _IRNODE_H_
+#define _IRNODE_H_
#include <stddef.h>
-# include "irgraph.h"
-# include "entity.h"
-# include "firm_common.h"
-# include "irop.h"
-# include "irmode.h"
-# include "type.h"
-# include "irextbb.h"
-# include "dbginfo.h"
+#include "irgraph.h"
+#include "entity.h"
+#include "firm_common.h"
+#include "irop.h"
+#include "irmode.h"
+#include "type.h"
+#include "irextbb.h"
+#include "dbginfo.h"
/**
* @file irnode.h
of node cast to long. */
long get_irn_node_nr (const ir_node *node);
-/** Returns the pinned state of a node. */
+/** Returns the pinned state of a node.
+ *
+ * Returns whether the node _always_ must be pinned.
+ * I.e., the node is not floating after global cse.
+ *
+ * @returns Either state op_pin_state_pinned or op_pin_state_floats.
+ */
op_pin_state get_irn_pinned (const ir_node *node);
/** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
void set_irn_pinned(ir_node *node, op_pin_state state);
+/** Returns whether the node is currently pinned.
+ *
+ * If get_irn_pinned returns op_pin_state_floats and the graph the
+ * node belongs to is in state op_poin_state_floats then this function
+ * returns 'floats', else 'pinned'.
+ */
+op_pin_state is_irn_pinned_in_irg (const ir_node *node);
+
/**
* irnode constructor.
* Create a new irnode in irg, with an op, mode, arity and
*
* @param db Debug info.
* @param irg IR-graph on with this new node should be constructed.
+ * @param block The block the new node belongs to
* @param op The opcode of the new node.
* @param mode The mode of the new node.
* @param arity The arity of the new node, may be <0 if yet.
int arity,
ir_node *in[]);
-/** Return the block the node belongs to.
+/**
+ * Return the block the node belongs to. This is only
+ * possible for pinned nodes or if the graph is in pinned state.
+ * Otherwise the block may be incorrect. This condition is
+ * now checked by an assertion.
*
* This works for all except Block. It can return Blocks or the Bad node.
*
* To express the difference to access routines that work for all
* nodes we use infix "nodes" and do not name this function
- * get_irn_block. */
+ * get_irn_block(). */
ir_node *get_nodes_block (const ir_node *node);
/** Sets the Block of a node. */
* @function get_irn_block()
* @see get_nodes_block()
*/
+
/**
* Projection numbers for result of Start node: use for Proj nodes!
*/
*
* 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);
+ir_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);
+ir_type *is_globals_pointer(ir_node *n);
/** Test whether arbitrary node is value arg base.
*
int get_Block_n_cfgpreds (ir_node *node);
ir_node *get_Block_cfgpred (ir_node *node, int pos);
void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
-bool get_Block_matured (ir_node *node);
-void set_Block_matured (ir_node *node, bool matured);
+/** Get the predecessor block.
+ *
+ * Returns the block corresponding to the predecessor pos of block.
+ *
+ * There are several ambiguities we resolve with this function:
+ * - The direct predecessor can be a Proj, which is not pinned.
+ * We walk from the predecessor to the next pinned node
+ * (skip_Proj) and return the block that node is in.
+ * - If we encounter the Bad node, this function does not return
+ * Start, but the Bad node.
+ */
+ir_node *get_Block_cfgpred_block(ir_node *node, int pos);
+int get_Block_matured (ir_node *node);
+void set_Block_matured (ir_node *node, int matured);
/** A visited flag only for block nodes.
* @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
unsigned long get_Block_block_visited (ir_node *node);
void set_Block_block_visited (ir_node *node, unsigned long visit);
+
+/**
+ * Marks a block as dead but do not replace it with a Bad node.
+ * Dead blocks are removed in the con
+ */
ir_node *set_Block_dead(ir_node *block);
int is_Block_dead(const ir_node *block);
free_End() frees these data structures. */
void free_End (ir_node *end);
+/** Return the target address of an IJmp */
+ir_node *get_IJmp_target(ir_node *ijmp);
+
+/** Sets the target address of an IJmp */
+void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
/* 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.
is recognized by the boolean selector.
The switch Cond has as selector an unsigned integer. It produces as result
an n+1 Tuple (cf0, ... , cfn) of control flows.
- We differ two flavours of this Cond. The first, the dense Cond, passes
+ We differ two flavors of this Cond. The first, the dense Cond, passes
control along output i if the selector value is i, 0 <= i <= n. If the
selector value is >n it passes control along output n.
- The second Cond flavor diffirences in the treatment of cases not specified in
+ The second Cond flavor differences in the treatment of cases not specified in
the source program. It magically knows about the existence of Proj nodes.
It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
exists. Else it passes control along output n (even if this Proj does not
ir_node *get_Return_res (ir_node *node, int pos);
void set_Return_res (ir_node *node, int pos, ir_node *res);
-ir_node *get_Raise_mem (ir_node *node);
-void set_Raise_mem (ir_node *node, ir_node *mem);
-ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
-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. */
- pn_Raise_max /**< number of projections from a Raise */
-} pn_Raise; /* Projection numbers for Raise. */
-
typedef enum {
CNST_NULL = 0, /**< The node is a const(0). */
CNST_ONE = +1, /**< The node is a const(1). */
CNST_ALL_ONE = -1, /**< The node is a const(11111...). */
- CNST_OTHER = 2, /**< The tarvel of the const has another value. */
+ CNST_OTHER = 2, /**< The tarval of the const has another value. */
CNST_SYMCONST = 3, /**< The node is symconst. */
CNST_NO_CONST = 4 /**< The node is no const at all. */
} cnst_classify_t;
/** Returns the source language type of a Const node.
* Must be an atomic type. Mode of type must be mode of node.
*/
-type *get_Const_type (ir_node *node);
+ir_type *get_Const_type (ir_node *node);
/** Sets the source language type of a Const node. */
-void set_Const_type (ir_node *node, type *tp);
+void set_Const_type (ir_node *node, ir_type *tp);
/** This enum names the three different kinds of symbolic Constants
represented by SymConst. The content of the attribute type_or_id
Type_or_id_p is entity *. */
} symconst_kind;
-/** SymConst attributes
- This union contains the symbolic information represented by the node */
+/** SymConst attribute.
+ *
+ * This union contains the symbolic information represented by the node. */
union symconst_symbol {
- type *type_p;
- ident *ident_p;
- entity *entity_p;
+ ir_type *type_p;
+ ident *ident_p;
+ entity *entity_p;
};
typedef union symconst_symbol symconst_symbol;
void set_SymConst_kind (ir_node *node, symconst_kind num);
/** Only to access SymConst of kind type_tag or size. Else assertion: */
-type *get_SymConst_type (ir_node *node);
-void set_SymConst_type (ir_node *node, type *tp);
+ir_type *get_SymConst_type (ir_node *node);
+void set_SymConst_type (ir_node *node, ir_type *tp);
/** Only to access SymConst of kind addr_name. Else assertion: */
ident *get_SymConst_name (ir_node *node);
/** Access the type of the value represented by the SymConst.
*
* Example: primitive type int for SymConst size. */
-type *get_SymConst_value_type (ir_node *node);
-void set_SymConst_value_type (ir_node *node, type *tp);
+ir_type *get_SymConst_value_type (ir_node *node);
+void set_SymConst_value_type (ir_node *node, ir_type *tp);
ir_node *get_Sel_mem (ir_node *node);
void set_Sel_mem (ir_node *node, ir_node *mem);
entity *get_Sel_entity (ir_node *node); /* entity to select */
void set_Sel_entity (ir_node *node, entity *ent);
-/** InstOf access */
-type *get_InstOf_ent (ir_node *node);
-void set_InstOf_ent (ir_node *node, type *ent);
-ir_node *get_InstOf_store (ir_node *node);
-void set_InstOf_store (ir_node *node, ir_node *obj);
-ir_node *get_InstOf_obj (ir_node *node);
-void set_InstOf_obj (ir_node *node, ir_node *obj);
-
/**
* Projection numbers for result of Call node: use for Proj nodes!
*/
an exception */
pn_Call_max = 5 /**< number of projections from a Call */
} pn_Call; /* Projection numbers for Call. */
+#define pn_Call_M pn_Call_M_regular
ir_node *get_Call_mem (ir_node *node);
void set_Call_mem (ir_node *node, ir_node *mem);
/** Sets the call parameter at position pos. */
void set_Call_param (ir_node *node, int pos, ir_node *param);
/** Gets the type of a call. */
-type *get_Call_type (ir_node *node);
+ir_type *get_Call_type (ir_node *node);
/** Sets the type of a call. */
-void set_Call_type (ir_node *node, type *tp);
+void set_Call_type (ir_node *node, ir_type *tp);
/** Gets the arity of a call. Identical to get_Call_n_params(). */
int get_Call_arity (ir_node *node);
typedef enum {
pn_Div_M, /**< Memory result. */
pn_Div_X_except, /**< Execution result if exception occurred. */
- pn_Div_res /**< Result of computation. */
+ pn_Div_res, /**< Result of computation. */
+ pn_Div_max /**< number of projections from a Div */
} pn_Div; /* Projection numbers for Div. */
ir_node *get_Mod_left (ir_node *node);
pn_Cmp_Uge = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
pn_Cmp_Ne = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
pn_Cmp_True = 15 /**< true */
- /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
+ /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for JNI interface */
} pn_Cmp; /* Projection numbers for Cmp */
/* #define not_mask pn_Cmp_Leg */
/** returns the pnc name from an pnc constant */
const char *get_pnc_string(int pnc);
-/** Calculates the negated pnc condition. */
-int get_negated_pnc(int pnc);
+/** Calculates the negated (Complement(R)) pnc condition. */
+int get_negated_pnc(int pnc, ir_mode *mode);
-/** Calculates the swapped pnc condition, i.e., "<" --> ">" */
-int get_swapped_pnc(int pnc);
+/** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
+int get_inversed_pnc(int pnc);
ir_node *get_Cmp_left (ir_node *node);
void set_Cmp_left (ir_node *node, ir_node *left);
*/
ir_node *get_Cast_op (ir_node *node);
void set_Cast_op (ir_node *node, ir_node *op);
-type *get_Cast_type (ir_node *node);
-void set_Cast_type (ir_node *node, type *to_tp);
+ir_type *get_Cast_type (ir_node *node);
+void set_Cast_type (ir_node *node, ir_type *to_tp);
/** Checks for upcast.
*
* Projection numbers for Alloc: use for Proj nodes!
*/
typedef enum {
- pn_Alloc_M, /**< Memory result. */
+ pn_Alloc_M, /**< Memory result. */
pn_Alloc_X_except, /**< Execution result if exception occurred. */
pn_Alloc_res, /**< Result of allocation. */
pn_Alloc_max /**< number of projections from an Alloc */
void set_Alloc_mem (ir_node *node, ir_node *mem);
ir_node *get_Alloc_size (ir_node *node);
void set_Alloc_size (ir_node *node, ir_node *size);
-type *get_Alloc_type (ir_node *node);
-void set_Alloc_type (ir_node *node, type *tp);
+ir_type *get_Alloc_type (ir_node *node);
+void set_Alloc_type (ir_node *node, ir_type *tp);
/** The allocation place. */
typedef enum {
void set_Free_ptr (ir_node *node, ir_node *ptr);
ir_node *get_Free_size (ir_node *node);
void set_Free_size (ir_node *node, ir_node *size);
-type *get_Free_type (ir_node *node);
-void set_Free_type (ir_node *node, type *tp);
+ir_type *get_Free_type (ir_node *node);
+void set_Free_type (ir_node *node, ir_type *tp);
where_alloc get_Free_where (ir_node *node);
void set_Free_where (ir_node *node, where_alloc where);
/** Returns the source language type of a Proj node.
* Must be an atomic type. Mode of type must be mode of node.
*/
-type *get_Proj_type (ir_node *node);
+ir_type *get_Proj_type (ir_node *node);
/** Return the predecessor of a Proj node. */
ir_node *get_Proj_pred (const ir_node *node);
pn_Cmp get_Confirm_cmp (ir_node *node);
void set_Confirm_cmp (ir_node *node, pn_Cmp cmp);
+/*
+ * Mux Support: Note that Psi nodes with one condition can be handled
+ * like Mux nodes, and the access functions work as expected.
+ */
ir_node *get_Mux_sel (ir_node *node);
void set_Mux_sel (ir_node *node, ir_node *sel);
ir_node *get_Mux_false (ir_node *node);
ir_node *get_Mux_true (ir_node *node);
void set_Mux_true (ir_node *node, ir_node *ir_true);
+ir_node *get_Psi_cond (ir_node *node, int pos);
+void set_Psi_cond (ir_node *node, int pos, ir_node *cond);
+ir_node *get_Psi_val (ir_node *node, int pos);
+void set_Psi_val (ir_node *node, int pos, ir_node *val);
+ir_node *get_Psi_default(ir_node *node);
+void set_Psi_default(ir_node *node, ir_node *val);
+int get_Psi_n_conds(ir_node *node);
+
+/**
+ * Projection numbers for result of CopyB node: use for Proj nodes!
+ */
+typedef enum {
+ pn_CopyB_M_regular = 0, /**< The memory result. */
+ pn_CopyB_X_except = 1, /**< The control flow result branching to the exception handler */
+ pn_CopyB_M_except = 2, /**< The memory result in case the runtime function terminated with
+ an exception */
+ pn_CopyB_max = 3 /**< number of projections from a CopyB */
+} pn_CopyB; /* Projection numbers for CopyB. */
+#define pn_CopyB_M pn_CopyB_M_regular
+
+ir_node *get_CopyB_mem (ir_node *node);
+void set_CopyB_mem (ir_node *node, ir_node *mem);
+ir_node *get_CopyB_dst (ir_node *node);
+void set_CopyB_dst (ir_node *node, ir_node *dst);
+ir_node *get_CopyB_src (ir_node *node);
+void set_CopyB_src (ir_node *node, ir_node *src);
+ir_type *get_CopyB_type(ir_node *node);
+void set_CopyB_type(ir_node *node, ir_type *data_type);
+
+/**
+ * Projection numbers for result of InstOf node: use for Proj nodes!
+ */
+typedef enum {
+ pn_InstOf_M_regular = 0, /**< The memory result. */
+ pn_InstOf_X_except = 1, /**< The control flow result branching to the exception handler */
+ pn_InstOf_res = 2, /**< The checked object pointer. */
+ pn_InstOf_M_except = 3, /**< The memory result in case the runtime function terminated with
+ an exception */
+ pn_InstOf_max = 4 /**< number of projections from an InstOf */
+} pn_InstOf;
+#define pn_InstOf_M pn_InstOf_M_regular
+
+/** InstOf access */
+ir_type *get_InstOf_type (ir_node *node);
+void set_InstOf_type (ir_node *node, ir_type *type);
+ir_node *get_InstOf_store (ir_node *node);
+void set_InstOf_store (ir_node *node, ir_node *obj);
+ir_node *get_InstOf_obj (ir_node *node);
+void set_InstOf_obj (ir_node *node, ir_node *obj);
+
+/**
+ * Projection numbers for Raise.
+ */
+typedef enum {
+ pn_Raise_X = 0, /**< The control flow to the exception handler. */
+ pn_Raise_M = 1, /**< The Memory result. */
+ pn_Raise_max /**< number of projections from a Raise */
+} pn_Raise; /* Projection numbers for Raise. */
+
+ir_node *get_Raise_mem (ir_node *node);
+void set_Raise_mem (ir_node *node, ir_node *mem);
+ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
+void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
+
+/**
+ * Projection numbers for result of Bound node: use for Proj nodes!
+ */
+typedef enum {
+ pn_Bound_M_regular = 0, /**< The memory result. */
+ pn_Bound_X_except = 1, /**< The control flow result branching to the exception handler */
+ pn_Bound_res = 2, /**< The checked index. */
+ pn_Bound_M_except = 3, /**< The memory result in case the runtime function terminated with
+ an exception */
+ pn_Bound_max = 4 /**< number of projections from a Bound */
+} pn_Bound;
+#define pn_Bound_M pn_Bound_M_regular
+
+/** Returns the memory input of a Bound operation. */
+ir_node *get_Bound_mem(ir_node *bound);
+void set_Bound_mem (ir_node *bound, ir_node *mem);
+
+/** Returns the index input of a Bound operation. */
+ir_node *get_Bound_index(ir_node *bound);
+void set_Bound_index(ir_node *bound, ir_node *idx);
+
+/** Returns the lower bound input of a Bound operation. */
+ir_node *get_Bound_lower(ir_node *bound);
+void set_Bound_lower(ir_node *bound, ir_node *lower);
+
+/** Returns the upper bound input of a Bound operation. */
+ir_node *get_Bound_upper(ir_node *bound);
+void set_Bound_upper(ir_node *bound, ir_node *upper);
/*
*
/** returns operand of node if node is a Proj. */
ir_node *skip_Proj (ir_node *node);
/** returns operand of node if node is a Id */
-ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
-/* returns corresponding operand of Tuple if node is a Proj from
+ir_node *skip_Id (ir_node *node); /* Old name is skip_nop(). */
+/** returns corresponding operand of Tuple if node is a Proj from
a Tuple. */
ir_node *skip_Tuple (ir_node *node);
/** returns operand of node if node is a Cast */
int is_no_Block (const ir_node *node);
/** returns true if the node is a Block */
int is_Block (const ir_node *node);
-/** returns true if node is a Unknown node. */
+/** returns true if node is an Unknown node. */
int is_Unknown (const ir_node *node);
+/** returns true if node is a Return node. */
+int is_Return (const ir_node *node);
+/** returns true if node is a Call node. */
+int is_Call (const ir_node *node);
+/** returns true if node is a Sel node. */
+int is_Sel (const ir_node *node);
+/** returns true if node is a Mux node or a Psi with only one condition. */
+int is_Mux (const ir_node *node);
/** returns true if node is a Proj node or a Filter node in
* intraprocedural view */
int is_Proj (const ir_node *node);
/** Returns true if the operation is a forking control flow
* operation: Cond. */
-int is_forking_op(const ir_node *node);
+int is_irn_forking(const ir_node *node);
/** Return the type associated with the value produced by n
* if the node remarks this type as it is the case for
- * Cast, Const, SymConst and some Proj nodes. */
-type *get_irn_type(ir_node *n);
+ * Cast, Const, SymConst and some Proj nodes or unknown_type. */
+ir_type *get_irn_type(ir_node *n);
+
+/** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
+ Cast) or NULL.*/
+ir_type *get_irn_type_attr(ir_node *n);
+
+/** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
+entity *get_irn_entity_attr(ir_node *n);
+
+/** Returns non-zero for constant-like nodes. */
+int is_irn_constlike(const ir_node *node);
+
+/**
+ * Returns non-zero for nodes that are allowed to have keep-alives and
+ * are neither Block nor PhiM.
+ */
+int is_irn_keep(const ir_node *node);
+
+/**
+ * Returns non-zero for nodes that are machine operations.
+ */
+int is_irn_machine_op(const ir_node *node);
+
+/**
+ * Returns non-zero for nodes that are machine operands.
+ */
+int is_irn_machine_operand(const ir_node *node);
+
+/**
+ * Returns non-zero for nodes that have the n'th user machine flag set.
+ */
+int is_irn_machine_user(const ir_node *node, unsigned n);
+
+/**
+ * A type to express conditional jump predictions.
+ */
+typedef enum {
+ COND_JMP_PRED_NONE, /**< No jump prediction. Default. */
+ COND_JMP_PRED_TRUE, /**< The True case is predicted. */
+ COND_JMP_PRED_FALSE /**< The False case is predicted. */
+} cond_jmp_predicate;
+
+/** Gets the string representation of the jump prediction .*/
+const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
+
+/** Returns the conditional jump prediction of a Cond node. */
+cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
+
+/** Sets a new conditional jump prediction. */
+void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
/**
* Access custom node data.
*/
unsigned register_additional_node_data(unsigned size);
+/**
+ * Return a pointer to the node attributes.
+ * Needed for user-defined nodes.
+ */
+void *get_irn_generic_attr(ir_node *node);
+
+/**
+ * Returns the unique node index for the node in its graph.
+ * This index is used to access phase information for this node.
+ */
+unsigned get_irn_idx(const ir_node *node);
/*-----------------------------------------------------------------*/
/** Debug aides **/
void dump_irn(ir_node *n);
#include "ident.h"
+#include <stdio.h>
#ifdef __GNUC__
/* GNU C has the __FUNCTION__ extension */
}
#endif
-# endif /* _IRNODE_H_ */
+#endif /* _IRNODE_H_ */