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