/**
@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_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);
* ---------------------------------------------------------------------------
*
* 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_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
* --------------------------------------
*
* 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"
/*-------------------------------------------------------------------------*/
*
* 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.
/** 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
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.
* @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_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.
*
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.
*
* @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 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);
*/
ir_node *new_d_Conv (dbg_info *db, ir_node *op, ir_mode *mode);
+/** 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
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_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 */
/*-----------------------------------------------------------------------*/
* -# 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);
*
* 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 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.
ir_node *new_Free (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
*/
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_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. */
/* Supports automatic Phi node construction. */
/* --- 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