added support for Thread local storage
[libfirm] / ir / ir / irnode.h
index e70e554..fd1b3d6 100644 (file)
@@ -9,8 +9,8 @@
  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
-#ifndef _IRNODE_H_
-#define _IRNODE_H_
+#ifndef _FIRM_IR_IRNODE_H_
+#define _FIRM_IR_IRNODE_H_
 
 #include <stddef.h>
 
@@ -105,9 +105,19 @@ void          set_irn_in            (ir_node *node, int arity, ir_node *in[]);
 /**
  * Get the n-th predecessor of a node.
  * This function removes Id predecessors.
+ * This function automatically handles intra- and interprocedural views.
  */
 ir_node      *get_irn_n             (const ir_node *node, int n);
+
+/**
+ * Get the n-th predecessor of a node in intraprocedural view.
+ * Can be used always if it's know that node is not a split one.
+ */
 ir_node      *get_irn_intra_n       (const ir_node *node, int n);
+
+/**
+ * Get the n-th predecessor of a node in interprocedural view.
+ */
 ir_node      *get_irn_inter_n       (const ir_node *node, int n);
 
 /** Replace the n-th predecessor of a node with a new one. */
@@ -132,6 +142,8 @@ opcode        get_irn_opcode        (const ir_node *node);
 const char   *get_irn_opname        (const ir_node *node);
 /** Get the ident for a string representation of the opcode. */
 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);
 /** Sets the visited counter of a node. */
@@ -233,14 +245,16 @@ typedef enum {
   pn_Start_M,                /**< Projection on the initial memory. */
   pn_Start_P_frame_base,     /**< Projection on the frame base pointer. */
   pn_Start_P_globals,        /**< Projection on the pointer to the data segment
-                                  containing _all_ global entities. */
+                                  containing _all_ global entities.  Use for
+                                  position independent data/code access. */
+  pn_Start_P_tls,            /**< Projection on the pointer to the thread local store
+                                  segment containing _all_thread local variables. */
   pn_Start_T_args,           /**< Projection on all arguments. */
   pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
                                   type of this method. */
   pn_Start_max               /**< number of projections from a Start */
 } pn_Start; /* Projection numbers for Start. */
 
-
 /** Test whether arbitrary node is frame pointer.
  *
  * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
@@ -253,6 +267,12 @@ ir_type *is_frame_pointer(ir_node *n);
  * from Start.  If so returns global type, else Null. */
 ir_type *is_globals_pointer(ir_node *n);
 
+/** Test whether arbitrary node is tls pointer.
+ *
+ * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
+ * from Start.  If so returns tls type, else Null. */
+ir_type *is_tls_pointer(ir_node *n);
+
 /** Test whether arbitrary node is value arg base.
  *
  * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
@@ -328,6 +348,9 @@ 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 */
+void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
+
 /** 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. */
@@ -420,28 +443,36 @@ void     set_Const_type   (ir_node *node, ir_type *tp);
      this flag. */
 typedef enum {
   symconst_type_tag,    /**< The SymConst is a type tag for the given type.
-                          Type_or_id_p is type *. */
-  symconst_size,        /**< The SymConst is the size of the given type.
-                          Type_or_id_p is 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.
-                          Type_or_id_p is ident *. */
+                          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.
-                          Type_or_id_p is entity *. */
+                          symconst_symbol is entity *. */
 } symconst_kind;
 
+/** 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)
+
 /** SymConst attribute.
  *
  *  This union contains the symbolic information represented by the node.  */
-union symconst_symbol {
+typedef union symconst_symbol {
   ir_type *type_p;
   ident   *ident_p;
   entity  *entity_p;
-};
-
-typedef union symconst_symbol symconst_symbol;
-
+} symconst_symbol;
 
 /** Get the kind of the SymConst. */
 symconst_kind get_SymConst_kind (const ir_node *node);
@@ -877,6 +908,7 @@ ir_node **get_Sync_preds_arr (ir_node *node);
 int       get_Sync_n_preds (ir_node *node);
 ir_node  *get_Sync_pred (ir_node *node, int pos);
 void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
+void      add_Sync_pred (ir_node *node, ir_node *pred);
 
 /** Returns the source language type of a Proj node.
  * Must be an atomic type.  Mode of type must be mode of node.
@@ -908,6 +940,10 @@ void     set_Confirm_bound (ir_node *node, ir_node *bound);
 pn_Cmp   get_Confirm_cmp   (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.
+ */
 ir_node *get_Mux_sel   (ir_node *node);
 void     set_Mux_sel   (ir_node *node, ir_node *sel);
 ir_node *get_Mux_false (ir_node *node);
