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