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