Fixed typos, improved docu
[libfirm] / ir / ir / ircons.h
index 44bb63d..a77254c 100644 (file)
  *    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);
  *
  *    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
  *    --------------------------------------
  *
  *   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"
 
 /*-------------------------------------------------------------------------*/
@@ -1566,6 +1589,30 @@ ir_node *new_rd_Conv   (dbg_info *db, ir_graph *irg, ir_node *block,
 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.
@@ -1818,6 +1865,19 @@ ir_node *new_rd_NoMem  (ir_graph *irg);
 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.
@@ -2028,6 +2088,23 @@ ir_node *new_r_Const_type(ir_graph *irg, ir_node *block,
 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, entity *ent);
+
 /** Constructor for a Sel node.
  *
  * The select node selects an entity (field or method) from an entity
@@ -2284,6 +2361,29 @@ ir_node *new_r_Conv   (ir_graph *irg, ir_node *block,
 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.
@@ -2347,7 +2447,7 @@ ir_node *new_r_Alloc  (ir_graph *irg, ir_node *block, ir_node *store,
 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
@@ -2359,7 +2459,7 @@ ir_node *new_r_Free   (ir_graph *irg, ir_node *block, ir_node *store,
  * @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.
  *
@@ -2533,6 +2633,18 @@ ir_node *new_r_NoMem  (ir_graph *irg);
 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.
@@ -3005,7 +3117,7 @@ ir_node *new_d_Cmp    (dbg_info *db, ir_node *op1, ir_node *op2);
  */
 ir_node *new_d_Conv   (dbg_info *db, ir_node *op, ir_mode *mode);
 
-/**Constructor for a Cast node.
+/** Constructor for a Cast node.
  *
  * High level type cast
  * Adds the node to the block in current_ir_block.
@@ -3016,7 +3128,29 @@ ir_node *new_d_Conv   (dbg_info *db, ir_node *op, ir_mode *mode);
  */
 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.
  *
@@ -3252,6 +3386,17 @@ ir_node *new_d_NoMem  (void);
 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.
@@ -3501,18 +3646,18 @@ ir_node *new_Call   (ir_node *store, ir_node *callee, int arity, ir_node *in[],
 
 /** 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.
@@ -3691,7 +3836,7 @@ ir_node *new_Cmp    (ir_node *op1, ir_node *op2);
  */
 ir_node *new_Conv   (ir_node *op, ir_mode *mode);
 
-/**Constructor for a Cast node.
+/** Constructor for a Cast node.
  *
  * Adds the node to the block in current_ir_block.
  * High level type cast
@@ -3701,6 +3846,26 @@ ir_node *new_Conv   (ir_node *op, ir_mode *mode);
  */
 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.
@@ -3755,7 +3920,7 @@ ir_node *new_Alloc  (ir_node *store, ir_node *size, ir_type *alloc_type,
 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
@@ -3876,6 +4041,15 @@ ir_node *new_NoMem  (void);
  */
 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.
@@ -4004,7 +4178,7 @@ 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.
  *
@@ -4031,4 +4205,4 @@ void irp_finalize_cons(void);
  */
 typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
 
-#endif /* _IRCONS_H_ */
+#endif /* _FIRM_IR_IRCONS_H_ */