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