- Fix some more stuff in ir_spec.py
[libfirm] / include / libfirm / ircons.h
index bbea40e..69362c7 100644 (file)
  *    ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity,
  *                         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 **in, type_method *type);
+ *    ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity,
+ *                         ir_node **in, type_method *type);
  *    ir_node *new_Add    (ir_node *op1, ir_node *op2, ir_mode *mode);
  *    ir_node *new_Sub    (ir_node *op1, ir_node *op2, ir_mode *mode);
  *    ir_node *new_Minus  (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_Load   (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags);
+ *    ir_node *new_Store  (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags);
  *    ir_node *new_Alloc  (ir_node *store, ir_node *size, ir_type *alloc_type,
  *                         where_alloc where);
  *    ir_node *new_Free   (ir_node *store, ir_node *ptr, ir_node *size,
  *    ir_node *new_immBlock (void)
  *    ----------------------------
  *
- *    Creates a new block.  Sets current_block to itself.  When a new block is
- *    created it cannot be known how many predecessors this block will have in the
- *    control flow graph. Therefore the list of inputs can not be fixed at
- *    creation.  Predecessors can be added with add_immBlock_pred (block, control flow
- *    operation).  With every added predecessor the number of inputs to Phi nodes
- *    also changes.
+ *    Creates a new block. When a new block is created it cannot be known how
+ *    many predecessors this block will have in the control flow graph.
+ *    Therefore the list of inputs can not be fixed at creation.  Predecessors
+ *    can be added with add_immBlock_pred (block, control flow operation).
+ *    With every added predecessor the number of inputs to Phi nodes also
+ *    changes.
  *
  *    The block can be completed by mature_immBlock(block) if all predecessors are
  *    known.  If several blocks are built at once, mature_immBlock can only be called
  *    Example for faulty IR construction:  (draw the graph on a paper and you'll
  *                                          get it ;-)
  *
- *      block_before_loop = new_block();
+ *      block_before_loop = new_immBlock();
+ *      set_cur_block(block_before_loop);
  *      set_value(x);
  *      mature_immBlock(block_before_loop);
  *      before2header = new_Jmp;
  *
- *      loop_header = new_block ();
+ *      loop_header = new_immBlock ();
+ *      set_cur_block(loop_header);
  *      header2body - new_Jmp();
  *
- *      loop_body = new_block ();
+ *      loop_body = new_immBlock ();
+ *      set_cur_block(loop_body);
  *      body2header = new_Jmp();
  *
  *      add_immBlock_pred(loop_header, before2header);
  *      A tuple containing the eventually changed store and the procedure
  *      results.
  *    Attributes:
- *      attr.call        Contains the type information for the procedure.
+ *      attr.call        Contains the attributes for the procedure.
  *
+ *    ir_node *new_Builtin(ir_node *store, ir_builtin_kind kind, int arity, ir_node **in,
+ *    -----------------------------------------------------------------------------------
+ *                       type_method *type)
+ *                       ------------------
+ *
+ *    Creates a builtin call.
+ *
+ *    Parameters
+ *      *store           The actual store.
+ *      kind             Describes the called builtin.
+ *      arity            The number of procedure parameters.
+ *      **in             An array with the pointers to the parameters.
+ *                       The constructor copies this array.
+ *      *type            Type information of the procedure called.
+ *
+ *    Inputs:
+ *      The store, the kind and the parameters.
+ *    Output:
+ *      A tuple containing the eventually changed store and the procedure
+ *      results.
+ *    Attributes:
+ *      attr.builtin     Contains the attributes for the called builtin.
  *
  *    ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
  *    ------------------------------------------------------------
  *      The definition valid in this block.
  *
  *    ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
- *    -----------------------------------------------------------------------------
+ *    -----------------------------------------------------------------------------------
  *
  *    Creates a Mux node. This node implements the following semantic:
  *    If the sel node (which must be of mode_b) evaluates to true, its value is
  *    OPERATIONS TO MANAGE MEMORY EXPLICITLY
  *    --------------------------------------
  *
- *    ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode)
- *    ----------------------------------------------------------------
+ *    ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags)
+ *    -------------------------------------------------------------------------------------
  *
  *    The Load operation reads a value from memory.
  *
  *    *store        The current memory.
  *    *addr         A pointer to the variable to be read in this memory.
  *    *mode         The mode of the value to be loaded.
+ *     flags        Additional flags for alignment, volatility and pin state.
  *
  *    Inputs:
  *      The memory and a pointer to a variable in this memory.
  *      A tuple of the memory, a control flow to be taken in case of
  *      an exception and the loaded value.
  *
