remove symconst_type_tag
[libfirm] / include / libfirm / irnode.h
index 36553e2..807b553 100644 (file)
@@ -21,7 +21,6 @@
  * @file
  * @brief   Representation of an intermediate operation.
  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
- * @version $Id$
  */
 #ifndef FIRM_IR_IRNODE_H
 #define FIRM_IR_IRNODE_H
@@ -35,8 +34,6 @@
 #include "begin.h"
 #include "nodeops.h"
 
-ENUM_BITSET(pn_Cmp)
-
 /**
  * @defgroup ir_node Declarations of an ir node.
  *
@@ -61,34 +58,22 @@ ENUM_BITSET(pn_Cmp)
  */
 
 /**
- *   Checks whether a pointer points to a ir node.
+ * Checks whether a pointer points to a ir node. This is guessed by looking
+ * at the few bytes of the thing. Most things used in firm have a firm_kind
+ * attribute there. This function might falsely return true though for things
+ * without a firm_kind at the beginning.
  *
- *   @param thing   an arbitrary pointer
- *   @return        non-zero if the thing is a ir mode, else zero
+ * @param thing   an arbitrary pointer
+ * @return        non-zero if the thing is a ir mode, else zero
  */
-FIRM_API int is_ir_node (const void *thing);
+FIRM_API int is_ir_node(const void *thing);
 
 /**
  * Returns the number of predecessors without the block predecessor.
  *
  * @param node   the IR-node
  */
-FIRM_API int get_irn_arity      (const ir_node *node);
-
-/** Replaces the old in array by a new one that will contain the ins given in
-   the parameters.  Conserves the block predecessor.  It copies the array passed.
-   This function is necessary to adjust in arrays of blocks, calls and phis.
-   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. */
-FIRM_API 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(),
-   to iterate including the Block predecessor iterate from i = -1 to
-   i < get_irn_arity. */
-/* Access predecessor n */
+FIRM_API int get_irn_arity(const ir_node *node);
 
 /**
  * Get the n-th predecessor of a node.
@@ -96,6 +81,15 @@ FIRM_API void set_irn_in(ir_node *node, int arity, ir_node *in[]);
  */
 FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
 
+/**
+ * Replaces the old in array by a new one that will contain the ins given in
+ * the parameters. Conserves the block predecessor. It copies the array passed.
+ * This function is necessary to adjust in arrays of blocks, calls and phis.
+ * 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. */
+FIRM_API void set_irn_in(ir_node *node, int arity, ir_node *in[]);
+
 /**
  * Add a artificial dependency to the node.
  * The dependency is only inserted if it is not there already.
@@ -148,9 +142,9 @@ FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
  * @returns   the number of the new input
  */
 FIRM_API int add_irn_n(ir_node *node, ir_node *in);
-/* Remove predecessor i from Sync n */
+/** Remove predecessor i from Sync n */
 FIRM_API void del_Sync_n(ir_node *n, int i);
-/* Sets the mode struct of node.  */
+/** Sets the mode struct of node.  */
 FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
 /** Gets the mode struct of a node.  */
 FIRM_API ir_mode *get_irn_mode(const ir_node *node);
@@ -164,7 +158,7 @@ FIRM_API unsigned get_irn_opcode(const ir_node *node);
 FIRM_API const char *get_irn_opname(const ir_node *node);
 /** Get the ident for a string representation of the opcode. */
 FIRM_API ident *get_irn_opident(const ir_node *node);
-/** If arg is an argument of the node, returns it's position, -1 otherwise */
+/** If arg is an argument of the node, returns its position, -1 otherwise */
 FIRM_API int get_irn_pred_pos(ir_node *node, ir_node *arg);
 /** Gets the visited counter of a node. */
 FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
@@ -244,10 +238,10 @@ FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
  * 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(). */
-FIRM_API ir_node *get_nodes_block (const ir_node *node);
+FIRM_API ir_node *get_nodes_block(const ir_node *node);
 
 /** Sets the Block of a node. */
