move compound_graph path stuff into own files and add deprecation comments
[libfirm] / include / libfirm / irnode.h
index 660e24a..694a344 100644 (file)
@@ -51,8 +51,6 @@
  *
  *  The common fields are:
  *
- *  - firm_kind - A firm_kind tag containing k_type.  This is useful
- *                for dynamically checking whether a node is a ir_node.
  *  - arity     - The number of predecessors in the Firm graph.
  *  - in        - A list with the predecessors in the Firm graph.  There are
  *                routines to access individual elements and to obtain the
@@ -70,7 +68,7 @@
  * Some projection numbers must be always equal to support automatic phi construction
  */
 enum pn_generic {
-       pn_Generic_M_regular = 0,  /**< The memory result. */
+       pn_Generic_M         = 0,  /**< The memory result. */
        pn_Generic_X_regular = 1,  /**< Execution result if no exception occurred. */
        pn_Generic_X_except  = 2,  /**< The control flow result branching to the exception handler */
        pn_Generic_other     = 3   /**< First free projection number */
@@ -185,8 +183,6 @@ void del_Sync_n(ir_node *n, int i);
 void set_irn_mode(ir_node *node, ir_mode *mode);
 /** Gets the mode struct of a node.  */
 ir_mode *get_irn_mode(const ir_node *node);
-/** Gets the mode-enum ir_modecode. */
-ir_modecode get_irn_modecode(const ir_node *node);
 /** Gets the ident for a string representation of the mode .*/
 ident *get_irn_modeident(const ir_node *node);
 /** Gets the string representation of the mode .*/
@@ -304,11 +300,6 @@ void      set_nodes_block (ir_node *node, ir_node *block);
  * get_irn_MacroBlock(). */
 ir_node  *get_nodes_MacroBlock(const ir_node *node);
 
-/**
- * @function get_irn_block()
- * @see get_nodes_block()
- */
-
 /**
  * Projection numbers for result of Start node: use for Proj nodes!
  */
@@ -334,11 +325,28 @@ ir_type *is_frame_pointer(const ir_node *n);
  * from Start.  If so returns tls type, else Null. */
 ir_type *is_tls_pointer(const ir_node *n);
 
-/* @@@ no more supported  */
-ir_node **get_Block_cfgpred_arr(ir_node *node);
-int       get_Block_n_cfgpreds(const ir_node *node);
-ir_node  *get_Block_cfgpred(const ir_node *node, int pos);
-void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
+/** Return the number of control flow predecessors of a block. */
+int       get_Block_n_cfgpreds(const ir_node *block);
+/** Return the control flow predecessor of a block at a given position. */
+ir_node  *get_Block_cfgpred(const ir_node *block, int pos);
+/** Set the control flow predecessor of a block at a given position. */
+void      set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
+
+/**
+ * Return the position of the predecessor block pred in the inputs
+ * of the block block.
+ *
+ * @param block  the block
+ * @param pred   a predecessor block of block
+ *
+ * @return the position of pred in block or -1
+ *
+ * @note When using the old extended basic block form for blocks
+ * with exception exists, a predecessor block might have more
+ * than one position. In that case it is not specified, with is returned.
+ */
+int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
+
 /** Get the predecessor block.
  *
  *  Returns the block corresponding to the predecessor pos of block.
@@ -351,13 +359,16 @@ void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
  *    Start block, but the Bad node.
  */
 ir_node  *get_Block_cfgpred_block(const ir_node *node, int pos);
-int       get_Block_matured(const ir_node *node);
-void      set_Block_matured(ir_node *node, int matured);
+
+/** Return the matured flag of a block */
+int       get_Block_matured(const ir_node *block);
+/** set the matured flag of a block. */
+void      set_Block_matured(ir_node *block, int matured);
 
 /** A visited flag only for block nodes.
  *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
-ir_visited_t get_Block_block_visited(const ir_node *node);
-void         set_Block_block_visited(ir_node *node, ir_visited_t visit);
+ir_visited_t get_Block_block_visited(const ir_node *block);
+void         set_Block_block_visited(ir_node *block, ir_visited_t visit);
 
 /**
  * Marks a block as dead but do not replace it with a Bad node.
@@ -399,12 +410,14 @@ void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
 ir_node *get_irn_MacroBlock(const ir_node *n);
 /** Returns the ir_graph this Block belongs to. */
 ir_graph *get_Block_irg(const ir_node *block);
-/** Returns non-zero if the block has an assigned label. */
-int has_Block_label(const ir_node *block);
-/** Returns the label of a Block. */
-ir_label_t get_Block_label(const ir_node *block);
-/** Sets a label to a block. */
-void set_Block_label(ir_node *block, ir_label_t label);
+/** Returns non-zero if the block has an entity assigned */
+int has_Block_entity(const ir_node *block);
+/** Returns the entity for a Block */
+ir_entity *get_Block_entity(const ir_node *block);
+/** Returns the entity for a Block (creating it if necessary) */
+ir_entity *create_Block_entity(ir_node *block);
+/** Set a new entity for a block */
+void set_Block_entity(ir_node *block, ir_entity *entity);
 /** Gets the head of the Phi list for this block. */
 ir_node *get_Block_phis(const ir_node *block);
 /** Sets the head of the Phi list for this block. */
@@ -532,9 +545,6 @@ void     set_Const_type(ir_node *node, ir_type *tp);
 /** Returns non-zero if s symconst kind has an enum_const attribute */
 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
 
-/** Returns non-zero if s symconst kind has a label attribute */
-#define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
-
 /** Get the kind of the SymConst. */
 symconst_kind get_SymConst_kind(const ir_node *node);
 /** Set the kind of the SymConst. */
@@ -563,11 +573,6 @@ union symconst_symbol get_SymConst_symbol(const ir_node *node);
 void                  set_SymConst_symbol(ir_node *node,
                                           union symconst_symbol sym);
 
-/** Only to access SymConst of kind symconst_label.  Else assertion: */
-ir_label_t get_SymConst_label(const ir_node *node);
-void       set_SymConst_label(ir_node *node, ir_label_t label);
-
-
 /** Access the type of the value represented by the SymConst.
  *
  *  Example: primitive type int for SymConst size. */
@@ -589,21 +594,22 @@ void       set_Sel_entity (ir_node *node, ir_entity *ent);
  * Projection numbers for result of Call node: use for Proj nodes!
  */
 typedef enum {
-       pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
+       pn_Call_M         = pn_Generic_M,         /**< The memory result. */
        pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
        pn_Call_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler. */
        pn_Call_T_result  = pn_Generic_other,     /**< The tuple containing all (0, 1, 2, ...) results. */
-       pn_Call_M_except,                         /**< The memory result in case the called method terminated with
-                                                      an exception. */
        pn_Call_P_value_res_base,                 /**< A pointer to the memory region containing copied results
                                                       passed by value (for compound result types). */
        pn_Call_max                               /**< number of projections from a Call */
 } pn_Call;   /* Projection numbers for Call. */
-#define pn_Call_M pn_Call_M_regular
 
+/** Retrieve the memory input of a Call. */
 ir_node *get_Call_mem(const ir_node *node);
+/** Set the memory input of a Call. */
 void     set_Call_mem(ir_node *node, ir_node *mem);
+/** Retrieve the call address of a Call. */
 ir_node *get_Call_ptr(const ir_node *node);
+/** Set the call address of a Call. */
 void     set_Call_ptr(ir_node *node, ir_node *ptr);
 ir_node **get_Call_param_arr(ir_node *node);
 /** Gets the number of parameters of a call. */
@@ -616,6 +622,10 @@ 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);
+/** Returns non-zero if this call can be a tail-call. */
+unsigned get_Call_tail_call(const ir_node *node);
+/** Sets the tail call attribute. */
+void     set_Call_tail_call(ir_node *node, unsigned tail_call);
 
 /**
  * Returns non-zero if a Call is surely a self-recursive Call.
@@ -654,9 +664,9 @@ 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_M        = pn_Generic_M,     /**< 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);
@@ -677,9 +687,13 @@ 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);
 
+/** Retrieve the call address of a CallBegin. */
 ir_node  *get_CallBegin_ptr(const ir_node *node);
