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

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