get_mode_size_bits() returns the size in bits, not bytes.
[libfirm] / include / libfirm / irnode.h
index 14cbdc4..be09fde 100644 (file)
@@ -185,8 +185,6 @@ 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 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 .*/
@@ -304,11 +302,6 @@ void      set_nodes_block (ir_node *node, ir_node *block);
  * get_irn_MacroBlock(). */
 ir_node  *get_nodes_MacroBlock(const ir_node *node);
 
-/**
- * @function get_irn_block()
- * @see get_nodes_block()
- */
-
 /**
  * Projection numbers for result of Start node: use for Proj nodes!
  */
@@ -319,8 +312,6 @@ typedef enum {
        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. */
 
@@ -336,17 +327,28 @@ ir_type *is_frame_pointer(const ir_node *n);
  * from Start.  If so returns tls type, else Null. */
 ir_type *is_tls_pointer(const ir_node *n);
 
-/** Test whether arbitrary node is value arg base.
+/** Return the number of control flow predecessors of a block. */
+int       get_Block_n_cfgpreds(const ir_node *block);
+/** Return the control flow predecessor of a block at a given position. */
+ir_node  *get_Block_cfgpred(const ir_node *block, int pos);
+/** Set the control flow predecessor of a block at a given position. */
+void      set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
+
+/**
+ * Return the position of the predecessor block pred in the inputs
+ * of the block block.
  *
- * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
- * from Start.   If so returns 1, else 0. */
-int is_value_arg_pointer(const ir_node *n);
-
-/* @@@ no more supported  */
-ir_node **get_Block_cfgpred_arr(ir_node *node);
-int       get_Block_n_cfgpreds(const ir_node *node);
-ir_node  *get_Block_cfgpred(const ir_node *node, int pos);
-void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
+ * @param block  the block
+ * @param pred   a predecessor block of block
+ *
+ * @return the position of pred in block or -1
+ *
+ * @note When using the old extended basic block form for blocks
+ * with exception exists, a predecessor block might have more
+ * than one position. In that case it is not specified, with is returned.
+ */
+int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
+
 /** Get the predecessor block.
  *
  *  Returns the block corresponding to the predecessor pos of block.
@@ -356,16 +358,19 @@ void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
  *    We walk from the predecessor to the next pinned node
  *    (skip_Proj) and return the block that node is in.
  *  - If we encounter the Bad node, this function does not return
- *    Start, but the Bad node.
+ *    Start block, but the Bad node.
  */
 ir_node  *get_Block_cfgpred_block(const ir_node *node, int pos);
-int       get_Block_matured(const ir_node *node);
-void      set_Block_matured(ir_node *node, int matured);
+
+/** Return the matured flag of a block */
+int       get_Block_matured(const ir_node *block);
+/** set the matured flag of a block. */
+void      set_Block_matured(ir_node *block, int matured);
 
 /** A visited flag only for block nodes.
  *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
-ir_visited_t get_Block_block_visited(const ir_node *node);
-void         set_Block_block_visited(ir_node *node, ir_visited_t visit);
+ir_visited_t get_Block_block_visited(const ir_node *block);
+void         set_Block_block_visited(ir_node *block, ir_visited_t visit);
 
 /**
  * Marks a block as dead but do not replace it with a Bad node.
@@ -407,12 +412,14 @@ void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
 ir_node *get_irn_MacroBlock(const ir_node *n);
 /** Returns the ir_graph this Block belongs to. */
 ir_graph *get_Block_irg(const ir_node *block);
-/** Returns non-zero if the block has an assigned label. */
-int has_Block_label(const ir_node *block);
-/** Returns the label of a Block. */
-ir_label_t get_Block_label(const ir_node *block);
-/** Sets a label to a block. */
-void set_Block_label(ir_node *block, ir_label_t label);
+/** Returns non-zero if the block has an entity assigned */
+int has_Block_entity(const ir_node *block);
+/** Returns the entity for a Block */
+ir_entity *get_Block_entity(const ir_node *block);
+/** Returns the entity for a Block (creating it if necessary) */
+ir_entity *create_Block_entity(ir_node *block);
+/** Set a new entity for a block */
+void set_Block_entity(ir_node *block, ir_entity *entity);
 /** Gets the head of the Phi list for this block. */
 ir_node *get_Block_phis(const ir_node *block);
 /** Sets the head of the Phi list for this block. */
@@ -482,11 +489,15 @@ typedef enum {
                           Proj nodes mean default control flow, i.e., Proj(n). */
 } cond_kind;
 
+/** Gets the string representation of the Cond node kind. */
+const char *get_cond_kind_name(cond_kind kind);
+
 ir_node  *get_Cond_selector(const ir_node *node);
 void      set_Cond_selector(ir_node *node, ir_node *selector);
 cond_kind get_Cond_kind(const ir_node *node);
 void      set_Cond_kind(ir_node *node, cond_kind kind);
-long      get_Cond_defaultProj(const ir_node *node);
+long      get_Cond_default_proj(const ir_node *node);
+void      set_Cond_default_proj(ir_node *node, long defproj);
 
 /**
  * Projection numbers for conditions.
@@ -536,9 +547,6 @@ void     set_Const_type(ir_node *node, ir_type *tp);
 /** Returns non-zero if s symconst kind has an enum_const attribute */
 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
 
-/** Returns non-zero if s symconst kind has a label attribute */
-#define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)
-
 /** Get the kind of the SymConst. */
 symconst_kind get_SymConst_kind(const ir_node *node);
 /** Set the kind of the SymConst. */
@@ -567,11 +575,6 @@ union symconst_symbol get_SymConst_symbol(const ir_node *node);
 void                  set_SymConst_symbol(ir_node *node,
                                           union symconst_symbol sym);
 
-/** Only to access SymConst of kind symconst_label.  Else assertion: */
-ir_label_t get_SymConst_label(const ir_node *node);
-void       set_SymConst_label(ir_node *node, ir_label_t label);
-
-
 /** Access the type of the value represented by the SymConst.
  *
  *  Example: primitive type int for SymConst size. */
@@ -605,9 +608,13 @@ typedef enum {
 } pn_Call;   /* Projection numbers for Call. */
 #define pn_Call_M pn_Call_M_regular
 
+/** Retrieve the memory input of a Call. */
 ir_node *get_Call_mem(const ir_node *node);
+/** Set the memory input of a Call. */
 void     set_Call_mem(ir_node *node, ir_node *mem);
+/** Retrieve the call address of a Call. */
 ir_node *get_Call_ptr(const ir_node *node);
+/** Set the call address of a Call. */
 void     set_Call_ptr(ir_node *node, ir_node *ptr);
 ir_node **get_Call_param_arr(ir_node *node);
 /** Gets the number of parameters of a call. */
@@ -659,7 +666,7 @@ void    remove_Call_callee_arr(ir_node *node);
  */
 typedef enum {
        pn_Builtin_M        = pn_Generic_M_regular, /**< The memory result. */
-       pn_Builtin_T_result = pn_Generic_other,     /**< The tuple containing all (0, 1, 2, ...) results. */
+       pn_Builtin_1_result = pn_Generic_other,     /**< first result. */
        pn_Builtin_max                              /**< number of projections from a Builtin */
 } pn_Builtin;   /* Projection numbers for Builtin. */
 
@@ -681,9 +688,13 @@ void            set_Builtin_type(ir_node *node, ir_type *tp);
 /** Returns a human readable string for the ir_builtin_kind. */
 const char *get_builtin_kind_name(ir_builtin_kind kind);
 
+/** Retrieve the call address of a CallBegin. */
 ir_node  *get_CallBegin_ptr(const ir_node *node);
+/** Set the call address of a CallBegin. */
 void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
+/** Retrieve the original Call node of a CallBegin. */
 ir_node  *get_CallBegin_call(const ir_node *node);
+/** Set the original Call node of a CallBegin. */
 void      set_CallBegin_call(ir_node *node, ir_node *call);
 
 /* For unary and binary arithmetic operations the access to the
@@ -711,6 +722,11 @@ void     set_Carry_left(ir_node *node, ir_node *left);
 ir_node *get_Carry_right(const ir_node *node);
 void     set_Carry_right(ir_node *node, ir_node *right);
 
+ir_node *get_Borrow_left(const ir_node *node);
+void     set_Borrow_left(ir_node *node, ir_node *left);
+ir_node *get_Borrow_right(const ir_node *node);
+void     set_Borrow_right(ir_node *node, ir_node *right);
+
 ir_node *get_Sub_left(const ir_node *node);
 void     set_Sub_left(ir_node *node, ir_node *left);
 ir_node *get_Sub_right(const ir_node *node);
@@ -778,7 +794,8 @@ ir_node *get_Div_mem(const ir_node *node);
 void     set_Div_mem(ir_node *node, ir_node *mem);
 ir_mode *get_Div_resmode(const ir_node *node);
 void     set_Div_resmode(ir_node *node, ir_mode *mode);
-int      is_Div_remainderless(const ir_node *node);
+int      get_Div_no_remainder(const ir_node *node);
+void     set_Div_no_remainder(ir_node *node, int no_remainder);
 
 /**
  * Projection numbers for Div: use for Proj nodes!
@@ -1157,7 +1174,7 @@ void     set_Bound_upper(ir_node *bound, ir_node *upper);
 
 /** Return the operand of a Pin node. */
 ir_node *get_Pin_op(const ir_node *pin);
-void    set_Pin_op(ir_node *pin, ir_node *node);
+void     set_Pin_op(ir_node *pin, ir_node *node);
 
 /** Return the assembler text of an ASM pseudo node. */
 ident *get_ASM_text(const ir_node *node);
@@ -1306,6 +1323,8 @@ int      is_IJmp(const ir_node *node);
 int      is_Raise(const ir_node *node);
 /** Returns true if a node is an ASM node. */
 int      is_ASM(const ir_node *node);
+/** Returns true if a node is an Dummy node. */
+int      is_Dummy(const ir_node *node);
 /** 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. */
@@ -1331,6 +1350,12 @@ ir_mode *get_divop_resmod(const ir_node *node);
  *  operation: Cond. */
 int is_irn_forking(const ir_node *node);
 
+/**
+ * Copies all attributes stored in the old node  to the new node.
+ * Assumes both have the same opcode and sufficient size.
+ */
+void copy_node_attr(const ir_node *old_node, ir_node *new_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 or unknown_type. */
@@ -1387,7 +1412,7 @@ typedef enum {
        COND_JMP_PRED_FALSE        /**< The False case is predicted. */
 } cond_jmp_predicate;
 
-/** Gets the string representation of the jump prediction .*/
+/** 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. */