- do not use tuple result for builtins, not needed yet
[libfirm] / include / libfirm / irnode.h
index b98880b..7c922e7 100644 (file)
@@ -118,14 +118,19 @@ ir_node *get_irn_n(const ir_node *node, int n);
 /**
 * Add a artificial dependency to the node.
 * The dependency is only inserted if it is not there already.
+* This is only allowed in phase_backend!
+*
 * @param node The node.
 * @param dep  The dependency target.
+*
 * @return The index in the array (get_irn_dep() with that index returns @p dep).
 */
 int add_irn_dep(ir_node *node, ir_node *dep);
 
 /**
  * Copy all dependencies from a node to another.
+ * This is only allowed in phase_backend!
+ *
  * @param tgt The node which should be enriched.
  * @param src The node whose dependencies shall be copied.
  */
@@ -199,15 +204,16 @@ ident *get_irn_opident(const ir_node *node);
 /** If arg is an argument of the node, returns it's position, -1 otherwise */
 int get_irn_pred_pos(ir_node *node, ir_node *arg);
 /** Gets the visited counter of a node. */
-unsigned long get_irn_visited(const ir_node *node);
+ir_visited_t get_irn_visited(const ir_node *node);
 /** Sets the visited counter of a node. */
-void set_irn_visited(ir_node *node, unsigned long visited);
+void set_irn_visited(ir_node *node, ir_visited_t visited);
 /** Sets visited to get_irg_visited(current_ir_graph). */
 void mark_irn_visited(ir_node *node);
-/** Returns 1 if visited < get_irg_visited(current_ir_graph). */
-int irn_not_visited(const ir_node *node);
 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
 int irn_visited(const ir_node *node);
+/** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
+ * visited, if it was not. */
+int irn_visited_else_mark(ir_node *node);
 
 /**
  * Sets the link of a node.
@@ -358,8 +364,8 @@ void      set_Block_matured(ir_node *node, int matured);
 
 /** A visited flag only for block nodes.
  *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
-unsigned long get_Block_block_visited(const ir_node *node);
-void      set_Block_block_visited(ir_node *node, unsigned long visit);
+ir_visited_t get_Block_block_visited(const ir_node *node);
+void         set_Block_block_visited(ir_node *node, ir_visited_t visit);
 
 /**
  * Marks a block as dead but do not replace it with a Bad node.
@@ -370,7 +376,6 @@ int       is_Block_dead(const ir_node *block);
 
 /* For this current_ir_graph must be set. */
 void      mark_Block_block_visited(ir_node *node);
-int       Block_not_block_visited(const ir_node *node);
 int       Block_block_visited(const ir_node *node);
 
 #ifdef INTERPROCEDURAL_VIEW
@@ -427,11 +432,20 @@ ir_node *get_End_keepalive(const ir_node *end, int pos);
 void add_End_keepalive(ir_node *end, ir_node *ka);
 /** Set the Keep alive node at position pos. */
 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
-/** Set new keep-alives. */
+
+/**
+ * Set new keep-alives.
+ * Beware: This might be an expensive operation if dynamic edges are enabled,
+ * so avoid it in the backend.
+ */
 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
-/** Set new keep-alives from old keep-alives, skipping irn. */
+
+/** Remove irn from the keep-alive set. */
 void remove_End_keepalive(ir_node *end, ir_node *irn);
 
+/* Remove Bads, NoMem and doublets from the keep-alive set. */
+void remove_End_Bads_and_doublets(ir_node *end);
+
 /** Some parts of the End node are allocated separately -- their memory
    is not recovered by dead_node_elimination if a End node is dead.
    free_End() frees these data structures. */
@@ -510,30 +524,6 @@ ir_type  *get_Const_type(ir_node *node);
 /** Sets the source language type of a Const node. */
 void     set_Const_type(ir_node *node, ir_type *tp);
 
-/**  This enum names the three different kinds of symbolic Constants
-     represented by SymConst.  The content of the attribute type_or_id
-     depends on this tag.  Use the proper access routine after testing
-     this flag. */
-typedef enum {
-       symconst_type_tag,    /**< The SymConst is a type tag for the given type.
-                                  symconst_symbol is type *. */
-       symconst_type_size,   /**< The SymConst is the size of the given type.
-                                  symconst_symbol is type *. */
-       symconst_type_align,  /**< The SymConst is the alignment of the given type.
-                                  symconst_symbol is type *. */
-       symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
-                                  by the linker.  The pointer is represented by a string.
-                                  symconst_symbol is ident *. */
-       symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
-                                  by the linker.  The pointer is represented by an entity.
-                                  symconst_symbol is entity *. */
-       symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
-                                  owner type. */
-       symconst_enum_const,  /**< The SymConst is a enumeration constant of an
-                                  enumeration type. */
-       symconst_label        /**< The SymConst is a label address. */
-} symconst_kind;
-
 /** Returns non-zero if s symconst kind has a type attribute */
 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
 
