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