- *    ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val)
- *    ----------------------------------------------------------------
+ *    ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags)
+ *    -------------------------------------------------------------------------------------
  *
  *    The Store operation writes a value to a variable in memory.
  *
 #ifndef FIRM_IR_IRCONS_H
 #define FIRM_IR_IRCONS_H
 
-#include "firm_common.h"
-#include "irnode.h"
-#include "irgraph.h"
+#include "firm_types.h"
+
+/**
+ * constrained flags for memory operations.
+ */
+typedef enum ir_cons_flags {
+       cons_none      = 0,        /**< No constrains. */
+       cons_volatile  = 1U << 0,  /**< Memory operation is volatile. */
+       cons_unaligned = 1U << 1,  /**< Memory operation is unaligned. */
+       cons_floats    = 1U << 2   /**< Memory operation can float. */
+} ir_cons_flags;
 
 /*-------------------------------------------------------------------------*/
 /* The raw interface                                                       */
@@ -1410,7 +1446,7 @@ ir_node *new_rd_Sel    (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st
 
 /** Constructor for a Call node.
  *
- *  Represents all kinds of method and function calls.
+ * Represents all kinds of method and function calls.
  *
  * @param   *db     A pointer for debug information.
  * @param   *irg    The IR graph the node  belongs to.
@@ -1424,6 +1460,22 @@ ir_node *new_rd_Sel    (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st
 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);
 
+/** Constructor for a ´Builtin node.
+ *
+ * Represents a call of a backend-specific builtin..
+ *
+ * @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 state.
+ * @param   arity   The number of procedure parameters.
+ * @param   *in[]   An array with the procedure parameters. The constructor copies this array.
+ * @param   kind    The kind of the called builtin.
+ * @param   *tp     Type information of the procedure called.
+ */
+ir_node *new_rd_Builtin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
+                                   int arity, ir_node *in[], ir_builtin_kind kind, ir_type *tp);
+
 /** Constructor for a Add node.
  *
  * @param   *db    A pointer for debug information.
@@ -1682,6 +1734,17 @@ ir_node *new_rd_Rotl    (dbg_info *db, ir_graph *irg, ir_node *block,
 ir_node *new_rd_Conv   (dbg_info *db, ir_graph *irg, ir_node *block,
                ir_node *op, ir_mode *mode);
 
+/** Constructor for a strictConv 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   *op    The operand.
+ * @param   *mode  The mode of this the operand muss be converted .
+ */
+ir_node *new_rd_strictConv   (dbg_info *db, ir_graph *irg, ir_node *block,
+               ir_node *op, ir_mode *mode);
+
 /** Constructor for a Cast node.
  *
  * High level type cast.
@@ -1739,9 +1802,10 @@ ir_node *new_rd_Phi    (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
  * @param *store The current memory
  * @param *adr   A pointer to the variable to be read in this memory.
  * @param *mode  The mode of the value to be loaded.
+ * @param  flags Additional flags for alignment, volatility and pin state.
  */
 ir_node *new_rd_Load   (dbg_info *db, ir_graph *irg, ir_node *block,
-                       ir_node *store, ir_node *adr, ir_mode *mode);
+                       ir_node *store, ir_node *adr, ir_mode *mode, ir_cons_flags flags);
 
 /** Constructor for a Store node.
  *
@@ -1751,9 +1815,10 @@ ir_node *new_rd_Load   (dbg_info *db, ir_graph *irg, ir_node *block,
  * @param *store The current memory
  * @param *adr   A pointer to the variable to be read in this memory.
  * @param *val   The value to write to this variable.
+ * @param  flags Additional flags for alignment, volatility and pin state.
  */
 ir_node *new_rd_Store  (dbg_info *db, ir_graph *irg, ir_node *block,
-               ir_node *store, ir_node *adr, ir_node *val);
+               ir_node *store, ir_node *adr, ir_node *val, ir_cons_flags flags);
 
 /** Constructor for a Alloc node.
  *
@@ -2236,7 +2301,7 @@ ir_node *new_r_Sel    (ir_graph *irg, ir_node *block, ir_node *store,
 
 /** Constructor for a Call node.
  *
- *  Represents all kinds of method and function calls.
+ * Represents all kinds of method and function calls.
  *
  * @param   *irg    The IR graph the node  belongs to.
  * @param   *block  The IR block the node belongs to.
@@ -2247,8 +2312,22 @@ ir_node *new_r_Sel    (ir_graph *irg, ir_node *block, ir_node *store,
  * @param   *tp     Type information of the procedure called.
  */
 ir_node *new_r_Call   (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 Builtin node.
+ *
+ * Represents a call of a backend-specific builtin..
+ *
+ * @param   *irg    The IR graph the node  belongs to.
+ * @param   *block  The IR block the node belongs to.
+ * @param   *store  The actual store.
+ * @param   arity   The number of procedure parameters.
+ * @param   *in[]   An array with the pointers to the parameters. The constructor copies this array.
+ * @param   kind    The kind of the called builtin.
+ * @param   *tp     Type information of the procedure called.
+ */
+ir_node *new_r_Builtin(ir_graph *irg, ir_node *block, ir_node *store,
+                       int arity, ir_node *in[], ir_builtin_kind kind, ir_type *tp);
 
 /** Constructor for a Add node.
  *
@@ -2488,6 +2567,16 @@ ir_node *new_r_Rotl   (ir_graph *irg, ir_node *block,
 ir_node *new_r_Conv   (ir_graph *irg, ir_node *block,
                ir_node *op, ir_mode *mode);
 
+/** Constructor for a strict Conv node.
+ *
+ * @param   *irg   The IR graph the node  belongs to.
+ * @param   *block The IR block the node belongs to.
+ * @param   *op    The operand.
+ * @param   *mode  The mode of this the operand muss be converted .
+ */
+ir_node *new_r_strictConv   (ir_graph *irg, ir_node *block,
+               ir_node *op, ir_mode *mode);
+
 /** Constructor for a Cast node.
  *
  * High level type cast
@@ -2541,9 +2630,10 @@ ir_node *new_r_Phi    (ir_graph *irg, ir_node *block, int arity,
  * @param *store The current memory
  * @param *adr   A pointer to the variable to be read in this memory.
  * @param *mode  The mode of the value to be loaded.
+ * @param  flags Additional flags for alignment, volatility and pin state.
  */
 ir_node *new_r_Load   (ir_graph *irg, ir_node *block,
-               ir_node *store, ir_node *adr, ir_mode *mode);
+               ir_node *store, ir_node *adr, ir_mode *mode, ir_cons_flags flags);
 
 /** Constructor for a Store node.
  *
@@ -2552,9 +2642,10 @@ ir_node *new_r_Load   (ir_graph *irg, ir_node *block,
  * @param *store The current memory
  * @param *adr   A pointer to the variable to be read in this memory.
  * @param *val   The value to write to this variable.
+ * @param  flags Additional flags for alignment, volatility and pin state.
  */
 ir_node *new_r_Store  (ir_graph *irg, ir_node *block,
-                      ir_node *store, ir_node *adr, ir_node *val);
+                      ir_node *store, ir_node *adr, ir_node *val, ir_cons_flags flags);
 
 /** Constructor for a Alloc node.
  *
@@ -3057,8 +3148,8 @@ ir_node *new_d_Sel    (dbg_info *db, ir_node *store, ir_node *objptr, int arity,
 
 /** Constructor for a Call node.
  *
- *  Represents all kinds of method and function calls.
- *  Adds the node to the block in current_ir_block.
+ * Represents all kinds of method and function calls.
+ * Adds the node to the block in current_ir_block.
  *
  * @param   *db     A pointer for debug information.
  * @param   *store  The actual store.
@@ -3068,7 +3159,21 @@ ir_node *new_d_Sel    (dbg_info *db, ir_node *store, ir_node *objptr, int arity,
  * @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);
+                       ir_type *tp);
+
+/** Constructor for a Builtin node.
+ *
+ * Represents a call of a backend-specific builtin..
+ * Adds the node to the block in current_ir_block.
+ *
+ * @param   *db     A pointer for debug information.
+ * @param   *store  The actual store.
+ * @param   arity   The number of procedure parameters.
+ * @param   *in[]   An array with the pointers to the parameters. The constructor copies this array.
+ * @param   kind    The kind of the called builtin.
+ * @param   *tp     Type information of the procedure called.
+ */
+ir_node *new_d_Builtin(dbg_info *db, ir_node *store, int arity, ir_node *in[], ir_builtin_kind kind, ir_type *tp);
 
 /** Constructor for a Add node.
  *
@@ -3368,8 +3473,9 @@ ir_node *new_d_Phi    (dbg_info *db, int arity, ir_node *in[], ir_mode *mode);
  * @param *store The current memory
  * @param *addr  A pointer to the variable to be read in this memory.
  * @param *mode  The mode of the value to be loaded.
+ * @param  flags Additional flags for alignment, volatility and pin state.
  */
