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