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