doxygen comment updated
[libfirm] / ir / ir / ircons.h
index 545e386..6ecce2f 100644 (file)
@@ -4,10 +4,10 @@
  * 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.
  */
 
  *    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_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
@@ -1225,7 +1225,7 @@ ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
  * @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.
  *
@@ -1240,7 +1240,7 @@ ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg, ir_node *block,
  * @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.
  *
@@ -1277,20 +1277,27 @@ ir_node *new_rd_Const  (dbg_info *db, ir_graph *irg, ir_node *block,
  * @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.
  *
@@ -1336,7 +1343,7 @@ ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir
  * @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.
  *
@@ -1359,7 +1366,7 @@ ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block,
  * @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.
  *
@@ -1375,7 +1382,7 @@ ir_node *new_rd_Sel    (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st
  * @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.
  *
@@ -1387,7 +1394,7 @@ ir_node *new_rd_Call   (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st
  * @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.
  *
@@ -1399,7 +1406,7 @@ ir_node *new_rd_Add    (dbg_info *db, ir_graph *irg, ir_node *block,
  * @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.
  *
@@ -2137,7 +2144,7 @@ ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
  * @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.
  *
@@ -2160,7 +2167,7 @@ ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
  */
 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.
  *
@@ -2916,7 +2923,7 @@ ir_node *new_d_SymConst (dbg_info *db, union symconst_symbol value, symconst_kin
  *                     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.
  *
@@ -2938,7 +2945,7 @@ ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, entity *
  * @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.
  *
@@ -3247,7 +3254,7 @@ ir_node *new_d_Store  (dbg_info *db, ir_node *store, ir_node *addr, ir_node *val
  * @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.
  *
@@ -3702,7 +3709,7 @@ 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.
  *
@@ -3723,7 +3730,7 @@ ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent);
  * @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.
  *
@@ -3737,7 +3744,7 @@ ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
  * @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.
  *
@@ -4022,7 +4029,7 @@ ir_node *new_Alloc  (ir_node *store, ir_node *size, ir_type *alloc_type,
  * @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.
  *
@@ -4196,13 +4203,13 @@ ir_node *new_Raise  (ir_node *store, ir_node *obj);
  * @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);
+ir_node *new_Pin    (ir_node *node);
 
 /*---------------------------------------------------------------------*/
 /* The comfortable interface.                                          */
@@ -4222,14 +4229,14 @@ ir_node *new_Pin(ir_node *node);
  * 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());
 
 
@@ -4243,8 +4250,8 @@ void mature_immBlock (ir_node *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.
  *
@@ -4256,7 +4263,19 @@ ir_node *get_value (int pos, ir_mode *mode);
  * @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.
  *
@@ -4264,7 +4283,7 @@ void set_value (int pos, ir_node *value);
  * 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.
  *
@@ -4273,13 +4292,13 @@ ir_node *get_store (void);
  *
  * @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);