removed INLIEN before global functions
[libfirm] / ir / ir / irnode.h
index 04391d9..aa96f26 100644 (file)
@@ -13,6 +13,8 @@
 # ifndef _IRNODE_H_
 # define _IRNODE_H_
 
+#include <stddef.h>
+
 /**
  * Projection numbers of compare: use for Proj nodes!
  * @remark there are numbers with normalized names below!
@@ -131,9 +133,9 @@ void          set_irn_in            (ir_node *node, int arity,
  * Get the n-th predecessor of a node.
  * This function removes Id predecessors.
  */
-ir_node      *get_irn_n             (ir_node *node, int n);
-ir_node      *get_irn_intra_n       (ir_node *node, int n);
-ir_node      *get_irn_inter_n       (ir_node *node, int n);
+ir_node      *get_irn_n             (const ir_node *node, int n);
+ir_node      *get_irn_intra_n       (const ir_node *node, int n);
+ir_node      *get_irn_inter_n       (const ir_node *node, int n);
 
 /** Replace the n-th predecessor of a node with a new one. */
 void          set_irn_n             (ir_node *node, int n, ir_node *in);
@@ -179,7 +181,7 @@ void         *get_irn_link     (const ir_node *node);
 
 /** Returns the ir_graph this node belongs to. Only valid if irg
  *  is in state op_pin_state_pinned (irg is only stored in the block. */
-ir_graph     *get_irn_irg      (ir_node *node);
+ir_graph     *get_irn_irg      (const ir_node *node);
 
 /** Outputs a unique number for this node if libFIRM is compiled for
    debugging, (configure with --enable-debug) else returns address
@@ -221,7 +223,7 @@ new_ir_node (dbg_info *db,
  * To express the difference to access routines that work for all
  * nodes we use infix "nodes" and do not name this function
  * get_irn_block. */
-ir_node  *get_nodes_block (ir_node *node);
+ir_node  *get_nodes_block (const ir_node *node);
 
 /** Sets the Block of a node. */
 void      set_nodes_block (ir_node *node, ir_node *block);
@@ -274,6 +276,9 @@ bool      get_Block_matured (ir_node *node);
 void      set_Block_matured (ir_node *node, bool matured);
 unsigned long get_Block_block_visited (ir_node *node);
 void      set_Block_block_visited (ir_node *node, unsigned long visit);
+ir_node  *set_Block_dead(ir_node *block);
+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(ir_node *node);
@@ -322,7 +327,7 @@ void free_End (ir_node *end);
    We differ two flavours 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 differes in the treatment of cases not specified in
+   The second Cond flavor diffirences 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
@@ -562,7 +567,7 @@ void     set_Quot_mem (ir_node *node, ir_node *mem);
  */
 typedef enum {
   pn_Quot_M,           /**< Memory result.    */
-  pn_Quot_X_except,    /**< Execution result if exception occured. */
+  pn_Quot_X_except,    /**< Execution result if exception occurred. */
   pn_Quot_res,         /**< Result of computation. */
   pn_Quot_max          /**< number of projections from a Quot */
 } pn_Quot;  /* Projection numbers for Quot. */
