firmjni does not like two similar enums.
[libfirm] / ir / ir / irnode.h
index 8e03728..5a97ff2 100644 (file)
@@ -9,44 +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_
 
-/**
- * Projection numbers of compare: use for Proj nodes!
- * @remark there are numbers with normalized names below!
- */
-typedef enum {
-  False = 0,    /**< false */
-  Eq,           /**< equal */
-  Lt,           /**< less */
-  Le,           /**< less or equal */
-  Gt,           /**< greater */
-  Ge,           /**< greater or equal */
-  Lg,           /**< less or greater */
-  Leg = 7,      /**< less, equal or greater = ordered */
-  Uo,           /**< unordered */
-  Ue,           /**< unordered or equal */
-  Ul,           /**< unordered or less */
-  Ule,          /**< unordered, less or equal */
-  Ug,           /**< unordered or greater */
-  Uge,          /**< unordered, greater or equal */
-  Ne,           /**< unordered, less or greater = not equal */
-  True = 15     /**< true */
-  /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
-} pnc_number;   /* pnc: Projection Number Cmp */
-#define not_mask Leg
+#include <stddef.h>
 
-# include "tv.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 "exc.h" */
 
 /**
  * @file irnode.h
@@ -118,8 +93,8 @@ int           get_irn_inter_arity   (const ir_node *node);
    Assumes that current_ir_graph is set to the graph containing "node".
    "in" must contain all predecessors except the block that are required for
    the nodes opcode. */
-void          set_irn_in            (ir_node *node, int arity,
-                        ir_node *in[]);
+void          set_irn_in            (ir_node *node, int arity, ir_node *in[]);
+
 /* to iterate through the predecessors without touching the array. No
    order of predecessors guaranteed.
    To iterate over the operands iterate from 0 to i < get_irn_arity(),
@@ -131,9 +106,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 +154,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 +196,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);
@@ -272,8 +247,14 @@ ir_node  *get_Block_cfgpred (ir_node *node, int pos);
 void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 bool      get_Block_matured (ir_node *node);
 void      set_Block_matured (ir_node *node, bool matured);
+
+/** A visited flag only for block nodes.
+ *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
 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);
@@ -293,6 +274,11 @@ ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
 /* frees the memory. */
 void      remove_Block_cg_cfgpred_arr(ir_node * node);
 
+/** returns the extended basic block a block belongs to */
+ir_extblk *get_Block_extbb(const ir_node *block);
+/** sets the extended basic block a block belongs to */
+void set_Block_extbb(ir_node *block, ir_extblk *extblk);
+
 /** Return the number of Keep alive node. */
 int  get_End_n_keepalives(ir_node *end);
 
@@ -322,7 +308,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
@@ -373,9 +359,25 @@ typedef enum {
   pn_Raise_max   /**< number of projections from a Raise */
 } pn_Raise;  /* Projection numbers for Raise. */
 
+typedef enum {
+  CNST_NULL     =  0, /**< The node is a const(0). */
+  CNST_ONE      = +1, /**< The node is a const(1). */
+  CNST_ALL_ONE  = -1, /**< The node is a const(11111...). */
+  CNST_OTHER    =  2, /**< The tarvel of the const has another value. */
+  CNST_SYMCONST =  3, /**< The node is symconst. */
+  CNST_NO_CONST =  4  /**< The node is no const at all. */
+} cnst_classify_t;
+
 tarval  *get_Const_tarval (ir_node *node);
 void     set_Const_tarval (ir_node *node, tarval *con);
 
+/**
+ * Classify a node concerning constant properties.
+ * @param irn A node to check for.
+ * @return Constant properties of that node.
+ */
+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.
  */
@@ -453,6 +455,14 @@ 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);
 
+/** InstOf access */
+type    *get_InstOf_ent (ir_node *node);
+void    set_InstOf_ent (ir_node *node, type *ent);
+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);
+void    set_InstOf_obj (ir_node *node, ir_node *obj);
+
 /**
  * Projection numbers for result of Call node: use for Proj nodes!
  */
@@ -466,6 +476,7 @@ typedef enum {
                  an exception */
   pn_Call_max       = 5   /**< number of projections from a Call */
 } pn_Call;   /* Projection numbers for Call. */
+#define pn_Call_M pn_Call_M_regular
 
 ir_node *get_Call_mem (ir_node *node);
 void     set_Call_mem (ir_node *node, ir_node *mem);
@@ -489,8 +500,10 @@ int      get_Call_arity (ir_node *node);
  *
  *  The callee information lists all method entities that can be called
  *  from this node.  If the address expression can not be analyzed fully,