-ir_node *new_d_Load   (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode);
+ir_node *new_d_Load(dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags);
 
 /** Constructor for a Store node.
  *
@@ -3379,8 +3485,9 @@ ir_node *new_d_Load   (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mod
  * @param *store The current memory
  * @param *addr  A pointer to the variable to be read in this memory.
  * @param *val   The value to write to this variable.
+ * @param  flags Additional flags for alignment, volatility and pin state.
  */
-ir_node *new_d_Store  (dbg_info *db, ir_node *store, ir_node *addr, ir_node *val);
+ir_node *new_d_Store(dbg_info *db, ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags);
 
 /** Constructor for a Alloc node.
  *
@@ -3866,8 +3973,8 @@ ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
 
 /** Constructor for a Call node.
  *
- *  Adds the node to the block in current_ir_block.
- *  Represents all kinds of method and function calls.
+ * Adds the node to the block in current_ir_block.
+ * Represents all kinds of method and function calls.
  *
  * @param   *store  The actual store.
  * @param   *callee A pointer to the called procedure.
@@ -3878,6 +3985,20 @@ ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
 ir_node *new_Call   (ir_node *store, ir_node *callee, int arity, ir_node *in[],
                      ir_type *tp);
 
+/** Constructor for a Builtin node.
+ *
+ * Represents a call of a backend-specific builtin..
+ * Represents all kinds of method and function calls.
+ *
+ * @param   *store  The actual store.
+ * @param   kind    The kind of the called builtin.
+ * @param   arity   The number of procedure parameters.
+ * @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_Builtin(ir_node *store, int arity, ir_node *in[],
+                     ir_builtin_kind kind, ir_type *tp);
+
 /** Constructor for a CallBegin node.
  *
  * CallBegin represents control flow depending of the pointer value
@@ -4153,16 +4274,18 @@ ir_node *new_Phi    (int arity, ir_node *in[], ir_mode *mode);
  * @param *store  The current memory.
  * @param *addr   A pointer to the variable to be read in this memory.
  * @param *mode   The mode of the value to be loaded.
+ * @param  flags  Additional flags for alignment, volatility and pin state.
  */
