X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Fircons.h;h=2d0a7a5b85cfa41e3f886dc95fa8afaaf2660cb4;hb=da0db014608257f77c6ed0518c685c8dc1b465c6;hp=b4c53ca48b265d564957893d33d396b3e1d308c8;hpb=ef63002fcb03a29f1b4e041c067d0fa8546bed96;p=libfirm diff --git a/include/libfirm/ircons.h b/include/libfirm/ircons.h index b4c53ca48..2d0a7a5b8 100644 --- a/include/libfirm/ircons.h +++ b/include/libfirm/ircons.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved. + * Copyright (C) 1995-2010 University of Karlsruhe. All right reserved. * * This file is part of libFirm. * @@ -26,17 +26,6 @@ * @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, - constructor then adds all Proj nodes and returns the pointer - to the Proj node that selects the result of the arithmetic operation. - -# Maybe hide the exception region in a global variable, especially if - it is always unambiguous. -*/ - /** * @file * @@ -265,7 +254,7 @@ * 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_Const (tarval *con); + * ir_node *new_Const (ir_tarval *con); * ir_node *new_SymConst (ir_mode *mode, symconst_symbol value, symconst_kind kind); * 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, @@ -279,11 +268,8 @@ * 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_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode); - * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); * ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state; - * 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); @@ -327,7 +313,6 @@ * All ir_nodes are defined by a common data structure. They are distinguished * by their opcode and differ in the number of their attributes. * - * The constructor for the block node sets current_block to itself. * Const nodes are always added to the start block. * All other constructors add the created node to the current_block. * swich_block(block) allows to set the current block to block. @@ -393,7 +378,7 @@ * * Mature_immBlock also fixes the number of inputs to the Phi nodes. Mature_immBlock * should be called as early as possible, as afterwards the generation of Phi - * nodes is more efficient. + * nodes is more efficient. * * Inputs: * There is an input for each control flow predecessor of the block. @@ -418,12 +403,10 @@ * -------------------------------------------- * * Creates a new Block with the given list of predecessors. This block - * is mature. As other constructors calls optimization and vrfy for the + * is mature. As other constructors calls optimization and verify for the * block. If one of the predecessors is Unknown (as it has to be filled in * 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 analysis. + * construct Blocks in loops. * * * CONTROL FLOW OPERATIONS @@ -440,7 +423,7 @@ * node in each procedure which is automatically created by new_ir_graph. * * Inputs: - * No inputs except the block it belogns to. + * No inputs except the block it belongs to. * Output: * A tuple of 4 (5, 6) distinct values. These are labeled by the following * projection numbers (pn_Start): @@ -500,13 +483,13 @@ * A value of mode I_u. (i) * Output: * A tuple of n control flows. If the Cond's input is i, control - * flow will procede along output i. If the input is >= n control + * flow will proceed along output i. If the input is >= n control * flow proceeds along output n. * * ir_node *new_Return (ir_node *store, int arity, ir_node **in) * ------------------------------------------------------------- * - * The return node has as inputs the results of the procedure. It + * The Return node has as inputs the results of the procedure. It * passes the control flow to the end_block. * * Inputs: @@ -515,9 +498,8 @@ * Output * Control flow to the end block. * - * --------- * - * ir_node *new_Const (tarval *con) + * ir_node *new_Const (ir_tarval *con) * ----------------------------------------------- * * Creates a constant in the constant table and adds a Const node @@ -703,28 +685,6 @@ * * Returns the high order bits of a n*n=2n multiplication. * - * ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state) - * ------------------------------------------------------------------------------------------------- - * - * Quot performs exact division of floating point numbers. It's mode - * is Tuple, the mode of the result must match the Proj mode - * that extracts the result of the arithmetic operations. - * - * Inputs: - * The store needed to model exceptions and the two operands. - * Output: - * A tuple containing a memory and a execution for modeling exceptions - * and the result of the arithmetic operation. - * - * ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state) - * --------------------------------------------------------------------------------------------------- - * - * Performs Div and Mod on integer values. - * - * Output: - * A tuple containing a memory and a execution for modeling exceptions - * and the two result of the arithmetic operations. - * * ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state) * ------------------------------------------------------------------------------------------------ * @@ -735,11 +695,6 @@ * * Trivial. * - * ir_node *new_Abs (ir_node *op, ir_mode *mode) - * --------------------------------------------- - * - * Trivial. - * * ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode) * ------------------------------------------------------------ * @@ -843,14 +798,12 @@ * of in's of current_block. This is not checked by the library! * If one of the predecessors is Unknown (as it has to be filled in * 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 analysis. + * construct Phi nodes in loops. * * Parameter * arity number of predecessors * **in array with predecessors - * *mode The mode of it's inputs and output. + * *mode The mode of its inputs and output. * Inputs: * A Phi node has as many inputs as the block it belongs to. * Each input points to a definition of the same value on a @@ -909,9 +862,11 @@ * * Parameters: * *store The memory which shall contain the new variable. - * *count This field is for allocating arrays, i.e., it gives the multiple - * of the size of alloc_type to allocate memory for. - * *alloc_type The type of the allocated variable. + * *count This field is for allocating arrays, it specifies how + * many array elements are to be allocated. + * *alloc_type The type of the allocated variable. In case of allocating + * arrays this has to be the array type, not the type of the + * array elements. * where Where to allocate the variable, either heap_alloc or stack_alloc. * * Inputs: @@ -1004,7 +959,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 its * opcode and giving it a new in array. * * Parameters @@ -1015,7 +970,7 @@ * ir_node *new_Id (ir_node *val, ir_mode *mode) * --------------------------------------------- * - * The single output of the Id operation is it's input. Also needed + * The single output of the Id operation is its input. Also needed * for optimizations. * * @@ -1105,7 +1060,7 @@ * e.g. if there is only one definition of this value, but this * definition reaches the currend block on several different * paths. This Phi node will be eliminated if optimizations are - * turned on right after it's creation. + * turned on right after its creation. * Requires current_block to be set correctly. * * There are two special routines for the global store: @@ -1136,146 +1091,15 @@ #define FIRM_IR_IRCONS_H #include "firm_types.h" - -/** - * constrained flags for memory operations. - */ -typedef enum ir_cons_flags { - cons_none = 0, /**< No constrains. */ - cons_volatile = 1U << 0, /**< Memory operation is volatile. */ - cons_unaligned = 1U << 1, /**< Memory operation is unaligned. */ - cons_floats = 1U << 2 /**< Memory operation can float. */ -} ir_cons_flags; +#include "begin.h" +#include "irnode.h" /*-------------------------------------------------------------------------*/ /* The raw interface */ /*-------------------------------------------------------------------------*/ -/** Constructor for a Block node. - * - * Constructs a mature block with the given predecessors. Use Unknown - * nodes as predecessors to construct a block if the number of - * predecessors is known, but not the predecessors themselves. This - * constructor does not set current_block. It not be used with - * automatic Phi node construction. - * - * @param *db A Pointer for debug information. - * @param irg The IR graph the block belongs to. - * @param arity The number of control predecessors. - * @param in[] An array of control predecessors. The length of - * the array must be 'arity'. The constructor copies this array. - */ -ir_node *new_rd_Block(dbg_info *db, ir_graph *irg, int arity, ir_node *in[]); - -/** Constructor for a Start node. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belongs to. - * @param *block The IR block the node belongs to. - */ -ir_node *new_rd_Start(dbg_info *db, ir_graph *irg, ir_node *block); - -/** Constructor for a End node. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belongs to. - * @param *block The IR block the node belongs to. - */ -ir_node *new_rd_End(dbg_info *db, ir_graph *irg, ir_node *block); - -/** Constructor for a Jmp node. - * - * Jmp represents control flow to a single control successor. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - */ -ir_node *new_rd_Jmp(dbg_info *db, 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 *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_node *block, 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. - * - * @param *db A pointer for debug information. - * @param *block The block the node belong to. - */ -ir_node *new_rd_Break(dbg_info *db, ir_node *block); - -/** Constructor for a Cond node. - * - * If c is mode_b represents a conditional branch (if/else). If c is - * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond - * node, default Proj is 0.) - * - * This is not consistent: Input to Cond is Is, Proj has as proj number - * longs. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *c The conditions parameter. Can be of mode b or I_u. - */ -ir_node *new_rd_Cond(dbg_info *db, ir_node *block, ir_node *c); - -/** Constructor for a Return node. - * - * Returns the memory and zero or more return values. Only node that - * can end regular control flow. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *store The state of memory. - * @param arity Number of return values. - * @param *in Array of length arity with return values. The constructor copies this array. - */ -ir_node *new_rd_Return(dbg_info *db, ir_node *block, - ir_node *store, int arity, ir_node *in[]); - -/** Constructor for a Const_type node. - * - * Adds the node to the start block. - * - * The constant represents a target value. This constructor sets high - * level type information for the constant value. - * Derives mode from passed tarval. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belongs to. - * @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, - tarval *con, ir_type *tp); - -/** Constructor for a Const node. - * - * Adds the node to the start block. - * - * Constructor for a Const node. The constant represents a target - * value. Sets the type information to type_unknown. (No more - * supported: If tv is entity derives a somehow useful type.) - * Derives mode from passed tarval. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belongs to. - * @param *con Points to an entry in the constant table. - */ -ir_node *new_rd_Const(dbg_info *db, ir_graph *irg, tarval *con); - -/** Constructor for a Const node. +/** + * Constructor for a Const node. * * Adds the node to the start block. * @@ -1288,10 +1112,10 @@ ir_node *new_rd_Const(dbg_info *db, ir_graph *irg, tarval *con); * @param *mode The mode of the operands and results. * @param value A value from which the tarval is made. */ -ir_node *new_rd_Const_long(dbg_info *db, ir_graph *irg, - ir_mode *mode, long value); +FIRM_API ir_node *new_rd_Const_long(dbg_info *db, ir_graph *irg, + ir_mode *mode, long value); -/** Constructor for a SymConst_type node. +/** Constructor for a SymConst node. * * This is the constructor for a symbolic constant. * There are several kinds of symbolic constants: @@ -1325,61 +1149,53 @@ ir_node *new_rd_Const_long(dbg_info *db, ir_graph *irg, * @param value A type, ident, entity or enum constant depending on the * SymConst kind. * @param kind The kind of the symbolic constant, see the list above - * @param tp The source type of the constant. - */ -ir_node *new_rd_SymConst_type(dbg_info *db, ir_graph *irg, ir_mode *mode, - union symconst_symbol value, symconst_kind kind, - 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_mode *mode, - union symconst_symbol value, symconst_kind kind); +FIRM_API ir_node *new_rd_SymConst(dbg_info *db, ir_graph *irg, ir_mode *mode, + union symconst_symbol value, + symconst_kind kind); /** Constructor for a SymConst addr_ent node. * - * Same as new_rd_SymConst_type, except that the constructor is tailored for + * Same as new_rd_SymConst, 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_mode *mode, - ir_entity *symbol, ir_type *tp); +FIRM_API ir_node *new_rd_SymConst_addr_ent(dbg_info *db, ir_graph *irg, + ir_mode *mode, ir_entity *symbol); /** Constructor for a SymConst ofs_ent node. * - * Same as new_rd_SymConst_type, except that the constructor is tailored for + * Same as new_rd_SymConst, 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_mode *mode, - ir_entity *symbol, ir_type *tp); +FIRM_API ir_node *new_rd_SymConst_ofs_ent(dbg_info *db, ir_graph *irg, + ir_mode *mode, ir_entity *symbol); /** Constructor for a SymConst type_tag node. * - * Same as new_rd_SymConst_type, except that the constructor is tailored for + * Same as new_rd_SymConst, except that the constructor is tailored for * symconst_type_tag. * Adds the SymConst to the start block of irg. */ -ir_node *new_rd_SymConst_type_tag(dbg_info *db, ir_graph *irg, ir_mode *mode, - ir_type *symbol, ir_type *tp); +FIRM_API ir_node *new_rd_SymConst_type_tag(dbg_info *db, ir_graph *irg, + ir_mode *mode, ir_type *symbol); /** Constructor for a SymConst size node. * - * Same as new_rd_SymConst_type, except that the constructor is tailored for + * Same as new_rd_SymConst, 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_mode *mode, - ir_type *symbol, ir_type *tp); +FIRM_API ir_node *new_rd_SymConst_size(dbg_info *db, ir_graph *irg, + ir_mode *mode, ir_type *symbol); /** Constructor for a SymConst size node. * - * Same as new_rd_SymConst_type, except that the constructor is tailored for + * Same as new_rd_SymConst, 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_mode *mode, - ir_type *symbol, ir_type *tp); +FIRM_API ir_node *new_rd_SymConst_align(dbg_info *db, ir_graph *irg, + ir_mode *mode, ir_type *symbol); /** Constructor for a simpleSel node. * @@ -1395,2958 +1211,406 @@ ir_node *new_rd_SymConst_align(dbg_info *db, ir_graph *irg, ir_mode *mode, * single attribute out. * @param *ent The entity to select. */ -ir_node *new_rd_simpleSel(dbg_info *db, ir_node *block, - ir_node *store, ir_node *objptr, ir_entity *ent); - -/** Constructor for a Sel node. - * - * The select node selects an entity (field or method) from an entity - * with a compound type. It explicitly specifies the entity selected. - * Dynamically the node may select entities that overwrite the given - * entity. If the selected entity is an array element entity the Sel - * node takes the required array indices as inputs. - * - * @param *db A pointer for debug information. - * @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 compound entity the Sel operation selects a - * single attribute from. - * @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_node *block, ir_node *store, - ir_node *objptr, int n_index, ir_node *index[], ir_entity *ent); - -/** Constructor for a Call node. - * - * Represents all kinds of method and function calls. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *store The current memory state. - * @param *callee A pointer to the called procedure. - * @param arity The number of procedure parameters. - * @param *in[] An array with the procedure parameters. The constructor copies this array. - * @param *tp Type information of the procedure called. - */ -ir_node *new_rd_Call(dbg_info *db, ir_node *block, ir_node *store, - ir_node *callee, int arity, ir_node *in[], ir_type *tp); - -/** Constructor for a Builtin node. - * - * Represents a call of a backend-specific builtin.. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *store The current memory state. - * @param arity The number of procedure parameters. - * @param *in[] An array with the procedure parameters. The constructor copies this array. - * @param kind The kind of the called builtin. - * @param *tp Type information of the procedure called. - */ -ir_node *new_rd_Builtin(dbg_info *db, ir_node *block, ir_node *store, - int arity, ir_node *in[], ir_builtin_kind kind, ir_type *tp); +FIRM_API ir_node *new_rd_simpleSel(dbg_info *db, ir_node *block, ir_node *store, + ir_node *objptr, ir_entity *ent); -/** Constructor for a Add node. +/** Constructor for a remainderless Div node. * * @param *db A pointer for debug information. * @param *block The IR block the node belongs to. + * @param *memop The store needed to model exceptions * @param *op1 The first operand. * @param *op2 The second operand. - * @param *mode The mode of the operands and the result. + * @param *mode The mode of the result. + * @param state The pinned state. */ -ir_node *new_rd_Add(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); +FIRM_API ir_node *new_rd_DivRL(dbg_info *db, ir_node *block, ir_node *memop, + ir_node *op1, ir_node *op2, ir_mode *mode, + op_pin_state state); -/** Constructor for a Sub node. +/** Constructor for a strictConv node. * * @param *db A pointer for debug information. * @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. + * @param *op The operand. + * @param *mode The mode of this the operand muss be converted . */ -ir_node *new_rd_Sub(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); +FIRM_API ir_node *new_rd_strictConv(dbg_info *db, ir_node *block, + ir_node *op, ir_mode *mode); -/** Constructor for a Minus node. +/** Constructor for a defaultProj node. * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_rd_Minus(dbg_info *db, ir_node *block, - ir_node *op, ir_mode *mode); - -/** Constructor for a Mul node. + * Represents the default control flow of a Switch-Cond node. * - * @param *db A pointer for debug information. - * @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. + * @param *db A pointer for debug information. + * @param arg A node producing a tuple. + * @param max_proj The end position of the value in the tuple. */ -ir_node *new_rd_Mul(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); +FIRM_API ir_node *new_rd_defaultProj(dbg_info *db, ir_node *arg, long max_proj); -/** Constructor for a Mulh node. +/** Constructor for an ASM pseudo node. * - * @param *db A pointer for debug information. - * @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. + * @param *db A pointer for debug information. + * @param *block The block the node belong to. + * @param arity The number of data inputs to the node. + * @param *in The array of length arity of data inputs. + * @param *inputs The array of length arity of input constraints. + * @param n_outs The number of data outputs to the node. + * @param *outputs The array of length n_outs of output constraints. + * @param n_clobber The number of clobbered registers. + * @param *clobber The array of length n_clobber of clobbered registers. + * @param *asm_text The assembler text. */ -ir_node *new_rd_Mulh(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); +FIRM_API ir_node *new_rd_ASM(dbg_info *db, ir_node *block, + int arity, ir_node *in[], ir_asm_constraint *inputs, + int n_outs, ir_asm_constraint *outputs, + int n_clobber, ident *clobber[], ident *asm_text); + +/*-------------------------------------------------------------------------*/ +/* The raw interface without debug support */ +/*-------------------------------------------------------------------------*/ -/** Constructor for a Quot node. +/** Constructor for a Const node. * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. + * Adds the node to the start block. + * + * Constructor for a Const node. The constant represents a target + * value. Sets the type information to type_unknown. (No more + * supported: If tv is entity derives a somehow useful type.) + * + * @param *irg The IR graph 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_rd_Quot(dbg_info *db, ir_node *block, ir_node *memop, - ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); +FIRM_API ir_node *new_r_Const_long(ir_graph *irg, ir_mode *mode, long value); -/** Constructor for a DivMod node. +/** Constructor for a SymConst node. * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the results. - * @param state The pinned state. + * This is the constructor for a symbolic constant. + * There are several kinds of symbolic constants: + * - symconst_type_tag The symbolic constant represents a type tag. The + * type the tag stands for is given explicitly. + * - symconst_type_size The symbolic constant represents the size of a type. + * The type of which the constant represents the size + * is given explicitly. + * - symconst_type_align The symbolic constant represents the alignment of a + * type. The type of which the constant represents the + * size is given explicitly. + * - symconst_addr_ent The symbolic constant represents the address of an + * entity (variable or method). The variable is given + * explicitly by a firm entity. + * - symconst_ofs_ent The symbolic constant represents the offset of an + * entity in its owner type. + * - symconst_enum_const The symbolic constant is a enumeration constant of + * an enumeration type. + * + * 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 *irg The IR graph the node belongs to. + * @param mode The mode for the SymConst. + * @param value A type, ident, entity or enum constant depending on the + * SymConst kind. + * @param kind The kind of the symbolic constant, see the list above */ -ir_node *new_rd_DivMod(dbg_info *db, ir_node *block, ir_node *memop, - ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); +FIRM_API ir_node *new_r_SymConst(ir_graph *irg, ir_mode *mode, + union symconst_symbol value, + symconst_kind kind); -/** Constructor for a Div node. +/** Constructor for a simpleSel node. * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. + * 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 *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_Div(dbg_info *db, ir_node *block, ir_node *memop, - ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); +FIRM_API ir_node *new_r_simpleSel(ir_node *block, ir_node *store, + ir_node *objptr, ir_entity *ent); /** Constructor for a remainderless Div node. * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. + * @param *block The IR block the node belongs to. + * @param *memop The store needed to model exceptions + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the result. + * @param state The pinned state. */ -ir_node *new_rd_DivRL(dbg_info *db, ir_node *block, ir_node *memop, - ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Mod node. +FIRM_API ir_node *new_r_DivRL(ir_node *block, ir_node *memop, + ir_node *op1, ir_node *op2, ir_mode *mode, + op_pin_state state); +/** Constructor for a strict Conv node. * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. + * @param *block The IR block the node belongs to. + * @param *op The operand. + * @param *mode The mode of this the operand muss be converted . */ -ir_node *new_rd_Mod(dbg_info *db, ir_node *block, ir_node *memop, - ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); +FIRM_API ir_node *new_r_strictConv(ir_node *block, ir_node *op, ir_mode *mode); -/** Constructor for a Abs node. +/** Constructor for a defaultProj node. * - * @param *db A pointer for debug information. - * @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_rd_Abs(dbg_info *db, ir_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a And node. + * Represents the default control flow of a Switch-Cond node. * - * @param *db A pointer for debug information. - * @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. + * @param arg A node producing a tuple. + * @param max_proj The end position of the value in the tuple. */ -ir_node *new_rd_And(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); +FIRM_API ir_node *new_r_defaultProj(ir_node *arg, long max_proj); -/** Constructor for a Or node. +/** Constructor for an ASM pseudo node. * - * @param *db A pointer for debug information. - * @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_Or(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Eor node. - * - * @param *db A pointer for debug information. - * @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_rd_Eor(dbg_info *db, ir_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Not node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *mode The mode of the operand and the result. - */ -ir_node *new_rd_Not(dbg_info *db, ir_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a Cmp node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op1 The first operand. - * @param *op2 The second operand. - */ -ir_node *new_rd_Cmp(dbg_info *db, ir_node *block, ir_node *op1, ir_node *op2); - -/** Constructor for a Shl node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_rd_Shl(dbg_info *db, ir_node *block, - ir_node *op, ir_node *k, ir_mode *mode); - -/** Constructor for a Shr node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_rd_Shr(dbg_info *db, ir_node *block, - ir_node *op, ir_node *k, ir_mode *mode); - -/** Constructor for a Shrs node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to shift the operand. - * @param *mode The mode of the operand and the result. - */ -ir_node *new_rd_Shrs(dbg_info *db, ir_node *block, - ir_node *op, ir_node *k, ir_mode *mode); - -/** Constructor for a Rotl node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to rotate the operand. - * @param *mode The mode of the operand. - */ -ir_node *new_rd_Rotl(dbg_info *db, ir_node *block, - ir_node *op, ir_node *k, ir_mode *mode); - - -/** Constructor for a Conv node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *mode The mode of this the operand muss be converted . - */ -ir_node *new_rd_Conv(dbg_info *db, ir_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a strictConv node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *mode The mode of this the operand muss be converted . - */ -ir_node *new_rd_strictConv(dbg_info *db, ir_node *block, - ir_node *op, ir_mode *mode); - -/** Constructor for a Cast node. - * - * High level type cast. - * - * @param *db A pointer for debug information. - * @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_rd_Cast(dbg_info *db, ir_node *block, - ir_node *op, ir_type *to_tp); - -/** Constructor for a Carry node. - * - * @param *db A pointer for debug information. - * @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_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Borrow node. - * - * @param *db A pointer for debug information. - * @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_node *block, - ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Phi node. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param arity The number of predecessors - * @param *in[] Array with predecessors. The constructor copies this array. - * @param *mode The mode of it's inputs and output. - */ -ir_node *new_rd_Phi(dbg_info *db, ir_node *block, int arity, - ir_node *in[], ir_mode *mode); - -/** Constructor for a Load node. - * - * @param *db A pointer for debug information. - * @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. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_rd_Load(dbg_info *db, ir_node *block, ir_node *store, - ir_node *adr, ir_mode *mode, ir_cons_flags flags); - -/** Constructor for a Store node. - * - * @param *db A pointer for debug information. - * @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 *val The value to write to this variable. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_rd_Store(dbg_info *db, ir_node *block, ir_node *store, - ir_node *adr, ir_node *val, ir_cons_flags flags); - -/** Constructor for a Alloc node. - * - * The Alloc node extends the memory by space for an entity of type alloc_type. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *store The memory which shall contain the new variable. - * @param *count The number of objects to allocate. - * @param *alloc_type The type of the allocated variable. - * @param where Where to allocate the variable, either heap_alloc or stack_alloc. - */ -ir_node *new_rd_Alloc(dbg_info *db, ir_node *block, ir_node *store, - ir_node *count, ir_type *alloc_type, ir_where_alloc where); - -/** Constructor for a Free node. - * - * Frees the memory occupied by the entity pointed to by the pointer - * arg. Type indicates the type of the entity the argument points to. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *store The memory which shall contain the new variable. - * @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_node *block, ir_node *store, - ir_node *ptr, ir_node *size, ir_type *free_type, ir_where_alloc where); - -/** Constructor for a Sync node. - * - * Merges several memory values. The node assumes that a variable - * either occurs only in one of the memories, or it contains the same - * value in all memories where it occurs. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @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_rd_Sync(dbg_info *db, ir_node *block, int arity, ir_node *in[]); - -/** Constructor for a Proj node. - * - * Projects a single value out of a tuple. The parameter proj gives the - * position of the value within the tuple. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param arg A node producing a tuple. The node must have mode_T. - * @param *mode The mode of the value to project. - * @param proj The position of the value in the tuple. - */ -ir_node *new_rd_Proj(dbg_info *db, ir_node *block, ir_node *arg, - ir_mode *mode, long proj); - -/** Constructor for a defaultProj node. - * - * Represents the default control flow of a Switch-Cond node. - * - * @param *db A pointer for debug information. - * @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. - */ -ir_node *new_rd_defaultProj(dbg_info *db, ir_node *block, - ir_node *arg, long max_proj); - -/** Constructor for a Tuple node. - * - * This is an auxiliary node to replace a node that returns a tuple - * without changing the corresponding Proj nodes. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param arity The number of tuple elements. - * @param *in[] An array containing pointers to the nodes producing the tuple - * elements. The constructor copies this array. - */ -ir_node *new_rd_Tuple(dbg_info *db, ir_node *block, - int arity, ir_node *in[]); - -/** Constructor for a Id node. - * - * This is an auxiliary node to replace a node that returns a single - * value. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belongs to. - * @param *val The value - * @param *mode The mode of *val. - */ -ir_node *new_rd_Id(dbg_info *db, ir_node *block, - ir_node *val, ir_mode *mode); - -/** Constructor for a Confirm node. - * - * Specifies constraints for a value. To support dataflow analyses. - * - * Example: If the value never exceeds '100' this is expressed by placing a - * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge. - * - * @param *db A pointer for debug information. - * @param *block The IR block the node belong to. - * @param *val The value we express a constraint for - * @param *bound The value to compare against. Must be a firm node, typically a constant. - * @param cmp The compare operation. - */ -ir_node *new_rd_Confirm(dbg_info *db, ir_node *block, - ir_node *val, ir_node *bound, pn_Cmp cmp); - -/** Constructor for an Unknown node. - * - * Represents an arbitrary value. Places the node in the start block. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belongs to. - * @param *m The mode of the unknown value. - */ -ir_node *new_rd_Unknown(dbg_info *db, ir_graph *irg, ir_mode *m); - -/** Constructor for a CallBegin node. - * - * CallBegin represents control flow depending of the pointer value - * representing the called method to the called methods. The - * constructor copies the method pointer input from the passed Call - * node. - * - * @param *db A pointer for debug information. - * @param *block The block the node belong to. - * @param *callee The call node visible in the intra procedural view. - */ -ir_node *new_rd_CallBegin(dbg_info *db, ir_node *block, ir_node *ptr, ir_node *call); - -/** Constructor for a EndReg node. - * - * Used to represent regular procedure end in interprocedual view. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belong to. - * @param *block The block the node belong to. - */ -ir_node *new_rd_EndReg(dbg_info *db, ir_graph *irg, ir_node *block); - -/** Constructor for a EndExcept node. - * - * Used to represent exceptional procedure end in interprocedural view. - * - * @param *db A pointer for debug information. - * @param *irg The IR graph the node belong to. - * @param *block The block the node belong to. - */ -ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block); - -/** Constructor for a Filter node. - * - * Adds the node to the block in current_ir_block. Filter is a node - * with two views used to construct the interprocedural view. In - * intraprocedural view its semantics are identical to the Proj node. - * In interprocedural view the Filter performs the Phi operation on - * method parameters or results. Other than a Phi a Filter node may - * not be removed if it has only a single input. - * - * The constructor builds the Filter in intraprocedural view. - * - * @param *db A pointer for debug information. - * @param *block The block the node belong to. - * @param *arg The tuple value to project from. - * @param *mode The mode of the projected value. - * @param proj The position in the tuple to project from. - */ -ir_node *new_rd_Filter(dbg_info *db,ir_node *block, ir_node *arg, - ir_mode *mode, long proj); - -/** Constructor for a Mux node. - * - * @param *db A pointer for debug information. - * @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_node *block, ir_node *sel, - ir_node *ir_false, ir_node *ir_true, ir_mode *mode); - -/** Constructor for a CopyB node. - * - * @param *db A pointer for debug information. - * @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_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 *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_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 *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_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 *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_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 *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_node *block, ir_node *node); - -/** Constructor for an ASM pseudo node. - * - * @param *db A pointer for debug information. - * @param *block The block the node belong to. - * @param arity The number of data inputs to the node. - * @param *in The array of length arity of data inputs. - * @param *inputs The array of length arity of input constraints. - * @param n_outs The number of data outputs to the node. - * @param *outputs The array of length n_outs of output constraints. - * @param n_clobber The number of clobbered registers. - * @param *clobber The array of length n_clobber of clobbered registers. - * @param *asm_text The assembler text. - */ -ir_node *new_rd_ASM(dbg_info *db, ir_node *block, - int arity, ir_node *in[], ir_asm_constraint *inputs, - int n_outs, ir_asm_constraint *outputs, - int n_clobber, ident *clobber[], ident *asm_text); - -/*-------------------------------------------------------------------------*/ -/* The raw interface without debug support */ -/*-------------------------------------------------------------------------*/ - -/** Constructor for a Block node. - * - * Constructs a mature block with the given predecessors. Use Unknown - * nodes as predecessors to construct a block if the number of - * predecessors is known, but not the predecessors themselves. This - * constructor does not set current_block. It not be used with - * automatic Phi node construction. - * - * - * @param irg The IR graph the block belongs to. - * @param arity The number of control predecessors. - * @param in[] An array of control predecessors. The length of - * the array must be 'arity'. The constructor copies this array. - */ -ir_node *new_r_Block(ir_graph *irg, int arity, ir_node *in[]); - -/** Constructor for a Start node. - * - * @param *irg The IR graph the node belongs to. - * @param *block The IR block the node belongs to. - */ -ir_node *new_r_Start(ir_graph *irg, ir_node *block); - -/** Constructor for a End node. - * - * @param *irg The IR graph the node belongs to. - * @param *block The IR block the node belongs to. - */ -ir_node *new_r_End(ir_graph *irg, ir_node *block); - -/** Constructor for a Jmp node. - * - * Jmp represents control flow to a single control successor. - * - * @param *block The IR block the node belongs to. - */ -ir_node *new_r_Jmp(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 *block The IR block the node belongs to. - * @param *tgt The IR node representing the target address. - */ -ir_node *new_r_IJmp(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. - * - * @param *block The IR block the node belongs to. - * @param *c The conditions parameter.Can be of mode b or I_u. - */ -ir_node *new_r_Cond(ir_node *block, ir_node *c); - -/** Constructor for a Return node. - * - * Returns the memory and zero or more return values. Only node that - * can end regular control flow. - * - * @param *block The IR block the node belongs to. - * @param *store The state of memory. - * @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_node *block, ir_node *store, int arity, ir_node *in[]); - -/** Constructor for a Const node. - * - * Adds the node to the start block. - * - * Constructor for a Const node. The constant represents a target - * value. Sets the type information to type_unknown. (No more - * supported: If tv is entity derives a somehow useful type.) - * Derives mode from passed tarval. - * - * @param *irg The IR graph the node belongs to. - * @param *con Points to an entry in the constant table. - */ -ir_node *new_r_Const(ir_graph *irg, tarval *con); - -/** Constructor for a Const node. - * - * Adds the node to the start block. - * - * Constructor for a Const node. The constant represents a target - * value. Sets the type information to type_unknown. (No more - * supported: If tv is entity derives a somehow useful type.) - * - * @param *irg The IR graph 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_mode *mode, long value); - -/** Constructor for a Const_type node. - * - * Adds the node to the start block. - * - * The constant represents a target value. This constructor sets high - * level type information for the constant value. - * Derives mode from passed tarval. - * - * @param *irg The IR graph the node belongs to. - * @param *con Points to an entry in the constant table. - * @param *tp The type of the constant. - */ -ir_node *new_r_Const_type(ir_graph *irg, tarval *con, ir_type *tp); - -/** Constructor for a SymConst node. - * - * This is the constructor for a symbolic constant. - * There are several kinds of symbolic constants: - * - symconst_type_tag The symbolic constant represents a type tag. The - * type the tag stands for is given explicitly. - * - symconst_type_size The symbolic constant represents the size of a type. - * The type of which the constant represents the size - * is given explicitly. - * - symconst_type_align The symbolic constant represents the alignment of a - * type. The type of which the constant represents the - * size is given explicitly. - * - symconst_addr_ent The symbolic constant represents the address of an - * entity (variable or method). The variable is given - * explicitly by a firm entity. - * - symconst_ofs_ent The symbolic constant represents the offset of an - * entity in its owner type. - * - symconst_enum_const The symbolic constant is a enumeration constant of - * an enumeration type. - * - * 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 *irg The IR graph the node belongs to. - * @param mode The mode for the SymConst. - * @param value A type, ident, entity or enum constant depending on the - * SymConst kind. - * @param kind The kind of the symbolic constant, see the list above - */ -ir_node *new_r_SymConst(ir_graph *irg, ir_mode *mode, - union symconst_symbol value, symconst_kind kind); - -/** 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 *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_node *block, ir_node *store, - ir_node *objptr, ir_entity *ent); - -/** Constructor for a Sel node. - * - * The select node selects an entity (field or method) from an entity - * with a compound type. It explicitly specifies the entity selected. - * Dynamically the node may select entities that overwrite the given - * entity. If the selected entity is an array element entity the Sel - * node takes the required array indices as inputs. - * - * @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 compound entity the Sel operation selects a - * single attribute from. - * @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_node *block, ir_node *store, - ir_node *objptr, int n_index, ir_node *index[], - ir_entity *ent); - -/** Constructor for a Call node. - * - * Represents all kinds of method and function calls. - * - * @param *block The IR block the node belongs to. - * @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_node *block, ir_node *store, - ir_node *callee, int arity, ir_node *in[], ir_type *tp); - -/** Constructor for a Builtin node. - * - * Represents a call of a backend-specific builtin.. - * - * @param *block The IR block the node belongs to. - * @param *store The actual store. - * @param arity The number of procedure parameters. - * @param *in[] An array with the pointers to the parameters. The constructor copies this array. - * @param kind The kind of the called builtin. - * @param *tp Type information of the procedure called. - */ -ir_node *new_r_Builtin(ir_node *block, ir_node *store, - int arity, ir_node *in[], ir_builtin_kind kind, ir_type *tp); - -/** Constructor for a Add node. - * - * @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_Add(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** - * Constructor for a Sub node. - * - * @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_Sub(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Minus node. - * - * @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_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a Mul node. - * - * @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_Mul(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Mulh node. - * - * @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_Mulh(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Quot node. - * - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_r_Quot(ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2, - ir_mode *mode, op_pin_state state); - -/** Constructor for a DivMod node. - * - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the results. - * @param state The pinned state. - */ -ir_node *new_r_DivMod(ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2, - ir_mode *mode, op_pin_state state); - -/** Constructor for a Div node. - * - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_r_Div(ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2, - ir_mode *mode, op_pin_state state); - -/** Constructor for a remainderless Div node. - * - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_r_DivRL(ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2, - ir_mode *mode, op_pin_state state); - -/** Constructor for a Mod node. - * - * @param *block The IR block the node belongs to. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_r_Mod(ir_node *block, ir_node *memop, ir_node *op1, ir_node *op2, - ir_mode *mode, op_pin_state state); - -/** Constructor for a Abs node. - * - * @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_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a And node. - * - * @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_And(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Or node. - * - * @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_Or(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Eor node. - * - * @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_Eor(ir_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Not node. - * - * @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_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a Cmp node. - * - * @param *block The IR block the node belongs to. - * @param *op1 The first operand. - * @param *op2 The second operand. - */ -ir_node *new_r_Cmp(ir_node *block, ir_node *op1, ir_node *op2); - -/** Constructor for a Shl node. - * - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_r_Shl(ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); - -/** Constructor for a Shr node. - * - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_r_Shr(ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); - -/** - * Constructor for a Shrs node. - * - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to shift the operand. - * @param *mode The mode of the operand and the result. - */ -ir_node *new_r_Shrs(ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); - -/** Constructor for a Rotl node. - * - * @param *block The IR block the node belongs to. - * @param *op The operand. - * @param *k The number of bits to rotate the operand. - * @param *mode The mode of the operand. - */ -ir_node *new_r_Rotl(ir_node *block, ir_node *op, ir_node *k, ir_mode *mode); - -/** Constructor for a Conv node. - * - * @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_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a strict Conv node. - * - * @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_strictConv(ir_node *block, ir_node *op, ir_mode *mode); - -/** Constructor for a Cast node. - * - * High level type cast - * - * @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_node *block, ir_node *op, ir_type *to_tp); - -/** Constructor for a Carry node. - * - * @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_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** - * Constructor for a Borrow node. - * - * @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_node *block, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Phi node. - * - * @param *block The IR block the node belongs to. - * @param arity The number of predecessors - * @param *in[] Array with predecessors. The constructor copies this array. - * @param *mode The mode of it's inputs and output. - */ -ir_node *new_r_Phi(ir_node *block, int arity, ir_node *in[], ir_mode *mode); - -/** Constructor for a Load node. - * - * @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. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_r_Load(ir_node *block, ir_node *store, - ir_node *adr, ir_mode *mode, ir_cons_flags flags); - -/** Constructor for a Store node. - * - * @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 *val The value to write to this variable. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_r_Store(ir_node *block, ir_node *store, - ir_node *adr, ir_node *val, ir_cons_flags flags); - -/** Constructor for a Alloc node. - * - * The Alloc node extends the memory by space for an entity of type alloc_type. - * - * @param *block The IR block the node belongs to. - * @param *store The memory which shall contain the new variable. - * @param *count The number of objects 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_node *block, ir_node *store, - ir_node *count, ir_type *alloc_type, ir_where_alloc where); - -/** Constructor for a Free node. - * - * Frees the memory occupied by the entity pointed to by the pointer - * arg. Type indicates the type of the entity the argument points to. - * - * @param *block The IR block the node belongs to. - * @param *store The memory which shall contain the new variable. - * @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_node *block, ir_node *store, - ir_node *ptr, ir_node *size, ir_type *free_type, ir_where_alloc where); - -/** Constructor for a Sync node. - * - * Merges several memory values. The node assumes that a variable - * either occurs only in one of the memories, or it contains the same - * value in all memories where it occurs. - * - * @param *block The IR block the node belongs to. - * @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_node *block, int arity, ir_node *in[]); - -/** Constructor for a Proj node. - * - * Projects a single value out of a tuple. The parameter proj gives the - * position of the value within the tuple. - * - * @param *block The IR block the node belongs to. - * @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_node *block, ir_node *arg, - ir_mode *mode, long proj); - -/** Constructor for a defaultProj node. - * - * Represents the default control flow of a Switch-Cond node. - * - * @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. - */ -ir_node *new_r_defaultProj(ir_node *block, ir_node *arg, long max_proj); - - -/** Constructor for a Tuple node. - * - * This is an auxiliary node to replace a node that returns a tuple - * without changing the corresponding Proj nodes. - * - * @param *block The IR block the node belongs to. - * @param arity The number of tuple elements. - * @param *in[] An array containing pointers to the nodes producing the tuple elements. - * The constructor copies this array. - */ -ir_node *new_r_Tuple(ir_node *block, int arity, ir_node *in[]); - -/** Constructor for a Id node. - * - * This is an auxiliary node to replace a node that returns a single - * value. - * - * @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_node *block, ir_node *val, ir_mode *mode); - -/** Constructor for a Bad node. - * - * Returns the unique Bad node of the graph. The same as - * get_irg_bad(). - * - * @param *irg The IR graph the node belongs to. - */ -ir_node *new_r_Bad(ir_graph *irg); - -/** Constructor for a Confirm node. - * - * Specifies constraints for a value. To support dataflow analyses. - * - * Example: If the value never exceeds '100' this is expressed by placing a - * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge. - * - * @param *block The IR block the node belong to. - * @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_node *block, ir_node *val, ir_node *bound, pn_Cmp cmp); - -/** Constructor for a Unknown node. - * - * Represents an arbitrary value. Places the node in - * the start block. - * - * @param *irg The IR graph the node belongs to. - * @param *m The mode of the unknown value. - */ -ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m); - -/** Constructor for a CallBegin node. - * - * CallBegin represents control flow depending of the pointer value - * representing the called method to the called methods. The - * constructor copies the method pointer input from the passed Call - * node. - * - * @param *block The block the node belong to. - * @param *callee The call node visible in the intra procedural view. - */ -ir_node *new_r_CallBegin(ir_node *block, ir_node *ptr, ir_node *call); - -/** Constructor for a EndReg node. - * - * Used to represent regular procedure end in interprocedual view. - * - * @param *irg The IR graph the node belong to. - * @param *block The block the node belong to. - */ -ir_node *new_r_EndReg(ir_graph *irg, ir_node *block); - -/** Constructor for a EndExcept node. - * - * Used to represent exceptional procedure end in interprocedural view. - * - * @param *irg The IR graph the node belong to. - * @param *block The block the node belong to. - */ -ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block); - -/** Constructor for a Break node. - * - * Break represents control flow to a single control successor just as Jmp. - * The blocks separated by a break may not be concatenated by an optimization. - * It is used for the interprocedural representation where blocks are parted - * behind Call nodes to represent the control flow to called procedures. - * - * @param *block The block the node belong to. - */ -ir_node *new_r_Break(ir_node *block); - -/** Constructor for a Filter node. - * - * Constructor for a Filter node. Adds the node to the block in current_ir_block. - * Filter is a node with two views used to construct the interprocedural view. - * In intraprocedural view its semantics are identical to the Proj node. - * In interprocedural view the Filter performs the Phi operation on method - * parameters or results. Other than a Phi a Filter node may not be removed - * if it has only a single input. - * - * The constructor builds the Filter in intraprocedural view. - * - * @param *block The block the node belong to. - * @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_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_r_NoMem(ir_graph *irg); - -/** Constructor for a Mux node. - * - * @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_node *block, ir_node *sel, - ir_node *ir_false, ir_node *ir_true, ir_mode *mode); - -/** Constructor for a CopyB node. - * - * @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_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 *block The block the node belong 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_node *block, ir_node *store, - ir_node *objptr, ir_type *type); - -/** Constructor for a Raise node. - * - * A High-Level Exception throw. - * - * @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_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 *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_node *block, ir_node *store, - ir_node *idx, ir_node *lower, ir_node *upper); - -/** Constructor for a Pin node. - * - * @param *block The block the node belong to. - * @param *node The node which value should be pinned. - */ -ir_node *new_r_Pin(ir_node *block, ir_node *node); - -/** Constructor for an ASM pseudo node. - * - * @param *block The block the node belong to. - * @param arity The number of data inputs to the node. - * @param *in The array of length arity of data inputs. - * @param *inputs The array of length arity of input constraints. - * @param n_outs The number of data outputs to the node. - * @param *outputs The array of length n_outs of output constraints. - * @param n_clobber The number of clobbered registers. - * @param *clobber The array of length n_clobber of clobbered registers. - * @param *asm_text The assembler text. - */ -ir_node *new_r_ASM(ir_node *block, - int arity, ir_node *in[], ir_asm_constraint *inputs, - int n_outs, ir_asm_constraint *outputs, - int n_clobber, ident *clobber[], ident *asm_text); - -/*-----------------------------------------------------------------------*/ -/* The block oriented interface */ -/*-----------------------------------------------------------------------*/ - -/** Sets the current block in which the following constructors place the - * 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. 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 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[]); - -/** Constructor for a Start node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - */ -ir_node *new_d_Start(dbg_info *db); - -/** Constructor for a End node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - */ -ir_node *new_d_End(dbg_info *db); - -/** Constructor for a Jmp node. - * - * Adds the node to the block in current_ir_block. - * - * Jmp represents control flow to a single control successor. - * - * @param *db A pointer for debug information. - */ -ir_node *new_d_Jmp(dbg_info *db); - -/** Constructor for 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. - * - * Adds the node to the block in current_ir_block. - * - * If c is mode_b represents a conditional branch (if/else). If c is - * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond - * node, default Proj is 0.) - * - * This is not consistent: Input to Cond is Is, Proj has as proj number - * longs. - * - * @param *db A pointer for debug information. - * @param *c The conditions parameter.Can be of mode b or I_u. - */ -ir_node *new_d_Cond(dbg_info *db, ir_node *c); - -/** Constructor for a Return node. - * - * Adds the node to the block in current_ir_block. - * - * Returns the memory and zero or more return values. Only node that - * can end regular control flow. - * - * @param *db A pointer for debug information. - * @param *store The state of memory. - * @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 Const_type node. - * - * Adds the node to the start block. - * - * The constant represents a target value. This constructor sets high - * level type information for the constant value. - * Derives mode from passed tarval. - * - * @param *db A pointer for debug information. - * @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, tarval *con, ir_type *tp); - -/** Constructor for a Const node. - * - * Adds the node to the block in current_ir_block. - * - * Constructor for a Const node. The constant represents a target - * value. Sets the type information to type_unknown. (No more - * supported: If tv is entity derives a somehow useful type.) - * Derives mode from passed tarval. - * - * @param *db A pointer for debug information. - * @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, tarval *con); - -/** Constructor for a SymConst_type node. - * - * This is the constructor for a symbolic constant. - * There are several kinds of symbolic constants: - * - symconst_type_tag The symbolic constant represents a type tag. The - * type the tag stands for is given explicitly. - * - symconst_type_size The symbolic constant represents the size of a type. - * The type of which the constant represents the size - * is given explicitly. - * - symconst_type_align The symbolic constant represents the alignment of a - * type. The type of which the constant represents the - * size is given explicitly. - * - symconst_addr_ent The symbolic constant represents the address of an - * entity (variable or method). The variable is given - * explicitly by a firm entity. - * - symconst_ofs_ent The symbolic constant represents the offset of an - * entity in its owner type. - * - symconst_enum_const The symbolic constant is a enumeration constant of - * an enumeration type. - * - * 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 mode The mode for the SymConst. - * @param value A type, ident, entity or enum constant depending on the - * SymConst kind. - * @param kind The kind of the symbolic constant, see the list above - * @param tp The source type of the constant. - */ -ir_node *new_d_SymConst_type(dbg_info *db, ir_mode *mode, - 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, ir_mode *mode, - union symconst_symbol value, symconst_kind kind); - -/** Constructor for a simpleSel node. - * - * This is a shortcut for the new_d_Sel() constructor. To be used for - * Sel nodes that do not select from an array, i.e., have no index - * inputs. It adds the two parameters 0, NULL. - * - * @param *db A pointer for debug information. - * @param *store The memory in which the object the entity should be - * selected from is allocated. - * @param *objptr The object from that the Sel operation selects a - * single attribute out. - * @param *ent The entity to select. - */ -ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent); - -/** Constructor for a Sel node. - * - * The select node selects an entity (field or method) from an entity - * with a compound type. It explicitly specifies the entity selected. - * Dynamically the node may select entities that overwrite the given - * entity. If the selected entity is an array element entity the Sel - * node takes the required array 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 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[], - ir_entity *ent); - -/** Constructor for a Call node. - * - * Represents all kinds of method and function calls. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *store The actual store. - * @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_d_Call(dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[], - ir_type *tp); - -/** Constructor for a Builtin node. - * - * Represents a call of a backend-specific builtin.. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *store The actual store. - * @param arity The number of procedure parameters. - * @param *in[] An array with the pointers to the parameters. The constructor copies this array. - * @param kind The kind of the called builtin. - * @param *tp Type information of the procedure called. - */ -ir_node *new_d_Builtin(dbg_info *db, ir_node *store, int arity, ir_node *in[], ir_builtin_kind kind, 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 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); - -/** 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 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); - -/** Constructor for a Minus node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *op The operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_d_Minus(dbg_info *db, ir_node *op, ir_mode *mode); - -/** Constructor for a Mul node. - * - * Adds the node to the block in current_ir_block. - * - * @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_Mul(dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Mulh 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_Mulh(dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Quot node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_d_Quot(dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a DivMod node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the results. - * @param state The pinned state. - */ -ir_node *new_d_DivMod(dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Div node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_d_Div(dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a remainderless Div node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_d_DivRL(dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Mod node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_d_Mod(dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Abs node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *op The operand - * @param *mode The mode of the operands and the result. - */ -ir_node *new_d_Abs(dbg_info *db, ir_node *op, ir_mode *mode); - -/** Constructor for a And node. - * - * Adds the node to the block in current_ir_block. - * - * @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_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 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); - -/** 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 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); - -/** Constructor for a Not node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *op The operand. - * @param *mode The mode of the operand and the result. - */ -ir_node *new_d_Not(dbg_info *db, ir_node *op, ir_mode *mode); - -/** Constructor for a Shl node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @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); - -/** Constructor for a Shr node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *op The operand. - * @param *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); - -/** Constructor for a Shrs node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *op The operand. - * @param *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); - -/** Constructor for a Rotl node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @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_Rotl(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 first operand. - * @param *op2 The second operand. - */ -ir_node *new_d_Cmp(dbg_info *db, ir_node *op1, ir_node *op2); - -/** Constructor for a Conv node. - * - * Adds the node to the block in current_ir_block. - * - * @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_strictConv(dbg_info *db, ir_node *op, ir_mode *mode); - -/** Constructor for a Cast node. - * - * High level type cast - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *op The operand. - * @param *to_tp The type of this the operand muss be casted . - */ -ir_node *new_d_Cast(dbg_info *db, ir_node *op, 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_Borrow(dbg_info *db, 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 *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); - -/** Constructor for a Load node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *store The current memory - * @param *addr A pointer to the variable to be read in this memory. - * @param *mode The mode of the value to be loaded. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_d_Load(dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags); - -/** Constructor for a Store node. - * - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *store The current memory - * @param *addr A pointer to the variable to be read in this memory. - * @param *val The value to write to this variable. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_d_Store(dbg_info *db, ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags); - -/** Constructor for a Alloc node. - * - * The Alloc node extends the memory by space for an entity of type alloc_type. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *store The memory which shall contain the new variable. - * @param *count The number of objects 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 *count, ir_type *alloc_type, - ir_where_alloc where); - - /** Constructor for a Free node. - * - * Frees the memory occupied by the entity pointed to by the pointer - * arg. Type indicates the type of the entity the argument points to. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *store The memory which shall contain the new variable. - * @param *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, - ir_type *free_type, ir_where_alloc where); - -/** Constructor for a Sync node. - * - * Merges several memory values. The node assumes that a variable - * either occurs only in one of the memories, or it contains the same - * value in all memories where it occurs. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param arity The number of memories to 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[]); - -/** 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 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); - -/** Constructor for a defaultProj node. - * - * Represents the default control flow of a Switch-Cond node. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param arg A node producing a tuple. - * @param max_proj The end position of the value in the tuple. - */ -ir_node *new_d_defaultProj(dbg_info *db, ir_node *arg, long max_proj); - -/** Constructor for a Tuple node. - * - * This is an auxiliary node to replace a node that returns a tuple - * without changing the corresponding Proj nodes. - * Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param arity The number of tuple elements. - * @param **in An array containing pointers to the nodes producing the tuple elements. - */ -ir_node *new_d_Tuple(dbg_info *db, int arity, ir_node *in[]); - -/** Constructor for a Id node. - * - * This is an auxiliary node to replace a node that returns a single - * value. Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *val The operand to Id. - * @param *mode The mode of *val. - */ -ir_node *new_d_Id(dbg_info *db, ir_node *val, ir_mode *mode); - -/** Constructor for a Confirm node. - * - * Constructor for a Confirm node. Adds the node to the block in current_ir_block. - * Specifies constraints for a value. To support dataflow analyses. - * - * Example: If the value never exceeds '100' this is expressed by placing a - * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge. - * - * @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_d_Confirm(dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp); - -/** Constructor for an Unknown node. - * - * Represents an arbitrary value. Places the node in - * the start block. - * - * @param *db A pointer for debug information. - * @param *m The mode of the unknown value. - */ -ir_node *new_d_Unknown(dbg_info *db, ir_mode *m); - -/** Constructor for a CallBegin node. - * - * CallBegin represents control flow depending of the pointer value - * representing the called method to the called methods. The - * constructor copies the method pointer input from the passed Call - * node.Adds the node to the block in current_ir_block. - * - * @param *db A pointer for debug information. - * @param *callee The call node visible in the intra procedural view. - */ -ir_node *new_d_CallBegin(dbg_info *db, ir_node *ptr, ir_node *call); - -/** 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 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 Break node. - * - * Used to represent exceptional procedure end in interprocedural view. - * Adds the node to the block in current_ir_block. - * - * Break represents control flow to a single control successor just as Jmp. - * The blocks separated by a break may not be concatenated by an optimization. - * It is used for the interprocedural representation where blocks are parted - * behind Call nodes to represent the control flow to called procedures. - * - * @param *db A pointer for debug information. - */ -ir_node *new_d_Break(dbg_info *db); - -/** Constructor for a Filter node. - * - * Constructor for a Filter node. Adds the node to the block in - * current_ir_block. Filter is a node with two views used to - * construct the interprocedural view. In intraprocedural view its - * semantics are identical to the Proj node. In interprocedural view - * the Filter performs the Phi operation on method parameters or - * results. Other than a Phi a Filter node may not be removed if it - * has only a single input. - * - * The constructor builds the Filter in intraprocedural view. - * - * @param *db A pointer for debug information. - * @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 Mux node. - * - * @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 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); - -/** Constructor for an ASM pseudo node. - * - * @param *db A pointer for debug information. - * @param arity The number of data inputs to the node. - * @param *in The array of length arity of data inputs. - * @param *inputs The array of length arity of input constraints. - * @param n_outs The number of data outputs to the node. - * @param *outputs The array of length n_outs of output constraints. - * @param n_clobber The number of clobbered registers. - * @param *clobber The array of length n_clobber of clobbered registers. - * @param *asm_text The assembler text. - */ -ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[], ir_asm_constraint *inputs, - int n_outs, ir_asm_constraint *outputs, - int n_clobber, ident *clobber[], ident *asm_text); - -/*-----------------------------------------------------------------------*/ -/* The block oriented interface without debug support */ -/*-----------------------------------------------------------------------*/ - -/* 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. 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 - * the array must be 'arity'. - */ -ir_node *new_Block(int arity, ir_node *in[]); - -/** Constructor for a Start node. - * - * Adds the node to the block in current_ir_block. - * - */ -ir_node *new_Start(void); - -/** Constructor for an End node. - * - * Adds the node to the block in current_ir_block. - */ -ir_node *new_End(void); - -/** 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); - -/** Constructor for an EndExpcept node. - * - * 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. - * - * 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. - */ -ir_node *new_Break(void); - -/** Constructor for a Cond node. - * - * If c is mode_b represents a conditional branch (if/else). If c is - * mode_Is/mode_Iu (?) represents a switch. (Allocates dense Cond - * node, default Proj is 0.). Adds the node to the block in current_ir_block. - * - * This is not consistent: Input to Cond is Is, Proj has as proj number - * longs. - * - * - * @param *c The conditions parameter.Can be of mode b or I_u. - */ -ir_node *new_Cond(ir_node *c); - -/** Constructor for a Return node. - * - * Returns the memory and zero or more return values. Only node that - * can end regular control flow. Adds the node to the block in current_ir_block. - * - * @param *store The state of memory. - * @param arity Number of array 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 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. - * Derives mode from passed tarval. - * - * @param *con Points to an entry in the constant table. This pointer is - * added to the attributes of the node. - */ -ir_node *new_Const(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. - * - * Derives mode from passed tarval. */ -ir_node *new_Const_type(tarval *con, ir_type *tp); - -/** Constructor for a SymConst_type node. - * - * This is the constructor for a symbolic constant. - * There are several kinds of symbolic constants: - * - symconst_type_tag The symbolic constant represents a type tag. The - * type the tag stands for is given explicitly. - * - symconst_type_size The symbolic constant represents the size of a type. - * The type of which the constant represents the size - * is given explicitly. - * - symconst_type_align The symbolic constant represents the alignment of a - * type. The type of which the constant represents the - * size is given explicitly. - * - symconst_addr_ent The symbolic constant represents the address of an - * entity (variable or method). The variable is given - * explicitly by a firm entity. - * - symconst_ofs_ent The symbolic constant represents the offset of an - * entity in its owner type. - * - symconst_enum_const The symbolic constant is a enumeration constant of - * an enumeration type. - * - * 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 mode The mode for the SymConst. - * @param value A type, ident, entity or enum constant depending on the - * SymConst kind. - * @param kind The kind of the symbolic constant, see the list above - * @param tp The source type of the constant. - */ -ir_node *new_SymConst_type(ir_mode *mode, union symconst_symbol value, symconst_kind kind, ir_type *tp); - -/** Constructor for a SymConst node. - * - * This is the constructor for a symbolic constant. - * There are several kinds of symbolic constants: - * - symconst_type_tag The symbolic constant represents a type tag. The - * type the tag stands for is given explicitly. - * - symconst_type_size The symbolic constant represents the size of a type. - * The type of which the constant represents the size - * is given explicitly. - * - symconst_type_align The symbolic constant represents the alignment of a - * type. The type of which the constant represents the - * size is given explicitly. - * - symconst_addr_ent The symbolic constant represents the address of an - * entity (variable or method). The variable is given - * explicitly by a firm entity. - * - symconst_ofs_ent The symbolic constant represents the offset of an - * entity in its owner type. - * - symconst_enum_const The symbolic constant is a enumeration constant of - * an enumeration type. - * - * 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 mode The mode for the SymConst. - * @param value A type, ident, entity or enum constant depending on the - * SymConst kind. - * @param kind The kind of the symbolic constant, see the list above - */ -ir_node *new_SymConst(ir_mode *mode, 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, ir_entity *ent); - -/** Constructor for a Sel node. - * - * The select node selects an entity (field or method) from an entity - * with a compound type. It explicitly specifies the entity selected. - * Dynamically the node may select entities that overwrite the given - * entity. If the selected entity is an array element entity the Sel - * node takes the required array 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 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[], - ir_entity *ent); - -/** Constructor for a Call node. - * - * Adds the node to the block in current_ir_block. - * Represents all kinds of method and function calls. - * - * @param *store The actual store. - * @param *callee A pointer to the called procedure. - * @param 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[], - ir_type *tp); - -/** Constructor for a Builtin node. - * - * Represents a call of a backend-specific builtin.. - * Represents all kinds of method and function calls. - * - * @param *store The actual store. - * @param kind The kind of the called builtin. - * @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_Builtin(ir_node *store, int arity, ir_node *in[], - ir_builtin_kind kind, ir_type *tp); - -/** Constructor for a CallBegin node. - * - * CallBegin represents control flow depending of the pointer value - * representing the called method to the called methods. The - * constructor copies the method pointer input from the passed Call - * node. Adds the node to the block in current_ir_block. - * - * @param *callee A pointer to the called procedure. - */ -ir_node *new_CallBegin(ir_node *ptr, ir_node *call); - -/** Constructor for a Add 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_Add(ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Sub node. - * - * Adds the node to the block in current_ir_block. - * - * @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); - -/** Constructor for a Minus node. - * - * Adds the node to the block in current_ir_block. - * - * @param *op The operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_Minus(ir_node *op, ir_mode *mode); - -/** - * Constructor for a Mul node. Adds the node to the block in current_ir_block. - * - * @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); - -/** - * Constructor for a Mulh 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_Mulh(ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Quot node. - * - * Adds the node to the block in current_ir_block. - * - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_Quot(ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a DivMod node. - * - * Adds the node to the block in current_ir_block. - * - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the results. - * @param state The pinned state. - */ -ir_node *new_DivMod(ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Div node. - * - * Adds the node to the block in current_ir_block. - * - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_Div(ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a remainderless Div node. - * - * Adds the node to the block in current_ir_block. - * - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_DivRL(ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Mod node. - * - * Adds the node to the block in current_ir_block. - * - * @param *memop The store needed to model exceptions - * @param *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the result. - * @param state The pinned state. - */ -ir_node *new_Mod(ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state); - -/** Constructor for a Abs node. - * - * Adds the node to the block in current_ir_block. - * - * @param *op The operand - * @param *mode The mode of the operands and the result. - */ -ir_node *new_Abs(ir_node *op, ir_mode *mode); - -/** Constructor for a And node. - * - * Adds the node to the block in current_ir_block. - * - * @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 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 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); - -/** Constructor for a Not node. - * - * Adds the node to the block in current_ir_block. - * - * @param *op The operand. - * @param *mode The mode of the operand and the result. - */ -ir_node *new_Not(ir_node *op, ir_mode *mode); - -/** Constructor for a Shl node. - * - * Adds the node to the block in current_ir_block. - * - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_Shl(ir_node *op, ir_node *k, ir_mode *mode); - -/** - * Constructor for a Shr node. Adds the node to the block in current_ir_block. - * - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. + * @param *block The block the node belong to. + * @param arity The number of data inputs to the node. + * @param *in The array of length arity of data inputs. + * @param *inputs The array of length arity of input constraints. + * @param n_outs The number of data outputs to the node. + * @param *outputs The array of length n_outs of output constraints. + * @param n_clobber The number of clobbered registers. + * @param *clobber The array of length n_clobber of clobbered registers. + * @param *asm_text The assembler text. */ -ir_node *new_Shr(ir_node *op, ir_node *k, ir_mode *mode); +FIRM_API ir_node *new_r_ASM(ir_node *block, + int arity, ir_node *in[], ir_asm_constraint *inputs, + int n_outs, ir_asm_constraint *outputs, + int n_clobber, ident *clobber[], ident *asm_text); -/** Constructor for a Shrs node. - * - * Adds the node to the block in current_ir_block. - * - * @param *op The operand. - * @param *k The number of bits to shift the operand . - * @param *mode The mode of the operand and the result. - */ -ir_node *new_Shrs(ir_node *op, ir_node *k, ir_mode *mode); +/*-----------------------------------------------------------------------*/ +/* The block oriented interface */ +/*-----------------------------------------------------------------------*/ -/** Constructor for a Rotl node. - * - * Adds the node to the block in current_ir_block. +/** Sets the current block in which the following constructors place the + * nodes they construct. * - * @param *op The operand. - * @param *k The number of bits to rotate the operand. - * @param *mode The mode of the operand. + * @param target The new current block. */ -ir_node *new_Rotl(ir_node *op, ir_node *k, ir_mode *mode); +FIRM_API void set_cur_block(ir_node *target); +FIRM_API void set_r_cur_block(ir_graph *irg, ir_node *target); -/** Constructor for a Cmp node. - * - * Adds the node to the block in current_ir_block. - * - * @param *op1 The first operand. - * @param *op2 The second operand. - */ -ir_node *new_Cmp(ir_node *op1, ir_node *op2); +/** Returns the current block of the current graph. */ +FIRM_API ir_node *get_cur_block(void); +FIRM_API ir_node *get_r_cur_block(ir_graph *irg); -/** Constructor for a Conv node. - * - * Adds the node to the block in current_ir_block. +/** + * @see new_rd_Const_long() * - * @param *op The operand. - * @param *mode The mode of this the operand muss be converted. + * @param *db A pointer for debug information. + * @param *mode The mode of the operands and results. + * @param value A value from which the tarval is made. */ -ir_node *new_Conv(ir_node *op, ir_mode *mode); +FIRM_API ir_node *new_d_Const_long(dbg_info *db, ir_mode *mode, long value); -/** Constructor for a strict Conv node. +/** 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 several kinds of symbolic constants: + * - symconst_type_tag The symbolic constant represents a type tag. The + * type the tag stands for is given explicitly. + * - symconst_type_size The symbolic constant represents the size of a type. + * The type of which the constant represents the size + * is given explicitly. + * - symconst_type_align The symbolic constant represents the alignment of a + * type. The type of which the constant represents the + * size is given explicitly. + * - symconst_addr_ent The symbolic constant represents the address of an + * entity (variable or method). The variable is given + * explicitly by a firm entity. + * - symconst_ofs_ent The symbolic constant represents the offset of an + * entity in its owner type. + * - symconst_enum_const The symbolic constant is a enumeration constant of + * an enumeration type. * - * @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. + * 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). * - * Adds the node to the block in current_ir_block. - * High level type cast + * Mention union in declaration so that the firmjni generator recognizes that + * it can not cast the argument to an int. * - * @param *op The operand. - * @param *to_tp The type of this the operand muss be casted . + * @param *db A pointer for debug information. + * @param mode The mode for the SymConst. + * @param value A type, ident, entity or enum constant depending on the + * SymConst kind. + * @param kind The kind of the symbolic constant, see the list above */ -ir_node *new_Cast(ir_node *op, ir_type *to_tp); +FIRM_API ir_node *new_d_SymConst(dbg_info *db, ir_mode *mode, + union symconst_symbol value, + symconst_kind kind); -/** Constructor for a Carry node. +/** 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 *op1 The first operand. - * @param *op2 The second operand. - * @param *mode The mode of the operands and the result. + * @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 *ent The entity to select. */ -ir_node *new_Carry(ir_node *op1, ir_node *op2, ir_mode *mode); - -/** Constructor for a Borrow node. +FIRM_API ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, + ir_entity *ent); +/** Constructor for a remainderless Div node. * * Adds the node to the block in current_ir_block. * + * @param *db A pointer for debug information. + * @param *memop The store needed to model exceptions * @param *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 *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 *addr A pointer to the variable to be read in this memory. - * @param *mode The mode of the value to be loaded. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_Load(ir_node *store, ir_node *addr, ir_mode *mode, ir_cons_flags flags); - -/** Constructor for a Store node. - * - * @param *store The current memory. - * @param *addr A pointer to the variable to be read in this memory. - * @param *val The value to write to this variable. - * @param flags Additional flags for alignment, volatility and pin state. - */ -ir_node *new_Store(ir_node *store, ir_node *addr, ir_node *val, ir_cons_flags flags); - -/** Constructor for a Alloc node. - * - * The Alloc node extends the memory by space for an entity of type alloc_type. - * Adds the node to the block in current_ir_block. - * - * @param *store The memory which shall contain the new variable. - * @param *count The number of objects 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 *count, ir_type *alloc_type, - ir_where_alloc where); - -/** Constructor for a Free node. - * - * Frees the memory occupied by the entity pointed to by the pointer - * arg. Type indicates the type of the entity the argument points to. - * Adds the node to the block in current_ir_block. - * - * @param *store The memory which shall contain the new variable. - * @param *ptr The pointer to the object to free. - * @param *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, - ir_type *free_type, ir_where_alloc where); - -/** 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 synchronize. - * @param **in An array of pointers to nodes that produce an output of type - * memory. The constructor copies this array. + * @param *mode The mode of the result. + * @param state The pinned state. */ -ir_node *new_Sync(int arity, ir_node *in[]); - -/** Constructor for a Proj node. +FIRM_API ir_node *new_d_DivRL(dbg_info *db, ir_node *memop, + ir_node *op1, ir_node *op2, ir_mode *mode, + op_pin_state state); +/** Constructor for a strict Conv node. * - * Projects a single value out of a tuple. The parameter proj gives the - * position of the value within the tuple. * Adds the node to the block in current_ir_block. * - * @param arg A node producing a tuple. - * @param *mode The mode of the value to project. - * @param proj The position of the value in the tuple. - */ -ir_node *new_Proj(ir_node *arg, ir_mode *mode, long proj); - -/** Constructor for a Filter node. - * - * Constructor for a Filter node. Adds the node to the block in current_ir_block. - * Filter is a node with two views used to construct the interprocedural view. - * In intraprocedural view its semantics are identical to the Proj node. - * In interprocedural view the Filter performs the Phi operation on method - * parameters or results. Other than a Phi a Filter node may not be removed - * if it has only a single input. - * - * The constructor builds the Filter in intraprocedural view. - * - * @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. + * @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_Filter(ir_node *arg, ir_mode *mode, long proj); +FIRM_API ir_node *new_d_strictConv(dbg_info *db, ir_node *op, ir_mode *mode); /** Constructor for a defaultProj node. * * Represents the default control flow of a Switch-Cond node. * Adds the node to the block in current_ir_block. * + * @param *db A pointer for debug information. * @param arg A node producing a tuple. * @param max_proj The end position of the value in the tuple. */ -ir_node *new_defaultProj(ir_node *arg, long max_proj); +FIRM_API ir_node *new_d_defaultProj(dbg_info *db, ir_node *arg, long max_proj); -/** Constructor for a Tuple node. - * - * This is an auxiliary node to replace a node that returns a tuple - * without changing the corresponding Proj nodes. - * Adds the node to the block in current_ir_block. +/** Constructor for an ASM pseudo node. * - * @param arity The number of tuple elements. - * @param **in An array containing pointers to the nodes producing the tuple elements. + * @param *db A pointer for debug information. + * @param arity The number of data inputs to the node. + * @param *in The array of length arity of data inputs. + * @param *inputs The array of length arity of input constraints. + * @param n_outs The number of data outputs to the node. + * @param *outputs The array of length n_outs of output constraints. + * @param n_clobber The number of clobbered registers. + * @param *clobber The array of length n_clobber of clobbered registers. + * @param *asm_text The assembler text. */ -ir_node *new_Tuple(int arity, ir_node *in[]); +FIRM_API ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[], + ir_asm_constraint *inputs, + int n_outs, ir_asm_constraint *outputs, + int n_clobber, ident *clobber[], ident *asm_text); -/** 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); +/*-----------------------------------------------------------------------*/ +/* The block oriented interface without debug support */ +/*-----------------------------------------------------------------------*/ -/** Constructor for a Bad node. - * - * Returns the unique Bad node of the graph. The same as - * get_irg_bad(). +/** + * 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_Bad(void); +FIRM_API ir_node *new_Const_long(ir_mode *mode, long value); -/** Constructor for a Confirm node. - * - * Specifies constraints for a value. To support dataflow analyses. - * Adds the node to the block in current_ir_block. - * - * Example: If the value never exceeds '100' this is expressed by placing a - * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge. +/** Constructor for a SymConst node. * - * @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 an Unknown node. + * This is the constructor for a symbolic constant. + * There are several kinds of symbolic constants: + * - symconst_type_tag The symbolic constant represents a type tag. The + * type the tag stands for is given explicitly. + * - symconst_type_size The symbolic constant represents the size of a type. + * The type of which the constant represents the size + * is given explicitly. + * - symconst_type_align The symbolic constant represents the alignment of a + * type. The type of which the constant represents the + * size is given explicitly. + * - symconst_addr_ent The symbolic constant represents the address of an + * entity (variable or method). The variable is given + * explicitly by a firm entity. + * - symconst_ofs_ent The symbolic constant represents the offset of an + * entity in its owner type. + * - symconst_enum_const The symbolic constant is a enumeration constant of + * an enumeration type. * - * Represents an arbitrary value. Places the node in - * the start block. + * 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 *m The mode of the unknown value. - */ -ir_node *new_Unknown(ir_mode *m); - -/** Constructor for a NoMem node. + * Mention union in declaration so that the firmjni generator recognizes that + * it can not cast the argument to an int. * - * Returns the unique NoMem node of the graph. The same as - * get_irg_no_mem(). + * @param mode The mode for the SymConst. + * @param value A type, ident, entity or enum constant depending on the + * SymConst kind. + * @param kind The kind of the symbolic constant, see the list above */ -ir_node *new_NoMem(void); +FIRM_API ir_node *new_SymConst(ir_mode *mode, union symconst_symbol value, + symconst_kind kind); -/** Constructor for a Mux node. +/** Constructor for a simpelSel node. * - * Adds the node to the block in current_ir_block. + * 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 *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). + * @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_Mux(ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode); +FIRM_API ir_node *new_simpleSel(ir_node *store, ir_node *objptr, + ir_entity *ent); -/** Constructor for a CopyB node. +/** Constructor for a remainderless Div 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. + * @param *memop The store needed to model exceptions + * @param *op1 The first operand. + * @param *op2 The second operand. + * @param *mode The mode of the result. + * @param state The pinned state. */ -ir_node *new_InstOf(ir_node *store, ir_node *objptr, ir_type *type); +FIRM_API ir_node *new_DivRL(ir_node *memop, ir_node *op1, ir_node *op2, + ir_mode *mode, op_pin_state state); -/**Constructor for a Raise node. +/** Constructor for a strict Conv node. * - * A High-Level Exception throw. + * Adds the node to the block in current_ir_block. * - * @param *store The current memory. - * @param *obj A pointer to the Except variable. + * @param *op The operand. + * @param *mode The mode of this the operand muss be converted. */ -ir_node *new_Raise(ir_node *store, ir_node *obj); +FIRM_API ir_node *new_strictConv(ir_node *op, ir_mode *mode); -/** Constructor for a Bound node. - * - * A High-Level bounds check. Checks whether lower <= idx && idx < upper. +/** 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 *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_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. + * @param arg A node producing a tuple. + * @param max_proj The end position of the value in the tuple. */ -ir_node *new_Pin(ir_node *node); +FIRM_API ir_node *new_defaultProj(ir_node *arg, long max_proj); /** Constructor for an ASM pseudo node. * @@ -4359,19 +1623,9 @@ ir_node *new_Pin(ir_node *node); * @param *clobber The array of length n_clobber of clobbered registers. * @param *asm_text The assembler text. */ -ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs, - int n_outs, ir_asm_constraint *outputs, - int n_clobber, ident *clobber[], ident *asm_text); - -/** Constructor for a Dummy node. - * - * @param *mode The mode of the node. - */ -ir_node *new_Dummy(ir_mode *mode); - -ir_node *new_r_Dummy(ir_graph *irg, ir_mode *mode); - -ir_node *new_rd_Dummy(dbg_info *db, ir_graph *irg, ir_mode *mode); +FIRM_API ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs, + int n_outs, ir_asm_constraint *outputs, + int n_clobber, ident *clobber[], ident *asm_text); /*---------------------------------------------------------------------*/ /* The comfortable interface. */ @@ -4390,30 +1644,16 @@ ir_node *new_rd_Dummy(dbg_info *db, ir_graph *irg, ir_mode *mode); * 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); - -/** Create an immature PartBlock. - * - * An immature block has only one Block or PartBlock predecessor. - * A PartBlock forms together with one BLock and possibly other - * PartBlocks a MacroBlock. - * - * Adds the PartBlock 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_immPartBlock(dbg_info *db, ir_node *pred_jmp); -ir_node *new_immPartBlock(ir_node *pred_jmp); +FIRM_API ir_node *new_d_immBlock(dbg_info *db); +FIRM_API ir_node *new_immBlock(void); +FIRM_API ir_node *new_r_immBlock(ir_graph *irg); +FIRM_API ir_node *new_rd_immBlock(dbg_info *db, ir_graph *irg); /** Add a control flow edge to an immature block. */ -void add_immBlock_pred(ir_node *immblock, ir_node *jmp); +FIRM_API void add_immBlock_pred(ir_node *immblock, ir_node *jmp); /** 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()); - +FIRM_API void mature_immBlock(ir_node *block); /** Get the current value of a local variable. * @@ -4421,12 +1661,22 @@ void mature_immBlock(ir_node *block); * 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); +FIRM_API ir_node *get_value(int pos, ir_mode *mode); +FIRM_API ir_node *get_r_value(ir_graph *irg, int pos, ir_mode *mode); + +/** + * Try to guess the mode of a local variable. + * This is done by recursively going up the control flow graph until + * we find a definition for the variable. The mode of the first found + * definition is returned. NULL in case no definition is found. + * + * @param pos The position/id of the local variable. + */ +FIRM_API ir_mode *ir_guess_mode(int pos); +FIRM_API ir_mode *ir_r_guess_mode(ir_graph *irg, int pos); /** Remark a new definition of a variable. * @@ -4438,19 +1688,19 @@ ir_node *get_value(int pos, ir_mode *mode); * @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); +FIRM_API void set_value(int pos, ir_node *value); +FIRM_API void set_r_value(ir_graph *irg, int pos, ir_node *value); -/** Find the value number for a node in the current block. +/** + * 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 searched value * - * @param *value The value to find. + * @return the value number of the value or -1 if this value has + * no value number in the current block. */ -int find_value(ir_node *value); +FIRM_API int find_value(ir_node *value); +FIRM_API int r_find_value(ir_graph *irg, ir_node *value); /** Get the current memory state. * @@ -4458,7 +1708,8 @@ int find_value(ir_node *value); * state. This call automatically inserts Phi nodes for the memory * state value. */ -ir_node *get_store(void); +FIRM_API ir_node *get_store(void); +FIRM_API ir_node *get_r_store(ir_graph *irg); /** Remark a new definition of the memory state. * @@ -4467,29 +1718,30 @@ ir_node *get_store(void); * * @param *store The new memory state. */ -void set_store(ir_node *store); +FIRM_API void set_store(ir_node *store); +FIRM_API void set_r_store(ir_graph *irg, ir_node *store); /** 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 */ -ir_type *get_cur_frame_type(void); - +FIRM_API void keep_alive(ir_node *ka); +FIRM_API void r_keep_alive(ir_graph *irg, ir_node *ka); /* --- initialize and finalize IR construction --- */ /** Puts the graph into state "phase_high" */ -#define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high) +FIRM_API void irg_finalize_cons(ir_graph *irg); /** 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); +FIRM_API void irp_finalize_cons(void); + +FIRM_API void ir_set_uninitialized_local_variable_func( + uninitialized_local_variable_func_t *func); -/* --- Initialization --- */ +#include "end.h" #endif