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
  13 # ifndef _IRNODE_H_
  14 # define _IRNODE_H_
  15
  16 #include <stddef.h>
  17
  18 /**
  19  * Projection numbers of compare: use for Proj nodes!
  20  * @remark there are numbers with normalized names below!
  21  */
  22 typedef enum {
  23   False = 0,    /**< false */
  24   Eq,           /**< equal */
  25   Lt,           /**< less */
  26   Le,           /**< less or equal */
  27   Gt,           /**< greater */
  28   Ge,           /**< greater or equal */
  29   Lg,           /**< less or greater */
  30   Leg = 7,      /**< less, equal or greater = ordered */
  31   Uo,           /**< unordered */
  32   Ue,           /**< unordered or equal */
  33   Ul,           /**< unordered or less */
  34   Ule,          /**< unordered, less or equal */
  35   Ug,           /**< unordered or greater */
  36   Uge,          /**< unordered, greater or equal */
  37   Ne,           /**< unordered, less or greater = not equal */
  38   True = 15     /**< true */
  39   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
  40 } pnc_number;   /* pnc: Projection Number Cmp */
  41 #define not_mask Leg
  42
  43 # include "tv.h"
  44 # include "irgraph.h"
  45 # include "entity.h"
  46 # include "firm_common.h"
  47 # include "irop.h"
  48 # include "irmode.h"
  49 # include "type.h"
  50 # include "dbginfo.h"
  51 /* # include "exc.h" */
  52
  53 /**
  54  * @file irnode.h
  55  *
  56  * @author Martin Trapp, Christian Schaefer
  57  *
  58  * Declarations of an ir node.
  59  */
  60
  61 /**
  62  * @defgroup ir_node Declarations of an ir node.
  63  *
  64  * The type definition of ir_node is also in irgraph.h to resolve
  65  *  recursion between irnode.h and irgraph.h
  66  *
  67  * ir_node - a datatype representing a Firm node
  68  *
  69  *  The common fields are:
  70  *
  71  *  - firm_kind - A firm_kind tag containing k_type.  This is useful
  72  *                for dynamically checking whether a node is a ir_node.
  73  *  - arity     - The number of predecessors in the Firm graph.
  74  *  - in        - A list with the predecessors in the Firm graph.  There are
  75  *                routines to access individual elements and to obtain the
  76  *                array.  The method returning the array should not be used.
  77  *  - mode      - The mode of the node.  There are routines to get the mode
  78  *                but also to access the mode's fields directly.
  79  *  - opcode    - The opcode of the node. There are routines to get the opcode
  80  *                but also to access the opcode's fields directly.
  81  *  - node_nr   - A unique number for the node.  Available only if debugging
  82  *                is turned on.
  83  * @{
  84  */
  85
  86 #ifndef _IR_NODE_TYPEDEF_
  87 #define _IR_NODE_TYPEDEF_
  88 typedef struct ir_node ir_node;
  89 #endif
  90
  91 #ifdef __cplusplus
  92 extern "C" {
  93 #endif
  94
  95 /**
  96  *   you can work on the graph without considering the different types
  97  *   of nodes, it's just a big graph.
  98  */
  99
 100 /**
 101  *   Checks whether a pointer points to a ir node.
 102  *
 103  *   @param thing   an arbitrary pointer
 104  *   @return        non-zero if the thing is a ir mode, else zero
 105  */
 106 int is_ir_node (const void *thing);
 107
 108 /**
 109  * Returns the number of predecessors without the block predecessor.
 110  *
 111  * @param node   the IR-node
 112  */
 113 int           get_irn_arity         (const ir_node *node);
 114 int           get_irn_intra_arity   (const ir_node *node);
 115 int           get_irn_inter_arity   (const ir_node *node);
 116
 117 /** Replaces the old in array by a new one that will contain the ins given in
 118    the parameters.  Conserves the block predecessor.  It copies the array passed.
 119    This function is necessary to adjust in arrays of blocks, calls and phis.
 120    Assumes that current_ir_graph is set to the graph containing "node".
 121    "in" must contain all predecessors except the block that are required for
 122    the nodes opcode. */
 123 void          set_irn_in            (ir_node *node, int arity,
 124                         ir_node *in[]);
 125 /* to iterate through the predecessors without touching the array. No
 126    order of predecessors guaranteed.
 127    To iterate over the operands iterate from 0 to i < get_irn_arity(),
 128    to iterate including the Block predecessor iterate from i = -1 to
 129    i < get_irn_arity. */
 130 /* Access predecessor n */
 131
 132 /**
 133  * Get the n-th predecessor of a node.
 134  * This function removes Id predecessors.
 135  */
 136 ir_node      *get_irn_n             (ir_node *node, int n);
 137 ir_node      *get_irn_intra_n       (ir_node *node, int n);
 138 ir_node      *get_irn_inter_n       (ir_node *node, int n);
 139
 140 /** Replace the n-th predecessor of a node with a new one. */
 141 void          set_irn_n             (ir_node *node, int n, ir_node *in);
 142 /* Sets the mode struct of node.  */
 143 void          set_irn_mode (ir_node *node, ir_mode *mode);
 144 /** Gets the mode struct of a node.  */
 145 ir_mode      *get_irn_mode          (const ir_node *node);
 146 /** Gets the mode-enum modecode. */
 147 modecode      get_irn_modecode      (const ir_node *node);
 148 /** Gets the ident for a string representation of the mode .*/
 149 ident        *get_irn_modeident     (const ir_node *node);
 150 /** Gets the string representation of the mode .*/
 151 const char   *get_irn_modename      (const ir_node *node);
 152 /** Gets the opcode struct of the node. */
 153 ir_op        *get_irn_op            (const ir_node *node);
 154 /** Sets the opcode struct of the node. */
 155 void          set_irn_op            (ir_node *node, ir_op *op);
 156 /** Gets the opcode-enum of the node. */
 157 opcode        get_irn_opcode        (const ir_node *node);
 158 /** Get the string representation of the opcode. */
 159 const char   *get_irn_opname        (const ir_node *node);
 160 /** Get the ident for a string representation of the opcode. */
 161 ident        *get_irn_opident       (const ir_node *node);
 162 /** Gets the visited counter of a node. */
 163 unsigned long get_irn_visited (const ir_node *node);
 164 /** Sets the visited counter of a node. */
 165 void          set_irn_visited (ir_node *node, unsigned long visited);
 166 /** Sets visited to get_irg_visited(current_ir_graph). */
 167 void          mark_irn_visited (ir_node *node);
 168 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
 169 int           irn_not_visited  (const ir_node *node);
 170 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
 171 int           irn_visited      (const ir_node *node);
 172
 173 /**
 174  * Sets the link of a node.
 175  * Only allowed if the graph is NOT in phase_building.
 176  */
 177 void          set_irn_link     (ir_node *node, void *link);
 178
 179 /** Returns the link of a node.  */
 180 void         *get_irn_link     (const ir_node *node);
 181
 182 /** Returns the ir_graph this node belongs to. Only valid if irg
 183  *  is in state op_pin_state_pinned (irg is only stored in the block. */
 184 ir_graph     *get_irn_irg      (ir_node *node);
 185
 186 /** Outputs a unique number for this node if libFIRM is compiled for
 187    debugging, (configure with --enable-debug) else returns address
 188    of node cast to long. */
 189 long          get_irn_node_nr  (const ir_node *node);
 190
 191 /** Returns the pinned state of a node. */
 192 op_pin_state get_irn_pinned    (const ir_node *node);
 193
 194 /** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
 195 void set_irn_pinned(ir_node *node, op_pin_state state);
 196
 197 /**
 198  * irnode constructor.
 199  * Create a new irnode in irg, with an op, mode, arity and
 200  * some incoming irnodes.
 201  * This constructor is used in every specified irnode constructor.
 202  *
 203  * @param db    Debug info.
 204  * @param irg   IR-graph on with this new node should be constructed.
 205  * @param op    The opcode of the new node.
 206  * @param mode  The mode of the new node.
 207  * @param arity The arity of the new node, may be <0 if yet.
 208  * @param in    An array of arity predecessor nodes.
 209  */
 210 ir_node *
 211 new_ir_node (dbg_info *db,
 212          ir_graph *irg,
 213          ir_node *block,
 214          ir_op *op,
 215          ir_mode *mode,
 216          int arity,
 217          ir_node *in[]);
 218
 219 /** Return the block the node belongs to.
 220  *
 221  * This works for all except Block.  It can return Blocks or the Bad node.
 222  *
 223  * To express the difference to access routines that work for all
 224  * nodes we use infix "nodes" and do not name this function
 225  * get_irn_block. */
 226 ir_node  *get_nodes_block (ir_node *node);
 227
 228 /** Sets the Block of a node. */
 229 void      set_nodes_block (ir_node *node, ir_node *block);
 230
 231 /**
 232  * @function get_irn_block()
 233  * @see get_nodes_block()
 234  */
 235 /**
 236  * Projection numbers for result of Start node: use for Proj nodes!
 237  */
 238 typedef enum {
 239   pn_Start_X_initial_exec,   /**< Projection on the initial control flow. */
 240   pn_Start_M,                /**< Projection on the initial memory. */
 241   pn_Start_P_frame_base,     /**< Projection on the frame base pointer. */
 242   pn_Start_P_globals,        /**< Projection on the pointer to the data segment
 243                                   containing _all_ global entities. */
 244   pn_Start_T_args,           /**< Projection on all arguments. */
 245   pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
 246                                   type of this method. */
 247   pn_Start_max               /**< number of projections from a Start */
 248 } pn_Start; /* Projection numbers for Start. */
 249
 250
 251 /** Test whether arbitrary node is frame pointer.
 252  *
 253  * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 254  * from Start.  If so returns frame type, else Null. */
 255 type *is_frame_pointer(ir_node *n);
 256
 257 /** Test whether arbitrary node is globals pointer.
 258  *
 259  * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
 260  * from Start.  If so returns global type, else Null. */
 261 type *is_globals_pointer(ir_node *n);
 262
 263 /** Test whether arbitrary node is value arg base.
 264  *
 265  * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
 266  * from Start.   If so returns 1, else 0. */
 267 int   is_value_arg_pointer(ir_node *n);
 268
 269
 270 /* @@@ no more supported  */
 271 ir_node **get_Block_cfgpred_arr (ir_node *node);
 272 int       get_Block_n_cfgpreds (ir_node *node);
 273 ir_node  *get_Block_cfgpred (ir_node *node, int pos);
 274 void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 275 bool      get_Block_matured (ir_node *node);
 276 void      set_Block_matured (ir_node *node, bool matured);
 277 unsigned long get_Block_block_visited (ir_node *node);
 278 void      set_Block_block_visited (ir_node *node, unsigned long visit);
 279 /* For this current_ir_graph must be set. */
 280 void      mark_Block_block_visited(ir_node *node);
 281 int       Block_not_block_visited(ir_node *node);
 282
 283 /* Set and remove interprocedural predecessors. If the interprocedural
 284  * predecessors are removed, the node has the same predecessors in
 285  * both views.
 286  * @@@ Maybe better:  arity is zero if no cg preds. */
 287 void      set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
 288 void      set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
 289 /* @@@ not supported */
 290 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
 291 /** Returns the number of interprocedural predecessors.  0 if none. */
 292 int       get_Block_cg_n_cfgpreds(ir_node * node);
 293 /** Return the interprocedural predecessor at position pos. */
 294 ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
 295 /* frees the memory. */
 296 void      remove_Block_cg_cfgpred_arr(ir_node * node);
 297
 298 /** Return the number of Keep alive node. */
 299 int  get_End_n_keepalives(ir_node *end);
 300
 301 /** Return the Keep alive node a position pos. */
 302 ir_node *get_End_keepalive(ir_node *end, int pos);
 303
 304 /** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
 305 void add_End_keepalive (ir_node *end, ir_node *ka);
 306
 307 /** Set the Keep alive node at position pos. */
 308 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
 309
 310 /** Some parts of the End node are allocated separately -- their memory
 311    is not recovered by dead_node_elimination if a End node is dead.
 312    free_End() frees these data structures. */
 313 void free_End (ir_node *end);
 314
 315
 316 /* We distinguish three kinds of Cond nodes.  These can be distinguished
 317    by the mode of the selector operand and an internal flag of type cond_kind.
 318    First we distinguish binary Conds and switch Conds.
 319    A binary Cond has as selector a boolean value.  Proj(0) projects the control
 320    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
 321    is recognized by the boolean selector.
 322    The switch Cond has as selector an unsigned integer.  It produces as result
 323    an n+1 Tuple (cf0, ... , cfn) of control flows.
 324    We differ two flavours of this Cond.  The first, the dense Cond, passes
 325    control along output i if the selector value is i, 0 <= i <= n.  If the
 326    selector value is >n it passes control along output n.
 327    The second Cond flavor differes in the treatment of cases not specified in
 328    the source program.  It magically knows about the existence of Proj nodes.
 329    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
 330    exists.  Else it passes control along output n (even if this Proj does not
 331    exist.)  This Cond we call "fragmentary".  There is a special constructor
 332    new_defaultProj that automatically sets the flavor.
 333    The two switch flavors are distinguished by a flag of type cond_kind.
 334    Default flavor is "dense"
 335 */
 336 typedef enum {
 337   dense,        /**< Default. Missing Proj nodes are dead control flow. */
 338   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
 339            Proj nodes mean default control flow, i.e., Proj(n). */
 340 } cond_kind;
 341
 342 ir_node  *get_Cond_selector (ir_node *node);
 343 void      set_Cond_selector (ir_node *node, ir_node *selector);
 344 cond_kind get_Cond_kind (ir_node *node);
 345 void      set_Cond_kind (ir_node *node, cond_kind kind);
 346 long      get_Cond_defaultProj (ir_node *node);
 347
 348 /**
 349  * Projection numbers for conditions.
 350  */
 351 typedef enum {
 352   pn_Cond_false,    /**< Control flow if operand is "false". */
 353   pn_Cond_true,     /**< Control flow if operand is "true".  */
 354   pn_Cond_max       /**< number of projections from a Cond */
 355 } pn_Cond;  /* Projection numbers for Cond. */
 356
 357 ir_node  *get_Return_mem (ir_node *node);
 358 void      set_Return_mem (ir_node *node, ir_node *mem);
 359 ir_node **get_Return_res_arr (ir_node *node);
 360 int       get_Return_n_ress (ir_node *node);
 361 ir_node  *get_Return_res (ir_node *node, int pos);
 362 void      set_Return_res (ir_node *node, int pos, ir_node *res);
 363
 364 ir_node *get_Raise_mem (ir_node *node);
 365 void     set_Raise_mem (ir_node *node, ir_node *mem);
 366 ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
 367 void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
 368
 369 /**
 370  * Projection numbers for Raise.
 371  */
 372 typedef enum {
 373   pn_Raise_X,    /**< Execution result. */
 374   pn_Raise_M,    /**< Memory result.    */
 375   pn_Raise_max   /**< number of projections from a Raise */
 376 } pn_Raise;  /* Projection numbers for Raise. */
 377
 378 tarval  *get_Const_tarval (ir_node *node);
 379 void     set_Const_tarval (ir_node *node, tarval *con);
 380
 381 /** Returns the source language type of a Const node.
 382  * Must be an atomic type.  Mode of type must be mode of node.
 383  */
 384 type    *get_Const_type   (ir_node *node);
 385
 386 /** Sets the source language type of a Const node. */
 387 void     set_Const_type   (ir_node *node, type *tp);
 388
 389 /**  This enum names the three different kinds of symbolic Constants
 390      represented by SymConst.  The content of the attribute type_or_id
 391      depends on this tag.  Use the proper access routine after testing
 392      this flag. */
 393 typedef enum {
 394   symconst_type_tag,    /**< The SymConst is a type tag for the given type.
 395                            Type_or_id_p is type *. */
 396   symconst_size,        /**< The SymConst is the size of the given type.
 397                            Type_or_id_p is type *. */
 398   symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
 399                            by the linker.  The pointer is represented by a string.
 400                            Type_or_id_p is ident *. */
 401   symconst_addr_ent     /**< The SymConst is a symbolic pointer to be filled in
 402                            by the linker.  The pointer is represented by an entity.
 403                            Type_or_id_p is entity *. */
 404 } symconst_kind;
 405
 406 /** SymConst attributes
 407     This union contains the symbolic information represented by the node  */
 408 union symconst_symbol {
 409   type   *type_p;
 410   ident  *ident_p;
 411   entity *entity_p;
 412 };
 413
 414 typedef union symconst_symbol symconst_symbol;
 415
 416
 417 /** Get the kind of the SymConst. */
 418 symconst_kind get_SymConst_kind (const ir_node *node);
 419 /** Set the kind of the SymConst. */
 420 void          set_SymConst_kind (ir_node *node, symconst_kind num);
 421
 422 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
 423 type    *get_SymConst_type (ir_node *node);
 424 void     set_SymConst_type (ir_node *node, type *tp);
 425
 426 /** Only to access SymConst of kind addr_name.  Else assertion: */
 427 ident   *get_SymConst_name (ir_node *node);
 428 void     set_SymConst_name (ir_node *node, ident *name);
 429
 430 /** Only to access SymConst of kind addr_ent.  Else assertion: */
 431 entity  *get_SymConst_entity (ir_node *node);
 432 void     set_SymConst_entity (ir_node *node, entity *ent);
 433
 434 /** Sets both: type and ptrinfo.  Needed to treat the node independent of
 435    its semantics.  Does a memcpy for the memory sym points to. */
 436 /* write 'union': firmjni then does not create a method... */
 437 union symconst_symbol get_SymConst_symbol (ir_node *node);
 438 void                  set_SymConst_symbol (ir_node *node,
 439                                            union symconst_symbol sym);
 440
 441 /** Access the type of the value represented by the SymConst.
 442  *
 443  *  Example: primitive type int for SymConst size. */
 444 type *get_SymConst_value_type (ir_node *node);
 445 void  set_SymConst_value_type (ir_node *node, type *tp);
 446
 447 ir_node *get_Sel_mem (ir_node *node);
 448 void     set_Sel_mem (ir_node *node, ir_node *mem);
 449 ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 450 void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 451 ir_node **get_Sel_index_arr (ir_node *node);
 452 int      get_Sel_n_indexs (ir_node *node);
 453 ir_node *get_Sel_index (ir_node *node, int pos);
 454 void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 455 entity  *get_Sel_entity (ir_node *node); /* entity to select */
 456 void     set_Sel_entity (ir_node *node, entity *ent);
 457
 458 /**
 459  * Projection numbers for result of Call node: use for Proj nodes!
 460  */
 461 typedef enum {
 462   pn_Call_M_regular = 0,  /**< The memory result. */
 463   pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
 464   pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
 465                  passed by value (for compound result types). */
 466   pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
 467   pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
 468                  an exception */
 469   pn_Call_max       = 5   /**< number of projections from a Call */
 470 } pn_Call;   /* Projection numbers for Call. */
 471
 472 ir_node *get_Call_mem (ir_node *node);
 473 void     set_Call_mem (ir_node *node, ir_node *mem);
 474 ir_node *get_Call_ptr (ir_node *node);
 475 void     set_Call_ptr (ir_node *node, ir_node *ptr);
 476 ir_node **get_Call_param_arr (ir_node *node);
 477 /** Gets the number of parameters of a call. */
 478 int      get_Call_n_params (ir_node *node);
 479 /** Gets the call parameter at position pos. */
 480 ir_node *get_Call_param (ir_node *node, int pos);
 481 /** Sets the call parameter at position pos. */
 482 void     set_Call_param (ir_node *node, int pos, ir_node *param);
 483 /** Gets the type of a call. */
 484 type    *get_Call_type (ir_node *node);
 485 /** Sets the type of a call. */
 486 void     set_Call_type (ir_node *node, type *tp);
 487 /** Gets the arity of a call. Identical to get_Call_n_params(). */
 488 int      get_Call_arity (ir_node *node);
 489
 490 /** Set, get and remove the callee information for a Call node.
 491  *
 492  *  The callee information lists all method entities that can be called
 493  *  from this node.  If the address expression can not be analyzed fully,
 494  *  e.g., as entities can be called that are not in the compilation unit,
 495  *  the array contains the unknown_entity.  The array contains only entities
 496  *  with peculiarity_existent, but with all kinds of visibility.  The entities
 497  *  not necessarily contain an irg.
 498  *
 499  *  The array is only accessible if callee information is valid.  See flag
 500  *  in graph.
 501  *
 502  *  The memory allocated for the array is managed automatically, i.e., it must
 503  *  not be freed if the Call node is removed from the graph.
 504  *
 505  *  @param node A Call node.
 506  */
 507 int     Call_has_callees      (ir_node *node);
 508 int     get_Call_n_callees    (ir_node *node);
 509 entity *get_Call_callee       (ir_node *node, int pos);
 510
 511 /** Set the full callee array.
 512  *
 513  *  The passed array is copied. Assumes current_ir_graph set properly! */
 514 void    set_Call_callee_arr   (ir_node *node, const int n, entity **arr);
 515 void    remove_Call_callee_arr(ir_node *node);
 516
 517 ir_node  *get_CallBegin_ptr  (ir_node *node);
 518 void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
 519 ir_node  *get_CallBegin_call (ir_node *node);
 520 void      set_CallBegin_call (ir_node *node, ir_node *call);
 521
 522 /* For unary and binary arithmetic operations the access to the
 523    operands can be factored out.  Left is the first, right the
 524    second arithmetic value  as listed in tech report 1999-44.
 525    unops are: Minus, Abs, Not, Conv, Cast
 526    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 527    Shr, Shrs, Rot, Cmp */
 528 int      is_unop (const ir_node *node);
 529 ir_node *get_unop_op (ir_node *node);
 530 void     set_unop_op (ir_node *node, ir_node *op);
 531 int      is_binop (const ir_node *node);
 532 ir_node *get_binop_left (ir_node *node);
 533 void     set_binop_left (ir_node *node, ir_node *left);
 534 ir_node *get_binop_right (ir_node *node);
 535 void     set_binop_right (ir_node *node, ir_node *right);
 536
 537 ir_node *get_Add_left (ir_node *node);
 538 void     set_Add_left (ir_node *node, ir_node *left);
 539 ir_node *get_Add_right (ir_node *node);
 540 void     set_Add_right (ir_node *node, ir_node *right);
 541
 542 ir_node *get_Sub_left (ir_node *node);
 543 void     set_Sub_left (ir_node *node, ir_node *left);
 544 ir_node *get_Sub_right (ir_node *node);
 545 void     set_Sub_right (ir_node *node, ir_node *right);
 546
 547 ir_node *get_Minus_op (ir_node *node);
 548 void     set_Minus_op (ir_node *node, ir_node *op);
 549
 550 ir_node *get_Mul_left (ir_node *node);
 551 void     set_Mul_left (ir_node *node, ir_node *left);
 552 ir_node *get_Mul_right (ir_node *node);
 553 void     set_Mul_right (ir_node *node, ir_node *right);
 554
 555 ir_node *get_Quot_left (ir_node *node);
 556 void     set_Quot_left (ir_node *node, ir_node *left);
 557 ir_node *get_Quot_right (ir_node *node);
 558 void     set_Quot_right (ir_node *node, ir_node *right);
 559 ir_node *get_Quot_mem (ir_node *node);
 560 void     set_Quot_mem (ir_node *node, ir_node *mem);
 561
 562 /**
 563  * Projection numbers for Quot: use for Proj nodes!
 564  */
 565 typedef enum {
 566   pn_Quot_M,           /**< Memory result.    */
 567   pn_Quot_X_except,    /**< Execution result if exception occured. */
 568   pn_Quot_res,         /**< Result of computation. */
 569   pn_Quot_max          /**< number of projections from a Quot */
 570 } pn_Quot;  /* Projection numbers for Quot. */
 571
 572 ir_node *get_DivMod_left (ir_node *node);
 573 void     set_DivMod_left (ir_node *node, ir_node *left);
 574 ir_node *get_DivMod_right (ir_node *node);
 575 void     set_DivMod_right (ir_node *node, ir_node *right);
 576 ir_node *get_DivMod_mem (ir_node *node);
 577 void     set_DivMod_mem (ir_node *node, ir_node *mem);
 578
 579 /**
 580  * Projection numbers for DivMod: use for Proj nodes!
 581  */
 582 typedef enum {
 583   pn_DivMod_M,           /**< Memory result.    */
 584   pn_DivMod_X_except,    /**< Execution result if exception occured. */
 585   pn_DivMod_res_div,     /**< Result of computation a / b. */
 586   pn_DivMod_res_mod,     /**< Result of computation a % b. */
 587   pn_DivMod_max          /**< number of projections from a DivMod */
 588 } pn_DivMod;  /* Projection numbers for DivMod. */
 589
 590 ir_node *get_Div_left (ir_node *node);
 591 void     set_Div_left (ir_node *node, ir_node *left);
 592 ir_node *get_Div_right (ir_node *node);
 593 void     set_Div_right (ir_node *node, ir_node *right);
 594 ir_node *get_Div_mem (ir_node *node);
 595 void     set_Div_mem (ir_node *node, ir_node *mem);
 596
 597 /**
 598  * Projection numbers for Div: use for Proj nodes!
 599  */
 600 typedef enum {
 601   pn_Div_M,           /**< Memory result.    */
 602   pn_Div_X_except,    /**< Execution result if exception occured. */
 603   pn_Div_res          /**< Result of computation. */
 604 } pn_Div;  /* Projection numbers for Div. */
 605
 606 ir_node *get_Mod_left (ir_node *node);
 607 void     set_Mod_left (ir_node *node, ir_node *left);
 608 ir_node *get_Mod_right (ir_node *node);
 609 void     set_Mod_right (ir_node *node, ir_node *right);
 610 ir_node *get_Mod_mem (ir_node *node);
 611 void     set_Mod_mem (ir_node *node, ir_node *mem);
 612
 613 /**
 614  * Projection numbers for Mod: use for Proj nodes!
 615  */
 616 typedef enum {
 617   pn_Mod_M,           /**< Memory result.    */
 618   pn_Mod_X_except,    /**< Execution result if exception occured. */
 619   pn_Mod_res,         /**< Result of computation. */
 620   pn_Mod_max          /**< number of projections from a Mod */
 621 } pn_Mod;  /* Projection numbers for Mod. */
 622
 623 ir_node *get_Abs_op (ir_node *node);
 624 void     set_Abs_op (ir_node *node, ir_node *op);
 625
 626 ir_node *get_And_left (ir_node *node);
 627 void     set_And_left (ir_node *node, ir_node *left);
 628 ir_node *get_And_right (ir_node *node);
 629 void     set_And_right (ir_node *node, ir_node *right);
 630
 631 ir_node *get_Or_left (ir_node *node);
 632 void     set_Or_left (ir_node *node, ir_node *left);
 633 ir_node *get_Or_right (ir_node *node);
 634 void     set_Or_right (ir_node *node, ir_node *right);
 635
 636 ir_node *get_Eor_left (ir_node *node);
 637 void     set_Eor_left (ir_node *node, ir_node *left);
 638 ir_node *get_Eor_right (ir_node *node);
 639 void     set_Eor_right (ir_node *node, ir_node *right);
 640
 641 ir_node *get_Not_op (ir_node *node);
 642 void     set_Not_op (ir_node *node, ir_node *op);
 643
 644 /**
 645  * Projection numbers for Cmp are defined several times.
 646  * The bit patterns are used for various tests, so don't change.
 647  * The "unordered" values are possible results of comparing
 648  * floating point numbers.
 649  * Note that the encoding is imported, so do NOT change the order.
 650  */
 651 typedef enum {
 652   pn_Cmp_False = 0,                             /**< false */
 653   pn_Cmp_Eq    = 1,                             /**< equal */
 654   pn_Cmp_Lt    = 2,                             /**< less */
 655   pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
 656   pn_Cmp_Gt    = 4,                             /**< greater */
 657   pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
 658   pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
 659   pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
 660   pn_Cmp_Uo    = 8,                             /**< unordered */
 661   pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
 662   pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
 663   pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
 664   pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
 665   pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
 666   pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
 667   pn_Cmp_True  = 15                             /**< true */
 668   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
 669 } pn_Cmp;   /* Projection numbers for Cmp */
 670 /* #define not_mask pn_Cmp_Leg */
 671
 672 const char *get_pnc_string(int pnc);
 673 int         get_negated_pnc(int pnc);
 674 ir_node *get_Cmp_left (ir_node *node);
 675 void     set_Cmp_left (ir_node *node, ir_node *left);
 676 ir_node *get_Cmp_right (ir_node *node);
 677 void     set_Cmp_right (ir_node *node, ir_node *right);
 678
 679 ir_node *get_Shl_left (ir_node *node);
 680 void     set_Shl_left (ir_node *node, ir_node *left);
 681 ir_node *get_Shl_right (ir_node *node);
 682 void     set_Shl_right (ir_node *node, ir_node *right);
 683
 684 ir_node *get_Shr_left (ir_node *node);
 685 void     set_Shr_left (ir_node *node, ir_node *left);
 686 ir_node *get_Shr_right (ir_node *node);
 687 void     set_Shr_right (ir_node *node, ir_node *right);
 688
 689 ir_node *get_Shrs_left (ir_node *node);
 690 void     set_Shrs_left (ir_node *node, ir_node *left);
 691 ir_node *get_Shrs_right (ir_node *node);
 692 void     set_Shrs_right (ir_node *node, ir_node *right);
 693
 694 ir_node *get_Rot_left (ir_node *node);
 695 void     set_Rot_left (ir_node *node, ir_node *left);
 696 ir_node *get_Rot_right (ir_node *node);
 697 void     set_Rot_right (ir_node *node, ir_node *right);
 698
 699 ir_node *get_Conv_op (ir_node *node);
 700 void     set_Conv_op (ir_node *node, ir_node *op);
 701
 702 /* Does Cast need a mem operator?
 703  * Cast should only depend on the type, not on the state of an
 704  * entity.  But:  we initialze various fields after Alloc, that
 705  * are accessed in the cast.  This required some precaution, to
 706  * get the right memory into the Loads generated from the cast.
 707  */
 708 ir_node *get_Cast_op (ir_node *node);
 709 void     set_Cast_op (ir_node *node, ir_node *op);
 710 type    *get_Cast_type (ir_node *node);
 711 void     set_Cast_type (ir_node *node, type *to_tp);
 712
 713 /** Returns true if n is Phi or Filter in interprocedural_view.
 714    Returns false if irg in phase building and the Phi has zero
 715    predecessors: it's a Phi0. */
 716 int       is_Phi (ir_node *n);
 717 /** Returns true  if irg in phase building and the Phi has zero
 718    predecessors: it's a Phi0. */
 719 int       is_Phi0 (ir_node *n);
 720 /* These routines also work for Filter nodes in interprocedural view. */
 721 ir_node **get_Phi_preds_arr (ir_node *node);
 722 int       get_Phi_n_preds (ir_node *node);
 723 ir_node  *get_Phi_pred (ir_node *node, int pos);
 724 void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 725
 726 ir_node  *get_Filter_pred(ir_node *node);
 727 void      set_Filter_pred(ir_node *node, ir_node *pred);
 728 long      get_Filter_proj(ir_node *node);
 729 void      set_Filter_proj(ir_node *node, long proj);
 730 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 731  * @@@ Maybe better:  arity is zero if no cg preds. */
 732 void     set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
 733 void     set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
 734 int      get_Filter_n_cg_preds(ir_node *node);
 735 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
 736
 737 /** Return true if parameter is a memory operation.
 738  *
 739  *  A memory operation is an operation that changes the
 740  *  memory.  I.e., a Load or a Store operation.
 741  */
 742 int is_memop(ir_node *node);
 743 ir_node *get_memop_mem (ir_node *node);
 744 void     set_memop_mem (ir_node *node, ir_node *mem);
 745 ir_node *get_memop_ptr (ir_node *node);
 746 void     set_memop_ptr (ir_node *node, ir_node *ptr);
 747
 748 /**
 749  * Projection numbers for Load: use for Proj nodes!
 750  */
 751 typedef enum {
 752   pn_Load_M,         /**< Memory result.    */
 753   pn_Load_X_except,  /**< Execution result if exception occured. */
 754   pn_Load_res,       /**< Result of load operation. */
 755   pn_Load_max        /**< number of projections from a Load */
 756 } pn_Load;  /* Projection numbers for Load. */
 757
 758 ir_node       *get_Load_mem (ir_node *node);
 759 void           set_Load_mem (ir_node *node, ir_node *mem);
 760 ir_node       *get_Load_ptr (ir_node *node);
 761 void           set_Load_ptr (ir_node *node, ir_node *ptr);
 762 ir_mode       *get_Load_mode (ir_node *node);
 763 void           set_Load_mode (ir_node *node, ir_mode *mode);
 764 ent_volatility get_Load_volatility (ir_node *node);
 765 void           set_Load_volatility (ir_node *node, ent_volatility volatility);
 766
 767 /**
 768  * Projection numbers for Store: use for Proj nodes!
 769  */
 770 typedef enum {
 771   pn_Store_M,         /**< Memory result.    */
 772   pn_Store_X_except,  /**< Execution result if exception occured. */
 773   pn_Store_max        /**< number of projections from a Store */
 774 } pn_Store;  /* Projection numbers for Store. */
 775
 776 ir_node       *get_Store_mem (ir_node *node);
 777 void           set_Store_mem (ir_node *node, ir_node *mem);
 778 ir_node       *get_Store_ptr (ir_node *node);
 779 void           set_Store_ptr (ir_node *node, ir_node *ptr);
 780 ir_node       *get_Store_value (ir_node *node);
 781 void           set_Store_value (ir_node *node, ir_node *value);
 782 ent_volatility get_Store_volatility (ir_node *node);
 783 void           set_Store_volatility (ir_node *node, ent_volatility volatility);
 784
 785 /**
 786  * Projection numbers for Alloc: use for Proj nodes!
 787  */
 788 typedef enum {
 789   pn_Alloc_M,          /**< Memory result. */
 790   pn_Alloc_X_except,  /**< Execution result if exception occured. */
 791   pn_Alloc_res,       /**< Result of allocation. */
 792   pn_Alloc_max        /**< number of projections from an Alloc */
 793 } pn_Alloc;  /* Projection numbers for Alloc. */
 794
 795 ir_node *get_Alloc_mem (ir_node *node);
 796 void     set_Alloc_mem (ir_node *node, ir_node *mem);
 797 ir_node *get_Alloc_size (ir_node *node);
 798 void     set_Alloc_size (ir_node *node, ir_node *size);
 799 type    *get_Alloc_type (ir_node *node);
 800 void     set_Alloc_type (ir_node *node, type *tp);
 801
 802 /** The allocation place. */
 803 typedef enum {
 804   stack_alloc,          /**< Alloc allocates the object on the stack. */
 805   heap_alloc            /**< Alloc allocates the object on the heap. */
 806 } where_alloc;
 807
 808 where_alloc  get_Alloc_where (ir_node *node);
 809 void         set_Alloc_where (ir_node *node, where_alloc where);
 810
 811 ir_node *get_Free_mem (ir_node *node);
 812 void     set_Free_mem (ir_node *node, ir_node *mem);
 813 ir_node *get_Free_ptr (ir_node *node);
 814 void     set_Free_ptr (ir_node *node, ir_node *ptr);
 815 ir_node *get_Free_size (ir_node *node);
 816 void     set_Free_size (ir_node *node, ir_node *size);
 817 type    *get_Free_type (ir_node *node);
 818 void     set_Free_type (ir_node *node, type *tp);
 819
 820 ir_node **get_Sync_preds_arr (ir_node *node);
 821 int       get_Sync_n_preds (ir_node *node);
 822 ir_node  *get_Sync_pred (ir_node *node, int pos);
 823 void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 824
 825 ir_node  *get_Proj_pred (ir_node *node);
 826 void      set_Proj_pred (ir_node *node, ir_node *pred);
 827 long      get_Proj_proj (ir_node *node);
 828 void      set_Proj_proj (ir_node *node, long proj);
 829
 830 ir_node **get_Tuple_preds_arr (ir_node *node);
 831 int       get_Tuple_n_preds (ir_node *node);
 832 ir_node  *get_Tuple_pred (ir_node *node, int pos);
 833 void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 834
 835 ir_node  *get_Id_pred (ir_node *node);
 836 void      set_Id_pred (ir_node *node, ir_node *pred);
 837
 838 /** Confirm has a single result and returns 'value' unchanged.
 839  *  The node expresses a restriction on 'value':
 840  *  'value' 'cmp' 'bound' == true.                                 */
 841 ir_node *get_Confirm_value (ir_node *node);
 842 void     set_Confirm_value (ir_node *node, ir_node *value);
 843 ir_node *get_Confirm_bound (ir_node *node);
 844 void     set_Confirm_bound (ir_node *node, ir_node *bound);
 845 pn_Cmp   get_Confirm_cmp   (ir_node *node);
 846 void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
 847
 848 /*
 849  *
 850  * NAME Auxiliary routines
 851  *
 852  *  Not properly documented ;-)
 853  *
 854  */
 855
 856 /** returns operand of node if node is a Proj. */
 857 ir_node *skip_Proj (ir_node *node);
 858 /** returns operand of node if node is a Id */
 859 ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
 860 /* returns corresponding operand of Tuple if node is a Proj from
 861    a Tuple. */
 862 ir_node *skip_Tuple (ir_node *node);
 863 /** returns operand of node if node is a Cast */
 864 ir_node *skip_Cast  (ir_node *node);
 865 /** returns true if node is a Bad node. */
 866 int      is_Bad    (const ir_node *node);
 867 /** returns true if the node is not a Block */
 868 int      is_no_Block (const ir_node *node);
 869 /** returns true if the node is a Block */
 870 int      is_Block (const ir_node *node);
 871 /** returns true if node is a Unknown node. */
 872 int      is_Unknown (const ir_node *node);
 873 /** returns true if node is a Proj node or a Filter node in
 874  * intraprocedural view */
 875 int      is_Proj (const ir_node *node);
 876 /** Returns true if the operation manipulates control flow:
 877    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
 878 int is_cfop(const ir_node *node);
 879
 880 /** Returns true if the operation manipulates interprocedural control flow:
 881     CallBegin, EndReg, EndExcept */
 882 int is_ip_cfop(const ir_node *node);
 883 /** Returns true if the operation can change the control flow because
 884     of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
 885     Bad. */
 886 int is_fragile_op(const ir_node *node);
 887 /** Returns the memory operand of fragile operations. */
 888 ir_node *get_fragile_op_mem(ir_node *node);
 889
 890 /** Returns true if the operation is a forking control flow
 891  *  operation: Cond. */
 892 int is_forking_op(const ir_node *node);
 893
 894 /**
 895  * Access custom node data.
 896  * The data must have been registered with
 897  * register_additional_node_data() before.
 898  * @param node The ir node to get the data from.
 899  * @param type The type of the data you registered.
 900  * @param off The value returned by register_additional_node_data.
 901  * @return A pointer of type @p type.
 902  */
 903 #define get_irn_data(node,type,off) \
 904  (assert(off > 0 && "Invalid node data offset"), (type *) ((char *) (node) - (off)))
 905
 906 /**
 907  * Request additional data to be allocated with an ir node.
 908  * @param size The size of the additional data required.
 909  * @return A positive number, if the opration was successful, which
 910  * must be passed to the access macro get_irn_data(), 0 if the
 911  * registration failed.
 912  */
 913 size_t register_additional_node_data(size_t size);
 914
 915
 916 /*-----------------------------------------------------------------*/
 917 /** Debug aides                                                   **/
 918 /*-----------------------------------------------------------------*/
 919
 920
 921 /** Debug print the node.
 922  *
 923  *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
 924  *  is set.  Else does nothing. */
 925 void    dump_irn(ir_node *n);
 926
 927 #include "ident.h"
 928
 929 #ifdef __GNUC__
 930 /* GNU C has the __FUNCTION__ extension */
 931 #define __MYFUNC__ __FUNCTION__
 932 #else
 933 /* use Filename instead */
 934 #define __MYFUNC__ __FILE__
 935 #endif
 936
 937 /* !!!!!!!!! @@@
 938    Don't format with "\", firmjni gets problems */
 939 /** Output location */
 940 #define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
 941 /** Output the firm kind of the node */
 942 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
 943 /** Output information about a node */
 944 #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))
 945 /** Output information about a node and its block */
 946 #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)))
 947 /** Output information about a type */
 948 #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))
 949 /** Output information about an entity */
 950 #define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
 951 /** Output information about an entity and its type */
 952 #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))
 953 /** Output information about an entity and its owner */
 954 #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))
 955 /** Output information about a graph */
 956 #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))))
 957 /** Output information about an ident */
 958 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
 959 /** Output information about a mode */
 960 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
 961 /** Output information about a loop */
 962 #define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
 963 /** Output information about a tarVal */
 964 #define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
 965
 966 /*@}*/ /* end of ir_node group definition */
 967
 968
 969 #ifdef __cplusplus
 970 }
 971 #endif
 972
 973 # endif /* _IRNODE_H_ */