-ir_node *new_Load   (ir_node *store, ir_node *addr, ir_mode *mode);
+ir_node *new_Load(ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags);
 
 /** Constructor for a Store node.
  *
  * @param *store  The current memory.
  * @param *addr   A pointer to the variable to be read in this memory.
  * @param *val    The value to write to this variable.
+ * @param  flags  Additional flags for alignment, volatility and pin state.
  */
-ir_node *new_Store  (ir_node *store, ir_node *addr, ir_node *val);
+ir_node *new_Store(ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags);
 
 /** Constructor for a Alloc node.
  *
@@ -4378,6 +4501,12 @@ ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
                  int n_outs, ir_asm_constraint *outputs,
                  int n_clobber, ident *clobber[], ident *asm_text);
 
+/** Constructor for a Dummy node.
+ *
+ * @param *mode     The mode of the node.
+ */
+ir_node *new_Dummy(ir_mode *mode);
+
 /*---------------------------------------------------------------------*/
 /* The comfortable interface.                                          */
 /* Supports automatic Phi node construction.                           */
@@ -4391,10 +4520,9 @@ ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
  * can be added with add_immBlock_pred().  Once all predecessors are
  * added the block must be matured.
  *
- * Adds the block to the graph in current_ir_graph. Does set
- * current_block.  Can be used with automatic Phi node construction.
- * This constructor can only be used if the graph is in
- * state_building.
+ * Adds the block to the graph in current_ir_graph. Can be used with automatic
+ * Phi node construction.
+ * 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);
@@ -4498,21 +4626,4 @@ void irp_finalize_cons(void);
 
 /* --- Initialization --- */
 
-/**
- * This function is called, whenever a local variable is used before definition
- *
- * @param irg       the IR graph on which this happens
- * @param mode      the mode of the local var
- * @param pos       position chosen be the frontend for this variable (n_loc)
- *
- * @return a firm node of mode @p mode that initializes the var at position pos
- *
- * @note
- *      Do not return NULL!
- *      If this function is not set, FIRM will create a const node with tarval BAD.
- *      Use set_irg_loc_description()/get_irg_loc_description() to assign additional
- *      informations to local variables.
- */
-typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
-
 #endif