* *frame The ir_node producing the pointer to the stack frame of
* the procedure as output. This is the Proj node on the
* third output of the start node. This output of the start
- * node is tagged as pns_frame_base. In FIRM most lokal
+ * node is tagged as pns_frame_base. In FIRM most lokal
* variables are modeled as data flow edges. Static
* allocated arrays can not be represented as dataflow
* edges. Therefore FIRM has to represent them in the stack
*
* *args The ir_node that produces the arguments of the method as
* it's result. This is a Proj node on the fourth output of
- * the start node. This output is tagged as pns_args.
+ * the start node. This output is tagged as pn_Start_T_args.
*
* *bad The bad node is an auxiliary node. It is needed only once,
* so there is this globally reachable node.
*
* *current_block A pointer to the current block. Any node created with
* one of the node constructors (new_<opcode>) are assigned
- * to this block. It can be set with switch_block(block).
+ * to this block. It can be set with set_cur_block(block).
* Only needed for ir construction.
*
* params/n_loc An int giving the number of local variables in this
*
* + types ==> implemented in type.h
* With types type information is represented. There are several type
- * nodes.
+ * nodes.
*
* Implementation of the FIRM operations: ir_node
* ----------------------------------------------
* one statically allocated struct ir_op for each opcode.
*
* *mode The ir_mode of the operation represented by this firm
- * node. The mode of the operation is the mode of it's
+ * node. The mode of the operation is the mode of it's
* result. A Firm mode is a datatype as known to the target,
* not a type of the source language.
*
* *link A pointer to an ir_node. With this pointer all Phi nodes
* are attached to a Block, i.e., a Block points to it's
* first Phi node, this node points to the second Phi node
- * in the Block and so fourth. Used in mature_block
+ * in the Block and so fourth. Used in mature_immBlock
* to find all Phi nodes to be matured. It's also used to
* annotate a node with a better, optimized version of it.
*
* ================
*
* current_ir_graph Points to the current ir_graph. All constructors for
- * nodes add nodes to this graph.
+ * nodes add nodes to this graph.
*
* ir_visited An int used as flag to traverse the ir_graph.
*
* (new_<Node> constructurs and a set of additional routines.)
* * A less comfortable interface where all predecessors except the block
* an operation belongs to need to be specified. SSA must be constructed
- * by hand. (new_<Node> constructors and switch_block()). This interface
+ * by hand. (new_<Node> constructors and set_cur_block()). This interface
* is called "block oriented". It automatically calles the local optimizations
* for each new node.
* * An even less comfortable interface where the block needs to be specified
*
* A global variable holds the current basic block. All (non block) nodes
* generated are added to this block. The current block can be set with
- * switch_block(block). If several blocks are constructed in parallel block
+ * set_cur_block(block). If several blocks are constructed in parallel block
* switches need to be performed constantly.
*
* To generate a Block node (with the comfortable interface) it's predecessor
* control flow nodes need not be known. In case of cyclic control flow these
- * can not be known when the block is constructed. With add_in_edge(block,
+ * can not be known when the block is constructed. With add_immBlock_pred(block,
* cfnode) predecessors can be added to the block. If all predecessors are
- * added to the block mature_block(b) needs to be called. Calling mature_block
+ * added to the block mature_immBlock(b) needs to be called. Calling mature_immBlock
* early improves the efficiency of the Phi node construction algorithm.
- * But if several blocks are constructed at once, mature_block must only
+ * But if several blocks are constructed at once, mature_immBlock must only
* be called after performing all set_values and set_stores in the block!
* (See documentation of new_immBlock constructor.)
*
* ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
*
* this_block = new_immBlock();
- * add_in_edge(this_block, cf_pred1);
- * add_in_edge(this_block, cf_pred2);
- * mature_block(this_block);
+ * add_immBlock_pred(this_block, cf_pred1);
+ * add_immBlock_pred(this_block, cf_pred2);
+ * mature_immBlock(this_block);
* a_val = get_value(42, mode_Iu);
* mem = get_store();
* div = new_Div(mem, a_val, a_val);
* ir_node *new_Return (ir_node *store, int arity, ir_node **in);
* ir_node *new_Raise (ir_node *store, ir_node *obj);
* ir_node *new_Const (ir_mode *mode, tarval *con);
- * ir_node *new_SymConst (type_or_id_p value, symconst_kind kind);
+ * ir_node *new_SymConst (symconst_symbol value, symconst_kind kind);
* ir_node *new_simpleSel (ir_node *store, ir_node *objptr, entity *ent);
* ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
* ir_node **in, entity *ent);
* ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
* type *free_type);
* ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
-=======
- * ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent);
- * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity,
- * ir_node **in, entity *ent);
- * ir_node *new_Call (ir_node *store, ir_node *callee, int arity,
- * ir_node **in, type_method *type);
- * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
- * ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
- * ir_node *new_Minus (ir_node *op, ir_mode *mode);
- * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
- * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2);
- * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2);
- * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2);
- * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2);
- * ir_node *new_Abs (ir_node *op, ir_mode *mode);
- * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
- * ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
- * ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
- * ir_node *new_Not (ir_node *op, ir_mode *mode);
- * ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
- * ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
- * ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
- * ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
- * ir_node *new_Cmp (ir_node *op1, ir_node *op2);
- * ir_node *new_Conv (ir_node *op, ir_mode *mode);
- * ir_node *new_Cast (ir_node *op, type *to_tp);
- * ir_node *new_Load (ir_node *store, ir_node *addr);
- * ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
- * ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type,
- * where_alloc where);
- * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
- * type *free_type);
- * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
* ir_node *new_FuncCall (ir_node *store, ir_node *callee, int arity,
* ir_node **in, type_method *type);
*
- * void add_in_edge (ir_node *block, ir_node *jmp);
- * void mature_block (ir_node *block);
- * void switch_block (ir_node *target);
+ * void add_immBlock_pred (ir_node *block, ir_node *jmp);
+ * void mature_immBlock (ir_node *block);
+ * void set_cur_block (ir_node *target);
* ir_node *get_value (int pos, ir_mode *mode);
* void set_value (int pos, ir_node *value);
* ir_node *get_store (void);
* Creates a new block. Sets current_block to itself. When a new block is
* created it cannot be known how many predecessors this block will have in the
* control flow graph. Therefore the list of inputs can not be fixed at
- * creation. Predecessors can be added with add_in_edge (block, control flow
+ * creation. Predecessors can be added with add_immBlock_pred (block, control flow
* operation). With every added predecessor the number of inputs to Phi nodes
* also changes.
*
- * The block can be completed by mature_block(block) if all predecessors are
- * known. If several blocks are built at once, mature_block can only be called
+ * The block can be completed by mature_immBlock(block) if all predecessors are
+ * known. If several blocks are built at once, mature_immBlock can only be called
* after set_value has been called for all values that are life at the end
- * of the block. This is necessary so that Phi nodes created by mature_block
- * get the right predecessors in case of cyclic dependencies. If all set_values
+ * of the block. This is necessary so that Phi nodes created mature_immBlock * get the right predecessors in case of cyclic dependencies. If all set_values
* of this block are called after maturing it and before calling get_value
* in some block that is control flow dependent on this block, the construction
* is correct.
*
* block_before_loop = new_block();
* set_value(x);
- * mature_block(block_before_loop);
+ * mature_immBlock(block_before_loop);
* before2header = new_Jmp;
*
* loop_header = new_block ();
* loop_body = new_block ();
* body2header = new_Jmp();
*
- * add_in_edge(loop_header, before2header);
- * add_in_edge(loop_header, body2header);
- * add_in_edge(loop_body, header2body);
+ * add_immBlock_pred(loop_header, before2header);
+ * add_immBlock_pred(loop_header, body2header);
+ * add_immBlock_pred(loop_body, header2body);
*
- * mature_block(loop_header);
- * mature_block(loop_body);
+ * mature_immBlock(loop_header);
+ * mature_immBlock(loop_body);
*
* get_value(loop_body, x); // gets the Phi in loop_header
* set_value(loop_header, x); // sets the value the above get_value should
* // have returned!!!
*
- * Mature_block also fixes the number of inputs to the Phi nodes. Mature_block
+ * Mature_immBlock also fixes the number of inputs to the Phi nodes. Mature_immBlock
* should be called as early as possible, as afterwards the generation of Phi
- * nodes is more efficient.
+ * nodes is more efficient.
*
* Inputs:
* There is an input for each control flow predecessor of the block.
* -------------------------
*
* Creates a start node. Not actually needed public. There is only one such
- * node in each procedure which is automatically created by new_ir_graph.
+ * node in each procedure which is automatically created by new_ir_graph.
*
* Inputs:
* No inputs except the block it belogns to.
* Output:
* A tuple of 4 (5, 6) distinct values. These are labeled by the following
- * projection numbers (pns_number):
- * * pns_initial_exec
- * mode X, points to the first block to be executed.
- * * pns_global_store
- * mode M, the global store
- * * pns_frame_base mode P, a pointer to the base of the procedures
- * stack frame.
- * * pns_globals mode P, a pointer to the part of the memory containing
- * _all_ global things.
- * * pns_args mode T, a tuple containing all arguments of the procedure.
+ * projection numbers (pn_Start):
+ * * pn_Start_X_initial_exec mode X, points to the first block to be exe * cuted.
+ * * pn_Start_M mode M, the global store
+ * * pn_Start_P_frame_base mode P, a pointer to the base of the proce * dures stack frame.
+ * * pn_Start_P_globals mode P, a pointer to the part of the memory * containing_all_ global things.
+ * * pn_Start_T_args mode T, a tuple containing all arguments of * the procedure.
*
*
* ir_node *new_End (void)
* -----------------------
*
* Creates an end node. Not actually needed public. There is only one such
- * node in each procedure which is automatically created by new_ir_graph.
+ * node in each procedure which is automatically created by new_ir_graph.
*
* Inputs:
* No inputs except the block it belongs to.
* attr.con A tarval* pointer to the proper entry in the constant
* table.
*
- * ir_node *new_SymConst (type *tp, symconst_kind kind)
+ * ir_node *new_SymConst (type *tp, symconst_addr_ent kind)
* ------------------------------------------------------------
*
* There are three kinds of symbolic constants:
- * type_tag The symbolic constant represents a type tag.
- * size The symbolic constant represents the size of a class.
- * link_info Information for the linker, e.g. the name of a global
+ * symconst_type_tag The symbolic constant represents a type tag.
+ * symconst_size The symbolic constant represents the size of a class.
+ * symconst_addr_name Information for the linker, e.g. the name of a global
* variable.
* To represent a pointer to an entity that is represented by an entity
* datastructure don't use
* An unsigned integer (I_u) or a pointer (P).
*
* Attributes:
- * attr.i.num The symconst_kind, i.e. one of
- * - type_tag
- * - size
- * - linkage_ptr_info
- * If the attr.i.num is type_tag or size, the node contains an attribute
+ * attr.i.num The symconst_addr_ent, i.e. one of
+ * -symconst_type_tag
+ * -symconst_size
+ * - symconst_addr_name
+ * If the attr.i.num is symconst_type_tag or symconst_size, the node contains an attribute
* attr.i.*type, a pointer to a type_class. The mode of the node is mode_Is.
* if it is linkage_ptr_info it contains
* attr.i.*ptrinfo, an ident holding information for the linker. The mode
* -----------------------------------------------------------------------------------
*
* Creates a procedure call to a function WITHOUT memory side effects.
- * Nodes of this kind are floating in contrast to Call nodes.
+ * nodes of this kind are floating in contrast to Call nodes.
* Further, a procedure call with FuncCall cannot raise an exception!
*
* Parameters
* replaced by the Tuple operation so that the following Proj nodes have not to
* be changed. (They are hard to find due to the implementation with pointers
* in only one direction.) The Tuple node is smaller than any other
- * node, so that a node can be changed into a Tuple by just changing it's
+ * node, so that a node can be changed into a Tuple by just changing it's
* opcode and giving it a new in array.
*
* Parameters
*
* Keep this node alive because it is (might be) not in the control
* flow from Start to End. Adds the node to the list in the end
- * node.
+ * node.
*
*/
/* The raw interface */
/*-------------------------------------------------------------------------*/
-/* Constructs a Block with a fixed number of predecessors.
- Does not set current_block. Can not be used with automatic
- Phi node construction. */
-
/** Constructor for a Block node.
*
- * Constructor for a Block node. Constructs a mature block with the given
- * predecessors. Use Unknown nodes as predecessors to constuct a block
- * if the number of predecessors is known, but not the predecessors themselves.
- * This constructor does not set current_block. It not be used with automatic
- * Phi node construction.
+ * Constructs a mature block with the given predecessors. Use Unknown
+ * nodes as predecessors to construct a block if the number of
+ * predecessors is known, but not the predecessors themselves. This
+ * constructor does not set current_block. It not be used with
+ * automatic Phi node construction.
*
* @param *db A Pointer for debug information.
* @param irg The ir graph the block belongs to.
ir_node *new_rd_Block (dbg_info *db, ir_graph *irg, int arity, ir_node *in[]);
/** Constructor for a Start node.
- *
- * Constructor for a Start node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
- *
*/
ir_node *new_rd_Start (dbg_info *db, ir_graph *irg, ir_node *block);
/** Constructor for a End node.
- *
- * Constructor for a End node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
- *
*/
ir_node *new_rd_End (dbg_info *db, ir_graph *irg, ir_node *block);
/** Constructor for a Jmp node.
*
- * Constructor for a Jmp node. Jmp represents control flow to a single \
- * control successor.
+ * Jmp represents control flow to a single control successor.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
- *
*/
ir_node *new_rd_Jmp (dbg_info *db, ir_graph *irg, ir_node *block);
-/** Constructor for a Cond node.
+/** Constructor for a Break node.
+ *
+ * Break represents control flow to a single control successor just as Jmp.
+ * The blocks separated by a break may not be concatenated by an optimization.
+ * It is used for the interprocedural representation where blocks are parted
+ * behind Call nodes to represent the control flow to called procedures.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belong to.
+ * @param *block The block the node belong to.
+ */
+ir_node *new_rd_Break (dbg_info *db, ir_graph *irg, ir_node *block);
+
+/** Constructor for a Cond node.
*
- * Constructor for a Cond node. If c is mode_b represents a conditional
- * branch (if/else). If c is mode_Is represents a switch. (Allocates dense
- * Cond node, default Proj is 0.)
+ * If c is mode_b represents a conditional branch (if/else). If c is
+ * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
+ * node, default Proj is 0.)
+ *
+ * This is not consistent: Input to Cond is Is, Proj has as proj number
+ * longs.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *c The conditions parameter. Can be of mode b or I_u.
- *
*/
ir_node *new_rd_Cond (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c);
/** Constructor for a Return node.
*
- * Constructor for a Return node. Returns the memory an zero or
- * more return values. Only node that can end regular control flow.
+ * Returns the memory an zero or more return values. Only node that
+ * can end regular control flow.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *store, int arity, ir_node *in[]);
/** Constructor for a Raise node.
- *
- * Constructor for a Raise node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *obj A pointer to the Except variable.
*/
ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *store, ir_node *obj);
+ ir_node *store, ir_node *obj);
-/** Constructor for a Const node.
+/** Constructor for a Const_type node.
*
- * Constructor for a Const node. The constant represents a target value.
- * This constructor sets high level type information for the
- * constant value.
+ * The constant represents a target value. This constructor sets high
+ * level type information for the constant value.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Const_type (dbg_info* db, ir_graph *irg, ir_node *block,
ir_mode *mode, tarval *con, type *tp);
-/** Constructor for a Const node.
+/** Constructor for a Const node.
*
- * Constructor for a Const node. The constant represents a target value.
- * Sets the type information to type_unknown. (No more supported: If
- * tv is entity derives a somehow useful type.)
+ * Constructor for a Const node. The constant represents a target
+ * value. Sets the type information to type_unknown. (No more
+ * supported: If tv is entity derives a somehow useful type.)
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *mode The mode of the operands and redults.
* @param *con Points to an entry in the constant table.
*/
-
ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block,
ir_mode *mode, tarval *con);
-/** Constructor for a SymConst node.
+/** Constructor for a SymConst_type node.
*
* This is the constructor for a symbolic constant.
* There are four kinds of symbolic constants:
- * type_tag The symbolic constant represents a type tag. The type the
+ * - type_tag The symbolic constant represents a type tag. The type the
* tag stands for is given explicitly.
- * size The symbolic constant represents the size of a type. The
+ * - size The symbolic constant represents the size of a type. The
* type of which the constant represents the size is given
* explicitly.
- * addr_name The symbolic constant represents the address of an entity
+ * - addr_name The symbolic constant represents the address of an entity
* (variable or method). The variable is indicated by a name
* that is valid for linking.
- * addr_ent The symbolic constant represents the address of an entity
+ * - addr_ent The symbolic constant represents the address of an entity
* (variable or method). The variable is given explicitly by
* a firm entity.
*
* Outputs of the node.
* An unsigned integer (I_u) or a pointer (P).
*
+ * Mention union in declaration so that the firmjni generator recognizes that
+ * it can not cast the argument to an int.
+ *
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param symkind The kind of the symbolic constant: type_tag, size, addr_name or addr_ent.
* @param value A type, entity or a ident depending on the SymConst kind.
+ * @param tp The source type of the constant.
*/
+ir_node *new_rd_SymConst_type (dbg_info* db, ir_graph *irg, ir_node *block, union symconst_symbol value,
+ symconst_kind symkind, type *tp);
+
+/** Constructor for a SymConst node.
+ *
+ * Same as new_rd_SymConst_type, except that it sets the type to type_unknown. */
ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block,
- type_or_id_p value, symconst_kind symkind);
+ union symconst_symbol value, symconst_kind symkind);
+
+/** Constructor for a SymConst addr_ent node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_addr_ent.
+ * Adds the symconst to the start block of irg. */
+ir_node *new_rd_SymConst_addr_ent (dbg_info *db, ir_graph *irg, entity *symbol, type *tp);
+
+/** Constructor for a SymConst addr_name node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_addr_ent.
+ * Adds the symconst to the start block of irg. */
+ir_node *new_rd_SymConst_addr_name (dbg_info *db, ir_graph *irg, ident *symbol, type *tp);
+
+/** Constructor for a SymConst type_tag node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_addr_ent.
+ * Adds the symconst to the start block of irg. */
+ir_node *new_rd_SymConst_type_tag (dbg_info *db, ir_graph *irg, type *symbol, type *tp);
+
+/** Constructor for a SymConst size node.
+ *
+ * Same as new_rd_SymConst_type, except that the constructor is tailored for
+ * symconst_addr_ent.
+ * Adds the symconst to the start block of irg. */
+ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, type *symbol, type *tp);
/** Constructor for a Sel node.
*
- * Constructor for a Sel node. The select node selects an entity (field or method)
- * from an entity with a compound type. It explicitly specifies the entity selected.
- * Dynamically the node may select entities that overwrite the given entity. If the
- * selected entity is an array element entity the Sel node takes the required array
- * indicees as inputs.
+ * The select node selects an entity (field or method) from an entity
+ * with a compound type. It explicitly specifies the entity selected.
+ * Dynamically the node may select entities that overwrite the given
+ * entity. If the selected entity is an array element entity the Sel
+ * node takes the required array indicees as inputs.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *index[] If the compound entity is an array the indicees of the selected
* element entity. The constructor copies this array.
* @param *ent The entity to select.
- *
*/
ir_node *new_rd_Sel (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
- ir_node *objptr, int n_index, ir_node *index[], entity *ent);
+ ir_node *objptr, int n_index, ir_node *index[], entity *ent);
-/**
- * Constructor for a InstOf node. For translating Java. Not supported as standard
- * firm node.
+/** Constructor for a InstOf node.
+ *
+ * For translating Java. Not supported as standard firm node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *objptr
* @param *ent
*/
-ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store, ir_node *objptr, type *ent);
+ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
+ ir_node *objptr, type *ent);
-/**
- * Constructor for a Call node.
+/** Constructor for a Call node.
+ *
+ * Represents all kinds of method and function calls.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Call (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
ir_node *callee, int arity, ir_node *in[], type *tp);
-/**
- * Constructor for a Add node.
+/** Constructor for a FuncCall node.
+ *
+ * FuncCall is a function Call that has no side effects. Therefore there
+ * is not memory operand or result.
+ *
+ * @param *db A pointer for debug information.
+ * @param *irg The ir graph the node belong to.
+ * @param *block The block the node belong to.
+ * @param *callee A pointer to the called procedure.
+ * @param arity The number of procedure parameters.
+ * @param *in[] An array with the pointers to the parameters. The constructor
+ * copies this array.
+ * @param *tp Type information of the procedure called.
+ */
+ir_node *new_rd_FuncCall (dbg_info *db, ir_graph *irg, ir_node *block,
+ ir_node *callee, int arity, ir_node *in[],
+ type *tp);
+
+/** Constructor for a Add node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *mode The mode of the operands and the result.
*/
ir_node *new_rd_Add (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *op1, ir_node *op2, ir_mode *mode);
+ ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Sub node.
+/** Constructor for a Sub node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *mode The mode of the operands and the result.
*/
ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *op1, ir_node *op2, ir_mode *mode);
+ ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Minus node.
+/** Constructor for a Minus node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *mode The mode of the operand and the result.
*/
ir_node *new_rd_Minus (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *op, ir_mode *mode);
+ ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Mul node.
+/** Constructor for a Mul node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Quot node.
+/** Constructor for a Quot node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a DivMod node.
+/** Constructor for a DivMod node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Div node.
+/** Constructor for a Div node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Mod node.
+/** Constructor for a Mod node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Mod (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Abs node.
+/** Constructor for a Abs node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Abs (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a And node.
+/** Constructor for a And node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Or node.
+/** Constructor for a Or node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Eor node.
+/** Constructor for a Eor node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Eor (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Not node.
+/** Constructor for a Not node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op The operand.
* @param *mode The mode of the operand and the result.
- *
*/
ir_node *new_rd_Not (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Cmp node.
+/** Constructor for a Cmp node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op1 The operand 1.
* @param *op2 The operand 2.
- *
*/
ir_node *new_rd_Cmp (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Shl node.
+/** Constructor for a Shl node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *op The operand.
* @param *k The number of bits to shift the operand .
* @param *mode The mode of the operand and the result.
- *
*/
ir_node *new_rd_Shl (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-
-/**
- * Constructor for a Shr node.
+/** Constructor for a Shr node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *op The operand.
* @param *k The number of bits to shift the operand .
* @param *mode The mode of the operand and the result.
- *
*/
-
ir_node *new_rd_Shr (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Shrs node.
+/** Constructor for a Shrs node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *op The operand.
* @param *k The number of bits to shift the operand.
* @param *mode The mode of the operand and the result.
- *
*/
-
ir_node *new_rd_Shrs (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Rot node.
+/** Constructor for a Rot node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *op The operand.
* @param *k The number of bits to rotate the operand.
* @param *mode The mode of the operand.
- *
*/
-
ir_node *new_rd_Rot (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Conv node.
+/** Constructor for a Conv node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op The operand.
* @param *mode The mode of this the operand muss be converted .
- *
*/
-
ir_node *new_rd_Conv (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Cast node. High level type cast.
+/** Constructor for a Cast node.
+ *
+ * High level type cast.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Cast (dbg_info* db, ir_graph *irg, ir_node *block,
ir_node *op, type *to_tp);
-/**
- * Constructor for a Phi node.
+/** Constructor for a Phi node.
*
- * @param *db A pointer for debugginaromation.
+ * @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param arity The number of predecessors
- * @param *in[] Array with predecessors. The constructor copies this array.
+ * @param *in[] Array with predecessors. The constructor copies this array.
* @param *mode The mode of it's inputs and output.
*/
ir_node *new_rd_Phi (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
ir_node *in[], ir_mode *mode);
-/**
- * Constructor for a Load node.
+/** Constructor for a Load node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Load (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *store, ir_node *adr);
-/**
- * Constructor for a Store node.
+/** Constructor for a Store node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
ir_node *new_rd_Store (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *store, ir_node *adr, ir_node *val);
-/**
- * Constructor for a Alloc node.
+/** Constructor for a Alloc node.
+ *
+ * The Alloc node extends the memory by space for an entity of type alloc_type.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *size The number of bytes to allocate.
* @param *alloc_type The type of the allocated variable.
* @param where Where to allocate the variable, either heap_alloc or stack_alloc.
- *
*/
ir_node *new_rd_Alloc (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
ir_node *size, type *alloc_type, where_alloc where);
/** Constructor for a Free node.
*
- * Constructor for a Free node. Frees the memory occupied by the
- * entity pointed to by the pointer arg. Type indicates the type of
- * the entity the argument points to.
+ * Frees the memory occupied by the entity pointed to by the pointer
+ * arg. Type indicates the type of the entity the argument points to.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *ptr The pointer to the object to free.
* @param *size The number of objects of type free_type to free in a sequence.
* @param *free_type The type of the freed variable.
- *
*/
ir_node *new_rd_Free (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
ir_node *ptr, ir_node *size, type *free_type);
-/** Constructor for a Sync node.
+/** Constructor for a Sync node.
*
- * Constructor for a Sync node. Merges several memory values. The node assumes
- * that a variable either occurs only in one of the memories, or it contains the
- * same value in all memories where it occurs.
+ * Merges several memory values. The node assumes that a variable
+ * either occurs only in one of the memories, or it contains the same
+ * value in all memories where it occurs.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
*/
ir_node *new_rd_Sync (dbg_info *db, ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
-/** Constructor for a Proj node.
+/** Constructor for a Proj node.
*
- * Constructor for a Proj node. Projects a single value out of a tuple.
- * The @param proj gives the position of the value within the tuple.
+ * Projects a single value out of a tuple. The parameter proj gives the
+ * position of the value within the tuple.
*
* @param *db A pointer for deubugginformation.
* @param *irg The ir graph the node belongs to.
/** Constructor for a defaultProj node.
*
- * Constructor for a defaultProj node. Represents the default control flow of
- * a Switch-Cond node.
+ * Represents the default control flow of a Switch-Cond node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
/** Constructor for a Tuple node.
*
- * Constructor for a Tuple node. This is an auxiliary node to replace a
- * node that returns a tuple without changing the corresponding Proj nodes.
+ * This is an auxiliary node to replace a node that returns a tuple
+ * without changing the corresponding Proj nodes.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
/** Constructor for a Id node.
*
- * Constructor for a Id node. This is an auxiliary node to
- * replace a node that returns a single value.
+ * This is an auxiliary node to replace a node that returns a single
+ * value.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
/** Constructor for a Bad node.
*
- * Constructor for a Bad node. Returns the unique Bad node of the graph.
- * The same as get_irg_bad(irg).
+ * Returns the unique Bad node of the graph. The same as
+ * get_irg_bad().
*
* @param *irg The ir graph the node belongs to.
*/
ir_node *new_rd_Bad (ir_graph *irg);
-/**
- * Constructor for a Confirm node.
+/** Constructor for a Confirm node.
+ *
+ * Specifies constraints for a value. To support dataflow analyses.
+ *
+ * Example: If the value never exceeds '100' this is expressed by placing a
+ * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
*
- * @param *db A pointer for debug information.
* @param *irg The ir graph the node belong to.
* @param *block The ir block the node belong to.
- * @param *val
- * @param *bound
- * @param cmp
+ * @param *db A pointer for debug information.
+ * @param *val The value we express a constraint for
+ * @param *bound The value to compare against. Must be a firm node, typically a constant.
+ * @param cmp The compare operation.
*/
ir_node *new_rd_Confirm (dbg_info *db, ir_graph *irg, ir_node *block,
ir_node *val, ir_node *bound, pn_Cmp cmp);
-/**
- * Constructor for a Unknown node.
+/** Constructor for an Unknown node.
+ *
+ * Represents an arbitrary value. Places the node in the start block.
*
* @param *irg The ir graph the node belongs to.
- * @param *m
+ * @param *m The mode of the unknown value.
*/
ir_node *new_rd_Unknown(ir_graph *irg, ir_mode *m);
-/**
- * Constructor for a CallBegin node.
+/** Constructor for a CallBegin node.
+ *
+ * CallBegin represents control flow depending of the pointer value
+ * representing the called method to the called methods. The
+ * constructor copies the method pointer input from the passed Call
+ * node.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
- * @param *callee The call node bisible in the intra procedural view.
+ * @param *callee The call node visible in the intra procedural view.
*/
ir_node *new_rd_CallBegin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *callee);
-/**
- * Constructor for a EndReg node.
+/** Constructor for a EndReg node.
+ *
+ * Used to represent regular procedure end in interprocedual view.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belong to.
*/
ir_node *new_rd_EndReg (dbg_info *db, ir_graph *irg, ir_node *block);
-/**
- * Constructor for a EndExcept node.
+/** Constructor for a EndExcept node.
+ *
+ * Used to represent exceptional procedure end in interprocedural view.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belong to.
*/
ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block);
-/**
- * Constructor for a Break node.
+/** Constructor for a Filter node.
*
- * @param *db A pointer for debug information.
- * @param *irg The ir graph the node belong to.
- * @param *block The block the node belong to.
- */
-ir_node *new_rd_Break (dbg_info *db, ir_graph *irg, ir_node *block);
-
-/**
+ * Adds the node to the block in current_ir_block. Filter is a node
+ * with two views used to construct the interprocedural view. In
+ * intraprocedural view its semantics are identical to the Proj node.
+ * In interprocedural view the Filter performs the Phi operation on
+ * method parameters or results. Other than a Phi a Filter node may
+ * not be removed if it has only a single input.
*
- * Constructor for a Filter node.
+ * The constructor builds the Filter in intraprocedural view.
*
- * @param *db A pointer for debug information.
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
- * @param *arg
- * @param *mode
- * @param proj
+ * @param *arg The tuple value to project from.
+ * @param *mode The mode of the projected value.
+ * @param proj The position in the tuple to project from.
*/
ir_node *new_rd_Filter (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
ir_mode *mode, long proj);
-/**
- * Constructor for a FuncCall node.
- *
- * @param *db A pointer for debug information.
- * @param *irg The ir graph the node belong to.
- * @param *block The block the node belong to.
- * @param *callee A pointer to the called procedure.
- * @param arity The number of procedure parameters.
- * @param *in[] An array with the pointers to the parameters. The constructor
- * copies this array. The constructor copies this array.
- * @param *tp Type information of the procedure called.
- */
-ir_node *new_rd_FuncCall (dbg_info *db, ir_graph *irg, ir_node *block,
- ir_node *callee, int arity, ir_node *in[],
- type *tp);
/*-------------------------------------------------------------------------*/
/* The raw interface without debug support */
/*-------------------------------------------------------------------------*/
-/* Constructs a Block with a fixed number of predecessors.
- Does not set current_block. Can not be used with automatic
- Phi node costruction. */
-
-/**
- * Constructor for a Block node.
+/** Constructor for a Block node.
+ *
+ * Constructs a mature block with the given predecessors. Use Unknown
+ * nodes as predecessors to construct a block if the number of
+ * predecessors is known, but not the predecessors themselves. This
+ * constructor does not set current_block. It not be used with
+ * automatic Phi node construction.
+ *
*
* @param irg The ir graph the block belongs to.
* @param arity The number of control predecessors.
- * @param in[] An array of control predecessors. The length of
+ * @param in[] An array of control predecessors. The length of
* the array must be 'arity'. The constructor copies this array.
*/
ir_node *new_r_Block (ir_graph *irg, int arity, ir_node *in[]);
-/**
- * Constructor for a Start node.
+/** Constructor for a Start node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
*/
ir_node *new_r_Start (ir_graph *irg, ir_node *block);
-/**
- * Constructor for a End node.
+/** Constructor for a End node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
*/
ir_node *new_r_End (ir_graph *irg, ir_node *block);
-/**
- * Constructor for a Jmp node.
+/** Constructor for a Jmp node.
+ *
+ * Jmp represents control flow to a single control successor.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
*/
ir_node *new_r_Jmp (ir_graph *irg, ir_node *block);
-/**
- * Constructor for a Cond node.
+/** Constructor for a Cond node.
+ *
+ * If c is mode_b represents a conditional branch (if/else). If c is
+ * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
+ * node, default Proj is 0.)
+ *
+ * This is not consistent: Input to Cond is Is, Proj has as proj number
+ * longs.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
*/
ir_node *new_r_Cond (ir_graph *irg, ir_node *block, ir_node *c);
-/**
- * Constructor for a Return node.
+/** Constructor for a Return node.
+ *
+ * Returns the memory an zero or more return values. Only node that
+ * can end regular control flow.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
ir_node *new_r_Return (ir_graph *irg, ir_node *block,
ir_node *store, int arity, ir_node *in[]);
-/**
- * Constructor for a Raise node.
+/** Constructor for a Raise node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *store The current memory.
* @param *obj A pointer to the Except variable.
- *
*/
-
ir_node *new_r_Raise (ir_graph *irg, ir_node *block,
ir_node *store, ir_node *obj);
-/**
- * Constructor for a Const node.
+/** Constructor for a Const node.
+ *
+ * Constructor for a Const node. The constant represents a target
+ * value. Sets the type information to type_unknown. (No more
+ * supported: If tv is entity derives a somehow useful type.)
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the results.
- * @param *con Points to an entry in the constant table. This pointer is
- * added to the attributes of the node (self->attr.con).
+ * @param *con Points to an entry in the constant table.
*/
-
ir_node *new_r_Const (ir_graph *irg, ir_node *block,
ir_mode *mode, tarval *con);
-/**
- * Constructor for a SymConst node.
+
+/** Constructor for a SymConst node.
+ *
+ * This is the constructor for a symbolic constant.
+ * There are four kinds of symbolic constants:
+ * - type_tag The symbolic constant represents a type tag. The type the
+ * tag stands for is given explicitly.
+ * - size The symbolic constant represents the size of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * - addr_name The symbolic constant represents the address of an entity
+ * (variable or method). The variable is indicated by a name
+ * that is valid for linking.
+ * - addr_ent The symbolic constant represents the address of an entity
+ * (variable or method). The variable is given explicitly by
+ * a firm entity.
+ *
+ * Inputs to the node:
+ * No inputs except the block it belongs to.
+ * Outputs of the node.
+ * An unsigned integer (I_u) or a pointer (P).
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
- * @param volue
+ * @param volue A type, entity or a ident depending on the SymConst kind.
* @param symkind The kind of the symbolic constant: type_tag, size or link_info.
*/
ir_node *new_r_SymConst (ir_graph *irg, ir_node *block,
- type_or_id_p value, symconst_kind symkind);
+ union symconst_symbol value, symconst_kind symkind);
-/**
- * Constructor for a Sel node.
+/** Constructor for a Sel node.
+ *
+ * The select node selects an entity (field or method) from an entity
+ * with a compound type. It explicitly specifies the entity selected.
+ * Dynamically the node may select entities that overwrite the given
+ * entity. If the selected entity is an array element entity the Sel
+ * node takes the required array indicees as inputs.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
- * @param *store The memory in which the object the entity should be selected from is allocated.
- * @param *objptr The object from that the Sel operation selects a single attribute out.
- * @param *n_index The index of the selected object from the array.
- * @param *index[] Array with index inputs to the node. The constructor copies this array.
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a compound entity the Sel operation selects a
+ * single attribute from.
+ * @param *n_index The number of array indicees needed to select an array element entity.
+ * @param *index[] If the compound entity is an array the indicees of the selected
+ * element entity. The constructor copies this array.
* @param *ent The entity to select.
*/
ir_node *new_r_Sel (ir_graph *irg, ir_node *block, ir_node *store,
ir_node *objptr, int n_index, ir_node *index[],
entity *ent);
-/**
- * Constructor for a InstOf node.
+/** Constructor for a InstOf node.
+ *
+ * For translating Java. Not supported as standard firm node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *z
*
*/
-
ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *x, ir_node *y, type *z);
-/**
- * Constructor for a Call node.
+/** Constructor for a Call node.
+ *
+ * Represents all kinds of method and function calls.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *tp Type information of the procedure called.
*
*/
-
ir_node *new_r_Call (ir_graph *irg, ir_node *block, ir_node *store,
ir_node *callee, int arity, ir_node *in[],
type *tp);
-/**
- * Constructor for a Add node.
+/** Constructor for a Add node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the result.
*
*/
-
-
ir_node *new_r_Add (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
/**
- * Constructor for a Sub node.
+ * Constructor for a Sub node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the results.
*
*/
-
ir_node *new_r_Sub (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Minus node.
+/** Constructor for a Minus node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_r_Minus (ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Mul node.
+/** Constructor for a Mul node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_r_Mul (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Quot node.
+/** Constructor for a Quot node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_r_Quot (ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a DivMod node.
+/** Constructor for a DivMod node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_r_DivMod (ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Div node.
+/** Constructor for a Div node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_r_Div (ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Mod node.
+/** Constructor for a Mod node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_r_Mod (ir_graph *irg, ir_node *block,
ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Abs node.
+/** Constructor for a Abs node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_r_Abs (ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a And node.
+/** Constructor for a And node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_r_And (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Or node.
+/** Constructor for a Or node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_r_Or (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Eor node.
+/** Constructor for a Eor node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operands and the results.
*
*/
-
ir_node *new_r_Eor (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Not node.
+/** Constructor for a Not node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_r_Not (ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Cmp node.
+/** Constructor for a Cmp node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_r_Cmp (ir_graph *irg, ir_node *block,
ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Shl node.
+/** Constructor for a Shl node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_r_Shl (ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Shr node.
+/** Constructor for a Shr node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_r_Shr (ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
/**
- * Constructor for a Shrs node.
+ * Constructor for a Shrs node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_r_Shrs (ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Rot node.
+/** Constructor for a Rot node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of the operand.
*
*/
-
ir_node *new_r_Rot (ir_graph *irg, ir_node *block,
ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Conv node.
+/** Constructor for a Conv node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of this the operand muss be converted .
*
*/
-
ir_node *new_r_Conv (ir_graph *irg, ir_node *block,
ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Cast node.
+/** Constructor for a Cast node.
+ *
+ * High level type cast
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *to_tp The type of this the operand muss be casted .
*
*/
-
ir_node *new_r_Cast (ir_graph *irg, ir_node *block,
ir_node *op, type *to_tp);
-/**
- * Constructor for a Phi node.
+
+/** Constructor for a Phi node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *mode The mode of it's inputs and output.
*
*/
-
ir_node *new_r_Phi (ir_graph *irg, ir_node *block, int arity,
- ir_node *in[], ir_mode *mode);
-/**
- * Constructor for a Load node.
+ ir_node *in[], ir_mode *mode);
+
+/** Constructor for a Load node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *adr A pointer to the variable to be read in this memory.
*
*/
-
ir_node *new_r_Load (ir_graph *irg, ir_node *block,
ir_node *store, ir_node *adr);
-/**
- * Constructor for a Store node.
+/** Constructor for a Store node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *adr A pointer to the variable to be read in this memory.
* @param *val The value to write to this variable.
*/
-
ir_node *new_r_Store (ir_graph *irg, ir_node *block,
- ir_node *store, ir_node *adr, ir_node *val);
-/**
- * Constructor for a Alloc node.
+ ir_node *store, ir_node *adr, ir_node *val);
+
+/** Constructor for a Alloc node.
+ *
+ * The Alloc node extends the memory by space for an entity of type alloc_type.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param where Where to allocate the variable, either heap_alloc or stack_alloc.
*
*/
-
ir_node *new_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store,
ir_node *size, type *alloc_type, where_alloc where);
-/**
- * Constructor for a Free node.
+
+/** Constructor for a Free node.
+ *
+ * Frees the memory occupied by the entity pointed to by the pointer
+ * arg. Type indicates the type of the entity the argument points to.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param *free_type The type of the freed variable.
*
*/
-
ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store,
ir_node *ptr, ir_node *size, type *free_type);
-/**
- * Constructor for a Sync node.
+
+/** Constructor for a Sync node.
+ *
+ * Merges several memory values. The node assumes that a variable
+ * either occurs only in one of the memories, or it contains the same
+ * value in all memories where it occurs.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param arity The number of memories to syncronize.
- * @param *in[] An array of pointers to nodes that produce an output of type memory. The constructor copies this array.
+ * @param *in[] An array of pointers to nodes that produce an output of type memory.
+ * The constructor copies this array.
*
*/
-
ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
-/**
- * Constructor for a Proj node.
+/** Constructor for a Proj node.
+ *
+ * Projects a single value out of a tuple. The parameter proj gives the
+ * position of the value within the tuple.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param proj The position of the value in the tuple.
*
*/
-
ir_node *new_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg,
ir_mode *mode, long proj);
-/**
- * Constructor for a defaultProj node.
+/** Constructor for a defaultProj node.
+ *
+ * Represents the default control flow of a Switch-Cond node.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param max_ proj The end position of the value in the tuple.
*
*/
-
ir_node *new_r_defaultProj (ir_graph *irg, ir_node *block, ir_node *arg, long max_proj);
-/**
- * Constructor for a Tuple node.
+/** Constructor for a Tuple node.
+ *
+ * This is an auxiliary node to replace a node that returns a tuple
+ * without changing the corresponding Proj nodes.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
* @param arity The number of tuple elements.
- * @param *in[] An array containing pointers to the nodes producing the tuple elements. The constructor copies this array.
- *
+ * @param *in[] An array containing pointers to the nodes producing the tuple elements.
+ * The constructor copies this array.
*/
-
ir_node *new_r_Tuple (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
-/**
- * Constructor for a Id node.
+
+/** Constructor for a Id node.
+ *
+ * This is an auxiliary node to replace a node that returns a single
+ * value.
*
* @param *irg The ir graph the node belongs to.
* @param *block The ir block the node belongs to.
- * @param *val
+ * @param *val The operand to Id.
* @param *mode The mode of *val.
*
*/
-
ir_node *new_r_Id (ir_graph *irg, ir_node *block,
ir_node *val, ir_mode *mode);
-/**
- * Constructor for a Bad node.
+/** Constructor for a Bad node.
+ *
+ * Returns the unique Bad node of the graph. The same as
+ * get_irg_bad().
*
* @param *irg The ir graph the node belongs to.
*
ir_node *new_r_Bad (ir_graph *irg);
-/**
- * Constructor for a Confirm node.
+/** Constructor for a Confirm node.
+ *
+ * Specifies constraints for a value. To support dataflow analyses.
+ *
+ * Example: If the value never exceeds '100' this is expressed by placing a
+ * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
*
* @param *irg The ir graph the node belong to.
* @param *block The ir block the node belong to.
- * @param *val
- * @param *bound
- * @param cmp
+ * @param *db A pointer for debug information.
+ * @param *val The value we express a constraint for
+ * @param *bound The value to compare against. Must be a firm node, typically a constant.
+ * @param cmp The compare operation.
*
*/
-
ir_node *new_r_Confirm (ir_graph *irg, ir_node *block,
ir_node *val, ir_node *bound, pn_Cmp cmp);
-/**
- * Constructor for a Unknown node.
+/** Constructor for a Unknown node.
*
- * @param *irg The ir graph the node belongs to.
- * @param *m
+ * Represents an arbtrary valus. Places the node in
+ * the start block.
*
+ * @param *irg The ir graph the node belongs to.
+ * @param *m The mode of the unknown value.
*/
-
ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
-/**
- * Constructor for a CallBegin node.
+/** Constructor for a CallBegin node.
+ *
+ * CallBegin represents control flow depending of the pointer value
+ * representing the called method to the called methods. The
+ * constructor copies the method pointer input from the passed Call
+ * node.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
* @param *callee The call node bisible in the intra procedural view.
*
*/
-
ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee);
-/**
- * Constructor for a EndReg node.
+/** Constructor for a EndReg node.
+ *
+ * Used to represent regular procedure end in interprocedual view.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
*
*/
-
ir_node *new_r_EndReg (ir_graph *irg, ir_node *block);
-/**
- * Constructor for a EndExcept node.
+/** Constructor for a EndExcept node.
+ *
+ * Used to represent exceptional procedure end in interprocedural view.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
*
*/
-
ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block);
-/**
- * Constructor for a Break node.
+/** Constructor for a Break node.
+ *
+ * Break represents control flow to a single control successor just as Jmp.
+ * The blocks separated by a break may not be concatenated by an optimization.
+ * It is used for the interprocedural representation where blocks are parted
+ * behind Call nodes to represent the control flow to called procedures.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
*
*/
-
ir_node *new_r_Break (ir_graph *irg, ir_node *block);
-/**
+/** Constructor for a Filter node.
+ *
+ * Constructor for a Filter node. Adds the node to the block in current_ir_block.
+ * Filter is a node with two views used to construct the interprocedural view.
+ * In intraprocedural view its semantics are identical to the Proj node.
+ * In interprocedural view the Filter performs the Phi operation on method
+ * parameters or results. Other than a Phi a Filter node may not be removed
+ * if it has only a single input.
*
- * Costructor for a Filter node.
+ * The constructor builds the Filter in intraprocedural view.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
- * @param *arg
- * @param *mode
- * @param proj
+ * @param *arg The tuple value to project from.
+ * @param *mode The mode of the projected value.
+ * @param proj The position in the tuple to project from.
*
*/
ir_node *new_r_Filter (ir_graph *irg, ir_node *block, ir_node *arg,
ir_mode *mode, long proj);
-/**
- * Constructor for a FuncCall node.
+
+/** Constructor for a FuncCall node.
+ *
+ * FuncCall is a function Call that has no side effects. Therefore there
+ * is not memory operand or result.
*
* @param *irg The ir graph the node belong to.
* @param *block The block the node belong to.
* @param *callee A pointer to the called procedure.
* @param arity The number of procedure parameters.
- * @param *in[] An array with the pointers to the parameters. The constructor copies this array.
+ * @param *in[] An array with the pointers to the parameters.
+ * The constructor copies this array.
* @param *type Type information of the procedure called.
*
*/
-
ir_node *new_r_FuncCall (ir_graph *irg, ir_node *block,
ir_node *callee, int arity, ir_node *in[],
type *tp);
/*-----------------------------------------------------------------------*/
/** Sets the current block in which the following constructors place the
- nodes they construct. */
-void switch_block (ir_node *target);
+ * nodes they construct.
+ *
+ * @param target The new current block.
+ */
+void set_cur_block (ir_node *target);
-/* Constructs a Block with a fixed number of predecessors.
- Does set current_block. Can be used with automatic Phi
- node construction. */
+/** Returns the current block of the current graph. */
+ir_node *get_cur_block(void);
-/**
- * Constructor for a Block node. Adds the block to the graph in current_ir_graph .
+/** Returns the fixed nodes of the current graph. */
+#define get_cur_end_block() get_irg_end_block(current_ir_graph)
+#define get_cur_end() get_irg_end(current_ir_graph)
+#define get_cur_start_block() get_irg_start_block(current_ir_graph)
+#define get_cur_start() get_irg_start(current_ir_graph)
+
+/** Constructor for a Block node.
*
- * @param *db A Pointer for debug information.
+ * Adds the block to the graph in current_ir_graph. Constructs a Block
+ * with a fixed number of predecessors. Does set current_block. Can
+ * be used with automatic Phi node construction.
+ *
+ * @param *db A Pointer for debugginfomation.
* @param arity The number of control predecessors.
- * @param in An array of control predecessors. The length of
+ * @param in[] An array of control predecessors. The length of
* the array must be 'arity'.
*/
-
ir_node *new_d_Block(dbg_info* db, int arity, ir_node *in[]);
-/**
- * Constructor for a Start node. Adds the node to the block in current_ir_block.
+/** Constructor for a Start node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
*
*/
-
ir_node *new_d_Start (dbg_info* db);
-/**
- * Constructor for a End node. Adds the node to the block in current_ir_block.
+/** Constructor for a End node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
*
*/
-
ir_node *new_d_End (dbg_info* db);
-/**
- * Constructor for a Jmp node. Adds the node to the block in current_ir_block.
+/** Constructor for a Jmp node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * Jmp represents control flow to a single control successor.
*
* @param *db A pointer for debug information.
*
ir_node *new_d_Jmp (dbg_info* db);
-/**
- * Constructor for a Cond node. Adds the node to the block in current_ir_block.
+/** Constructor for a Cond node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * If c is mode_b represents a conditional branch (if/else). If c is
+ * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
+ * node, default Proj is 0.)
+ *
+ * This is not consistent: Input to Cond is Is, Proj has as proj number
+ * longs.
*
* @param *db A pointer for debug information.
* @param *c The conditions parameter.Can be of mode b or I_u.
ir_node *new_d_Cond (dbg_info* db, ir_node *c);
-/**
- * Constructor for a Return node. Adds the node to the block in current_ir_block.
+/** Constructor for a Return node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * Returns the memory an zero or more return values. Only node that
+ * can end regular control flow.
*
* @param *db A pointer for debug information.
* @param *store The state of memory.
ir_node *new_d_Return (dbg_info* db, ir_node *store, int arity, ir_node *in[]);
-/**
- * Constructor for a Raise node. Adds the node to the block in current_ir_block.
+/** Constructor for a Raise node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *store The current memory.
ir_node *new_d_Raise (dbg_info* db, ir_node *store, ir_node *obj);
-/**
- * Constructor for a Const_type node. Adds the node to the block in current_ir_block.
+/** Constructor for a Const_type node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * The constant represents a target value. This constructor sets high
+ * level type information for the constant value.
*
* @param *db A pointer for debug information.
* @param *mode The mode of the operands and redults.
- * @param *con Points to an entry in the constant table. This pointer is added to the attributes of the node (self->attr.con).
+ * @param *con Points to an entry in the constant table. This pointer is
+ added to the attributes of the node.
* @param *tp The type of the constante.
*
*/
ir_node *new_d_Const_type (dbg_info* db, ir_mode *mode, tarval *con, type *tp);
-/**
- * Constructor for a Const node. Adds the node to the block in current_ir_block.
+/** Constructor for a Const node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * Constructor for a Const node. The constant represents a target
+ * value. Sets the type information to type_unknown. (No more
+ * supported: If tv is entity derives a somehow useful type.)
*
* @param *db A pointer for debug information.
* @param *mode The mode of the operands and redults.
- * @param *con Points to an entry in the constant table. This pointer is added to the attributes of the node (self->attr.con).
+ * @param *con Points to an entry in the constant table. This pointer is added
+ * to the attributes of the node.
*
*/
-
ir_node *new_d_Const (dbg_info* db, ir_mode *mode, tarval *con);
-/**
- * Constructor for a SymConst node. Adds the node to the block in current_ir_block.
+/** Constructor for a SymConst_type node.
+ *
+ * Adds the node to the block in current_ir_block.
+ * This is the constructor for a symbolic constant.
+ * There are four kinds of symbolic constants:
+ * - type_tag The symbolic constant represents a type tag. The type the
+ * tag stands for is given explicitly.
+ * - size The symbolic constant represents the size of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * - addr_name The symbolic constant represents the address of an entity
+ * (variable or method). The variable is indicated by a name
+ * that is valid for linking.
+ * - addr_ent The symbolic constant represents the address of an entity
+ * (variable or method). The variable is given explicitly by
+ * a firm entity.
+ *
+ * Inputs to the node:
+ * No inputs except the block it belongs to.
+ * Outputs of the node.
+ * An unsigned integer (I_u) or a pointer (P).
*
* @param *db A pointer for debug information.
- * @param volue
- * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
+ * @param value A type, entity or ident depending on the SymConst kind.
+ * @param symkind The kind of the symbolic constant: symconst_type_tag, symconst_size
+ * or symconst_addr_name.
+ * @param tp The source type of the constant.
*
*/
+ir_node *new_d_SymConst_type (dbg_info* db, union symconst_symbol value, symconst_kind kind, type* tp);
-ir_node *new_d_SymConst (dbg_info* db, type_or_id_p value, symconst_kind kind);
+/** Constructor for a SymConst node.
+ *
+ * Same as new_d_SymConst_type, except that it sets the type to type_unknown. */
+ir_node *new_d_SymConst (dbg_info* db, union symconst_symbol value, symconst_kind kind);
-/**
- * Constructor for a simpleSel node. Adds the node to the block in current_ir_block.
+/** Constructor for a simpleSel node.
+ *
+ * This is a shortcut for the new_d_Sel() constructor. To be used for
+ * Sel nodes that do not select from an array, i.e., have no index
+ * inputs. It adds the two parameters 0, NULL.
*
* @param *db A pointer for debug information.
- * @param *store The memory in which the object the entity should be selected from is allocated.
- * @param *objptr The object from that the Sel operation selects a single attribute out.
+ * @param *store The memory in which the object the entity should be
+ * selected from is allocated.
+ * @param *objptr The object from that the Sel operation selects a
+ * single attribute out.
* @param *ent The entity to select.
*
*/
-
ir_node *new_d_simpleSel(dbg_info* db, ir_node *store, ir_node *objptr, entity *ent);
-/**
- * Constructor for a Sel node. Adds the node to the block in current_ir_block.
+/** Constructor for a Sel node.
+ *
+ * The select node selects an entity (field or method) from an entity
+ * with a compound type. It explicitly specifies the entity selected.
+ * Dynamically the node may select entities that overwrite the given
+ * entity. If the selected entity is an array element entity the Sel
+ * node takes the required array indicees as inputs.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
- * @param *store The memory in which the object the entity should be selected from is allocated.
- * @param *objptr The object from that the Sel operation selects a single attribute out.
- * @param arity The index of the selected object from the array.
- * @param *in Array with index inputs to the node.
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a compound entity the Sel operation selects a
+ * single attribute from.
+ * @param *n_index The number of array indicees needed to select an array element entity.
+ * @param *index[] If the compound entity is an array the indicees of the selected
+ * element entity. The constructor copies this array.
* @param *ent The entity to select.
- *
*/
-
ir_node *new_d_Sel (dbg_info* db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
entity *ent);
-/**
- * Constructor for a InstOf node. Adds the node to the block in current_ir_block.
+/** Constructor for a InstOf node.
+ *
+ * Adds the node to the block in current_ir_block.
+ *
+ * For translating Java. Not supported as standard firm node.
*
* @param *db A pointer for debug information.
* @param *store
* @param *ent
*
*/
-
ir_node *new_d_InstOf (dbg_info* db, ir_node *store, ir_node *objptr, type *ent);
-/**
- * Constructor for a Call node. Adds the node to the block in current_ir_block.
+/** Constructor for a Call node.
+ *
+ * Represents all kinds of method and function calls.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *store The actual store.
ir_node *new_d_Call (dbg_info* db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
type *tp);
-/**
- * Constructor for a Add node. Adds the node to the block in current_ir_block.
+/** Constructor for a Add node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op1 The operand 1.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_d_Add (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Sub node. Adds the node to the block in current_ir_block.
+/** Constructor for a Sub node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op1 The operand 1.
ir_node *new_d_Sub (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Minus node. Adds the node to the block in current_ir_block.
+/** Constructor for a Minus node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand .
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_d_Minus (dbg_info* db, ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Mul node. Adds the node to the block in current_ir_block.
+/** Constructor for a Mul node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op1 The operand 1.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_d_Mul (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Quot node. Adds the node to the block in current_ir_block.
+/** Constructor for a Quot node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *memop The store needed to model exceptions
* @param *op2 The operand 2.
*
*/
-
ir_node *new_d_Quot (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a DivMod node. Adds the node to the block in current_ir_block.
+/** Constructor for a DivMod node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *memop The store needed to model exceptions
* @param *op2 The operand 2.
*
*/
-
ir_node *new_d_DivMod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Div node. Adds the node to the block in current_ir_block.
+/** Constructor for a Div node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *memop The store needed to model exceptions
* @param *op2 The operand 2.
*
*/
-
ir_node *new_d_Div (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Mod node. Adds the node to the block in current_ir_block.
+/** Constructor for a Mod node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *memop The store needed to model exceptions
* @param *op2 The operand 2.
*
*/
-
ir_node *new_d_Mod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Abs node. Adds the node to the block in current_ir_block.
+/** Constructor for a Abs node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_d_Abs (dbg_info* db, ir_node *op, ir_mode *mode);
-/**
- * Constructor for a And node. Adds the node to the block in current_ir_block.
+/** Constructor for a And node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *irg The ir graph the node belongs to.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_d_And (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Or node. Adds the node to the block in current_ir_block.
+/** Constructor for a Or node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op1 The operand 1.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_d_Or (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Eor node. Adds the node to the block in current_ir_block.
+/** Constructor for a Eor node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op1 The operand 1.
* @param *mode The mode of the operands and the results.
*
*/
-
ir_node *new_d_Eor (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Not node. Adds the node to the block in current_ir_block.
+/** Constructor for a Not node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_d_Not (dbg_info* db, ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Shl node. Adds the node to the block in current_ir_block.
+/** Constructor for a Shl node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_d_Shl (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Shr node. Adds the node to the block in current_ir_block.
+/** Constructor for a Shr node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_d_Shr (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Shrs node. Adds the node to the block in current_ir_block.
+/** Constructor for a Shrs node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_d_Shrs (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Rot node. Adds the node to the block in current_ir_block.
+/** Constructor for a Rot node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *mode The mode of the operand.
*
*/
-
ir_node *new_d_Rot (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Cmp node. Adds the node to the block in current_ir_block.
+/** Constructor for a Cmp node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op1 The operand 1.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_d_Cmp (dbg_info* db, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Conv node. Adds the node to the block in current_ir_block.
+/** Constructor for a Conv node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *mode The mode of this the operand muss be converted .
*
*/
-
ir_node *new_d_Conv (dbg_info* db, ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Cast node. Adds the node to the block in current_ir_block.
+/**Constructor for a Cast node.
+ *
+ * High level type cast
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *op The operand.
* @param *to_tp The type of this the operand muss be casted .
*
*/
-
ir_node *new_d_Cast (dbg_info* db, ir_node *op, type *to_tp);
-/**
- * Constructor for a Phi node. Adds the node to the block in current_ir_block.
+/**Constructor for a Phi node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debugginaromation.
* @param arity The number of predecessors
* @param *mode The mode of it's inputs and output.
*
*/
-
ir_node *new_d_Phi (dbg_info* db, int arity, ir_node *in[], ir_mode *mode);
-/**
- * Constructor for a Load node. Adds the node to the block in current_ir_block.
+/** Constructor for a Load node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *store The current memory
* @param *adr A pointer to the variable to be read in this memory.
*
*/
-
ir_node *new_d_Load (dbg_info* db, ir_node *store, ir_node *addr);
-/**
- * Constructor for a Store node. Adds the node to the block in current_ir_block.
+/** Constructor for a Store node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *store The current memory
* @param *adr A pointer to the variable to be read in this memory.
* @param *val The value to write to this variable.
*/
-
ir_node *new_d_Store (dbg_info* db, ir_node *store, ir_node *addr, ir_node *val);
-/**
- * Constructor for a Alloc node. Adds the node to the block in current_ir_block.
+/** Constructor for a Alloc node.
+ *
+ * The Alloc node extends the memory by space for an entity of type alloc_type.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *store The memory which shall contain the new variable.
* @param where Where to allocate the variable, either heap_alloc or stack_alloc.
*
*/
-
ir_node *new_d_Alloc (dbg_info* db, ir_node *store, ir_node *size, type *alloc_type,
where_alloc where);
-/**
- * Constructor for a Free node. Adds the node to the block in current_ir_block.
+ /** Constructor for a Free node.
+ *
+ * Frees the memory occupied by the entity pointed to by the pointer
+ * arg. Type indicates the type of the entity the argument points to.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *store The memory which shall contain the new variable.
* @param *free_type The type of the freed variable.
*
*/
-
ir_node *new_d_Free (dbg_info* db, ir_node *store, ir_node *ptr, ir_node *size,
type *free_type);
-/**
- * Constructor for a Sync node. Adds the node to the block in current_ir_block.
+/** Constructor for a Sync node.
+ *
+ * Merges several memory values. The node assumes that a variable
+ * either occurs only in one of the memories, or it contains the same
+ * value in all memories where it occurs.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param arity The number of memories to syncronize.
- * @param **in An array of pointers to nodes that produce an output of type memory.
+ * @param **in An array of pointers to nodes that produce an output of type
+ * memory. The constructor copies this array.
*
*/
-
ir_node *new_d_Sync (dbg_info* db, int arity, ir_node *in[]);
-/**
- * Constructor for a Proj node. Adds the node to the block in current_ir_block.
+/** Constructor for a Proj node.
+ *
+ * Projects a single value out of a tuple. The parameter proj gives the
+ * position of the value within the tuple.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for deubugginformation.
* @param arg A node producing a tuple.
* @param proj The position of the value in the tuple.
*
*/
-
ir_node *new_d_Proj (dbg_info* db, ir_node *arg, ir_mode *mode, long proj);
-/**
- * Constructor for a defaultProj node. Adds the node to the block in current_ir_block.
+/** Constructor for a defaultProj node.
+ *
+ * Represents the default control flow of a Switch-Cond node.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param arg A node producing a tuple.
* @param max_ proj The end position of the value in the tuple.
*
*/
-
ir_node *new_d_defaultProj (dbg_info* db, ir_node *arg, long max_proj);
-/**
- * Constructor for a Tuple node. Adds the node to the block in current_ir_block.
+/** Constructor for a Tuple node.
+ *
+ * This is an auxiliary node to replace a node that returns a tuple
+ * without changing the corresponding Proj nodes.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param arity The number of tuple elements.
* @param **in An array containing pointers to the nodes producing the tuple elements.
*
*/
-
ir_node *new_d_Tuple (dbg_info* db, int arity, ir_node *in[]);
-/**
- * Constructor for a Id node. Adds the node to the block in current_ir_block.
- * Performs the Id operation, i.e., does nothing.
+/** Constructor for a Id node.
+ *
+ * This is an auxiliary node to replace a node that returns a single
+ * value. Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *val The operand to Id.
* @param *mode The mode of *val.
*
*/
-
ir_node *new_d_Id (dbg_info* db, ir_node *val, ir_mode *mode);
-/**
- * Returns the unique Bad node. Same as get_irn_bad(..);
+/** Costructor for a Bad node.
+ *
+ * Returns the unique Bad node of the graph. The same as
+ * get_irg_bad().
+ *
*/
-
ir_node *new_d_Bad (void);
-/**
- * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
+/** Constructor for a Confirm node.
+ *
+ * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
* Specifies constraints for a value. To support dataflow analyses.
*
* Example: If the value never exceeds '100' this is expressed by placing a
* @param cmp The compare operation.
*
*/
-
ir_node *new_d_Confirm (dbg_info* db, ir_node *val, ir_node *bound, pn_Cmp cmp);
-/**
- * Constructor for a Unknown node. Represents an arbtrary valus. Places the node in
+/** Constructor for an Unknown node.
+ *
+ * Represents an arbtrary valus. Places the node in
* the start block.
*
* @param *m The mode of the unknown value.
*
*/
-
ir_node *new_d_Unknown(ir_mode *m);
-/**
- * Constructor for a CallBegin node. Adds the node to the block in current_ir_block.
+/** Constructor for a CallBegin node.
+ *
+ * CallBegin represents control flow depending of the pointer value
+ * representing the called method to the called methods. The
+ * constructor copies the method pointer input from the passed Call
+ * node.Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *callee The call node bisible in the intra procedural view.
*
*/
-
ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee);
-/**
- * Constructor for a EndReg node. Adds the node to the block in current_ir_block.
+/** Constructor for an EndReg node.
+ *
+ *Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
*
*/
-
ir_node *new_d_EndReg (dbg_info *db);
-/**
- * Constructor for a Endexcept node. Adds the node to the block in current_ir_block.
+/** Constructor for an Endexcept node.
+ *
+ * Used to represent regular procedure end in interprocedual view.
+ * Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
*
*/
-
ir_node *new_d_EndExcept(dbg_info *db);
-/**
- * Constructor for a Breake node. Adds the node to the block in current_ir_block.
+/** Constructor for a Break node.
+ *
+ * Used to represent exceptional procedure end in interprocedural view.
+ * Adds the node to the block in current_ir_block.
+ *
+ * Break represents control flow to a single control successor just as Jmp.
+ * The blocks separated by a break may not be concatenated by an optimization.
+ * It is used for the interprocedural representation where blocks are parted
+ * behind Call nodes to represent the control flow to called procedures.
*
* @param *db A pointer for debug information.
*
*/
-
-
ir_node *new_d_Break (dbg_info *db);
-/** Constructor for a Filter node.
+/** Constructor for a Filter node.
*
* Constructor for a Filter node. Adds the node to the block in
* current_ir_block. Filter is a node with two views used to
* @param proj The position in the tuple to project from.
*
*/
-
ir_node *new_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
-/**
- * Constructor for a FuncCall node. Adds the node to the block in current_ir_block.
+/** Constructor for a FuncCall node.
+ *
+ * FuncCall is a function Call that has no side effects. Therefore there
+ * is not memory operand or result. Adds the node to the block in current_ir_block.
*
* @param *db A pointer for debug information.
* @param *callee A pointer to the called procedure.
* @param arity The number of procedure parameters.
- * @param **in An array with the pointers to the parameters. The constructor copies this array.
+ * @param **in An array with the pointers to the parameters.
+ * The constructor copies this array.
* @param *tp Type information of the procedure called.
*
*/
-
-
ir_node *new_d_FuncCall (dbg_info* db, ir_node *callee, int arity, ir_node *in[],
type *tp);
/*-----------------------------------------------------------------------*/
/* Needed from the interfase with debug support:
-void switch_block (ir_node *target); */
-
-/* Constructs a Block with a fixed number of predecessors.
- Does set current_block. Can be used with automatic Phi
- node construction. */
+void set_cur_block (ir_node *target); */
/** Constructor for a Block node.
*
* Constructor for a Block node. Adds the block to the graph in
- * current_ir_graph .
+ * current_ir_graph. Constructs a Block with a fixed number of
+ * predecessors. Does set current_block. Can be used with automatic
+ * Phi node construction.
*
* @param arity The number of control predecessors.
* @param in An array of control predecessors. The length of
*/
ir_node *new_Block(int arity, ir_node *in[]);
-/**
+/** Constructor for a Start node.
*
- * Constructor for a Start node. Adds the node to the block in current_ir_block.
+ * Adds the node to the block in current_ir_block.
*
*/
-
ir_node *new_Start (void);
-/**
+/** Constructor for an End node.
*
- * Constructor for a End node. Adds the node to the block in current_ir_block.
+ * Adds the node to the block in current_ir_block.
*
*/
-
ir_node *new_End (void);
-/**
+/** Constructor for an EndReg node.
*
- * Constructor for a EndReg node. Adds the node to the block in current_ir_block.
+ * Used to represent regular procedure end in interprocedual view.
+ * Adds the node to the block in current_ir_block.
*
*/
-
ir_node *new_EndReg (void);
/** Constructor for an EndExpcept node.
*
- * Constructor for an EndExpcept node. Adds the node to the block in current_ir_block.
+ * Used to represent exceptional procedure end in interprocedural view.
+ * Adds the node to the block in current_ir_block.
*
*
*
*
* Constructor for a Jump node. Adds the node to the block in current_ir_block.
*
+ * Jmp represents control flow to a single control successor.
+ *
*/
-
ir_node *new_Jmp (void);
-/**
- *
- * Constructor for a Break node. Adds the node to the block in current_ir_block.
+/** Constructor for a Break node.
+ * Break represents control flow to a single control successor just as Jmp.
+ * The blocks separated by a break may not be concatenated by an optimization.
+ * It is used for the interprocedural representation where blocks are parted
+ * behind Call nodes to represent the control flow to called procedures.
+ *Adds the node to the block in current_ir_block.
*
*/
-
ir_node *new_Break (void);
-/**
- * Constructor for a Cond node. Adds the node to the block in current_ir_block.
+/** Constructor for a Cond node.
+ *
+ * If c is mode_b represents a conditional branch (if/else). If c is
+ * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond
+ * node, default Proj is 0.). Adds the node to the block in current_ir_block.
+ *
+ * This is not consistent: Input to Cond is Is, Proj has as proj number
+ * longs.
+ *
*
* @param *c The conditions parameter.Can be of mode b or I_u.
*
*/
-
ir_node *new_Cond (ir_node *c);
-/**
- * Constructor for a Return node. Adds the node to the block in current_ir_block.
+/** Constructor for a Return node.
+ *
+ * Returns the memory an zero or more return values. Only node that
+ * can end regular control flow. Adds the node to the block in current_ir_block.
*
* @param *store The state of memory.
* @param arity Number of array indexes.
* @param *in Array with index inputs to the node.
*
*/
-
ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
-/**
- * Constructor for a Raise node. Adds the node to the block in current_ir_block.
+/**Constructor for a Raise node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *store The current memory.
* @param *obj A pointer to the Except variable.
*
*/
-
ir_node *new_Raise (ir_node *store, ir_node *obj);
-/**
- * Constructor for a Const node. Adds the node to the block in current_ir_block.
+/** Constructor for a Const node.
+ *
+ * Constructor for a Const node. The constant represents a target
+ * value. Sets the type information to type_unknown. (No more
+ * supported: If tv is entity derives a somehow useful type.)
+ * Adds the node to the block in current_ir_block.
*
* @param *mode The mode of the operands and redults.
- * @param *con Points to an entry in the constant table. This pointer is added to the attributes of the node (self->attr.con).
+ * @param *con Points to an entry in the constant table. This pointer is
+ * added to the attributes of the node.
*
*/
-
ir_node *new_Const (ir_mode *mode, tarval *con);
-/**
- * Constructor for a SymConst node. Adds the node to the block in current_ir_block.
+/** Constructor for a SymConst node.
*
- * @param volue
- * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
+ * Adds the node to the block in current_ir_block.
+ * This is the constructor for a symbolic constant.
+ * There are four kinds of symbolic constants:
+ * - type_tag The symbolic constant represents a type tag. The type the
+ * tag stands for is given explicitly.
+ * - size The symbolic constant represents the size of a type. The
+ * type of which the constant represents the size is given
+ * explicitly.
+ * - addr_name The symbolic constant represents the address of an entity
+ * (variable or method). The variable is indicated by a name
+ * that is valid for linking.
+ * - addr_ent The symbolic constant represents the address of an entity
+ * (variable or method). The variable is given explicitly by
+ * a firm entity.
+ *
+ * Inputs to the node:
+ * No inputs except the block it belongs to.
+ * Outputs of the node.
+ * An unsigned integer (I_u) or a pointer (P).
+ *
+ * @param value A type or a ident depending on the SymConst kind.
+ * @param symkind The kind of the symbolic constant: symconst_type_tag, symconst_size or symconst_addr_name.
*
*/
+ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind);
-ir_node *new_SymConst (type_or_id_p value, symconst_kind kind);
-
-/**
- * Constructor for a simpelSel node.
+/** Constructor for a simpelSel node.
+ *
+ * This is a shortcut for the new_Sel() constructor. To be used for
+ * Sel nodes that do not select from an array, i.e., have no index
+ * inputs. It adds the two parameters 0, NULL.
*
* @param *store The memory in which the object the entity should be selected from is allocated.
* @param *objptr The object from that the Sel operation selects a single attribute out.
* @param *ent The entity to select.
*
*/
-
ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent);
-/**
- * Constructor for a Sel node.
+/** Constructor for a Sel node.
*
- * @param *store The memory in which the object the entity should be selected from is allocated.
- * @param *objptr The object from that the Sel operation selects a single attribute out.
- * @param *n_index The index of the selected object from the array.
- * @param *index Array with index inputs to the node.
- * @param *ent The entity to select.
+ * The select node selects an entity (field or method) from an entity
+ * with a compound type. It explicitly specifies the entity selected.
+ * Dynamically the node may select entities that overwrite the given
+ * entity. If the selected entity is an array element entity the Sel
+ * node takes the required array indicees as inputs.
+ * Adds the node to the block in current_ir_block.
*
+ * @param *store The memory in which the object the entity should be selected
+ * from is allocated.
+ * @param *objptr A pointer to a compound entity the Sel operation selects a
+ * single attribute from.
+ * @param *n_index The number of array indicees needed to select an array element entity.
+ * @param *index[] If the compound entity is an array the indicees of the selected
+ * element entity. The constructor copies this array.
+ * @param *ent The entity to select.
*/
-
ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
entity *ent);
-/**
- * Constructor for a InstOf node. Adds the node to the block in current_ir_block.
+/** Constructor for an InstOf node.
+ *
+ * Adds the node to the block in current_ir_block.
+ * For translating Java. Not supported as standard firm node.
*
* @param *store
* @param *objptr
* @param *ent
*
*/
-
ir_node *new_InstOf (ir_node *store, ir_node *obj, type *ent);
-/**
- * Constructor for a Call node. Adds the node to the block in current_ir_block.
+/** Constructor for a Call node.
+ *
+ * Adds the node to the block in current_ir_block.
+ * Represents all kinds of method and function calls.
*
* @param *store The actual store.
* @param *callee A pointer to the called procedure.
* @param *tp Type information of the procedure called.
*
*/
-
ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[],
type *tp);
-/**
- * Constructor for a CallBegin node. Adds the node to the block in current_ir_block.
+/** Constructor for a CallBegin node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *callee A pointer to the called procedure.
*
*/
-
ir_node *new_CallBegin(ir_node *callee);
-/**
- * Constructor for a Add node. Adds the node to the block in current_ir_block.
+/**Constructor for a Add node.
+ *
+ * CallBegin represents control flow depending of the pointer value
+ * representing the called method to the called methods. The
+ * constructor copies the method pointer input from the passed Call
+ * node.Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Sub node. Adds the node to the block in current_ir_block.
+/** Constructor for a Sub node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Minus node. Adds the node to the block in current_ir_block.
+/** Constructor for a Minus node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand .
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_Minus (ir_node *op, ir_mode *mode);
/**
- * Constructor for a Mul node. Adds the node to the block in current_ir_block.
+ * Constructor for a Mul node. Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Quot node. Adds the node to the block in current_ir_block.
+/** Constructor for a Quot node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *memop The store needed to model exceptions
* @param *op1 The operand 1.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a DivMod node. Adds the node to the block in current_ir_block.
+/** Constructor for a DivMod node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *memop The store needed to model exceptions
* @param *op1 The operand 1.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Div node. Adds the node to the block in current_ir_block.
+/** Constructor for a Div node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *memop The store needed to model exceptions
* @param *op1 The operand 1.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Mod node. Adds the node to the block in current_ir_block.
+/** Constructor for a Mod node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *memop The store needed to model exceptions
* @param *op1 The operand 1.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Abs node. Adds the node to the block in current_ir_block.
+/** Constructor for a Abs node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_Abs (ir_node *op, ir_mode *mode);
-/**
- * Constructor for a And node. Adds the node to the block in current_ir_block.
+/** Constructor for a And node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode);
/**
- * Constructor for a Or node. Adds the node to the block in current_ir_block.
+ * Constructor for a Or node. Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
* @param *mode The mode of the operands and the result.
*
*/
-
ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode);
/**
- * Constructor for a Eor node. Adds the node to the block in current_ir_block.
+ * Constructor for a Eor node. Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
* @param *mode The mode of the operands and the results.
*
*/
-
ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode);
-/**
- * Constructor for a Not node. Adds the node to the block in current_ir_block.
+/** Constructor for a Not node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand.
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_Not (ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Shl node. Adds the node to the block in current_ir_block.
+/** Constructor for a Shl node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand.
* @param *k The number of bits to shift the operand .
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode);
/**
- * Constructor for a Shr node. Adds the node to the block in current_ir_block.
+ * Constructor for a Shr node. Adds the node to the block in current_ir_block.
*
* @param *op The operand.
* @param *k The number of bits to shift the operand .
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Shrs node. Adds the node to the block in current_ir_block.
+/** Constructor for a Shrs node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand.
* @param *k The number of bits to shift the operand .
* @param *mode The mode of the operand and the result.
*
*/
-
ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Rot node. Adds the node to the block in current_ir_block.
+/** Constructor for a Rot node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand.
* @param *k The number of bits to rotate the operand.
* @param *mode The mode of the operand.
*
*/
-
ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode);
-/**
- * Constructor for a Cmp node. Adds the node to the block in current_ir_block.
+/** Constructor for a Cmp node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op1 The operand 1.
* @param *op2 The operand 2.
*
*/
-
ir_node *new_Cmp (ir_node *op1, ir_node *op2);
-/**
- * Constructor for a Conv node. Adds the node to the block in current_ir_block.
+/** Constructor for a Conv node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param *op The operand.
* @param *mode The mode of this the operand muss be converted .
*
*/
-
ir_node *new_Conv (ir_node *op, ir_mode *mode);
-/**
- * Constructor for a Cast node. Adds the node to the block in current_ir_block.
+/**Constructor for a Cast node.
+ *
+ * Adds the node to the block in current_ir_block.
+ * High level type cast
*
* @param *op The operand.
* @param *to_tp The type of this the operand muss be casted .
*
*/
-
ir_node *new_Cast (ir_node *op, type *to_tp);
-/**
- * Constructor for a Phi node. Adds the node to the block in current_ir_block.
+/** Constructor for a Phi node.
+ *
+ * Adds the node to the block in current_ir_block.
*
* @param arity The number of predecessors
* @param *in Array with predecessors
* @param *mode The mode of it's inputs and output.
*
*/
-
ir_node *new_Phi (int arity, ir_node *in[], ir_mode *mode);
-/**
- * Constructor for a Load node.
+/** Constructor for a Load node.
*
* @param *store The current memory
* @param *addr A pointer to the variable to be read in this memory.
*
*/
-
ir_node *new_Load (ir_node *store, ir_node *addr);
-/**
- * Constructor for a Store node.
+/** Constructor for a Store node.
*
* @param *store The current memory
* @param *addr A pointer to the variable to be read in this memory.
* @param *val The value to write to this variable.
*/
-
ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val);
-/**
- * Constructor for a Alloc node. Adds the node to the block in current_ir_block.
+/**Constructor for a Alloc node.
+ *
+ * The Alloc node extends the memory by space for an entity of type alloc_type.
+ * Adds the node to the block in current_ir_block.
*
* @param *store The memory which shall contain the new variable.
* @param *size The number of bytes to allocate.
* @param where Where to allocate the variable, either heap_alloc or stack_alloc.
*
*/
-
ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type,
where_alloc where);
-/**
- * Constructor for a Free node. Adds the node to the block in current_ir_block.
+/**Constructor for a Free node.
+ *
+ * Frees the memory occupied by the entity pointed to by the pointer
+ * arg. Type indicates the type of the entity the argument points to.
+ * Adds the node to the block in current_ir_block.
*
* @param *store The memory which shall contain the new variable.
* @param *ptr The pointer to the object to free.
* @param *free_type The type of the freed variable.
*
*/
-
ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size,
- type *free_type);
+ type *free_type);
-/**
- * Constructor for a Sync node. Adds the node to the block in current_ir_block.
+/** Constructor for a Sync node.
+ *
+ * Merges several memory values. The node assumes that a variable
+ * either occurs only in one of the memories, or it contains the same
+ * value in all memories where it occurs.
+ * Adds the node to the block in current_ir_block.
*
* @param arity The number of memories to syncronize.
- * @param **in An array of pointers to nodes that produce an output of type memory.
+ * @param **in An array of pointers to nodes that produce an output of type
+ * memory. The constructor copies this array.
*
*/
-
ir_node *new_Sync (int arity, ir_node *in[]);
-/**
- * Constructor for a Proj node. Adds the node to the block in current_ir_block.
+/** Constructor for a Proj node.
+ *
+ * Projects a single value out of a tuple. The parameter proj gives the
+ * position of the value within the tuple.
+ * Adds the node to the block in current_ir_block.
*
* @param arg A node producing a tuple.
* @param *mode The mode of the value to project.
* @param proj The position of the value in the tuple.
*
*/
-
ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj);
-/**
+/** Costructor for a Filter node.
+ *
+ * Constructor for a Filter node. Adds the node to the block in current_ir_block.
+ * Filter is a node with two views used to construct the interprocedural view.
+ * In intraprocedural view its semantics are identical to the Proj node.
+ * In interprocedural view the Filter performs the Phi operation on method
+ * parameters or results. Other than a Phi a Filter node may not be removed
+ * if it has only a single input.
*
- * Constructor for a Filter node. Adds the node to the block in current_ir_block.
+ * The constructor builds the Filter in intraprocedural view.
*
- * @param *arg
- * @param *mode
- * @param proj
+ * @param *arg The tuple value to project from.
+ * @param *mode The mode of the projected value.
+ * @param proj The position in the tuple to project from.
*
*/
-
ir_node *new_Filter (ir_node *arg, ir_mode *mode, long proj);
-/**
- * Constructor for a defaultProj node.Adds the node to the block in current_ir_block.
+/** Constructor for a defaultProj node.
+ *
+ * Represents the default control flow of a Switch-Cond node.
+ * Adds the node to the block in current_ir_block.
*
* @param arg A node producing a tuple.
* @param max_ proj The end position of the value in the tuple.
*
*/
-
ir_node *new_defaultProj (ir_node *arg, long max_proj);
-/**
- * Constructor for a Tuple node. Adds the node to the block in current_ir_block.
+/** Constructor for a Tuple node.
+ *
+ * This is an auxiliary node to replace a node that returns a tuple
+ * without changing the corresponding Proj nodes.
+ * Adds the node to the block in current_ir_block.
*
* @param arity The number of tuple elements.
* @param **in An array containing pointers to the nodes producing the tuple elements.
*
*/
-
ir_node *new_Tuple (int arity, ir_node *in[]);
-/**
- * Constructor for a Id node. Adds the node to the block in current_ir_block.
+/** Constructor for an Id node.
*
- * @param *val
+ * This is an auxiliary node to replace a node that returns a single
+ * value. Adds the node to the block in current_ir_block.
+ *
+ * @param *val The operand to Id.
* @param *mode The mode of *val.
*
*/
-
ir_node *new_Id (ir_node *val, ir_mode *mode);
-/**
+/** Constructor for a Bad node.
*
- * Constructor for a Bad node.
- * Adds the node to the block in current_ir_block.
+ * Returns the unique Bad node of the graph. The same as
+ * get_irg_bad().
*
*/
ir_node *new_Bad (void);
-/**
- * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
+/** Constructor for a Confirm node.
+ *
+ * Specifies constraints for a value. To support dataflow analyses.
+ * Adds the node to the block in current_ir_block.
*
- * @param *val
- * @param *bound
- * @param cmp
+ * Example: If the value never exceeds '100' this is expressed by placing a
+ * Confirm node val = new_d_Confirm(db, val, 100, '<') on the dataflow edge.
+ *
+ * @param *val The value we express a constraint for
+ * @param *bound The value to compare against. Must be a firm node, typically a constant.
+ * @param cmp The compare operation.
*
*/
-
ir_node *new_Confirm (ir_node *val, ir_node *bound, pn_Cmp cmp);
-/**
- * Constructor for a Unknown node. Adds the node to the block in current_ir_block.
+/** Constructor for an Unknown node.
*
- * @param *m
+ * Represents an arbitrary value. Places the node in
+ * the start block.
+ *
+ * @param *m The mode of the unknown value.
*
*/
-
ir_node *new_Unknown(ir_mode *m);
-/**
- * Constructor for a FuncCall node. Adds the node to the block in current_ir_block.
+/** Constructor for a FuncCall node.
+ *
+ * FuncCall is a function Call that has no side effects. Therefore there
+ * is not memory operand or result.Adds the node to the block in current_ir_block.
*
* @param *callee A pointer to the called procedure.
* @param arity The number of procedure parameters.
- * @param **in An array with the pointers to the parameters. The constructor copies this array.
+ * @param **in An array with the pointers to the parameters.
+ * The constructor copies this array.
* @param *tp Type information of the procedure called.
*
*/
-
ir_node *new_FuncCall (ir_node *callee, int arity, ir_node *in[],
- type *tp);
+ type *tp);
/*---------------------------------------------------------------------*/
/* The comfortable interface. */
/* needed also. */
/*---------------------------------------------------------------------*/
-/* --- Block construction --- */
-/* immature Block without predecessors */
+/** Create an immature block.
+ *
+ * An immature block has an unknown number of predecessors. Predecessors
+ * can be added with add_immBlock_pred(). Once all predecessors are
+ * added the block must be matured.
+ *
+ * Adds the block to the graph in current_ir_graph. Does set
+ * current_block. Can be used with automatic Phi node construction.
+ * This constructor can only be used if the graph is in
+ * state_building.
+ */
ir_node *new_d_immBlock (dbg_info* db);
ir_node *new_immBlock (void);
/** Add a control flow edge to an immature block. */
-void add_in_edge (ir_node *immblock, ir_node *jmp);
+void add_immBlock_pred (ir_node *immblock, ir_node *jmp);
+
+/** Fix the number of predecessors of an immature block. */
+void mature_immBlock (ir_node *block);
+#define mature_cur_block() mature_immBlock(get_cur_block());
-/** fixes the number of predecessors of a block. */
-void mature_block (ir_node *block);
-/* --- Parameter administration --- */
-/* Read a value from the array with the local variables. Use this
- function to obtain the last definition of the value associated with
- pos. Pos may not exceed the value passed as n_loc to new_ir_graph. */
+/** Get the current value of a local variable.
+ *
+ * Use this function to obtain the last definition of the local variable
+ * associated with pos. Pos may not exceed the value passed as n_loc
+ * to new_ir_graph. This call automatically inserts Phi nodes.
+ *
+ * @param *db A pointer for debug information.
+ * @param pos The position/id of the local variable.
+ * @param *mode The mode of the value to get.
+ */
ir_node *get_d_value (dbg_info* db, int pos, ir_mode *mode);
ir_node *get_value (int pos, ir_mode *mode);
-/** Write a value in the array with the local variables. Use this function
- to remember a new definition of the value associated with pos. Pos may
- not exceed the value passed as n_loc to new_ir_graph. */
+/** Remark a new definition of a variable.
+ *
+ * Use this function to remember a new definition of the value
+ * associated with pos. Pos may not exceed the value passed as n_loc
+ * to new_ir_graph. This call is needed to automatically inserts Phi
+ * nodes.
+ *
+ * @param pos The position/id of the local variable.
+ * @param *value The new value written to the local variable.
+*/
void set_value (int pos, ir_node *value);
-/** Read a store.
- Use this function to get the most recent version of the store (type M).
- Internally it does the same as get_value. */
+/** Get the current memory state.
+ *
+ * Use this function to obtain the last definition of the memory
+ * state. This call automatically inserts Phi nodes for the memory
+ * state value.
+ *
+ */
ir_node *get_store (void);
-/** Write a store. */
+/** Remark a new definition of the memory state.
+ *
+ * Use this function to remember a new definition of the memory state.
+ * This call is needed to automatically inserts Phi nodes.
+ *
+ * @param *store The new memory state.
+*/
void set_store (ir_node *store);
-/** keep this node alive even if End is not control-reachable from it */
+/** keep this node alive even if End is not control-reachable from it
+ *
+ * @param ka The node to keep alive.
+ */
void keep_alive (ir_node *ka);
-/* --- Useful access routines --- */
-/** Returns the current block of the current graph. To set the current
- block use switch_block(). */
-ir_node *get_cur_block(void);
-
/** Returns the frame type of the current graph */
type *get_cur_frame_type(void);
*/
typedef ir_node *default_initialize_local_variable_func_t(ir_mode *mode, int pos);
-/**
- * Initializes the graph construction.
- *
- * @param func @see default_initialize_local_variable_func_t
- */
-void init_cons (default_initialize_local_variable_func_t *func);
# endif /* _IRCONS_H_ */
projects / libfirm / blobdiff