fehler119 is C99
[libfirm] / include / libfirm / irnode.h
index 1258947..ac11fe5 100644 (file)
@@ -118,14 +118,19 @@ ir_node *get_irn_n(const ir_node *node, int n);
 /**
 * Add a artificial dependency to the node.
 * The dependency is only inserted if it is not there already.
+* This is only allowed in phase_backend!
+*
 * @param node The node.
 * @param dep  The dependency target.
+*
 * @return The index in the array (get_irn_dep() with that index returns @p dep).
 */
 int add_irn_dep(ir_node *node, ir_node *dep);
 
 /**
  * Copy all dependencies from a node to another.
+ * This is only allowed in phase_backend!
+ *
  * @param tgt The node which should be enriched.
  * @param src The node whose dependencies shall be copied.
  */
@@ -180,8 +185,8 @@ 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 modecode. */
-modecode get_irn_modecode(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 .*/
@@ -412,6 +417,12 @@ void set_Block_label(ir_node *block, ir_label_t label);
 ir_node *get_Block_phis(const ir_node *block);
 /** Sets the head of the Phi list for this block. */
 void set_Block_phis(ir_node *block, ir_node *phi);
+/** Add a Phi node to the list of Block Phi's. */
+void add_Block_phi(ir_node *block, ir_node *phi);
+/** Get the Block mark (single bit). */
+unsigned get_Block_mark(const ir_node *block);
+/** Set the Block mark (single bit). */
+void set_Block_mark(ir_node *block, unsigned mark);
 
 /** Return the number of Keep alive node. */
 int  get_End_n_keepalives(const ir_node *end);
@@ -421,9 +432,15 @@ ir_node *get_End_keepalive(const ir_node *end, int pos);
 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. */
+
+/**
+ * Set new keep-alives.
+ * Beware: This might be an expensive operation if dynamic edges are enabled,
+ * so avoid it in the backend.
+ */
 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
-/** Set new keep-alives from old keep-alives, skipping irn. */
+
+/** Remove irn from the keep-alive set. */
 void remove_End_keepalive(ir_node *end, ir_node *irn);
 
 /** Some parts of the End node are allocated separately -- their memory
@@ -639,6 +656,12 @@ 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(const ir_node *node);
 
+/**
+ * Returns non-zero if a Call is surely a self-recursive Call.
+ * Beware: if this functions returns 0, the call might be self-recursive!
+ */
+int is_self_recursive_Call(const ir_node *call);
+
 /** Set, get and remove the callee information for a Call node.
  *
  *  The callee information lists all method entities that can be called
@@ -676,7 +699,7 @@ void      set_CallBegin_call(ir_node *node, ir_node *call);
    second arithmetic value  as listed in tech report 1999-44.
    unops are: Minus, Abs, Not, Conv, Cast
    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
-   Shr, Shrs, Rot, Cmp */
+   Shr, Shrs, Rotl, Cmp */
 int      is_unop(const ir_node *node);
 ir_node *get_unop_op(const ir_node *node);
 void     set_unop_op(ir_node *node, ir_node *op);
@@ -872,10 +895,10 @@ void     set_Shrs_left(ir_node *node, ir_node *left);
 ir_node *get_Shrs_right(const ir_node *node);
 void     set_Shrs_right(ir_node *node, ir_node *right);
 
-ir_node *get_Rot_left(const ir_node *node);
-void     set_Rot_left(ir_node *node, ir_node *left);
-ir_node *get_Rot_right(const ir_node *node);
-void     set_Rot_right(ir_node *node, ir_node *right);
+ir_node *get_Rotl_left(const ir_node *node);
+void     set_Rotl_left(ir_node *node, ir_node *left);
+ir_node *get_Rotl_right(const ir_node *node);
+void     set_Rotl_right(ir_node *node, ir_node *right);
 
 ir_node *get_Conv_op(const ir_node *node);
 void     set_Conv_op(ir_node *node, ir_node *op);
@@ -912,14 +935,14 @@ int is_Cast_upcast(ir_node *node);
 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
+/** Returns true if n is a Phi or a Filter node in INTER-procedural view.
+   Returns false if irg is in phase phase_building and the Phi has zero
    predecessors: it's a Phi0. */
 int       is_Phi(const ir_node *n);
-/** Returns true if irg in phase building and the Phi has zero
+/** Returns true if irg in phase phase_building and the Phi has zero
    predecessors. It's a Phi0 then. */
 int       is_Phi0(const ir_node *n);
-/* These routines also work for Filter nodes in interprocedural view. */
+/* These routines also work for Filter nodes in INTER-procedural view. */
 ir_node **get_Phi_preds_arr(ir_node *node);
 int       get_Phi_n_preds(const ir_node *node);
 ir_node  *get_Phi_pred(const ir_node *node, int pos);
@@ -975,10 +998,10 @@ 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_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 */
+       pn_Store_M         = pn_Generic_M_regular, /**< 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 */
 } pn_Store;  /* Projection numbers for Store. */
 
 ir_node       *get_Store_mem(const ir_node *node);
