nsz Git - libfirm/blob - ir/ir/irnode.h

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