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

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