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

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Representation of an intermediate operation.
  23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_IR_IRNODE_H
  27 #define FIRM_IR_IRNODE_H
  28
  29 #include <stddef.h>
  30
  31 #include "firm_common.h"
  32 #include "typerep.h"
  33 #include "irop.h"
  34 #include "irmode.h"
  35
  36 /**
  37  * @file irnode.h
  38  *
  39  * @author Martin Trapp, Christian Schaefer
  40  *
  41  * Declarations of an ir node.
  42  */
  43
  44 /**
  45  * @defgroup ir_node Declarations of an ir node.
  46  *
  47  * The type definition of ir_node is also in irgraph.h to resolve
  48  *  recursion between irnode.h and irgraph.h
  49  *
  50  * ir_node - a datatype representing a Firm node
  51  *
  52  *  The common fields are:
  53  *
  54  *  - arity     - The number of predecessors in the Firm graph.
  55  *  - in        - A list with the predecessors in the Firm graph.  There are
  56  *                routines to access individual elements and to obtain the
  57  *                array.  The method returning the array should not be used.
  58  *  - mode      - The mode of the node.  There are routines to get the mode
  59  *                but also to access the mode's fields directly.
  60  *  - opcode    - The opcode of the node. There are routines to get the opcode
  61  *                but also to access the opcode's fields directly.
  62  *  - node_nr   - A unique number for the node.  Available only if debugging
  63  *                is turned on.
  64  * @{
  65  */
  66
  67 /**
  68  * Some projection numbers must be always equal to support automatic phi construction
  69  */
  70 enum pn_generic {
  71         pn_Generic_M         = 0,  /**< The memory result. */
  72         pn_Generic_X_regular = 1,  /**< Execution result if no exception occurred. */
  73         pn_Generic_X_except  = 2,  /**< The control flow result branching to the exception handler */
  74         pn_Generic_other     = 3   /**< First free projection number */
  75 };
  76
  77 /**
  78  *   Checks whether a pointer points to a ir node.
  79  *
  80  *   @param thing   an arbitrary pointer
  81  *   @return        non-zero if the thing is a ir mode, else zero
  82  */
  83 int is_ir_node (const void *thing);
  84
  85 /**
  86  * Returns the number of predecessors without the block predecessor.
  87  *
  88  * @param node   the IR-node
  89  */
  90 int get_irn_arity      (const ir_node *node);
  91 int get_irn_intra_arity(const ir_node *node);
  92 int get_irn_inter_arity(const ir_node *node);
  93
  94 /** Replaces the old in array by a new one that will contain the ins given in
  95    the parameters.  Conserves the block predecessor.  It copies the array passed.
  96    This function is necessary to adjust in arrays of blocks, calls and phis.
  97    Assumes that current_ir_graph is set to the graph containing "node".
  98    "in" must contain all predecessors except the block that are required for
  99    the nodes opcode. */
 100 void set_irn_in(ir_node *node, int arity, ir_node *in[]);
 101
 102 /* to iterate through the predecessors without touching the array. No
 103    order of predecessors guaranteed.
 104    To iterate over the operands iterate from 0 to i < get_irn_arity(),
 105    to iterate including the Block predecessor iterate from i = -1 to
 106    i < get_irn_arity. */
 107 /* Access predecessor n */
 108
 109 /**
 110  * Get the n-th predecessor of a node.
 111  * This function removes Id predecessors.
 112  * This function automatically handles intra- and interprocedural views.
 113  */
 114 ir_node *get_irn_n(const ir_node *node, int n);
 115
 116 /**
 117 * Add a artificial dependency to the node.
 118 * The dependency is only inserted if it is not there already.
 119 * This is only allowed in phase_backend!
 120 *
 121 * @param node The node.
 122 * @param dep  The dependency target.
 123 *
 124 * @return The index in the array (get_irn_dep() with that index returns @p dep).
 125 */
 126 int add_irn_dep(ir_node *node, ir_node *dep);
 127
 128 /**
 129  * Copy all dependencies from a node to another.
 130  * This is only allowed in phase_backend!
 131  *
 132  * @param tgt The node which should be enriched.
 133  * @param src The node whose dependencies shall be copied.
 134  */
 135 void add_irn_deps(ir_node *tgt, ir_node *src);
 136
 137 /**
 138  * Get the length of the dependency array.
 139  * @param node The node.
 140  * @return The length of the dependency array or 0 if it has not yet been allocated.
 141  */
 142 int get_irn_deps(const ir_node *node);
 143
 144 /**
 145  * Get an entry of the dependency array.
 146  * @param node The node.
 147  * @param pos  The position.
 148  * @return The node at that position.
 149  */
 150 ir_node *get_irn_dep(const ir_node *node, int pos);
 151
 152 /**
 153  * Set an entry of the dependency array.
 154  * @param node The node.
 155  * @param pos  The position.
 156  * @param dep  The dependency target.
 157  */
 158 void set_irn_dep(ir_node *node, int pos, ir_node *dep);
 159
 160
 161 /**
 162  * Get the n-th predecessor of a node in intraprocedural view.
 163  * Can be used always if it's know that node is not a split one.
 164  */
 165 ir_node *get_irn_intra_n(const ir_node *node, int n);
 166
 167 /**
 168  * Get the n-th predecessor of a node in interprocedural view.
 169  */
 170 ir_node *get_irn_inter_n(const ir_node *node, int n);
 171
 172 /** Replace the n-th predecessor of a node with a new one. */
 173 void set_irn_n(ir_node *node, int n, ir_node *in);
 174 /**
 175  * Appends a new predecessor to a node. This only works for nodes with
 176  * variable arity!
 177  * @returns   the number of the new input
 178  */
 179 int add_irn_n(ir_node *node, ir_node *in);
 180 /* Remove predecessor i from Sync n */
 181 void del_Sync_n(ir_node *n, int i);
 182 /* Sets the mode struct of node.  */
 183 void set_irn_mode(ir_node *node, ir_mode *mode);
 184 /** Gets the mode struct of a node.  */
 185 ir_mode *get_irn_mode(const ir_node *node);
 186 /** Gets the ident for a string representation of the mode .*/
 187 ident *get_irn_modeident(const ir_node *node);
 188 /** Gets the string representation of the mode .*/
 189 const char *get_irn_modename(const ir_node *node);
 190 /** Gets the opcode struct of the node. */
 191 ir_op *get_irn_op(const ir_node *node);
 192 /** Sets the opcode struct of the node. */
 193 void set_irn_op(ir_node *node, ir_op *op);
 194 /** Gets the opcode-enum of the node. */
 195 unsigned get_irn_opcode(const ir_node *node);
 196 /** Get the string representation of the opcode. */
 197 const char *get_irn_opname(const ir_node *node);
 198 /** Get the ident for a string representation of the opcode. */
 199 ident *get_irn_opident(const ir_node *node);
 200 /** If arg is an argument of the node, returns it's position, -1 otherwise */
 201 int get_irn_pred_pos(ir_node *node, ir_node *arg);
 202 /** Gets the visited counter of a node. */
 203 ir_visited_t get_irn_visited(const ir_node *node);
 204 /** Sets the visited counter of a node. */
 205 void set_irn_visited(ir_node *node, ir_visited_t visited);
 206 /** Sets visited to get_irg_visited(current_ir_graph). */
 207 void mark_irn_visited(ir_node *node);
 208 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
 209 int irn_visited(const ir_node *node);
 210 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). Marks the node
 211  * visited, if it was not. */
 212 int irn_visited_else_mark(ir_node *node);
 213
 214 /**
 215  * Sets the link of a node.
 216  * Only allowed if the graph is NOT in phase_building.
 217  */
 218 void set_irn_link(ir_node *node, void *link);
 219
 220 /** Returns the link of a node.  */
 221 void *get_irn_link(const ir_node *node);
 222
 223 /** Returns the ir_graph this node belongs to. */
 224 ir_graph *get_irn_irg(const ir_node *node);
 225
 226 /** Outputs a unique number for this node if libFIRM is compiled for
 227    debugging, (configure with --enable-debug) else returns address
 228    of node cast to long. */
 229 long get_irn_node_nr(const ir_node *node);
 230
 231 /** Returns the pinned state of a node.
 232  *
 233  *  Returns whether the node _always_ must be pinned.
 234  *  I.e., the node is not floating after global cse.
 235  *
 236  * @returns Either state op_pin_state_pinned or op_pin_state_floats.
 237  */
 238 op_pin_state get_irn_pinned(const ir_node *node);
 239
 240 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
 241 void set_irn_pinned(ir_node *node, op_pin_state state);
 242
 243 /** Returns whether the node is currently pinned.
 244  *
 245  * If get_irn_pinned returns op_pin_state_floats and the graph the
 246  * node belongs to is in state op_poin_state_floats then this function
 247  * returns 'floats', else 'pinned'.
 248  */
 249 op_pin_state is_irn_pinned_in_irg(const ir_node *node);
 250
 251 /**
 252  * IR node constructor.
 253  * Create a new IR node in irg, with an op, mode, arity and
 254  * some incoming IR nodes.
 255  * This constructor is used in every specific IR node constructor.
 256  *
 257  * @param db    Debug info.
 258  * @param irg   IR-graph on with this new node should be constructed.
 259  * @param block The block the new node belongs to
 260  * @param op    The opcode of the new node.
 261  * @param mode  The mode of the new node.
 262  * @param arity The arity of the new node, <0 if can be changed dynamically.
 263  * @param in    An array of arity predecessor nodes.
 264  */
 265 ir_node *
 266 new_ir_node(dbg_info *db,
 267          ir_graph *irg,
 268          ir_node *block,
 269          ir_op *op,
 270          ir_mode *mode,
 271          int arity,
 272          ir_node *in[]);
 273
 274 /**
 275  * Return the block the node belongs to.  This is only
 276  * possible for pinned nodes or if the graph is in pinned state.
 277  * Otherwise the block may be incorrect.  This condition is
 278  * now checked by an assertion.
 279  *
 280  * This works for all except Block.  It can return Blocks or the Bad node.
 281  *
 282  * To express the difference to access routines that work for all
 283  * nodes we use infix "nodes" and do not name this function
 284  * get_irn_block(). */
 285 ir_node  *get_nodes_block (const ir_node *node);
 286
 287 /** Sets the Block of a node. */
 288 void      set_nodes_block (ir_node *node, ir_node *block);
 289
 290 /**
 291  * Return the MacroBlock the node belongs to.  This is only
 292  * possible for pinned nodes or if the graph is in pinned state.
 293  * Otherwise the MacroBlock may be incorrect.  This condition is
 294  * now checked by an assertion.
 295  *
 296  * This works for all except Block.  It can return Blocks or the Bad node.
 297  *
 298  * To express the difference to access routines that work for all
 299  * nodes we use infix "nodes" and do not name this function
 300  * get_irn_MacroBlock(). */
 301 ir_node  *get_nodes_MacroBlock(const ir_node *node);
 302
 303 /**
 304  * Projection numbers for result of Start node: use for Proj nodes!
 305  */
 306 typedef enum {
 307         pn_Start_X_initial_exec,   /**< Projection on the initial control flow. */
 308         pn_Start_M,                /**< Projection on the initial memory. */
 309         pn_Start_P_frame_base,     /**< Projection on the frame base pointer. */
 310         pn_Start_P_tls,            /**< Projection on the pointer to the thread local store
 311                                         segment containing _all_thread local variables. */
 312         pn_Start_T_args,           /**< Projection on all arguments. */
 313         pn_Start_max               /**< number of projections from a Start */
 314 } pn_Start; /* Projection numbers for Start. */
 315
 316 /** Test whether arbitrary node is frame pointer.
 317  *
 318  * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 319  * from Start.  If so returns frame type, else Null. */
 320 ir_type *is_frame_pointer(const ir_node *n);
 321
 322 /** Test whether arbitrary node is the thread local storage (tls) pointer.
 323  *
 324  * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 325  * from Start.  If so returns tls type, else Null. */
 326 ir_type *is_tls_pointer(const ir_node *n);
 327
 328 /** Return the number of control flow predecessors of a block. */
 329 int       get_Block_n_cfgpreds(const ir_node *block);
 330 /** Return the control flow predecessor of a block at a given position. */
 331 ir_node  *get_Block_cfgpred(const ir_node *block, int pos);
 332 /** Set the control flow predecessor of a block at a given position. */
 333 void      set_Block_cfgpred(ir_node *block, int pos, ir_node *pred);
 334
 335 /**
 336  * Return the position of the predecessor block pred in the inputs
 337  * of the block block.
 338  *
 339  * @param block  the block
 340  * @param pred   a predecessor block of block
 341  *
 342  * @return the position of pred in block or -1
 343  *
 344  * @note When using the old extended basic block form for blocks
 345  * with exception exists, a predecessor block might have more
 346  * than one position. In that case it is not specified, with is returned.
 347  */
 348 int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
 349
 350 /** Get the predecessor block.
 351  *
 352  *  Returns the block corresponding to the predecessor pos of block.
 353  *
 354  *  There are several ambiguities we resolve with this function:
 355  *  - The direct predecessor can be a Proj, which is not pinned.
 356  *    We walk from the predecessor to the next pinned node
 357  *    (skip_Proj) and return the block that node is in.
 358  *  - If we encounter the Bad node, this function does not return
 359  *    Start block, but the Bad node.
 360  */
 361 ir_node  *get_Block_cfgpred_block(const ir_node *node, int pos);
 362
 363 /** Return the matured flag of a block */
 364 int       get_Block_matured(const ir_node *block);
 365 /** set the matured flag of a block. */
 366 void      set_Block_matured(ir_node *block, int matured);
 367
 368 /** A visited flag only for block nodes.
 369  *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
 370 ir_visited_t get_Block_block_visited(const ir_node *block);
 371 void         set_Block_block_visited(ir_node *block, ir_visited_t visit);
 372
 373 /**
 374  * Marks a block as dead but do not replace it with a Bad node.
 375  * Dead blocks are removed in the con
 376  */
 377 ir_node  *set_Block_dead(ir_node *block);
 378 int       is_Block_dead(const ir_node *block);
 379
 380 /* For this current_ir_graph must be set. */
 381 void      mark_Block_block_visited(ir_node *node);
 382 int       Block_block_visited(const ir_node *node);
 383
 384 #ifdef INTERPROCEDURAL_VIEW
 385 /* Set and remove interprocedural predecessors. If the interprocedural
 386  * predecessors are removed, the node has the same predecessors in
 387  * both views.
 388  * @@@ Maybe better:  arity is zero if no cg preds. */
 389 void      set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
 390 void      set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
 391 /* @@@ not supported */
 392 ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
 393 /** Returns the number of interprocedural predecessors.  0 if none. */
 394 int       get_Block_cg_n_cfgpreds(const ir_node *node);
 395 /** Return the interprocedural predecessor at position pos. */
 396 ir_node  *get_Block_cg_cfgpred(const ir_node *node, int pos);
 397 /** Frees the memory allocated for interprocedural predecessors. */
 398 void      remove_Block_cg_cfgpred_arr(ir_node *node);
 399 #endif
 400
 401 /** Returns the extended basic block a block belongs to. */
 402 ir_extblk *get_Block_extbb(const ir_node *block);
 403 /** Sets the extended basic block a block belongs to. */
 404 void set_Block_extbb(ir_node *block, ir_extblk *extblk);
 405 /** Get the Macro Block header of a (sub-) block. */
 406 ir_node *get_Block_MacroBlock(const ir_node *block);
 407 /** Set the Macro Block header of a (sub-) block. */
 408 void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
 409 /** Get the Macro Block header of a node. */
 410 ir_node *get_irn_MacroBlock(const ir_node *n);
 411 /** Returns the ir_graph this Block belongs to. */
 412 ir_graph *get_Block_irg(const ir_node *block);
 413 /** Returns non-zero if the block has an entity assigned */
 414 int has_Block_entity(const ir_node *block);
 415 /** Returns the entity for a Block */
 416 ir_entity *get_Block_entity(const ir_node *block);
 417 /** Returns the entity for a Block (creating it if necessary) */
 418 ir_entity *create_Block_entity(ir_node *block);
 419 /** Set a new entity for a block */
 420 void set_Block_entity(ir_node *block, ir_entity *entity);
 421 /** Gets the head of the Phi list for this block. */
 422 ir_node *get_Block_phis(const ir_node *block);
 423 /** Sets the head of the Phi list for this block. */
 424 void set_Block_phis(ir_node *block, ir_node *phi);
 425 /** Add a Phi node to the list of Block Phi's. */
 426 void add_Block_phi(ir_node *block, ir_node *phi);
 427 /** Get the Block mark (single bit). */
 428 unsigned get_Block_mark(const ir_node *block);
 429 /** Set the Block mark (single bit). */
 430 void set_Block_mark(ir_node *block, unsigned mark);
 431
 432 /** Return the number of Keep alive node. */
 433 int  get_End_n_keepalives(const ir_node *end);
 434 /** Return the Keep alive node a position pos. */
 435 ir_node *get_End_keepalive(const ir_node *end, int pos);
 436 /** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
 437 void add_End_keepalive(ir_node *end, ir_node *ka);
 438 /** Set the Keep alive node at position pos. */
 439 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
 440
 441 /**
 442  * Set new keep-alives.
 443  * Beware: This might be an expensive operation if dynamic edges are enabled,
 444  * so avoid it in the backend.
 445  */
 446 void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
 447
 448 /** Remove irn from the keep-alive set. */
 449 void remove_End_keepalive(ir_node *end, ir_node *irn);
 450
 451 /* Remove Bads, NoMem and doublets from the keep-alive set. */
 452 void remove_End_Bads_and_doublets(ir_node *end);
 453
 454 /** Some parts of the End node are allocated separately -- their memory
 455    is not recovered by dead_node_elimination if a End node is dead.
 456    free_End() frees these data structures. */
 457 void free_End(ir_node *end);
 458
 459 /** Return the target address of an IJmp */
 460 ir_node *get_IJmp_target(const ir_node *ijmp);
 461 /** Sets the target address of an IJmp */
 462 void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
 463
 464 /* We distinguish three kinds of Cond nodes.  These can be distinguished
 465    by the mode of the selector operand and an internal flag of type cond_kind.
 466    First we distinguish binary Conds and switch Conds.
 467    A binary Cond has as selector a boolean value.  Proj(0) projects the control
 468    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
 469    is recognized by the boolean selector.
 470    The switch Cond has as selector an unsigned integer.  It produces as result
 471    an n+1 Tuple (cf0, ... , cfn) of control flows.
 472    We differ two flavors of this Cond.  The first, the dense Cond, passes
 473    control along output i if the selector value is i, 0 <= i <= n.  If the
 474    selector value is >n it passes control along output n.
 475    The second Cond flavor differences in the treatment of cases not specified in
 476    the source program.  It magically knows about the existence of Proj nodes.
 477    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
 478    exists.  Else it passes control along output n (even if this Proj does not
 479    exist.)  This Cond we call "fragmentary".  There is a special constructor
 480    new_defaultProj that automatically sets the flavor.
 481    The two switch flavors are distinguished by a flag of type cond_kind.
 482    Default flavor is "dense"
 483 */
 484 typedef enum {
 485         dense,        /**< Default. Missing Proj nodes are dead control flow. */
 486         fragmentary   /**< Special. No control flow optimizations allowed.  Missing
 487                            Proj nodes mean default control flow, i.e., Proj(n). */
 488 } cond_kind;
 489
 490 /** Gets the string representation of the Cond node kind. */
 491 const char *get_cond_kind_name(cond_kind kind);
 492
 493 ir_node  *get_Cond_selector(const ir_node *node);
 494 void      set_Cond_selector(ir_node *node, ir_node *selector);
 495 cond_kind get_Cond_kind(const ir_node *node);
 496 void      set_Cond_kind(ir_node *node, cond_kind kind);
 497 long      get_Cond_default_proj(const ir_node *node);
 498 void      set_Cond_default_proj(ir_node *node, long defproj);
 499
 500 /**
 501  * Projection numbers for conditions.
 502  */
 503 typedef enum {
 504         pn_Cond_false,    /**< Control flow if operand is "false". */
 505         pn_Cond_true,     /**< Control flow if operand is "true".  */
 506         pn_Cond_max       /**< number of projections from a Cond */
 507 } pn_Cond;  /* Projection numbers for Cond. */
 508
 509 ir_node  *get_Return_mem(const ir_node *node);
 510 void      set_Return_mem(ir_node *node, ir_node *mem);
 511 ir_node **get_Return_res_arr(ir_node *node);
 512 int       get_Return_n_ress(const ir_node *node);
 513 ir_node  *get_Return_res(const ir_node *node, int pos);
 514 void      set_Return_res(ir_node *node, int pos, ir_node *res);
 515
 516 tarval  *get_Const_tarval(const ir_node *node);
 517 void     set_Const_tarval(ir_node *node, tarval *con);
 518
 519 /** Return non-zero if the given Const node represents the 0 constant. */
 520 int is_Const_null(const ir_node *node);
 521
 522 /** Return non-zero if the given Const node represents the 1 constant. */
 523 int is_Const_one(const ir_node *node);
 524
 525 /** Return non-zero if the given Const node represents the constant with all bits set. */
 526 int is_Const_all_one(const ir_node *node);
 527
 528 /** Returns the source language type of a Const node.
 529  * Must be an atomic type.  Mode of type must be mode of node.
 530  */
 531 ir_type  *get_Const_type(ir_node *node);
 532
 533 /** Sets the source language type of a Const node. */
 534 void     set_Const_type(ir_node *node, ir_type *tp);
 535
 536 /** Returns non-zero if s symconst kind has a type attribute */
 537 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
 538
 539 /** Returns non-zero if s symconst kind has an ident attribute */
 540 #define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)
 541
 542 /** Returns non-zero if s symconst kind has an entity attribute */
 543 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
 544
 545 /** Returns non-zero if s symconst kind has an enum_const attribute */
 546 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
 547
 548 /** Get the kind of the SymConst. */
 549 symconst_kind get_SymConst_kind(const ir_node *node);
 550 /** Set the kind of the SymConst. */
 551 void          set_SymConst_kind(ir_node *node, symconst_kind num);
 552
 553 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
 554 ir_type  *get_SymConst_type(const ir_node *node);
 555 void     set_SymConst_type(ir_node *node, ir_type *tp);
 556
 557 /** Only to access SymConst of kind addr_name.  Else assertion: */
 558 ident   *get_SymConst_name(const ir_node *node);
 559 void     set_SymConst_name(ir_node *node, ident *name);
 560
 561 /** Only to access SymConst of kind addr_ent.  Else assertion: */
 562 ir_entity *get_SymConst_entity(const ir_node *node);
 563 void       set_SymConst_entity(ir_node *node, ir_entity *ent);
 564
 565 /** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
 566 ir_enum_const *get_SymConst_enum(const ir_node *node);
 567 void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
 568
 569 /** Sets both: type and ptrinfo.  Needed to treat the node independent of
 570    its semantics.  Does a memcpy for the memory sym points to. */
 571 /* write 'union': firmjni then does not create a method... */
 572 union symconst_symbol get_SymConst_symbol(const ir_node *node);
 573 void                  set_SymConst_symbol(ir_node *node,
 574                                           union symconst_symbol sym);
 575
 576 /** Access the type of the value represented by the SymConst.
 577  *
 578  *  Example: primitive type int for SymConst size. */
 579 ir_type *get_SymConst_value_type(ir_node *node);
 580 void    set_SymConst_value_type(ir_node *node, ir_type *tp);
 581
 582 ir_node   *get_Sel_mem(const ir_node *node);
 583 void       set_Sel_mem(ir_node *node, ir_node *mem);
 584 ir_node   *get_Sel_ptr(const ir_node *node);  /* ptr to the object to select from */
 585 void       set_Sel_ptr(ir_node *node, ir_node *ptr);
 586 ir_node   **get_Sel_index_arr(ir_node *node);
 587 int        get_Sel_n_indexs(const ir_node *node);
 588 ir_node   *get_Sel_index(const ir_node *node, int pos);
 589 void       set_Sel_index(ir_node *node, int pos, ir_node *index);
 590 ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
 591 void       set_Sel_entity (ir_node *node, ir_entity *ent);
 592
 593 /**
 594  * Projection numbers for result of Call node: use for Proj nodes!
 595  */
 596 typedef enum {
 597         pn_Call_M         = pn_Generic_M,         /**< The memory result. */
 598         pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
 599         pn_Call_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler. */
 600         pn_Call_T_result  = pn_Generic_other,     /**< The tuple containing all (0, 1, 2, ...) results. */
 601         pn_Call_P_value_res_base,                 /**< A pointer to the memory region containing copied results
 602                                                        passed by value (for compound result types). */
 603         pn_Call_max                               /**< number of projections from a Call */
 604 } pn_Call;   /* Projection numbers for Call. */
 605
 606 /** Retrieve the memory input of a Call. */
 607 ir_node *get_Call_mem(const ir_node *node);
 608 /** Set the memory input of a Call. */
 609 void     set_Call_mem(ir_node *node, ir_node *mem);
 610 /** Retrieve the call address of a Call. */
 611 ir_node *get_Call_ptr(const ir_node *node);
 612 /** Set the call address of a Call. */
 613 void     set_Call_ptr(ir_node *node, ir_node *ptr);
 614 ir_node **get_Call_param_arr(ir_node *node);
 615 /** Gets the number of parameters of a call. */
 616 int      get_Call_n_params(const ir_node *node);
 617 /** Gets the call parameter at position pos. */
 618 ir_node *get_Call_param(const ir_node *node, int pos);
 619 /** Sets the call parameter at position pos. */
 620 void     set_Call_param(ir_node *node, int pos, ir_node *param);
 621 /** Gets the type of a call. */
 622 ir_type *get_Call_type(ir_node *node);
 623 /** Sets the type of a call. */
 624 void     set_Call_type(ir_node *node, ir_type *tp);
 625 /** Returns non-zero if this call can be a tail-call. */
 626 unsigned get_Call_tail_call(const ir_node *node);
 627 /** Sets the tail call attribute. */
 628 void     set_Call_tail_call(ir_node *node, unsigned tail_call);
 629
 630 /**
 631  * Returns non-zero if a Call is surely a self-recursive Call.
 632  * Beware: if this functions returns 0, the call might be self-recursive!
 633  */
 634 int is_self_recursive_Call(const ir_node *call);
 635
 636 /** Set, get and remove the callee information for a Call node.
 637  *
 638  *  The callee information lists all method entities that can be called
 639  *  from this node.  If the address expression can not be analyzed fully,
 640  *  e.g., as entities can be called that are not in the compilation unit,
 641  *  the array contains the unknown_entity.  The array contains only entities
 642  *  with peculiarity_existent, but with all kinds of visibility.  The entities
 643  *  not necessarily contain an irg.
 644  *
 645  *  The array is only accessible if callee information is valid.  See flag
 646  *  in graph.
 647  *
 648  *  The memory allocated for the array is managed automatically, i.e., it must
 649  *  not be freed if the Call node is removed from the graph.
 650  *
 651  *  @param node A Call node.
 652  */
 653 int        Call_has_callees(const ir_node *node);
 654 int        get_Call_n_callees(const ir_node *node);
 655 ir_entity *get_Call_callee(const ir_node *node, int pos);
 656
 657 /** Set the full callee array.
 658  *
 659  *  The passed array is copied. Assumes current_ir_graph set properly! */
 660 void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
 661 void    remove_Call_callee_arr(ir_node *node);
 662
 663 /**
 664  * Projection numbers for result of Builtin node: use for Proj nodes!
 665  */
 666 typedef enum {
 667         pn_Builtin_M        = pn_Generic_M,     /**< The memory result. */
 668         pn_Builtin_1_result = pn_Generic_other, /**< first result. */
 669         pn_Builtin_max                          /**< number of projections from a Builtin */
 670 } pn_Builtin;   /* Projection numbers for Builtin. */
 671
 672 ir_node         *get_Builtin_mem(const ir_node *node);
 673 void            set_Builtin_mem(ir_node *node, ir_node *mem);
 674 ir_builtin_kind get_Builtin_kind(const ir_node *node);
 675 void            set_Builtin_kind(ir_node *node, ir_builtin_kind kind);
 676 ir_node         **get_Builtin_param_arr(ir_node *node);
 677 /** Gets the number of parameters of a Builtin. */
 678 int             get_Builtin_n_params(const ir_node *node);
 679 /** Gets the Builtin parameter at position pos. */
 680 ir_node         *get_Builtin_param(const ir_node *node, int pos);
 681 /** Sets the Builtin parameter at position pos. */
 682 void            set_Builtin_param(ir_node *node, int pos, ir_node *param);
 683 /** Gets the type of a builtin. */
 684 ir_type         *get_Builtin_type(ir_node *node);
 685 /** Sets the type of a Builtin. */
 686 void            set_Builtin_type(ir_node *node, ir_type *tp);
 687 /** Returns a human readable string for the ir_builtin_kind. */
 688 const char *get_builtin_kind_name(ir_builtin_kind kind);
 689
 690 /** Retrieve the call address of a CallBegin. */
 691 ir_node  *get_CallBegin_ptr(const ir_node *node);
 692 /** Set the call address of a CallBegin. */
 693 void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
 694 /** Retrieve the original Call node of a CallBegin. */
 695 ir_node  *get_CallBegin_call(const ir_node *node);
 696 /** Set the original Call node of a CallBegin. */
 697 void      set_CallBegin_call(ir_node *node, ir_node *call);
 698
 699 /* For unary and binary arithmetic operations the access to the
 700    operands can be factored out.  Left is the first, right the
 701    second arithmetic value  as listed in tech report 1999-44.
 702    unops are: Minus, Abs, Not, Conv, Cast
 703    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 704    Shr, Shrs, Rotl, Cmp */
 705 int      is_unop(const ir_node *node);
 706 ir_node *get_unop_op(const ir_node *node);
 707 void     set_unop_op(ir_node *node, ir_node *op);
 708 int      is_binop(const ir_node *node);
 709 ir_node *get_binop_left(const ir_node *node);
 710 void     set_binop_left(ir_node *node, ir_node *left);
 711 ir_node *get_binop_right(const ir_node *node);
 712 void     set_binop_right(ir_node *node, ir_node *right);
 713
 714 ir_node *get_Add_left(const ir_node *node);
 715 void     set_Add_left(ir_node *node, ir_node *left);
 716 ir_node *get_Add_right(const ir_node *node);
 717 void     set_Add_right(ir_node *node, ir_node *right);
 718
 719 ir_node *get_Carry_left(const ir_node *node);
 720 void     set_Carry_left(ir_node *node, ir_node *left);
 721 ir_node *get_Carry_right(const ir_node *node);
 722 void     set_Carry_right(ir_node *node, ir_node *right);
 723
 724 ir_node *get_Borrow_left(const ir_node *node);
 725 void     set_Borrow_left(ir_node *node, ir_node *left);
 726 ir_node *get_Borrow_right(const ir_node *node);
 727 void     set_Borrow_right(ir_node *node, ir_node *right);
 728
 729 ir_node *get_Sub_left(const ir_node *node);
 730 void     set_Sub_left(ir_node *node, ir_node *left);
 731 ir_node *get_Sub_right(const ir_node *node);
 732 void     set_Sub_right(ir_node *node, ir_node *right);
 733
 734 ir_node *get_Minus_op(const ir_node *node);
 735 void     set_Minus_op(ir_node *node, ir_node *op);
 736
 737 ir_node *get_Mul_left(const ir_node *node);
 738 void     set_Mul_left(ir_node *node, ir_node *left);
 739 ir_node *get_Mul_right(const ir_node *node);
 740 void     set_Mul_right(ir_node *node, ir_node *right);
 741
 742 ir_node *get_Mulh_left(const ir_node *node);
 743 void     set_Mulh_left(ir_node *node, ir_node *left);
 744 ir_node *get_Mulh_right(const ir_node *node);
 745 void     set_Mulh_right(ir_node *node, ir_node *right);
 746
 747 ir_node *get_Quot_left(const ir_node *node);
 748 void     set_Quot_left(ir_node *node, ir_node *left);
 749 ir_node *get_Quot_right(const ir_node *node);
 750 void     set_Quot_right(ir_node *node, ir_node *right);
 751 ir_node *get_Quot_mem(const ir_node *node);
 752 void     set_Quot_mem(ir_node *node, ir_node *mem);
 753 ir_mode *get_Quot_resmode(const ir_node *node);
 754 void     set_Quot_resmode(ir_node *node, ir_mode *mode);
 755
 756 /**
 757  * Projection numbers for Quot: use for Proj nodes!
 758  */
 759 typedef enum {
 760         pn_Quot_M         = pn_Generic_M,         /**< Memory result. */
 761         pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
 762         pn_Quot_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
 763         pn_Quot_res       = pn_Generic_other,     /**< Result of computation. */
 764         pn_Quot_max                               /**< number of projections from a Quot */
 765 } pn_Quot;  /* Projection numbers for Quot. */
 766
 767 ir_node *get_DivMod_left(const ir_node *node);
 768 void     set_DivMod_left(ir_node *node, ir_node *left);
 769 ir_node *get_DivMod_right(const ir_node *node);
 770 void     set_DivMod_right(ir_node *node, ir_node *right);
 771 ir_node *get_DivMod_mem(const ir_node *node);
 772 void     set_DivMod_mem(ir_node *node, ir_node *mem);
 773 ir_mode *get_DivMod_resmode(const ir_node *node);
 774 void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
 775
 776 /**
 777  * Projection numbers for DivMod: use for Proj nodes!
 778  */
 779 typedef enum {
 780         pn_DivMod_M         = pn_Generic_M,         /**< Memory result. */
 781         pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
 782         pn_DivMod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
 783         pn_DivMod_res_div   = pn_Generic_other,     /**< Result of computation a / b. */
 784         pn_DivMod_res_mod,                          /**< Result of computation a % b. */
 785         pn_DivMod_max                               /**< number of projections from a DivMod */
 786 } pn_DivMod;  /* Projection numbers for DivMod. */
 787
 788 ir_node *get_Div_left(const ir_node *node);
 789 void     set_Div_left(ir_node *node, ir_node *left);
 790 ir_node *get_Div_right(const ir_node *node);
 791 void     set_Div_right(ir_node *node, ir_node *right);
 792 ir_node *get_Div_mem(const ir_node *node);
 793 void     set_Div_mem(ir_node *node, ir_node *mem);
 794 ir_mode *get_Div_resmode(const ir_node *node);
 795 void     set_Div_resmode(ir_node *node, ir_mode *mode);
 796 int      get_Div_no_remainder(const ir_node *node);
 797 void     set_Div_no_remainder(ir_node *node, int no_remainder);
 798
 799 /**
 800  * Projection numbers for Div: use for Proj nodes!
 801  */
 802 typedef enum {
 803         pn_Div_M         = pn_Generic_M,         /**< Memory result. */
 804         pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
 805         pn_Div_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
 806         pn_Div_res       = pn_Generic_other,     /**< Result of computation. */
 807         pn_Div_max                               /**< number of projections from a Div */
 808 } pn_Div;  /* Projection numbers for Div. */
 809
 810 ir_node *get_Mod_left(const ir_node *node);
 811 void     set_Mod_left(ir_node *node, ir_node *left);
 812 ir_node *get_Mod_right(const ir_node *node);
 813 void     set_Mod_right(ir_node *node, ir_node *right);
 814 ir_node *get_Mod_mem(const ir_node *node);
 815 void     set_Mod_mem(ir_node *node, ir_node *mem);
 816 ir_mode *get_Mod_resmode(const ir_node *node);
 817 void     set_Mod_resmode(ir_node *node, ir_mode *mode);
 818
 819 /**
 820  * Projection numbers for Mod: use for Proj nodes!
 821  */
 822 typedef enum {
 823         pn_Mod_M         = pn_Generic_M,         /**< Memory result.    */
 824         pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
 825         pn_Mod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
 826         pn_Mod_res       = pn_Generic_other,     /**< Result of computation. */
 827         pn_Mod_max                               /**< number of projections from a Mod */
 828 } pn_Mod;  /* Projection numbers for Mod. */
 829
 830 ir_node *get_Abs_op(const ir_node *node);
 831 void     set_Abs_op(ir_node *node, ir_node *op);
 832
 833 ir_node *get_And_left(const ir_node *node);
 834 void     set_And_left(ir_node *node, ir_node *left);
 835 ir_node *get_And_right(const ir_node *node);
 836 void     set_And_right(ir_node *node, ir_node *right);
 837
 838 ir_node *get_Or_left(const ir_node *node);
 839 void     set_Or_left(ir_node *node, ir_node *left);
 840 ir_node *get_Or_right(const ir_node *node);
 841 void     set_Or_right(ir_node *node, ir_node *right);
 842
 843 ir_node *get_Eor_left(const ir_node *node);
 844 void     set_Eor_left(ir_node *node, ir_node *left);
 845 ir_node *get_Eor_right(const ir_node *node);
 846 void     set_Eor_right(ir_node *node, ir_node *right);
 847
 848 ir_node *get_Not_op(const ir_node *node);
 849 void     set_Not_op(ir_node *node, ir_node *op);
 850
 851 /** returns the pnc name from an pnc constant */
 852 const char *get_pnc_string(int pnc);
 853
 854 /** Calculates the negated (Complement(R)) pnc condition. */
 855 pn_Cmp      get_negated_pnc(long pnc, ir_mode *mode);
 856
 857 /** Calculates the inversed (R^-1) pnc condition, i.e., "<" --> ">" */
 858 pn_Cmp      get_inversed_pnc(long pnc);
 859
 860 /** An alternative name for get_inversed_pnc() that can be better memorized. */
 861 #define get_mirrored_pnc(pnc)  get_inversed_pnc(pnc)
 862
 863 ir_node *get_Cmp_left(const ir_node *node);
 864 void     set_Cmp_left(ir_node *node, ir_node *left);
 865 ir_node *get_Cmp_right(const ir_node *node);
 866 void     set_Cmp_right(ir_node *node, ir_node *right);
 867
 868 ir_node *get_Shl_left(const ir_node *node);
 869 void     set_Shl_left(ir_node *node, ir_node *left);
 870 ir_node *get_Shl_right(const ir_node *node);
 871 void     set_Shl_right(ir_node *node, ir_node *right);
 872
 873 ir_node *get_Shr_left(const ir_node *node);
 874 void     set_Shr_left(ir_node *node, ir_node *left);
 875 ir_node *get_Shr_right(const ir_node *node);
 876 void     set_Shr_right(ir_node *node, ir_node *right);
 877
 878 ir_node *get_Shrs_left(const ir_node *node);
 879 void     set_Shrs_left(ir_node *node, ir_node *left);
 880 ir_node *get_Shrs_right(const ir_node *node);
 881 void     set_Shrs_right(ir_node *node, ir_node *right);
 882
 883 ir_node *get_Rotl_left(const ir_node *node);
 884 void     set_Rotl_left(ir_node *node, ir_node *left);
 885 ir_node *get_Rotl_right(const ir_node *node);
 886 void     set_Rotl_right(ir_node *node, ir_node *right);
 887
 888 ir_node *get_Conv_op(const ir_node *node);
 889 void     set_Conv_op(ir_node *node, ir_node *op);
 890 int      get_Conv_strict(const ir_node *node);
 891 void     set_Conv_strict(ir_node *node, int flag);
 892
 893 /* Does Cast need a mem operator?
 894  * Cast should only depend on the type, not on the state of an
 895  * entity.  But:  we initialize various fields after Alloc, that
 896  * are accessed in the cast.  This required some precaution, to
 897  * get the right memory into the Loads generated from the cast.
 898  */
 899 ir_node *get_Cast_op(const ir_node *node);
 900 void     set_Cast_op(ir_node *node, ir_node *op);
 901 ir_type *get_Cast_type(ir_node *node);
 902 void     set_Cast_type(ir_node *node, ir_type *to_tp);
 903
 904 /** Checks for upcast.
 905  *
 906  * Returns true if the Cast node casts a class type to a super type.
 907  * Works also for pointers to classes (recursively).
 908  *
 909  * Needs typeinfo calculated.
 910  */
 911 int is_Cast_upcast(ir_node *node);
 912
 913 /** Checks for downcast.
 914  *
 915  * Returns true if the Cast node casts a class type to a sub type.
 916  * Works also for pointers to classes (recursively).
 917  *
 918  * Needs typeinfo calculated.
 919  */
 920 int is_Cast_downcast(ir_node *node);
 921
 922
 923 /** Returns true if n is a Phi or a Filter node in INTER-procedural view.
 924    Returns false if irg is in phase phase_building and the Phi has zero
 925    predecessors: it's a Phi0. */
 926 int       is_Phi(const ir_node *n);
 927 /** Returns true if irg in phase phase_building and the Phi has zero
 928    predecessors. It's a Phi0 then. */
 929 int       is_Phi0(const ir_node *n);
 930 /* These routines also work for Filter nodes in INTER-procedural view. */
 931 ir_node **get_Phi_preds_arr(ir_node *node);
 932 int       get_Phi_n_preds(const ir_node *node);
 933 ir_node  *get_Phi_pred(const ir_node *node, int pos);
 934 void      set_Phi_pred(ir_node *node, int pos, ir_node *pred);
 935 ir_node  *get_Phi_next(const ir_node *phi);
 936 void      set_Phi_next(ir_node *phi, ir_node *next);
 937
 938 ir_node  *get_Filter_pred(ir_node *node);
 939 void      set_Filter_pred(ir_node *node, ir_node *pred);
 940 long      get_Filter_proj(ir_node *node);
 941 void      set_Filter_proj(ir_node *node, long proj);
 942 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 943  * @@@ Maybe better:  arity is zero if no cg preds. */
 944 void     set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
 945 void     set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
 946 int      get_Filter_n_cg_preds(ir_node *node);
 947 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
 948
 949 /** Return true if parameter is a memory operation.
 950  *
 951  *  A memory operation is an operation that changes the
 952  *  memory.  I.e., a Load or a Store operation.
 953  */
 954 int     is_memop(const ir_node *node);
 955 ir_node *get_memop_mem(const ir_node *node);
 956 void     set_memop_mem(ir_node *node, ir_node *mem);
 957 ir_node *get_memop_ptr(const ir_node *node);
 958 void     set_memop_ptr(ir_node *node, ir_node *ptr);
 959
 960 /**
 961  * Projection numbers for Load: use for Proj nodes!
 962  */
 963 typedef enum {
 964         pn_Load_M         = pn_Generic_M,         /**< Memory result. */
 965         pn_Load_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
 966         pn_Load_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
 967         pn_Load_res       = pn_Generic_other,     /**< Result of load operation. */
 968         pn_Load_max                               /**< number of projections from a Load */
 969 } pn_Load;  /* Projection numbers for Load. */
 970
 971 ir_node       *get_Load_mem(const ir_node *node);
 972 void           set_Load_mem(ir_node *node, ir_node *mem);
 973 ir_node       *get_Load_ptr(const ir_node *node);
 974 void           set_Load_ptr(ir_node *node, ir_node *ptr);
 975 ir_mode       *get_Load_mode(const ir_node *node);
 976 void           set_Load_mode(ir_node *node, ir_mode *mode);
 977 ir_volatility  get_Load_volatility(const ir_node *node);
 978 void           set_Load_volatility(ir_node *node, ir_volatility volatility);
 979 ir_align       get_Load_align(const ir_node *node);
 980 void           set_Load_align(ir_node *node, ir_align align);
 981
 982 /**
 983  * Projection numbers for Store: use for Proj nodes!
 984  */
 985 typedef enum {
 986         pn_Store_M         = pn_Generic_M,         /**< Memory result. */
 987         pn_Store_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
 988         pn_Store_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
 989         pn_Store_max       = pn_Generic_other      /**< number of projections from a Store */
 990 } pn_Store;  /* Projection numbers for Store. */
 991
 992 ir_node       *get_Store_mem(const ir_node *node);
 993 void           set_Store_mem(ir_node *node, ir_node *mem);
 994 ir_node       *get_Store_ptr(const ir_node *node);
 995 void           set_Store_ptr(ir_node *node, ir_node *ptr);
 996 ir_node       *get_Store_value(const ir_node *node);
 997 void           set_Store_value(ir_node *node, ir_node *value);
 998 ir_volatility  get_Store_volatility(const ir_node *node);
 999 void           set_Store_volatility(ir_node *node, ir_volatility volatility);
