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

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