@@ -549,25 +539,13 @@ typedef enum {
 /** Returns non-zero if s symconst kind has a label attribute */
 #define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
 
-/** SymConst attribute.
- *
- *  This union contains the symbolic information represented by the node.
- */
-typedef union symconst_symbol {
-       ir_type       *type_p;    /**< The type of a SymConst. */
-       ident         *ident_p;   /**< The ident of a SymConst. */
-       ir_entity     *entity_p;  /**< The entity of a SymConst. */
-       ir_enum_const *enum_p;    /**< The enumeration constant of a SymConst. */
-       ir_label_t    label;      /**< The label of a SymConst. */
-} symconst_symbol;
-
 /** Get the kind of the SymConst. */
 symconst_kind get_SymConst_kind(const ir_node *node);
 /** Set the kind of the SymConst. */
 void          set_SymConst_kind(ir_node *node, symconst_kind num);
 
 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
-ir_type  *get_SymConst_type(ir_node *node);
+ir_type  *get_SymConst_type(const ir_node *node);
 void     set_SymConst_type(ir_node *node, ir_type *tp);
 
 /** Only to access SymConst of kind addr_name.  Else assertion: */
@@ -642,8 +620,6 @@ void     set_Call_param(ir_node *node, int pos, ir_node *param);
 ir_type *get_Call_type(ir_node *node);
 /** Sets the type of a call. */
 void     set_Call_type(ir_node *node, ir_type *tp);
-/** Gets the arity of a call. Identical to get_Call_n_params(). */
-int      get_Call_arity(const ir_node *node);
 
 /**
  * Returns non-zero if a Call is surely a self-recursive Call.
@@ -678,6 +654,33 @@ ir_entity *get_Call_callee(const ir_node *node, int pos);
 void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
 void    remove_Call_callee_arr(ir_node *node);
 
+/**
+ * Projection numbers for result of Builtin node: use for Proj nodes!
+ */
+typedef enum {
+       pn_Builtin_M        = pn_Generic_M_regular, /**< The memory result. */
+       pn_Builtin_1_result = pn_Generic_other,     /**< first result. */
+       pn_Builtin_max                              /**< number of projections from a Builtin */
+} pn_Builtin;   /* Projection numbers for Builtin. */
+
+ir_node         *get_Builtin_mem(const ir_node *node);
+void            set_Builtin_mem(ir_node *node, ir_node *mem);
+ir_builtin_kind get_Builtin_kind(const ir_node *node);
+void            set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
+ir_node         **get_Builtin_param_arr(ir_node *node);
+/** Gets the number of parameters of a Builtin. */
+int             get_Builtin_n_params(const ir_node *node);
+/** Gets the Builtin parameter at position pos. */
+ir_node         *get_Builtin_param(const ir_node *node, int pos);
+/** Sets the Builtin parameter at position pos. */
+void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
+/** Gets the type of a builtin. */
+ir_type         *get_Builtin_type(ir_node *node);
+/** Sets the type of a Builtin. */
+void            set_Builtin_type(ir_node *node, ir_type *tp);
+/** Returns a human readable string for the ir_builtin_kind. */
+const char *get_builtin_kind_name(ir_builtin_kind kind);
+
 ir_node  *get_CallBegin_ptr(const ir_node *node);
 void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
 ir_node  *get_CallBegin_call(const ir_node *node);
@@ -688,7 +691,7 @@ void      set_CallBegin_call(ir_node *node, ir_node *call);
    second arithmetic value  as listed in tech report 1999-44.
    unops are: Minus, Abs, Not, Conv, Cast
    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
-   Shr, Shrs, Rot, Cmp */
+   Shr, Shrs, Rotl, Cmp */
 int      is_unop(const ir_node *node);
 ir_node *get_unop_op(const ir_node *node);
 void     set_unop_op(ir_node *node, ir_node *op);
@@ -703,6 +706,11 @@ void     set_Add_left(ir_node *node, ir_node *left);
 ir_node *get_Add_right(const ir_node *node);
 void     set_Add_right(ir_node *node, ir_node *right);
 
+ir_node *get_Carry_left(const ir_node *node);
+void     set_Carry_left(ir_node *node, ir_node *left);
+ir_node *get_Carry_right(const ir_node *node);
+void     set_Carry_right(ir_node *node, ir_node *right);
+
 ir_node *get_Sub_left(const ir_node *node);
 void     set_Sub_left(ir_node *node, ir_node *left);
 ir_node *get_Sub_right(const ir_node *node);
@@ -824,34 +832,6 @@ void     set_Eor_right(ir_node *node, ir_node *right);
 ir_node *get_Not_op(const ir_node *node);
 void     set_Not_op(ir_node *node, ir_node *op);
 
-/**
- * Projection numbers for Cmp are defined several times.
- * The bit patterns are used for various tests, so don't change.
- * The "unordered" values are possible results of comparing
- * floating point numbers.
- * Note that the encoding is imported, so do NOT change the order.
- */
-typedef enum {
-       pn_Cmp_False = 0,                             /**< false */
-       pn_Cmp_Eq    = 1,                             /**< equal */
-       pn_Cmp_Lt    = 2,                             /**< less */
-       pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
-       pn_Cmp_Gt    = 4,                             /**< greater */
-       pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
-       pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
-       pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
-       pn_Cmp_Uo    = 8,                             /**< unordered */
-       pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
-       pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
-       pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
-       pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
-       pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
-       pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
-       pn_Cmp_True  = 15                             /**< true */
-       /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
-} pn_Cmp;   /* Projection numbers for Cmp */
-/* #define not_mask pn_Cmp_Leg */
-
 /** returns the pnc name from an pnc constant */
 const char *get_pnc_string(int pnc);
 
@@ -884,10 +864,10 @@ void     set_Shrs_left(ir_node *node, ir_node *left);
 ir_node *get_Shrs_right(const ir_node *node);
 void     set_Shrs_right(ir_node *node, ir_node *right);
 
-ir_node *get_Rot_left(const ir_node *node);
-void     set_Rot_left(ir_node *node, ir_node *left);
-ir_node *get_Rot_right(const ir_node *node);
-void     set_Rot_right(ir_node *node, ir_node *right);
+ir_node *get_Rotl_left(const ir_node *node);
+void     set_Rotl_left(ir_node *node, ir_node *left);
+ir_node *get_Rotl_right(const ir_node *node);
+void     set_Rotl_right(ir_node *node, ir_node *right);
 
 ir_node *get_Conv_op(const ir_node *node);
 void     set_Conv_op(ir_node *node, ir_node *op);
@@ -1022,12 +1002,6 @@ void     set_Alloc_size(ir_node *node, ir_node *size);
 ir_type *get_Alloc_type(ir_node *node);
 void     set_Alloc_type(ir_node *node, ir_type *tp);
 
-/** The allocation place. */
-typedef enum {
-       stack_alloc,          /**< Alloc allocates the object on the stack. */
-       heap_alloc            /**< Alloc allocates the object on the heap. */
-} ir_where_alloc;
-
 ir_where_alloc get_Alloc_where(const ir_node *node);
 void           set_Alloc_where(ir_node *node, ir_where_alloc where);
 
@@ -1061,6 +1035,13 @@ void      set_Proj_pred(ir_node *node, ir_node *pred);
 long      get_Proj_proj(const ir_node *node);
 void      set_Proj_proj(ir_node *node, long proj);
 
+/**
+ * Returns non-zero if a node is a routine parameter.
+ *
+ * @param node  the Proj node to test
+ */
+int is_arg_Proj(const ir_node *node);
+
 ir_node **get_Tuple_preds_arr(ir_node *node);
 int       get_Tuple_n_preds(const ir_node *node);
 ir_node  *get_Tuple_pred(const ir_node *node, int pos);
@@ -1080,8 +1061,7 @@ pn_Cmp        get_Confirm_cmp(const ir_node *node);
 void          set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
 
 /*
- * Mux Support: Note that Psi nodes with one condition can be handled
- * like Mux nodes, and the access functions work as expected.
+ * Mux Support
  */
 ir_node *get_Mux_sel(const ir_node *node);
 void     set_Mux_sel(ir_node *node, ir_node *sel);
@@ -1090,14 +1070,6 @@ void     set_Mux_false(ir_node *node, ir_node *ir_false);
 ir_node *get_Mux_true(const ir_node *node);
 void     set_Mux_true(ir_node *node, ir_node *ir_true);
 
-ir_node *get_Psi_cond(const ir_node *node, int pos);
-void     set_Psi_cond(ir_node *node, int pos, ir_node *cond);
-ir_node *get_Psi_val(const ir_node *node, int pos);
-void     set_Psi_val(ir_node *node, int pos, ir_node *val);
-ir_node *get_Psi_default(const ir_node *node);
-void     set_Psi_default(ir_node *node, ir_node *val);
-int      get_Psi_n_conds(const ir_node *node);
-
 /**
  * Projection numbers for result of CopyB node: use for Proj nodes!
  */
@@ -1187,13 +1159,6 @@ void     set_Bound_upper(ir_node *bound, ir_node *upper);
 ir_node *get_Pin_op(const ir_node *pin);
 void    set_Pin_op(ir_node *pin, ir_node *node);
 
-/** A input/output constraint attribute */
-typedef struct {
-       unsigned       pos;           /**< The inputs/output position for this constraint. */
-       ident          *constraint;   /**< The constraint for this input/output. */
-       ir_mode        *mode;         /**< The mode of the constraint. */
-} ir_asm_constraint;
-
 /** Return the assembler text of an ASM pseudo node. */
 ident *get_ASM_text(const ir_node *node);
 /** Return the number of input constraints for an ASM node. */
@@ -1224,8 +1189,11 @@ ir_node *skip_Id(ir_node *node);   /* Old name is skip_nop(). */
 /** Returns corresponding operand of Tuple if node is a Proj from
    a Tuple. */
 ir_node *skip_Tuple(ir_node *node);
-/** returns operand of node if node is a Cast. */
+/** Returns operand of node if node is a Cast. */
 ir_node *skip_Cast(ir_node *node);
+const ir_node *skip_Cast_const(const ir_node *node);
+/** Returns operand of node if node is a Pin. */
+ir_node *skip_Pin(ir_node *node);
 /** Returns operand of node if node is a Confirm */
 ir_node *skip_Confirm(ir_node *node);
 /** Skip all high-level Operations (including Cast, Confirm). */
@@ -1258,6 +1226,8 @@ int      is_DivMod(const ir_node *node);
 int      is_Quot(const ir_node *node);
 /** Returns true if node is an Add node. */
 int      is_Add(const ir_node *node);
+/** Returns true if node is a Carry node. */
+int      is_Carry(const ir_node *node);
 /** Returns true if node is an And node. */
 int      is_And(const ir_node *node);
 /** Returns true if node is an Or node. */
@@ -1274,10 +1244,8 @@ int      is_Shl(const ir_node *node);
 int      is_Shr(const ir_node *node);
 /** Returns true if node is a Shrs node. */
 int      is_Shrs(const ir_node *node);
-/** Returns true if node is a Rot node. */
-int      is_Rot(const ir_node *node);
-/** Returns true if node is a Psi node. */
-int      is_Psi(const ir_node *node);
+/** Returns true if node is a Rotl node. */
+int      is_Rotl(const ir_node *node);
 /** Returns true if node is an Id node. */
 int      is_Id(const ir_node *node);
 /** Returns true if node is a Tuple node. */
@@ -1294,6 +1262,8 @@ int      is_Unknown(const ir_node *node);
 int      is_Return(const ir_node *node);
 /** Returns true if node is a Call node. */
 int      is_Call(const ir_node *node);
+/** Returns true if node is a Builtin node. */
+int      is_Builtin(const ir_node *node);
 /** Returns true if node is a CallBegin node. */
 int      is_CallBegin(const ir_node *node);
 /** Returns true if node is a Sel node. */
@@ -1302,7 +1272,7 @@ int      is_Sel(const ir_node *node);
 int      is_Mul(const ir_node *node);
 /** Returns true if node is a Mulh node. */
 int      is_Mulh(const ir_node *node);
-/** Returns true if node is a Mux node or a Psi with only one condition. */
+/** Returns true if node is a Mux node. */
 int      is_Mux(const ir_node *node);
 /** Returns true if node is a Load node. */
 int      is_Load(const ir_node *node);
@@ -1490,16 +1460,17 @@ void set_irn_dbg_info(ir_node *n, dbg_info *db);
  */
 dbg_info *get_irn_dbg_info(const ir_node *n);
 
-/*-----------------------------------------------------------------*/
-/** Debug aides                                                   **/
-/*-----------------------------------------------------------------*/
-
-
-/** Debug print the node.
+/**
+ * Calculate a hash value of a node. Only inputs, mode and opcode are used.
  *
- *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
- *  is set.  Else does nothing. */
-void dump_irn(const ir_node *n);
+ * @param node  the node to hash
+ */
+unsigned firm_default_hash(const ir_node *node);
+
+/**
+ * returns a descriptive name of a node (containing type+number)
+ */
+const char *gdb_node_helper(void *firm_object);
 
 /*@}*/ /* end of ir_node group definition */