1000 ir_align       get_Store_align(const ir_node *node);
1001 void           set_Store_align(ir_node *node, ir_align align);
1002
1003 /**
1004  * Projection numbers for Alloc: use for Proj nodes!
1005  */
1006 typedef enum {
1007         pn_Alloc_M         = pn_Generic_M,         /**< Memory result. */
1008         pn_Alloc_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1009         pn_Alloc_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
1010         pn_Alloc_res       = pn_Generic_other,     /**< Result of allocation. */
1011         pn_Alloc_max                               /**< number of projections from an Alloc */
1012 } pn_Alloc;  /* Projection numbers for Alloc. */
1013
1014 ir_node *get_Alloc_mem(const ir_node *node);
1015 void     set_Alloc_mem(ir_node *node, ir_node *mem);
1016 ir_node *get_Alloc_size(const ir_node *node);
1017 void     set_Alloc_size(ir_node *node, ir_node *size);
1018 ir_type *get_Alloc_type(ir_node *node);
1019 void     set_Alloc_type(ir_node *node, ir_type *tp);
1020
1021 ir_where_alloc get_Alloc_where(const ir_node *node);
1022 void           set_Alloc_where(ir_node *node, ir_where_alloc where);
1023
1024 ir_node *get_Free_mem(const ir_node *node);
1025 void     set_Free_mem(ir_node *node, ir_node *mem);
1026 ir_node *get_Free_ptr(const ir_node *node);
1027 void     set_Free_ptr(ir_node *node, ir_node *ptr);
1028 ir_node *get_Free_size(const ir_node *node);
1029 void     set_Free_size(ir_node *node, ir_node *size);
1030 ir_type *get_Free_type(ir_node *node);
1031 void     set_Free_type(ir_node *node, ir_type *tp);
1032
1033 ir_where_alloc get_Free_where(const ir_node *node);
1034 void           set_Free_where(ir_node *node, ir_where_alloc where);
1035
1036 ir_node **get_Sync_preds_arr(ir_node *node);
1037 int       get_Sync_n_preds(const ir_node *node);
1038 ir_node  *get_Sync_pred(const ir_node *node, int pos);
1039 void      set_Sync_pred(ir_node *node, int pos, ir_node *pred);
1040 void      add_Sync_pred(ir_node *node, ir_node *pred);
1041
1042 /** Returns the source language type of a Proj node.
1043  * Must be an atomic type.  Mode of type must be mode of node.
1044  */
1045 ir_type  *get_Proj_type(ir_node *node);
1046
1047 /** Return the predecessor of a Proj node. */
1048 ir_node  *get_Proj_pred(const ir_node *node);
1049 void      set_Proj_pred(ir_node *node, ir_node *pred);
1050 /** Return the projection number of a Proj node. */
1051 long      get_Proj_proj(const ir_node *node);
1052 void      set_Proj_proj(ir_node *node, long proj);
1053
1054 /**
1055  * Returns non-zero if a node is a routine parameter.
1056  *
1057  * @param node  the Proj node to test
1058  */
1059 int is_arg_Proj(const ir_node *node);
1060
1061 ir_node **get_Tuple_preds_arr(ir_node *node);
1062 int       get_Tuple_n_preds(const ir_node *node);
1063 ir_node  *get_Tuple_pred(const ir_node *node, int pos);
1064 void      set_Tuple_pred(ir_node *node, int pos, ir_node *pred);
1065
1066 ir_node  *get_Id_pred(const ir_node *node);
1067 void      set_Id_pred(ir_node *node, ir_node *pred);
1068
1069 /** Confirm has a single result and returns 'value' unchanged.
1070  *  The node expresses a restriction on 'value':
1071  *  'value' 'cmp' 'bound' == true.                                 */
1072 ir_node      *get_Confirm_value(const ir_node *node);
1073 void          set_Confirm_value(ir_node *node, ir_node *value);
1074 ir_node      *get_Confirm_bound(const ir_node *node);
1075 void          set_Confirm_bound(ir_node *node, ir_node *bound);
1076 pn_Cmp        get_Confirm_cmp(const ir_node *node);
1077 void          set_Confirm_cmp(ir_node *node, pn_Cmp cmp);
1078
1079 /*
1080  * Mux Support
1081  */
1082 ir_node *get_Mux_sel(const ir_node *node);
1083 void     set_Mux_sel(ir_node *node, ir_node *sel);
1084 ir_node *get_Mux_false(const ir_node *node);
1085 void     set_Mux_false(ir_node *node, ir_node *ir_false);
1086 ir_node *get_Mux_true(const ir_node *node);
1087 void     set_Mux_true(ir_node *node, ir_node *ir_true);
1088
1089 /**
1090  * Projection numbers for result of CopyB node: use for Proj nodes!
1091  */
1092 typedef enum {
1093         pn_CopyB_M_regular = pn_Generic_M,         /**< The memory result. */
1094         pn_CopyB_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1095         pn_CopyB_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler */
1096         pn_CopyB_max       = pn_Generic_other      /**< number of projections from a CopyB */
1097 } pn_CopyB;   /* Projection numbers for CopyB. */
1098 #define pn_CopyB_M pn_CopyB_M_regular
1099
1100 ir_node *get_CopyB_mem(const ir_node *node);
1101 void     set_CopyB_mem(ir_node *node, ir_node *mem);
1102 ir_node *get_CopyB_dst(const ir_node *node);
1103 void     set_CopyB_dst(ir_node *node, ir_node *dst);
1104 ir_node *get_CopyB_src(const ir_node *node);
1105 void     set_CopyB_src(ir_node *node, ir_node *src);
1106 ir_type *get_CopyB_type(ir_node *node);
1107 void     set_CopyB_type(ir_node *node, ir_type *data_type);
1108
1109 /**
1110  * Projection numbers for result of InstOf node: use for Proj nodes!
1111  */
1112 typedef enum {
1113         pn_InstOf_M_regular = pn_Generic_M,         /**< The memory result. */
1114         pn_InstOf_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1115         pn_InstOf_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler */
1116         pn_InstOf_res       = pn_Generic_other,     /**< The checked object pointer. */
1117         pn_InstOf_max                               /**< number of projections from an InstOf */
1118 } pn_InstOf;
1119 #define pn_InstOf_M pn_InstOf_M_regular
1120
1121 /** InstOf access. */
1122 ir_type *get_InstOf_type(ir_node *node);
1123 void    set_InstOf_type(ir_node *node, ir_type *type);
1124 ir_node *get_InstOf_store(const ir_node *node);
1125 void    set_InstOf_store(ir_node *node, ir_node *obj);
1126 ir_node *get_InstOf_obj(const ir_node *node);
1127 void    set_InstOf_obj(ir_node *node, ir_node *obj);
1128
1129 /**
1130  * Projection numbers for Raise.
1131  */
1132 typedef enum {
1133         pn_Raise_M = pn_Generic_M,          /**< The Memory result. */
1134         pn_Raise_X = pn_Generic_X_regular,  /**< The control flow to the exception handler. */
1135         pn_Raise_max                        /**< number of projections from a Raise */
1136 } pn_Raise;  /* Projection numbers for Raise. */
1137
1138 ir_node *get_Raise_mem(const ir_node *node);
1139 void     set_Raise_mem(ir_node *node, ir_node *mem);
1140 ir_node *get_Raise_exo_ptr(const ir_node *node);  /* PoinTeR to EXception Object */
1141 void     set_Raise_exo_ptr(ir_node *node, ir_node *exoptr);
1142
1143 /**
1144  * Projection numbers for result of Bound node: use for Proj nodes!
1145  */
1146 typedef enum {
1147         pn_Bound_M         = pn_Generic_M,         /**< The memory result. */
1148         pn_Bound_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
1149         pn_Bound_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler */
1150         pn_Bound_res       = pn_Generic_other,     /**< The checked index. */
1151         pn_Bound_max                               /**< number of projections from a Bound */
1152 } pn_Bound;
1153
1154 /** Returns the memory input of a Bound operation. */
1155 ir_node *get_Bound_mem(const ir_node *bound);
1156 void     set_Bound_mem(ir_node *bound, ir_node *mem);
1157
1158 /** Returns the index input of a Bound operation. */
1159 ir_node *get_Bound_index(const ir_node *bound);
1160 void     set_Bound_index(ir_node *bound, ir_node *idx);
1161
1162 /** Returns the lower bound input of a Bound operation. */
1163 ir_node *get_Bound_lower(const ir_node *bound);
1164 void     set_Bound_lower(ir_node *bound, ir_node *lower);
1165
1166 /** Returns the upper bound input of a Bound operation. */
1167 ir_node *get_Bound_upper(const ir_node *bound);
1168 void     set_Bound_upper(ir_node *bound, ir_node *upper);
1169
1170 /** Return the operand of a Pin node. */
1171 ir_node *get_Pin_op(const ir_node *pin);
1172 void     set_Pin_op(ir_node *pin, ir_node *node);
1173
1174 /** Return the assembler text of an ASM pseudo node. */
1175 ident *get_ASM_text(const ir_node *node);
1176 /** Return the number of input constraints for an ASM node. */
1177 int get_ASM_n_input_constraints(const ir_node *node);
1178 /** Return the input constraints for an ASM node. */
1179 const ir_asm_constraint *get_ASM_input_constraints(const ir_node *node);
1180 /** Return the number of output constraints for an ASM node.  */
1181 int get_ASM_n_output_constraints(const ir_node *node);
1182 /** Return the output constraints for an ASM node. */
1183 const ir_asm_constraint *get_ASM_output_constraints(const ir_node *node);
1184 /** Return the number of clobbered registers for an ASM node.  */
1185 int get_ASM_n_clobbers(const ir_node *node);
1186 /** Return the list of clobbered registers for an ASM node. */
1187 ident **get_ASM_clobbers(const ir_node *node);
1188
1189 /*
1190  *
1191  * NAME Auxiliary routines
1192  *
1193  */
1194
1195 /** Returns operand of node if node is a Proj. */
1196 ir_node *skip_Proj(ir_node *node);
1197 /** Returns operand of node if node is a Proj. */
1198 const ir_node *skip_Proj_const(const ir_node *node);
1199 /** Returns operand of node if node is a Id. */
1200 ir_node *skip_Id(ir_node *node);   /* Old name is skip_nop(). */
1201 /** Returns corresponding operand of Tuple if node is a Proj from
1202    a Tuple. */
1203 ir_node *skip_Tuple(ir_node *node);
1204 /** Returns operand of node if node is a Cast. */
1205 ir_node *skip_Cast(ir_node *node);
1206 const ir_node *skip_Cast_const(const ir_node *node);
1207 /** Returns operand of node if node is a Pin. */
1208 ir_node *skip_Pin(ir_node *node);
1209 /** Returns operand of node if node is a Confirm */
1210 ir_node *skip_Confirm(ir_node *node);
1211 /** Skip all high-level Operations (including Cast, Confirm). */
1212 ir_node *skip_HighLevel_ops(ir_node *node);
1213 /** Returns true if irn is a Const node. */
1214 int      is_Const(const ir_node *node);
1215 /** Returns true if a node is a Conv node. */
1216 int      is_Conv(const ir_node *node);
1217 /** Returns true if a node is a strictConv node. */
1218 int      is_strictConv(const ir_node *node);
1219 /** Returns true if a node is a Cast node. */
1220 int      is_Cast(const ir_node *node);
1221 /** Returns true if node is a Bad node. */
1222 int      is_Bad(const ir_node *node);
1223 /** Returns true if node is a NoMem node. */
1224 int      is_NoMem(const ir_node *node);
1225 /** Returns true if node is a Start node. */
1226 int      is_Start(const ir_node *node);
1227 /** Returns true if node is a Minus node. */
1228 int      is_Minus(const ir_node *node);
1229 /** Returns true if node is a Abs node. */
1230 int      is_Abs(const ir_node *node);
1231 /** Returns true if node is a Mod node. */
1232 int      is_Mod(const ir_node *node);
1233 /** Returns true if node is a Div node. */
1234 int      is_Div(const ir_node *node);
1235 /** Returns true if node is a DivMod node. */
1236 int      is_DivMod(const ir_node *node);
1237 /** Returns true if node is a Quot node. */
1238 int      is_Quot(const ir_node *node);
1239 /** Returns true if node is an Add node. */
1240 int      is_Add(const ir_node *node);
1241 /** Returns true if node is a Carry node. */
1242 int      is_Carry(const ir_node *node);
1243 /** Returns true if node is an And node. */
1244 int      is_And(const ir_node *node);
1245 /** Returns true if node is an Or node. */
1246 int      is_Or(const ir_node *node);
1247 /** Returns true if node is an Eor node. */
1248 int      is_Eor(const ir_node *node);
1249 /** Returns true if node is a Sub node. */
1250 int      is_Sub(const ir_node *node);
1251 /** Returns true if node is a Not node. */
1252 int      is_Not(const ir_node *node);
1253 /** Returns true if node is a Shl node. */
1254 int      is_Shl(const ir_node *node);
1255 /** Returns true if node is a Shr node. */
1256 int      is_Shr(const ir_node *node);
1257 /** Returns true if node is a Shrs node. */
1258 int      is_Shrs(const ir_node *node);
1259 /** Returns true if node is a Rotl node. */
1260 int      is_Rotl(const ir_node *node);
1261 /** Returns true if node is an Id node. */
1262 int      is_Id(const ir_node *node);
1263 /** Returns true if node is a Tuple node. */
1264 int      is_Tuple(const ir_node *node);
1265 /** Returns true if node is a Bound node. */
1266 int      is_Bound(const ir_node *node);
1267 /** Returns true if the node is not a Block */
1268 int      is_no_Block(const ir_node *node);
1269 /** Returns true if the node is a Block */
1270 int      is_Block(const ir_node *node);
1271 /** Returns true if node is an Unknown node. */
1272 int      is_Unknown(const ir_node *node);
1273 /** Returns true if node is a Return node. */
1274 int      is_Return(const ir_node *node);
1275 /** Returns true if node is a Call node. */
1276 int      is_Call(const ir_node *node);
1277 /** Returns true if node is a Builtin node. */
1278 int      is_Builtin(const ir_node *node);
1279 /** Returns true if node is a CallBegin node. */
1280 int      is_CallBegin(const ir_node *node);
1281 /** Returns true if node is a Sel node. */
1282 int      is_Sel(const ir_node *node);
1283 /** Returns true if node is a Mul node. */
1284 int      is_Mul(const ir_node *node);
1285 /** Returns true if node is a Mulh node. */
1286 int      is_Mulh(const ir_node *node);
1287 /** Returns true if node is a Mux node. */
1288 int      is_Mux(const ir_node *node);
1289 /** Returns true if node is a Load node. */
1290 int      is_Load(const ir_node *node);
1291 /** Returns true if node is a Store node. */
1292 int      is_Store(const ir_node *node);
1293 /** Returns true if node is a Sync node. */
1294 int      is_Sync(const ir_node *node);
1295 /** Returns true if node is a Confirm node. */
1296 int      is_Confirm(const ir_node *node);
1297 /** Returns true if node is a Pin node. */
1298 int      is_Pin(const ir_node *node);
1299 /** Returns true if node is a SymConst node. */
1300 int      is_SymConst(const ir_node *node);
1301 /** Returns true if node is a SymConst node with kind symconst_addr_ent. */
1302 int      is_SymConst_addr_ent(const ir_node *node);
1303 /** Returns true if node is a Cond node. */
1304 int      is_Cond(const ir_node *node);
1305 /** Returns true of node is a CopyB node. */
1306 int      is_CopyB(const ir_node *node);
1307 /** Returns true if node is a Cmp node. */
1308 int      is_Cmp(const ir_node *node);
1309 /** Returns true if node is an Alloc node. */
1310 int      is_Alloc(const ir_node *node);
1311 /** Returns true if node is a Free node. */
1312 int      is_Free(const ir_node *node);
1313 /** Returns true if a node is a Jmp node. */
1314 int      is_Jmp(const ir_node *node);
1315 /** Returns true if a node is a IJmp node. */
1316 int      is_IJmp(const ir_node *node);
1317 /** Returns true if a node is a Raise node. */
1318 int      is_Raise(const ir_node *node);
1319 /** Returns true if a node is an ASM node. */
1320 int      is_ASM(const ir_node *node);
1321 /** Returns true if a node is an Dummy node. */
1322 int      is_Dummy(const ir_node *node);
1323 /** Returns true if node is a Proj node or a Filter node in INTRA-procedural view. */
1324 int      is_Proj(const ir_node *node);
1325 /** Returns true if node is a Filter node. */
1326 int      is_Filter(const ir_node *node);
1327
1328 /** Returns true if the operation manipulates control flow:
1329    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
1330 int is_cfop(const ir_node *node);
1331
1332 /** Returns true if the operation manipulates interprocedural control flow:
1333     CallBegin, EndReg, EndExcept */
1334 int is_ip_cfop(const ir_node *node);
1335 /** Returns true if the operation can change the control flow because
1336     of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
1337     Bad. Raise is not fragile, but a unconditional jump. */
1338 int is_fragile_op(const ir_node *node);
1339 /** Returns the memory operand of fragile operations. */
1340 ir_node *get_fragile_op_mem(ir_node *node);
1341 /** Returns the result mode of a Div operation. */
1342 ir_mode *get_divop_resmod(const ir_node *node);
1343
1344 /** Returns true if the operation is a forking control flow
1345  *  operation: Cond. */
1346 int is_irn_forking(const ir_node *node);
1347
1348 /**
1349  * Copies all attributes stored in the old node  to the new node.
1350  * Assumes both have the same opcode and sufficient size.
1351  */
1352 void copy_node_attr(const ir_node *old_node, ir_node *new_node);
1353
1354 /** Return the type associated with the value produced by n
1355  *  if the node remarks this type as it is the case for
1356  *  Cast, Const, SymConst and some Proj nodes or unknown_type. */
1357 ir_type *get_irn_type(ir_node *n);
1358
1359 /** Return the type attribute of a node n (SymConst, Call, Alloc, Free,
1360     Cast) or NULL.*/
1361 ir_type *get_irn_type_attr(ir_node *n);
1362
1363 /** Return the entity attribute of a node n (SymConst, Sel) or NULL. */
1364 ir_entity *get_irn_entity_attr(ir_node *n);
1365
1366 /** Returns non-zero for constant-like nodes. */
1367 int is_irn_constlike(const ir_node *node);
1368
1369 /**
1370  * Returns non-zero for nodes that must be always optimized
1371  * (Phi, Id. Proj, Cond, Block, Confirm ...).
1372  */
1373 int is_irn_always_opt(const ir_node *node);
1374
1375 /**
1376  * Returns non-zero for nodes that are allowed to have keep-alives and
1377  * are neither Block nor PhiM.
1378  */
1379 int is_irn_keep(const ir_node *node);
1380
1381 /**
1382  * Returns non-zero for nodes that are always placed in the start block.
1383  */
1384 int is_irn_start_block_placed(const ir_node *node);
1385
1386 /**
1387  * Returns non-zero for nodes that are machine operations.
1388  */
1389 int is_irn_machine_op(const ir_node *node);
1390
1391 /**
1392  * Returns non-zero for nodes that are machine operands.
1393  */
1394 int is_irn_machine_operand(const ir_node *node);
1395
1396 /**
1397  * Returns non-zero for nodes that have the n'th user machine flag set.
1398  */
1399 int is_irn_machine_user(const ir_node *node, unsigned n);
1400
1401 /**
1402  * A type to express conditional jump predictions.
1403  */
1404 typedef enum {
1405         COND_JMP_PRED_NONE,        /**< No jump prediction. Default. */
1406         COND_JMP_PRED_TRUE,        /**< The True case is predicted. */
1407         COND_JMP_PRED_FALSE        /**< The False case is predicted. */
1408 } cond_jmp_predicate;
1409
1410 /** Gets the string representation of the jump prediction. */
1411 const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
1412
1413 /** Returns the conditional jump prediction of a Cond node. */
1414 cond_jmp_predicate get_Cond_jmp_pred(const ir_node *cond);
1415
1416 /** Sets a new conditional jump prediction. */
1417 void set_Cond_jmp_pred(ir_node *cond, cond_jmp_predicate pred);
1418
1419 /** Checks whether a node represents a global address. */
1420 int is_Global(const ir_node *node);
1421
1422 /* Returns the entity of a global address. */
1423 ir_entity *get_Global_entity(const ir_node *node);
1424
1425 /**
1426  * Access custom node data.
1427  * The data must have been registered with
1428  * register_additional_node_data() before.
1429  * @param node The ir node to get the data from.
1430  * @param type The type of the data you registered.
1431  * @param off The value returned by register_additional_node_data().
1432  * @return A pointer of type @p type.
1433  */
1434 #define get_irn_data(node,type,off) \
1435   (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
1436
1437 /**
1438  * Get the pointer to the node some custom data belongs to.
1439  * @param data The pointer to the custom data.
1440  * @param off The number as returned by register_additional_node_data().
1441  * @return A pointer to the ir node the custom data belongs to.
1442  */
1443 #define get_irn_data_base(data,off) \
1444   (assert(off > 0 && "Invalid node data offset"), (ir_node *) ((char *) (data) + (off)))
1445
1446 /**
1447  * Request additional data to be allocated with an ir node.
1448  * @param size The size of the additional data required.
1449  * @return A positive number, if the operation was successful, which
1450  * must be passed to the access macro get_irn_data(), 0 if the
1451  * registration failed.
1452  */
1453 unsigned firm_register_additional_node_data(unsigned size);
1454
1455 /**
1456  * Return a pointer to the node attributes.
1457  * Needed for user-defined nodes.
1458  */
1459 void *get_irn_generic_attr(ir_node *node);
1460 const void *get_irn_generic_attr_const(const ir_node *node);
1461
1462 /**
1463  * Returns the unique node index for the node in its graph.
1464  * This index is used to access phase information for this node.
1465  */
1466 unsigned get_irn_idx(const ir_node *node);
1467
1468 /**
1469  * Sets the debug information of a node.
1470  *
1471  * @param n   The node.
1472  * @param db  The debug info.
1473  */
1474 void set_irn_dbg_info(ir_node *n, dbg_info *db);
1475
1476 /**
1477  * Returns the debug information of an node.
1478  *
1479  * @param n   The node.
1480  */
1481 dbg_info *get_irn_dbg_info(const ir_node *n);
1482
1483 /**
1484  * Calculate a hash value of a node. Only inputs, mode and opcode are used.
1485  *
1486  * @param node  the node to hash
1487  */
1488 unsigned firm_default_hash(const ir_node *node);
1489
1490 /**
1491  * returns a descriptive name of a node (containing type+number)
1492  */
1493 const char *gdb_node_helper(void *firm_object);
1494
1495 /*@}*/ /* end of ir_node group definition */
1496
1497 #endif