- *  e.g., as there are external methods that could be called, the array
- *  contains a single NULL entry.
+ *  e.g., as entities can be called that are not in the compilation unit,
+ *  the array contains the unknown_entity.  The array contains only entities
+ *  with peculiarity_existent, but with all kinds of visibility.  The entities
+ *  not necessarily contain an irg.
  *
  *  The array is only accessible if callee information is valid.  See flag
  *  in graph.
@@ -560,7 +573,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. */
@@ -577,7 +590,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 */
@@ -595,7 +608,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. */
 
@@ -611,7 +624,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. */
@@ -665,8 +678,15 @@ typedef enum {
 } pn_Cmp;   /* Projection numbers for Cmp */
 /* #define not_mask pn_Cmp_Leg */
 
+/** returns the pnc name from an pnc constant */
 const char *get_pnc_string(int pnc);
+
+/** Calculates the negated (Complement(R)) pnc condition. */
 int         get_negated_pnc(int pnc);
+
+/** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
+int         get_inversed_pnc(int pnc);
+
 ir_node *get_Cmp_left (ir_node *node);
 void     set_Cmp_left (ir_node *node, ir_node *left);
 ir_node *get_Cmp_right (ir_node *node);
@@ -697,7 +717,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.
  */
@@ -706,13 +726,28 @@ 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);
 
+/** Checks for upcast.
+ *
+ * Returns true if the Cast node casts a class type to a super type.
+ * Works also for pointers to classes (recursively).
+ */
+int is_Cast_upcast(ir_node *node);
+
+/** Checks for downcast.
+ *
+ * Returns true if the Cast node casts a class type to a sub type.
+ * Works also for pointers to classes (recursively).
+ */
+int is_Cast_downcast(ir_node *node);
+
+
 /** 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);
@@ -746,7 +781,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. */
@@ -765,7 +800,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. */
 
@@ -783,7 +818,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. */
@@ -813,14 +848,24 @@ 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);
 
+where_alloc  get_Free_where (ir_node *node);
+void         set_Free_where (ir_node *node, where_alloc where);
+
 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);
 
-ir_node  *get_Proj_pred (ir_node *node);
+/** 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);
+
+/** Return the predecessor of a Proj node. */
+ir_node  *get_Proj_pred (const ir_node *node);
 void      set_Proj_pred (ir_node *node, ir_node *pred);
-long      get_Proj_proj (ir_node *node);
+/** Return the projection number of a Proj node. */
+long      get_Proj_proj (const ir_node *node);
 void      set_Proj_proj (ir_node *node, long proj);
 
 ir_node **get_Tuple_preds_arr (ir_node *node);
@@ -841,6 +886,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
@@ -858,6 +911,12 @@ ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
 ir_node *skip_Tuple (ir_node *node);
 /** returns operand of node if node is a Cast */
 ir_node *skip_Cast  (ir_node *node);
+/** returns operand of node if node is a Confirm */
+ir_node *skip_Confirm  (ir_node *node);
+/** Skip all high-level Operations. */
+ir_node *skip_HighLevel(ir_node *node);
+/** returns true if irn is a Const node. */
+int                     is_Const(const ir_node *node);
 /** returns true if node is a Bad node. */
 int      is_Bad    (const ir_node *node);
 /** returns true if the node is not a Block */
@@ -878,7 +937,7 @@ int is_cfop(const ir_node *node);
 int is_ip_cfop(const ir_node *node);
 /** Returns true if the operation can change the control flow because
     of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
-    Bad. */
+    Bad. Raise is not fragile, but a unconditional jump. */
 int is_fragile_op(const ir_node *node);
 /** Returns the memory operand of fragile operations. */
 ir_node *get_fragile_op_mem(ir_node *node);
@@ -887,6 +946,42 @@ ir_node *get_fragile_op_mem(ir_node *node);
  *  operation: Cond. */
 int is_forking_op(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);
+
+/**
+ * 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                                                   **/
 /*-----------------------------------------------------------------*/
@@ -915,7 +1010,11 @@ void    dump_irn(ir_node *n);
 /** Output the firm kind of the node */
 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
 /** Output information about a node */
-#define DDMN(X)  printf("%s(l.%i) %s%s: %ld (%p)\n",         __MYFUNC__, __LINE__,  get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))
+
+/*#define DDMN(X)  printf("%s(l.%i) %s%s: %ld (%p)\n",         __MYFUNC__, __LINE__,  get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))*/
+int dump_node_opcode(FILE *F, ir_node *n);
+#define DDMN(X)  do { printf("%s(l.%i) ", __MYFUNC__, __LINE__); dump_node_opcode(stdout, X); printf(": %ld (%p)\n", get_irn_node_nr(X), (void *)(X)); } while (0)
+
 /** Output information about a node and its block */
 #define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X),  get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_block(X)))
 /** Output information about a type */