Check that COnst nodes have same mode as its tarval
[libfirm] / ir / ir / irnode.h
index c8bc64e..b5c1bf6 100644 (file)
@@ -9,19 +9,19 @@
  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
-# ifndef _IRNODE_H_
-# define _IRNODE_H_
+#ifndef _IRNODE_H_
+#define _IRNODE_H_
 
 #include <stddef.h>
 
-# include "irgraph.h"
-# include "entity.h"
-# include "firm_common.h"
-# include "irop.h"
-# include "irmode.h"
-# include "type.h"
-# include "irextbb.h"
-# include "dbginfo.h"
+#include "irgraph.h"
+#include "entity.h"
+#include "firm_common.h"
+#include "irop.h"
+#include "irmode.h"
+#include "type.h"
+#include "irextbb.h"
+#include "dbginfo.h"
 
 /**
  * @file irnode.h
@@ -245,13 +245,13 @@ typedef enum {
  *
  * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
  * from Start.  If so returns frame type, else Null. */
-type *is_frame_pointer(ir_node *n);
+ir_type *is_frame_pointer(ir_node *n);
 
 /** Test whether arbitrary node is globals pointer.
  *
  * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
  * from Start.  If so returns global type, else Null. */
-type *is_globals_pointer(ir_node *n);
+ir_type *is_globals_pointer(ir_node *n);
 
 /** Test whether arbitrary node is value arg base.
  *
@@ -267,7 +267,7 @@ ir_node  *get_Block_cfgpred (ir_node *node, int pos);
 void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 /** Get the predecessor block.
  *
- *  Returns the block corresonding to the predecessor pos of block.
+ *  Returns the block corresponding to the predecessor pos of block.
  *
  *  There are several ambiguities we resolve with this function:
  *  - The direct predecessor can be a Proj, which is not pinned.
@@ -277,8 +277,8 @@ void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
  *    Start, but the Bad node.
  */
 ir_node  *get_Block_cfgpred_block(ir_node *node, int pos);
-bool      get_Block_matured (ir_node *node);
-void      set_Block_matured (ir_node *node, bool matured);
+int       get_Block_matured (ir_node *node);
+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()*/
@@ -423,10 +423,10 @@ cnst_classify_t classify_Const(ir_node *irn);
 /** Returns the source language type of a Const node.
  * Must be an atomic type.  Mode of type must be mode of node.
  */
-type    *get_Const_type   (ir_node *node);
+ir_type  *get_Const_type   (ir_node *node);
 
 /** Sets the source language type of a Const node. */