@@ -1012,8 +1035,8 @@ void     set_Alloc_type(ir_node *node, ir_type *tp);
 
 /** The allocation place. */
 typedef enum {
-  stack_alloc,          /**< Alloc allocates the object on the stack. */
-  heap_alloc            /**< Alloc allocates the object on the heap. */
+       stack_alloc,          /**< Alloc allocates the object on the stack. */
+       heap_alloc            /**< Alloc allocates the object on the heap. */
 } ir_where_alloc;
 
 ir_where_alloc get_Alloc_where(const ir_node *node);
@@ -1049,6 +1072,13 @@ void      set_Proj_pred(ir_node *node, ir_node *pred);
 long      get_Proj_proj(const ir_node *node);
 void      set_Proj_proj(ir_node *node, long proj);
 
+/**
+ * Returns non-zero if a node is a routine parameter.
+ *
+ * @param node  the Proj node to test
+ */
+int is_arg_Proj(const ir_node *node);
+
 ir_node **get_Tuple_preds_arr(ir_node *node);
 int       get_Tuple_n_preds(const ir_node *node);
 ir_node  *get_Tuple_pred(const ir_node *node, int pos);
@@ -1122,7 +1152,7 @@ typedef enum {
 } pn_InstOf;
 #define pn_InstOf_M pn_InstOf_M_regular
 
-/** InstOf access */
+/** InstOf access. */
 ir_type *get_InstOf_type(ir_node *node);
 void    set_InstOf_type(ir_node *node, ir_type *type);
 ir_node *get_InstOf_store(const ir_node *node);
@@ -1262,10 +1292,12 @@ int      is_Shl(const ir_node *node);
 int      is_Shr(const ir_node *node);
 /** Returns true if node is a Shrs node. */
 int      is_Shrs(const ir_node *node);
-/** Returns true if node is a Rot node. */
-int      is_Rot(const ir_node *node);
+/** Returns true if node is a Rotl node. */
+int      is_Rotl(const ir_node *node);
 /** Returns true if node is a Psi node. */
 int      is_Psi(const ir_node *node);
+/** Returns true if node is an Id node. */
+int      is_Id(const ir_node *node);
 /** Returns true if node is a Tuple node. */
 int      is_Tuple(const ir_node *node);
 /** Returns true if node is a Bound node. */
@@ -1280,6 +1312,8 @@ int      is_Unknown(const ir_node *node);
 int      is_Return(const ir_node *node);
 /** Returns true if node is a Call node. */
 int      is_Call(const ir_node *node);
+/** Returns true if node is a CallBegin node. */
+int      is_CallBegin(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 Mul node. */
@@ -1304,21 +1338,27 @@ int      is_SymConst(const ir_node *node);
 int      is_SymConst_addr_ent(const ir_node *node);
 /** Returns true if node is a Cond node. */
 int      is_Cond(const ir_node *node);
-/** Returns true of node is a CopyB node */
+/** Returns true of node is a CopyB node. */
 int      is_CopyB(const ir_node *node);
 /** Returns true if node is a Cmp node. */
 int      is_Cmp(const ir_node *node);
-/** Returns true if node is an Alloc node */
+/** Returns true if node is an Alloc node. */
 int      is_Alloc(const ir_node *node);
-/** Returns true if a node is a Jmp node */
+/** Returns true if node is a Free node. */
+int      is_Free(const ir_node *node);
+/** Returns true if a node is a Jmp node. */
 int      is_Jmp(const ir_node *node);
-/** Returns true if a node is a Raise node */
+/** Returns true if a node is a IJmp node. */
+int      is_IJmp(const ir_node *node);
+/** Returns true if a node is a Raise node. */
 int      is_Raise(const ir_node *node);
-/** Returns true if a node is an ASM node */
+/** Returns true if a node is an ASM node. */
 int      is_ASM(const ir_node *node);
-/** Returns true if node is a Proj node or a Filter node in
- * intraprocedural view */
+/** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
 int      is_Proj(const ir_node *node);
+/** Returns true if node is a Filter node. */
+int      is_Filter(const ir_node *node);
+
 /** Returns true if the operation manipulates control flow:
    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
 int is_cfop(const ir_node *node);
@@ -1468,16 +1508,12 @@ void set_irn_dbg_info(ir_node *n, dbg_info *db);
  */
 dbg_info *get_irn_dbg_info(const ir_node *n);
 
-/*-----------------------------------------------------------------*/
-/** Debug aides                                                   **/
-/*-----------------------------------------------------------------*/
-
-
-/** Debug print the node.
+/**
+ * Calculate a hash value of a node. Only inputs, mode and opcode are used.
  *
- *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
- *  is set.  Else does nothing. */
-void dump_irn(const ir_node *n);
+ * @param node  the node to hash
+ */
+unsigned firm_default_hash(const ir_node *node);
 
 /*@}*/ /* end of ir_node group definition */