nsz Git - libfirm/blob - include/libfirm/ircons.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Various irnode constructors. Automatic construction of SSA
  23  *          representation.
  24  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Boris Boesler,
  25  *          Michael Beck
  26  * @version $Id$
  27  */
  28
  29 /**@todo
  30  Ideas for improvement:
  31  -# Handle construction of exceptions more comfortable:
  32     Add new constructors that pass the exception region (or better the
  33     Phi for the memories, the ex. region can be found from there) as parameter,
  34     constructor then adds all Proj nodes and returns the pointer
  35     to the Proj node that selects the result of the arithmetic operation.
  36  -# Maybe hide the exception region in a global variable, especially if
  37     it is always unambiguous.
  38 */
  39
  40 /**
  41  *  @file
  42  *
  43  *  documentation no more supported since 2001
  44  *
  45  *  IR node construction.
  46  *
  47  *    This file documents all datatypes and constructors needed to
  48  *    build a FIRM representation of a procedure.  The constructors are
  49  *    also implemented in this file.
  50  *
  51  *    The documentation also gives a short manual how to use the library.
  52  *
  53  *    For extensive documentation of FIRM see UKA Techreport 1999-14.
  54  *
  55  *
  56  *    Three kinds of nodes
  57  *    --------------------
  58  *
  59  *      There are three kinds of nodes known to the IR:  entities,
  60  *      types, and ir_nodes
  61  *
  62  *      + ir_nodes are the actual nodes of the FIRM intermediate representation.
  63  *        They represent operations on the data of the program and control flow
  64  *        operations.
  65  *
  66  *      + entity ==> implemented in entity.h
  67  *        Refers to a single entity of the compiled program, e.g. a field of a
  68  *        class or a method.  If a method or variable can not be assigned to
  69  *        a method or class or the like, it is a global object.
  70  *
  71  *      + types ==> implemented in type.h
  72  *        With types type information is represented.  There are several type
  73  *       nodes.
  74  *
  75  *    Implementation of the FIRM operations: ir_node
  76  *    ----------------------------------------------
  77  *
  78  *      Ir_nodes represent operations on the data of the program and control flow
  79  *      operations.  Examples of ir_nodes:  Add, Jmp, Cmp
  80  *
  81  *      FIRM is a dataflow graph.  A dataflow graph is a directed graph,
  82  *      so that every node has incoming and outgoing edges.  A node is
  83  *      executable if every input at it's incoming edges is available.
  84  *      Execution of the dataflow graph is started at the Start node which
  85  *      has no incoming edges and ends when the End node executes, even if
  86  *      there are still executable or not executed nodes.  (Is this true,
  87  *      or must all executable nodes be executed?)  (There are exceptions
  88  *      to the dataflow paradigma that all inputs have to be available
  89  *      before a node can execute: Phi, Block.  See UKA Techreport
  90  *      1999-14.)
  91  *
  92  *      The implementation of FIRM differs from the view as a dataflow
  93  *      graph.  To allow fast traversion of the graph edges are
  94  *      implemented as C-pointers.  Inputs to nodes are not ambiguous, the
  95  *      results can be used by several other nodes.  Each input can be
  96  *      implemented as a single pointer to a predecessor node, outputs
  97  *      need to be lists of pointers to successors.  Therefore a node
  98  *      contains pointers to it's predecessor so that the implementation is a
  99  *      dataflow graph with reversed edges.  It has to be traversed bottom
 100  *      up.
 101  *
 102  *      All nodes of the IR have the same basic structure.  They are
 103  *      distinguished by a field containing the opcode.
 104  *
 105  *      The fields of an ir_node:
 106  *
 107  *      kind             A firm_kind tag containing k_ir_node.  This is useful for
 108  *                       dynamically checking the type of a node.
 109  *
 110  *      *op              This ir_op gives the opcode as a tag and a string
 111  *                       and the number of attributes of an ir_node.  There is
 112  *                       one statically allocated struct ir_op for each opcode.
 113  *
 114  *      *mode            The ir_mode of the operation represented by this firm
 115  *                      node.  The mode of the operation is the mode of it's
 116  *                       result.  A Firm mode is a datatype as known to the target,
 117  *               not a type of the source language.
 118  *
 119  *      visit            A flag for traversing the IR.
 120  *
 121  *      **in             An array with pointers to the node's predecessors.
 122  *
 123  *      *link            A pointer to an ir_node.  With this pointer all Phi nodes
 124  *                       are attached to a Block, i.e., a Block points to it's
 125  *                       first Phi node, this node points to the second Phi node
 126  *                       in the Block and so fourth.  Used in mature_immBlock
 127  *                       to find all Phi nodes to be matured.  It's also used to
 128  *               annotate a node with a better, optimized version of it.
 129  *
 130  *      attr             An attr struct containing the attributes of the nodes. The
 131  *                       attributes depend on the opcode of the node.  The number
 132  *               of these attributes is given in op.
 133  *
 134  *    The struct ir_op
 135  *    ----------------
 136  *                       Not yet documented. See irop.h.
 137  *
 138  *    The struct ir_mode
 139  *    ------------------
 140  *                       Not yet documented. See irmode.h.
 141  *
 142  *    GLOBAL VARIABLES -- now also fields of ir_graph.
 143  *    ================
 144  *
 145  *    current_ir_graph   Points to the current ir_graph.  All constructors for
 146  *                      nodes add nodes to this graph.
 147  *
 148  *    ir_visited         An int used as flag to traverse the ir_graph.
 149  *
 150  *    block_visited      An int used as a flag to traverse block nodes in the
 151  *                       graph.
 152  *
 153  *                       Others not yet documented.
 154  *
 155  *
 156  *
 157  *    CONSTRUCTOR FOR IR_GRAPH --> see irgraph.h
 158  *    ========================
 159  *
 160  *
 161  *    PROCEDURE TO CONSTRUCT AN IR GRAPH --> see also Firm tutorial
 162  *    ==================================
 163  *
 164  *    This library supplies several interfaces to construct a FIRM graph for
 165  *    a program:
 166  *    - A "comfortable" interface generating SSA automatically.  Automatically
 167  *      computed predecessors of nodes need not be specified in the constructors.
 168  *      (new_<Node> constructurs and a set of additional routines.)
 169  *    - A less comfortable interface where all predecessors except the block
 170  *      an operation belongs to need to be specified.  SSA must be constructed
 171  *      by hand.  (new_<Node> constructors and set_cur_block()).  This interface
 172  *      is called "block oriented".  It automatically calles the local optimizations
 173  *      for each new node.
 174  *    - An even less comfortable interface where the block needs to be specified
 175  *      explicitly.  This is called the "raw" interface. (new_r_<Node>
 176  *      constructors).  These nodes are not optimized.
 177  *
 178  *    To use the functionality of the comfortable interface correctly the Front
 179  *    End needs to follow certain protocols.  This is explained in the following.
 180  *    To build a correct IR with the other interfaces study the semantics of
 181  *    the firm node (See tech-reprot UKA 1999-14).  For the construction of
 182  *    types and entities see the documentation in those modules.
 183  *
 184  *    First the Frontend needs to decide which variables and values used in
 185  *    a procedure can be represented by dataflow edges.  These are variables
 186  *    that need not be saved to memory as they cause no side effects visible
 187  *    out of the procedure.  Often these are all compiler generated
 188  *    variables and simple local variables of the procedure as integers,
 189  *    reals and pointers.  The frontend has to count and number these variables.
 190  *
 191  *    First an ir_graph needs to be constructed with new_ir_graph.  The
 192  *    constructor gets the number of local variables.  The graph is hold in the
 193  *    global variable irg.
 194  *
 195  *    Now the construction of the procedure can start.  Several basic blocks can
 196  *    be constructed in parallel, but the code within each block needs to
 197  *    be constructed (almost) in program order.
 198  *
 199  *    A global variable holds the current basic block.  All (non block) nodes
 200  *    generated are added to this block.  The current block can be set with
 201  *    set_cur_block(block).  If several blocks are constructed in parallel block
 202  *    switches need to be performed constantly.
 203  *
 204  *    To generate a Block node (with the comfortable interface), its predecessor
 205  *    control flow nodes need not be known.  In case of cyclic control flow these
 206  *    can not be known when the block is constructed.  With add_immBlock_pred(block,
 207  *    cfnode) predecessors can be added to the block.  If all predecessors are
 208  *    added to the block mature_immBlock(b) needs to be called.  Calling mature_immBlock
 209  *    early improves the efficiency of the Phi node construction algorithm.
 210  *    But if several  blocks are constructed at once, mature_immBlock must only
 211  *    be called after performing all set_values and set_stores in the block!
 212  *    (See documentation of new_immBlock constructor.)
 213  *
 214  *    The constructors of arithmetic nodes require that their predecessors
 215  *    are mentioned.  Sometimes these are available in the Frontend as the
 216  *    predecessors have just been generated by the frontend.  If they are local
 217  *    values the predecessors can be obtained from the library with a call to
 218  *    get_value(local_val_nr).  (local_val_nr needs to be administered by
 219  *    the Frontend.)  A call to get_value triggers the generation of Phi nodes.
 220  *    If an arithmetic operation produces a local value this value needs to be
 221  *    passed to the library by set_value(node, local_val_nr).
 222  *    In straight line code these two operations just remember and return the
 223  *    pointer to nodes producing the value.  If the value passes block boundaries
 224  *    Phi nodes can be inserted.
 225  *    Similar routines exist to manage the Memory operands: set_store and
 226  *    get_store.
 227  *
 228  *    Several nodes produce more than one result.  An example is the Div node.
 229  *    Such nodes return tuples of values.  From these individual values can be
 230  *    extracted by proj nodes.
 231  *
 232  *    The following example illustrates the construction of a simple basic block
 233  *    with two predecessors stored in variables cf_pred1 and cf_pred2, containing
 234  *    the code
 235  *      a = a div a;
 236  *    and finally jumping to an other block.  The variable a got the local_val_nr
 237  *    42 by the frontend.
 238  *
 239  *    ir_node *this_block, *cf_pred1, *cf_pred2, *a_val, *mem, *div, *res, *cf_op;
 240  *
 241  *    this_block = new_immBlock();
 242  *    add_immBlock_pred(this_block, cf_pred1);
 243  *    add_immBlock_pred(this_block, cf_pred2);
 244  *    mature_immBlock(this_block);
 245  *    a_val = get_value(42, mode_Iu);
 246  *    mem = get_store();
 247  *    div = new_Div(mem, a_val, a_val, mode_Iu);
 248  *    mem = new_Proj(div, mode_M, pn_Div_M);   * for the numbers for Proj see docu *
 249  *    res = new_Proj(div, mode_Iu, pn_Div_res);
 250  *    set_store(mem);
 251  *    set_value(res, 42);
 252  *    cf_op = new_Jmp();
 253  *
 254  *    For further information look at the documentation of the nodes and
 255  *    constructors and at the paragraph COPING WITH DATA OBJECTS at the
 256  *    end of this documentation.
 257  *
 258  *    The comfortable interface contains the following routines further explained
 259  *    below:
 260  *
 261  *    ir_node *new_immBlock (void);
 262  *    ir_node *new_Start    (void);
 263  *    ir_node *new_End      (void);
 264  *    ir_node *new_Jmp      (void);
 265  *    ir_node *new_IJmp     (ir_node *tgt);
 266  *    ir_node *new_Cond     (ir_node *c);
 267  *    ir_node *new_Return   (ir_node *store, int arity, ir_node **in);
 268  *    ir_node *new_Const    (tarval *con);
 269  *    ir_node *new_SymConst (ir_mode *mode, symconst_symbol value, symconst_kind kind);
 270  *    ir_node *new_simpleSel (ir_node *store, ir_node *objptr, ir_entity *ent);
 271  *    ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity,
 272  *                         ir_node **in, ir_entity *ent);
 273  *    ir_node *new_Call   (ir_node *store, ir_node *callee, int arity,
 274  *                 ir_node **in, type_method *type);
 275  *    ir_node *new_Add    (ir_node *op1, ir_node *op2, ir_mode *mode);
 276  *    ir_node *new_Sub    (ir_node *op1, ir_node *op2, ir_mode *mode);
 277  *    ir_node *new_Minus  (ir_node *op,  ir_mode *mode);
 278  *    ir_node *new_Mul    (ir_node *op1, ir_node *op2, ir_mode *mode);
 279  *    ir_node *new_Mulh   (ir_node *op1, ir_node *op2, ir_mode *mode);
 280  *    ir_node *new_Quot   (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
 281  *    ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
 282  *    ir_node *new_Div    (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
 283  *    ir_node *new_Mod    (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state;
 284  *    ir_node *new_Abs    (ir_node *op,                ir_mode *mode);
 285  *    ir_node *new_And    (ir_node *op1, ir_node *op2, ir_mode *mode);
 286  *    ir_node *new_Or     (ir_node *op1, ir_node *op2, ir_mode *mode);
 287  *    ir_node *new_Eor    (ir_node *op1, ir_node *op2, ir_mode *mode);
 288  *    ir_node *new_Not    (ir_node *op,                ir_mode *mode);
 289  *    ir_node *new_Shl    (ir_node *op,  ir_node *k,   ir_mode *mode);
 290  *    ir_node *new_Shr    (ir_node *op,  ir_node *k,   ir_mode *mode);
 291  *    ir_node *new_Shrs   (ir_node *op,  ir_node *k,   ir_mode *mode);
 292  *    ir_node *new_Rotl   (ir_node *op,  ir_node *k,   ir_mode *mode);
 293  *    ir_node *new_Cmp    (ir_node *op1, ir_node *op2);
 294  *    ir_node *new_Conv   (ir_node *op, ir_mode *mode);
 295  *    ir_node *new_Cast   (ir_node *op, ir_type *to_tp);
 296  *    ir_node *new_Carry  (ir_node *op1, ir_node *op2, ir_mode *mode);
 297  *    ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
 298  *    ir_node *new_Load   (ir_node *store, ir_node *addr, ir_mode *mode);
 299  *    ir_node *new_Store  (ir_node *store, ir_node *addr, ir_node *val);
 300  *    ir_node *new_Alloc  (ir_node *store, ir_node *size, ir_type *alloc_type,
 301  *                         where_alloc where);
 302  *    ir_node *new_Free   (ir_node *store, ir_node *ptr, ir_node *size,
 303  *               ir_type *free_type, where_alloc where);
 304  *    ir_node *new_Proj   (ir_node *arg, ir_mode *mode, long proj);
 305  *    ir_node *new_NoMem  (void);
 306  *    ir_node *new_Mux    (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
 307  *    ir_node *new_CopyB  (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
 308  *    ir_node *new_InstOf (ir_node *store, ir_node obj, ir_type *ent);
 309  *    ir_node *new_Raise  (ir_node *store, ir_node *obj);
 310  *    ir_node *new_Bound  (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
 311  *    ir_node *new_Pin    (ir_node *node);
 312  *
 313  *    void add_immBlock_pred (ir_node *block, ir_node *jmp);
 314  *    void mature_immBlock (ir_node *block);
 315  *    void set_cur_block (ir_node *target);
 316  *    ir_node *get_value (int pos, ir_mode *mode);
 317  *    void set_value (int pos, ir_node *value);
 318  *    ir_node *get_store (void);
 319  *    void set_store (ir_node *store);
 320  *    keep_alive (ir_node ka)
 321  *
 322  *    IR_NODES AND CONSTRUCTORS FOR IR_NODES
 323  *    =======================================
 324  *
 325  *    All ir_nodes are defined by a common data structure.  They are distinguished
 326  *    by their opcode and differ in the number of their attributes.
 327  *
 328  *    The constructor for the block node sets current_block to itself.
 329  *    Const nodes are always added to the start block.
 330  *    All other constructors add the created node to the current_block.
 331  *    swich_block(block) allows to set the current block to block.
 332  *
 333  *    Watch for my inconsistent use of input and predecessor (dataflow view)
 334  *    and `the node points to' (implementation view).
 335  *
 336  *    The following description of the nodes lists four properties them if these
 337  *    are of interest:
 338  *     - the parameters to the constructor
 339  *     - the inputs of the Firm node
 340  *     - the outputs of the Firm node
 341  *     - attributes to the node
 342  *
 343  *    ------------
 344  *
 345  *    ir_node *new_immBlock (void)
 346  *    ----------------------------
 347  *
 348  *    Creates a new block.  Sets current_block to itself.  When a new block is
 349  *    created it cannot be known how many predecessors this block will have in the
 350  *    control flow graph. Therefore the list of inputs can not be fixed at
 351  *    creation.  Predecessors can be added with add_immBlock_pred (block, control flow
 352  *    operation).  With every added predecessor the number of inputs to Phi nodes
 353  *    also changes.
 354  *
 355  *    The block can be completed by mature_immBlock(block) if all predecessors are
 356  *    known.  If several blocks are built at once, mature_immBlock can only be called
 357  *    after set_value has been called for all values that are life at the end
 358  *    of the block.  This is necessary so that Phi nodes created mature_immBlock
 359  *    get the right predecessors in case of cyclic dependencies.  If all set_values
 360  *    of this block are called after maturing it and before calling get_value
 361  *    in some block that is control flow dependent on this block, the construction
 362  *    is correct.
 363  *
 364  *    Example for faulty IR construction:  (draw the graph on a paper and you'll
 365  *                                          get it ;-)
 366  *
 367  *      block_before_loop = new_block();
 368  *      set_value(x);
 369  *      mature_immBlock(block_before_loop);
 370  *      before2header = new_Jmp;
 371  *
 372  *      loop_header = new_block ();
 373  *      header2body - new_Jmp();
 374  *
 375  *      loop_body = new_block ();
 376  *      body2header = new_Jmp();
 377  *
 378  *      add_immBlock_pred(loop_header, before2header);
 379  *      add_immBlock_pred(loop_header, body2header);
 380  *      add_immBlock_pred(loop_body, header2body);
 381  *
 382  *      mature_immBlock(loop_header);
 383  *      mature_immBlock(loop_body);
 384  *
 385  *      get_value(loop_body, x);   //  gets the Phi in loop_header
 386  *      set_value(loop_header, x); //  sets the value the above get_value should
 387  *                                 //  have returned!!!
 388  *
 389  *    Mature_immBlock also fixes the number of inputs to the Phi nodes.  Mature_immBlock
 390  *    should be called as early as possible, as afterwards the generation of Phi
 391  *   nodes is more efficient.
 392  *
 393  *    Inputs:
 394  *      There is an input for each control flow predecessor of the block.
 395  *      The input points to an instruction producing an output of type X.
 396  *      Possible predecessors:  Start, Jmp, Cond, Raise or Return or any node
 397  *      possibly causing an exception.  (Often the real predecessors are Projs.)
 398  *    Output:
 399  *      Mode BB (R), all nodes belonging to this block should consume this output.
 400  *      As they are strict (except Block and Phi node) it is a necessary condition
 401  *      that the block node executed before any other node in this block executes.
 402  *    Attributes:
 403  *      block.matured  Indicates whether the block is mature.
 404  *      block.**graph_arr
 405  *                      This attribute contains all local values valid in this
 406  *                      block. This is needed to build the Phi nodes and removed
 407  *                      if the graph is complete.  This field is used by the
 408  *              internal construction algorithm and should not be accessed
 409  *              from outside.
 410  *
 411  *
 412  *    ir_node *new_Block (int arity, ir_node **in)
 413  *    --------------------------------------------
 414  *
 415  *    Creates a new Block with the given list of predecessors.  This block
 416  *    is mature.  As other constructors calls optimization and vrfy for the
 417  *    block.  If one of the predecessors is Unknown (as it has to be filled in
 418  *    later) optimizations are skipped.  This is necessary to
 419  *    construct Blocks in loops.  Leaving Unknown in the Block after finishing
 420  *    the construction may have strange effects, especially for interprocedural
 421  *    representation and analysis.
 422  *
 423  *
 424  *    CONTROL FLOW OPERATIONS
 425  *    -----------------------
 426  *
 427  *    In each block there must be exactly one of the control flow
 428  *    operations Start, End, Jmp, Cond, Return or Raise.  The output of a
 429  *    control flow operation points to the block to be executed next.
 430  *
 431  *    ir_node *new_Start (void)
 432  *    -------------------------
 433  *
 434  *    Creates a start node.  Not actually needed public.  There is only one such
 435  *   node in each procedure which is automatically created by new_ir_graph.
 436  *
 437  *    Inputs:
 438  *      No inputs except the block it belogns to.
 439  *    Output:
 440  *      A tuple of 4 (5, 6) distinct values. These are labeled by the following
 441  *      projection numbers (pn_Start):
 442  *      * pn_Start_X_initial_exec    mode X, points to the first block to be exe *                                   cuted.
 443  *      * pn_Start_M                 mode M, the global store
 444  *      * pn_Start_P_frame_base      mode P, a pointer to the base of the proce  *                                   dures stack frame.
 445  *      * pn_Start_P_globals         mode P, a pointer to the part of the memory *                                   containing_all_ global things.
 446  *      * pn_Start_T_args            mode T, a tuple containing all arguments of *                                   the procedure.
 447  *
 448  *
 449  *    ir_node *new_End (void)
 450  *    -----------------------
 451  *
 452  *    Creates an end node.  Not actually needed public.  There is only one such
 453  *   node in each procedure which is automatically created by new_ir_graph.
 454  *
 455  *    Inputs:
 456  *      No inputs except the block it belongs to.
 457  *    Output:
 458  *      No output.
 459  *
 460  *    ir_node *new_Jmp (void)
 461  *    -----------------------
 462  *
 463  *    Creates a Jmp node.
 464  *
 465  *    Inputs:
 466  *      The block the node belongs to
 467  *    Output:
 468  *      Control flow to the next block.
 469  *
 470  *    ir_node *new_IJmp (ir_node *tgt)
 471  *    -----------------------
 472  *
 473  *    Creates an IJmp node.
 474  *
 475  *    Inputs:
 476  *      The node that represents the target jump address
 477  *    Output:
 478  *      Control flow to an unknown target, must be pinned by
 479  *      the End node.
 480  *
 481  *    ir_node *new_Cond (ir_node *c)
 482  *    ------------------------------
 483  *
 484  *    Creates a Cond node.  There are two versions of this node.
 485  *
 486  *    The Boolean Cond:
 487  *    Input:
 488  *      A value of mode b.
 489  *    Output:
 490  *      A tuple of two control flows.  The first is taken if the input is
 491  *      false, the second if it is true.
 492  *
 493  *    The Switch Cond:
 494  *    Input:
 495  *      A value of mode I_u. (i)
 496  *    Output:
 497  *      A tuple of n control flows.  If the Cond's input is i, control
 498  *      flow will procede along output i. If the input is >= n control
 499  *      flow proceeds along output n.
 500  *
 501  *    ir_node *new_Return (ir_node *store, int arity, ir_node **in)
 502  *    -------------------------------------------------------------
 503  *
 504  *    The return node has as inputs the results of the procedure.  It
 505  *    passes the control flow to the end_block.
 506  *
 507  *    Inputs:
 508  *      The memory state.
 509  *      All results.
 510  *    Output
 511  *      Control flow to the end block.
 512  *
 513  *    ---------
 514  *
 515  *    ir_node *new_Const (tarval *con)
 516  *    -----------------------------------------------
 517  *
 518  *    Creates a constant in the constant table and adds a Const node
 519  *    returning this value to the start block. The mode is derived
 520  *    from the tarval.
 521  *
 522  *    Parameters:
 523  *      *con             Points to an entry in the constant table.
 524  *                       This pointer is added to the attributes of
 525  *                       the node (self->attr.con)
 526  *    Inputs:
 527  *      No inputs except the block it belogns to.
 528  *    Output:
 529  *      The constant value.
 530  *    Attribute:
 531  *      attr.con   A tarval* pointer to the proper entry in the constant
 532  *                 table.
 533  *
 534  *    ir_node *new_SymConst (ir_mode *mode,union symconst_symbol value, symconst_addr_ent kind)
 535  *    -----------------------------------------------------------------------------------------
 536  *
 537  *    There are three five of symbolic constants:
 538  *     symconst_type_tag   The symbolic constant represents a type tag.
 539  *     symconst_type_size  The symbolic constant represents the size of a type.
 540  *     symconst_type_align The symbolic constant represents the alignment of a type.
 541  *     symconst_addr_name  Information for the linker, e.g. the name of a global
 542  *                         variable.
 543  *     symconst_addr_ent   The symbolic constant represents the address of an entity.
 544  *
 545  *    To represent a pointer to an entity that is represented by an entity
 546  *    datastructure don't use
 547  *      new_SymConst((type_or_id*)get_entity_ld_ident(ent), symconst_addr_name);.
 548  *    Use a real const instead:
 549  *      new_SymConst(ent, symconst_addr_ent);
 550  *    This makes the Constant independent of name changes of the entity due to
 551  *    mangling.
 552  *
 553  *    Parameters
 554  *      kind        The kind of the symbolic constant: type_tag, size or link_info.
 555  *      *type_or_id Points to the type the tag stands for or to the type
 556  *                  whose size is represented by the constant or to an ident
 557  *                  representing the linkage info.
 558  *
 559  *    Inputs:
 560  *      No inputs except the block it belongs to.
 561  *    Output:
 562  *      A symbolic constant.
 563  *
 564  *    Attributes:
 565  *      attr.i.num       The symconst_addr_ent, i.e. one of
 566  *                        -symconst_type_tag
 567  *                        -symconst_type_size
 568  *                        -symconst_type_align
 569  *                        -symconst_addr_name
 570  *                        -symconst_addr_ent
 571  *
 572  *    If the attr.i.num is symconst_type_tag, symconst_type_size or symconst_type_align,
 573  *    the node contains an attribute:
 574  *
 575  *      attr.i.*type,    a pointer to a type_class.
 576  *        if it is linkage_ptr_info it contains
 577  *      attr.i.*ptrinfo,  an ident holding information for the linker.
 578  *
 579  *    ---------------
 580  *
 581  *    ir_node *new_simpleSel (ir_node *store, ir_node *frame, ir_entity *sel)
 582  *    -----------------------------------------------------------------------
 583  *
 584  *
 585  *    Selects an entity from a compound type. This entity can be a field or
 586  *    a method.
 587  *
 588  *    Parameters:
 589  *      *store     The memory in which the object the entity should be selected
 590  *                 from is allocated.
 591  *      *frame     The pointer to the object.
 592  *      *sel       The entity to select.
 593  *
 594  *    Inputs:
 595  *      The memory containing the object.
 596  *      A pointer to the object.
 597  *      An unsigned integer.
 598  *    Output:
 599  *      A pointer to the selected entity.
 600  *    Attributes:
 601  *      attr.sel   Pointer to the entity
 602  *
 603  *
 604  *    ir_node *new_Sel (ir_node *store, ir_node *frame, int arity, ir_node **in,
 605  *    --------------------------------------------------------------------------
 606  *                      ir_entity *sel)
 607  *                      ---------------
 608  *
 609  *    Selects a field from an array type.  The entity has as owner the array, as
 610  *    type the arrays element type.  The indices to access an array element are
 611  *    given also.
 612  *
 613  *    Parameters:
 614  *      *store     The memory in which the object the entity should be selected from
 615  *                 is allocated.
 616  *      *frame     The pointer to the object.
 617  *      *arity     number of array indices.
 618  *      *in        array with index inputs to the node.
 619  *      *sel       The entity to select.
 620  *
 621  *    Inputs:
 622  *      The memory containing the object.
 623  *      A pointer to the object.
 624  *      As much unsigned integer as there are array expressions.
 625  *    Output:
 626  *      A pointer to the selected entity.
 627  *    Attributes:
 628  *      attr.sel   Pointer to the entity
 629  *
 630  *    The constructors new_Sel and new_simpleSel generate the same IR nodes.
 631  *    simpleSel just sets the arity of the index inputs to zero.
 632  *
 633  *
 634  *    ARITHMETIC OPERATIONS
 635  *    ---------------------
 636  *
 637  *    ir_node *new_Call (ir_node *store, ir_node *callee, int arity, ir_node **in,
 638  *    ----------------------------------------------------------------------------
 639  *                       type_method *type)
 640  *                       ------------------
 641  *
 642  *    Creates a procedure call.
 643  *
 644  *    Parameters
 645  *      *store           The actual store.
 646  *      *callee          A pointer to the called procedure.
 647  *      arity            The number of procedure parameters.
 648  *      **in             An array with the pointers to the parameters.
 649  *                       The constructor copies this array.
 650  *      *type            Type information of the procedure called.
 651  *
 652  *    Inputs:
 653  *      The store, the callee and the parameters.
 654  *    Output:
 655  *      A tuple containing the eventually changed store and the procedure
 656  *      results.
 657  *    Attributes:
 658  *      attr.call        Contains the type information for the procedure.
 659  *
 660  *
 661  *    ir_node *new_Add (ir_node *op1, ir_node *op2, ir_mode *mode)
 662  *    ------------------------------------------------------------
 663  *
 664  *    Trivial.
 665  *
 666  *    ir_node *new_Sub (ir_node *op1, ir_node *op2, ir_mode *mode)
 667  *    ------------------------------------------------------------
 668  *
 669  *    Trivial.
 670  *
 671  *    ir_node *new_Minus (ir_node *op, ir_mode *mode)
 672  *    -----------------------------------------------
 673  *
 674  *    Unary Minus operations on integer and floating point values.
 675  *
 676  *    ir_node *new_Mul (ir_node *op1, ir_node *op2, ir_mode *mode)
 677  *    ------------------------------------------------------------
 678  *
 679  *    Trivial.
 680  *
 681  *    ir_node *new_Mulh (ir_node *op1, ir_node *op2, ir_mode *mode)
 682  *    ------------------------------------------------------------
 683  *
 684  *    Returns the high order bits of a n*n=2n multiplication.
 685  *
 686  *    ir_node *new_Quot (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
 687  *    -------------------------------------------------------------------------------------------------
 688  *
 689  *    Quot performs exact division of floating point numbers.  It's mode
 690  *    is Tuple, the mode of the result must match the Proj mode
 691  *    that extracts the result of the arithmetic operations.
 692  *
 693  *    Inputs:
 694  *      The store needed to model exceptions and the two operands.
 695  *    Output:
 696  *      A tuple containing a memory and a execution for modeling exceptions
 697  *      and the result of the arithmetic operation.
 698  *
 699  *    ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
 700  *    ---------------------------------------------------------------------------------------------------
 701  *
 702  *    Performs Div and Mod on integer values.
 703  *
 704  *    Output:
 705  *      A tuple containing a memory and a execution for modeling exceptions
 706  *      and the two result of the arithmetic operations.
 707  *
 708  *    ir_node *new_Div (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
 709  *    ------------------------------------------------------------------------------------------------
 710  *
 711  *    Trivial.
 712  *
 713  *    ir_node *new_Mod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state)
 714  *    ------------------------------------------------------------------------------------------------
 715  *
 716  *    Trivial.
 717  *
 718  *    ir_node *new_Abs (ir_node *op, ir_mode *mode)
 719  *    ---------------------------------------------
 720  *
 721  *    Trivial.
 722  *
 723  *    ir_node *new_And (ir_node *op1, ir_node *op2, ir_mode *mode)
 724  *    ------------------------------------------------------------
 725  *
 726  *    Trivial.
 727  *
 728  *    ir_node *new_Or (ir_node *op1, ir_node *op2, ir_mode *mode)
 729  *    -----------------------------------------------------------
 730  *
 731  *    Trivial.
 732  *
 733  *    ir_node *new_Eor (ir_node *op1, ir_node *op2, ir_mode *mode)
 734  *    ------------------------------------------------------------
 735  *
 736  *    Trivial.
 737  *
 738  *    ir_node *new_Not (ir_node *op, ir_mode *mode)
 739  *    ---------------------------------------------
 740  *
 741  *    This node constructs a constant where all bits are set to one
 742  *    and a Eor of this constant and the operator.  This simulates a
 743  *    Not operation.
 744  *
 745  *    ir_node *new_Shl (ir_node *op, ir_node *k, ir_mode *mode)
 746  *    ---------------------------------------------------------
 747  *
 748  *    Trivial.
 749  *
 750  *    ir_node *new_Shr (ir_node *op, ir_node *k, ir_mode *mode)
 751  *    ---------------------------------------------------------
 752  *
 753  *    Logic shift right, i.e., zero extended.
 754  *
 755  *
 756  *    ir_node *new_Shrs (ir_node *op, ir_node *k, ir_mode *mode)
 757  *    ----------------------------------------------------------
 758  *
 759  *    Arithmetic shift right, i.e., sign extended.
 760  *
 761  *    ir_node *new_Rotl (ir_node *op, ir_node *k, ir_mode *mode)
 762  *    ---------------------------------------------------------
 763  *
 764  *    Rotates the operand to the left by k bits.
 765  *
 766  *    ir_node *new_Carry (ir_node *op1, ir_node *op2, ir_mode *mode)
 767  *    ------------------------------------------------------------
 768  *
 769  *    Calculates the Carry value for integer addition. Used only
 770  *    in lowering code.
 771  *
 772  *    ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode)
 773  *    ------------------------------------------------------------
 774  *
 775  *    Calculates the Borrow value for integer substraction. Used only
 776  *    in lowering code.
 777  *
 778  *    ir_node *new_Conv (ir_node *op, ir_mode *mode)
 779  *    ---------------------------------------------
 780  *
 781  *    Mode conversion.  For allowed conversions see UKA Tech Report
 782  *    1999-14.
 783  *
 784  *    ir_node *new_Cmp (ir_node *op1, ir_node *op2)
 785  *    ---------------------------------------------
 786  *
 787  *    Input:
 788  *      The two values to be compared.
 789  *    Output:
 790  *      A 16-tuple containing the results of the 16 different comparisons.
 791  *      The following is a list giving the comparisons and a projection
 792  *      number (pn_Cmp) to use in Proj nodes to extract the proper result.
 793  *        pn_Cmp_False false
 794  *        pn_Cmp_Eq    equal
 795  *        pn_Cmp_Lt    less
 796  *        pn_Cmp_Le    less or equal
 797  *        pn_Cmp_Gt    greater
 798  *        pn_Cmp_Ge    greater of equal
 799  *        pn_Cmp_Lg    less or greater
 800  *        pn_Cmp_Leg   less, equal or greater = ordered
 801  *        pn_Cmp_Uo    unordered
 802  *        pn_Cmp_Ue    unordered or equal
 803  *        pn_Cmp_Ul    unordered or less
 804  *        pn_Cmp_Ule   unordered, less or equal
 805  *        pn_Cmp_Ug    unordered or greater
 806  *        pn_Cmp_Uge   unordered, greater or equal
 807  *        pn_Cmp_Ne    unordered, less or greater = not equal
 808  *        pn_Cmp_True  true
 809  *
 810  *
 811  *
 812  *    ------------
 813  *
 814  *    In general, Phi nodes are automaitcally inserted.  In some cases, if
 815  *    all predecessors of a block are known, an explicit Phi node constructor
 816  *    is needed.  E.g., to construct a FIRM graph for a statement as
 817  *      a = (b==c) ? 2 : 5;
 818  *
 819  *    ir_node *new_Phi (int arity, ir_node **in, ir_mode *mode)
 820  *    ---------------------------------------------------------
 821  *
 822  *    Creates a Phi node. The in's order has to correspond to the order
 823  *    of in's of current_block.  This is not checked by the library!
 824  *    If one of the predecessors is Unknown (as it has to be filled in
 825  *    later) optimizations are skipped.  This is necessary to
 826  *    construct Phi nodes in loops.  Leaving Unknown in the Phi after finishing
 827  *    the construction may have strange effects, especially for interprocedural
 828  *    representation and analysis.
 829  *
 830  *    Parameter
 831  *      arity            number of predecessors
 832  *      **in             array with predecessors
 833  *      *mode            The mode of it's inputs and output.
 834  *    Inputs:
 835  *      A Phi node has as many inputs as the block it belongs to.
 836  *      Each input points to a definition of the same value on a
 837  *      different path in the control flow.
 838  *    Output
 839  *      The definition valid in this block.
 840  *
 841  *    ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode)
 842  *    -----------------------------------------------------------------------------
 843  *
 844  *    Creates a Mux node. This node implements the following semantic:
 845  *    If the sel node (which must be of mode_b) evaluates to true, its value is
 846  *    ir_true, else ir_false;
 847  *
 848  *
 849  *
 850  *    OPERATIONS TO MANAGE MEMORY EXPLICITLY
 851  *    --------------------------------------
 852  *
 853  *    ir_node *new_Load (ir_node *store, ir_node *addr, ir_mode *mode)
 854  *    ----------------------------------------------------------------
 855  *
 856  *    The Load operation reads a value from memory.
 857  *
 858  *    Parameters:
 859  *    *store        The current memory.
 860  *    *addr         A pointer to the variable to be read in this memory.
 861  *    *mode         The mode of the value to be loaded.
 862  *
 863  *    Inputs:
 864  *      The memory and a pointer to a variable in this memory.
 865  *    Output:
 866  *      A tuple of the memory, a control flow to be taken in case of
 867  *      an exception and the loaded value.
 868  *
 869  *    ir_node *new_Store (ir_node *store, ir_node *addr, ir_node *val)
 870  *    ----------------------------------------------------------------
 871  *
 872  *    The Store operation writes a value to a variable in memory.
 873  *
 874  *    Inputs:
 875  *      The memory, a pointer to a variable in this memory and the value
 876  *      to write to this variable.
 877  *    Output:
 878  *      A tuple of the changed memory and a control flow to be taken in
 879  *      case of an exception.
 880  *
 881  *    ir_node *new_Alloc (ir_node *store, ir_node *size, ir_type *alloc_type,
 882  *    -----------------------------------------------------------------------
 883  *                        where_alloc where)
 884  *                        ------------------
 885  *
 886  *    The Alloc node allocates a new variable.  It can be specified whether the
 887  *    variable should be allocated to the stack or to the heap.
 888  *
 889  *    Parameters:
 890  *      *store       The memory which shall contain the new variable.
 891  *      **    *size        The number of bytes to allocate. Old. **
 892  *      *size        We decided that the size easily can be derived from the type.
 893  *                   This field is for allocating arrays, i.e., it gives the multiple
 894  *           of the size of alloc_type to allocate memory for.
 895  *      *alloc_type  The type of the allocated variable.
 896  *      where        Where to allocate the variable, either heap_alloc or stack_alloc.
 897  *
 898  *    Inputs:
 899  *      A memory and an unsigned integer.
 900  *    Output:
 901  *      A tuple of the changed memory, a control flow to be taken in
 902  *      case of an exception and the pointer to the new variable.
 903  *    Attributes:
 904  *      a.where          Indicates where the variable is allocated.
 905  *      a.*type          A pointer to the class the allocated data object
 906  *                       belongs to.
 907  *
 908  *    ir_node *new_Free (ir_node *store, ir_node *ptr, ir_node *size, ir_type *free_type,
 909  *    -----------------------------------------------------------------------------------
 910  *                        where_alloc where)
 911  *                        ------------------
 912  *
 913  *    The Free node frees memory of the given variable.
 914  *
 915  *    Parameters:
 916  *      *store       The memory which shall contain the new variable.
 917  *      *ptr         The pointer to the object to free.
 918  *      *size        The number of objects of type free_type to free in a sequence.
 919  *      *free_type   The type of the freed variable.
 920  *      where        Where the variable was allocated, either heap_alloc or stack_alloc.
 921  *
 922  *    Inputs:
 923  *      A memory, a pointer and an unsigned integer.
 924  *    Output:
 925  *      The changed memory.
 926  *    Attributes:
 927  *      f.*type          A pointer to the type information of the freed data object.
 928  *
 929  *    Not Implemented!
 930  *
 931  *    ir_node *new_Sync (int arity, ir_node **in)
 932  *    -------------------------------------------
 933  *
 934  *    The Sync operation unifies several partial memory blocks.  These blocks
 935  *    have to be pairwise disjunct or the values in common locations have to
 936  *    be identical.  This operation allows to specify all operations that eventually
 937  *    need several partial memory blocks as input with a single entrance by
 938  *    unifying the memories with a preceding Sync operation.
 939  *
 940  *    Parameters
 941  *      arity    The number of memories to synchronize.
 942  *      **in     An array of pointers to nodes that produce an output of
 943  *               type memory.
 944  *    Inputs
 945  *      Several memories.
 946  *    Output
 947  *      The unified memory.
 948  *
 949  *
 950  *    SPECIAL OPERATIONS
 951  *    ------------------
 952  *
 953  *    ir_node *new_Bad (void)
 954  *    -----------------------
 955  *
 956  *    Returns the unique Bad node current_ir_graph->bad.
 957  *    This node is used to express results of dead code elimination.
 958  *
 959  *    ir_node *new_NoMem (void)
 960  *    -----------------------------------------------------------------------------------
 961  *
 962  *    Returns the unique NoMem node current_ir_graph->no_mem.
 963  *    This node is used as input for operations that need a Memory, but do not
 964  *    change it like Div by const != 0, analyzed calls etc.
 965  *
 966  *    ir_node *new_Proj (ir_node *arg, ir_mode *mode, long proj)
 967  *    ----------------------------------------------------------
 968  *
 969  *    Selects one entry of a tuple.  This is a hidden edge with attributes.
 970  *
 971  *    Parameters
 972  *      *arg      A node producing a tuple.
 973  *      *mode     The mode of the value to project.
 974  *      proj      The position of the value in the tuple.
 975  *    Input:
 976  *      The tuple.
 977  *    Output:
 978  *      The value.
 979  *
 980  *    ir_node *new_Tuple (int arity, ir_node **in)
 981  *    --------------------------------------------
 982  *
 983  *    Builds a Tuple from single values.  This is needed to implement
 984  *    optimizations that remove a node that produced a tuple.  The node can be
 985  *    replaced by the Tuple operation so that the following Proj nodes have not to
 986  *    be changed.  (They are hard to find due to the implementation with pointers
 987  *    in only one direction.)  The Tuple node is smaller than any other
 988  *    node, so that a node can be changed into a Tuple by just changing it's
 989  *    opcode and giving it a new in array.
 990  *
 991  *    Parameters
 992  *      arity    The number of tuple elements.
 993  *      **in     An array containing pointers to the nodes producing the
 994  *               tuple elements.
 995  *
 996  *    ir_node *new_Id (ir_node *val, ir_mode *mode)
 997  *    ---------------------------------------------
 998  *
 999  *    The single output of the Id operation is it's input.  Also needed
1000  *    for optimizations.
1001  *
1002  *
1003  *    HIGH LEVEL OPERATIONS
1004  *    ---------------------
1005  *
1006  *    ir_node *new_CopyB (ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type)
1007  *    -----------------------------------------------------------------------------------
1008  *
1009  *    Describes a high level block copy of a compound type from address src to
1010  *    address dst. Must be lowered to a Call to a runtime memory copy function.
1011  *
1012  *
1013  *    HIGH LEVEL OPERATIONS: Exception Support
1014  *    ----------------------------------------
1015  *    See TechReport 1999-14, chapter Exceptions.
1016  *
1017  *    ir_node *new_InstOf(ir_node *store, ir_node *ptr, ir_type *type);
1018  *    -----------------------------------------------------------------------------------
1019  *
1020  *    Describes a high level type check. Must be lowered to a Call to a runtime check
1021  *    function.
1022  *
1023  *    ir_node *new_Raise (ir_node *store, ir_node *obj)
1024  *    -------------------------------------------------
1025  *
1026  *    Raises an exception.  Unconditional change of control flow.  Writes
1027  *    an explicit Except variable to memory to pass it to the exception
1028  *    handler.  Must be lowered to a Call to a runtime check
1029  *    function.
1030  *
1031  *    Inputs:
1032  *      The memory state.
1033  *      A pointer to the Except variable.
1034  *    Output:
1035  *      A tuple of control flow and the changed memory state.  The control flow
1036  *      points to the exception handler if it is definied in this procedure,
1037  *      else it points to the end_block.
1038  *
1039  *    ir_node *new_Bound  (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
1040  *    -----------------------------------------------------------------------------------
1041  *
1042  *    Describes a high level bounds check. Must be lowered to a Call to a runtime check
1043  *    function.
1044  *
1045  *    ir_node *new_Pin  (ir_node *node);
1046  *    -----------------------------------------------------------------------------------
1047  *
1048  *    Pin the value of the node node in the current block  No users of the Pin node can
1049  *    float above the Block of the Pin. The node cannot float behind this block. Often
1050  *    used to Pin the NoMem node.
1051  *
1052  *
1053  *    COPING WITH DATA OBJECTS
1054  *    ========================
1055  *
1056  *    Two kinds of data objects have to be distinguished for generating
1057  *    FIRM.  First there are local variables other than arrays that are
1058  *    known to be alias free.  Second there are all other data objects.
1059  *    For the first a common SSA representation is built, the second
1060  *    are modeled by saving them to memory.  The memory is treated as
1061  *    a single local variable, the alias problem is hidden in the
1062  *    content of this variable.
1063  *
1064  *    All values known in a Block are listed in the block's attribute,
1065  *    block.**graph_arr which is used to automatically insert Phi nodes.
1066  *    The following two functions can be used to add a newly computed value
1067  *    to the array, or to get the producer of a value, i.e., the current
1068  *    live value.
1069  *
1070  *    inline void set_value (int pos, ir_node *value)
1071  *    -----------------------------------------------
1072  *
1073  *    Has to be called for every assignment to a local variable.  It
1074  *    adds the value to the array of used values at position pos.  Pos
1075  *    has to be a unique identifier for an entry in the procedure's
1076  *    definition table.  It can be used to access the value again.
1077  *    Requires current_block to be set correctly.
1078  *
1079  *    ir_node *get_value (int pos, ir_mode *mode)
1080  *    -------------------------------------------
1081  *
1082  *    Returns the node defining the value referred to by pos. If the
1083  *    value is not defined in this block a Phi node is generated and
1084  *    all definitions reaching this Phi node are collected.  It can
1085  *    happen that the algorithm allocates an unnecessary Phi node,
1086  *    e.g. if there is only one definition of this value, but this
1087  *    definition reaches the currend block on several different
1088  *    paths.  This Phi node will be eliminated if optimizations are
1089  *    turned on right after it's creation.
1090  *    Requires current_block to be set correctly.
1091  *
1092  *    There are two special routines for the global store:
1093  *
1094  *    void set_store (ir_node *store)
1095  *    -------------------------------
1096  *
1097  *    Adds the store to the array of known values at a reserved
1098  *    position.
1099  *    Requires current_block to be set correctly.
1100  *
1101  *    ir_node *get_store (void)
1102  *    -------------------------
1103  *
1104  *    Returns the node defining the actual store.
1105  *    Requires current_block to be set correctly.
1106  *
1107  *
1108  *    inline void keep_alive (ir_node *ka)
1109  *    ------------------------------------
1110  *
1111  *    Keep this node alive because it is (might be) not in the control
1112  *    flow from Start to End.  Adds the node to the list in the end
1113  *   node.
1114  *
1115  */
1116 #ifndef FIRM_IR_IRCONS_H
1117 #define FIRM_IR_IRCONS_H
1118
1119 #include "firm_types.h"
1120
1121 /*-------------------------------------------------------------------------*/
1122 /* The raw interface                                                       */
1123 /*-------------------------------------------------------------------------*/
1124
1125 /** Constructor for a Block node.
1126  *
1127  * Constructs a mature block with the given predecessors.  Use Unknown
1128  * nodes as predecessors to construct a block if the number of
1129  * predecessors is known, but not the predecessors themselves.  This
1130  * constructor does not set current_block.  It not be used with
1131  * automatic Phi node construction.
1132  *
1133  * @param *db    A Pointer for  debug information.
1134  * @param irg    The IR graph the block belongs to.
1135  * @param arity  The number of control predecessors.
1136  * @param in[]   An array of control predecessors.  The length of
1137  *               the array must be 'arity'.  The constructor copies this array.
1138  */
1139 ir_node *new_rd_Block  (dbg_info *db, ir_graph *irg,  int arity, ir_node *in[]);
1140
1141 /** Constructor for a Start node.
1142  *
1143  * @param *db    A pointer for debug information.
1144  * @param *irg   The IR graph the node belongs to.
1145  * @param *block The IR block the node belongs to.
1146  */
1147 ir_node *new_rd_Start  (dbg_info *db, ir_graph *irg, ir_node *block);
1148
1149 /** Constructor for a End node.
1150  *
1151  * @param *db    A pointer for  debug information.
1152  * @param *irg   The IR graph the node  belongs to.
1153  * @param *block The IR block the node belongs to.
1154  */
1155 ir_node *new_rd_End    (dbg_info *db, ir_graph *irg, ir_node *block);
1156
1157 /** Constructor for a Jmp node.
1158  *
1159  * Jmp represents control flow to a single control successor.
1160  *
1161  * @param *db     A pointer for debug information.
1162  * @param *irg    The IR graph the node belongs to.
1163  * @param *block  The IR block the node belongs to.
1164  */
1165 ir_node *new_rd_Jmp    (dbg_info *db, ir_graph *irg, ir_node *block);
1166
1167 /** Constructor for an IJmp node.
1168  *
1169  * IJmp represents control flow to a single control successor not
1170  * statically known i.e. an indirect Jmp.
1171  *
1172  * @param *db     A pointer for debug information.
1173  * @param *irg    The IR graph the node belongs to.
1174  * @param *block  The IR block the node belongs to.
1175  * @param *tgt    The IR node representing the target address.
1176  */
1177 ir_node *new_rd_IJmp   (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *tgt);
1178
1179 /** Constructor for a Break node.
1180  *
1181  * Break represents control flow to a single control successor just as Jmp.
1182  * The blocks separated by a break may not be concatenated by an optimization.
1183  * It is used for the interprocedural representation where blocks are parted
1184  * behind Call nodes to represent the control flow to called procedures.
1185  *
1186  * @param *db     A pointer for debug information.
1187  * @param *irg    The IR graph the node belong to.
1188  * @param *block  The block the node belong to.
1189  */
1190 ir_node *new_rd_Break  (dbg_info *db, ir_graph *irg, ir_node *block);
1191
1192 /** Constructor for a Cond node.
1193  *
1194  * If c is mode_b represents a conditional branch (if/else). If c is
1195  * mode_Is/mode_Iu (?) represents a switch.  (Allocates dense Cond
1196  * node, default Proj is 0.)
1197  *
1198  * This is not consistent:  Input to Cond is Is, Proj has as proj number
1199  * longs.
1200  *
1201  * @param *db    A pointer for debug information.
1202  * @param *irg   The IR graph the node  belongs to.
1203  * @param *block The IR block the node belongs to.
1204  * @param *c     The conditions parameter. Can be of mode b or I_u.
1205  */
1206 ir_node *new_rd_Cond   (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *c);
1207
1208 /** Constructor for a Return node.
1209  *
1210  * Returns the memory and zero or more return values.  Only node that
1211  * can end regular control flow.
1212  *
1213  * @param *db    A pointer for debug information.
1214  * @param *irg   The IR graph the node  belongs to.
1215  * @param *block The IR block the node belongs to.
1216  * @param *store The state of memory.
1217  * @param arity  Number of return values.
1218  * @param *in    Array of length arity with return values.  The constructor copies this array.
1219  */
1220 ir_node *new_rd_Return (dbg_info *db, ir_graph *irg, ir_node *block,
1221                         ir_node *store, int arity, ir_node *in[]);
1222
1223 /** Constructor for a Const_type node.
1224  *
1225  * Adds the node to the start block.
1226  *
1227  * The constant represents a target value.  This constructor sets high
1228  * level type information for the constant value.
1229  * Derives mode from passed tarval.
1230  *
1231  * @param *db    A pointer for debug information.
1232  * @param *irg   The IR graph the node  belongs to.
1233  * @param *con   Points to an entry in the constant table.
1234  * @param *tp    The type of the constant.
1235  */
1236 ir_node *new_rd_Const_type (dbg_info *db, ir_graph *irg,
1237                             tarval *con, ir_type *tp);
1238
1239 /** Constructor for a Const node.
1240  *
1241  * Adds the node to the start block.
1242  *
1243  * Constructor for a Const node. The constant represents a target
1244  * value.  Sets the type information to type_unknown.  (No more
1245  * supported: If tv is entity derives a somehow useful type.)
1246  * Derives mode from passed tarval.
1247  *
1248  * @param *db    A pointer for debug information.
1249  * @param *irg   The IR graph the node  belongs to.
1250  * @param *con   Points to an entry in the constant table.
1251  */
1252 ir_node *new_rd_Const  (dbg_info *db, ir_graph *irg, tarval *con);
1253
1254 /** Constructor for a Const node.
1255  *
1256  * Adds the node to the start block.
1257  *
1258  * Constructor for a Const node. The constant represents a target
1259  * value.  Sets the type information to type_unknown.  (No more
1260  * supported: If tv is entity derives a somehow useful type.)
1261  *
1262  * @param *db    A pointer for debug information.
1263  * @param *irg   The IR graph the node  belongs to.
1264  * @param *mode  The mode of the operands and results.
1265  * @param value  A value from which the tarval is made.
1266  */
1267 ir_node *new_rd_Const_long (dbg_info *db, ir_graph *irg,
1268                                     ir_mode *mode, long value);
1269
1270 /** Constructor for a SymConst_type node.
1271  *
1272  *  This is the constructor for a symbolic constant.
1273  *    There are four kinds of symbolic constants:
1274  *    - type_tag   The symbolic constant represents a type tag.  The type the
1275  *                 tag stands for is given explicitly.
1276  *    - type_size  The symbolic constant represents the size of a type.  The
1277  *                 type of which the constant represents the size is given
1278  *                 explicitly.
1279  *    - type_align The symbolic constant represents the alignment of a type.  The
1280  *                 type of which the constant represents the size is given
1281  *                 explicitly.
1282  *    - addr_name  The symbolic constant represents the address of an entity
1283  *                 (variable or method).  The variable is indicated by a name
1284  *                 that is valid for linking.
1285  *    - addr_ent   The symbolic constant represents the address of an entity
1286  *                 (variable or method).  The variable is given explicitly by
1287  *                 a firm entity.
1288  *
1289  *    Inputs to the node:
1290  *      No inputs except the block it belongs to.
1291  *    Outputs of the node.
1292  *      An unsigned integer (I_u) or a pointer (P).
1293  *
1294  *    Mention union in declaration so that the firmjni generator recognizes that
1295  *    it can not cast the argument to an int.
1296  *
1297  * @param *db     A pointer for debug information.
1298  * @param *irg    The IR graph the node  belongs to.
1299  * @param *block  The IR block the node belongs to.
1300  * @param mode    The mode for the SymConst.
1301  * @param symkind The kind of the symbolic constant: type_tag, size, addr_name or addr_ent.
1302  * @param value   A type, entity or a ident depending on the SymConst kind.
1303  * @param tp      The source type of the constant.
1304  */
1305 ir_node *new_rd_SymConst_type(dbg_info *db, ir_graph *irg, ir_node *block, ir_mode *mode,
1306                               union symconst_symbol value,
1307                               symconst_kind symkind, ir_type *tp);
1308
1309 /** Constructor for a SymConst node.
1310  *
1311  *  Same as new_rd_SymConst_type, except that it sets the type to type_unknown.
1312  */
1313 ir_node *new_rd_SymConst(dbg_info *db, ir_graph *irg, ir_node *block, ir_mode *mode,
1314                          union symconst_symbol value, symconst_kind symkind);
1315
1316 /** Constructor for a SymConst addr_ent node.
1317  *
1318  * Same as new_rd_SymConst_type, except that the constructor is tailored for
1319  * symconst_addr_ent.
1320  * Adds the SymConst to the start block of irg. */
1321 ir_node *new_rd_SymConst_addr_ent(dbg_info *db, ir_graph *irg, ir_mode *mode,
1322                                   ir_entity *symbol, ir_type *tp);
1323
1324 /** Constructor for a SymConst ofs_ent node.
1325  *
1326  * Same as new_rd_SymConst_type, except that the constructor is tailored for
1327  * symconst_ofs_ent.
1328  * Adds the SymConst to the start block of irg.
1329  */
1330 ir_node *new_rd_SymConst_ofs_ent(dbg_info *db, ir_graph *irg, ir_mode *mode,
1331                                  ir_entity *symbol, ir_type *tp);
1332
1333 /** Constructor for a SymConst addr_name node.
1334  *
1335  * Same as new_rd_SymConst_type, except that the constructor is tailored for
1336  * symconst_addr_ent.
1337  * Adds the SymConst to the start block of irg.
1338  */
1339 ir_node *new_rd_SymConst_addr_name(dbg_info *db, ir_graph *irg, ir_mode *mode,
1340                                    ident *symbol, ir_type *tp);
1341
1342 /** Constructor for a SymConst type_tag node.
1343  *
1344  * Same as new_rd_SymConst_type, except that the constructor is tailored for
1345  * symconst_addr_ent.
1346  * Adds the SymConst to the start block of irg.
1347  */
1348 ir_node *new_rd_SymConst_type_tag(dbg_info *db, ir_graph *irg, ir_mode *mode,
1349                                   ir_type *symbol, ir_type *tp);
1350
1351 /** Constructor for a SymConst size node.
1352  *
1353  * Same as new_rd_SymConst_type, except that the constructor is tailored for
1354  * symconst_type_size.
1355  * Adds the SymConst to the start block of irg. */
1356 ir_node *new_rd_SymConst_size(dbg_info *db, ir_graph *irg, ir_mode *mode,
1357                               ir_type *symbol, ir_type *tp);
1358
1359 /** Constructor for a SymConst size node.
1360  *
1361  * Same as new_rd_SymConst_type, except that the constructor is tailored for
1362  * symconst_type_align.
1363  * Adds the SymConst to the start block of irg.
1364  */
1365 ir_node *new_rd_SymConst_align(dbg_info *db, ir_graph *irg, ir_mode *mode,
1366                                ir_type *symbol, ir_type *tp);
1367
1368 /** Constructor for a simpleSel node.
1369  *
1370  *  This is a shortcut for the new_rd_Sel() constructor.  To be used for
1371  *  Sel nodes that do not select from an array, i.e., have no index
1372  *  inputs.  It adds the two parameters 0, NULL.
1373  *
1374  * @param   *db        A pointer for debug information.
1375  * @param   *irg       The IR graph the node  belongs to.
1376  * @param   *block     The IR block the node belongs to.
1377  * @param   *store     The memory in which the object the entity should be
1378  *                     selected from is allocated.
1379  * @param   *objptr    The object from that the Sel operation selects a
1380  *                     single attribute out.
1381  * @param   *ent       The entity to select.
1382  */
1383 ir_node *new_rd_simpleSel (dbg_info *db, ir_graph *irg, ir_node *block,
1384                            ir_node *store, ir_node *objptr, ir_entity *ent);
1385
1386 /** Constructor for a Sel node.
1387  *
1388  * The select node selects an entity (field or method) from an entity
1389  * with a compound type.  It explicitly specifies the entity selected.
1390  * Dynamically the node may select entities that overwrite the given
1391  * entity.  If the selected entity is an array element entity the Sel
1392  * node takes the required array indices as inputs.
1393  *
1394  * @param   *db        A pointer for debug information.
1395  * @param   *irg       The IR graph the node  belongs to.
1396  * @param   *block     The IR block the node belongs to.
1397  * @param   *store     The memory in which the object the entity should be selected
1398  *                     from is allocated.
1399  * @param   *objptr    A pointer to a compound entity the Sel operation selects a
1400  *                     single attribute from.
1401  * @param   *n_index   The number of array indices needed to select an array element entity.
1402  * @param   *index[]   If the compound entity is an array the indices of the selected
1403  *                     element entity.  The constructor copies this array.
1404  * @param   *ent       The entity to select.
1405  */
1406 ir_node *new_rd_Sel    (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1407                                     ir_node *objptr, int n_index, ir_node *index[], ir_entity *ent);
1408
1409 /** Constructor for a Call node.
1410  *
1411  *  Represents all kinds of method and function calls.
1412  *
1413  * @param   *db     A pointer for debug information.
1414  * @param   *irg    The IR graph the node  belongs to.
1415  * @param   *block  The IR block the node belongs to.
1416  * @param   *store  The current memory state.
1417  * @param   *callee A pointer to the called procedure.
1418  * @param   arity   The number of procedure parameters.
1419  * @param   *in[]   An array with the procedure parameters. The constructor copies this array.
1420  * @param   *tp     Type information of the procedure called.
1421  */
1422 ir_node *new_rd_Call   (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1423                                     ir_node *callee, int arity, ir_node *in[], ir_type *tp);
1424
1425 /** Constructor for a Add node.
1426  *
1427  * @param   *db    A pointer for debug information.
1428  * @param   *irg   The IR graph the node  belongs to.
1429  * @param   *block The IR block the node belongs to.
1430  * @param   *op1   The first operand.
1431  * @param   *op2   The second operand.
1432  * @param   *mode  The mode of the operands and the result.
1433  */
1434 ir_node *new_rd_Add    (dbg_info *db, ir_graph *irg, ir_node *block,
1435                                     ir_node *op1, ir_node *op2, ir_mode *mode);
1436
1437 /** Constructor for a Sub node.
1438  *
1439  * @param   *db    A pointer for debug information.
1440  * @param   *irg   The IR graph the node  belongs to.
1441  * @param   *block The IR block the node belongs to.
1442  * @param   *op1   The first operand.
1443  * @param   *op2   The second operand.
1444  * @param   *mode  The mode of the operands and the result.
1445  */
1446 ir_node *new_rd_Sub    (dbg_info *db, ir_graph *irg, ir_node *block,
1447                                     ir_node *op1, ir_node *op2, ir_mode *mode);
1448
1449 /** Constructor for a Minus node.
1450  *
1451  * @param   *db    A pointer for debug information.
1452  * @param   *irg   The IR graph the node  belongs to.
1453  * @param   *block The IR block the node belongs to.
1454  * @param   *op    The operand .
1455  * @param   *mode  The mode of the operand and the result.
1456  */
1457 ir_node *new_rd_Minus  (dbg_info *db, ir_graph *irg, ir_node *block,
1458                         ir_node *op,  ir_mode *mode);
1459
1460 /** Constructor for a Mul node.
1461  *
1462  * @param   *db    A pointer for debug information.
1463  * @param   *irg   The IR graph the node  belongs to.
1464  * @param   *block The IR block the node belongs to.
1465  * @param   *op1   The first operand.
1466  * @param   *op2   The second operand.
1467  * @param   *mode  The mode of the operands and the result.
1468  */
1469 ir_node *new_rd_Mul    (dbg_info *db, ir_graph *irg, ir_node *block,
1470                ir_node *op1, ir_node *op2, ir_mode *mode);
1471
1472 /** Constructor for a Mulh node.
1473  *
1474  * @param   *db    A pointer for debug information.
1475  * @param   *irg   The IR graph the node  belongs to.
1476  * @param   *block The IR block the node belongs to.
1477  * @param   *op1   The first operand.
1478  * @param   *op2   The second operand.
1479  * @param   *mode  The mode of the operands and the result.
1480  */
1481 ir_node *new_rd_Mulh   (dbg_info *db, ir_graph *irg, ir_node *block,
1482                ir_node *op1, ir_node *op2, ir_mode *mode);
1483
1484 /** Constructor for a Quot node.
1485  *
1486  * @param   *db    A pointer for debug information.
1487  * @param   *irg   The IR graph the node  belongs to.
1488  * @param   *block The IR block the node belongs to.
1489  * @param   *memop The store needed to model exceptions
1490  * @param   *op1   The first operand.
1491  * @param   *op2   The second operand.
1492  * @param   *mode  The mode of the result.
1493  * @param   state  The pinned state.
1494  */
1495 ir_node *new_rd_Quot   (dbg_info *db, ir_graph *irg, ir_node *block,
1496                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1497
1498 /** Constructor for a DivMod node.
1499  *
1500  * @param   *db    A pointer for debug information.
1501  * @param   *irg   The IR graph the node  belongs to.
1502  * @param   *block The IR block the node belongs to.
1503  * @param   *memop The store needed to model exceptions
1504  * @param   *op1   The first operand.
1505  * @param   *op2   The second operand.
1506  * @param   *mode  The mode of the results.
1507  * @param   state  The pinned state.
1508  */
1509 ir_node *new_rd_DivMod (dbg_info *db, ir_graph *irg, ir_node *block,
1510                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1511
1512 /** Constructor for a Div node.
1513  *
1514  * @param   *db    A pointer for debug information.
1515  * @param   *irg   The IR graph the node  belongs to.
1516  * @param   *block The IR block the node belongs to.
1517  * @param   *memop The store needed to model exceptions
1518  * @param   *op1   The first operand.
1519  * @param   *op2   The second operand.
1520  * @param   *mode  The mode of the result.
1521  * @param   state  The pinned state.
1522  */
1523 ir_node *new_rd_Div    (dbg_info *db, ir_graph *irg, ir_node *block,
1524                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1525
1526 /** Constructor for a remainderless Div node.
1527  *
1528  * @param   *db    A pointer for debug information.
1529  * @param   *irg   The IR graph the node  belongs to.
1530  * @param   *block The IR block the node belongs to.
1531  * @param   *memop The store needed to model exceptions
1532  * @param   *op1   The first operand.
1533  * @param   *op2   The second operand.
1534  * @param   *mode  The mode of the result.
1535  * @param   state  The pinned state.
1536  */
1537 ir_node *new_rd_DivRL  (dbg_info *db, ir_graph *irg, ir_node *block,
1538                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1539
1540 /** Constructor for a Mod node.
1541  *
1542  * @param   *db    A pointer for debug information.
1543  * @param   *irg   The IR graph the node  belongs to.
1544  * @param   *block The IR block the node belongs to.
1545  * @param   *memop The store needed to model exceptions
1546  * @param   *op1   The first operand.
1547  * @param   *op2   The second operand.
1548  * @param   *mode  The mode of the result.
1549  * @param   state  The pinned state.
1550  */
1551 ir_node *new_rd_Mod    (dbg_info *db, ir_graph *irg, ir_node *block,
1552                         ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
1553
1554 /** Constructor for a Abs node.
1555  *
1556  * @param   *db    A pointer for debug information.
1557  * @param   *irg   The IR graph the node  belongs to.
1558  * @param   *block The IR block the node belongs to.
1559  * @param   *op    The operand
1560  * @param   *mode  The mode of the operands and the result.
1561  */
1562 ir_node *new_rd_Abs    (dbg_info *db, ir_graph *irg, ir_node *block,
1563                        ir_node *op, ir_mode *mode);
1564
1565 /** Constructor for a And node.
1566  *
1567  * @param   *db    A pointer for debug information.
1568  * @param   *irg   The IR graph the node  belongs to.
1569  * @param   *block The IR block the node belongs to.
1570  * @param   *op1   The first operand.
1571  * @param   *op2   The second operand.
1572  * @param   *mode  The mode of the operands and the result.
1573  */
1574 ir_node *new_rd_And    (dbg_info *db, ir_graph *irg, ir_node *block,
1575                         ir_node *op1, ir_node *op2, ir_mode *mode);
1576
1577 /** Constructor for a Or node.
1578  *
1579  * @param   *db    A pointer for debug information.
1580  * @param   *irg   The IR graph the node  belongs to.
1581  * @param   *block The IR block the node belongs to.
1582  * @param   *op1   The first operand.
1583  * @param   *op2   The second operand.
1584  * @param   *mode  The mode of the operands and the result.
1585  */
1586 ir_node *new_rd_Or     (dbg_info *db, ir_graph *irg, ir_node *block,
1587                         ir_node *op1, ir_node *op2, ir_mode *mode);
1588
1589 /** Constructor for a Eor node.
1590  *
1591  * @param   *db    A pointer for debug information.
1592  * @param   *irg   The IR graph the node  belongs to.
1593  * @param   *block The IR block the node belongs to.
1594  * @param   *op1   The first operand.
1595  * @param   *op2   The second operand.
1596  * @param   *mode  The mode of the operands and the results.
1597  */
1598 ir_node *new_rd_Eor    (dbg_info *db, ir_graph *irg, ir_node *block,
1599                         ir_node *op1, ir_node *op2, ir_mode *mode);
1600
1601 /** Constructor for a Not node.
1602  *
1603  * @param   *db    A pointer for debug information.
1604  * @param   *irg   The IR graph the node  belongs to.
1605  * @param   *block The IR block the node belongs to.
1606  * @param   *op    The operand.
1607  * @param   *mode  The mode of the operand and the result.
1608  */
1609 ir_node *new_rd_Not    (dbg_info *db, ir_graph *irg, ir_node *block,
1610                ir_node *op, ir_mode *mode);
1611
1612 /** Constructor for a Cmp node.
1613  *
1614  * @param   *db    A pointer for debug information.
1615  * @param   *irg   The IR graph the node  belongs to.
1616  * @param   *block The IR block the node belongs to.
1617  * @param   *op1   The first operand.
1618  * @param   *op2   The second operand.
1619  */
1620 ir_node *new_rd_Cmp    (dbg_info *db, ir_graph *irg, ir_node *block,
1621                ir_node *op1, ir_node *op2);
1622
1623 /** Constructor for a Shl node.
1624  *
1625  * @param   *db    A pointer for debug information.
1626  * @param   *irg   The IR graph the node  belongs to.
1627  * @param   *block The IR block the node belongs to.
1628  * @param   *op    The operand.
1629  * @param   *k     The number of bits to  shift the operand .
1630  * @param   *mode  The mode of the operand and the result.
1631  */
1632 ir_node *new_rd_Shl    (dbg_info *db, ir_graph *irg, ir_node *block,
1633                ir_node *op, ir_node *k, ir_mode *mode);
1634
1635 /** Constructor for a Shr node.
1636  *
1637  * @param   *db    A pointer for debug information.
1638  * @param   *irg   The IR graph the node  belongs to.
1639  * @param   *block The IR block the node belongs to.
1640  * @param   *op    The operand.
1641  * @param   *k     The number of bits to shift the operand .
1642  * @param   *mode  The mode of the operand and the result.
1643  */
1644 ir_node *new_rd_Shr    (dbg_info *db, ir_graph *irg, ir_node *block,
1645                ir_node *op, ir_node *k, ir_mode *mode);
1646
1647 /** Constructor for a Shrs node.
1648  *
1649  * @param   *db    A pointer for debug information.
1650  * @param   *irg   The IR graph the node  belongs to.
1651  * @param   *block The IR block the node belongs to.
1652  * @param   *op    The operand.
1653  * @param   *k     The number of bits to shift the operand.
1654  * @param   *mode  The mode of the operand and the result.
1655  */
1656 ir_node *new_rd_Shrs   (dbg_info *db, ir_graph *irg, ir_node *block,
1657                ir_node *op, ir_node *k, ir_mode *mode);
1658
1659 /** Constructor for a Rotl node.
1660  *
1661  * @param   *db    A pointer for debug information.
1662  * @param   *irg   The IR graph the node  belongs to.
1663  * @param   *block The IR block the node belongs to.
1664  * @param   *op    The operand.
1665  * @param   *k     The number of bits to rotate the operand.
1666  * @param   *mode  The mode of the operand.
1667  */
1668 ir_node *new_rd_Rotl    (dbg_info *db, ir_graph *irg, ir_node *block,
1669                ir_node *op, ir_node *k, ir_mode *mode);
1670
1671
1672 /** Constructor for a Conv node.
1673  *
1674  * @param   *db    A pointer for debug information.
1675  * @param   *irg   The IR graph the node  belongs to.
1676  * @param   *block The IR block the node belongs to.
1677  * @param   *op    The operand.
1678  * @param   *mode  The mode of this the operand muss be converted .
1679  */
1680 ir_node *new_rd_Conv   (dbg_info *db, ir_graph *irg, ir_node *block,
1681                ir_node *op, ir_mode *mode);
1682
1683 /** Constructor for a Cast node.
1684  *
1685  * High level type cast.
1686  *
1687  * @param   *db    A pointer for debug information.
1688  * @param   *irg   The IR graph the node  belongs to.
1689  * @param   *block The IR block the node belongs to.
1690  * @param   *op    The operand.
1691  * @param   *to_tp The type of this the operand muss be casted .
1692  */
1693 ir_node *new_rd_Cast   (dbg_info *db, ir_graph *irg, ir_node *block,
1694                         ir_node *op, ir_type *to_tp);
1695
1696 /** Constructor for a Carry node.
1697  *
1698  * @param   *db    A pointer for debug information.
1699  * @param   *irg   The IR graph the node  belongs to.
1700  * @param   *block The IR block the node belongs to.
1701  * @param   *op1   The first operand.
1702  * @param   *op2   The second operand.
1703  * @param   *mode  The mode of the operands and the result.
1704  */
1705 ir_node *new_rd_Carry  (dbg_info *db, ir_graph *irg, ir_node *block,
1706                         ir_node *op1, ir_node *op2, ir_mode *mode);
1707
1708 /** Constructor for a Borrow node.
1709  *
1710  * @param   *db    A pointer for debug information.
1711  * @param   *irg   The IR graph the node  belongs to.
1712  * @param   *block The IR block the node belongs to.
1713  * @param   *op1   The first operand.
1714  * @param   *op2   The second operand.
1715  * @param   *mode  The mode of the operands and the result.
1716  */
1717 ir_node *new_rd_Borrow (dbg_info *db, ir_graph *irg, ir_node *block,
1718                         ir_node *op1, ir_node *op2, ir_mode *mode);
1719
1720 /** Constructor for a Phi node.
1721  *
1722  * @param *db    A pointer for debug information.
1723  * @param *irg   The IR graph the node  belongs to.
1724  * @param *block The IR block the node belongs to.
1725  * @param arity  The number of predecessors
1726  * @param *in[]  Array with predecessors.  The constructor copies this array.
1727  * @param *mode  The mode of it's inputs and output.
1728  */
1729 ir_node *new_rd_Phi    (dbg_info *db, ir_graph *irg, ir_node *block, int arity,
1730                         ir_node *in[], ir_mode *mode);
1731
1732 /** Constructor for a Load node.
1733  *
1734  * @param *db    A pointer for debug information.
1735  * @param *irg   The IR graph the node  belongs to.
1736  * @param *block The IR block the node belongs to.
1737  * @param *store The current memory
1738  * @param *adr   A pointer to the variable to be read in this memory.
1739  * @param *mode  The mode of the value to be loaded.
1740  */
1741 ir_node *new_rd_Load   (dbg_info *db, ir_graph *irg, ir_node *block,
1742                         ir_node *store, ir_node *adr, ir_mode *mode);
1743
1744 /** Constructor for a Store node.
1745  *
1746  * @param *db    A pointer for debug information.
1747  * @param *irg   The IR graph the node  belongs to.
1748  * @param *block The IR block the node belongs to.
1749  * @param *store The current memory
1750  * @param *adr   A pointer to the variable to be read in this memory.
1751  * @param *val   The value to write to this variable.
1752  */
1753 ir_node *new_rd_Store  (dbg_info *db, ir_graph *irg, ir_node *block,
1754                ir_node *store, ir_node *adr, ir_node *val);
1755
1756 /** Constructor for a Alloc node.
1757  *
1758  * The Alloc node extends the memory by space for an entity of type alloc_type.
1759  *
1760  * @param *db         A pointer for debug information.
1761  * @param *irg        The IR graph the node  belongs to.
1762  * @param *block      The IR block the node belongs to.
1763  * @param *store      The memory which shall contain the new variable.
1764  * @param *size       The number of bytes to allocate.
1765  * @param *alloc_type The type of the allocated variable.
1766  * @param where       Where to allocate the variable, either heap_alloc or stack_alloc.
1767  */
1768 ir_node *new_rd_Alloc  (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1769                ir_node *size, ir_type *alloc_type, ir_where_alloc where);
1770
1771 /** Constructor for a Free node.
1772  *
1773  * Frees the memory occupied by the entity pointed to by the pointer
1774  * arg.  Type indicates the type of the entity the argument points to.
1775  *
1776  * @param *db         A pointer for debug information.
1777  * @param *irg        The IR graph the node  belongs to.
1778  * @param *block      The IR block the node belongs to.
1779  * @param *store      The memory which shall contain the new variable.
1780  * @param *ptr        The pointer to the object to free.
1781  * @param *size       The number of objects of type free_type to free in a sequence.
1782  * @param *free_type  The type of the freed variable.
1783  * @param where       Where the variable was allocated, either heap_alloc or stack_alloc.
1784  */
1785 ir_node *new_rd_Free   (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1786                         ir_node *ptr, ir_node *size, ir_type *free_type, ir_where_alloc where);
1787
1788 /** Constructor for a Sync node.
1789  *
1790  * Merges several memory values.  The node assumes that a variable
1791  * either occurs only in one of the memories, or it contains the same
1792  * value in all memories where it occurs.
1793  *
1794  * @param *db       A pointer for debug information.
1795  * @param *irg      The IR graph the node  belongs to.
1796  * @param *block    The IR block the node belongs to.
1797  * @param  arity    The number of memories to synchronize.
1798  * @param  *in[]    An array of pointers to nodes that produce an output of type
1799  *                  memory.  The constructor copies this array.
1800  */
1801 ir_node *new_rd_Sync   (dbg_info *db, ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
1802
1803 /** Constructor for a Proj node.
1804  *
1805  * Projects a single value out of a tuple.  The parameter proj gives the
1806  * position of the value within the tuple.
1807  *
1808  * @param *db    A pointer for debug information.
1809  * @param *irg   The IR graph the node  belongs to.
1810  * @param *block The IR block the node belongs to.
1811  * @param arg    A node producing a tuple.  The node must have mode_T.
1812  * @param *mode  The mode of the value to project.
1813  * @param proj   The position of the value in the tuple.
1814  */
1815 ir_node *new_rd_Proj   (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1816                         ir_mode *mode, long proj);
1817
1818 /** Constructor for a defaultProj node.
1819  *
1820  * Represents the default control flow of a Switch-Cond node.
1821  *
1822  * @param *db       A pointer for debug information.
1823  * @param *irg      The IR graph the node  belongs to.
1824  * @param *block    The IR block the node belongs to.
1825  * @param arg       A node producing a tuple.
1826  * @param max_proj  The end position of the value in the tuple.
1827  */
1828 ir_node *new_rd_defaultProj (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1829                              long max_proj);
1830
1831 /** Constructor for a Tuple node.
1832  *
1833  * This is an auxiliary node to replace a node that returns a tuple
1834  * without changing the corresponding Proj nodes.
1835  *
1836  * @param *db     A pointer for debug information.
1837  * @param *irg    The IR graph the node  belongs to.
1838  * @param *block  The IR block the node belongs to.
1839  * @param arity   The number of tuple elements.
1840  * @param *in[]   An array containing pointers to the nodes producing the tuple
1841  *                elements. The constructor copies this array.
1842  */
1843 ir_node *new_rd_Tuple  (dbg_info *db, ir_graph *irg, ir_node *block,
1844                         int arity, ir_node *in[]);
1845
1846 /** Constructor for a Id node.
1847  *
1848  * This is an auxiliary node to replace a node that returns a single
1849  * value.
1850  *
1851  * @param *db     A pointer for debug information.
1852  * @param *irg    The IR graph the node  belongs to.
1853  * @param *block  The IR block the node belongs to.
1854  * @param *val    The value
1855  * @param *mode   The mode of *val.
1856  */
1857 ir_node *new_rd_Id     (dbg_info *db, ir_graph *irg, ir_node *block,
1858                         ir_node *val, ir_mode *mode);
1859
1860 /** Constructor for a Confirm node.
1861  *
1862  * Specifies constraints for a value.  To support dataflow analyses.
1863  *
1864  * Example: If the value never exceeds '100' this is expressed by placing a
1865  * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
1866  *
1867  * @param *irg    The IR graph the node belong to.
1868  * @param *block  The IR block the node belong to.
1869  * @param *db     A pointer for debug information.
1870  * @param *val    The value we express a constraint for
1871  * @param *bound  The value to compare against. Must be a firm node, typically a constant.
1872  * @param cmp     The compare operation.
1873  */
1874 ir_node *new_rd_Confirm (dbg_info *db, ir_graph *irg, ir_node *block,
1875              ir_node *val, ir_node *bound, pn_Cmp cmp);
1876
1877 /** Constructor for an Unknown node.
1878  *
1879  * Represents an arbitrary value.  Places the node in the start block.
1880  *
1881  * @param *irg    The IR graph the node  belongs to.
1882  * @param *m      The mode of the unknown value.
1883  */
1884 ir_node *new_rd_Unknown(ir_graph *irg, ir_mode *m);
1885
1886 /** Constructor for a CallBegin node.
1887  *
1888  * CallBegin represents control flow depending of the pointer value
1889  * representing the called method to the called methods.  The
1890  * constructor copies the method pointer input from the passed Call
1891  * node.
1892  *
1893  * @param *db     A pointer for debug information.
1894  * @param *irg    The IR graph the node belong to.
1895  * @param *block  The block the node belong to.
1896  * @param *callee The call node visible in the intra procedural view.
1897  */
1898 ir_node *new_rd_CallBegin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *callee);
1899
1900 /** Constructor for a EndReg node.
1901  *
1902  * Used to represent regular procedure end in interprocedual view.
1903  *
1904  * @param *db     A pointer for debug information.
1905  * @param *irg    The IR graph the node belong to.
1906  * @param *block  The block the node belong to.
1907  */
1908 ir_node *new_rd_EndReg (dbg_info *db, ir_graph *irg, ir_node *block);
1909
1910 /** Constructor for a EndExcept node.
1911  *
1912  * Used to represent exceptional procedure end in interprocedural view.
1913  *
1914  * @param *db     A pointer for debug information.
1915  * @param *irg    The IR graph the node belong to.
1916  * @param *block  The block the node belong to.
1917  */
1918 ir_node *new_rd_EndExcept(dbg_info *db, ir_graph *irg, ir_node *block);
1919
1920 /** Constructor for a Filter node.
1921  *
1922  * Adds the node to the block in current_ir_block.  Filter is a node
1923  * with two views used to construct the interprocedural view.  In
1924  * intraprocedural view its semantics are identical to the Proj node.
1925  * In interprocedural view the Filter performs the Phi operation on
1926  * method parameters or results.  Other than a Phi a Filter node may
1927  * not be removed if it has only a single input.
1928  *
1929  * The constructor builds the Filter in intraprocedural view.
1930  *
1931  * @param *db     A pointer for debug information.
1932  * @param *irg    The IR graph the node belong to.
1933  * @param *block  The block the node belong to.
1934  * @param *arg  The tuple value to project from.
1935  * @param *mode The mode of the projected value.
1936  * @param proj  The position in the tuple to project from.
1937  */
1938 ir_node *new_rd_Filter (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *arg,
1939                         ir_mode *mode, long proj);
1940
1941 /** Constructor for a Mux node.
1942  *
1943  * @param *db       A pointer for debug information.
1944  * @param *irg      The IR graph the node belong to.
1945  * @param *block    The block the node belong to.
1946  * @param *sel      The ir_node that calculates the boolean select.
1947  * @param *ir_true  The ir_node that calculates the true result.
1948  * @param *ir_false The ir_node that calculates the false result.
1949  * @param *mode     The mode of the node (and it_true and ir_false).
1950  */
1951 ir_node *new_rd_Mux  (dbg_info *db, ir_graph *irg, ir_node *block,
1952     ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
1953
1954 /** Constructor for a CopyB node.
1955  *
1956  * @param *db         A pointer for debug information.
1957  * @param *irg        The IR graph the node belong to.
1958  * @param *block      The block the node belong to.
1959  * @param *store      The current memory
1960  * @param *dst        The ir_node that represents the destination address.
1961  * @param *src        The ir_node that represents the source address.
1962  * @param *data_type  The type of the copied data
1963  */
1964 ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block,
1965     ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
1966
1967 /** Constructor for a InstOf node.
1968  *
1969  * A High-Level Type check.
1970  *
1971  * @param   *db        A pointer for debug information.
1972  * @param   *irg       The IR graph the node  belongs to.
1973  * @param   *block     The IR block the node belongs to.
1974  * @param   *store     The memory in which the object the entity should be selected
1975  *                     from is allocated.
1976  * @param   *objptr    A pointer to a object of a class type.
1977  * @param   *type      The type of which objptr must be.
1978  */
1979 ir_node *new_rd_InstOf (dbg_info *db, ir_graph *irg, ir_node *block, ir_node *store,
1980                         ir_node *objptr, ir_type *type);
1981
1982 /** Constructor for a Raise node.
1983  *
1984  * A High-Level Exception throw.
1985  *
1986  * @param *db    A pointer for debug information.
1987  * @param *irg   The IR graph the node  belongs to.
1988  * @param *block The IR block the node belongs to.
1989  * @param *store The current memory.
1990  * @param *obj   A pointer to the Except variable.
1991  */
1992 ir_node *new_rd_Raise  (dbg_info *db, ir_graph *irg, ir_node *block,
1993                         ir_node *store, ir_node *obj);
1994
1995 /** Constructor for a Bound node.
1996  *
1997  * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
1998  *
1999  * @param *db         A pointer for debug information.
2000  * @param *irg        The IR graph the node belong to.
2001  * @param *block      The block the node belong to.
2002  * @param *store      The current memory.
2003  * @param *idx        The ir_node that represents an index.
2004  * @param *lower      The ir_node that represents the lower bound for the index.
2005  * @param *upper      The ir_node that represents the upper bound for the index.
2006  */
2007 ir_node *new_rd_Bound(dbg_info *db, ir_graph *irg, ir_node *block,
2008     ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
2009
2010 /** Constructor for a Pin node.
2011  *
2012  * @param *db         A pointer for debug information.
2013  * @param *irg        The IR graph the node belong to.
2014  * @param *block      The block the node belong to.
2015  * @param *node       The node which value should be pinned.
2016  */
2017 ir_node *new_rd_Pin(dbg_info *db, ir_graph *irg, ir_node *block, ir_node *node);
2018
2019 /** Constructor for an ASM pseudo node.
2020  *
2021  * @param *db         A pointer for debug information.
2022  * @param *irg        The IR graph the node belong to.
2023  * @param *block      The block the node belong to.
2024  * @param arity       The number of data inputs to the node.
2025  * @param *in         The array of length arity of data inputs.
2026  * @param *inputs     The array of length arity of input constraints.
2027  * @param n_outs      The number of data outputs to the node.
2028  * @param *outputs    The array of length n_outs of output constraints.
2029  * @param n_clobber   The number of clobbered registers.
2030  * @param *clobber    The array of length n_clobber of clobbered registers.
2031  * @param *asm_text   The assembler text.
2032  */
2033 ir_node *new_rd_ASM(dbg_info *db, ir_graph *irg, ir_node *block,
2034                     int arity, ir_node *in[], ir_asm_constraint *inputs,
2035                     int n_outs, ir_asm_constraint *outputs,
2036                     int n_clobber, ident *clobber[], ident *asm_text);
2037
2038 /*-------------------------------------------------------------------------*/
2039 /* The raw interface without debug support                                 */
2040 /*-------------------------------------------------------------------------*/
2041
2042 /** Constructor for a Block node.
2043  *
2044  * Constructs a mature block with the given predecessors.  Use Unknown
2045  * nodes as predecessors to construct a block if the number of
2046  * predecessors is known, but not the predecessors themselves.  This
2047  * constructor does not set current_block.  It not be used with
2048  * automatic Phi node construction.
2049  *
2050  *
2051  * @param irg    The IR graph the block belongs to.
2052  * @param arity  The number of control predecessors.
2053  * @param in[]   An array of control predecessors.  The length of
2054  *               the array must be 'arity'. The constructor copies this array.
2055  */
2056 ir_node *new_r_Block  (ir_graph *irg,  int arity, ir_node *in[]);
2057
2058 /** Constructor for a Start node.
2059  *
2060  * @param *irg   The IR graph the node belongs to.
2061  * @param *block The IR block the node belongs to.
2062  */
2063 ir_node *new_r_Start  (ir_graph *irg, ir_node *block);
2064
2065 /** Constructor for a End node.
2066  *
2067  * @param *irg   The IR graph the node  belongs to.
2068  * @param *block The IR block the node belongs to.
2069  */
2070 ir_node *new_r_End    (ir_graph *irg, ir_node *block);
2071
2072 /** Constructor for a Jmp node.
2073  *
2074  * Jmp represents control flow to a single control successor.
2075  *
2076  * @param *irg    The IR graph the node belongs to.
2077  * @param *block  The IR block the node belongs to.
2078  */
2079 ir_node *new_r_Jmp    (ir_graph *irg, ir_node *block);
2080
2081 /** Constructor for an IJmp node.
2082  *
2083  * IJmp represents control flow to a single control successor not
2084  * statically known i.e. an indirect Jmp.
2085  *
2086  * @param *irg    The IR graph the node belongs to.
2087  * @param *block  The IR block the node belongs to.
2088  * @param *tgt    The IR node representing the target address.
2089  */
2090 ir_node *new_r_IJmp   (ir_graph *irg, ir_node *block, ir_node *tgt);
2091
2092 /** Constructor for a Cond node.
2093  *
2094  * If c is mode_b represents a conditional branch (if/else). If c is
2095  * mode_Is/mode_Iu (?) represents a switch.  (Allocates dense Cond
2096  * node, default Proj is 0.)
2097  *
2098  * This is not consistent:  Input to Cond is Is, Proj has as proj number
2099  * longs.
2100  *
2101  * @param *irg   The IR graph the node  belongs to.
2102  * @param *block The IR block the node belongs to.
2103  * @param *c     The conditions parameter.Can be of mode b or I_u.
2104  */
2105 ir_node *new_r_Cond   (ir_graph *irg, ir_node *block, ir_node *c);
2106
2107 /** Constructor for a Return node.
2108  *
2109  * Returns the memory and zero or more return values.  Only node that
2110  * can end regular control flow.
2111  *
2112  * @param *irg   The IR graph the node  belongs to.
2113  * @param *block The IR block the node belongs to.
2114  * @param *store The state of memory.
2115  * @param arity  Number of array indices.
2116  * @param *in[]   Array with index inputs to the node. The constructor copies this array.
2117  */
2118 ir_node *new_r_Return (ir_graph *irg, ir_node *block,
2119                        ir_node *store, int arity, ir_node *in[]);
2120
2121 /** Constructor for a Const node.
2122  *
2123  * Adds the node to the start block.
2124  *
2125  * Constructor for a Const node. The constant represents a target
2126  * value.  Sets the type information to type_unknown.  (No more
2127  * supported: If tv is entity derives a somehow useful type.)
2128  * Derives mode from passed tarval.
2129  *
2130  * @param *irg   The IR graph the node  belongs to.
2131  * @param *block The IR block the node belongs to.
2132  * @param *con   Points to an entry in the constant table.
2133  */
2134 ir_node *new_r_Const  (ir_graph *irg, tarval *con);
2135
2136 /** Constructor for a Const node.
2137  *
2138  * Adds the node to the start block.
2139  *
2140  * Constructor for a Const node. The constant represents a target
2141  * value.  Sets the type information to type_unknown.  (No more
2142  * supported: If tv is entity derives a somehow useful type.)
2143  *
2144  * @param *irg   The IR graph the node  belongs to.
2145  * @param *mode  The mode of the operands and the results.
2146  * @param value  A value from which the tarval is made.
2147  */
2148 ir_node *new_r_Const_long(ir_graph *irg,
2149                        ir_mode *mode, long value);
2150
2151 /** Constructor for a Const_type node.
2152  *
2153  * Adds the node to the start block.
2154  *
2155  * The constant represents a target value.  This constructor sets high
2156  * level type information for the constant value.
2157  * Derives mode from passed tarval.
2158  *
2159  * @param *irg   The IR graph the node  belongs to.
2160  * @param *con   Points to an entry in the constant table.
2161  * @param *tp    The type of the constant.
2162  */
2163 ir_node *new_r_Const_type(ir_graph *irg, tarval *con, ir_type *tp);
2164
2165 /** Constructor for a SymConst node.
2166  *
2167  *  This is the constructor for a symbolic constant.
2168  *    There are four kinds of symbolic constants:
2169  *    - type_tag  The symbolic constant represents a type tag.  The type the
2170  *                tag stands for is given explicitly.
2171  *    - size      The symbolic constant represents the size of a type.  The
2172  *                type of which the constant represents the size is given
2173  *                explicitly.
2174  *    - addr_name The symbolic constant represents the address of an entity
2175  *                (variable or method).  The variable is indicated by a name
2176  *                that is valid for linking.
2177  *    - addr_ent   The symbolic constant represents the address of an entity
2178  *                (variable or method).  The variable is given explicitly by
2179  *                a firm entity.
2180  *
2181  *    Inputs to the node:
2182  *      No inputs except the block it belongs to.
2183  *    Outputs of the node.
2184  *      An unsigned integer (I_u) or a pointer (P).
2185  *
2186  * @param *irg    The IR graph the node  belongs to.
2187  * @param *block  The IR block the node belongs to.
2188  * @param mode    The mode for the SymConst.
2189  * @param value   A type, entity or a ident depending on the SymConst kind.
2190  * @param symkind The kind of the symbolic constant: type_tag, size or link_info.
2191  */
2192 ir_node *new_r_SymConst(ir_graph *irg, ir_node *block, ir_mode *mode,
2193                         union symconst_symbol value, symconst_kind symkind);
2194
2195 /** Constructor for a simpleSel node.
2196  *
2197  *  This is a shortcut for the new_d_Sel() constructor.  To be used for
2198  *  Sel nodes that do not select from an array, i.e., have no index
2199  *  inputs.  It adds the two parameters 0, NULL.
2200  *
2201  * @param   *irg       The IR graph the node  belongs to.
2202  * @param   *block     The IR block the node belongs to.
2203  * @param   *store     The memory in which the object the entity should be selected
2204  *                     from is allocated.
2205  * @param   *objptr    The object from that the Sel operation selects a
2206  *                     single attribute out.
2207  * @param   *ent       The entity to select.
2208  */
2209 ir_node *new_r_simpleSel(ir_graph *irg, ir_node *block, ir_node *store,
2210                          ir_node *objptr, ir_entity *ent);
2211
2212 /** Constructor for a Sel node.
2213  *
2214  * The select node selects an entity (field or method) from an entity
2215  * with a compound type.  It explicitly specifies the entity selected.
2216  * Dynamically the node may select entities that overwrite the given
2217  * entity.  If the selected entity is an array element entity the Sel
2218  * node takes the required array indices as inputs.
2219  *
2220  * @param   *irg       The IR graph the node  belongs to.
2221  * @param   *block     The IR block the node belongs to.
2222  * @param   *store     The memory in which the object the entity should be selected
2223  *                     from is allocated.
2224  * @param   *objptr    A pointer to a compound entity the Sel operation selects a
2225  *                     single attribute from.
2226  * @param   *n_index   The number of array indices needed to select an array element entity.
2227  * @param   *index[]   If the compound entity is an array the indices of the selected
2228  *                     element entity.  The constructor copies this array.
2229  * @param   *ent       The entity to select.
2230  */
2231 ir_node *new_r_Sel    (ir_graph *irg, ir_node *block, ir_node *store,
2232                        ir_node *objptr, int n_index, ir_node *index[],
2233                ir_entity *ent);
2234
2235 /** Constructor for a Call node.
2236  *
2237  *  Represents all kinds of method and function calls.
2238  *
2239  * @param   *irg    The IR graph the node  belongs to.
2240  * @param   *block  The IR block the node belongs to.
2241  * @param   *store  The actual store.
2242  * @param   *callee A pointer to the called procedure.
2243  * @param   arity   The number of procedure parameters.
2244  * @param   *in[]   An array with the pointers to the parameters. The constructor copies this array.
2245  * @param   *tp     Type information of the procedure called.
2246  */
2247 ir_node *new_r_Call   (ir_graph *irg, ir_node *block, ir_node *store,
2248                ir_node *callee, int arity, ir_node *in[],
2249                ir_type *tp);
2250
2251 /** Constructor for a Add node.
2252  *
2253  * @param   *irg   The IR graph the node  belongs to.
2254  * @param   *block The IR block the node belongs to.
2255  * @param   *op1   The first operand.
2256  * @param   *op2   The second operand.
2257  * @param   *mode  The mode of the operands and the result.
2258  */
2259 ir_node *new_r_Add    (ir_graph *irg, ir_node *block,
2260                ir_node *op1, ir_node *op2, ir_mode *mode);
2261
2262 /**
2263  * Constructor for a Sub node.
2264  *
2265  * @param   *irg   The IR graph the node  belongs to.
2266  * @param   *block The IR block the node belongs to.
2267  * @param   *op1   The first operand.
2268  * @param   *op2   The second operand.
2269  * @param   *mode  The mode of the operands and the results.
2270  */
2271 ir_node *new_r_Sub    (ir_graph *irg, ir_node *block,
2272                ir_node *op1, ir_node *op2, ir_mode *mode);
2273
2274 /** Constructor for a Minus node.
2275  *
2276  * @param   *irg   The IR graph the node  belongs to.
2277  * @param   *block The IR block the node belongs to.
2278  * @param   *op   The operand.
2279  * @param   *mode  The mode of the operand and the result.
2280  */
2281 ir_node *new_r_Minus  (ir_graph *irg, ir_node *block,
2282                ir_node *op,  ir_mode *mode);
2283
2284 /** Constructor for a Mul node.
2285  *
2286  * @param   *irg   The IR graph the node  belongs to.
2287  * @param   *block The IR block the node belongs to.
2288  * @param   *op1   The first operand.
2289  * @param   *op2   The second operand.
2290  * @param   *mode  The mode of the operands and the result.
2291  */
2292 ir_node *new_r_Mul    (ir_graph *irg, ir_node *block,
2293                ir_node *op1, ir_node *op2, ir_mode *mode);
2294
2295 /** Constructor for a Mulh node.
2296  *
2297  * @param   *irg   The IR graph the node  belongs to.
2298  * @param   *block The IR block the node belongs to.
2299  * @param   *op1   The first operand.
2300  * @param   *op2   The second operand.
2301  * @param   *mode  The mode of the operands and the result.
2302  */
2303 ir_node *new_r_Mulh   (ir_graph *irg, ir_node *block,
2304                ir_node *op1, ir_node *op2, ir_mode *mode);
2305
2306 /** Constructor for a Quot node.
2307  *
2308  * @param   *irg   The IR graph the node  belongs to.
2309  * @param   *block The IR block the node belongs to.
2310  * @param   *memop The store needed to model exceptions
2311  * @param   *op1   The first operand.
2312  * @param   *op2   The second operand.
2313  * @param   *mode  The mode of the result.
2314  * @param   state  The pinned state.
2315  */
2316 ir_node *new_r_Quot   (ir_graph *irg, ir_node *block,
2317                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2318
2319 /** Constructor for a DivMod node.
2320  *
2321  * @param   *irg   The IR graph the node  belongs to.
2322  * @param   *block The IR block the node belongs to.
2323  * @param   *memop The store needed to model exceptions
2324  * @param   *op1   The first operand.
2325  * @param   *op2   The second operand.
2326  * @param   *mode  The mode of the results.
2327  * @param   state  The pinned state.
2328  */
2329 ir_node *new_r_DivMod (ir_graph *irg, ir_node *block,
2330                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2331
2332 /** Constructor for a Div node.
2333  *
2334  * @param   *irg   The IR graph the node  belongs to.
2335  * @param   *block The IR block the node belongs to.
2336  * @param   *memop The store needed to model exceptions
2337  * @param   *op1   The first operand.
2338  * @param   *op2   The second operand.
2339  * @param   *mode  The mode of the result.
2340  * @param   state  The pinned state.
2341  */
2342 ir_node *new_r_Div    (ir_graph *irg, ir_node *block,
2343                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2344
2345 /** Constructor for a remainderless Div node.
2346  *
2347  * @param   *irg   The IR graph the node  belongs to.
2348  * @param   *block The IR block the node belongs to.
2349  * @param   *memop The store needed to model exceptions
2350  * @param   *op1   The first operand.
2351  * @param   *op2   The second operand.
2352  * @param   *mode  The mode of the result.
2353  * @param   state  The pinned state.
2354  */
2355 ir_node *new_r_DivRL  (ir_graph *irg, ir_node *block,
2356                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2357
2358 /** Constructor for a Mod node.
2359  *
2360  * @param   *irg   The IR graph the node  belongs to.
2361  * @param   *block The IR block the node belongs to.
2362  * @param   *memop The store needed to model exceptions
2363  * @param   *op1   The first operand.
2364  * @param   *op2   The second operand.
2365  * @param   *mode  The mode of the result.
2366  * @param   state  The pinned state.
2367  */
2368 ir_node *new_r_Mod    (ir_graph *irg, ir_node *block,
2369                ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
2370
2371 /** Constructor for a Abs node.
2372  *
2373  * @param   *irg   The IR graph the node  belongs to.
2374  * @param   *block The IR block the node belongs to.
2375  * @param   *op    The operand
2376  * @param   *mode  The mode of the operands and the result.
2377  */
2378 ir_node *new_r_Abs    (ir_graph *irg, ir_node *block,
2379                        ir_node *op, ir_mode *mode);
2380
2381 /** Constructor for a And node.
2382  *
2383  * @param   *irg   The IR graph the node  belongs to.
2384  * @param   *block The IR block the node belongs to.
2385  * @param   *op1   The first operand.
2386  * @param   *op2   The second operand.
2387  * @param   *mode  The mode of the operands and the result.
2388  */
2389 ir_node *new_r_And    (ir_graph *irg, ir_node *block,
2390                ir_node *op1, ir_node *op2, ir_mode *mode);
2391
2392 /** Constructor for a Or node.
2393  *
2394  * @param   *irg   The IR graph the node  belongs to.
2395  * @param   *block The IR block the node belongs to.
2396  * @param   *op1   The first operand.
2397  * @param   *op2   The second operand.
2398  * @param   *mode  The mode of the operands and the result.
2399  */
2400 ir_node *new_r_Or     (ir_graph *irg, ir_node *block,
2401                ir_node *op1, ir_node *op2, ir_mode *mode);
2402
2403 /** Constructor for a Eor node.
2404  *
2405  * @param   *irg   The IR graph the node  belongs to.
2406  * @param   *block The IR block the node belongs to.
2407  * @param   *op1   The first operand.
2408  * @param   *op2   The second operand.
2409  * @param   *mode  The mode of the operands and the results.
2410  */
2411 ir_node *new_r_Eor    (ir_graph *irg, ir_node *block,
2412                ir_node *op1, ir_node *op2, ir_mode *mode);
2413
2414 /** Constructor for a Not node.
2415  *
2416  * @param   *irg   The IR graph the node  belongs to.
2417  * @param   *block The IR block the node belongs to.
2418  * @param   *op    The operand.
2419  * @param   *mode  The mode of the operand and the result.
2420  */
2421 ir_node *new_r_Not    (ir_graph *irg, ir_node *block,
2422                ir_node *op, ir_mode *mode);
2423
2424 /** Constructor for a Cmp node.
2425  *
2426  * @param   *irg   The IR graph the node  belongs to.
2427  * @param   *block The IR block the node belongs to.
2428  * @param   *op1   The first operand.
2429  * @param   *op2   The second operand.
2430  */
2431 ir_node *new_r_Cmp    (ir_graph *irg, ir_node *block,
2432                ir_node *op1, ir_node *op2);
2433
2434 /** Constructor for a Shl node.
2435  *
2436  * @param   *irg   The IR graph the node  belongs to.
2437  * @param   *block The IR block the node belongs to.
2438  * @param   *op    The operand.
2439  * @param   *k     The number of bits to  shift the operand .
2440  * @param   *mode  The mode of the operand and the result.
2441  */
2442 ir_node *new_r_Shl    (ir_graph *irg, ir_node *block,
2443                ir_node *op, ir_node *k, ir_mode *mode);
2444
2445 /** Constructor for a Shr node.
2446  *
2447  * @param   *irg   The IR graph the node  belongs to.
2448  * @param   *block The IR block the node belongs to.
2449  * @param   *op    The operand.
2450  * @param   *k     The number of bits to shift the operand .
2451  * @param   *mode  The mode of the operand and the result.
2452  */
2453 ir_node *new_r_Shr    (ir_graph *irg, ir_node *block,
2454                ir_node *op, ir_node *k, ir_mode *mode);
2455
2456 /**
2457  * Constructor for a Shrs node.
2458  *
2459  * @param   *irg   The IR graph the node  belongs to.
2460  * @param   *block The IR block the node belongs to.
2461  * @param   *op    The operand.
2462  * @param   *k     The number of bits to shift the operand.
2463  * @param   *mode  The mode of the operand and the result.
2464  */
2465 ir_node *new_r_Shrs   (ir_graph *irg, ir_node *block,
2466                ir_node *op, ir_node *k, ir_mode *mode);
2467
2468 /** Constructor for a Rotl node.
2469  *
2470  * @param   *irg   The IR graph the node  belongs to.
2471  * @param   *block The IR block the node belongs to.
2472  * @param   *op    The operand.
2473  * @param   *k     The number of bits to rotate the operand.
2474  * @param   *mode  The mode of the operand.
2475  */
2476 ir_node *new_r_Rotl   (ir_graph *irg, ir_node *block,
2477                ir_node *op, ir_node *k, ir_mode *mode);
2478
2479 /** Constructor for a Conv node.
2480  *
2481  * @param   *irg   The IR graph the node  belongs to.
2482  * @param   *block The IR block the node belongs to.
2483  * @param   *op    The operand.
2484  * @param   *mode  The mode of this the operand muss be converted .
2485  */
2486 ir_node *new_r_Conv   (ir_graph *irg, ir_node *block,
2487                ir_node *op, ir_mode *mode);
2488
2489 /** Constructor for a Cast node.
2490  *
2491  * High level type cast
2492  *
2493  * @param   *irg   The IR graph the node  belongs to.
2494  * @param   *block The IR block the node belongs to.
2495  * @param   *op    The operand.
2496  * @param   *to_tp The type of this the operand muss be casted .
2497  */
2498 ir_node *new_r_Cast   (ir_graph *irg, ir_node *block,
2499                ir_node *op, ir_type *to_tp);
2500
2501 /** Constructor for a Carry node.
2502  *
2503  * @param   *irg   The IR graph the node  belongs to.
2504  * @param   *block The IR block the node belongs to.
2505  * @param   *op1   The first operand.
2506  * @param   *op2   The second operand.
2507  * @param   *mode  The mode of the operands and the result.
2508  */
2509 ir_node *new_r_Carry  (ir_graph *irg, ir_node *block,
2510                ir_node *op1, ir_node *op2, ir_mode *mode);
2511
2512 /**
2513  * Constructor for a Borrow node.
2514  *
2515  * @param   *irg   The IR graph the node  belongs to.
2516  * @param   *block The IR block the node belongs to.
2517  * @param   *op1   The first operand.
2518  * @param   *op2   The second operand.
2519  * @param   *mode  The mode of the operands and the results.
2520  */
2521 ir_node *new_r_Borrow (ir_graph *irg, ir_node *block,
2522                ir_node *op1, ir_node *op2, ir_mode *mode);
2523
2524 /** Constructor for a Phi node.
2525  *
2526  * @param *irg   The IR graph the node  belongs to.
2527  * @param *block The IR block the node belongs to.
2528  * @param arity  The number of predecessors
2529  * @param *in[]    Array with predecessors. The constructor copies this array.
2530  * @param *mode  The mode of it's inputs and output.
2531  */
2532 ir_node *new_r_Phi    (ir_graph *irg, ir_node *block, int arity,
2533                        ir_node *in[], ir_mode *mode);
2534
2535 /** Constructor for a Load node.
2536  *
2537  * @param *irg   The IR graph the node  belongs to.
2538  * @param *block The IR block the node belongs to.
2539  * @param *store The current memory
2540  * @param *adr   A pointer to the variable to be read in this memory.
2541  * @param *mode  The mode of the value to be loaded.
2542  */
2543 ir_node *new_r_Load   (ir_graph *irg, ir_node *block,
2544                ir_node *store, ir_node *adr, ir_mode *mode);
2545
2546 /** Constructor for a Store node.
2547  *
2548  * @param *irg   The IR graph the node  belongs to.
2549  * @param *block The IR block the node belongs to.
2550  * @param *store The current memory
2551  * @param *adr   A pointer to the variable to be read in this memory.
2552  * @param *val   The value to write to this variable.
2553  */
2554 ir_node *new_r_Store  (ir_graph *irg, ir_node *block,
2555                        ir_node *store, ir_node *adr, ir_node *val);
2556
2557 /** Constructor for a Alloc node.
2558  *
2559  * The Alloc node extends the memory by space for an entity of type alloc_type.
2560  *
2561  * @param *irg        The IR graph the node  belongs to.
2562  * @param *block      The IR block the node belongs to.
2563  * @param *store      The memory which shall contain the new variable.
2564  * @param *size       The number of bytes to allocate.
2565  * @param *alloc_type The type of the allocated variable.
2566  * @param where       Where to allocate the variable, either heap_alloc or stack_alloc.
2567  */
2568 ir_node *new_r_Alloc  (ir_graph *irg, ir_node *block, ir_node *store,
2569                ir_node *size, ir_type *alloc_type, ir_where_alloc where);
2570
2571 /** Constructor for a Free node.
2572  *
2573  * Frees the memory occupied by the entity pointed to by the pointer
2574  * arg.  Type indicates the type of the entity the argument points to.
2575  *
2576  * @param *irg        The IR graph the node  belongs to.
2577  * @param *block      The IR block the node belongs to.
2578  * @param *store      The memory which shall contain the new variable.
2579  * @param *ptr        The pointer to the object to free.
2580  * @param *size       The number of objects of type free_type to free in a sequence.
2581  * @param *free_type  The type of the freed variable.
2582  * @param where       Where the variable was allocated, either heap_alloc or stack_alloc.
2583  */
2584 ir_node *new_r_Free   (ir_graph *irg, ir_node *block, ir_node *store,
2585                ir_node *ptr, ir_node *size, ir_type *free_type, ir_where_alloc where);
2586
2587 /** Constructor for a Sync node.
2588  *
2589  * Merges several memory values.  The node assumes that a variable
2590  * either occurs only in one of the memories, or it contains the same
2591  * value in all memories where it occurs.
2592  *
2593  * @param *irg      The IR graph the node  belongs to.
2594  * @param *block    The IR block the node belongs to.
2595  * @param  arity    The number of memories to synchronize.
2596  * @param  *in[]    An array of pointers to nodes that produce an output of  type memory.
2597  *                  The constructor copies this array.
2598  */
2599 ir_node *new_r_Sync (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2600
2601 /** Constructor for a Proj node.
2602  *
2603  * Projects a single value out of a tuple.  The parameter proj gives the
2604  * position of the value within the tuple.
2605  *
2606  * @param *irg   The IR graph the node  belongs to.
2607  * @param *block The IR block the node belongs to.
2608  * @param arg    A node producing a tuple.
2609  * @param *mode  The mode of the value to project.
2610  * @param proj   The position of the value in the tuple.
2611  */
2612 ir_node *new_r_Proj   (ir_graph *irg, ir_node *block, ir_node *arg,
2613                        ir_mode *mode, long proj);
2614
2615 /** Constructor for a defaultProj node.
2616  *
2617  * Represents the default control flow of a Switch-Cond node.
2618  *
2619  * @param *irg      The IR graph the node  belongs to.
2620  * @param *block    The IR block the node belongs to.
2621  * @param arg       A node producing a tuple.
2622  * @param max_proj  The end  position of the value in the tuple.
2623  */
2624 ir_node *new_r_defaultProj (ir_graph *irg, ir_node *block, ir_node *arg, long max_proj);
2625
2626
2627 /** Constructor for a Tuple node.
2628  *
2629  * This is an auxiliary node to replace a node that returns a tuple
2630  * without changing the corresponding Proj nodes.
2631  *
2632  * @param *irg    The IR graph the node  belongs to.
2633  * @param *block  The IR block the node belongs to.
2634  * @param arity   The number of tuple elements.
2635  * @param *in[]   An array containing pointers to the nodes producing the tuple elements.
2636  *                The constructor copies this array.
2637  */
2638 ir_node *new_r_Tuple  (ir_graph *irg, ir_node *block, int arity, ir_node *in[]);
2639
2640 /** Constructor for a Id node.
2641  *
2642  * This is an auxiliary node to replace a node that returns a single
2643  * value.
2644  *
2645  * @param *irg    The IR graph the node  belongs to.
2646  * @param *block  The IR block the node belongs to.
2647  * @param *val    The operand to Id.
2648  * @param *mode   The mode of *val.
2649  */
2650 ir_node *new_r_Id     (ir_graph *irg, ir_node *block,
2651                ir_node *val, ir_mode *mode);
2652
2653 /** Constructor for a Bad node.
2654  *
2655  * Returns the unique Bad node of the graph.  The same as
2656  * get_irg_bad().
2657  *
2658  * @param *irg    The IR graph the node  belongs to.
2659  *
2660  */
2661 ir_node *new_r_Bad    (ir_graph *irg);
2662
2663 /** Constructor for a Confirm node.
2664  *
2665  * Specifies constraints for a value.  To support dataflow analyses.
2666  *
2667  * Example: If the value never exceeds '100' this is expressed by placing a
2668  * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
2669  *
2670  * @param *irg    The IR graph the node belong to.
2671  * @param *block  The IR block the node belong to.
2672  * @param *val    The value we express a constraint for
2673  * @param *bound  The value to compare against. Must be a firm node, typically a constant.
2674  * @param cmp     The compare operation.
2675  */
2676 ir_node *new_r_Confirm(ir_graph *irg, ir_node *block,
2677             ir_node *val, ir_node *bound, pn_Cmp cmp);
2678
2679 /** Constructor for a Unknown node.
2680  *
2681  * Represents an arbitrary value.  Places the node in
2682  * the start block.
2683  *
2684  * @param *irg    The IR graph the node  belongs to.
2685  * @param *m      The mode of the unknown value.
2686  */
2687 ir_node *new_r_Unknown(ir_graph *irg, ir_mode *m);
2688
2689 /** Constructor for a CallBegin node.
2690  *
2691  * CallBegin represents control flow depending of the pointer value
2692  * representing the called method to the called methods.  The
2693  * constructor copies the method pointer input from the passed Call
2694  * node.
2695  *
2696  * @param *irg    The IR graph the node belong to.
2697  * @param *block  The block the node belong to.
2698  * @param *callee The call node visible in the  intra procedural view.
2699  */
2700 ir_node *new_r_CallBegin(ir_graph *irg, ir_node *block, ir_node *callee);
2701
2702 /** Constructor for a EndReg node.
2703  *
2704  * Used to represent regular procedure end in interprocedual view.
2705  *
2706  * @param *irg    The IR graph the node belong to.
2707  * @param *block  The block the node belong to.
2708  */
2709 ir_node *new_r_EndReg (ir_graph *irg, ir_node *block);
2710
2711 /** Constructor for a EndExcept node.
2712  *
2713  * Used to represent exceptional procedure end in interprocedural view.
2714  *
2715  * @param *irg    The IR graph the node belong to.
2716  * @param *block  The block the node belong to.
2717  */
2718 ir_node *new_r_EndExcept(ir_graph *irg, ir_node *block);
2719
2720 /** Constructor for a Break node.
2721  *
2722  * Break represents control flow to a single control successor just as Jmp.
2723  * The blocks separated by a break may not be concatenated by an optimization.
2724  * It is used for the interprocedural representation where blocks are parted
2725  * behind Call nodes to represent the control flow to called procedures.
2726  *
2727  * @param *irg    The IR graph the node belong to.
2728  * @param *block  The block the node belong to.
2729  */
2730 ir_node *new_r_Break  (ir_graph *irg, ir_node *block);
2731
2732 /** Constructor for a Filter node.
2733  *
2734  * Constructor for a Filter node. Adds the node to the block in current_ir_block.
2735  * Filter is a node with two views used to construct the interprocedural view.
2736  * In intraprocedural view its semantics are identical to the Proj node.
2737  * In interprocedural view the Filter performs the Phi operation on method
2738  * parameters or results.  Other than a Phi a Filter node may not be removed
2739  * if it has only a single input.
2740  *
2741  * The constructor builds the Filter in intraprocedural view.
2742  *
2743  * @param *irg    The IR graph the node belong to.
2744  * @param *block  The block the node belong to.
2745  * @param *arg  The tuple value to project from.
2746  * @param *mode The mode of the projected value.
2747  * @param proj  The position in the tuple to project from.
2748  */
2749 ir_node *new_r_Filter (ir_graph *irg, ir_node *block, ir_node *arg,
2750                ir_mode *mode, long proj);
2751
2752 /** Constructor for a NoMem node.
2753  *
2754  * Returns the unique NoMem node of the graph.  The same as
2755  * get_irg_no_mem().
2756  *
2757  * @param *irg    The IR graph the node belongs to.
2758  */
2759 ir_node *new_r_NoMem  (ir_graph *irg);
2760
2761 /** Constructor for a Mux node.
2762  *
2763  * @param *irg      The IR graph the node belong to.
2764  * @param *block    The block the node belong to.
2765  * @param *sel      The ir_node that calculates the boolean select.
2766  * @param *ir_true  The ir_node that calculates the true result.
2767  * @param *ir_false The ir_node that calculates the false result.
2768  * @param *mode     The mode of the node (and it_true and ir_false).
2769  */
2770 ir_node *new_r_Mux  (ir_graph *irg, ir_node *block,
2771     ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
2772
2773 /** Constructor for a CopyB node.
2774  *
2775  * @param *irg        The IR graph the node belong to.
2776  * @param *block      The block the node belong to.
2777  * @param *store      The current memory
2778  * @param *dst        The ir_node that represents the destination address.
2779  * @param *src        The ir_node that represents the source address.
2780  * @param *data_type  The type of the copied data
2781  */
2782 ir_node *new_r_CopyB(ir_graph *irg, ir_node *block,
2783     ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
2784
2785 /** Constructor for a InstOf node.
2786  *
2787  * A High-Level Type check.
2788  *
2789  * @param   *irg       The IR graph the node  belongs to.
2790  * @param   *block     The IR block the node belongs to.
2791  * @param   *store     The memory in which the object the entity should be selected
2792  *                     from is allocated.
2793  * @param   *objptr    A pointer to a object of a class type.
2794  * @param   *type      The type of which objptr must be.
2795  */
2796 ir_node *new_r_InstOf(ir_graph *irg, ir_node *block, ir_node *store,
2797                       ir_node *objptr, ir_type *type);
2798
2799 /** Constructor for a Raise node.
2800  *
2801  * A High-Level Exception throw.
2802  *
2803  * @param *irg   The IR graph the node  belongs to.
2804  * @param *block The IR block the node belongs to.
2805  * @param *store The current memory.
2806  * @param *obj   A pointer to the Except variable.
2807  */
2808 ir_node *new_r_Raise(ir_graph *irg, ir_node *block,
2809                      ir_node *store, ir_node *obj);
2810
2811 /** Constructor for a Bound node.
2812  *
2813  * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
2814  *
2815  * @param *irg        The IR graph the node belong to.
2816  * @param *block      The block the node belong to.
2817  * @param *store      The current memory.
2818  * @param *idx        The ir_node that represents an index.
2819  * @param *lower      The ir_node that represents the lower bound for the index.
2820  * @param *upper      The ir_node that represents the upper bound for the index.
2821  */
2822 ir_node *new_r_Bound(ir_graph *irg, ir_node *block,
2823     ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
2824
2825 /** Constructor for a Pin node.
2826  *
2827  * @param *irg        The IR graph the node belong to.
2828  * @param *block      The block the node belong to.
2829  * @param *node       The node which value should be pinned.
2830  */
2831 ir_node *new_r_Pin(ir_graph *irg, ir_node *block, ir_node *node);
2832
2833 /** Constructor for an ASM pseudo node.
2834  *
2835  * @param *irg        The IR graph the node belong to.
2836  * @param *block      The block the node belong to.
2837  * @param arity       The number of data inputs to the node.
2838  * @param *in         The array of length arity of data inputs.
2839  * @param *inputs     The array of length arity of input constraints.
2840  * @param n_outs      The number of data outputs to the node.
2841  * @param *outputs    The array of length n_outs of output constraints.
2842  * @param n_clobber   The number of clobbered registers.
2843  * @param *clobber    The array of length n_clobber of clobbered registers.
2844  * @param *asm_text   The assembler text.
2845  */
2846 ir_node *new_r_ASM(ir_graph *irg, ir_node *block,
2847                    int arity, ir_node *in[], ir_asm_constraint *inputs,
2848                    int n_outs, ir_asm_constraint *outputs,
2849                    int n_clobber, ident *clobber[], ident *asm_text);
2850
2851 /*-----------------------------------------------------------------------*/
2852 /* The block oriented interface                                          */
2853 /*-----------------------------------------------------------------------*/
2854
2855 /** Sets the current block in which the following constructors place the
2856  *  nodes they construct.
2857  *
2858  *  @param target  The new current block.
2859  */
2860 void     set_cur_block (ir_node *target);
2861
2862 /** Returns the current block of the current graph. */
2863 ir_node *get_cur_block(void);
2864
2865 /** Returns the fixed nodes  of the current graph. */
2866 #define get_cur_end_block()   get_irg_end_block(current_ir_graph)
2867 #define get_cur_end()         get_irg_end(current_ir_graph)
2868 #define get_cur_start_block() get_irg_start_block(current_ir_graph)
2869 #define get_cur_start()       get_irg_start(current_ir_graph)
2870
2871 /** Constructor for a Block node.
2872  *
2873  * Adds the block to the graph in current_ir_graph. Constructs a Block
2874  * with a fixed number of predecessors.  Does set current_block.  Can
2875  * be used with automatic Phi node construction.
2876  *
2877  * @param *db    A Pointer for debug information.
2878  * @param arity  The number of control predecessors.
2879  * @param in[]   An array of control predecessors.  The length of
2880  *               the array must be 'arity'.
2881  */
2882 ir_node *new_d_Block(dbg_info *db, int arity, ir_node *in[]);
2883
2884 /** Constructor for a Start node.
2885  *
2886  * Adds the node to the block in current_ir_block.
2887  *
2888  * @param *db    A pointer for debug information.
2889  */
2890 ir_node *new_d_Start  (dbg_info *db);
2891
2892 /** Constructor for a End node.
2893  *
2894  * Adds the node to the block in current_ir_block.
2895  *
2896  * @param *db     A pointer for debug information.
2897  */
2898 ir_node *new_d_End    (dbg_info *db);
2899
2900 /** Constructor for a Jmp node.
2901  *
2902  * Adds the node to the block in current_ir_block.
2903  *
2904  * Jmp represents control flow to a single control successor.
2905  *
2906  * @param *db     A pointer for debug information.
2907  */
2908 ir_node *new_d_Jmp    (dbg_info *db);
2909
2910 /** Constructor for an IJmp node.
2911  *
2912  * IJmp represents control flow to a single control successor not
2913  * statically known i.e. an indirect Jmp.
2914  *
2915  * @param *db     A pointer for debug information.
2916  * @param *tgt    The IR node representing the target address.
2917  */
2918 ir_node *new_d_IJmp   (dbg_info *db, ir_node *tgt);
2919
2920 /** Constructor for a Cond node.
2921  *
2922  * Adds the node to the block in current_ir_block.
2923  *
2924  * If c is mode_b represents a conditional branch (if/else). If c is
2925  * mode_Is/mode_Iu (?) represents a switch.  (Allocates dense Cond
2926  * node, default Proj is 0.)
2927  *
2928  * This is not consistent:  Input to Cond is Is, Proj has as proj number
2929  * longs.
2930  *
2931  * @param *db    A pointer for debug information.
2932  * @param *c     The conditions parameter.Can be of mode b or I_u.
2933  */
2934 ir_node *new_d_Cond   (dbg_info *db, ir_node *c);
2935
2936 /** Constructor for a Return node.
2937  *
2938  * Adds the node to the block in current_ir_block.
2939  *
2940  * Returns the memory and zero or more return values.  Only node that
2941  * can end regular control flow.
2942  *
2943  * @param *db    A pointer for debug information.
2944  * @param *store The state of memory.
2945  * @param arity  Number of array indices.
2946  * @param *in    Array with index inputs to the node.
2947  */
2948 ir_node *new_d_Return (dbg_info *db, ir_node *store, int arity, ir_node *in[]);
2949
2950 /** Constructor for a Const_type node.
2951  *
2952  * Adds the node to the start block.
2953  *
2954  * The constant represents a target value.  This constructor sets high
2955  * level type information for the constant value.
2956  * Derives mode from passed tarval.
2957  *
2958  * @param *db    A pointer for debug information.
2959  * @param *con   Points to an entry in the constant table. This pointer is
2960                  added to the attributes of the node.
2961  * @param *tp    The type of the constant.
2962  */
2963 ir_node *new_d_Const_type (dbg_info *db, tarval *con, ir_type *tp);
2964
2965 /** Constructor for a Const node.
2966  *
2967  * Adds the node to the block in current_ir_block.
2968  *
2969  * Constructor for a Const node. The constant represents a target
2970  * value.  Sets the type information to type_unknown.  (No more
2971  * supported: If tv is entity derives a somehow useful type.)
2972  * Derives mode from passed tarval.
2973  *
2974  * @param *db    A pointer for debug information.
2975  * @param *con   Points to an entry in the constant table. This pointer is added
2976  *               to the attributes of the node.
2977  */
2978 ir_node *new_d_Const  (dbg_info *db, tarval *con);
2979
2980 /** Constructor for a SymConst_type node.
2981  *
2982  *  Adds the node to the block in current_ir_block.
2983  *  This is the constructor for a symbolic constant.
2984  *    There are four kinds of symbolic constants:
2985  *    - type_tag  The symbolic constant represents a type tag.  The type the
2986  *                tag stands for is given explicitly.
2987  *    - size      The symbolic constant represents the size of a type.  The
2988  *                type of which the constant represents the size is given
2989  *                explicitly.
2990  *    - addr_name The symbolic constant represents the address of an entity
2991  *                (variable or method).  The variable is indicated by a name
2992  *                that is valid for linking.
2993  *    - addr_ent   The symbolic constant represents the address of an entity
2994  *                (variable or method).  The variable is given explicitly by
2995  *                a firm entity.
2996  *
2997  *    Inputs to the node:
2998  *      No inputs except the block it belongs to.
2999  *    Outputs of the node.
3000  *      An unsigned integer (I_u) or a pointer (P).
3001  *
3002  * @param *db     A pointer for debug information.
3003  * @param mode    The mode for the SymConst.
3004  * @param value   A type, entity or ident depending on the SymConst kind.
3005  * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_type_size,
3006  *                symconst_type_align, symconst_addr_name or symconst_addr_ent.
3007  * @param tp      The source type of the constant.
3008  */
3009 ir_node *new_d_SymConst_type(dbg_info *db, ir_mode *mode,
3010                              union symconst_symbol value, symconst_kind kind, ir_type *tp);
3011
3012 /** Constructor for a SymConst node.
3013  *
3014  *  Same as new_d_SymConst_type, except that it sets the type to type_unknown.
3015  */
3016 ir_node *new_d_SymConst(dbg_info *db, ir_mode *mode,
3017                         union symconst_symbol value, symconst_kind kind);
3018
3019 /** Constructor for a simpleSel node.
3020  *
3021  *  This is a shortcut for the new_d_Sel() constructor.  To be used for
3022  *  Sel nodes that do not select from an array, i.e., have no index
3023  *  inputs.  It adds the two parameters 0, NULL.
3024  *
3025  * @param   *db        A pointer for debug information.
3026  * @param   *store     The memory in which the object the entity should be
3027  *                     selected from is allocated.
3028  * @param   *objptr    The object from that the Sel operation selects a
3029  *                     single attribute out.
3030  * @param   *ent       The entity to select.
3031  */
3032 ir_node *new_d_simpleSel(dbg_info *db, ir_node *store, ir_node *objptr, ir_entity *ent);
3033
3034 /** Constructor for a Sel node.
3035  *
3036  * The select node selects an entity (field or method) from an entity
3037  * with a compound type.  It explicitly specifies the entity selected.
3038  * Dynamically the node may select entities that overwrite the given
3039  * entity.  If the selected entity is an array element entity the Sel
3040  * node takes the required array indices as inputs.
3041  * Adds the node to the block in current_ir_block.
3042  *
3043  * @param   *db        A pointer for debug information.
3044  * @param   *store     The memory in which the object the entity should be selected
3045  *                     from is allocated.
3046  * @param   *objptr    A pointer to a compound entity the Sel operation selects a
3047  *                     single attribute from.
3048  * @param   arity      The number of array indices needed to select an array element entity.
3049  * @param   *in[]      If the compound entity is an array the indices of the selected
3050  *                     element entity.  The constructor copies this array.
3051  * @param   *ent       The entity to select.
3052  */
3053 ir_node *new_d_Sel    (dbg_info *db, ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3054                        ir_entity *ent);
3055
3056 /** Constructor for a Call node.
3057  *
3058  *  Represents all kinds of method and function calls.
3059  *  Adds the node to the block in current_ir_block.
3060  *
3061  * @param   *db     A pointer for debug information.
3062  * @param   *store  The actual store.
3063  * @param   *callee A pointer to the called procedure.
3064  * @param   arity   The number of procedure parameters.
3065  * @param   *in[]   An array with the pointers to the parameters. The constructor copies this array.
3066  * @param   *tp     Type information of the procedure called.
3067  */
3068 ir_node *new_d_Call   (dbg_info *db, ir_node *store, ir_node *callee, int arity, ir_node *in[],
3069              ir_type *tp);
3070
3071 /** Constructor for a Add node.
3072  *
3073  * Adds the node to the block in current_ir_block.
3074  *
3075  * @param   *db    A pointer for debug information.
3076  * @param   *op1   The first operand.
3077  * @param   *op2   The second operand.
3078  * @param   *mode  The mode of the operands and the result.
3079  */
3080 ir_node *new_d_Add    (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3081
3082 /** Constructor for a Sub node.
3083  *
3084  * Adds the node to the block in current_ir_block.
3085  *
3086  * @param   *db    A pointer for debug information.
3087  * @param   *op1   The first operand.
3088  * @param   *op2   The second operand.
3089  * @param   *mode  The mode of the operands and the result.
3090  */
3091 ir_node *new_d_Sub    (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3092
3093 /** Constructor for a Minus node.
3094  *
3095  * Adds the node to the block in current_ir_block.
3096  *
3097  * @param   *db    A pointer for debug information.
3098  * @param   *op    The operand .
3099  * @param   *mode  The mode of the operand and the result.
3100  */
3101 ir_node *new_d_Minus  (dbg_info *db, ir_node *op,  ir_mode *mode);
3102
3103 /** Constructor for a Mul node.
3104  *
3105  * Adds the node to the block in current_ir_block.
3106  *
3107  * @param   *db    A pointer for debug information.
3108  * @param   *op1   The first operand.
3109  * @param   *op2   The second operand.
3110  * @param   *mode  The mode of the operands and the result.
3111  */
3112 ir_node *new_d_Mul    (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3113
3114 /** Constructor for a Mulh node.
3115  *
3116  * Adds the node to the block in current_ir_block.
3117  *
3118  * @param   *db    A pointer for debug information.
3119  * @param   *op1   The first operand.
3120  * @param   *op2   The second operand.
3121  * @param   *mode  The mode of the operands and the result.
3122  */
3123 ir_node *new_d_Mulh   (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3124
3125 /** Constructor for a Quot node.
3126  *
3127  * Adds the node to the block in current_ir_block.
3128  *
3129  * @param   *db    A pointer for debug information.
3130  * @param   *memop The store needed to model exceptions
3131  * @param   *op1   The first operand.
3132  * @param   *op2   The second operand.
3133  * @param   *mode  The mode of the result.
3134  * @param   state  The pinned state.
3135  */
3136 ir_node *new_d_Quot   (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3137
3138 /** Constructor for a DivMod node.
3139  *
3140  * Adds the node to the block in current_ir_block.
3141  *
3142  * @param   *db    A pointer for debug information.
3143  * @param   *memop The store needed to model exceptions
3144  * @param   *op1   The first operand.
3145  * @param   *op2   The second operand.
3146  * @param   *mode  The mode of the results.
3147  * @param   state  The pinned state.
3148  */
3149 ir_node *new_d_DivMod (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3150
3151 /** Constructor for a Div node.
3152  *
3153  * Adds the node to the block in current_ir_block.
3154  *
3155  * @param   *db    A pointer for debug information.
3156  * @param   *memop The store needed to model exceptions
3157  * @param   *op1   The first operand.
3158  * @param   *op2   The second operand.
3159  * @param   *mode  The mode of the result.
3160  * @param   state  The pinned state.
3161  */
3162 ir_node *new_d_Div    (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3163
3164 /** Constructor for a remainderless Div node.
3165  *
3166  * Adds the node to the block in current_ir_block.
3167  *
3168  * @param   *db    A pointer for debug information.
3169  * @param   *memop The store needed to model exceptions
3170  * @param   *op1   The first operand.
3171  * @param   *op2   The second operand.
3172  * @param   *mode  The mode of the result.
3173  * @param   state  The pinned state.
3174  */
3175 ir_node *new_d_DivRL  (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3176
3177 /** Constructor for a Mod node.
3178  *
3179  * Adds the node to the block in current_ir_block.
3180  *
3181  * @param   *db    A pointer for debug information.
3182  * @param   *memop The store needed to model exceptions
3183  * @param   *op1   The first operand.
3184  * @param   *op2   The second operand.
3185  * @param   *mode  The mode of the result.
3186  * @param   state  The pinned state.
3187  */
3188 ir_node *new_d_Mod    (dbg_info *db, ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3189
3190 /** Constructor for a Abs node.
3191  *
3192  * Adds the node to the block in current_ir_block.
3193  *
3194  * @param   *db    A pointer for debug information.
3195  * @param   *op    The operand
3196  * @param   *mode  The mode of the operands and the result.
3197  */
3198 ir_node *new_d_Abs    (dbg_info *db, ir_node *op,                ir_mode *mode);
3199
3200 /** Constructor for a And node.
3201  *
3202  * Adds the node to the block in current_ir_block.
3203  *
3204  * @param   *db    A pointer for debug information.
3205  * @param   *op1   The first operand.
3206  * @param   *op2   The second operand.
3207  * @param   *mode  The mode of the operands and the result.
3208  */
3209 ir_node *new_d_And    (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3210
3211 /** Constructor for a Or node.
3212  *
3213  * Adds the node to the block in current_ir_block.
3214  *
3215  * @param   *db    A pointer for debug information.
3216  * @param   *op1   The first operand.
3217  * @param   *op2   The second operand.
3218  * @param   *mode  The mode of the operands and the result.
3219  */
3220 ir_node *new_d_Or     (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3221
3222 /** Constructor for a Eor node.
3223  *
3224  * Adds the node to the block in current_ir_block.
3225  *
3226  * @param   *db    A pointer for debug information.
3227  * @param   *op1   The first operand.
3228  * @param   *op2   The second operand.
3229  * @param   *mode  The mode of the operands and the results.
3230  */
3231 ir_node *new_d_Eor    (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3232
3233 /** Constructor for a Not node.
3234  *
3235  * Adds the node to the block in current_ir_block.
3236  *
3237  * @param   *db    A pointer for debug information.
3238  * @param   *op    The operand.
3239  * @param   *mode  The mode of the operand and the result.
3240  */
3241 ir_node *new_d_Not    (dbg_info *db, ir_node *op,                ir_mode *mode);
3242
3243 /** Constructor for a Shl node.
3244  *
3245  * Adds the node to the block in current_ir_block.
3246  *
3247  * @param   *db    A pointer for debug information.
3248  * @param   *op    The operand.
3249  * @param   *k     The number of bits to  shift the operand .
3250  * @param   *mode  The mode of the operand and the result.
3251  */
3252 ir_node *new_d_Shl    (dbg_info *db, ir_node *op,  ir_node *k,   ir_mode *mode);
3253
3254 /** Constructor for a Shr node.
3255  *
3256  * Adds the node to the block in current_ir_block.
3257  *
3258  * @param   *db    A pointer for debug information.
3259  * @param   *op    The operand.
3260  * @param   *k     The number of bits to  shift the operand .
3261  * @param   *mode  The mode of the operand and the result.
3262  */
3263 ir_node *new_d_Shr    (dbg_info *db, ir_node *op,  ir_node *k,   ir_mode *mode);
3264
3265 /** Constructor for a Shrs node.
3266  *
3267  * Adds the node to the block in current_ir_block.
3268  *
3269  * @param   *db    A pointer for debug information.
3270  * @param   *op    The operand.
3271  * @param   *k     The number of bits to  shift the operand .
3272  * @param   *mode  The mode of the operand and the result.
3273  */
3274 ir_node *new_d_Shrs   (dbg_info *db, ir_node *op,  ir_node *k,   ir_mode *mode);
3275
3276 /** Constructor for a Rotl node.
3277  *
3278  * Adds the node to the block in current_ir_block.
3279  *
3280  * @param   *db    A pointer for debug information.
3281  * @param   *op    The operand.
3282  * @param   *k     The number of bits to rotate the operand.
3283  * @param   *mode  The mode of the operand.
3284  */
3285 ir_node *new_d_Rotl   (dbg_info *db, ir_node *op,  ir_node *k,   ir_mode *mode);
3286
3287 /** Constructor for a Cmp node.
3288  *
3289  * Adds the node to the block in current_ir_block.
3290  *
3291  * @param   *db    A pointer for debug information.
3292  * @param   *op1   The first operand.
3293  * @param   *op2   The second operand.
3294  */
3295 ir_node *new_d_Cmp    (dbg_info *db, ir_node *op1, ir_node *op2);
3296
3297 /** Constructor for a Conv node.
3298  *
3299  * Adds the node to the block in current_ir_block.
3300  *
3301  * @param   *db    A pointer for debug information.
3302  * @param   *op    The operand.
3303  * @param   *mode  The mode of this the operand muss be converted .
3304  */
3305 ir_node *new_d_Conv   (dbg_info *db, ir_node *op, ir_mode *mode);
3306
3307 /** Constructor for a strict Conv node.
3308  *
3309  * Adds the node to the block in current_ir_block.
3310  *
3311  * @param   *db    A pointer for debug information.
3312  * @param   *op    The operand.
3313  * @param   *mode  The mode of this the operand muss be converted .
3314  */
3315 ir_node *new_d_strictConv   (dbg_info *db, ir_node *op, ir_mode *mode);
3316
3317 /** Constructor for a Cast node.
3318  *
3319  * High level type cast
3320  * Adds the node to the block in current_ir_block.
3321  *
3322  * @param   *db    A pointer for debug information.
3323  * @param   *op    The operand.
3324  * @param   *to_tp The type of this the operand muss be casted .
3325  */
3326 ir_node *new_d_Cast   (dbg_info *db, ir_node *op, ir_type *to_tp);
3327
3328 /** Constructor for a Carry node.
3329  *
3330  * Adds the node to the block in current_ir_block.
3331  *
3332  * @param   *db    A pointer for debug information.
3333  * @param   *op1   The first operand.
3334  * @param   *op2   The second operand.
3335  * @param   *mode  The mode of the operands and the result.
3336  */
3337 ir_node *new_d_Carry  (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3338
3339 /** Constructor for a Borrow node.
3340  *
3341  * Adds the node to the block in current_ir_block.
3342  *
3343  * @param   *db    A pointer for debug information.
3344  * @param   *op1   The first operand.
3345  * @param   *op2   The second operand.
3346  * @param   *mode  The mode of the operands and the result.
3347  */
3348 ir_node *new_d_Borrow (dbg_info *db, ir_node *op1, ir_node *op2, ir_mode *mode);
3349
3350 /** Constructor for a Phi node.
3351  *
3352  * Adds the node to the block in current_ir_block.
3353  *
3354  * @param *db    A pointer for debug information.
3355  * @param arity  The number of predecessors
3356  * @param *in    Array with predecessors
3357  * @param *mode  The mode of it's inputs and output.
3358  */
3359 ir_node *new_d_Phi    (dbg_info *db, int arity, ir_node *in[], ir_mode *mode);
3360
3361 /** Constructor for a Load node.
3362  *
3363  * Adds the node to the block in current_ir_block.
3364  *
3365  * @param *db    A pointer for debug information.
3366  * @param *store The current memory
3367  * @param *addr  A pointer to the variable to be read in this memory.
3368  * @param *mode  The mode of the value to be loaded.
3369  */
3370 ir_node *new_d_Load   (dbg_info *db, ir_node *store, ir_node *addr, ir_mode *mode);
3371
3372 /** Constructor for a Store node.
3373  *
3374  * Adds the node to the block in current_ir_block.
3375  *
3376  * @param *db    A pointer for debug information.
3377  * @param *store The current memory
3378  * @param *addr  A pointer to the variable to be read in this memory.
3379  * @param *val   The value to write to this variable.
3380  */
3381 ir_node *new_d_Store  (dbg_info *db, ir_node *store, ir_node *addr, ir_node *val);
3382
3383 /** Constructor for a Alloc node.
3384  *
3385  * The Alloc node extends the memory by space for an entity of type alloc_type.
3386  * Adds the node to the block in current_ir_block.
3387  *
3388  * @param *db         A pointer for debug information.
3389  * @param *store      The memory which shall contain the new variable.
3390  * @param *size       The number of bytes to allocate.
3391  * @param *alloc_type The type of the allocated variable.
3392  * @param where       Where to allocate the variable, either heap_alloc or stack_alloc.
3393  */
3394 ir_node *new_d_Alloc  (dbg_info *db, ir_node *store, ir_node *size, ir_type *alloc_type,
3395                        ir_where_alloc where);
3396
3397  /** Constructor for a Free node.
3398  *
3399  * Frees the memory occupied by the entity pointed to by the pointer
3400  * arg.  Type indicates the type of the entity the argument points to.
3401  * Adds the node to the block in current_ir_block.
3402  *
3403  * @param *db         A pointer for debug information.
3404  * @param *store      The memory which shall contain the new variable.
3405  * @param *ptr        The pointer to the object to free.
3406  * @param *size       The number of objects of type free_type to free in a sequence.
3407  * @param *free_type  The type of the freed variable.
3408  * @param where       Where the variable was allocated, either heap_alloc or stack_alloc.
3409  */
3410 ir_node *new_d_Free   (dbg_info *db, ir_node *store, ir_node *ptr, ir_node *size,
3411              ir_type *free_type, ir_where_alloc where);
3412
3413 /** Constructor for a Sync node.
3414  *
3415  * Merges several memory values.  The node assumes that a variable
3416  * either occurs only in one of the memories, or it contains the same
3417  * value in all memories where it occurs.
3418  * Adds the node to the block in current_ir_block.
3419  *
3420  * @param *db       A pointer for debug information.
3421  * @param  arity    The number of memories to synchronize.
3422  * @param  **in     An array of pointers to nodes that produce an output of type
3423  *                  memory.  The constructor copies this array.
3424  */
3425 ir_node *new_d_Sync   (dbg_info *db, int arity, ir_node *in[]);
3426
3427 /** Constructor for a Proj node.
3428  *
3429  * Projects a single value out of a tuple.  The parameter proj gives the
3430  * position of the value within the tuple.
3431  * Adds the node to the block in current_ir_block.
3432  *
3433  * @param *db    A pointer for deubug information.
3434  * @param arg    A node producing a tuple.
3435  * @param *mode  The mode of the value to project.
3436  * @param proj   The position of the value in the tuple.
3437  */
3438 ir_node *new_d_Proj   (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3439
3440 /** Constructor for a defaultProj node.
3441  *
3442  * Represents the default control flow of a Switch-Cond node.
3443  * Adds the node to the block in current_ir_block.
3444  *
3445  * @param *db       A pointer for debug information.
3446  * @param arg       A node producing a tuple.
3447  * @param max_proj  The end  position of the value in the tuple.
3448  */
3449 ir_node *new_d_defaultProj (dbg_info *db, ir_node *arg, long max_proj);
3450
3451 /** Constructor for a Tuple node.
3452  *
3453  * This is an auxiliary node to replace a node that returns a tuple
3454  * without changing the corresponding Proj nodes.
3455  * Adds the node to the block in current_ir_block.
3456  *
3457  * @param *db     A pointer for debug information.
3458  * @param arity   The number of tuple elements.
3459  * @param **in    An array containing pointers to the nodes producing the tuple elements.
3460  */
3461 ir_node *new_d_Tuple  (dbg_info *db, int arity, ir_node *in[]);
3462
3463 /** Constructor for a Id node.
3464  *
3465  * This is an auxiliary node to replace a node that returns a single
3466  * value. Adds the node to the block in current_ir_block.
3467  *
3468  * @param *db     A pointer for debug information.
3469  * @param *val    The operand to Id.
3470  * @param *mode   The mode of *val.
3471  */
3472 ir_node *new_d_Id     (dbg_info *db, ir_node *val, ir_mode *mode);
3473
3474 /** Constructor for a Confirm node.
3475  *
3476  * Constructor for a Confirm node. Adds the node to the block in current_ir_block.
3477  * Specifies constraints for a value.  To support dataflow analyses.
3478  *
3479  * Example: If the value never exceeds '100' this is expressed by placing a
3480  * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
3481  *
3482  * @param *db     A pointer for debug information.
3483  * @param *val    The value we express a constraint for
3484  * @param *bound  The value to compare against. Must be a firm node, typically a constant.
3485  * @param cmp     The compare operation.
3486  */
3487 ir_node *new_d_Confirm (dbg_info *db, ir_node *val, ir_node *bound, pn_Cmp cmp);
3488
3489 /** Constructor for an Unknown node.
3490  *
3491  * Represents an arbitrary value.  Places the node in
3492  * the start block.
3493  *
3494  * @param *m      The mode of the unknown value.
3495  */
3496 ir_node *new_d_Unknown(ir_mode *m);
3497
3498 /** Constructor for a CallBegin node.
3499  *
3500  * CallBegin represents control flow depending of the pointer value
3501  * representing the called method to the called methods.  The
3502  * constructor copies the method pointer input from the passed Call
3503  * node.Adds the node to the block in current_ir_block.
3504  *
3505  * @param *db     A pointer for debug information.
3506  * @param *callee The call node visible in the  intra procedural view.
3507  */
3508 ir_node *new_d_CallBegin(dbg_info *db, ir_node *callee);
3509
3510 /** Constructor for an EndReg node.
3511  *
3512  *Adds the node to the block in current_ir_block.
3513  *
3514  * @param *db     A pointer for debug information.
3515  */
3516 ir_node *new_d_EndReg (dbg_info *db);
3517
3518 /** Constructor for an EndExcept node.
3519  *
3520  * Used to represent regular procedure end in interprocedual view.
3521  * Adds the node to the block in current_ir_block.
3522  *
3523  * @param *db     A pointer for debug information.
3524  */
3525 ir_node *new_d_EndExcept(dbg_info *db);
3526
3527 /** Constructor for a Break node.
3528  *
3529  * Used to represent exceptional procedure end in interprocedural view.
3530  * Adds the node to the block in current_ir_block.
3531  *
3532  * Break represents control flow to a single control successor just as Jmp.
3533  * The blocks separated by a break may not be concatenated by an optimization.
3534  * It is used for the interprocedural representation where blocks are parted
3535  * behind Call nodes to represent the control flow to called procedures.
3536  *
3537  * @param *db     A pointer for debug information.
3538  */
3539 ir_node *new_d_Break (dbg_info *db);
3540
3541 /** Constructor for a Filter node.
3542  *
3543  * Constructor for a Filter node. Adds the node to the block in
3544  * current_ir_block.  Filter is a node with two views used to
3545  * construct the interprocedural view.  In intraprocedural view its
3546  * semantics are identical to the Proj node.  In interprocedural view
3547  * the Filter performs the Phi operation on method parameters or
3548  * results.  Other than a Phi a Filter node may not be removed if it
3549  * has only a single input.
3550  *
3551  * The constructor builds the Filter in intraprocedural view.
3552  *
3553  * @param *db   A pointer for debug information.
3554  * @param *arg  The tuple value to project from.
3555  * @param *mode The mode of the projected value.
3556  * @param proj  The position in the tuple to project from.
3557  */
3558 ir_node *new_d_Filter (dbg_info *db, ir_node *arg, ir_mode *mode, long proj);
3559
3560 /** Constructor for a Mux node.
3561  *
3562  * @param *db       A pointer for debug information.
3563  * @param *sel      The ir_node that calculates the boolean select.
3564  * @param *ir_true  The ir_node that calculates the true result.
3565  * @param *ir_false The ir_node that calculates the false result.
3566  * @param *mode     The mode of the node (and it_true and ir_false).
3567  */
3568 ir_node *new_d_Mux  (dbg_info *db, ir_node *sel,
3569     ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
3570
3571 /** Constructor for a CopyB node.
3572  *
3573  * @param *db         A pointer for debug information.
3574  * @param *store      The current memory
3575  * @param *dst        The ir_node that represents the destination address.
3576  * @param *src        The ir_node that represents the source address.
3577  * @param *data_type  The type of the copied data
3578  */
3579 ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
3580
3581 /** Constructor for a InstOf node.
3582  *
3583  * A High-Level Type check.
3584  *
3585  * @param   *db        A pointer for debug information.
3586  * @param   *store     The memory in which the object the entity should be selected
3587  *                     from is allocated.
3588  * @param   *objptr    A pointer to a object of a class type.
3589  * @param   *type      The type of which objptr must be.
3590  */
3591 ir_node *new_d_InstOf (dbg_info *db, ir_node *store, ir_node *objptr, ir_type *type);
3592
3593 /** Constructor for a Raise node.
3594  *
3595  * A High-Level Exception throw.
3596  *
3597  * @param *db    A pointer for debug information.
3598  * @param *store The current memory.
3599  * @param *obj   A pointer to the Except variable.
3600  */
3601 ir_node *new_d_Raise  (dbg_info *db, ir_node *store, ir_node *obj);
3602
3603 /** Constructor for a Bound node.
3604  *
3605  * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
3606  *
3607  * @param *db         A pointer for debug information.
3608  * @param *store      The current memory
3609  * @param *idx        The ir_node that represents an index.
3610  * @param *lower      The ir_node that represents the lower bound for the index.
3611  * @param *upper      The ir_node that represents the upper bound for the index.
3612  */
3613 ir_node *new_d_Bound(dbg_info *db, ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
3614
3615 /** Constructor for a Pin node.
3616  *
3617  * @param *db         A pointer for debug information.
3618  * @param *node       The node which value should be pinned.
3619  */
3620 ir_node *new_d_Pin(dbg_info *db, ir_node *node);
3621
3622 /** Constructor for an ASM pseudo node.
3623  *
3624  * @param *db         A pointer for debug information.
3625  * @param arity       The number of data inputs to the node.
3626  * @param *in         The array of length arity of data inputs.
3627  * @param *inputs     The array of length arity of input constraints.
3628  * @param n_outs      The number of data outputs to the node.
3629  * @param *outputs    The array of length n_outs of output constraints.
3630  * @param n_clobber   The number of clobbered registers.
3631  * @param *clobber    The array of length n_clobber of clobbered registers.
3632  * @param *asm_text   The assembler text.
3633  */
3634 ir_node *new_d_ASM(dbg_info *db, int arity, ir_node *in[], ir_asm_constraint *inputs,
3635                    int n_outs, ir_asm_constraint *outputs,
3636                    int n_clobber, ident *clobber[], ident *asm_text);
3637
3638 /*-----------------------------------------------------------------------*/
3639 /* The block oriented interface without debug support                    */
3640 /*-----------------------------------------------------------------------*/
3641
3642 /* Needed from the interface with debug support:
3643 void set_cur_block (ir_node *target);   */
3644
3645 /** Constructor for a Block node.
3646  *
3647  * Constructor for a Block node. Adds the block to the graph in
3648  * current_ir_graph.  Constructs a Block with a fixed number of
3649  * predecessors.  Does set current_block.  Can be used with automatic
3650  * Phi node construction.
3651  *
3652  * @param arity  The number of control predecessors.
3653  * @param in     An array of control predecessors.  The length of
3654  *               the array must be 'arity'.
3655  */
3656 ir_node *new_Block(int arity, ir_node *in[]);
3657
3658 /** Constructor for a Start node.
3659  *
3660  * Adds the node to the block in current_ir_block.
3661  *
3662  */
3663 ir_node *new_Start  (void);
3664
3665 /** Constructor for an End node.
3666  *
3667  * Adds the node to the block in current_ir_block.
3668  */
3669 ir_node *new_End    (void);
3670
3671 /** Constructor for an EndReg node.
3672  *
3673  * Used to represent regular procedure end in interprocedual view.
3674  * Adds the node to the block in current_ir_block.
3675  */
3676 ir_node *new_EndReg (void);
3677
3678 /** Constructor for an EndExpcept node.
3679  *
3680  *  Used to represent exceptional procedure end in interprocedural view.
3681  *  Adds the node to the block in current_ir_block.
3682  */
3683 ir_node *new_EndExcept(void);
3684
3685 /** Constructor for a Jump node.
3686  *
3687  * Adds the node to the block in current_ir_block.
3688  *
3689  * Jmp represents control flow to a single control successor.
3690  */
3691 ir_node *new_Jmp    (void);
3692
3693 /** Constructor for an IJmp node.
3694  *
3695  * IJmp represents control flow to a single control successor not
3696  * statically known i.e. an indirect Jmp.
3697  *
3698  * @param *tgt    The IR node representing the target address.
3699  */
3700 ir_node *new_IJmp   (ir_node *tgt);
3701
3702 /** Constructor for a Break node.
3703  * Break represents control flow to a single control successor just as Jmp.
3704  * The blocks separated by a break may not be concatenated by an optimization.
3705  * It is used for the interprocedural representation where blocks are parted
3706  * behind Call nodes to represent the control flow to called procedures.
3707  * Adds the node to the block in current_ir_block.
3708  */
3709 ir_node *new_Break  (void);
3710
3711 /** Constructor for a Cond node.
3712  *
3713  * If c is mode_b represents a conditional branch (if/else). If c is
3714  * mode_Is/mode_Iu (?) represents a switch.  (Allocates dense Cond
3715  * node, default Proj is 0.). Adds the node to the block in current_ir_block.
3716  *
3717  * This is not consistent:  Input to Cond is Is, Proj has as proj number
3718  * longs.
3719  *
3720  *
3721  * @param *c     The conditions parameter.Can be of mode b or I_u.
3722  */
3723 ir_node *new_Cond   (ir_node *c);
3724
3725 /** Constructor for a Return node.
3726  *
3727  * Returns the memory and zero or more return values.  Only node that
3728  * can end regular control flow. Adds the node to the block in current_ir_block.
3729  *
3730  * @param *store The state of memory.
3731  * @param arity  Number of array indices.
3732  * @param *in    Array with index inputs to the node.
3733  */
3734 ir_node *new_Return (ir_node *store, int arity, ir_node *in[]);
3735
3736 /** Constructor for a Const node.
3737  *
3738  * Constructor for a Const node. The constant represents a target
3739  * value.  Sets the type information to type_unknown.  (No more
3740  * supported: If tv is entity derives a somehow useful type.)
3741  * Adds the node to the block in current_ir_block.
3742  * Derives mode from passed tarval.
3743  *
3744  * @param *con   Points to an entry in the constant table. This pointer is
3745  *               added to the attributes of  the node.
3746  */
3747 ir_node *new_Const (tarval *con);
3748
3749 /**
3750  * Make a const from a long.
3751  * This is just convenience for the usual
3752  * <code>
3753  * new_Const(mode, tarval_from_long(mode, ...))
3754  * </code>
3755  * pain.
3756  * @param mode The mode for the const.
3757  * @param value The value of the constant.
3758  * @return A new const node.
3759  */
3760 ir_node *new_Const_long(ir_mode *mode, long value);
3761
3762 /** Constructor for a Const node.
3763  *
3764  * Derives mode from passed tarval. */
3765 ir_node *new_Const_type(tarval *con, ir_type *tp);
3766
3767 /** Constructor for a SymConst node.
3768  *
3769  * Adds the node to the block in current_ir_block.
3770  * This is the constructor for a symbolic constant.
3771  * There are four kinds of symbolic constants:
3772  *    -# type_tag  The symbolic constant represents a type tag.  The type the
3773  *                 tag stands for is given explicitly.
3774  *    -# size      The symbolic constant represents the size of a type.  The
3775  *                 type of which the constant represents the size is given
3776  *                 explicitly.
3777  *    -# align     The symbolic constant represents the alignment of a type.  The
3778  *                 type of which the constant represents the size is given
3779  *                 explicitly.
3780  *    -# addr_name The symbolic constant represents the address of an entity
3781  *                 (variable or method).  The variable is indicated by a name
3782  *                 that is valid for linking.
3783  *    -# addr_ent  The symbolic constant represents the address of an entity
3784  *                 (variable or method).  The variable is given explicitly by
3785  *                 a firm entity.
3786  *
3787  *    Inputs to the node:
3788  *      No inputs except the block it belongs to.
3789  *    Outputs of the node.
3790  *      An unsigned integer (I_u) or a pointer (P).
3791  *
3792  * @param mode    The mode for the SymConst.
3793  * @param value   A type or a ident depending on the SymConst kind.
3794  * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3795  *                symconst_type_align, symconst_addr_name or symconst_addr_ent.
3796  * @param tp      The source type of the constant.
3797  */
3798 ir_node *new_SymConst_type(ir_mode *mode, union symconst_symbol value, symconst_kind kind, ir_type *tp);
3799
3800 /** Constructor for a SymConst node.
3801  *
3802  * Adds the node to the block in current_ir_block.
3803  * This is the constructor for a symbolic constant.
3804  * There are four kinds of symbolic constants:
3805  *    -# type_tag  The symbolic constant represents a type tag.  The type the
3806  *                 tag stands for is given explicitly.
3807  *    -# size      The symbolic constant represents the size of a type.  The
3808  *                 type of which the constant represents the size is given
3809  *                 explicitly.
3810  *    -# align     The symbolic constant represents the alignment of a type.  The
3811  *                 type of which the constant represents the size is given
3812  *                 explicitly.
3813  *    -# addr_name The symbolic constant represents the address of an entity
3814  *                 (variable or method).  The variable is indicated by a name
3815  *                 that is valid for linking.
3816  *    -# addr_ent  The symbolic constant represents the address of an entity
3817  *                 (variable or method).  The variable is given explicitly by
3818  *                 a firm entity.
3819  *
3820  *    Inputs to the node:
3821  *      No inputs except the block it belongs to.
3822  *    Outputs of the node.
3823  *      An unsigned integer (I_u) or a pointer (P).
3824  *
3825  * @param mode    The mode for the SymConst.
3826  * @param value   A type or a ident depending on the SymConst kind.
3827  * @param kind    The kind of the symbolic constant: symconst_type_tag, symconst_type_size
3828  *                symconst_type_align, symconst_addr_name or symconst_addr_ent.
3829  */
3830 ir_node *new_SymConst(ir_mode *mode, union symconst_symbol value, symconst_kind kind);
3831
3832 /** Constructor for a simpelSel node.
3833  *
3834  *  This is a shortcut for the new_Sel() constructor.  To be used for
3835  *  Sel nodes that do not select from an array, i.e., have no index
3836  *  inputs.  It adds the two parameters 0, NULL.
3837  *
3838  * @param   *store     The memory in which the object the entity should be selected from is allocated.
3839  * @param   *objptr    The object from that the Sel operation selects a single attribute out.
3840  * @param   *ent       The entity to select.
3841  */
3842 ir_node *new_simpleSel(ir_node *store, ir_node *objptr, ir_entity *ent);
3843
3844 /** Constructor for a Sel node.
3845  *
3846  * The select node selects an entity (field or method) from an entity
3847  * with a compound type.  It explicitly specifies the entity selected.
3848  * Dynamically the node may select entities that overwrite the given
3849  * entity.  If the selected entity is an array element entity the Sel
3850  * node takes the required array indices as inputs.
3851  * Adds the node to the block in current_ir_block.
3852  *
3853  * @param   *store     The memory in which the object the entity should be selected
3854  *                     from is allocated.
3855  * @param   *objptr    A pointer to a compound entity the Sel operation selects a
3856  *                     single attribute from.
3857  * @param   arity      The number of array indices needed to select an array element entity.
3858  * @param   *in[]      If the compound entity is an array the indices of the selected
3859  *                     element entity.  The constructor copies this array.
3860  * @param   *ent       The entity to select.
3861  */
3862 ir_node *new_Sel    (ir_node *store, ir_node *objptr, int arity, ir_node *in[],
3863                      ir_entity *ent);
3864
3865 /** Constructor for a Call node.
3866  *
3867  *  Adds the node to the block in current_ir_block.
3868  *  Represents all kinds of method and function calls.
3869  *
3870  * @param   *store  The actual store.
3871  * @param   *callee A pointer to the called procedure.
3872  * @param   arity   The number of procedure parameters.
3873  * @param   *in[]   An array with the pointers to the parameters. The constructor copies this array.
3874  * @param   *tp     Type information of the procedure called.
3875  */
3876 ir_node *new_Call   (ir_node *store, ir_node *callee, int arity, ir_node *in[],
3877                      ir_type *tp);
3878
3879 /** Constructor for a CallBegin node.
3880  *
3881  * CallBegin represents control flow depending of the pointer value
3882  * representing the called method to the called methods.  The
3883  * constructor copies the method pointer input from the passed Call
3884  * node. Adds the node to the block in current_ir_block.
3885  *
3886  * @param   *callee A pointer to the called procedure.
3887  */
3888 ir_node *new_CallBegin(ir_node *callee);
3889
3890 /** Constructor for a Add node.
3891  *
3892  * Adds the node to the block in current_ir_block.
3893  *
3894  * @param   *op1   The first operand.
3895  * @param   *op2   The second operand.
3896  * @param   *mode  The mode of the operands and the result.
3897  */
3898 ir_node *new_Add    (ir_node *op1, ir_node *op2, ir_mode *mode);
3899
3900 /** Constructor for a Sub node.
3901  *
3902  * Adds the node to the block in current_ir_block.
3903  *
3904  * @param   *op1   The first operand.
3905  * @param   *op2   The second operand.
3906  * @param   *mode  The mode of the operands and the result.
3907  */
3908 ir_node *new_Sub    (ir_node *op1, ir_node *op2, ir_mode *mode);
3909
3910 /** Constructor for a Minus node.
3911  *
3912  * Adds the node to the block in current_ir_block.
3913  *
3914  * @param   *op    The operand .
3915  * @param   *mode  The mode of the operand and the result.
3916  */
3917 ir_node *new_Minus  (ir_node *op,  ir_mode *mode);
3918
3919 /**
3920  * Constructor for a Mul node. Adds the node to the block in current_ir_block.
3921  *
3922  * @param   *op1   The first operand.
3923  * @param   *op2   The second operand.
3924  * @param   *mode  The mode of the operands and the result.
3925  */
3926 ir_node *new_Mul    (ir_node *op1, ir_node *op2, ir_mode *mode);
3927
3928 /**
3929  * Constructor for a Mulh node. Adds the node to the block in current_ir_block.
3930  *
3931  * @param   *op1   The first operand.
3932  * @param   *op2   The second operand.
3933  * @param   *mode  The mode of the operands and the result.
3934  */
3935 ir_node *new_Mulh   (ir_node *op1, ir_node *op2, ir_mode *mode);
3936
3937 /** Constructor for a Quot node.
3938  *
3939  * Adds the node to the block in current_ir_block.
3940  *
3941  * @param   *memop The store needed to model exceptions
3942  * @param   *op1   The first operand.
3943  * @param   *op2   The second operand.
3944  * @param   *mode  The mode of the result.
3945  * @param   state  The pinned state.
3946  */
3947 ir_node *new_Quot   (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3948
3949 /** Constructor for a DivMod node.
3950  *
3951  * Adds the node to the block in current_ir_block.
3952  *
3953  * @param   *memop The store needed to model exceptions
3954  * @param   *op1   The first operand.
3955  * @param   *op2   The second operand.
3956  * @param   *mode  The mode of the results.
3957  * @param   state  The pinned state.
3958  */
3959 ir_node *new_DivMod (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3960
3961 /** Constructor for a Div node.
3962  *
3963  * Adds the node to the block in current_ir_block.
3964  *
3965  * @param   *memop The store needed to model exceptions
3966  * @param   *op1   The first operand.
3967  * @param   *op2   The second operand.
3968  * @param   *mode  The mode of the result.
3969  * @param   state  The pinned state.
3970  */
3971 ir_node *new_Div    (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3972
3973 /** Constructor for a remainderless Div node.
3974  *
3975  * Adds the node to the block in current_ir_block.
3976  *
3977  * @param   *memop The store needed to model exceptions
3978  * @param   *op1   The first operand.
3979  * @param   *op2   The second operand.
3980  * @param   *mode  The mode of the result.
3981  * @param   state  The pinned state.
3982  */
3983 ir_node *new_DivRL  (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3984
3985 /** Constructor for a Mod node.
3986  *
3987  * Adds the node to the block in current_ir_block.
3988  *
3989  * @param   *memop The store needed to model exceptions
3990  * @param   *op1   The first operand.
3991  * @param   *op2   The second operand.
3992  * @param   *mode  The mode of the result.
3993  * @param   state  The pinned state.
3994  */
3995 ir_node *new_Mod    (ir_node *memop, ir_node *op1, ir_node *op2, ir_mode *mode, op_pin_state state);
3996
3997 /** Constructor for a Abs node.
3998  *
3999  * Adds the node to the block in current_ir_block.
4000  *
4001  * @param   *op    The operand
4002  * @param   *mode  The mode of the operands and the result.
4003  */
4004 ir_node *new_Abs    (ir_node *op,                ir_mode *mode);
4005
4006 /** Constructor for a And node.
4007  *
4008  * Adds the node to the block in current_ir_block.
4009  *
4010  * @param   *op1   The first operand.
4011  * @param   *op2   The second operand.
4012  * @param   *mode  The mode of the operands and the result.
4013  */
4014 ir_node *new_And    (ir_node *op1, ir_node *op2, ir_mode *mode);
4015
4016 /**
4017  * Constructor for a Or node. Adds the node to the block in current_ir_block.
4018  *
4019  * @param   *op1   The first operand.
4020  * @param   *op2   The second operand.
4021  * @param   *mode  The mode of the operands and the result.
4022  */
4023 ir_node *new_Or     (ir_node *op1, ir_node *op2, ir_mode *mode);
4024
4025 /**
4026  * Constructor for a Eor node. Adds the node to the block in current_ir_block.
4027  *
4028  * @param   *op1   The first operand.
4029  * @param   *op2   The second operand.
4030  * @param   *mode  The mode of the operands and the results.
4031  */
4032 ir_node *new_Eor    (ir_node *op1, ir_node *op2, ir_mode *mode);
4033
4034 /** Constructor for a Not node.
4035  *
4036  * Adds the node to the block in current_ir_block.
4037  *
4038  * @param   *op    The operand.
4039  * @param   *mode  The mode of the operand and the result.
4040  */
4041 ir_node *new_Not    (ir_node *op,                ir_mode *mode);
4042
4043 /** Constructor for a Shl node.
4044  *
4045  * Adds the node to the block in current_ir_block.
4046  *
4047  * @param   *op    The operand.
4048  * @param   *k     The number of bits to  shift the operand .
4049  * @param   *mode  The mode of the operand and the result.
4050  */
4051 ir_node *new_Shl    (ir_node *op,  ir_node *k,   ir_mode *mode);
4052
4053 /**
4054  * Constructor for a Shr node. Adds the node to the block in current_ir_block.
4055  *
4056  * @param   *op    The operand.
4057  * @param   *k     The number of bits to  shift the operand .
4058  * @param   *mode  The mode of the operand and the result.
4059  */
4060 ir_node *new_Shr    (ir_node *op,  ir_node *k,   ir_mode *mode);
4061
4062 /** Constructor for a Shrs node.
4063  *
4064  * Adds the node to the block in current_ir_block.
4065  *
4066  * @param   *op    The operand.
4067  * @param   *k     The number of bits to  shift the operand .
4068  * @param   *mode  The mode of the operand and the result.
4069  */
4070 ir_node *new_Shrs   (ir_node *op,  ir_node *k,   ir_mode *mode);
4071
4072 /** Constructor for a Rotl node.
4073  *
4074  * Adds the node to the block in current_ir_block.
4075  *
4076  * @param   *op    The operand.
4077  * @param   *k     The number of bits to rotate the operand.
4078  * @param   *mode  The mode of the operand.
4079  */
4080 ir_node *new_Rotl   (ir_node *op,  ir_node *k,   ir_mode *mode);
4081
4082 /** Constructor for a Cmp node.
4083  *
4084  * Adds the node to the block in current_ir_block.
4085  *
4086  * @param   *op1   The first operand.
4087  * @param   *op2   The second operand.
4088  */
4089 ir_node *new_Cmp    (ir_node *op1, ir_node *op2);
4090
4091 /** Constructor for a Conv node.
4092  *
4093  * Adds the node to the block in current_ir_block.
4094  *
4095  * @param   *op          The operand.
4096  * @param   *mode        The mode of this the operand muss be converted.
4097  */
4098 ir_node *new_Conv   (ir_node *op, ir_mode *mode);
4099
4100 /** Constructor for a strict Conv node.
4101  *
4102  * Adds the node to the block in current_ir_block.
4103  *
4104  * @param   *op          The operand.
4105  * @param   *mode        The mode of this the operand muss be converted.
4106  */
4107 ir_node *new_strictConv   (ir_node *op, ir_mode *mode);
4108
4109 /** Constructor for a Cast node.
4110  *
4111  * Adds the node to the block in current_ir_block.
4112  * High level type cast
4113  *
4114  * @param   *op    The operand.
4115  * @param   *to_tp The type of this the operand muss be casted .
4116  */
4117 ir_node *new_Cast   (ir_node *op, ir_type *to_tp);
4118
4119 /** Constructor for a Carry node.
4120  *
4121  * Adds the node to the block in current_ir_block.
4122  *
4123  * @param   *op1   The first operand.
4124  * @param   *op2   The second operand.
4125  * @param   *mode  The mode of the operands and the result.
4126  */
4127 ir_node *new_Carry  (ir_node *op1, ir_node *op2, ir_mode *mode);
4128
4129 /** Constructor for a Borrow node.
4130  *
4131  * Adds the node to the block in current_ir_block.
4132  *
4133  * @param   *op1   The first operand.
4134  * @param   *op2   The second operand.
4135  * @param   *mode  The mode of the operands and the result.
4136  */
4137 ir_node *new_Borrow (ir_node *op1, ir_node *op2, ir_mode *mode);
4138
4139 /** Constructor for a Phi node.
4140  *
4141  * Adds the node to the block in current_ir_block.
4142  *
4143  * @param arity  The number of predecessors.
4144  * @param *in    Array with predecessors.
4145  * @param *mode  The mode of it's inputs and output.
4146  */
4147 ir_node *new_Phi    (int arity, ir_node *in[], ir_mode *mode);
4148
4149 /** Constructor for a Load node.
4150  *
4151  * @param *store  The current memory.
4152  * @param *addr   A pointer to the variable to be read in this memory.
4153  * @param *mode   The mode of the value to be loaded.
4154  */
4155 ir_node *new_Load   (ir_node *store, ir_node *addr, ir_mode *mode);
4156
4157 /** Constructor for a Store node.
4158  *
4159  * @param *store  The current memory.
4160  * @param *addr   A pointer to the variable to be read in this memory.
4161  * @param *val    The value to write to this variable.
4162  */
4163 ir_node *new_Store  (ir_node *store, ir_node *addr, ir_node *val);
4164
4165 /** Constructor for a Alloc node.
4166  *
4167  * The Alloc node extends the memory by space for an entity of type alloc_type.
4168  * Adds the node to the block in current_ir_block.
4169  *
4170  * @param *store      The memory which shall contain the new variable.
4171  * @param *size       The number of bytes to allocate.
4172  * @param *alloc_type The type of the allocated variable.
4173  * @param where       Where to allocate the variable, either heap_alloc or stack_alloc.
4174  */
4175 ir_node *new_Alloc  (ir_node *store, ir_node *size, ir_type *alloc_type,
4176                      ir_where_alloc where);
4177
4178 /** Constructor for a Free node.
4179  *
4180  * Frees the memory occupied by the entity pointed to by the pointer
4181  * arg.  Type indicates the type of the entity the argument points to.
4182  * Adds the node to the block in current_ir_block.
4183  *
4184  * @param *store      The memory which shall contain the new variable.
4185  * @param *ptr        The pointer to the object to free.
4186  * @param *size       The number of objects of type free_type to free in a sequence.
4187  * @param *free_type  The type of the freed variable.
4188  * @param where       Where the variable was allocated, either heap_alloc or stack_alloc.
4189  */
4190 ir_node *new_Free   (ir_node *store, ir_node *ptr, ir_node *size,
4191                              ir_type *free_type, ir_where_alloc where);
4192
4193 /** Constructor for a Sync node.
4194  *
4195  * Merges several memory values.  The node assumes that a variable
4196  * either occurs only in one of the memories, or it contains the same
4197  * value in all memories where it occurs.
4198  * Adds the node to the block in current_ir_block.
4199  *
4200  * @param  arity    The number of memories to synchronize.
4201  * @param  **in     An array of pointers to nodes that produce an output of type
4202  *                  memory.  The constructor copies this array.
4203  */
4204 ir_node *new_Sync   (int arity, ir_node *in[]);
4205
4206 /** Constructor for a Proj node.
4207  *
4208  * Projects a single value out of a tuple.  The parameter proj gives the
4209  * position of the value within the tuple.
4210  * Adds the node to the block in current_ir_block.
4211  *
4212  * @param arg    A node producing a tuple.
4213  * @param *mode  The mode of the value to project.
4214  * @param proj   The position of the value in the tuple.
4215  */
4216 ir_node *new_Proj   (ir_node *arg, ir_mode *mode, long proj);
4217
4218 /** Constructor for a Filter node.
4219  *
4220  * Constructor for a Filter node. Adds the node to the block in current_ir_block.
4221  * Filter is a node with two views used to construct the interprocedural view.
4222  * In intraprocedural view its semantics are identical to the Proj node.
4223  * In interprocedural view the Filter performs the Phi operation on method
4224  * parameters or results.  Other than a Phi a Filter node may not be removed
4225  * if it has only a single input.
4226  *
4227  * The constructor builds the Filter in intraprocedural view.
4228  *
4229  * @param *arg  The tuple value to project from.
4230  * @param *mode The mode of the projected value.
4231  * @param proj  The position in the tuple to project from.
4232  */
4233 ir_node *new_Filter (ir_node *arg, ir_mode *mode, long proj);
4234
4235 /** Constructor for a defaultProj node.
4236  *
4237  * Represents the default control flow of a Switch-Cond node.
4238  * Adds the node to the block in current_ir_block.
4239  *
4240  * @param arg       A node producing a tuple.
4241  * @param max_proj  The end  position of the value in the tuple.
4242  */
4243 ir_node *new_defaultProj (ir_node *arg, long max_proj);
4244
4245 /** Constructor for a Tuple node.
4246  *
4247  * This is an auxiliary node to replace a node that returns a tuple
4248  * without changing the corresponding Proj nodes.
4249  * Adds the node to the block in current_ir_block.
4250  *
4251  * @param arity   The number of tuple elements.
4252  * @param **in    An array containing pointers to the nodes producing the tuple elements.
4253  */
4254 ir_node *new_Tuple  (int arity, ir_node *in[]);
4255
4256 /** Constructor for an Id node.
4257  *
4258  * This is an auxiliary node to replace a node that returns a single
4259  * value. Adds the node to the block in current_ir_block.
4260  *
4261  * @param *val    The operand to Id.
4262  * @param *mode   The mode of *val.
4263  */
4264 ir_node *new_Id     (ir_node *val, ir_mode *mode);
4265
4266 /** Constructor for a Bad node.
4267  *
4268  * Returns the unique Bad node of the graph.  The same as
4269  * get_irg_bad().
4270  */
4271 ir_node *new_Bad    (void);
4272
4273 /** Constructor for a Confirm node.
4274  *
4275  * Specifies constraints for a value.  To support dataflow analyses.
4276  * Adds the node to the block in current_ir_block.
4277  *
4278  * Example: If the value never exceeds '100' this is expressed by placing a
4279  * Confirm node val = new_d_Confirm(db, val, 100, '<=') on the dataflow edge.
4280  *
4281  * @param *val    The value we express a constraint for
4282  * @param *bound  The value to compare against. Must be a firm node, typically a constant.
4283  * @param cmp     The compare operation.
4284  */
4285 ir_node *new_Confirm (ir_node *val, ir_node *bound, pn_Cmp cmp);
4286
4287 /** Constructor for an Unknown node.
4288  *
4289  * Represents an arbitrary value.  Places the node in
4290  * the start block.
4291  *
4292  * @param *m      The mode of the unknown value.
4293  */
4294 ir_node *new_Unknown(ir_mode *m);
4295
4296 /** Constructor for a NoMem node.
4297  *
4298  * Returns the unique NoMem node of the graph.  The same as
4299  * get_irg_no_mem().
4300  */
4301 ir_node *new_NoMem  (void);
4302
4303 /** Constructor for a Mux node.
4304  *
4305  * Adds the node to the block in current_ir_block.
4306  *
4307  * @param *sel      The ir_node that calculates the boolean select.
4308  * @param *ir_true  The ir_node that calculates the true result.
4309  * @param *ir_false The ir_node that calculates the false result.
4310  * @param *mode     The mode of the node (and it_true and ir_false).
4311  */
4312 ir_node *new_Mux  (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *mode);
4313
4314 /** Constructor for a CopyB node.
4315  *
4316  * Adds the node to the block in current_ir_block.
4317  *
4318  * @param *store      The current memory
4319  * @param *dst        The ir_node that represents the destination address.
4320  * @param *src        The ir_node that represents the source address.
4321  * @param *data_type  The type of the copied data
4322  */
4323 ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, ir_type *data_type);
4324
4325 /** Constructor for a InstOf node.
4326  *
4327  * A High-Level Type check.
4328  *
4329  * @param   *store     The memory in which the object the entity should be selected
4330  *                     from is allocated.
4331  * @param   *objptr    A pointer to a object of a class type.
4332  * @param   *type      The type of which objptr must be.
4333  */
4334 ir_node *new_InstOf (ir_node *store, ir_node *objptr, ir_type *type);
4335
4336 /**Constructor for a Raise node.
4337  *
4338  * A High-Level Exception throw.
4339  *
4340  * @param *store The current memory.
4341  * @param *obj   A pointer to the Except variable.
4342  */
4343 ir_node *new_Raise  (ir_node *store, ir_node *obj);
4344
4345 /** Constructor for a Bound node.
4346  *
4347  * A High-Level bounds check. Checks whether lower <= idx && idx < upper.
4348  *
4349  * Adds the node to the block in current_ir_block.
4350  *
4351  * @param *store      The current memory
4352  * @param *idx        The ir_node that represents an index.
4353  * @param *lower      The ir_node that represents the lower bound for the index.
4354  * @param *upper      The ir_node that represents the upper bound for the index.
4355  */
4356 ir_node *new_Bound  (ir_node *store, ir_node *idx, ir_node *lower, ir_node *upper);
4357
4358 /** Constructor for a Pin node.
4359  *
4360  * @param *node       The node which value should be pinned.
4361  */
4362 ir_node *new_Pin    (ir_node *node);
4363
4364 /** Constructor for an ASM pseudo node.
4365  *
4366  * @param arity       The number of data inputs to the node.
4367  * @param *in         The array of length arity of data inputs.
4368  * @param *inputs     The array of length arity of input constraints.
4369  * @param n_outs      The number of data outputs to the node.
4370  * @param *outputs    The array of length n_outs of output constraints.
4371  * @param n_clobber   The number of clobbered registers.
4372  * @param *clobber    The array of length n_clobber of clobbered registers.
4373  * @param *asm_text   The assembler text.
4374  */
4375 ir_node *new_ASM(int arity, ir_node *in[], ir_asm_constraint *inputs,
4376                  int n_outs, ir_asm_constraint *outputs,
4377                  int n_clobber, ident *clobber[], ident *asm_text);
4378
4379 /*---------------------------------------------------------------------*/
4380 /* The comfortable interface.                                          */
4381 /* Supports automatic Phi node construction.                           */
4382 /* All routines of the block oriented interface except new_Block are   */
4383 /* needed also.                                                        */
4384 /*---------------------------------------------------------------------*/
4385
4386 /** Create an immature Block.
4387  *
4388  * An immature Block has an unknown number of predecessors.  Predecessors
4389  * can be added with add_immBlock_pred().  Once all predecessors are
4390  * added the block must be matured.
4391  *
4392  * Adds the block to the graph in current_ir_graph. Does set
4393  * current_block.  Can be used with automatic Phi node construction.
4394  * This constructor can only be used if the graph is in
4395  * state_building.
4396  */
4397 ir_node *new_d_immBlock(dbg_info *db);
4398 ir_node *new_immBlock(void);
4399
4400 /** Create an immature PartBlock.
4401  *
4402  * An immature block has only one Block or PartBlock predecessor.
4403  * A PartBlock forms together with one BLock and possibly other
4404  * PartBlocks a MacroBlock.
4405  *
4406  * Adds the PartBlock to the graph in current_ir_graph. Does set
4407  * current_block.  Can be used with automatic Phi node construction.
4408  * This constructor can only be used if the graph is in
4409  * state_building.
4410  */
4411 ir_node *new_d_immPartBlock(dbg_info *db, ir_node *pred_jmp);
4412 ir_node *new_immPartBlock(ir_node *pred_jmp);
4413
4414 /** Add a control flow edge to an immature block. */
4415 void add_immBlock_pred(ir_node *immblock, ir_node *jmp);
4416
4417 /** Finalize a Block node, when all control flows are known. */
4418 void mature_immBlock(ir_node *block);
4419 #define mature_cur_block() mature_immBlock(get_cur_block());
4420
4421
4422 /** Get the current value of a local variable.
4423  *
4424  * Use this function to obtain the last definition of the local variable
4425  * associated with pos.  Pos may not exceed the value passed as n_loc
4426  * to new_ir_graph.  This call automatically inserts Phi nodes.
4427  *
4428  * @param *db    A pointer for debug information.
4429  * @param  pos   The position/id of the local variable.
4430  * @param *mode  The mode of the value to get.
4431  */
4432 ir_node *get_d_value(dbg_info *db, int pos, ir_mode *mode);
4433 ir_node *get_value(int pos, ir_mode *mode);
4434
4435 /** Remark a new definition of a variable.
4436  *
4437  * Use this function to remember a new definition of the value
4438  * associated with pos. Pos may not exceed the value passed as n_loc
4439  * to new_ir_graph.  This call is needed to automatically inserts Phi
4440  * nodes.
4441  *
4442  * @param  pos   The position/id of the local variable.
4443  * @param *value The new value written to the local variable.
4444  */
4445 void set_value(int pos, ir_node *value);
4446
4447 /** Find the value number for a node in the current block.
4448  *
4449  * This function searches all values in the current block for
4450  * a given value and returns its value number if it was found, else
4451  * -1.
4452  * Note that this does not mean that the value does not exists,
4453  * it's just not equal the node (for instance behind a Phi/Confirm ...)
4454  *
4455  * @param *value The value to find.
4456  */
4457 int find_value(ir_node *value);
4458
4459 /** Get the current memory state.
4460  *
4461  * Use this function to obtain the last definition of the memory
4462  * state.  This call automatically inserts Phi nodes for the memory
4463  * state value.
4464  */
4465 ir_node *get_store(void);
4466
4467 /** Remark a new definition of the memory state.
4468  *
4469  * Use this function to remember a new definition of the memory state.
4470  * This call is needed to automatically inserts Phi nodes.
4471  *
4472  * @param *store The new memory state.
4473  */
4474 void set_store(ir_node *store);
4475
4476 /** keep this node alive even if End is not control-reachable from it
4477  *
4478  * @param ka The node to keep alive.
4479  */
4480 void keep_alive(ir_node *ka);
4481
4482 /** Returns the frame type of the current graph */
4483 ir_type *get_cur_frame_type(void);
4484
4485
4486 /* --- initialize and finalize IR construction --- */
4487
4488 /** Puts the graph into state "phase_high" */
4489 #define irg_finalize_cons(irg) set_irg_phase_state(irg, phase_high)
4490
4491 /** Puts the program and all graphs into state phase_high.
4492  *
4493  * This also remarks, the construction of types is finished,
4494  * e.g., that no more subtypes will be added.  */
4495 void irp_finalize_cons(void);
4496
4497 /* --- Initialization --- */
4498
4499 #endif