-FIRM_API void set_nodes_block (ir_node *node, ir_node *block);
+FIRM_API void set_nodes_block(ir_node *node, ir_node *block);
 
 /** Test whether arbitrary node is frame pointer.
  *
@@ -255,12 +249,6 @@ FIRM_API void set_nodes_block (ir_node *node, ir_node *block);
  * from Start.  If so returns frame type, else Null. */
 FIRM_API ir_type *is_frame_pointer(const ir_node *n);
 
-/** Test whether arbitrary node is the thread local storage (tls) pointer.
- *
- * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
- * from Start.  If so returns tls type, else Null. */
-FIRM_API ir_type *is_tls_pointer(const ir_node *n);
-
 /** Return the number of control flow predecessors of a block. */
 FIRM_API int get_Block_n_cfgpreds(const ir_node *block);
 /** Return the control flow predecessor of a block at a given position. */
@@ -304,17 +292,12 @@ FIRM_API 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()*/
 FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
+/** set block visited flag */
 FIRM_API 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.
- * Dead blocks are removed in the con
- */
-FIRM_API ir_node *set_Block_dead(ir_node *block);
-FIRM_API int is_Block_dead(const ir_node *block);
-
-/* For this current_ir_graph must be set. */
+/** mark a block as visited by setting its visited counter */
 FIRM_API void mark_Block_block_visited(ir_node *node);
+/** returns 1 if a block is marked as visited */
 FIRM_API int Block_block_visited(const ir_node *node);
 
 /** Returns the extended basic block a block belongs to. */
@@ -323,14 +306,8 @@ FIRM_API ir_extblk *get_Block_extbb(const ir_node *block);
 FIRM_API void set_Block_extbb(ir_node *block, ir_extblk *extblk);
 /** Returns the ir_graph this Block belongs to. */
 FIRM_API ir_graph *get_Block_irg(const ir_node *block);
-/** Returns non-zero if the block has an entity assigned */
-FIRM_API int has_Block_entity(const ir_node *block);
-/** Returns the entity for a Block */
-FIRM_API ir_entity *get_Block_entity(const ir_node *block);
 /** Returns the entity for a Block (creating it if necessary) */
 FIRM_API ir_entity *create_Block_entity(ir_node *block);
-/** Set a new entity for a block */
-FIRM_API void set_Block_entity(ir_node *block, ir_entity *entity);
 /** Gets the head of the Phi list for this block. */
 FIRM_API ir_node *get_Block_phis(const ir_node *block);
 /** Sets the head of the Phi list for this block. */
@@ -361,7 +338,7 @@ FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
 /** Remove irn from the keep-alive set. */
 FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
 
-/* Remove Bads, NoMem and doublets from the keep-alive set. */
+/** Remove Bads, NoMem and doublets from the keep-alive set. */
 FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
 
 /** Some parts of the End node are allocated separately -- their memory
@@ -403,7 +380,7 @@ FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
 /** Set the kind of the SymConst. */
 FIRM_API void          set_SymConst_kind(ir_node *node, symconst_kind num);
 
-/** Only to access SymConst of kind type_tag or size.  Else assertion: */
+/** Only to access SymConst of kind type_size.  Else assertion: */
 FIRM_API ir_type  *get_SymConst_type(const ir_node *node);
 FIRM_API void     set_SymConst_type(ir_node *node, ir_type *tp);
 
@@ -415,9 +392,6 @@ FIRM_API void       set_SymConst_entity(ir_node *node, ir_entity *ent);
 FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
 FIRM_API void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
 
-/** Sets both: type and ptrinfo.  Needed to treat the node independent of
-   its semantics.  Does a memcpy for the memory sym points to. */
-/* write 'union': firmjni then does not create a method... */
 FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
 FIRM_API void                  set_SymConst_symbol(ir_node *node,
                                                    union symconst_symbol sym);
@@ -435,12 +409,6 @@ FIRM_API ir_node *get_Call_param(const ir_node *node, int pos);
 /** Sets the call parameter at position pos. */
 FIRM_API void     set_Call_param(ir_node *node, int pos, ir_node *param);
 
