* @remark there are numbers with normalized names below!
*/
typedef enum {
- False = 0, /**< false */
+ False = 0, /**< false */
Eq, /**< equal */
Lt, /**< less */
Le, /**< less or equal */
Ug, /**< unordered or greater */
Uge, /**< unordered, greater or equal */
Ne, /**< unordered, less or greater = not equal */
- True = 15 /**< true */
+ True = 15 /**< true */
/* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
} pnc_number; /* pnc: Projection Number Cmp */
#define not_mask Leg
typedef struct ir_node ir_node;
#endif
+#ifdef __cplusplus
+ extern "C" {
+
+#endif
+
/**
* you can work on the graph without considering the different types
* of nodes, it's just a big graph.
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. */
+ * is in state op_pin_state_pinned (irg is only stored in the block. */
ir_graph *get_irn_irg (ir_node *node);
/** Outputs a unique number for this node if libFIRM is compiled for
/** This works for all except Block. 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. */
-#define get_nodes_block get_nodes_Block
-ir_node *get_nodes_Block (ir_node *node);
-#define set_nodes_block set_nodes_Block
-void set_nodes_Block (ir_node *node, ir_node *block);
+ir_node *get_nodes_block (ir_node *node);
+void set_nodes_block (ir_node *node, ir_node *block);
/**
* @function get_irn_block
* @see get_nodes_block()
*/
-
/**
* 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_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_max /**< number of projections from a Start */
} 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_global_store, /**< Projection on the global store */
- pns_frame_base, /**< Projection on the frame base */
- pns_globals, /**< Projection on the pointer to the data segment
- containing _all_ global entities. */
- pns_args, /**< Projection on all arguments */
- pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
- type of this method. */
-} pns_number; /* pns: Projection Number Start */
/** Test whether arbitrary node is frame pointer.
*
/* frees the memory. */
void remove_Block_cg_cfgpred_arr(ir_node * node);
-/* Start references the irg it is in.
- @@@ old -- use get_irn_irg instead! */
-ir_graph *get_Start_irg(ir_node *node);
-
+/** Keep alive dedicated nodes. These must be either
+ * PhiM or Block nodes. */
int get_End_n_keepalives(ir_node *end);
ir_node *get_End_keepalive(ir_node *end, int pos);
void add_End_keepalive (ir_node *end, ir_node *ka);
free_End frees these data structures. */
void free_End (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.
*/
typedef enum {
pn_Cond_false, /**< Control flow if operand is "false". */
- pn_Cond_true /**< Control flow if operand is "true". */
+ pn_Cond_true, /**< Control flow if operand is "true". */
+ pn_Cond_max /**< number of projections from a Cond */
} pn_Cond; /* Projection numbers for Cond. */
ir_node *get_Return_mem (ir_node *node);
*/
typedef enum {
pn_Raise_X, /**< Execution result. */
- pn_Raise_M /**< Memory result. */
+ pn_Raise_M, /**< Memory result. */
+ pn_Raise_max /**< number of projections from a Raise */
} pn_Raise; /* Projection numbers for Raise. */
tarval *get_Const_tarval (ir_node *node);
entity *get_Sel_entity (ir_node *node); /* entity to select */
void set_Sel_entity (ir_node *node, entity *ent);
-/**
- * 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 */
- pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
- pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
- an exception */
- pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
- passed by value (for compound result types). */
-} pncl_number; /* pncl: Projection Number CaLl */
-
/**
* Projection numbers for result of Call node: use for Proj nodes!
*/
pn_Call_X_except = 1, /**< The control flow result branching to the exception handler */
pn_Call_M_except = 3, /**< The memory result in case the called method terminated with
an exception */
- pn_Call_max = 5 /**< number of prejections from a Call */
+ pn_Call_max = 5 /**< number of projections from a Call */
} pn_Call; /* Projection numbers for Call. */
ir_node *get_Call_mem (ir_node *node);
/** Gets the arity of a call. Identical to get_Call_n_params(). */
int get_Call_arity (ir_node *node);
-/* Set, get and remove the callee-analysis.
- The array is only accessible if information is valid.
- It contains NULL for called methods that are not within
- the compilation unit. */
+/** Set, get and remove the callee information for a Call node.
+ *
+ * The callee information lists all method entities that can be called
+ * from this node. If the address expression can not be analyzed fully,
+ * e.g., as there are external methods that could be called, the array
+ * contains a single NULL entry.
+ *
+ * The array is only accessible if callee information is valid. See flag
+ * in graph.
+ *
+ * The memory allocated for the array is managed automatically, i.e., it must
+ * not be freed if the Call node is removed from the graph.
+ *
+ * @param node A Call node.
+ */
int Call_has_callees (ir_node *node);
-int get_Call_n_callees (ir_node * node);
-entity *get_Call_callee (ir_node * node, int pos);
-/* assumes current_ir_graph set properly! */
-void set_Call_callee_arr (ir_node * node, int n, entity ** arr);
-void remove_Call_callee_arr(ir_node * node);
+int get_Call_n_callees (ir_node *node);
+entity *get_Call_callee (ir_node *node, int pos);
+/** Set the full callee array.
+ *
+ * The passed array is copied. Assumes current_ir_graph set properly! */
+void set_Call_callee_arr (ir_node *node, const int n, entity **arr);
+void remove_Call_callee_arr(ir_node *node);
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);
/** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
int get_FuncCall_arity (ir_node *node);
-/* Set, get and remove the callee-analysis.
- The array is only accessible if information is valid.
- It contains NULL for called methods that are not within
- the compilation unit. */
+/** Set, get and remove the callee information for a Call node.
+ *
+ * The callee information lists all method entities that can be called
+ * from this node. If the address expression can not be analyzed fully,
+ * e.g., as there are external methods that could be called, the array
+ * contains a single NULL entry.
+ *
+ * The array is only accessible if callee information is valid. See flag
+ * in graph.
+ *
+ * The memory allocated for the array is managed automatically, i.e., it must
+ * not be freed if the Call node is removed from the graph.
+ *
+ * @param node A FuncCall node.
+ */
int FuncCall_has_callees (ir_node *node);
int get_FuncCall_n_callees (ir_node * node);
entity *get_FuncCall_callee (ir_node * node, int pos);
typedef enum {
pn_Quot_M, /**< Memory result. */
pn_Quot_X_except, /**< Execution result if exception occured. */
- pn_Quot_res /**< Result of computation. */
+ pn_Quot_res, /**< Result of computation. */
+ pn_Quot_max /**< number of projections from a Quot */
} pn_Quot; /* Projection numbers for Quot. */
ir_node *get_DivMod_left (ir_node *node);
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_res_mod, /**< Result of computation a % b. */
+ pn_DivMod_max /**< number of projections from a DivMod */
} pn_DivMod; /* Projection numbers for DivMod. */
ir_node *get_Div_left (ir_node *node);
typedef enum {
pn_Mod_M, /**< Memory result. */
pn_Mod_X_except, /**< Execution result if exception occured. */
- pn_Mod_res /**< Result of computation. */
+ pn_Mod_res, /**< Result of computation. */
+ pn_Mod_max /**< number of projections from a Mod */
} pn_Mod; /* Projection numbers for Mod. */
ir_node *get_Abs_op (ir_node *node);
int get_Filter_n_cg_preds(ir_node *node);
ir_node *get_Filter_cg_pred(ir_node *node, int pos);
+/** Return true if parameter is a memory operation.
+ *
+ * A memory operation is an operation that directly changes the
+ * memory. I.e., a Load or a Store operation.
+ */
+int is_memop(ir_node *node);
+ir_node *get_memop_mem (ir_node *node);
+void set_memop_mem (ir_node *node, ir_node *mem);
+ir_node *get_memop_ptr (ir_node *node);
+void set_memop_ptr (ir_node *node, ir_node *ptr);
+
/**
* Projection numbers for Load: use for Proj nodes!
*/
typedef enum {
pn_Load_M, /**< Memory result. */
pn_Load_X_except, /**< Execution result if exception occured. */
- pn_Load_res /**< Result of load operation. */
+ pn_Load_res, /**< Result of load operation. */
+ pn_Load_max /**< number of projections from a Load */
} pn_Load; /* Projection numbers for Load. */
-ir_node *get_Load_mem (ir_node *node);
-void set_Load_mem (ir_node *node, ir_node *mem);
-ir_node *get_Load_ptr (ir_node *node);
-void set_Load_ptr (ir_node *node, ir_node *ptr);
+ir_node *get_Load_mem (ir_node *node);
+void set_Load_mem (ir_node *node, ir_node *mem);
+ir_node *get_Load_ptr (ir_node *node);
+void set_Load_ptr (ir_node *node, ir_node *ptr);
+ir_mode *get_Load_mode (ir_node *node);
+void set_Load_mode (ir_node *node, ir_mode *mode);
+ent_volatility get_Load_volatility (ir_node *node);
+void set_Load_volatility (ir_node *node, ent_volatility volatility);
/**
* Projection numbers for Store: use for Proj nodes!
*/
typedef enum {
pn_Store_M, /**< Memory result. */
- pn_Store_X_except /**< Execution result if exception occured. */
+ pn_Store_X_except, /**< Execution result if exception occured. */
+ pn_Store_max /**< number of projections from a Store */
} pn_Store; /* Projection numbers for Store. */
-ir_node *get_Store_mem (ir_node *node);
-void set_Store_mem (ir_node *node, ir_node *mem);
-ir_node *get_Store_ptr (ir_node *node);
-void set_Store_ptr (ir_node *node, ir_node *ptr);
-ir_node *get_Store_value (ir_node *node);
-void set_Store_value (ir_node *node, ir_node *value);
+ir_node *get_Store_mem (ir_node *node);
+void set_Store_mem (ir_node *node, ir_node *mem);
+ir_node *get_Store_ptr (ir_node *node);
+void set_Store_ptr (ir_node *node, ir_node *ptr);
+ir_node *get_Store_value (ir_node *node);
+void set_Store_value (ir_node *node, ir_node *value);
+ent_volatility get_Store_volatility (ir_node *node);
+void set_Store_volatility (ir_node *node, ent_volatility volatility);
/**
* Projection numbers for Alloc: use for Proj nodes!
*/
typedef enum {
- pn_Alloc_M, /**< Memory result. */
- pn_Alloc_X_except, /**< Execution result if exception occured. */
- pn_Alloc_res /**< Result of allocation. */
+ pn_Alloc_M, /**< Memory result. */
+ pn_Alloc_X_except, /**< Execution result if exception occured. */
+ pn_Alloc_res, /**< Result of allocation. */
+ pn_Alloc_max /**< number of projections from an Alloc */
} pn_Alloc; /* Projection numbers for Alloc. */
ir_node *get_Alloc_mem (ir_node *node);
/** 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_nop (ir_node *node);
ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
/* returns corresponding operand of Tuple if node is a Proj from
a Tuple. */
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 */
int is_ip_cfop(ir_node *node);
/** Returns the memory operand of fragile operations. */
ir_node *get_fragile_op_mem(ir_node *node);
+/** Returns true if the operation is a forking control flow
+ * operation: Cond. */
+int is_forking_op(ir_node *node);
+
/*-----------------------------------------------------------------*/
/** Debug aides **/
/*-----------------------------------------------------------------*/
/** Output information about an entity and its owner */
#define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
/** Output information about a graph */
-#define DDMG(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (void *)(X))
+#define DDMG(X) printf("%s(l.%i) graph %s: %ld (%p) in %s %s.\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_entity(X)), get_irg_graph_nr(X), (void *)(X), get_type_tpop_name(get_entity_owner(get_irg_entity(X))), get_type_name(get_entity_owner(get_irg_entity(X))))
/** Output information about an ident */
-#define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
+#define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
/** 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 */
/*@}*/ /* end of ir_node group definition */
+#ifdef __cplusplus
+}
+#endif
+
# endif /* _IRNODE_H_ */