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