-/**
- * Returns non-zero if a Call is surely a self-recursive Call.
- * Beware: if this functions returns 0, the call might be self-recursive!
- */
-FIRM_API 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
@@ -478,12 +446,6 @@ FIRM_API void            set_Builtin_param(ir_node *node, int pos, ir_node *para
 /** Returns a human readable string for the ir_builtin_kind. */
 FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
 
-/* For unary and binary arithmetic operations the access to the
-   operands can be factored out.  Left is the first, right the
-   second arithmetic value  as listed in tech report 1999-44.
-   unops are: Minus, Abs, Not, Conv, Cast
-   binops are: Add, Sub, Mul, Div, Mod, And, Or, Eor, Shl,
-   Shr, Shrs, Rotl, Cmp */
 FIRM_API int      is_unop(const ir_node *node);
 FIRM_API ir_node *get_unop_op(const ir_node *node);
 FIRM_API void     set_unop_op(ir_node *node, ir_node *op);
@@ -493,6 +455,27 @@ FIRM_API void     set_binop_left(ir_node *node, ir_node *left);
 FIRM_API ir_node *get_binop_right(const ir_node *node);
 FIRM_API void     set_binop_right(ir_node *node, ir_node *right);
 
+/**
+ * Test wether a node is the X_except Proj of a fragile operation
+ */
+FIRM_API int      is_x_except_Proj(const ir_node *node);
+
+/**
+ * Test wether a node is the X_regular Proj of a fragile operation
+ */
+FIRM_API int      is_x_regular_Proj(const ir_node *node);
+
+/**
+ * Set throws exception attribute of a fragile node
+ * @p throws_exception must be 0 or 1
+ */
+FIRM_API void     ir_set_throws_exception(ir_node *node, int throws_exception);
+
+/**
+ * Returns throws_exception attribute of a fragile node
+ */
+FIRM_API int      ir_throws_exception(const ir_node *node);
+
 /** returns the name of an ir_relation */
 FIRM_API const char *get_relation_string(ir_relation relation);
 
@@ -547,26 +530,12 @@ FIRM_API void     set_memop_mem(ir_node *node, ir_node *mem);
 FIRM_API ir_node *get_memop_ptr(const ir_node *node);
 FIRM_API void     set_memop_ptr(ir_node *node, ir_node *ptr);
 
-FIRM_API ir_volatility  get_Load_volatility(const ir_node *node);
-FIRM_API void           set_Load_volatility(ir_node *node, ir_volatility volatility);
-FIRM_API ir_align       get_Load_align(const ir_node *node);
-FIRM_API void           set_Load_align(ir_node *node, ir_align align);
-
-FIRM_API ir_volatility  get_Store_volatility(const ir_node *node);
-FIRM_API void           set_Store_volatility(ir_node *node, ir_volatility volatility);
-FIRM_API ir_align       get_Store_align(const ir_node *node);
-FIRM_API void           set_Store_align(ir_node *node, ir_align align);
-
 FIRM_API ir_node **get_Sync_preds_arr(ir_node *node);
 FIRM_API int       get_Sync_n_preds(const ir_node *node);
 FIRM_API ir_node  *get_Sync_pred(const ir_node *node, int pos);
 FIRM_API void      set_Sync_pred(ir_node *node, int pos, ir_node *pred);
 FIRM_API void      add_Sync_pred(ir_node *node, ir_node *pred);
 
-/** Return the projection number of a Proj node. */
-FIRM_API long      get_Proj_proj(const ir_node *node);
-FIRM_API void      set_Proj_proj(ir_node *node, long proj);
-
 /**
  * Returns non-zero if a node is a routine parameter.
  *
@@ -580,26 +549,19 @@ FIRM_API ir_node  *get_Tuple_pred(const ir_node *node, int pos);
 FIRM_API void      set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
 
 /** Return the number of input constraints for an ASM node. */
-FIRM_API int get_ASM_n_input_constraints(const ir_node *node);
+FIRM_API size_t get_ASM_n_input_constraints(const ir_node *node);
 /** Return the number of output constraints for an ASM node.  */
-FIRM_API int get_ASM_n_output_constraints(const ir_node *node);
+FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
 /** Return the number of clobbered registers for an ASM node.  */
-FIRM_API int get_ASM_n_clobbers(const ir_node *node);
-
-/*
- *
- * NAME Auxiliary routines
- *
- */
+FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
 
 /** Returns operand of node if node is a Proj. */
 FIRM_API ir_node *skip_Proj(ir_node *node);
 /** Returns operand of node if node is a Proj. */
 FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
 /** Returns operand of node if node is a Id. */
-FIRM_API 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. */
+FIRM_API ir_node *skip_Id(ir_node *node);
+/** Returns corresponding operand of Tuple if node is a Proj from a Tuple. */
 FIRM_API ir_node *skip_Tuple(ir_node *node);
 /** Returns operand of node if node is a Cast. */
 FIRM_API ir_node *skip_Cast(ir_node *node);
@@ -610,13 +572,17 @@ FIRM_API ir_node *skip_Pin(ir_node *node);
 FIRM_API ir_node *skip_Confirm(ir_node *node);
 /** Skip all high-level Operations (including Cast, Confirm). */
 FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
-/** Returns true if the operation manipulates control flow:
-   Start, End, Jmp, Cond, Return, Raise, Bad */
+/** Returns true if the operation manipulates control flow */
 FIRM_API int is_cfop(const ir_node *node);
+/** returns true if the operation jumps to an unknown destination.
+ * See irop_flag_unknown_jump for a detailed explanation */
+FIRM_API int is_unknown_jump(const ir_node *node);
 
-/** Returns true if the operation can change the control flow because
-    of an exception: Call, Div, Mod, Load, Store, Alloc,
-    Bad. Raise is not fragile, but a unconditional jump. */
+/**
+ * Returns true if the operation can change the control flow because
+ * of an exception: Call, Div, Mod, Load, Store, Alloc,
+ * Bad. Raise is not fragile, but a unconditional jump.
+ */
 FIRM_API int is_fragile_op(const ir_node *node);
 /** Returns the memory operand of fragile operations. */
 FIRM_API ir_node *get_fragile_op_mem(ir_node *node);
@@ -641,7 +607,7 @@ FIRM_API int is_irn_forking(const ir_node *node);
 FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
 
 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
   Cast) or NULL.*/
