* Purpose: Various irnode constructors. Automatic construction
* of SSA representation.
* Author: Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier, Boris Boesler
+ * Modified by: Goetz Lindenmaier, Boris Boesler, Michael Beck
* Created:
* CVS-ID: $Id$
- * Copyright: (c) 1998-2003 Universität Karlsruhe
+ * Copyright: (c) 1998-2006 Universität Karlsruhe
* Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
*/
/**
@todo
- Ideas for imrovement:
+ Ideas for improvement:
-# Handle construction of exceptions more comfortable:
Add new constructors that pass the exception region (or better the
Phi for the memories, the ex. region can be found from there) as parameter,
* ir_node *new_IJmp (ir_node *tgt);
* ir_node *new_Cond (ir_node *c);
* ir_node *new_Return (ir_node *store, int arity, ir_node **in);
- * ir_node *new_Raise (ir_node *store, ir_node *obj);
* ir_node *new_Const (ir_mode *mode, tarval *con);
* ir_node *new_SymConst (symconst_symbol value, symconst_kind kind);
- * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, entity *ent);
+ * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent);
* ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
- * ir_node **in, entity *ent);
- * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
+ * ir_node **in, ir_entity *ent);
* ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
* ir_node **in, type_method *type);
* ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
* ir_node *new_Cmp (ir_node *op1, ir_node *op2);
* ir_node *new_Conv (ir_node *op, ir_mode *mode);
* ir_node *new_Cast (ir_node *op, ir_type *to_tp);
+ * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
+ * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
* ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode);
* ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
* ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
* ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
* ir_node *new_NoMem (void);
* ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
+ * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
* ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
+ * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
+ * ir_node *new_Raise (ir_node *store, ir_node *obj);
* ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+ * ir_node *new_Pin (ir_node *node);
*
* void add_immBlock_pred (ir_node *block, ir_node *jmp);
* void mature_immBlock (ir_node *block);
* Output
* Control flow to the end block.
*
- * ir_node *new_Raise (ir_node *store, ir_node *obj)
- * -------------------------------------------------
- *
- * Raises an exception. Unconditional change of control flow. Writes
- * an explicit Except variable to memory to pass it to the exception
- * handler. See TechReport 1999-14, chapter Exceptions.
- *
- * Inputs:
- * The memory state.
- * A pointer to the Except variable.
- * Output:
- * A tuple of control flow and the changed memory state. The control flow
- * points to the exception handler if it is definied in this procedure,
- * else it points to the end_block.
- *
- *
* ---------
*
* ir_node *new_Const (ir_mode *mode, tarval *con)
* ---------------------------------------------------------------------------
*
* There are three kinds of symbolic constants:
- * symconst_type_tag The symbolic constant represents a type tag.
- * symconst_size The symbolic constant represents the size of a class.
- * symconst_addr_name Information for the linker, e.g. the name of a global
- * variable.
+ * symconst_type_tag The symbolic constant represents a type tag.
+ * symconst_type_size The symbolic constant represents the size of a type.
+ * symconst_type_align The symbolic constant represents the alignment of a type.
+ * symconst_addr_name Information for the linker, e.g. the name of a global
+ * variable.
+ * symconst_addr_name The symbolic constant represents the address of an entity.
+ *
* To represent a pointer to an entity that is represented by an entity
* datastructure don't use
* new_SymConst((type_or_id*)get_entity_ld_ident(ent), symconst_addr_name);.
* Use a real const instead:
- * new_SymConst(mode_P_mach, tarval_p_from_entity(ent));
+ * new_SymConst(ent, symconst_addr_ent);
* This makes the Constant independent of name changes of the entity due to
* mangling.
*
* Attributes:
* attr.i.num The symconst_addr_ent, i.e. one of
* -symconst_type_tag
- * -symconst_size
- * - symconst_addr_name
- * If the attr.i.num is symconst_type_tag or symconst_size, the node contains an attribute
+ * -symconst_type_size
+ * -symconst_type_align
+ * -symconst_addr_name
+ *
+ * If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align,
+ * the node contains an attribute:
+ *
* attr.i.*type, a pointer to a type_class. The mode of the node is mode_Is.
* if it is linkage_ptr_info it contains
* attr.i.*ptrinfo, an ident holding information for the linker. The mode
*
* ---------------
*
- * ir_node *new_simpleSel (ir_node *store, ir_node *frame, entity *sel)
- * --------------------------------------------------------------------
+ * ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
+ * -----------------------------------------------------------------------
*
*
* Selects an entity from a compound type. This entity can be a field or
*
* ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
* --------------------------------------------------------------------------
- * entity *sel)
- * ------------
+ * ir_entity *sel)
+ * ---------------
*
* Selects a field from an array type. The entity has as owner the array, as
* type the arrays element type. The indices to access an array element are
*
* Rotates the operand to the (right??) by k bits.
*
+ * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
+ * ------------------------------------------------------------
+ *
+ * Calculates the Carry value for integer addition. Used only
+ * in lowering code.
+ *
+ * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
+ * ------------------------------------------------------------
+ *
+ * Calculates the Borrow value for integer substraction. Used only
+ * in lowering code.
+ *
* ir_node *new_Conv (ir_node *op, ir_mode *mode)
* ---------------------------------------------
*
* ir_true, else ir_false;
*
*
+ * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode)
+ * -----------------------------------------------------------------------------
+ *
+ * Creates a Psi node. This node implements the following semantic:
+ * Enter it here!!!
+ *
+ *
* OPERATIONS TO MANAGE MEMORY EXPLICITLY
* --------------------------------------
*
* This node is used as input for operations that need a Memory, but do not
* change it like Div by const != 0, analyzed calls etc.
*
- * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
- * -----------------------------------------------------------------------------------
- *
- * Describes a high level block copy of a compound type form address src to
- * address dst. Must be lowered to a Call to a runtime memory copy function.
- *
- * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
- * -----------------------------------------------------------------------------------
- *
- * Describes a high level bounds check. Must be lowered to a Call to a runtime check
- * function.
- *
* ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
* ----------------------------------------------------------
*
- * Selects one entry of a tuple. This is a hidden `fat edge'.
+ * Selects one entry of a tuple. This is a hidden edge with attributes.
*
* Parameters
* *arg A node producing a tuple.
* replaced by the Tuple operation so that the following Proj nodes have not to
* be changed. (They are hard to find due to the implementation with pointers
* in only one direction.) The Tuple node is smaller than any other
- * node, so that a node can be changed into a Tuple by just changing it's
+ * node, so that a node can be changed into a Tuple by just changing it's
* opcode and giving it a new in array.
*
* Parameters
* for optimizations.
*
*
+ * HIGH LEVEL OPERATIONS
+ * ---------------------
+ *
+ * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
+ * -----------------------------------------------------------------------------------
+ *
+ * Describes a high level block copy of a compound type from address src to
+ * address dst. Must be lowered to a Call to a runtime memory copy function.
+ *
+ *
+ * HIGH LEVEL OPERATIONS: Exception Support
+ * ----------------------------------------
+ * See TechReport 1999-14, chapter Exceptions.
+ *
+ * ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
+ * -----------------------------------------------------------------------------------
+ *
+ * Describes a high level type check. Must be lowered to a Call to a runtime check
+ * function.
+ *
+ * ir_node *new_Raise (ir_node *store, ir_node *obj)
+ * -------------------------------------------------
+ *
+ * Raises an exception. Unconditional change of control flow. Writes
+ * an explicit Except variable to memory to pass it to the exception
+ * handler. Must be lowered to a Call to a runtime check
+ * function.
+ *
+ * Inputs:
+ * The memory state.
+ * A pointer to the Except variable.
+ * Output:
+ * A tuple of control flow and the changed memory state. The control flow
+ * points to the exception handler if it is definied in this procedure,
+ * else it points to the end_block.
+ *
+ * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+ * -----------------------------------------------------------------------------------
+ *
+ * Describes a high level bounds check. Must be lowered to a Call to a runtime check
+ * function.
+ *
+ * ir_node *new_Pin (ir_node *node);
+ * -----------------------------------------------------------------------------------
+ *
+ * Pin the value of the node node in the current block No users of the Pin node can
+ * float above the Block of the Pin. The node cannot float behind this block. Often
+ * used to Pin the NoMem node.
+ *
+ *
* COPING WITH DATA OBJECTS
* ========================
*
*
* All values known in a Block are listed in the block's attribute,
* block.**graph_arr which is used to automatically insert Phi nodes.
- * The following two funcions can be used to add a newly computed value
+ * The following two functions can be used to add a newly computed value
* to the array, or to get the producer of a value, i.e., the current
* live value.
*
* node.
*
*/
-#ifndef _IRCONS_H_
-#define _IRCONS_H_
+#ifndef _FIRM_IR_IRCONS_H_
+#define _FIRM_IR_IRCONS_H_
#include "firm_common.h"
#include "irnode.h"
+#include "irgraph.h"
#include "dbginfo.h"
/*-------------------------------------------------------------------------*/
ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *store, int arity, ir_node *in[]);
-/** Constructor for a Raise node.
- *
- * @param *db A pointer for debug information.
- * @param *irg The ir graph the node belongs to.
- * @param *block The ir block the node belongs to.
- * @param *store The current memory.
- * @param *obj A pointer to the Except variable.
- */
-ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *store, ir_node *obj);
-
/** Constructor for a Const_type node.
*
* The constant represents a target value. This constructor sets high
* @param *tp The type of the constant.
*/
ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_mode *mode, tarval *con, ir_type *tp);
+ ir_mode *mode, tarval *con, ir_type *tp);
/** Constructor for a Const node.
*
* @param *con Points to an entry in the constant table.
*/
ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_mode *mode, tarval *con);
+ ir_mode *mode, tarval *con);
/** Constructor for a SymConst_type node.
*
* This is the constructor for a symbolic constant.
* There are four kinds of symbolic constants:
- * - type_tag The symbolic constant represents a type tag. The type the
- * tag stands for is given explicitly.
- * - size The symbolic constant represents the size of a type. The
- * type of which the constant represents the size is given
- * explicitly.
- * - addr_name The symbolic constant represents the address of an entity
- * (variable or method). The variable is indicated by a name
- * that is valid for linking.
+ * - type_tag The symbolic constant represents a type tag. The type the
+ * tag stands for is given explicitly.
+ * - type_size The symbolic constant represents the size of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * - type_align The symbolic constant represents the alignment of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * - addr_name The symbolic constant represents the address of an entity
+ * (variable or method). The variable is indicated by a name
+ * that is valid for linking.
* - addr_ent The symbolic constant represents the address of an entity
- * (variable or method). The variable is given explicitly by
- * a firm entity.
+ * (variable or method). The variable is given explicitly by
+ * a firm entity.
*
* Inputs to the node:
* No inputs except the block it belongs to.
* @param tp The source type of the constant.
*/
ir_node *new_rd_SymConst_type (dbg_info *db, ir_graph *irg, ir_node *block, union symconst_symbol value,
- symconst_kind symkind, ir_type *tp);
+ symconst_kind symkind, ir_type *tp);
/** Constructor for a SymConst node.
*
* Same as new_rd_SymConst_type, except that it sets the type to type_unknown. */
ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block,
- union symconst_symbol value, symconst_kind symkind);
+ union symconst_symbol value, symconst_kind symkind);
/** Constructor for a SymConst addr_ent node.
*
* Same as new_rd_SymConst_type, except that the constructor is tailored for
* symconst_addr_ent.
* Adds the SymConst to the start block of irg. */
-ir_node *new_rd_SymConst_addr_ent (dbg_info *db, ir_graph *irg, entity *symbol, ir_type *tp);
+ir_node *new_rd_SymConst_addr_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
+
+/** Constructor for a SymConst ofs_ent node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_ofs_ent.
+ * Adds the SymConst to the start block of irg. */
+ir_node *new_rd_SymConst_ofs_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_type *tp);
/** Constructor for a SymConst addr_name node.
*
/** Constructor for a SymConst size node.
*
* Same as new_rd_SymConst_type, except that the constructor is tailored for
- * symconst_addr_ent.
+ * symconst_type_size.
* Adds the SymConst to the start block of irg. */
ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
+/** Constructor for a SymConst size node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_type_align.
+ * Adds the SymConst to the start block of irg. */
+ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp);
+
/** Constructor for a simpleSel node.
*
* This is a shortcut for the new_rd_Sel() constructor. To be used for
* @param *ent The entity to select.
*/
ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *store, ir_node *objptr, entity *ent);
+ ir_node *store, ir_node *objptr, ir_entity *ent);
/** Constructor for a Sel node.
*
* @param *ent The entity to select.
*/
ir_node *new_rd_Sel (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
- ir_node *objptr, int n_index, ir_node *index[], entity *ent);
-
-/** Constructor for a InstOf node.
- *
- * For translating Java. Not supported as standard firm node.
- *
- * @param *db A pointer for debug information.
- * @param *irg The ir graph the node belongs to.
- * @param *block The ir block the node belongs to.
- * @param *store
- * @param *objptr
- * @param *ent
- */
-ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
- ir_node *objptr, ir_type *ent);
+ ir_node *objptr, int n_index, ir_node *index[], ir_entity *ent);
/** Constructor for a Call node.
*
* @param *tp Type information of the procedure called.
*/
ir_node *new_rd_Call (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
- ir_node *callee, int arity, ir_node *in[], ir_type *tp);
+ ir_node *callee, int arity, ir_node *in[], ir_type *tp);
/** Constructor for a Add node.
*
* @param *mode The mode of the operands and the result.
*/
ir_node *new_rd_Add (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *op1, ir_node *op2, ir_mode *mode);
+ ir_node *op1, ir_node *op2, ir_mode *mode);
/** Constructor for a Sub node.
*
* @param *mode The mode of the operands and the result.
*/
ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *op1, ir_node *op2, ir_mode *mode);
+ ir_node *op1, ir_node *op2, ir_mode *mode);
/** Constructor for a Minus node.
*
ir_node *new_rd_Cast (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_type *to_tp);
+/** Constructor for a Carry node.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_rd_Carry (dbg_info *db, ir_graph *irg, ir_node *block,
+ ir_node *op1, ir_node *op2, ir_mode *mode);
+
+/** Constructor for a Borrow node.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_rd_Borrow (dbg_info *db, ir_graph *irg, ir_node *block,
+ ir_node *op1, ir_node *op2, ir_mode *mode);
+
/** Constructor for a Phi node.
*
* @param *db A pointer for debug information.
ir_node *new_rd_Mux (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
+/** Constructor for a Psi node.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belong to.
+ * @param *block The block the node belong to.
+ * @param *arity The arity of the conditions
+ * @param *conds The array of mode_b conditions, length must be equal arity
+ * @param *vals The array of mode values, length must be equal arity + 1
+ * @param *mode The mode of the node (must be the mode of all vals).
+ */
+ir_node *new_rd_Psi (dbg_info *db, ir_graph *irg, ir_node *block,
+ int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
+
/** Constructor for a CopyB node.
*
* @param *db A pointer for debug information.
ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
+/** Constructor for a InstOf node.
+ *
+ * A High-Level Type check.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a object of a class type.
+ * @param *type The type of which objptr must be.
+ */
+ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
+ ir_node *objptr, ir_type *type);
+
+/** Constructor for a Raise node.
+ *
+ * A High-Level Exception throw.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *store The current memory.
+ * @param *obj A pointer to the Except variable.
+ */
+ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
+ ir_node *store, ir_node *obj);
+
/** Constructor for a Bound node.
- * Checks whether lower <= idx && idx < upper.
+ *
+ * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
- * @param *store The current memory
+ * @param *store The current memory.
* @param *idx The ir_node that represents an index.
* @param *lower The ir_node that represents the lower bound for the index.
* @param *upper The ir_node that represents the upper bound for the index.
ir_node *new_rd_Bound(dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+/** Constructor for a Pin node.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belong to.
+ * @param *block The block the node belong to.
+ * @param *node The node which value should be pinned.
+ */
+ir_node *new_rd_Pin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *node);
+
/*-------------------------------------------------------------------------*/
/* The raw interface without debug support */
/*-------------------------------------------------------------------------*/
ir_node *new_r_Return (ir_graph *irg, ir_node *block,
ir_node *store, int arity, ir_node *in[]);
-/** Constructor for a Raise node.
- *
- * @param *irg The ir graph the node belongs to.
- * @param *block The ir block the node belongs to.
- * @param *store The current memory.
- * @param *obj A pointer to the Except variable.
- */
-ir_node *new_r_Raise (ir_graph *irg, ir_node *block,
- ir_node *store, ir_node *obj);
-
/** Constructor for a Const node.
*
* Constructor for a Const node. The constant represents a target
ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
union symconst_symbol value, symconst_kind symkind);
+/** Constructor for a simpleSel node.
+ *
+ * This is a shortcut for the new_d_Sel() constructor. To be used for
+ * Sel nodes that do not select from an array, i.e., have no index
+ * inputs. It adds the two parameters 0, NULL.
+ *
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr The object from that the Sel operation selects a
+ * single attribute out.
+ * @param *ent The entity to select.
+ */
+ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
+ ir_node *objptr, ir_entity *ent);
+
/** Constructor for a Sel node.
*
* The select node selects an entity (field or method) from an entity
*/
ir_node *new_r_Sel (ir_graph *irg, ir_node *block, ir_node *store,
ir_node *objptr, int n_index, ir_node *index[],
- entity *ent);
-
-/** Constructor for a InstOf node.
- *
- * For translating Java. Not supported as standard firm node.
- *
- * @param *irg The ir graph the node belongs to.
- * @param *block The ir block the node belongs to.
- * @param *x
- * @param *y
- * @param *z
- */
-ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *x, ir_node *y, ir_type *z);
+ ir_entity *ent);
/** Constructor for a Call node.
*
ir_node *new_r_Cast (ir_graph *irg, ir_node *block,
ir_node *op, ir_type *to_tp);
+/** Constructor for a Carry node.
+ *
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_r_Carry (ir_graph *irg, ir_node *block,
+ ir_node *op1, ir_node *op2, ir_mode *mode);
+
+/**
+ * Constructor for a Borrow node.
+ *
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the results.
+ */
+ir_node *new_r_Borrow (ir_graph *irg, ir_node *block,
+ ir_node *op1, ir_node *op2, ir_mode *mode);
+
/** Constructor for a Phi node.
*
* @param *irg The ir graph the node belongs to.
ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store,
ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where);
-/** Constructor for a Sync node.
+/** Constructor for a Sync node.
*
* Merges several memory values. The node assumes that a variable
* either occurs only in one of the memories, or it contains the same
* @param *in[] An array of pointers to nodes that produce an output of type memory.
* The constructor copies this array.
*/
-ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
+ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
/** Constructor for a Proj node.
*
* @param *irg The ir graph the node belongs to.
*
*/
-
ir_node *new_r_Bad (ir_graph *irg);
/** Constructor for a Confirm node.
* @param *val The value we express a constraint for
* @param *bound The value to compare against. Must be a firm node, typically a constant.
* @param cmp The compare operation.
- *
*/
ir_node *new_r_Confirm (ir_graph *irg, ir_node *block,
ir_node *val, ir_node *bound, pn_Cmp cmp);
ir_node *new_r_Mux (ir_graph *irg, ir_node *block,
ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
+/** Constructor for a Psi node.
+ *
+ * @param *irg The ir graph the node belong to.
+ * @param *block The block the node belong to.
+ * @param *arity The arity of the conditions
+ * @param *conds The array of mode_b conditions, length must be equal arity
+ * @param *vals The array of mode values, length must be equal arity + 1
+ * @param *mode The mode of the node (must be the mode of all vals).
+ */
+ir_node *new_r_Psi (ir_graph *irg, ir_node *block,
+ int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
+
/** Constructor for a CopyB node.
*
* @param *irg The ir graph the node belong to.
ir_node *new_r_CopyB(ir_graph *irg, ir_node *block,
ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
+/** Constructor for a InstOf node.
+ *
+ * A High-Level Type check.
+ *
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a object of a class type.
+ * @param *type The type of which objptr must be.
+ */
+ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *store,
+ ir_node *objptr, ir_type *type);
+
+/** Constructor for a Raise node.
+ *
+ * A High-Level Exception throw.
+ *
+ * @param *irg The ir graph the node belongs to.
+ * @param *block The ir block the node belongs to.
+ * @param *store The current memory.
+ * @param *obj A pointer to the Except variable.
+ */
+ir_node *new_r_Raise (ir_graph *irg, ir_node *block,
+ ir_node *store, ir_node *obj);
+
/** Constructor for a Bound node.
- * Checks whether lower <= idx && idx < upper.
+ *
+ * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
- * @param *store The current memory
+ * @param *store The current memory.
* @param *idx The ir_node that represents an index.
* @param *lower The ir_node that represents the lower bound for the index.
* @param *upper The ir_node that represents the upper bound for the index.
ir_node *new_r_Bound(ir_graph *irg, ir_node *block,
ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+/** Constructor for a Pin node.
+ *
+ * @param *irg The ir graph the node belong to.
+ * @param *block The block the node belong to.
+ * @param *node The node which value should be pinned.
+ */
+ir_node *new_r_Pin(ir_graph *irg, ir_node *block, ir_node *node);
+
/*-----------------------------------------------------------------------*/
/* The block oriented interface */
/*-----------------------------------------------------------------------*/
* @param *db A pointer for debug information.
* @param *c The conditions parameter.Can be of mode b or I_u.
*/
-
ir_node *new_d_Cond (dbg_info *db, ir_node *c);
/** Constructor for a Return node.
* @param arity Number of array indices.
* @param *in Array with index inputs to the node.
*/
-
ir_node *new_d_Return (dbg_info *db, ir_node *store, int arity, ir_node *in[]);
-/** Constructor for a Raise node.
- *
- * Adds the node to the block in current_ir_block.
- *
- * @param *db A pointer for debug information.
- * @param *store The current memory.
- * @param *obj A pointer to the Except variable.
- */
-
-ir_node *new_d_Raise (dbg_info *db, ir_node *store, ir_node *obj);
-
/** Constructor for a Const_type node.
*
* Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param value A type, entity or ident depending on the SymConst kind.
- * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_size
- * or symconst_addr_name.
+ * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size,
+ * symconst_type_align, symconst_addr_name or symconst_addr_ent.
* @param tp The source type of the constant.
*/
ir_node *new_d_SymConst_type (dbg_info *db, union symconst_symbol value, symconst_kind kind, ir_type *tp);
* single attribute out.
* @param *ent The entity to select.
*/
-ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, entity *ent);
+ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent);
/** Constructor for a Sel node.
*
* @param *ent The entity to select.
*/
ir_node *new_d_Sel (dbg_info *db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
- entity *ent);
-
-/** Constructor for a InstOf node.
- *
- * Adds the node to the block in current_ir_block.
- *
- * For translating Java. Not supported as standard firm node.
- *
- * @param *db A pointer for debug information.
- * @param *store
- * @param *objptr
- * @param *ent
- */
-ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *ent);
+ ir_entity *ent);
/** Constructor for a Call node.
*
* @param *in[] An array with the pointers to the parameters. The constructor copies this array.
* @param *tp Type information of the procedure called.
*/
-
ir_node *new_d_Call (dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
ir_type *tp);
* @param *op2 The second operand.
* @param *mode The mode of the operands and the result.
*/
-
ir_node *new_d_Sub (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
/** Constructor for a Minus node.
*/
ir_node *new_d_Conv (dbg_info *db, ir_node *op, ir_mode *mode);
-/**Constructor for a Cast node.
+/** Constructor for a strict Conv node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param *db A pointer for debug information.
+ * @param *op The operand.
+ * @param *mode The mode of this the operand muss be converted .
+ */
+ir_node *new_d_strictConv (dbg_info *db, ir_node *op, ir_mode *mode);
+
+/** Constructor for a Cast node.
*
* High level type cast
* Adds the node to the block in current_ir_block.
*/
ir_node *new_d_Cast (dbg_info *db, ir_node *op, ir_type *to_tp);
-/**Constructor for a Phi node.
+/** Constructor for a Carry node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param *db A pointer for debug information.
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_d_Carry (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
+
+/** Constructor for a Borrow node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param *db A pointer for debug information.
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_d_Borrow (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
+
+/** Constructor for a Phi node.
*
* Adds the node to the block in current_ir_block.
*
* @param where Where to allocate the variable, either heap_alloc or stack_alloc.
*/
ir_node *new_d_Alloc (dbg_info *db, ir_node *store, ir_node *size, ir_type *alloc_type,
- where_alloc where);
+ where_alloc where);
/** Constructor for a Free node.
*
*/
ir_node *new_d_Sync (dbg_info *db, int arity, ir_node *in[]);
-
/** Constructor for a Proj node.
*
* Projects a single value out of a tuple. The parameter proj gives the
*/
ir_node *new_d_Proj (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
-
/** Constructor for a defaultProj node.
*
* Represents the default control flow of a Switch-Cond node.
*/
ir_node *new_d_Tuple (dbg_info *db, int arity, ir_node *in[]);
-
/** Constructor for a Id node.
*
* This is an auxiliary node to replace a node that returns a single
*/
ir_node *new_d_Confirm (dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp);
-
/** Constructor for an Unknown node.
*
* Represents an arbitrary value. Places the node in
ir_node *new_d_Mux (dbg_info *db, ir_node *sel,
ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
+/** Constructor for a Psi node.
+ *
+ * @param *db A pointer for debug information.
+ * @param *arity The arity of the conditions
+ * @param *conds The array of mode_b conditions, length must be equal arity
+ * @param *vals The array of mode values, length must be equal arity + 1
+ * @param *mode The mode of the node (must be the mode of all vals).
+ */
+ir_node *new_d_Psi (dbg_info *db,
+ int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
+
/** Constructor for a CopyB node.
*
* @param *db A pointer for debug information.
*/
ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
+/** Constructor for a InstOf node.
+ *
+ * A High-Level Type check.
+ *
+ * @param *db A pointer for debug information.
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a object of a class type.
+ * @param *type The type of which objptr must be.
+ */
+ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *type);
+
+/** Constructor for a Raise node.
+ *
+ * A High-Level Exception throw.
+ *
+ * @param *db A pointer for debug information.
+ * @param *store The current memory.
+ * @param *obj A pointer to the Except variable.
+ */
+ir_node *new_d_Raise (dbg_info *db, ir_node *store, ir_node *obj);
+
/** Constructor for a Bound node.
- * Checks whether lower <= idx && idx < upper.
+ *
+ * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
*
* @param *db A pointer for debug information.
* @param *store The current memory
*/
ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+/** Constructor for a Pin node.
+ *
+ * @param *db A pointer for debug information.
+ * @param *node The node which value should be pinned.
+ */
+ir_node *new_d_Pin(dbg_info *db, ir_node *node);
+
/*-----------------------------------------------------------------------*/
/* The block oriented interface without debug support */
/*-----------------------------------------------------------------------*/
*/
ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
-/**Constructor for a Raise node.
- *
- * Adds the node to the block in current_ir_block.
- *
- * @param *store The current memory.
- * @param *obj A pointer to the Except variable.
- */
-ir_node *new_Raise (ir_node *store, ir_node *obj);
-
/** Constructor for a Const node.
*
* Constructor for a Const node. The constant represents a target
* -# size The symbolic constant represents the size of a type. The
* type of which the constant represents the size is given
* explicitly.
+ * -# align The symbolic constant represents the alignment of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * -# addr_name The symbolic constant represents the address of an entity
+ * (variable or method). The variable is indicated by a name
+ * that is valid for linking.
+ * -# addr_ent The symbolic constant represents the address of an entity
+ * (variable or method). The variable is given explicitly by
+ * a firm entity.
+ *
+ * Inputs to the node:
+ * No inputs except the block it belongs to.
+ * Outputs of the node.
+ * An unsigned integer (I_u) or a pointer (P).
+ *
+ * @param value A type or a ident depending on the SymConst kind.
+ * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
+ * symconst_type_align, symconst_addr_name or symconst_addr_ent.
+ * @param tp The source type of the constant.
+ */
+ir_node *new_SymConst_type (union symconst_symbol value, symconst_kind kind, ir_type *tp);
+
+/** Constructor for a SymConst node.
+ *
+ * Adds the node to the block in current_ir_block.
+ * This is the constructor for a symbolic constant.
+ * There are four kinds of symbolic constants:
+ * -# type_tag The symbolic constant represents a type tag. The type the
+ * tag stands for is given explicitly.
+ * -# size The symbolic constant represents the size of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * -# align The symbolic constant represents the alignment of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
* -# addr_name The symbolic constant represents the address of an entity
* (variable or method). The variable is indicated by a name
* that is valid for linking.
* An unsigned integer (I_u) or a pointer (P).
*
* @param value A type or a ident depending on the SymConst kind.
- * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_size or symconst_addr_name.
+ * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size
+ * symconst_type_align, symconst_addr_name or symconst_addr_ent.
*/
ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind);
* @param *objptr The object from that the Sel operation selects a single attribute out.
* @param *ent The entity to select.
*/
-ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent);
+ir_node *new_simpleSel(ir_node *store, ir_node *objptr, ir_entity *ent);
/** Constructor for a Sel node.
*
* @param *ent The entity to select.
*/
ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
- entity *ent);
-
-/** Constructor for an InstOf node.
- *
- * Adds the node to the block in current_ir_block.
- * For translating Java. Not supported as standard firm node.
- *
- * @param *store The actual store.
- * @param *obj
- * @param *ent
- */
-ir_node *new_InstOf (ir_node *store, ir_node *obj, ir_type *ent);
+ ir_entity *ent);
/** Constructor for a Call node.
*
* @param *tp Type information of the procedure called.
*/
ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[],
- ir_type *tp);
+ ir_type *tp);
/** Constructor for a CallBegin node.
*
- * Adds the node to the block in current_ir_block.
+ * CallBegin represents control flow depending of the pointer value
+ * representing the called method to the called methods. The
+ * constructor copies the method pointer input from the passed Call
+ * node. Adds the node to the block in current_ir_block.
*
* @param *callee A pointer to the called procedure.
*/
ir_node *new_CallBegin(ir_node *callee);
-/**Constructor for a Add node.
+/** Constructor for a Add node.
*
- * CallBegin represents control flow depending of the pointer value
- * representing the called method to the called methods. The
- * constructor copies the method pointer input from the passed Call
- * node.Adds the node to the block in current_ir_block.
+ * Adds the node to the block in current_ir_block.
*
* @param *op1 The first operand.
* @param *op2 The second operand.
*
* Adds the node to the block in current_ir_block.
*
- * @param *op The operand.
- * @param *mode The mode of this the operand muss be converted .
+ * @param *op The operand.
+ * @param *mode The mode of this the operand muss be converted.
*/
ir_node *new_Conv (ir_node *op, ir_mode *mode);
-/**Constructor for a Cast node.
+/** Constructor for a strict Conv node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param *op The operand.
+ * @param *mode The mode of this the operand muss be converted.
+ */
+ir_node *new_strictConv (ir_node *op, ir_mode *mode);
+
+/** Constructor for a Cast node.
*
* Adds the node to the block in current_ir_block.
* High level type cast
*/
ir_node *new_Cast (ir_node *op, ir_type *to_tp);
+/** Constructor for a Carry node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode);
+
+/** Constructor for a Borrow node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param *op1 The first operand.
+ * @param *op2 The second operand.
+ * @param *mode The mode of the operands and the result.
+ */
+ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
+
/** Constructor for a Phi node.
*
* Adds the node to the block in current_ir_block.
*/
ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
-/**Constructor for a Alloc node.
+/** Constructor for a Alloc node.
*
* The Alloc node extends the memory by space for an entity of type alloc_type.
* Adds the node to the block in current_ir_block.
ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
where_alloc where);
-
-/**Constructor for a Free node.
+/** Constructor for a Free node.
*
* Frees the memory occupied by the entity pointed to by the pointer
* arg. Type indicates the type of the entity the argument points to.
* @param where Where the variable was allocated, either heap_alloc or stack_alloc.
*/
ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
- ir_type *free_type, where_alloc where);
+ ir_type *free_type, where_alloc where);
-/** Constructor for a Sync node.
+/** Constructor for a Sync node.
*
* Merges several memory values. The node assumes that a variable
* either occurs only in one of the memories, or it contains the same
*/
ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
-/** Costructor for a Filter node.
+/** Constructor for a Filter node.
*
* Constructor for a Filter node. Adds the node to the block in current_ir_block.
* Filter is a node with two views used to construct the interprocedural view.
*/
ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
+/** Constructor for a Psi node.
+ *
+ * @param *arity The arity of the conditions
+ * @param *conds The array of mode_b conditions, length must be equal arity
+ * @param *vals The array of mode values, length must be equal arity + 1
+ * @param *mode The mode of the node (must be the mode of all vals).
+ */
+ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode);
+
/** Constructor for a CopyB node.
*
* Adds the node to the block in current_ir_block.
*/
ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
+/** Constructor for a InstOf node.
+ *
+ * A High-Level Type check.
+ *
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a object of a class type.
+ * @param *type The type of which objptr must be.
+ */
+ir_node *new_InstOf (ir_node *store, ir_node *objptr, ir_type *type);
+
+/**Constructor for a Raise node.
+ *
+ * A High-Level Exception throw.
+ *
+ * @param *store The current memory.
+ * @param *obj A pointer to the Except variable.
+ */
+ir_node *new_Raise (ir_node *store, ir_node *obj);
+
/** Constructor for a Bound node.
- * Checks whether lower <= idx && idx < upper.
+ *
+ * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
*
* Adds the node to the block in current_ir_block.
*
* @param *lower The ir_node that represents the lower bound for the index.
* @param *upper The ir_node that represents the upper bound for the index.
*/
-ir_node *new_Bound(ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
+
+/** Constructor for a Pin node.
+ *
+ * @param *node The node which value should be pinned.
+ */
+ir_node *new_Pin (ir_node *node);
/*---------------------------------------------------------------------*/
/* The comfortable interface. */
* This constructor can only be used if the graph is in
* state_building.
*/
-ir_node *new_d_immBlock (dbg_info *db);
-ir_node *new_immBlock (void);
+ir_node *new_d_immBlock(dbg_info *db);
+ir_node *new_immBlock(void);
/** Add a control flow edge to an immature block. */
-void add_immBlock_pred (ir_node *immblock, ir_node *jmp);
+void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
/** Finalize a Block node, when all control flows are known. */
-void mature_immBlock (ir_node *block);
+void mature_immBlock(ir_node *block);
#define mature_cur_block() mature_immBlock(get_cur_block());
* @param pos The position/id of the local variable.
* @param *mode The mode of the value to get.
*/
-ir_node *get_d_value (dbg_info *db, int pos, ir_mode *mode);
-ir_node *get_value (int pos, ir_mode *mode);
+ir_node *get_d_value(dbg_info *db, int pos, ir_mode *mode);
+ir_node *get_value(int pos, ir_mode *mode);
/** Remark a new definition of a variable.
*
* @param pos The position/id of the local variable.
* @param *value The new value written to the local variable.
*/
-void set_value (int pos, ir_node *value);
+void set_value(int pos, ir_node *value);
+
+/** Find the value number for a node in the current block.
+ *
+ * This function searches all values in the current block for
+ * a given value and returns its value number if it was found, else
+ * -1.
+ * Note that this does not mean that the value does not exists,
+ * it's just not equal the node (for instance behind a Phi/Confirm ...)
+ *
+ * @param *value The value to find.
+ */
+int find_value(ir_node *value);
/** Get the current memory state.
*
* state. This call automatically inserts Phi nodes for the memory
* state value.
*/
-ir_node *get_store (void);
+ir_node *get_store(void);
/** Remark a new definition of the memory state.
*
*
* @param *store The new memory state.
*/
-void set_store (ir_node *store);
+void set_store(ir_node *store);
/** keep this node alive even if End is not control-reachable from it
*
* @param ka The node to keep alive.
*/
-void keep_alive (ir_node *ka);
+void keep_alive(ir_node *ka);
/** Returns the frame type of the current graph */
ir_type *get_cur_frame_type(void);
/* --- initialize and finalize ir construction --- */
/** Puts the graph into state "phase_high" */
-void irg_finalize_cons (ir_graph *irg);
+#define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high)
/** Puts the program and all graphs into state phase_high.
*
*/
typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
-#endif /* _IRCONS_H_ */
+#endif /* _FIRM_IR_IRCONS_H_ */
projects / libfirm / blobdiff