@@ -579,7 +584,7 @@ void     set_DivMod_mem (ir_node *node, ir_node *mem);
  */
 typedef enum {
   pn_DivMod_M,           /**< Memory result.    */
-  pn_DivMod_X_except,    /**< Execution result if exception occured. */
+  pn_DivMod_X_except,    /**< Execution result if exception occurred. */
   pn_DivMod_res_div,     /**< Result of computation a / b. */
   pn_DivMod_res_mod,     /**< Result of computation a % b. */
   pn_DivMod_max          /**< number of projections from a DivMod */
@@ -597,7 +602,7 @@ void     set_Div_mem (ir_node *node, ir_node *mem);
  */
 typedef enum {
   pn_Div_M,           /**< Memory result.    */
-  pn_Div_X_except,    /**< Execution result if exception occured. */
+  pn_Div_X_except,    /**< Execution result if exception occurred. */
   pn_Div_res          /**< Result of computation. */
 } pn_Div;  /* Projection numbers for Div. */
 
@@ -613,7 +618,7 @@ void     set_Mod_mem (ir_node *node, ir_node *mem);
  */
 typedef enum {
   pn_Mod_M,           /**< Memory result.    */
-  pn_Mod_X_except,    /**< Execution result if exception occured. */
+  pn_Mod_X_except,    /**< Execution result if exception occurred. */
   pn_Mod_res,         /**< Result of computation. */
   pn_Mod_max          /**< number of projections from a Mod */
 } pn_Mod;  /* Projection numbers for Mod. */
@@ -699,7 +704,7 @@ void     set_Conv_op (ir_node *node, ir_node *op);
 
 /* Does Cast need a mem operator?
  * Cast should only depend on the type, not on the state of an
- * entity.  But:  we initialze various fields after Alloc, that
+ * entity.  But:  we initialize various fields after Alloc, that
  * are accessed in the cast.  This required some precaution, to
  * get the right memory into the Loads generated from the cast.
  */
@@ -711,10 +716,10 @@ void     set_Cast_type (ir_node *node, type *to_tp);
 /** Returns true if n is Phi or Filter in interprocedural_view.
    Returns false if irg in phase building and the Phi has zero
    predecessors: it's a Phi0. */
-int       is_Phi (ir_node *n);
+int       is_Phi (const ir_node *n);
 /** Returns true  if irg in phase building and the Phi has zero
    predecessors: it's a Phi0. */
-int       is_Phi0 (ir_node *n);
+int       is_Phi0 (const ir_node *n);
 /* These routines also work for Filter nodes in interprocedural view. */
 ir_node **get_Phi_preds_arr (ir_node *node);
 int       get_Phi_n_preds (ir_node *node);
@@ -748,7 +753,7 @@ void     set_memop_ptr (ir_node *node, ir_node *ptr);
  */
 typedef enum {
   pn_Load_M,         /**< Memory result.    */
-  pn_Load_X_except,  /**< Execution result if exception occured. */
+  pn_Load_X_except,  /**< Execution result if exception occurred. */
   pn_Load_res,       /**< Result of load operation. */
   pn_Load_max        /**< number of projections from a Load */
 } pn_Load;  /* Projection numbers for Load. */
@@ -767,7 +772,7 @@ void           set_Load_volatility (ir_node *node, ent_volatility volatility);
  */
 typedef enum {
   pn_Store_M,         /**< Memory result.    */
-  pn_Store_X_except,  /**< Execution result if exception occured. */
+  pn_Store_X_except,  /**< Execution result if exception occurred. */
   pn_Store_max        /**< number of projections from a Store */
 } pn_Store;  /* Projection numbers for Store. */
 
@@ -785,7 +790,7 @@ void           set_Store_volatility (ir_node *node, ent_volatility volatility);
  */
 typedef enum {
   pn_Alloc_M,          /**< Memory result. */
-  pn_Alloc_X_except,  /**< Execution result if exception occured. */
+  pn_Alloc_X_except,  /**< Execution result if exception occurred. */
   pn_Alloc_res,       /**< Result of allocation. */
   pn_Alloc_max        /**< number of projections from an Alloc */
 } pn_Alloc;  /* Projection numbers for Alloc. */
@@ -843,6 +848,14 @@ 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);
 
+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);
+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);
+
+
 /*
  *
  * NAME Auxiliary routines
@@ -889,6 +902,37 @@ ir_node *get_fragile_op_mem(ir_node *node);
  *  operation: Cond. */
 int is_forking_op(const ir_node *node);
 
+/**
+ * Access custom node data.
+ * The data must have been registered with
+ * register_additional_node_data() before.
+ * @param node The ir node to get the data from.
+ * @param type The type of the data you registered.
+ * @param off The value returned by register_additional_node_data().
+ * @return A pointer of type @p type.
+ */
+#define get_irn_data(node,type,off) \
+  (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
+
+/**
+ * Get the pointer to the node some custom data belongs to.
+ * @param data The pointer to the custom data.
+ * @param off The number as returned by register_additional_node_data().
+ * @return A pointer to the ir node the custom data belongs to.
+ */
+#define get_irn_data_base(data,off) \
+  (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
+
+/**
+ * Request additional data to be allocated with an ir node.
+ * @param size The size of the additional data required.
+ * @return A positive number, if the operation was successful, which
+ * must be passed to the access macro get_irn_data(), 0 if the
+ * registration failed.
+ */
+unsigned register_additional_node_data(unsigned size);
+
+
 /*-----------------------------------------------------------------*/
 /** Debug aides                                                   **/
 /*-----------------------------------------------------------------*/