*  Cast) or NULL.*/
 FIRM_API ir_type *get_irn_type_attr(ir_node *n);
 
 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
@@ -661,21 +627,6 @@ FIRM_API int is_irn_keep(const ir_node *node);
  */
 FIRM_API int is_irn_start_block_placed(const ir_node *node);
 
-/**
- * Returns non-zero for nodes that are machine operations.
- */
-FIRM_API int is_irn_machine_op(const ir_node *node);
-
-/**
- * Returns non-zero for nodes that are machine operands.
- */
-FIRM_API int is_irn_machine_operand(const ir_node *node);
-
-/**
- * Returns non-zero for nodes that have the n'th user machine flag set.
- */
-FIRM_API int is_irn_machine_user(const ir_node *node, unsigned n);
-
 /**
  * Returns non-zero for nodes that are CSE neutral to its users.
  */
@@ -684,12 +635,6 @@ FIRM_API int is_irn_cse_neutral(const ir_node *node);
 /** Gets the string representation of the jump prediction. */
 FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
 
-/** Checks whether a node represents a global address. */
-FIRM_API int is_Global(const ir_node *node);
-
-/* Returns the entity of a global address. */
-FIRM_API ir_entity *get_Global_entity(const ir_node *node);
-
 /**
  * Access custom node data.
  * The data must have been registered with
@@ -760,7 +705,24 @@ FIRM_API unsigned firm_default_hash(const ir_node *node);
  */
 FIRM_API const char *gdb_node_helper(void *firm_object);
 
-/*@}*/ /* end of ir_node group definition */
+FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);
+
+FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);
+
+FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
+                                  ir_tarval *min, ir_tarval *max, long pn);
+
+FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
+                                            size_t entry);
+
+FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
+                                            size_t entry);
+
+FIRM_API long ir_switch_table_get_pn(const ir_switch_table *table, size_t entry);
+
+FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);
+
+/*@}*/
 
 #include "end.h"