Remove address name SymConsts.
[libfirm] / include / libfirm / irnode.h
index b694e15..55a4fbe 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 .*/
@@ -266,14 +262,8 @@ op_pin_state is_irn_pinned_in_irg(const ir_node *node);
  * @param arity The arity of the new node, <0 if can be changed dynamically.
  * @param in    An array of arity predecessor nodes.
  */
-ir_node *
-new_ir_node(dbg_info *db,
-         ir_graph *irg,
-         ir_node *block,
-         ir_op *op,
-         ir_mode *mode,
-         int arity,
-         ir_node *in[]);
+ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block, ir_op *op,
+                     ir_mode *mode, int arity, ir_node *in[]);
 
 /**
  * Return the block the node belongs to.  This is only
@@ -304,11 +294,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!
  */
@@ -470,39 +455,8 @@ ir_node *get_IJmp_target(const ir_node *ijmp);
 /** Sets the target address of an IJmp */
 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
 
-/* We distinguish three kinds of Cond nodes.  These can be distinguished
-   by the mode of the selector operand and an internal flag of type cond_kind.
-   First we distinguish binary Conds and switch Conds.
-   A binary Cond has as selector a boolean value.  Proj(0) projects the control
-   flow for case "False", Proj(1) the control flow for "True".  A binary Cond
-   is recognized by the boolean selector.
-   The switch Cond has as selector an unsigned integer.  It produces as result
-   an n+1 Tuple (cf0, ... , cfn) of control flows.
-   We differ two flavors of this Cond.  The first, the dense Cond, passes
-   control along output i if the selector value is i, 0 <= i <= n.  If the
-   selector value is >n it passes control along output n.
-   The second Cond flavor differences in the treatment of cases not specified in
-   the source program.  It magically knows about the existence of Proj nodes.
-   It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
-   exists.  Else it passes control along output n (even if this Proj does not
-   exist.)  This Cond we call "fragmentary".  There is a special constructor
-   new_defaultProj that automatically sets the flavor.
-   The two switch flavors are distinguished by a flag of type cond_kind.
-   Default flavor is "dense"
-*/
-typedef enum {
-       dense,        /**< Default. Missing Proj nodes are dead control flow. */
-       fragmentary   /**< Special. No control flow optimizations allowed.  Missing
-                          Proj nodes mean default control flow, i.e., Proj(n). */
-} cond_kind;
-
-/** Gets the string representation of the Cond node kind. */
-const char *get_cond_kind_name(cond_kind kind);
-
 ir_node  *get_Cond_selector(const ir_node *node);
 void      set_Cond_selector(ir_node *node, ir_node *selector);
-cond_kind get_Cond_kind(const ir_node *node);
-void      set_Cond_kind(ir_node *node, cond_kind kind);
 long      get_Cond_default_proj(const ir_node *node);
 void      set_Cond_default_proj(ir_node *node, long defproj);
 
@@ -545,9 +499,6 @@ void     set_Const_type(ir_node *node, ir_type *tp);
 /** Returns non-zero if s symconst kind has a type attribute */
 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
 
-/** Returns non-zero if s symconst kind has an ident attribute */
-#define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
-
 /** Returns non-zero if s symconst kind has an entity attribute */
 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
 
@@ -563,10 +514,6 @@ void          set_SymConst_kind(ir_node *node, symconst_kind num);
 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: */
-ident   *get_SymConst_name(const ir_node *node);
-void     set_SymConst_name(ir_node *node, ident *name);
-
 /** Only to access SymConst of kind addr_ent.  Else assertion: */
 ir_entity *get_SymConst_entity(const ir_node *node);
 void       set_SymConst_entity(ir_node *node, ir_entity *ent);
@@ -603,17 +550,14 @@ 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);
@@ -634,6 +578,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.
@@ -672,9 +620,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);
@@ -765,7 +713,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. */
@@ -785,7 +733,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. */
@@ -808,7 +756,7 @@ 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. */
@@ -828,7 +776,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. */
@@ -969,7 +917,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. */
@@ -991,7 +939,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 */
@@ -1012,7 +960,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. */
@@ -1098,12 +1046,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
 
@@ -1120,12 +1066,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
@@ -1142,7 +1086,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. */
@@ -1156,7 +1100,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. */
@@ -1357,6 +1301,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. */
@@ -1404,6 +1354,11 @@ int is_irn_machine_operand(const ir_node *node);
  */
 int is_irn_machine_user(const ir_node *node, unsigned n);
 
+/**
+ * Returns non-zero for nodes that are CSE neutral to its users.
+ */
+int is_irn_cse_neutral(const ir_node *node);
+
 /**
  * A type to express conditional jump predictions.
  */