* 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_Return (ir_node *store, int arity, ir_node **in);
* 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 **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_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);
*
* ---------------
*
- * 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
* 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.
*
* @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.
*
* @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.
*
* @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);
+ 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.
*
* @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 */
/*-------------------------------------------------------------------------*/
* @param *ent The entity to select.
*/
ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
- ir_node *objptr, entity *ent);
+ ir_node *objptr, ir_entity *ent);
/** Constructor for a Sel node.
*
*/
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);
+ ir_entity *ent);
/** Constructor for a Call node.
*
*
* @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 */
/*-----------------------------------------------------------------------*/
* 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);
+ ir_entity *ent);
/** Constructor for a Call node.
*
*/
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
* @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_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 */
/*-----------------------------------------------------------------------*/
* Derives mode from passed type. */
ir_node *new_Const_type(tarval *con, 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.
+ * -# 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.
* @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);
+ 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.
*
- * @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.
* @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.
*
* @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);
projects / libfirm / blobdiff