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

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