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

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