+/** Set the call address of a CallBegin. */
 void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
+/** Retrieve the original Call node of a CallBegin. */
 ir_node  *get_CallBegin_call(const ir_node *node);
+/** Set the original Call node of a CallBegin. */
 void      set_CallBegin_call(ir_node *node, ir_node *call);
 
 /* For unary and binary arithmetic operations the access to the
@@ -707,6 +721,11 @@ 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_Borrow_left(const ir_node *node);
+void     set_Borrow_left(ir_node *node, ir_node *left);
+ir_node *get_Borrow_right(const ir_node *node);
+void     set_Borrow_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);
@@ -738,7 +757,7 @@ void     set_Quot_resmode(ir_node *node, ir_mode *mode);
  * Projection numbers for Quot: use for Proj nodes!
  */
 typedef enum {
-       pn_Quot_M         = pn_Generic_M_regular, /**< Memory result. */
+       pn_Quot_M         = pn_Generic_M,         /**< Memory result. */
        pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Quot_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_Quot_res       = pn_Generic_other,     /**< Result of computation. */
@@ -758,7 +777,7 @@ void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
  * Projection numbers for DivMod: use for Proj nodes!
  */
 typedef enum {
-       pn_DivMod_M         = pn_Generic_M_regular, /**< Memory result. */
+       pn_DivMod_M         = pn_Generic_M,         /**< Memory result. */
        pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_DivMod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_DivMod_res_div   = pn_Generic_other,     /**< Result of computation a / b. */
@@ -775,12 +794,13 @@ void     set_Div_mem(ir_node *node, ir_node *mem);
 ir_mode *get_Div_resmode(const ir_node *node);
 void     set_Div_resmode(ir_node *node, ir_mode *mode);
 int      get_Div_no_remainder(const ir_node *node);
+void     set_Div_no_remainder(ir_node *node, int no_remainder);
 
 /**
  * Projection numbers for Div: use for Proj nodes!
  */
 typedef enum {
-       pn_Div_M         = pn_Generic_M_regular, /**< Memory result. */
+       pn_Div_M         = pn_Generic_M,         /**< Memory result. */
        pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Div_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_Div_res       = pn_Generic_other,     /**< Result of computation. */
@@ -800,7 +820,7 @@ void     set_Mod_resmode(ir_node *node, ir_mode *mode);
  * Projection numbers for Mod: use for Proj nodes!
  */
 typedef enum {
-       pn_Mod_M         = pn_Generic_M_regular, /**< Memory result.    */
+       pn_Mod_M         = pn_Generic_M,         /**< Memory result.    */
        pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Mod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_Mod_res       = pn_Generic_other,     /**< Result of computation. */
@@ -941,7 +961,7 @@ void     set_memop_ptr(ir_node *node, ir_node *ptr);
  * Projection numbers for Load: use for Proj nodes!
  */
 typedef enum {
-       pn_Load_M         = pn_Generic_M_regular, /**< Memory result. */
+       pn_Load_M         = pn_Generic_M,         /**< Memory result. */
        pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Load_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_Load_res       = pn_Generic_other,     /**< Result of load operation. */
@@ -963,7 +983,7 @@ void           set_Load_align(ir_node *node, ir_align align);
  * Projection numbers for Store: use for Proj nodes!
  */
 typedef enum {
-       pn_Store_M         = pn_Generic_M_regular, /**< Memory result. */
+       pn_Store_M         = pn_Generic_M,         /**< Memory result. */
        pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Store_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_Store_max       = pn_Generic_other      /**< number of projections from a Store */
@@ -984,7 +1004,7 @@ void           set_Store_align(ir_node *node, ir_align align);
  * Projection numbers for Alloc: use for Proj nodes!
  */
 typedef enum {
-       pn_Alloc_M         = pn_Generic_M_regular, /**< Memory result. */
+       pn_Alloc_M         = pn_Generic_M,         /**< Memory result. */
        pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Alloc_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
        pn_Alloc_res       = pn_Generic_other,     /**< Result of allocation. */
@@ -1070,12 +1090,10 @@ void     set_Mux_true(ir_node *node, ir_node *ir_true);
  * Projection numbers for result of CopyB node: use for Proj nodes!
  */
 typedef enum {
-       pn_CopyB_M_regular = pn_Generic_M_regular, /**< The memory result. */
+       pn_CopyB_M_regular = pn_Generic_M,         /**< The memory result. */
        pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_CopyB_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler */
-       pn_CopyB_M_except  = pn_Generic_other,     /**< The memory result in case the runtime function terminated with
-                                                       an exception */
-       pn_CopyB_max                               /**< number of projections from a CopyB */
+       pn_CopyB_max       = pn_Generic_other      /**< number of projections from a CopyB */
 } pn_CopyB;   /* Projection numbers for CopyB. */
 #define pn_CopyB_M pn_CopyB_M_regular
 
@@ -1092,12 +1110,10 @@ void     set_CopyB_type(ir_node *node, ir_type *data_type);
  * Projection numbers for result of InstOf node: use for Proj nodes!
  */
 typedef enum {
-       pn_InstOf_M_regular = pn_Generic_M_regular, /**< The memory result. */
+       pn_InstOf_M_regular = pn_Generic_M,         /**< The memory result. */
        pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_InstOf_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler */
        pn_InstOf_res       = pn_Generic_other,     /**< The checked object pointer. */
-       pn_InstOf_M_except,                         /**< The memory result in case the runtime function terminated with
-                                                        an exception */
        pn_InstOf_max                               /**< number of projections from an InstOf */
 } pn_InstOf;
 #define pn_InstOf_M pn_InstOf_M_regular
@@ -1114,7 +1130,7 @@ void    set_InstOf_obj(ir_node *node, ir_node *obj);
  * Projection numbers for Raise.
  */
 typedef enum {
-       pn_Raise_M = pn_Generic_M_regular,  /**< The Memory result. */
+       pn_Raise_M = pn_Generic_M,          /**< The Memory result. */
        pn_Raise_X = pn_Generic_X_regular,  /**< The control flow to the exception handler. */
        pn_Raise_max                        /**< number of projections from a Raise */
 } pn_Raise;  /* Projection numbers for Raise. */
@@ -1128,7 +1144,7 @@ void     set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
  * Projection numbers for result of Bound node: use for Proj nodes!
  */
 typedef enum {
-       pn_Bound_M         = pn_Generic_M_regular, /**< The memory result. */
+       pn_Bound_M         = pn_Generic_M,         /**< The memory result. */
        pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
        pn_Bound_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler */
        pn_Bound_res       = pn_Generic_other,     /**< The checked index. */
@@ -1153,7 +1169,7 @@ void     set_Bound_upper(ir_node *bound, ir_node *upper);
 
 /** Return the operand of a Pin node. */
 ir_node *get_Pin_op(const ir_node *pin);
-void    set_Pin_op(ir_node *pin, ir_node *node);
+void     set_Pin_op(ir_node *pin, ir_node *node);
 
 /** Return the assembler text of an ASM pseudo node. */
 ident *get_ASM_text(const ir_node *node);
@@ -1329,6 +1345,12 @@ ir_mode *get_divop_resmod(const ir_node *node);
  *  operation: Cond. */
 int is_irn_forking(const ir_node *node);
 
+/**
+ * Copies all attributes stored in the old node  to the new node.
+ * Assumes both have the same opcode and sufficient size.
+ */
+void copy_node_attr(const ir_node *old_node, ir_node *new_node);
+
 /** Return the type associated with the value produced by n
  *  if the node remarks this type as it is the case for
  *  Cast, Const, SymConst and some Proj nodes or unknown_type. */