X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Fircons.h;h=30c916cf201d7f0ffc7e896716ac56c25ac37a10;hb=eda9d668d0e8c8246015b4c5e743316a6a835a23;hp=78355bc92062857cbf137e28d39d667c61fa9c6a;hpb=d9663f1d01e157474633dd840b9db18c6356243b;p=libfirm diff --git a/ir/ir/ircons.h b/ir/ir/ircons.h index 78355bc92..30c916cf2 100644 --- a/ir/ir/ircons.h +++ b/ir/ir/ircons.h @@ -1,19 +1,33 @@ /* - * Project: libFIRM - * File name: ir/ir/ircons.h - * Purpose: Various irnode constructors. Automatic construction - * of SSA representation. - * Author: Martin Trapp, Christian Schaefer - * Modified by: Goetz Lindenmaier, Boris Boesler - * Created: - * CVS-ID: $Id$ - * Copyright: (c) 1998-2003 Universität Karlsruhe - * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. + * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved. + * + * This file is part of libFirm. + * + * This file may be distributed and/or modified under the terms of the + * GNU General Public License version 2 as published by the Free Software + * Foundation and appearing in the file LICENSE.GPL included in the + * packaging of this file. + * + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. + * + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. */ /** - @todo - Ideas for imrovement: + * @file + * @brief Various irnode constructors. Automatic construction of SSA + * representation. + * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Boris Boesler, + * Michael Beck + * @version $Id$ + */ + +/**@todo + Ideas for improvement: -# Handle construction of exceptions more comfortable: Add new constructors that pass the exception region (or better the Phi for the memories, the ex. region can be found from there) as parameter, @@ -24,14 +38,12 @@ */ /** - * @file ircons.h + * @file * * documentation no more supported since 2001 * * ir node construction. * - * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier - * * This file documents all datatypes and constructors needed to * build a FIRM representation of a procedure. The constructors are * also implemented in this file. @@ -40,77 +52,6 @@ * * For extensive documentation of FIRM see UKA Techreport 1999-14. * - * ========= - * - * The struct ir_graph - * ------------------- - * - * This struct contains all information about a procedure. - * It's allocated directly to memory. - * - * The fields of ir_graph: - * - * *ent The entity describing this procedure. - * - * The beginning and end of a graph: - * - * *start_block This ir_node is the block that contains the unique - * start node of the procedure. With it it contains - * the Proj's on starts results. - * Further all Const nodes are placed in the start block. - * *start This ir_node is the unique start node of the procedure. - * - * *end_block This ir_node is the block that contains the unique - * end node of the procedure. This block contains no - * further nodes. - * *end This ir_node is the unique end node of the procedure. - * - * The following nodes are Projs from the start node, held in ir_graph for - * simple access: - * - * *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 - * 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 - * frame. - * - * *globals This models a pointer to a space in the memory where - * _all_ global things are held. Select from this pointer - * with a Sel node the pointer to a global variable / - * procedure / compiler known function... . - * - * *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. - * - * *bad The bad node is an auxiliary node. It is needed only once, - * so there is this globally reachable node. - * - * Datastructures that are private to a graph: - * - * *obst An obstack that contains all nodes. - * - * *current_block A pointer to the current block. Any node created with - * one of the node constructors (new_) are assigned - * to this block. It can be set with switch_block(block). - * Only needed for ir construction. - * - * params/n_loc An int giving the number of local variables in this - * procedure. This is neede for ir construction. Name will - * be changed. - * - * *value_table This hash table (pset) is used for global value numbering - * for optimizing use in iropt.c. - * - * *Phi_in_stack; a stack needed for automatic Phi construction, needed only - * during ir construction. - * - * visited A int used as flag to traverse the ir_graph. - * - * block_visited A int used as a flag to traverse block nodes in the graph. * * Three kinds of nodes * -------------------- @@ -182,7 +123,7 @@ * *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. * @@ -222,15 +163,15 @@ * * This library supplies several interfaces to construct a FIRM graph for * a program: - * * A "comfortable" interface generating SSA automatically. Automatically + * - A "comfortable" interface generating SSA automatically. Automatically * computed predecessors of nodes need not be specified in the constructors. * (new_ constructurs and a set of additional routines.) - * * A less comfortable interface where all predecessors except the block + * - 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_ constructors and switch_block()). This interface + * by hand. (new_ 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 + * - An even less comfortable interface where the block needs to be specified * explicitly. This is called the "raw" interface. (new_r_ * constructors). These nodes are not optimized. * @@ -257,16 +198,16 @@ * * 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.) * @@ -298,9 +239,9 @@ * 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); @@ -314,22 +255,21 @@ * constructors and at the paragraph COPING WITH DATA OBJECTS at the * end of this documentation. * - * The comfortable interface contains the following routines further explained + * The comfortable interface contains the following routines further explained * below: * * ir_node *new_immBlock (void); * ir_node *new_Start (void); * ir_node *new_End (void); * ir_node *new_Jmp (void); + * ir_node *new_IJmp (ir_node *tgt); * ir_node *new_Cond (ir_node *c); * 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 (symconst_symbol value, symconst_kind kind); - * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, entity *ent); + * ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent); * ir_node *new_Sel (ir_node *store, ir_node *objptr, int arity, - * ir_node **in, entity *ent); - * ir_node *new_InstOf (ir_node *store, ir_node obj, type *ent); + * ir_node **in, ir_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); @@ -351,53 +291,28 @@ * 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_Cast (ir_node *op, ir_type *to_tp); + * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode); + * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode); + * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode); * 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, + * ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type, * where_alloc where); * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, - * type *free_type); + * ir_type *free_type, where_alloc where); * 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); + * ir_node *new_NoMem (void); + * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode); + * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode); + * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type); + * ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent); + * ir_node *new_Raise (ir_node *store, ir_node *obj); + * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper); + * ir_node *new_Pin (ir_node *node); + * + * 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); @@ -433,14 +348,14 @@ * 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 + * 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 @@ -451,7 +366,7 @@ * * 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 (); @@ -460,18 +375,18 @@ * 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. * @@ -503,7 +418,7 @@ * later) optimizations are skipped. This is necessary to * construct Blocks in loops. Leaving Unknown in the Block after finishing * the construction may have strange effects, especially for interprocedural - * representation and analyses. + * representation and analysis. * * * CONTROL FLOW OPERATIONS @@ -523,16 +438,12 @@ * 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) @@ -556,6 +467,17 @@ * Output: * Control flow to the next block. * + * ir_node *new_IJmp (ir_node *tgt) + * ----------------------- + * + * Creates an IJmp node. + * + * Inputs: + * The node that represents the target jump address + * Output: + * Control flow to an unknown target, must be pinned by + * the End node. + * * ir_node *new_Cond (ir_node *c) * ------------------------------ * @@ -588,22 +510,6 @@ * Output * Control flow to the end block. * - * ir_node *new_Raise (ir_node *store, ir_node *obj) - * ------------------------------------------------- - * - * Raises an exception. Unconditional change of control flow. Writes - * an explicit Except variable to memory to pass it to the exception - * handler. See TechReport 1999-14, chapter Exceptions. - * - * Inputs: - * The memory state. - * A pointer to the Except variable. - * Output: - * A tuple of control flow and the changed memory state. The control flow - * points to the exception handler if it is definied in this procedure, - * else it points to the end_block. - * - * * --------- * * ir_node *new_Const (ir_mode *mode, tarval *con) @@ -625,19 +531,22 @@ * attr.con A tarval* pointer to the proper entry in the constant * table. * - * ir_node *new_SymConst (type *tp, symconst_addr_ent kind) - * ------------------------------------------------------------ + * ir_node *new_SymConst (union symconst_symbol value, symconst_addr_ent kind) + * --------------------------------------------------------------------------- * * There are three kinds of symbolic constants: - * 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. + * symconst_type_tag The symbolic constant represents a type tag. + * symconst_type_size The symbolic constant represents the size of a type. + * symconst_type_align The symbolic constant represents the alignment of a type. + * symconst_addr_name Information for the linker, e.g. the name of a global + * variable. + * symconst_addr_name The symbolic constant represents the address of an entity. + * * To represent a pointer to an entity that is represented by an entity * datastructure don't use - * new_SymConst((type_or_id*)get_entity_ld_ident(ent), linkage_ptr_info);. + * new_SymConst((type_or_id*)get_entity_ld_ident(ent), symconst_addr_name);. * Use a real const instead: - * new_Const(mode_P_mach, tarval_p_from_entity(ent)); + * new_SymConst(ent, symconst_addr_ent); * This makes the Constant independent of name changes of the entity due to * mangling. * @@ -655,9 +564,13 @@ * Attributes: * 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 + * -symconst_type_size + * -symconst_type_align + * -symconst_addr_name + * + * If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align, + * 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 @@ -665,8 +578,8 @@ * * --------------- * - * ir_node *new_simpleSel (ir_node *store, ir_node *frame, entity *sel) - * -------------------------------------------------------------------- + * ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel) + * ----------------------------------------------------------------------- * * * Selects an entity from a compound type. This entity can be a field or @@ -690,18 +603,18 @@ * * ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in, * -------------------------------------------------------------------------- - * entity *sel) - * ------------ + * ir_entity *sel) + * --------------- * * Selects a field from an array type. The entity has as owner the array, as - * type the arrays element type. The indexes to access an array element are + * type the arrays element type. The indices to access an array element are * given also. * * Parameters: * *store The memory in which the object the entity should be selected from * is allocated. * *frame The pointer to the object. - * *arity number of array indexes. + * *arity number of array indices. * *in array with index inputs to the node. * *sel The entity to select. * @@ -744,26 +657,6 @@ * Attributes: * attr.call Contains the type information for the procedure. * - * ir_node *new_FuncCall (ir_node *callee, int arity, ir_node **in, type_method *type) - * ----------------------------------------------------------------------------------- - * - * Creates a procedure call to a function WITHOUT memory side effects. - * nodes of this kind are floating in contrast to Call nodes. - * Further, a procedure call with FuncCall cannot raise an exception! - * - * Parameters - * *callee A pointer to the called procedure. - * arity The number of procedure parameters. - * **in An array with the pointers to the parameters. - * The constructor copies this array. - * *type Type information of the procedure called. - * - * Inputs: - * The callee and the parameters. - * Output: - * A tuple containing the procedure results. - * Attributes: - * attr.call Contains the type information for the procedure. * * ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode) * ------------------------------------------------------------ @@ -778,7 +671,7 @@ * ir_node *new_Minus (ir_node *op, ir_mode *mode) * ----------------------------------------------- * - * Unary Minus operations on floating point values. + * Unary Minus operations on integer and floating point values. * * ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode) * ------------------------------------------------------------ @@ -865,6 +758,18 @@ * * Rotates the operand to the (right??) by k bits. * + * ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode) + * ------------------------------------------------------------ + * + * Calculates the Carry value for integer addition. Used only + * in lowering code. + * + * ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode) + * ------------------------------------------------------------ + * + * Calculates the Borrow value for integer substraction. Used only + * in lowering code. + * * ir_node *new_Conv (ir_node *op, ir_mode *mode) * --------------------------------------------- * @@ -879,23 +784,23 @@ * Output: * A 16-tuple containing the results of the 16 different comparisons. * The following is a list giving the comparisons and a projection - * number (pnc_number) to use in Proj nodes to extract the proper result. - * False false - * Eq equal - * Lt less - * Le less or equal - * Gt greater - * Ge greater of equal - * Lg less or greater - * Leg less, equal or greater = ordered - * Uo unordered - * Ue unordered or equal - * Ul unordered or less - * Ule unordered, less or equal - * Ug unordered or greater - * Uge unordered, greater or equal - * Ne unordered, less or greater = not equal - * True true + * number (pn_Cmp) to use in Proj nodes to extract the proper result. + * pn_Cmp_False false + * pn_Cmp_Eq equal + * pn_Cmp_Lt less + * pn_Cmp_Le less or equal + * pn_Cmp_Gt greater + * pn_Cmp_Ge greater of equal + * pn_Cmp_Lg less or greater + * pn_Cmp_Leg less, equal or greater = ordered + * pn_Cmp_Uo unordered + * pn_Cmp_Ue unordered or equal + * pn_Cmp_Ul unordered or less + * pn_Cmp_Ule unordered, less or equal + * pn_Cmp_Ug unordered or greater + * pn_Cmp_Uge unordered, greater or equal + * pn_Cmp_Ne unordered, less or greater = not equal + * pn_Cmp_True true * * * @@ -915,7 +820,7 @@ * later) optimizations are skipped. This is necessary to * construct Phi nodes in loops. Leaving Unknown in the Phi after finishing * the construction may have strange effects, especially for interprocedural - * representation and analyses. + * representation and analysis. * * Parameter * arity number of predecessors @@ -928,11 +833,25 @@ * Output * The definition valid in this block. * + * ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode) + * ----------------------------------------------------------------------------- + * + * Creates a Mux node. This node implements the following semantic: + * If the sel node (which must be of mode_b) evaluates to true, its value is + * ir_true, else ir_false; + * + * + * ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode) + * ----------------------------------------------------------------------------- + * + * Creates a Psi node. This node implements the following semantic: + * Enter it here!!! + * * * OPERATIONS TO MANAGE MEMORY EXPLICITLY * -------------------------------------- * - * ir_node *new_Load (ir_node *store, ir_node *addr) + * ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode) * ---------------------------------------------------------------- * * The Load operation reads a value from memory. @@ -940,6 +859,7 @@ * Parameters: * *store The current memory. * *addr A pointer to the variable to be read in this memory. + * *mode The mode of the value to be loaded. * * Inputs: * The memory and a pointer to a variable in this memory. @@ -959,8 +879,8 @@ * A tuple of the changed memory and a control flow to be taken in * case of an exception. * - * ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type, - * -------------------------------------------------------------------- + * ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type, + * ----------------------------------------------------------------------- * where_alloc where) * ------------------ * @@ -986,8 +906,10 @@ * a.*type A pointer to the class the allocated data object * belongs to. * - * ir_node *new_Free (ir_node *store, ir_node *ptr, type *free_type) - * ------------------------------------------------------------------ + * ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type, + * ----------------------------------------------------------------------------------- + * where_alloc where) + * ------------------ * * The Free node frees memory of the given variable. * @@ -996,6 +918,7 @@ * *ptr The pointer to the object to free. * *size The number of objects of type free_type to free in a sequence. * *free_type The type of the freed variable. + * where Where the variable was allocated, either heap_alloc or stack_alloc. * * Inputs: * A memory, a pointer and an unsigned integer. @@ -1016,7 +939,7 @@ * unifying the memories with a preceding Sync operation. * * Parameters - * arity The number of memories to syncronize. + * arity The number of memories to synchronize. * **in An array of pointers to nodes that produce an output of * type memory. * Inputs @@ -1034,10 +957,17 @@ * Returns the unique Bad node current_ir_graph->bad. * This node is used to express results of dead code elimination. * + * ir_node *new_NoMem (void) + * ----------------------------------------------------------------------------------- + * + * Returns the unique NoMem node current_ir_graph->no_mem. + * This node is used as input for operations that need a Memory, but do not + * change it like Div by const != 0, analyzed calls etc. + * * ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj) * ---------------------------------------------------------- * - * Selects one entry of a tuple. This is a hidden `fat edge'. + * Selects one entry of a tuple. This is a hidden edge with attributes. * * Parameters * *arg A node producing a tuple. @@ -1056,7 +986,7 @@ * 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 @@ -1071,6 +1001,56 @@ * for optimizations. * * + * HIGH LEVEL OPERATIONS + * --------------------- + * + * ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type) + * ----------------------------------------------------------------------------------- + * + * Describes a high level block copy of a compound type from address src to + * address dst. Must be lowered to a Call to a runtime memory copy function. + * + * + * HIGH LEVEL OPERATIONS: Exception Support + * ---------------------------------------- + * See TechReport 1999-14, chapter Exceptions. + * + * ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type); + * ----------------------------------------------------------------------------------- + * + * Describes a high level type check. Must be lowered to a Call to a runtime check + * function. + * + * ir_node *new_Raise (ir_node *store, ir_node *obj) + * ------------------------------------------------- + * + * Raises an exception. Unconditional change of control flow. Writes + * an explicit Except variable to memory to pass it to the exception + * handler. Must be lowered to a Call to a runtime check + * function. + * + * Inputs: + * The memory state. + * A pointer to the Except variable. + * Output: + * A tuple of control flow and the changed memory state. The control flow + * points to the exception handler if it is definied in this procedure, + * else it points to the end_block. + * + * ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper); + * ----------------------------------------------------------------------------------- + * + * Describes a high level bounds check. Must be lowered to a Call to a runtime check + * function. + * + * ir_node *new_Pin (ir_node *node); + * ----------------------------------------------------------------------------------- + * + * Pin the value of the node node in the current block No users of the Pin node can + * float above the Block of the Pin. The node cannot float behind this block. Often + * used to Pin the NoMem node. + * + * * COPING WITH DATA OBJECTS * ======================== * @@ -1084,7 +1064,7 @@ * * All values known in a Block are listed in the block's attribute, * block.**graph_arr which is used to automatically insert Phi nodes. - * The following two funcions can be used to add a newly computed value + * The following two functions can be used to add a newly computed value * to the array, or to get the producer of a value, i.e., the current * live value. * @@ -1112,15 +1092,15 @@ * * There are two special routines for the global store: * - * inline void set_store (ir_node *store) - * -------------------------------------- + * void set_store (ir_node *store) + * ------------------------------- * * Adds the store to the array of known values at a reserved * position. * Requires current_block to be set correctly. * - * inline ir_node *get_store (void) - * -------------------------------- + * ir_node *get_store (void) + * ------------------------- * * Returns the node defining the actual store. * Requires current_block to be set correctly. @@ -1134,19 +1114,13 @@ * node. * */ +#ifndef FIRM_IR_IRCONS_H +#define FIRM_IR_IRCONS_H - -# ifndef _IRCONS_H_ -# define _IRCONS_H_ - -# include "firm_common.h" -# include "irgraph.h" -# include "irnode.h" -# include "irmode.h" -# include "entity.h" -# include "tv.h" -# include "type.h" -# include "dbginfo.h" +#include "firm_common.h" +#include "irnode.h" +#include "irgraph.h" +#include "dbginfo.h" /*-------------------------------------------------------------------------*/ /* The raw interface */ @@ -1194,6 +1168,18 @@ ir_node *new_rd_End (dbg_info *db, ir_graph *irg, ir_node *block); */ ir_node *new_rd_Jmp (dbg_info *db, ir_graph *irg, ir_node *block); +/** Constructor for an IJmp node. + * + * IJmp represents control flow to a single control successor not + * statically known i.e. an indirect Jmp. + * + * @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 *tgt The ir node representing the target address. + */ +ir_node *new_rd_IJmp (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *tgt); + /** Constructor for a Break node. * * Break represents control flow to a single control successor just as Jmp. @@ -1238,17 +1224,6 @@ ir_node *new_rd_Cond (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c) ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store, int arity, ir_node *in[]); -/** Constructor for a Raise 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 *store The current memory. - * @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); - /** Constructor for a Const_type node. * * The constant represents a target value. This constructor sets high @@ -1257,12 +1232,12 @@ ir_node *new_rd_Raise (dbg_info *db, ir_graph *irg, ir_node *block, * @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 *mode The mode of the operands and redults. + * @param *mode The mode of the operands and results. * @param *con Points to an entry in the constant table. * @param *tp The type of the constant. */ -ir_node *new_rd_Const_type (dbg_info* db, ir_graph *irg, ir_node *block, - ir_mode *mode, tarval *con, type *tp); +ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg, ir_node *block, + ir_mode *mode, tarval *con, ir_type *tp); /** Constructor for a Const node. * @@ -1273,33 +1248,39 @@ ir_node *new_rd_Const_type (dbg_info* db, ir_graph *irg, ir_node *block, * @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 *mode The mode of the operands and redults. + * @param *mode The mode of the operands and results. * @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); + ir_mode *mode, tarval *con); /** 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 - * 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. + * - type_tag The symbolic constant represents a type tag. The type the + * tag stands for is given explicitly. + * - type_size The symbolic constant represents the size of a type. The + * type of which the constant represents the size is given + * explicitly. + * - type_align The symbolic constant represents the alignment 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. + * (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). * + * 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. @@ -1307,15 +1288,74 @@ ir_node *new_rd_Const (dbg_info *db, ir_graph *irg, ir_node *block, * @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, symconst_symbol value, - symconst_kind symkind, type *tp); +ir_node *new_rd_SymConst_type (dbg_info *db, ir_graph *irg, ir_node *block, union symconst_symbol value, + symconst_kind symkind, ir_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, - symconst_symbol 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, ir_entity *symbol, ir_type *tp); + +/** Constructor for a SymConst ofs_ent node. + * + * Same as new_rd_SymConst_type, except that the constructor is tailored for + * symconst_ofs_ent. + * Adds the SymConst to the start block of irg. */ +ir_node *new_rd_SymConst_ofs_ent (dbg_info *db, ir_graph *irg, ir_entity *symbol, ir_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, ir_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, ir_type *symbol, ir_type *tp); + +/** Constructor for a SymConst size node. + * + * Same as new_rd_SymConst_type, except that the constructor is tailored for + * symconst_type_size. + * Adds the SymConst to the start block of irg. */ +ir_node *new_rd_SymConst_size (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp); + +/** Constructor for a SymConst size node. + * + * Same as new_rd_SymConst_type, except that the constructor is tailored for + * symconst_type_align. + * Adds the SymConst to the start block of irg. */ +ir_node *new_rd_SymConst_align (dbg_info *db, ir_graph *irg, ir_type *symbol, ir_type *tp); + +/** Constructor for a simpleSel node. + * + * This is a shortcut for the new_rd_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 *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 *ent The entity to select. + */ +ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *store, ir_node *objptr, ir_entity *ent); /** Constructor for a Sel node. * @@ -1323,7 +1363,7 @@ ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block, * 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. + * node takes the required array indices as inputs. * * @param *db A pointer for debug information. * @param *irg The ir graph the node belongs to. @@ -1332,26 +1372,13 @@ ir_node *new_rd_SymConst (dbg_info *db, ir_graph *irg, ir_node *block, * 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 + * @param *n_index The number of array indices needed to select an array element entity. + * @param *index[] If the compound entity is an array the indices 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); - -/** 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 *block The ir block the node belongs to. - * @param *store - * @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 *objptr, int n_index, ir_node *index[], ir_entity *ent); /** Constructor for a Call node. * @@ -1367,49 +1394,31 @@ ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st * @param *tp Type information of the procedure called. */ 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 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); + ir_node *callee, int arity, ir_node *in[], ir_type *tp); /** Constructor for a Add 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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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. * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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. * @@ -1420,15 +1429,15 @@ ir_node *new_rd_Sub (dbg_info *db, ir_graph *irg, ir_node *block, * @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. * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. */ ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block, @@ -1440,8 +1449,8 @@ ir_node *new_rd_Mul (dbg_info *db, ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -1452,8 +1461,8 @@ ir_node *new_rd_Quot (dbg_info *db, ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -1464,8 +1473,8 @@ ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -1476,8 +1485,8 @@ ir_node *new_rd_Div (dbg_info *db, ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_rd_Mod (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -1498,8 +1507,8 @@ ir_node *new_rd_Abs (dbg_info *db, ir_graph *irg, ir_node *block, * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. */ ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block, @@ -1510,8 +1519,8 @@ ir_node *new_rd_And (dbg_info *db, ir_graph *irg, ir_node *block, * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. */ ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block, @@ -1522,8 +1531,8 @@ ir_node *new_rd_Or (dbg_info *db, ir_graph *irg, ir_node *block, * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the results. */ ir_node *new_rd_Eor (dbg_info *db, ir_graph *irg, ir_node *block, @@ -1545,8 +1554,8 @@ ir_node *new_rd_Not (dbg_info *db, ir_graph *irg, ir_node *block, * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_rd_Cmp (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *op1, ir_node *op2); @@ -1621,8 +1630,32 @@ ir_node *new_rd_Conv (dbg_info *db, ir_graph *irg, ir_node *block, * @param *op The operand. * @param *to_tp The type of this the operand muss be casted . */ -ir_node *new_rd_Cast (dbg_info* db, ir_graph *irg, ir_node *block, - ir_node *op, type *to_tp); +ir_node *new_rd_Cast (dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *op, ir_type *to_tp); + +/** Constructor for a Carry 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 first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. + */ +ir_node *new_rd_Carry (dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *op1, ir_node *op2, ir_mode *mode); + +/** Constructor for a Borrow 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 first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. + */ +ir_node *new_rd_Borrow (dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *op1, ir_node *op2, ir_mode *mode); /** Constructor for a Phi node. * @@ -1643,9 +1676,10 @@ ir_node *new_rd_Phi (dbg_info *db, ir_graph *irg, ir_node *block, int arity, * @param *block The ir block the node belongs to. * @param *store The current memory * @param *adr A pointer to the variable to be read in this memory. + * @param *mode The mode of the value to be loaded. */ ir_node *new_rd_Load (dbg_info *db, ir_graph *irg, ir_node *block, - ir_node *store, ir_node *adr); + ir_node *store, ir_node *adr, ir_mode *mode); /** Constructor for a Store node. * @@ -1672,7 +1706,7 @@ ir_node *new_rd_Store (dbg_info *db, ir_graph *irg, ir_node *block, * @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); + ir_node *size, ir_type *alloc_type, where_alloc where); /** Constructor for a Free node. * @@ -1686,9 +1720,10 @@ ir_node *new_rd_Alloc (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st * @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. + * @param where Where the variable was allocated, either heap_alloc or stack_alloc. */ 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); + ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where); /** Constructor for a Sync node. * @@ -1699,7 +1734,7 @@ ir_node *new_rd_Free (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *st * @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 memories to syncronize. + * @param arity The number of memories to synchronize. * @param *in[] An array of pointers to nodes that produce an output of type * memory. The constructor copies this array. */ @@ -1710,7 +1745,7 @@ ir_node *new_rd_Sync (dbg_info *db, ir_graph *irg, ir_node *block, int arity, * 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 *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 arg A node producing a tuple. The node must have mode_T. @@ -1842,6 +1877,7 @@ ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block); * * 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 The tuple value to project from. @@ -1851,6 +1887,105 @@ ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block); 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 NoMem node. + * + * Returns the unique NoMem node of the graph. The same as + * get_irg_no_mem(). + * + * @param *irg The ir graph the node belongs to. + */ +ir_node *new_rd_NoMem (ir_graph *irg); + +/** Constructor for a Mux 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 *sel The ir_node that calculates the boolean select. + * @param *ir_true The ir_node that calculates the true result. + * @param *ir_false The ir_node that calculates the false result. + * @param *mode The mode of the node (and it_true and ir_false). + */ +ir_node *new_rd_Mux (dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode); + +/** Constructor for a Psi 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 *arity The arity of the conditions + * @param *conds The array of mode_b conditions, length must be equal arity + * @param *vals The array of mode values, length must be equal arity + 1 + * @param *mode The mode of the node (must be the mode of all vals). + */ +ir_node *new_rd_Psi (dbg_info *db, ir_graph *irg, ir_node *block, + int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode); + +/** Constructor for a CopyB 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 *store The current memory + * @param *dst The ir_node that represents the destination address. + * @param *src The ir_node that represents the source address. + * @param *data_type The type of the copied data + */ +ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type); + +/** Constructor for a InstOf node. + * + * A High-Level Type check. + * + * @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 *store The memory in which the object the entity should be selected + * from is allocated. + * @param *objptr A pointer to a object of a class type. + * @param *type The type of which objptr must be. + */ +ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store, + ir_node *objptr, ir_type *type); + +/** Constructor for a Raise node. + * + * A High-Level Exception throw. + * + * @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 *store The current memory. + * @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); + +/** Constructor for a Bound node. + * + * A High-Level bounds check. Checks whether lower <= idx && idx < upper. + * + * @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 *store The current memory. + * @param *idx The ir_node that represents an index. + * @param *lower The ir_node that represents the lower bound for the index. + * @param *upper The ir_node that represents the upper bound for the index. + */ +ir_node *new_rd_Bound(dbg_info *db, ir_graph *irg, ir_node *block, + ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper); + +/** Constructor for a Pin 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 *node The node which value should be pinned. + */ +ir_node *new_rd_Pin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *node); /*-------------------------------------------------------------------------*/ /* The raw interface without debug support */ @@ -1895,11 +2030,22 @@ ir_node *new_r_End (ir_graph *irg, ir_node *block); */ ir_node *new_r_Jmp (ir_graph *irg, ir_node *block); -/** Constructor for a Cond node. +/** Constructor for an IJmp 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.) + * IJmp represents control flow to a single control successor not + * statically known i.e. an indirect Jmp. + * + * @param *irg The ir graph the node belongs to. + * @param *block The ir block the node belongs to. + * @param *tgt The ir node representing the target address. + */ +ir_node *new_r_IJmp (ir_graph *irg, ir_node *block, ir_node *tgt); + +/** 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. @@ -1918,21 +2064,25 @@ ir_node *new_r_Cond (ir_graph *irg, ir_node *block, ir_node *c); * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *store The state of memory. - * @param arity Number of array indexes. + * @param arity Number of array indices. * @param *in[] Array with index inputs to the node. The constructor copies this array. */ 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 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 *store The current memory. - * @param *obj A pointer to the Except variable. + * @param *mode The mode of the operands and the results. + * @param *con Points to an entry in the constant table. */ -ir_node *new_r_Raise (ir_graph *irg, ir_node *block, - ir_node *store, ir_node *obj); +ir_node *new_r_Const (ir_graph *irg, ir_node *block, + ir_mode *mode, tarval *con); /** Constructor for a Const node. * @@ -1943,10 +2093,24 @@ ir_node *new_r_Raise (ir_graph *irg, ir_node *block, * @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 value A value from which the tarval is made. + */ +ir_node *new_r_Const_long(ir_graph *irg, ir_node *block, + ir_mode *mode, long value); + +/** Constructor for a Const_type node. + * + * The constant represents a target value. This constructor sets high + * level type information for the constant value. + * + * @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 results. * @param *con Points to an entry in the constant table. + * @param *tp The type of the constant. */ -ir_node *new_r_Const (ir_graph *irg, ir_node *block, - ir_mode *mode, tarval *con); +ir_node *new_r_Const_type(ir_graph *irg, ir_node *block, + ir_mode *mode, tarval *con, ir_type *tp); /** Constructor for a SymConst node. * @@ -1971,11 +2135,28 @@ ir_node *new_r_Const (ir_graph *irg, ir_node *block, * * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. - * @param volue A type, entity or a ident depending on the SymConst kind. + * @param value 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, - symconst_symbol value, symconst_kind symkind); + union symconst_symbol value, symconst_kind symkind); + +/** 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 *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 *ent The entity to select. + */ +ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store, + ir_node *objptr, ir_entity *ent); /** Constructor for a Sel node. * @@ -1983,7 +2164,7 @@ ir_node *new_r_SymConst (ir_graph *irg, ir_node *block, * 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. + * node takes the required array indices as inputs. * * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. @@ -1991,27 +2172,14 @@ ir_node *new_r_SymConst (ir_graph *irg, ir_node *block, * 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 + * @param *n_index The number of array indices needed to select an array element entity. + * @param *index[] If the compound entity is an array the indices 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. - * - * 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 *x - * @param *y - * @param *z - * - */ -ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *x, ir_node *y, type *z); + ir_entity *ent); /** Constructor for a Call node. * @@ -2019,25 +2187,23 @@ ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *x, ir_node *y, ty * * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. - * @param * store The actual store. + * @param *store The actual store. * @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_r_Call (ir_graph *irg, ir_node *block, ir_node *store, ir_node *callee, int arity, ir_node *in[], - type *tp); + ir_type *tp); /** Constructor for a Add node. * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); @@ -2047,10 +2213,9 @@ ir_node *new_r_Add (ir_graph *irg, ir_node *block, * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); @@ -2061,7 +2226,6 @@ ir_node *new_r_Sub (ir_graph *irg, ir_node *block, * @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_r_Minus (ir_graph *irg, ir_node *block, ir_node *op, ir_mode *mode); @@ -2069,10 +2233,9 @@ ir_node *new_r_Minus (ir_graph *irg, ir_node *block, * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); @@ -2082,9 +2245,8 @@ ir_node *new_r_Mul (ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_r_Quot (ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -2094,9 +2256,8 @@ ir_node *new_r_Quot (ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_r_DivMod (ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -2106,9 +2267,8 @@ ir_node *new_r_DivMod (ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_r_Div (ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -2118,9 +2278,8 @@ ir_node *new_r_Div (ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_r_Mod (ir_graph *irg, ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2); @@ -2131,7 +2290,6 @@ ir_node *new_r_Mod (ir_graph *irg, ir_node *block, * @param *block The ir block the node belongs to. * @param *op The operand * @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); @@ -2140,10 +2298,9 @@ ir_node *new_r_Abs (ir_graph *irg, ir_node *block, * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); @@ -2152,10 +2309,9 @@ ir_node *new_r_And (ir_graph *irg, ir_node *block, * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); @@ -2164,10 +2320,9 @@ ir_node *new_r_Or (ir_graph *irg, ir_node *block, * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); @@ -2178,7 +2333,6 @@ ir_node *new_r_Eor (ir_graph *irg, ir_node *block, * @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_r_Not (ir_graph *irg, ir_node *block, ir_node *op, ir_mode *mode); @@ -2187,9 +2341,8 @@ ir_node *new_r_Not (ir_graph *irg, ir_node *block, * * @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. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_r_Cmp (ir_graph *irg, ir_node *block, ir_node *op1, ir_node *op2); @@ -2201,7 +2354,6 @@ ir_node *new_r_Cmp (ir_graph *irg, ir_node *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_r_Shl (ir_graph *irg, ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); @@ -2213,7 +2365,6 @@ ir_node *new_r_Shl (ir_graph *irg, ir_node *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_r_Shr (ir_graph *irg, ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); @@ -2226,7 +2377,6 @@ ir_node *new_r_Shr (ir_graph *irg, ir_node *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_r_Shrs (ir_graph *irg, ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); @@ -2238,7 +2388,6 @@ ir_node *new_r_Shrs (ir_graph *irg, ir_node *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_r_Rot (ir_graph *irg, ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); @@ -2249,7 +2398,6 @@ ir_node *new_r_Rot (ir_graph *irg, ir_node *block, * @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_r_Conv (ir_graph *irg, ir_node *block, ir_node *op, ir_mode *mode); @@ -2262,10 +2410,32 @@ ir_node *new_r_Conv (ir_graph *irg, ir_node *block, * @param *block The ir block the node belongs to. * @param *op The operand. * @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); + ir_node *op, ir_type *to_tp); + +/** Constructor for a Carry node. + * + * @param *irg The ir graph the node belongs to. + * @param *block The ir block the node belongs to. + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. + */ +ir_node *new_r_Carry (ir_graph *irg, ir_node *block, + ir_node *op1, ir_node *op2, ir_mode *mode); + +/** + * Constructor for a Borrow node. + * + * @param *irg The ir graph the node belongs to. + * @param *block The ir block the node belongs to. + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the results. + */ +ir_node *new_r_Borrow (ir_graph *irg, ir_node *block, + ir_node *op1, ir_node *op2, ir_mode *mode); /** Constructor for a Phi node. * @@ -2274,7 +2444,6 @@ ir_node *new_r_Cast (ir_graph *irg, ir_node *block, * @param arity The number of predecessors * @param *in[] Array with predecessors. The constructor copies this array. * @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); @@ -2285,10 +2454,11 @@ ir_node *new_r_Phi (ir_graph *irg, ir_node *block, int arity, * @param *block The ir block the node belongs to. * @param *store The current memory * @param *adr A pointer to the variable to be read in this memory. - * + * @param *mode The mode of the value to be loaded. */ ir_node *new_r_Load (ir_graph *irg, ir_node *block, - ir_node *store, ir_node *adr); + ir_node *store, ir_node *adr, ir_mode *mode); + /** Constructor for a Store node. * * @param *irg The ir graph the node belongs to. @@ -2297,9 +2467,9 @@ ir_node *new_r_Load (ir_graph *irg, ir_node *block, * @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); + 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. @@ -2310,11 +2480,9 @@ ir_node *new_r_Store (ir_graph *irg, ir_node *block, * @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_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store, - ir_node *size, type *alloc_type, where_alloc where); + ir_node *size, ir_type *alloc_type, where_alloc where); /** Constructor for a Free node. * @@ -2327,12 +2495,12 @@ ir_node *new_r_Alloc (ir_graph *irg, ir_node *block, ir_node *store, * @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. - * + * @param where Where the variable was allocated, either heap_alloc or stack_alloc. */ ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store, - ir_node *ptr, ir_node *size, type *free_type); + ir_node *ptr, ir_node *size, ir_type *free_type, where_alloc where); -/** 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 @@ -2340,12 +2508,11 @@ ir_node *new_r_Free (ir_graph *irg, ir_node *block, ir_node *store, * * @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 arity The number of memories to synchronize. * @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[]); +ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]); /** Constructor for a Proj node. * @@ -2357,7 +2524,6 @@ ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]); * @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_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg, ir_mode *mode, long proj); @@ -2369,8 +2535,7 @@ ir_node *new_r_Proj (ir_graph *irg, ir_node *block, ir_node *arg, * @param *irg The ir graph the node belongs to. * @param *block The ir block the node belongs to. * @param arg A node producing a tuple. - * @param max_ proj The end position of the value in the tuple. - * + * @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); @@ -2397,7 +2562,6 @@ ir_node *new_r_Tuple (ir_graph *irg, ir_node *block, int arity, ir_node *in[]); * @param *block The ir block the node belongs to. * @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); @@ -2410,7 +2574,6 @@ ir_node *new_r_Id (ir_graph *irg, ir_node *block, * @param *irg The ir graph the node belongs to. * */ - ir_node *new_r_Bad (ir_graph *irg); /** Constructor for a Confirm node. @@ -2422,18 +2585,16 @@ ir_node *new_r_Bad (ir_graph *irg); * * @param *irg The ir graph the node belong to. * @param *block The ir block the node belong to. - * @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. * - * Represents an arbtrary valus. Places the node in + * Represents an arbitrary value. Places the node in * the start block. * * @param *irg The ir graph the node belongs to. @@ -2450,8 +2611,7 @@ ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m); * * @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_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee); @@ -2461,7 +2621,6 @@ ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee); * * @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); @@ -2471,7 +2630,6 @@ ir_node *new_r_EndReg (ir_graph *irg, ir_node *block); * * @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); @@ -2484,7 +2642,6 @@ ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block); * * @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); @@ -2504,65 +2661,151 @@ ir_node *new_r_Break (ir_graph *irg, ir_node *block); * @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 NoMem node. * - * FuncCall is a function Call that has no side effects. Therefore there - * is not memory operand or result. + * Returns the unique NoMem node of the graph. The same as + * get_irg_no_mem(). * - * @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 *type Type information of the procedure called. + * @param *irg The ir graph the node belongs to. + */ +ir_node *new_r_NoMem (ir_graph *irg); + +/** Constructor for a Mux node. + * + * @param *irg The ir graph the node belong to. + * @param *block The block the node belong to. + * @param *sel The ir_node that calculates the boolean select. + * @param *ir_true The ir_node that calculates the true result. + * @param *ir_false The ir_node that calculates the false result. + * @param *mode The mode of the node (and it_true and ir_false). + */ +ir_node *new_r_Mux (ir_graph *irg, ir_node *block, + ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode); + +/** Constructor for a Psi node. + * + * @param *irg The ir graph the node belong to. + * @param *block The block the node belong to. + * @param *arity The arity of the conditions + * @param *conds The array of mode_b conditions, length must be equal arity + * @param *vals The array of mode values, length must be equal arity + 1 + * @param *mode The mode of the node (must be the mode of all vals). + */ +ir_node *new_r_Psi (ir_graph *irg, ir_node *block, + int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode); + +/** Constructor for a CopyB node. + * + * @param *irg The ir graph the node belong to. + * @param *block The block the node belong to. + * @param *store The current memory + * @param *dst The ir_node that represents the destination address. + * @param *src The ir_node that represents the source address. + * @param *data_type The type of the copied data + */ +ir_node *new_r_CopyB(ir_graph *irg, ir_node *block, + ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type); + +/** Constructor for a InstOf node. + * + * A High-Level Type check. + * + * @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 A pointer to a object of a class type. + * @param *type The type of which objptr must be. + */ +ir_node *new_r_InstOf (ir_graph *irg, ir_node *block, ir_node *store, + ir_node *objptr, ir_type *type); + +/** Constructor for a Raise node. + * + * A High-Level Exception throw. + * + * @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 Bound node. + * + * A High-Level bounds check. Checks whether lower <= idx && idx < upper. + * + * @param *irg The ir graph the node belong to. + * @param *block The block the node belong to. + * @param *store The current memory. + * @param *idx The ir_node that represents an index. + * @param *lower The ir_node that represents the lower bound for the index. + * @param *upper The ir_node that represents the upper bound for the index. + */ +ir_node *new_r_Bound(ir_graph *irg, ir_node *block, + ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper); + +/** Constructor for a Pin node. * + * @param *irg The ir graph the node belong to. + * @param *block The block the node belong to. + * @param *node The node which value should be pinned. */ -ir_node *new_r_FuncCall (ir_graph *irg, ir_node *block, - ir_node *callee, int arity, ir_node *in[], - type *tp); +ir_node *new_r_Pin(ir_graph *irg, ir_node *block, ir_node *node); /*-----------------------------------------------------------------------*/ /* The block oriented interface */ /*-----------------------------------------------------------------------*/ /** 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); + +/** Returns the current block of the current graph. */ +ir_node *get_cur_block(void); + +/** 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. * - * Adds the block to the graph in current_ir_graph. + * 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 *db A Pointer for debug information. * @param arity The number of control predecessors. * @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[]); +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. * * @param *db A pointer for debug information. - * */ -ir_node *new_d_Start (dbg_info* db); +ir_node *new_d_Start (dbg_info *db); /** 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); +ir_node *new_d_End (dbg_info *db); /** Constructor for a Jmp node. * @@ -2571,10 +2814,18 @@ ir_node *new_d_End (dbg_info* db); * Jmp represents control flow to a single control successor. * * @param *db A pointer for debug information. - * */ +ir_node *new_d_Jmp (dbg_info *db); -ir_node *new_d_Jmp (dbg_info* db); +/** Constructor for an IJmp node. + * + * IJmp represents control flow to a single control successor not + * statically known i.e. an indirect Jmp. + * + * @param *db A pointer for debug information. + * @param *tgt The ir node representing the target address. + */ +ir_node *new_d_IJmp (dbg_info *db, ir_node *tgt); /** Constructor for a Cond node. * @@ -2589,10 +2840,8 @@ ir_node *new_d_Jmp (dbg_info* db); * * @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); +ir_node *new_d_Cond (dbg_info *db, ir_node *c); /** Constructor for a Return node. * @@ -2603,24 +2852,10 @@ ir_node *new_d_Cond (dbg_info* db, ir_node *c); * * @param *db A pointer for debug information. * @param *store The state of memory. - * @param arity Number of array indexes. + * @param arity Number of array indices. * @param *in Array with index inputs to the node. - * - */ - -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. - * - * @param *db A pointer for debug information. - * @param *store The current memory. - * @param *obj A pointer to the Except variable. - * */ - -ir_node *new_d_Raise (dbg_info* db, ir_node *store, ir_node *obj); +ir_node *new_d_Return (dbg_info *db, ir_node *store, int arity, ir_node *in[]); /** Constructor for a Const_type node. * @@ -2630,13 +2865,12 @@ ir_node *new_d_Raise (dbg_info* db, ir_node *store, ir_node *obj); * 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 *tp The type of the constante. - * + * @param *mode The mode of the operands and results. + * @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 constant. */ - -ir_node *new_d_Const_type (dbg_info* db, ir_mode *mode, tarval *con, type *tp); +ir_node *new_d_Const_type (dbg_info *db, ir_mode *mode, tarval *con, ir_type *tp); /** Constructor for a Const node. * @@ -2647,11 +2881,11 @@ ir_node *new_d_Const_type (dbg_info* db, ir_mode *mode, tarval *con, type *tp); * 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 *mode The mode of the operands and results. + * @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); +ir_node *new_d_Const (dbg_info *db, ir_mode *mode, tarval *con); /** Constructor for a SymConst_type node. * @@ -2677,29 +2911,31 @@ ir_node *new_d_Const (dbg_info* db, ir_mode *mode, tarval *con); * * @param *db A pointer for debug information. * @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 kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size, + * symconst_type_align, symconst_addr_name or symconst_addr_ent. * @param tp The source type of the constant. - * */ -ir_node *new_d_SymConst_type (dbg_info* db, symconst_symbol value, symconst_kind kind, type* tp); +ir_node *new_d_SymConst_type (dbg_info *db, union symconst_symbol value, symconst_kind kind, ir_type *tp); /** 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, symconst_symbol value, symconst_kind kind); +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. + * 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); +ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent); /** Constructor for a Sel node. * @@ -2707,34 +2943,21 @@ ir_node *new_d_simpleSel(dbg_info* db, ir_node *store, ir_node *objptr, 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. + * node takes the required array indices 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 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 + * @param arity The number of array indices needed to select an array element entity. + * @param *in[] If the compound entity is an array the indices 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. - * - * For translating Java. Not supported as standard firm node. - * - * @param *db A pointer for debug information. - * @param *store - * @param *objptr - * @param *ent - * - */ -ir_node *new_d_InstOf (dbg_info* db, ir_node *store, ir_node *objptr, type *ent); +ir_node *new_d_Sel (dbg_info *db, ir_node *store, ir_node *objptr, int arity, ir_node *in[], + ir_entity *ent); /** Constructor for a Call node. * @@ -2747,36 +2970,31 @@ ir_node *new_d_InstOf (dbg_info* db, ir_node *store, ir_node *objptr, type *ent) * @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_d_Call (dbg_info* db, ir_node *store, ir_node *callee, int arity, ir_node *in[], - type *tp); +ir_node *new_d_Call (dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[], + ir_type *tp); /** 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 *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); +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. * * @param *db A pointer for debug information. - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. - * */ - -ir_node *new_d_Sub (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode); +ir_node *new_d_Sub (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); /** Constructor for a Minus node. * @@ -2785,21 +3003,19 @@ ir_node *new_d_Sub (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode); * @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); +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. * * @param *db A pointer for debug information. - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); +ir_node *new_d_Mul (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); /** Constructor for a Quot node. * @@ -2807,11 +3023,10 @@ ir_node *new_d_Mul (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode); * * @param *db A pointer for debug information. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ -ir_node *new_d_Quot (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2); +ir_node *new_d_Quot (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2); /** Constructor for a DivMod node. * @@ -2819,11 +3034,10 @@ ir_node *new_d_Quot (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2) * * @param *db A pointer for debug information. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ -ir_node *new_d_DivMod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2); +ir_node *new_d_DivMod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2); /** Constructor for a Div node. * @@ -2831,11 +3045,10 @@ ir_node *new_d_DivMod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2) * * @param *db A pointer for debug information. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ -ir_node *new_d_Div (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2); +ir_node *new_d_Div (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2); /** Constructor for a Mod node. * @@ -2843,11 +3056,10 @@ ir_node *new_d_Div (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2) * * @param *db A pointer for debug information. * @param *memop The store needed to model exceptions - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ -ir_node *new_d_Mod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2); +ir_node *new_d_Mod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2); /** Constructor for a Abs node. * @@ -2856,47 +3068,41 @@ ir_node *new_d_Mod (dbg_info* db, ir_node *memop, ir_node *op1, ir_node *op2) * @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); +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. * * @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. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); +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. * * @param *db A pointer for debug information. - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); +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. * * @param *db A pointer for debug information. - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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); +ir_node *new_d_Eor (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); /** Constructor for a Not node. * @@ -2905,9 +3111,8 @@ ir_node *new_d_Eor (dbg_info* db, ir_node *op1, ir_node *op2, ir_mode *mode); * @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); +ir_node *new_d_Not (dbg_info *db, ir_node *op, ir_mode *mode); /** Constructor for a Shl node. * @@ -2917,9 +3122,8 @@ ir_node *new_d_Not (dbg_info* db, ir_node *op, ir_mode *mode); * @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_d_Shl (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode); +ir_node *new_d_Shl (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode); /** Constructor for a Shr node. * @@ -2929,9 +3133,8 @@ ir_node *new_d_Shl (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode); * @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_d_Shr (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode); +ir_node *new_d_Shr (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode); /** Constructor for a Shrs node. * @@ -2941,9 +3144,8 @@ ir_node *new_d_Shr (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode); * @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_d_Shrs (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode); +ir_node *new_d_Shrs (dbg_info *db, ir_node *op, ir_node *k, ir_mode *mode); /** Constructor for a Rot node. * @@ -2953,20 +3155,18 @@ ir_node *new_d_Shrs (dbg_info* db, ir_node *op, ir_node *k, ir_mode *mode); * @param *op The operand. * @param *k The number of bits to rotate 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); +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. * * @param *db A pointer for debug information. - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ -ir_node *new_d_Cmp (dbg_info* db, ir_node *op1, ir_node *op2); +ir_node *new_d_Cmp (dbg_info *db, ir_node *op1, ir_node *op2); /** Constructor for a Conv node. * @@ -2975,11 +3175,20 @@ ir_node *new_d_Cmp (dbg_info* db, ir_node *op1, ir_node *op2); * @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 strict 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); +ir_node *new_d_strictConv (dbg_info *db, ir_node *op, ir_mode *mode); -/**Constructor for a Cast node. +/** Constructor for a Cast node. * * High level type cast * Adds the node to the block in current_ir_block. @@ -2987,21 +3196,41 @@ ir_node *new_d_Conv (dbg_info* db, ir_node *op, ir_mode *mode); * @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, ir_type *to_tp); + +/** Constructor for a Carry node. + * + * Adds the node to the block in current_ir_block. + * + * @param *db A pointer for debug information. + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. + */ +ir_node *new_d_Carry (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); + +/** Constructor for a Borrow node. + * + * Adds the node to the block in current_ir_block. * + * @param *db A pointer for debug information. + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. */ -ir_node *new_d_Cast (dbg_info* db, ir_node *op, type *to_tp); +ir_node *new_d_Borrow (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); -/**Constructor for a Phi node. +/** Constructor for a Phi node. * * Adds the node to the block in current_ir_block. * - * @param *db A pointer for debugginaromation. + * @param *db A pointer for debug information. * @param arity The number of predecessors * @param *in Array with 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); +ir_node *new_d_Phi (dbg_info *db, int arity, ir_node *in[], ir_mode *mode); /** Constructor for a Load node. * @@ -3009,10 +3238,10 @@ ir_node *new_d_Phi (dbg_info* db, int arity, ir_node *in[], ir_mode *mode); * * @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 *addr A pointer to the variable to be read in this memory. + * @param *mode The mode of the value to be loaded. */ -ir_node *new_d_Load (dbg_info* db, ir_node *store, ir_node *addr); +ir_node *new_d_Load (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode); /** Constructor for a Store node. * @@ -3020,12 +3249,12 @@ ir_node *new_d_Load (dbg_info* db, ir_node *store, ir_node *addr); * * @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 *addr 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); +ir_node *new_d_Store (dbg_info *db, ir_node *store, ir_node *addr, 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. * Adds the node to the block in current_ir_block. @@ -3035,12 +3264,11 @@ ir_node *new_d_Store (dbg_info* db, ir_node *store, ir_node *addr, ir_node *val * @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_d_Alloc (dbg_info* db, ir_node *store, ir_node *size, type *alloc_type, - where_alloc where); +ir_node *new_d_Alloc (dbg_info *db, ir_node *store, ir_node *size, ir_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. @@ -3051,12 +3279,12 @@ ir_node *new_d_Alloc (dbg_info* db, ir_node *store, ir_node *size, type *alloc_ * @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. - * + * @param where Where the variable was allocated, either heap_alloc or stack_alloc. */ -ir_node *new_d_Free (dbg_info* db, ir_node *store, ir_node *ptr, ir_node *size, - type *free_type); +ir_node *new_d_Free (dbg_info *db, ir_node *store, ir_node *ptr, ir_node *size, + ir_type *free_type, where_alloc where); -/**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 @@ -3064,42 +3292,37 @@ ir_node *new_d_Free (dbg_info* db, ir_node *store, ir_node *ptr, ir_node *size * 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 arity The number of memories to synchronize. * @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[]); +ir_node *new_d_Sync (dbg_info *db, 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. * Adds the node to the block in current_ir_block. * - * @param *db A pointer for deubugginformation. + * @param *db A pointer for deubug information. * @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_d_Proj (dbg_info* db, ir_node *arg, ir_mode *mode, long proj); - +ir_node *new_d_Proj (dbg_info *db, 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. * 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. - * + * @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); +ir_node *new_d_defaultProj (dbg_info *db, 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. @@ -3108,12 +3331,10 @@ ir_node *new_d_defaultProj (dbg_info* db, ir_node *arg, long max_proj); * @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[]); - +ir_node *new_d_Tuple (dbg_info *db, 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. Adds the node to the block in current_ir_block. @@ -3121,15 +3342,13 @@ ir_node *new_d_Tuple (dbg_info* db, int arity, ir_node *in[]); * @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); +ir_node *new_d_Id (dbg_info *db, ir_node *val, ir_mode *mode); -/**Costructor for a Bad node. +/** Constructor for a Bad node. * * Returns the unique Bad node of the graph. The same as * get_irg_bad(). - * */ ir_node *new_d_Bad (void); @@ -3145,18 +3364,15 @@ ir_node *new_d_Bad (void); * @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_d_Confirm (dbg_info* db, ir_node *val, ir_node *bound, pn_Cmp cmp); +ir_node *new_d_Confirm (dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp); - -/** Constructor for a Unknown node. +/** Constructor for an Unknown node. * - * Represents an arbtrary valus. Places the node in + * Represents an arbitrary value. Places the node in * the start block. * * @param *m The mode of the unknown value. - * */ ir_node *new_d_Unknown(ir_mode *m); @@ -3168,31 +3384,28 @@ ir_node *new_d_Unknown(ir_mode *m); * 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. - * + * @param *callee The call node visible in the intra procedural view. */ ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee); -/** Constructor for a EndReg node. +/** 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. +/** 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. +/** Constructor for a Break node. * * Used to represent exceptional procedure end in interprocedural view. * Adds the node to the block in current_ir_block. @@ -3203,7 +3416,6 @@ ir_node *new_d_EndExcept(dbg_info *db); * 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); @@ -3223,42 +3435,103 @@ ir_node *new_d_Break (dbg_info *db); * @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_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj); -/** Constructor for a FuncCall node. +/** Constructor for a NoMem 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. + * Returns the unique NoMem node of the graph. The same as + * get_irg_no_mem(). + */ +ir_node *new_d_NoMem (void); + +/** Constructor for a Mux node. * - * @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 *tp Type information of the procedure called. + * @param *db A pointer for debug information. + * @param *sel The ir_node that calculates the boolean select. + * @param *ir_true The ir_node that calculates the true result. + * @param *ir_false The ir_node that calculates the false result. + * @param *mode The mode of the node (and it_true and ir_false). + */ +ir_node *new_d_Mux (dbg_info *db, ir_node *sel, + ir_node *ir_false, ir_node *ir_true, ir_mode *mode); + +/** Constructor for a Psi node. * + * @param *db A pointer for debug information. + * @param *arity The arity of the conditions + * @param *conds The array of mode_b conditions, length must be equal arity + * @param *vals The array of mode values, length must be equal arity + 1 + * @param *mode The mode of the node (must be the mode of all vals). */ -ir_node *new_d_FuncCall (dbg_info* db, ir_node *callee, int arity, ir_node *in[], - type *tp); +ir_node *new_d_Psi (dbg_info *db, + int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode); + +/** Constructor for a CopyB node. + * + * @param *db A pointer for debug information. + * @param *store The current memory + * @param *dst The ir_node that represents the destination address. + * @param *src The ir_node that represents the source address. + * @param *data_type The type of the copied data + */ +ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type); + +/** Constructor for a InstOf node. + * + * A High-Level Type check. + * + * @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 A pointer to a object of a class type. + * @param *type The type of which objptr must be. + */ +ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *type); + +/** Constructor for a Raise node. + * + * A High-Level Exception throw. + * + * @param *db A pointer for debug information. + * @param *store The current memory. + * @param *obj A pointer to the Except variable. + */ +ir_node *new_d_Raise (dbg_info *db, ir_node *store, ir_node *obj); + +/** Constructor for a Bound node. + * + * A High-Level bounds check. Checks whether lower <= idx && idx < upper. + * + * @param *db A pointer for debug information. + * @param *store The current memory + * @param *idx The ir_node that represents an index. + * @param *lower The ir_node that represents the lower bound for the index. + * @param *upper The ir_node that represents the upper bound for the index. + */ +ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper); + +/** Constructor for a Pin node. + * + * @param *db A pointer for debug information. + * @param *node The node which value should be pinned. + */ +ir_node *new_d_Pin(dbg_info *db, ir_node *node); /*-----------------------------------------------------------------------*/ /* The block oriented interface without debug support */ /*-----------------------------------------------------------------------*/ -/* 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. */ +/* Needed from the interface with debug support: +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 @@ -3273,18 +3546,16 @@ ir_node *new_Block(int arity, ir_node *in[]); */ ir_node *new_Start (void); -/** Constructor for a End node. +/** Constructor for an End node. * * Adds the node to the block in current_ir_block. - * */ ir_node *new_End (void); -/** Constructor for a EndReg node. +/** Constructor for an EndReg node. * * Used to represent regular procedure end in interprocedual view. * Adds the node to the block in current_ir_block. - * */ ir_node *new_EndReg (void); @@ -3292,32 +3563,36 @@ ir_node *new_EndReg (void); * * Used to represent exceptional procedure end in interprocedural view. * Adds the node to the block in current_ir_block. - * - * - * */ ir_node *new_EndExcept(void); -/** +/** Constructor for a Jump node. * - * Constructor for a Jump node. Adds the node to the block in current_ir_block. + * 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 an IJmp node. + * + * IJmp represents control flow to a single control successor not + * statically known i.e. an indirect Jmp. + * + * @param *tgt The ir node representing the target address. + */ +ir_node *new_IJmp (ir_node *tgt); + /** 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. - * + * Adds the node to the block in current_ir_block. */ ir_node *new_Break (void); -/**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 @@ -3328,7 +3603,6 @@ ir_node *new_Break (void); * * * @param *c The conditions parameter.Can be of mode b or I_u. - * */ ir_node *new_Cond (ir_node *c); @@ -3338,51 +3612,93 @@ ir_node *new_Cond (ir_node *c); * 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 arity Number of array indices. * @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. +/** 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 *store The current memory. - * @param *obj A pointer to the Except variable. - * + * @param *mode The mode of the operands and results. + * @param *con Points to an entry in the constant table. This pointer is + * added to the attributes of the node. */ -ir_node *new_Raise (ir_node *store, ir_node *obj); +ir_node *new_Const (ir_mode *mode, tarval *con); + +/** + * Make a const from a long. + * This is just convenience for the usual + * + * new_Const(mode, tarval_from_long(mode, ...)) + * + * pain. + * @param mode The mode for the const. + * @param value The value of the constant. + * @return A new const node. + */ +ir_node *new_Const_long(ir_mode *mode, long value); /** 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.) + * Derives mode from passed type. */ +ir_node *new_Const_type(tarval *con, ir_type *tp); + +/** Constructor for a SymConst 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. + * -# align The symbolic constant represents the alignment 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. * - * @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). + * 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 kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size + * symconst_type_align, symconst_addr_name or symconst_addr_ent. + * @param tp The source type of the constant. */ -ir_node *new_Const (ir_mode *mode, tarval *con); +ir_node *new_SymConst_type (union symconst_symbol value, symconst_kind kind, ir_type *tp); /** Constructor for a SymConst 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. + * 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. + * -# align The symbolic constant represents the alignment 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. @@ -3390,19 +3706,22 @@ ir_node *new_Const (ir_mode *mode, tarval *con); * 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. - * + * @param kind The kind of the symbolic constant: symconst_type_tag, symconst_type_size + * symconst_type_align, symconst_addr_name or symconst_addr_ent. */ -ir_node *new_SymConst (symconst_symbol value, symconst_kind kind); +ir_node *new_SymConst (union symconst_symbol value, symconst_kind kind); /** 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); +ir_node *new_simpleSel(ir_node *store, ir_node *objptr, ir_entity *ent); /** Constructor for a Sel node. * @@ -3410,31 +3729,20 @@ ir_node *new_simpleSel(ir_node *store, ir_node *objptr, entity *ent); * 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. + * node takes the required array indices 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 + * @param arity The number of array indices needed to select an array element entity. + * @param *in[] If the compound entity is an array the indices 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. - * 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); + ir_entity *ent); /** Constructor for a Call node. * @@ -3446,31 +3754,28 @@ ir_node *new_InstOf (ir_node *store, ir_node *obj, type *ent); * @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_Call (ir_node *store, ir_node *callee, int arity, ir_node *in[], - type *tp); + ir_type *tp); /** Constructor for a CallBegin node. * - * Adds the node to the block in current_ir_block. + * 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 *callee A pointer to the called procedure. - * */ ir_node *new_CallBegin(ir_node *callee); -/**Constructor for a Add node. +/** 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. + * Adds the node to the block in current_ir_block. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. - * */ ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode); @@ -3478,10 +3783,9 @@ ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode); * * Adds the node to the block in current_ir_block. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. - * */ ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode); @@ -3491,17 +3795,15 @@ ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode); * * @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. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. - * */ ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode); @@ -3510,9 +3812,8 @@ ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode); * 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. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2); @@ -3521,9 +3822,8 @@ ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2); * 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. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2); @@ -3532,9 +3832,8 @@ ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2); * 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. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2); @@ -3543,9 +3842,8 @@ ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2); * 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. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2); @@ -3555,7 +3853,6 @@ ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2); * * @param *op The operand * @param *mode The mode of the operands and the result. - * */ ir_node *new_Abs (ir_node *op, ir_mode *mode); @@ -3563,30 +3860,27 @@ ir_node *new_Abs (ir_node *op, ir_mode *mode); * * Adds the node to the block in current_ir_block. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the result. - * */ 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. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @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. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. + * @param *op1 The first operand. + * @param *op2 The second operand. * @param *mode The mode of the operands and the results. - * */ ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode); @@ -3596,7 +3890,6 @@ ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode); * * @param *op The operand. * @param *mode The mode of the operand and the result. - * */ ir_node *new_Not (ir_node *op, ir_mode *mode); @@ -3607,7 +3900,6 @@ ir_node *new_Not (ir_node *op, ir_mode *mode); * @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); @@ -3617,7 +3909,6 @@ ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode); * @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); @@ -3628,7 +3919,6 @@ ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode); * @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); @@ -3639,7 +3929,6 @@ ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode); * @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); @@ -3647,9 +3936,8 @@ ir_node *new_Rot (ir_node *op, ir_node *k, ir_mode *mode); * * Adds the node to the block in current_ir_block. * - * @param *op1 The operand 1. - * @param *op2 The operand 2. - * + * @param *op1 The first operand. + * @param *op2 The second operand. */ ir_node *new_Cmp (ir_node *op1, ir_node *op2); @@ -3657,51 +3945,77 @@ ir_node *new_Cmp (ir_node *op1, ir_node *op2); * * 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 . - * + * @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. +/** Constructor for a strict 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_strictConv (ir_node *op, ir_mode *mode); + +/** 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, ir_type *to_tp); + +/** Constructor for a Carry node. * + * Adds the node to the block in current_ir_block. + * + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. */ -ir_node *new_Cast (ir_node *op, type *to_tp); +ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode); + +/** Constructor for a Borrow node. + * + * Adds the node to the block in current_ir_block. + * + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the operands and the result. + */ +ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode); /** 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 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. * - * @param *store The current memory + * @param *store The current memory. * @param *addr A pointer to the variable to be read in this memory. - * + * @param *mode The mode of the value to be loaded. */ -ir_node *new_Load (ir_node *store, ir_node *addr); +ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode); /** Constructor for a Store node. * - * @param *store The current memory + * @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. + * @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. +/** 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. @@ -3710,13 +4024,11 @@ ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val); * @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_Alloc (ir_node *store, ir_node *size, type *alloc_type, +ir_node *new_Alloc (ir_node *store, ir_node *size, ir_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. @@ -3726,26 +4038,25 @@ ir_node *new_Alloc (ir_node *store, ir_node *size, type *alloc_type, * @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. - * + * @param where Where the variable was allocated, either heap_alloc or stack_alloc. */ ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, - type *free_type); + ir_type *free_type, where_alloc where); -/**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. * Adds the node to the block in current_ir_block. * - * @param arity The number of memories to syncronize. + * @param arity The number of memories to synchronize. * @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. +/** 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. @@ -3754,11 +4065,10 @@ ir_node *new_Sync (int arity, ir_node *in[]); * @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. * * 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. @@ -3772,22 +4082,20 @@ ir_node *new_Proj (ir_node *arg, ir_mode *mode, long 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. +/** 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. - * + * @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. +/** Constructor for a Tuple node. * * This is an auxiliary node to replace a node that returns a tuple * without changing the corresponding Proj nodes. @@ -3795,28 +4103,24 @@ ir_node *new_defaultProj (ir_node *arg, long max_proj); * * @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. +/** Constructor for an 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 *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. * * Returns the unique Bad node of the graph. The same as * get_irg_bad(). - * */ - ir_node *new_Bad (void); /** Constructor for a Confirm node. @@ -3830,34 +4134,94 @@ ir_node *new_Bad (void); * @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. +/** Constructor for an Unknown node. * * 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. +/** Constructor for a NoMem 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. + * Returns the unique NoMem node of the graph. The same as + * get_irg_no_mem(). + */ +ir_node *new_NoMem (void); + +/** Constructor for a Mux node. * - * @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. + * Adds the node to the block in current_ir_block. + * + * @param *sel The ir_node that calculates the boolean select. + * @param *ir_true The ir_node that calculates the true result. + * @param *ir_false The ir_node that calculates the false result. + * @param *mode The mode of the node (and it_true and ir_false). + */ +ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode); + +/** Constructor for a Psi node. + * + * @param *arity The arity of the conditions + * @param *conds The array of mode_b conditions, length must be equal arity + * @param *vals The array of mode values, length must be equal arity + 1 + * @param *mode The mode of the node (must be the mode of all vals). + */ +ir_node *new_Psi (int arity, ir_node *conds[], ir_node *vals[], ir_mode *mode); + +/** Constructor for a CopyB node. + * + * Adds the node to the block in current_ir_block. + * + * @param *store The current memory + * @param *dst The ir_node that represents the destination address. + * @param *src The ir_node that represents the source address. + * @param *data_type The type of the copied data + */ +ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type); + +/** Constructor for a InstOf node. + * + * A High-Level Type check. + * + * @param *store The memory in which the object the entity should be selected + * from is allocated. + * @param *objptr A pointer to a object of a class type. + * @param *type The type of which objptr must be. + */ +ir_node *new_InstOf (ir_node *store, ir_node *objptr, ir_type *type); + +/**Constructor for a Raise node. + * + * A High-Level Exception throw. + * + * @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 Bound node. * + * A High-Level bounds check. Checks whether lower <= idx && idx < upper. + * + * Adds the node to the block in current_ir_block. + * + * @param *store The current memory + * @param *idx The ir_node that represents an index. + * @param *lower The ir_node that represents the lower bound for the index. + * @param *upper The ir_node that represents the upper bound for the index. */ -ir_node *new_FuncCall (ir_node *callee, int arity, ir_node *in[], - type *tp); +ir_node *new_Bound (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper); + +/** Constructor for a Pin node. + * + * @param *node The node which value should be pinned. + */ +ir_node *new_Pin (ir_node *node); /*---------------------------------------------------------------------*/ /* The comfortable interface. */ @@ -3866,75 +4230,120 @@ ir_node *new_FuncCall (ir_node *callee, int arity, ir_node *in[], /* needed also. */ /*---------------------------------------------------------------------*/ -/* --- Block construction --- */ -/* immature Block without predecessors */ -ir_node *new_d_immBlock (dbg_info* db); -ir_node *new_immBlock (void); +/** 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); -/** fixes the number of predecessors of a block. */ -void mature_block (ir_node *block); +/** Finalize a Block node, when all control flows are known. */ +void mature_immBlock(ir_node *block); +#define mature_cur_block() mature_immBlock(get_cur_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. */ -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. */ -void set_value (int pos, ir_node *value); +/** 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); + +/** 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. */ -ir_node *get_store (void); +/** Find the value number for a node in the current block. + * + * This function searches all values in the current block for + * a given value and returns its value number if it was found, else + * -1. + * Note that this does not mean that the value does not exists, + * it's just not equal the node (for instance behind a Phi/Confirm ...) + * + * @param *value The value to find. + */ +int find_value(ir_node *value); -/** Write a store. */ -void set_store (ir_node *store); +/** 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); -/** keep this node alive even if End is not control-reachable from it */ -void keep_alive (ir_node *ka); +/** 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); -/* --- 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); +/** 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); /** Returns the frame type of the current graph */ -type *get_cur_frame_type(void); +ir_type *get_cur_frame_type(void); /* --- initialize and finalize ir construction --- */ /** Puts the graph into state "phase_high" */ -void finalize_cons (ir_graph *irg); +#define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high) + +/** Puts the program and all graphs into state phase_high. + * + * This also remarks, the construction of types is finished, + * e.g., that no more subtypes will be added. */ +void irp_finalize_cons(void); /* --- Initialization --- */ /** * This function is called, whenever a local variable is used before definition * - * @parameter mode the mode of the local var - * @pos position choosen be the frontend for this var + * @param irg the IR graph on which this happens + * @param mode the mode of the local var + * @param pos position chosen be the frontend for this variable (n_loc) * - * @return a firm node of mode @p mode that initialises the var at position pos + * @return a firm node of mode @p mode that initializes the var at position pos * * @note - * Do not return NULL - * If this function is not set, FIRM will create a const node with tarval BAD - */ -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 + * Do not return NULL! + * If this function is not set, FIRM will create a const node with tarval BAD. + * Use set_irg_loc_description()/get_irg_loc_description() to assign additional + * informations to local variables. */ -void init_cons (default_initialize_local_variable_func_t *func); +typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos); -# endif /* _IRCONS_H_ */ +#endif