@@ -915,15 +951,23 @@ void     set_Mux_false (ir_node *node, ir_node *ir_false);
 ir_node *get_Mux_true  (ir_node *node);
 void     set_Mux_true  (ir_node *node, ir_node *ir_true);
 
+ir_node *get_Psi_cond   (ir_node *node, int pos);
+void     set_Psi_cond   (ir_node *node, int pos, ir_node *cond);
+ir_node *get_Psi_val    (ir_node *node, int pos);
+void     set_Psi_val    (ir_node *node, int pos, ir_node *val);
+ir_node *get_Psi_default(ir_node *node);
+void     set_Psi_default(ir_node *node, ir_node *val);
+int      get_Psi_n_conds(ir_node *node);
+
 /**
  * Projection numbers for result of CopyB node: use for Proj nodes!
  */
 typedef enum {
-  pn_CopyB_M_regular = pn_Call_M_regular, /**< The memory result. */
-  pn_CopyB_X_except  = pn_Call_X_except,  /**< The control flow result branching to the exception handler */
-  pn_CopyB_M_except  = pn_Call_M_except,  /**< The memory result in case the runtime function terminated with
+  pn_CopyB_M_regular = 0,  /**< The memory result. */
+  pn_CopyB_X_except  = 1,  /**< The control flow result branching to the exception handler */
+  pn_CopyB_M_except  = 2,  /**< The memory result in case the runtime function terminated with
                  an exception */
-  pn_CopyB_max       = pn_Call_max        /**< number of projections from a CopyB */
+  pn_CopyB_max       = 3   /**< number of projections from a CopyB */
 } pn_CopyB;   /* Projection numbers for CopyB. */
 #define pn_CopyB_M pn_CopyB_M_regular
 
@@ -975,14 +1019,11 @@ 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_regular = 0,   /**< The memory result. */
+  pn_Bound_M = 0,           /**< The memory result. */
   pn_Bound_X_except = 1,    /**< The control flow result branching to the exception handler */
   pn_Bound_res = 2,         /**< The checked index. */
-  pn_Bound_M_except = 3,    /**< The memory result in case the runtime function terminated with
-                                 an exception */
-  pn_Bound_max = 4          /**< number of projections from a Bound */
+  pn_Bound_max = 3          /**< number of projections from a Bound */
 } pn_Bound;
-#define pn_Bound_M pn_Bound_M_regular
 
 /** Returns the memory input of a Bound operation. */
 ir_node *get_Bound_mem(ir_node *bound);
@@ -1037,6 +1078,14 @@ int      is_Return (const ir_node *node);
 int      is_Call (const ir_node *node);
 /** returns true if node is a Sel node. */
 int      is_Sel (const ir_node *node);
+/** returns true if node is a Mux node or a Psi with only one condition. */
+int      is_Mux (const ir_node *node);
+/** returns true if node is a Load node. */
+int      is_Load (const ir_node *node);
+/** returns true if node is a Sync node. */
+int      is_Sync (const ir_node *node);
+/** returns true if node is a Confirm node. */
+int      is_Confirm (const ir_node *node);
 /** returns true if node is a Proj node or a Filter node in
  * intraprocedural view */
 int      is_Proj (const ir_node *node);
@@ -1079,6 +1128,21 @@ int is_irn_constlike(const ir_node *node);
  */
 int is_irn_keep(const ir_node *node);
 
+/**
+ * Returns non-zero for nodes that are machine operations.
+ */
+int is_irn_machine_op(const ir_node *node);
+
+/**
+ * Returns non-zero for nodes that are machine operands.
+ */
+int is_irn_machine_operand(const ir_node *node);
+
+/**
+ * Returns non-zero for nodes that have the n'th user machine flag set.
+ */
+int is_irn_machine_user(const ir_node *node, unsigned n);
+
 /**
  * A type to express conditional jump predictions.
  */
@@ -1133,6 +1197,12 @@ unsigned register_additional_node_data(unsigned size);
  */
 void *get_irn_generic_attr(ir_node *node);
 
+/**
+ * Returns the unique node index for the node in its graph.
+ * This index is used to access phase information for this node.
+ */
+unsigned get_irn_idx(const ir_node *node);
+
 /*-----------------------------------------------------------------*/
 /** Debug aides                                                   **/
 /*-----------------------------------------------------------------*/
@@ -1195,4 +1265,4 @@ int dump_node_opcode(FILE *F, ir_node *n);
 }
 #endif
 
-#endif /* _IRNODE_H_ */
+#endif /* _FIRM_IR_IRNODE_H_ */