-void     set_Const_type   (ir_node *node, type *tp);
+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
@@ -449,9 +449,9 @@ typedef enum {
  *
  *  This union contains the symbolic information represented by the node.  */
 union symconst_symbol {
-  type   *type_p;
-  ident  *ident_p;
-  entity *entity_p;
+  ir_type *type_p;
+  ident   *ident_p;
+  entity  *entity_p;
 };
 
 typedef union symconst_symbol symconst_symbol;
@@ -463,8 +463,8 @@ symconst_kind get_SymConst_kind (const ir_node *node);
 void          set_SymConst_kind (ir_node *node, symconst_kind num);
 
 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
-type    *get_SymConst_type (ir_node *node);
-void     set_SymConst_type (ir_node *node, type *tp);
+ir_type  *get_SymConst_type (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 (ir_node *node);
@@ -484,8 +484,8 @@ void                  set_SymConst_symbol (ir_node *node,
 /** Access the type of the value represented by the SymConst.
  *
  *  Example: primitive type int for SymConst size. */
-type *get_SymConst_value_type (ir_node *node);
-void  set_SymConst_value_type (ir_node *node, type *tp);
+ir_type *get_SymConst_value_type (ir_node *node);
+void    set_SymConst_value_type (ir_node *node, ir_type *tp);
 
 ir_node *get_Sel_mem (ir_node *node);
 void     set_Sel_mem (ir_node *node, ir_node *mem);
@@ -498,9 +498,22 @@ void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 entity  *get_Sel_entity (ir_node *node); /* entity to select */
 void     set_Sel_entity (ir_node *node, entity *ent);
 
+/**
+ * Projection numbers for result of InstOf node: use for Proj nodes!
+ */
+typedef enum {
+  pn_InstOf_M_regular = 0,   /**< The memory result. */
+  pn_InstOf_X_except = 1,    /**< The control flow result branching to the exception handler */
+  pn_InstOf_res = 2,         /**< The checked object pointer. */
+  pn_InstOf_M_except = 3,    /**< The memory result in case the runtime function terminated with
+                                 an exception */
+  pn_InstOf_max = 4          /**< number of projections from an InstOf */
+} pn_InstOf;
+#define pn_InstOf_M pn_InstOf_M_regular
+
 /** InstOf access */
-type    *get_InstOf_ent (ir_node *node);
-void    set_InstOf_ent (ir_node *node, type *ent);
+ir_type *get_InstOf_type (ir_node *node);
+void    set_InstOf_type (ir_node *node, ir_type *type);
 ir_node *get_InstOf_store (ir_node *node);
 void    set_InstOf_store (ir_node *node, ir_node *obj);
 ir_node *get_InstOf_obj (ir_node *node);
@@ -533,9 +546,9 @@ ir_node *get_Call_param (ir_node *node, int pos);
 /** Sets the call parameter at position pos. */
 void     set_Call_param (ir_node *node, int pos, ir_node *param);
 /** Gets the type of a call. */
-type    *get_Call_type (ir_node *node);
+ir_type *get_Call_type (ir_node *node);
 /** Sets the type of a call. */
-void     set_Call_type (ir_node *node, type *tp);
+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 (ir_node *node);
 
@@ -652,7 +665,8 @@ 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 occurred. */
-  pn_Div_res          /**< Result of computation. */
+  pn_Div_res,         /**< Result of computation. */
+  pn_Div_max          /**< number of projections from a Div */
 } pn_Div;  /* Projection numbers for Div. */
 
 ir_node *get_Mod_left (ir_node *node);
@@ -766,8 +780,8 @@ void     set_Conv_op (ir_node *node, ir_node *op);
  */
 ir_node *get_Cast_op (ir_node *node);
 void     set_Cast_op (ir_node *node, ir_node *op);
-type    *get_Cast_type (ir_node *node);
-void     set_Cast_type (ir_node *node, type *to_tp);
+ir_type *get_Cast_type (ir_node *node);
+void     set_Cast_type (ir_node *node, ir_type *to_tp);
 
 /** Checks for upcast.
  *
@@ -870,8 +884,8 @@ ir_node *get_Alloc_mem (ir_node *node);
 void     set_Alloc_mem (ir_node *node, ir_node *mem);
 ir_node *get_Alloc_size (ir_node *node);
 void     set_Alloc_size (ir_node *node, ir_node *size);
-type    *get_Alloc_type (ir_node *node);
-void     set_Alloc_type (ir_node *node, type *tp);
+ir_type *get_Alloc_type (ir_node *node);
+void     set_Alloc_type (ir_node *node, ir_type *tp);
 
 /** The allocation place. */
 typedef enum {
@@ -888,8 +902,8 @@ ir_node *get_Free_ptr (ir_node *node);
 void     set_Free_ptr (ir_node *node, ir_node *ptr);
 ir_node *get_Free_size (ir_node *node);
 void     set_Free_size (ir_node *node, ir_node *size);
-type    *get_Free_type (ir_node *node);
-void     set_Free_type (ir_node *node, type *tp);
+ir_type *get_Free_type (ir_node *node);
+void     set_Free_type (ir_node *node, ir_type *tp);
 
 where_alloc  get_Free_where (ir_node *node);
 void         set_Free_where (ir_node *node, where_alloc where);
@@ -902,7 +916,7 @@ void      set_Sync_pred (ir_node *node, int pos, 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.
  */
-type     *get_Proj_type (ir_node *node);
+ir_type  *get_Proj_type (ir_node *node);
 
 /** Return the predecessor of a Proj node. */
 ir_node  *get_Proj_pred (const ir_node *node);
@@ -936,6 +950,55 @@ 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);
 
+/**
+ * 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
+                 an exception */
+  pn_CopyB_max       = pn_Call_max        /**< number of projections from a CopyB */
+} pn_CopyB;   /* Projection numbers for CopyB. */
+#define pn_CopyB_M pn_CopyB_M_regular
+
+ir_node *get_CopyB_mem (ir_node *node);
+void     set_CopyB_mem (ir_node *node, ir_node *mem);
+ir_node *get_CopyB_dst (ir_node *node);
+void     set_CopyB_dst (ir_node *node, ir_node *dst);
+ir_node *get_CopyB_src (ir_node *node);
+void     set_CopyB_src (ir_node *node, ir_node *src);
+ir_type *get_CopyB_type(ir_node *node);
+void     set_CopyB_type(ir_node *node, ir_type *data_type);
+
+/**
+ * Projection numbers for result of Bound node: use for Proj nodes!
+ */
+typedef enum {
+  pn_Bound_M_regular = 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;
+#define pn_Bound_M pn_Bound_M_regular
+
+/** Returns the memory input of a Bound operation. */
+ir_node *get_Bound_mem(ir_node *bound);
+void     set_Bound_mem (ir_node *bound, ir_node *mem);
+
+/** Returns the index input of a Bound operation. */
+ir_node *get_Bound_index(ir_node *bound);
+void     set_Bound_index(ir_node *bound, ir_node *idx);
+
+/** Returns the lower bound input of a Bound operation. */
+ir_node *get_Bound_lower(ir_node *bound);
+void     set_Bound_lower(ir_node *bound, ir_node *lower);
+
+/** Returns the upper bound input of a Bound operation. */
+ir_node *get_Bound_upper(ir_node *bound);
+void     set_Bound_upper(ir_node *bound, ir_node *upper);
 
 /*
  *
@@ -948,7 +1011,7 @@ void     set_Mux_true  (ir_node *node, ir_node *ir_true);
 /** returns operand of node if node is a Proj. */
 ir_node *skip_Proj (ir_node *node);
 /** returns operand of node if node is a Id */
-ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
+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);
@@ -992,24 +1055,34 @@ int is_irn_forking(const ir_node *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. */
-type *get_irn_type(ir_node *n);
+ir_type *get_irn_type(ir_node *n);
+
+/** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
+    Cast) or NULL.*/
+ir_type *get_irn_type_attr(ir_node *n);
+
+/** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
+entity *get_irn_entity_attr(ir_node *n);
 
 /** Returns non-zero for constant-like nodes. */
 int is_irn_constlike(const ir_node *node);
 
 /**
- * A type for expression conditional jump predications.
+ * A type to express conditional jump predictions.
  */
 typedef enum {
-  COND_JMP_PRED_NONE,        /**< No jump predication. Default. */
+  COND_JMP_PRED_NONE,        /**< No jump prediction. Default. */
   COND_JMP_PRED_TRUE,        /**< The True case is predicted. */
   COND_JMP_PRED_FALSE        /**< The False case is predicted. */
 } cond_jmp_predicate;
 
-/** Returns the conditional jump predication of a Cond node. */
+/** Gets the string representation of the jump prediction .*/
+const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
+
+/** Returns the conditional jump prediction of a Cond node. */
 cond_jmp_predicate get_Cond_jmp_pred(ir_node *cond);
 
-/** Sets a new conditional jump predication. */
+/** Sets a new conditional jump prediction. */
 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
 
 /**
@@ -1060,6 +1133,7 @@ void *get_irn_generic_attr(ir_node *node);
 void    dump_irn(ir_node *n);
 
 #include "ident.h"
+#include <stdio.h>
 
 #ifdef __GNUC__
 /* GNU C has the __FUNCTION__ extension */
@@ -1109,4 +1183,4 @@ int dump_node_opcode(FILE *F, ir_node *n);
 }
 #endif
 
-# endif /* _IRNODE_H_ */
+#endif /* _IRNODE_H_ */