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
  92 #endif
  93
  94 /**
  95  *   you can work on the graph without considering the different types
  96  *   of nodes, it's just a big graph.
  97  */
  98
  99 /**
 100  *   Checks whether a pointer points to a ir node.
 101  *
 102  *   @param thing   an arbitrary pointer
 103  *   @return        non-zero if the thing is a ir mode, else zero
 104  */
 105 int is_ir_node (const void *thing);
 106
 107 /**
 108  * Returns the number of predecessors without the block predecessor.
 109  *
 110  * @param node   the IR-node
 111  */
 112 int           get_irn_arity         (const ir_node *node);
 113 int           get_irn_intra_arity   (const ir_node *node);
 114 int           get_irn_inter_arity   (const ir_node *node);
 115
 116 /** Replaces the old in array by a new one that will contain the ins given in
 117    the parameters.  Conserves the block predecessor.  It copies the array passed.
 118    This function is necessary to adjust in arrays of blocks, calls and phis.
 119    Assumes that current_ir_graph is set to the graph containing "node".
 120    "in" must contain all predecessors except the block that are required for
 121    the nodes opcode. */
 122 void          set_irn_in            (ir_node *node, int arity,
 123                         ir_node *in[]);
 124 /* to iterate through the predecessors without touching the array. No
 125    order of predecessors guaranteed.
 126    To iterate over the operands iterate from 0 to i < get_irn_arity(),
 127    to iterate including the Block predecessor iterate from i = -1 to
 128    i < get_irn_arity. */
 129 /* Access predecessor n */
 130
 131 /**
 132  * Get the n-th predecessor of a node.
 133  * This function removes Id predecessors.
 134  */
 135 ir_node      *get_irn_n             (ir_node *node, int n);
 136 ir_node      *get_irn_intra_n       (ir_node *node, int n);
 137 ir_node      *get_irn_inter_n       (ir_node *node, int n);
 138
 139 /** Replace the n-th predecessor of a node with a new one. */
 140 void          set_irn_n             (ir_node *node, int n, ir_node *in);
 141 /* Sets the mode struct of node.  */
 142 void          set_irn_mode (ir_node *node, ir_mode *mode);
 143 /** Gets the mode struct of a node.  */
 144 ir_mode      *get_irn_mode          (const ir_node *node);
 145 /** Gets the mode-enum modecode. */
 146 modecode      get_irn_modecode      (const ir_node *node);
 147 /** Gets the ident for a string representation of the mode .*/
 148 ident        *get_irn_modeident     (const ir_node *node);
 149 /** Gets the string representation of the mode .*/
 150 const char   *get_irn_modename      (const ir_node *node);
 151 /** Gets the opcode struct of the node. */
 152 ir_op        *get_irn_op            (const ir_node *node);
 153 /** Sets the opcode struct of the node. */
 154 void          set_irn_op            (ir_node *node, ir_op *op);
 155 /** Gets the opcode-enum of the node. */
 156 opcode        get_irn_opcode        (const ir_node *node);
 157 /** Get the string representation of the opcode. */
 158 const char   *get_irn_opname        (const ir_node *node);
 159 /** Get the ident for a string representation of the opcode. */
 160 ident        *get_irn_opident       (const ir_node *node);
 161 /** Gets the visited counter of a node. */
 162 unsigned long get_irn_visited (const ir_node *node);
 163 /** Sets the visited counter of a node. */
 164 void          set_irn_visited (ir_node *node, unsigned long visited);
 165 /** Sets visited to get_irg_visited(current_ir_graph). */
 166 void          mark_irn_visited (ir_node *node);
 167 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
 168 int           irn_not_visited  (const ir_node *node);
 169 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
 170 int           irn_visited      (const ir_node *node);
 171
 172 /**
 173  * Sets the link of a node.
 174  * Only allowed if the graph is NOT in phase_building.
 175  */
 176 void          set_irn_link     (ir_node *node, void *link);
 177
 178 /** Returns the link of a node.  */
 179 void         *get_irn_link     (const ir_node *node);
 180
 181 /** Returns the ir_graph this node belongs to. Only valid if irg
 182  *  is in state op_pin_state_pinned (irg is only stored in the block. */
 183 ir_graph     *get_irn_irg      (ir_node *node);
 184
 185 /** Outputs a unique number for this node if libFIRM is compiled for
 186    debugging, (configure with --enable-debug) else returns address
 187    of node cast to long. */
 188 long          get_irn_node_nr  (const ir_node *node);
 189
 190
 191 /**
 192  * irnode constructor.
 193  * Create a new irnode in irg, with an op, mode, arity and
 194  * some incoming irnodes.
 195  * This constructor is used in every specified irnode constructor.
 196  *
 197  * @param db    Debug info.
 198  * @param irg   IR-graph on with this new node should be constructed.
 199  * @param op    The opcode of the new node.
 200  * @param mode  The mode of the new node.
 201  * @param arity The arity of the new node, may be <0 if yet.
 202  * @param in    An array of arity predecessor nodes.
 203  */
 204 ir_node *
 205 new_ir_node (dbg_info *db,
 206          ir_graph *irg,
 207          ir_node *block,
 208          ir_op *op,
 209          ir_mode *mode,
 210          int arity,
 211          ir_node *in[]);
 212
 213 /*
 214  *
 215  * NAME access functions for node fields.
 216  *
 217  *  Not properly documented ;-)
 218  *
 219  */
 220
 221 /** This works for all except Block.  To express the difference to
 222  * access routines that work for all nodes we use infix "nodes" and do not
 223  * name this function get_irn_block. */
 224 #define get_nodes_block get_nodes_Block
 225 ir_node  *get_nodes_block (ir_node *node);
 226 #define set_nodes_block set_nodes_Block
 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 ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
 292 /* frees the memory. */
 293 void      remove_Block_cg_cfgpred_arr(ir_node * node);
 294
 295 /** Keep alive dedicated nodes.  These must be either
 296  *  PhiM or Block nodes. */
 297 int  get_End_n_keepalives(ir_node *end);
 298 ir_node *get_End_keepalive(ir_node *end, int pos);
 299 void add_End_keepalive (ir_node *end, ir_node *ka);
 300 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
 301 /* Some parts of the End node are allocated separately -- their memory
 302    is not recovered by dead_node_elimination if a End node is dead.
 303    free_End frees these data structures. */
 304 void free_End (ir_node *end);
 305
 306
 307 /* We distinguish three kinds of Cond nodes.  These can be distinguished
 308    by the mode of the selector operand and an internal flag of type cond_kind.
 309    First we distinguish binary Conds and switch Conds.
 310    A binary Cond has as selector a boolean value.  Proj(0) projects the control
 311    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
 312    is recognized by the boolean selector.
 313    The switch Cond has as selector an unsigned integer.  It produces as result
 314    an n+1 Tuple (cf0, ... , cfn) of control flows.
 315    We differ two flavours of this Cond.  The first, the dense Cond, passes
 316    control along output i if the selector value is i, 0 <= i <= n.  If the
 317    selector value is >n it passes control along output n.
 318    The second Cond flavor differes in the treatment of cases not specified in
 319    the source program.  It magically knows about the existence of Proj nodes.
 320    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
 321    exists.  Else it passes control along output n (even if this Proj does not
 322    exist.)  This Cond we call "fragmentary".  There is a special constructor
 323    new_defaultProj that automatically sets the flavor.
 324    The two switch flavors are distinguished by a flag of type cond_kind.
 325    Default flavor is "dense"
 326 */
 327 typedef enum {
 328   dense,        /**< Default. Missing Proj nodes are dead control flow. */
 329   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
 330            Proj nodes mean default control flow, i.e., Proj(n). */
 331 } cond_kind;
 332
 333 ir_node  *get_Cond_selector (ir_node *node);
 334 void      set_Cond_selector (ir_node *node, ir_node *selector);
 335 cond_kind get_Cond_kind (ir_node *node);
 336 void      set_Cond_kind (ir_node *node, cond_kind kind);
 337 long      get_Cond_defaultProj (ir_node *node);
 338
 339 /**
 340  * Projection numbers for conditions.
 341  */
 342 typedef enum {
 343   pn_Cond_false,    /**< Control flow if operand is "false". */
 344   pn_Cond_true,     /**< Control flow if operand is "true".  */
 345   pn_Cond_max       /**< number of projections from a Cond */
 346 } pn_Cond;  /* Projection numbers for Cond. */
 347
 348 ir_node  *get_Return_mem (ir_node *node);
 349 void      set_Return_mem (ir_node *node, ir_node *mem);
 350 ir_node **get_Return_res_arr (ir_node *node);
 351 int       get_Return_n_ress (ir_node *node);
 352 ir_node  *get_Return_res (ir_node *node, int pos);
 353 void      set_Return_res (ir_node *node, int pos, ir_node *res);
 354
 355 ir_node *get_Raise_mem (ir_node *node);
 356 void     set_Raise_mem (ir_node *node, ir_node *mem);
 357 ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
 358 void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
 359
 360 /**
 361  * Projection numbers for Raise.
 362  */
 363 typedef enum {
 364   pn_Raise_X,    /**< Execution result. */
 365   pn_Raise_M,    /**< Memory result.    */
 366   pn_Raise_max   /**< number of projections from a Raise */
 367 } pn_Raise;  /* Projection numbers for Raise. */
 368
 369 tarval  *get_Const_tarval (ir_node *node);
 370 void     set_Const_tarval (ir_node *node, tarval *con);
 371 /* The source language type.  Must be an atomic type.  Mode of type must
 372    be mode of node. For tarvals from entities type must be pointer to
 373    entity type. */
 374 type    *get_Const_type   (ir_node *node);
 375 void     set_Const_type   (ir_node *node, type *tp);
 376
 377 /**  This enum names the three different kinds of symbolic Constants
 378      represented by SymConst.  The content of the attribute type_or_id
 379      depends on this tag.  Use the proper access routine after testing
 380      this flag. */
 381
 382 typedef enum {
 383   symconst_type_tag,    /**< The SymConst is a type tag for the given type.
 384                            Type_or_id_p is type *. */
 385   symconst_size,        /**< The SymConst is the size of the given type.
 386                            Type_or_id_p is type *. */
 387   symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
 388                            by the linker.  The pointer is represented by a string.
 389                            Type_or_id_p is ident *. */
 390   symconst_addr_ent     /**< The SymConst is a symbolic pointer to be filled in
 391                            by the linker.  The pointer is represented by an entity.
 392                            Type_or_id_p is entity *. */
 393 } symconst_kind;
 394
 395 /** SymConst attributes
 396     This union contains the symbolic information represented by the node  */
 397 union symconst_symbol {
 398   type   *type_p;
 399   ident  *ident_p;
 400   entity *entity_p;
 401 };
 402
 403
 404 typedef union symconst_symbol symconst_symbol;
 405
 406
 407 /** Access the kind of the SymConst. */
 408 symconst_kind get_SymConst_kind (const ir_node *node);
 409 void          set_SymConst_kind (ir_node *node, symconst_kind num);
 410
 411 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
 412 type    *get_SymConst_type (ir_node *node);
 413 void     set_SymConst_type (ir_node *node, type *tp);
 414
 415 /** Only to access SymConst of kind addr_name.  Else assertion: */
 416 ident   *get_SymConst_name (ir_node *node);
 417 void     set_SymConst_name (ir_node *node, ident *name);
 418
 419 /** Only to access SymConst of kind addr_ent.  Else assertion: */
 420 entity  *get_SymConst_entity (ir_node *node);
 421 void     set_SymConst_entity (ir_node *node, entity *ent);
 422
 423 /** Sets both: type and ptrinfo.  Needed to treat the node independent of
 424    its semantics.  Does a memcpy for the memory sym points to. */
 425 /* write 'union': firmjni then does not create a method... */
 426 union symconst_symbol get_SymConst_symbol (ir_node *node);
 427 void                  set_SymConst_symbol (ir_node *node,
 428                                            union symconst_symbol sym);
 429
 430 ir_node *get_Sel_mem (ir_node *node);
 431 void     set_Sel_mem (ir_node *node, ir_node *mem);
 432 ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 433 void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 434 ir_node **get_Sel_index_arr (ir_node *node);
 435 int      get_Sel_n_indexs (ir_node *node);
 436 ir_node *get_Sel_index (ir_node *node, int pos);
 437 void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 438 entity  *get_Sel_entity (ir_node *node); /* entity to select */
 439 void     set_Sel_entity (ir_node *node, entity *ent);
 440
 441 /**
 442  * Projection numbers for result of Call node: use for Proj nodes!
 443  */
 444 typedef enum {
 445   pn_Call_M_regular = 0,  /**< The memory result. */
 446   pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
 447   pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
 448                  passed by value (for compound result types). */
 449   pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
 450   pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
 451                  an exception */
 452   pn_Call_max       = 5   /**< number of projections from a Call */
 453 } pn_Call;   /* Projection numbers for Call. */
 454
 455 ir_node *get_Call_mem (ir_node *node);
 456 void     set_Call_mem (ir_node *node, ir_node *mem);
 457 ir_node *get_Call_ptr (ir_node *node);
 458 void     set_Call_ptr (ir_node *node, ir_node *ptr);
 459 ir_node **get_Call_param_arr (ir_node *node);
 460 /** Gets the number of parameters of a call. */
 461 int      get_Call_n_params (ir_node *node);
 462 /** Gets the call parameter at position pos. */
 463 ir_node *get_Call_param (ir_node *node, int pos);
 464 /** Sets the call parameter at position pos. */
 465 void     set_Call_param (ir_node *node, int pos, ir_node *param);
 466 /** Gets the type of a call. */
 467 type    *get_Call_type (ir_node *node);
 468 /** Sets the type of a call. */
 469 void     set_Call_type (ir_node *node, type *tp);
 470 /** Gets the arity of a call. Identical to get_Call_n_params(). */
 471 int      get_Call_arity (ir_node *node);
 472
 473 /* Set, get and remove the callee-analysis.
 474    The array is only accessible if information is valid.
 475    It contains NULL for called methods that are not within
 476    the compilation unit. */
 477 int     Call_has_callees      (ir_node *node);
 478 int     get_Call_n_callees    (ir_node * node);
 479 entity *get_Call_callee       (ir_node * node, int pos);
 480 /* assumes current_ir_graph set properly! */
 481 void    set_Call_callee_arr   (ir_node * node, int n, entity ** arr);
 482 void    remove_Call_callee_arr(ir_node * node);
 483
 484 ir_node  *get_CallBegin_ptr  (ir_node *node);
 485 void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
 486 ir_node  *get_CallBegin_call (ir_node *node);
 487 void      set_CallBegin_call (ir_node *node, ir_node *call);
 488
 489 ir_node *get_FuncCall_ptr (ir_node *node);
 490 void     set_FuncCall_ptr (ir_node *node, ir_node *ptr);
 491 ir_node **get_FuncCall_param_arr (ir_node *node);
 492 /** Gets the number of parameters of a func call. */
 493 int      get_FuncCall_n_params (ir_node *node);
 494 /** Gets the func call parameter at position pos. */
 495 ir_node *get_FuncCall_param (ir_node *node, int pos);
 496 /** Sets the func call parameter at position pos. */
 497 void     set_FuncCall_param (ir_node *node, int pos, ir_node *param);
 498 /** Gets the type of a func call. */
 499 type    *get_FuncCall_type (ir_node *node);
 500 /** Sets the type of a func call. */
 501 void     set_FuncCall_type (ir_node *node, type *tp);
 502 /** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
 503 int      get_FuncCall_arity (ir_node *node);
 504
 505 /* Set, get and remove the callee-analysis.
 506    The array is only accessible if information is valid.
 507    It contains NULL for called methods that are not within
 508    the compilation unit. */
 509 int     FuncCall_has_callees      (ir_node *node);
 510 int     get_FuncCall_n_callees    (ir_node * node);
 511 entity *get_FuncCall_callee       (ir_node * node, int pos);
 512 /* assumes current_ir_graph set properly! */
 513 void    set_FuncCall_callee_arr   (ir_node * node, int n, entity ** arr);
 514 void    remove_FuncCall_callee_arr(ir_node * node);
 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 (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 (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 occured. */
 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 occured. */
 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 occured. */
 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 occured. */
 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  */
 644 typedef enum {
 645   pn_Cmp_False = 0,   /**< false */
 646   pn_Cmp_Eq,          /**< equal */
 647   pn_Cmp_Lt,          /**< less */
 648   pn_Cmp_Le,          /**< less or equal */
 649   pn_Cmp_Gt,          /**< greater */
 650   pn_Cmp_Ge,          /**< greater or equal */
 651   pn_Cmp_Lg,          /**< less or greater */
 652   pn_Cmp_Leg = 7,     /**< less, equal or greater = ordered */
 653   pn_Cmp_Uo,          /**< unordered */
 654   pn_Cmp_Ue,          /**< unordered or equal */
 655   pn_Cmp_Ul,          /**< unordered or less */
 656   pn_Cmp_Ule,         /**< unordered, less or equal */
 657   pn_Cmp_Ug,          /**< unordered or greater */
 658   pn_Cmp_Uge,         /**< unordered, greater or equal */
 659   pn_Cmp_Ne,          /**< unordered, less or greater = not equal */
 660   pn_Cmp_True = 15    /**< true */
 661   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
 662 } pn_Cmp;   /* Projection numbers for Cmp */
 663 /* #define not_mask pn_Cmp_Leg */
 664
 665 const char *get_pnc_string(int pnc);
 666 int         get_negated_pnc(int pnc);
 667 ir_node *get_Cmp_left (ir_node *node);
 668 void     set_Cmp_left (ir_node *node, ir_node *left);
 669 ir_node *get_Cmp_right (ir_node *node);
 670 void     set_Cmp_right (ir_node *node, ir_node *right);
 671
 672 ir_node *get_Shl_left (ir_node *node);
 673 void     set_Shl_left (ir_node *node, ir_node *left);
 674 ir_node *get_Shl_right (ir_node *node);
 675 void     set_Shl_right (ir_node *node, ir_node *right);
 676
 677 ir_node *get_Shr_left (ir_node *node);
 678 void     set_Shr_left (ir_node *node, ir_node *left);
 679 ir_node *get_Shr_right (ir_node *node);
 680 void     set_Shr_right (ir_node *node, ir_node *right);
 681
 682 ir_node *get_Shrs_left (ir_node *node);
 683 void     set_Shrs_left (ir_node *node, ir_node *left);
 684 ir_node *get_Shrs_right (ir_node *node);
 685 void     set_Shrs_right (ir_node *node, ir_node *right);
 686
 687 ir_node *get_Rot_left (ir_node *node);
 688 void     set_Rot_left (ir_node *node, ir_node *left);
 689 ir_node *get_Rot_right (ir_node *node);
 690 void     set_Rot_right (ir_node *node, ir_node *right);
 691
 692 ir_node *get_Conv_op (ir_node *node);
 693 void     set_Conv_op (ir_node *node, ir_node *op);
 694
 695 /* Does Cast need a mem operator?
 696  * Cast should only depend on the type, not on the state of an
 697  * entity.  But:  we initialze various fields after Alloc, that
 698  * are accessed in the cast.  This required some precaution, to
 699  * get the right memory into the Loads generated from the cast.
 700  */
 701 ir_node *get_Cast_op (ir_node *node);
 702 void     set_Cast_op (ir_node *node, ir_node *op);
 703 type    *get_Cast_type (ir_node *node);
 704 void     set_Cast_type (ir_node *node, type *to_tp);
 705
 706 /** Returns true if n is Phi or Filter in interprocedural_view.
 707    Returns false if irg in phase building and the Phi has zero
 708    predecessors: it's a Phi0. */
 709 int       is_Phi (ir_node *n);
 710 /** Returns true  if irg in phase building and the Phi has zero
 711    predecessors: it's a Phi0. */
 712 int       is_Phi0 (ir_node *n);
 713 /* These routines also work for Filter nodes in interprocedural view. */
 714 ir_node **get_Phi_preds_arr (ir_node *node);
 715 int       get_Phi_n_preds (ir_node *node);
 716 ir_node  *get_Phi_pred (ir_node *node, int pos);
 717 void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 718
 719 ir_node  *get_Filter_pred(ir_node *node);
 720 void      set_Filter_pred(ir_node *node, ir_node *pred);
 721 long      get_Filter_proj(ir_node *node);
 722 void      set_Filter_proj(ir_node *node, long proj);
 723 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 724  * @@@ Maybe better:  arity is zero if no cg preds. */
 725 void     set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
 726 void     set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
 727 int      get_Filter_n_cg_preds(ir_node *node);
 728 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
 729
 730 /** Return true if parameter is a memory operation.
 731  *
 732  *  A memory operation is an operation that directly changes the
 733  *  memory.  I.e., a Load or a Store operation.
 734  */
 735 int is_memop(ir_node *node);
 736 ir_node *get_memop_mem (ir_node *node);
 737 void     set_memop_mem (ir_node *node, ir_node *mem);
 738 ir_node *get_memop_ptr (ir_node *node);
 739 void     set_memop_ptr (ir_node *node, ir_node *ptr);
 740
 741 /**
 742  * Projection numbers for Load: use for Proj nodes!
 743  */
 744 typedef enum {
 745   pn_Load_M,         /**< Memory result.    */
 746   pn_Load_X_except,  /**< Execution result if exception occured. */
 747   pn_Load_res,       /**< Result of load operation. */
 748   pn_Load_max        /**< number of projections from a Load */
 749 } pn_Load;  /* Projection numbers for Load. */
 750
 751 ir_node       *get_Load_mem (ir_node *node);
 752 void           set_Load_mem (ir_node *node, ir_node *mem);
 753 ir_node       *get_Load_ptr (ir_node *node);
 754 void           set_Load_ptr (ir_node *node, ir_node *ptr);
 755 ent_volatility get_Load_volatility (ir_node *node);
 756 void           set_Load_volatility (ir_node *node, ent_volatility volatility);
 757 ir_mode       *get_Load_mode (ir_node *node);
 758 void           set_Load_mode (ir_node *node, ir_mode *mode);
 759
 760 /**
 761  * Projection numbers for Store: use for Proj nodes!
 762  */
 763 typedef enum {
 764   pn_Store_M,         /**< Memory result.    */
 765   pn_Store_X_except,  /**< Execution result if exception occured. */
 766   pn_Store_max        /**< number of projections from a Store */
 767 } pn_Store;  /* Projection numbers for Store. */
 768
 769 ir_node       *get_Store_mem (ir_node *node);
 770 void           set_Store_mem (ir_node *node, ir_node *mem);
 771 ir_node       *get_Store_ptr (ir_node *node);
 772 void           set_Store_ptr (ir_node *node, ir_node *ptr);
 773 ir_node       *get_Store_value (ir_node *node);
 774 void           set_Store_value (ir_node *node, ir_node *value);
 775 ent_volatility get_Store_volatility (ir_node *node);
 776 void           set_Store_volatility (ir_node *node, ent_volatility volatility);
 777
 778 /**
 779  * Projection numbers for Alloc: use for Proj nodes!
 780  */
 781 typedef enum {
 782   pn_Alloc_M,          /**< Memory result. */
 783   pn_Alloc_X_except,  /**< Execution result if exception occured. */
 784   pn_Alloc_res,       /**< Result of allocation. */
 785   pn_Alloc_max        /**< number of projections from an Alloc */
 786 } pn_Alloc;  /* Projection numbers for Alloc. */
 787
 788 ir_node *get_Alloc_mem (ir_node *node);
 789 void     set_Alloc_mem (ir_node *node, ir_node *mem);
 790 ir_node *get_Alloc_size (ir_node *node);
 791 void     set_Alloc_size (ir_node *node, ir_node *size);
 792 type    *get_Alloc_type (ir_node *node);
 793 void     set_Alloc_type (ir_node *node, type *tp);
 794
 795 /** The allocation place. */
 796 typedef enum {
 797   stack_alloc,          /**< Alloc allocates the object on the stack. */
 798   heap_alloc            /**< Alloc allocates the object on the heap. */
 799 } where_alloc;
 800
 801 where_alloc  get_Alloc_where (ir_node *node);
 802 void         set_Alloc_where (ir_node *node, where_alloc where);
 803
 804 ir_node *get_Free_mem (ir_node *node);
 805 void     set_Free_mem (ir_node *node, ir_node *mem);
 806 ir_node *get_Free_ptr (ir_node *node);
 807 void     set_Free_ptr (ir_node *node, ir_node *ptr);
 808 ir_node *get_Free_size (ir_node *node);
 809 void     set_Free_size (ir_node *node, ir_node *size);
 810 type    *get_Free_type (ir_node *node);
 811 void     set_Free_type (ir_node *node, type *tp);
 812
 813 ir_node **get_Sync_preds_arr (ir_node *node);
 814 int       get_Sync_n_preds (ir_node *node);
 815 ir_node  *get_Sync_pred (ir_node *node, int pos);
 816 void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 817
 818 ir_node  *get_Proj_pred (ir_node *node);
 819 void      set_Proj_pred (ir_node *node, ir_node *pred);
 820 long      get_Proj_proj (ir_node *node);
 821 void      set_Proj_proj (ir_node *node, long proj);
 822
 823 ir_node **get_Tuple_preds_arr (ir_node *node);
 824 int       get_Tuple_n_preds (ir_node *node);
 825 ir_node  *get_Tuple_pred (ir_node *node, int pos);
 826 void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 827
 828 ir_node  *get_Id_pred (ir_node *node);
 829 void      set_Id_pred (ir_node *node, ir_node *pred);
 830
 831 /** Confirm has a single result and returns 'value' unchanged.
 832  *  The node expresses a restriction on 'value':
 833  *  'value' 'cmp' 'bound' == true.                                 */
 834 ir_node *get_Confirm_value (ir_node *node);
 835 void     set_Confirm_value (ir_node *node, ir_node *value);
 836 ir_node *get_Confirm_bound (ir_node *node);
 837 void     set_Confirm_bound (ir_node *node, ir_node *bound);
 838 pn_Cmp   get_Confirm_cmp   (ir_node *node);
 839 void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
 840
 841 /*
 842  *
 843  * NAME Auxiliary routines
 844  *
 845  *  Not properly documented ;-)
 846  *
 847  */
 848
 849 /** returns operand of node if node is a Proj. */
 850 ir_node *skip_Proj (ir_node *node);
 851 /** returns operand of node if node is a Id */
 852 ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
 853 /* returns corresponding operand of Tuple if node is a Proj from
 854    a Tuple. */
 855 ir_node *skip_Tuple (ir_node *node);
 856 /** returns operand of node if node is a Cast */
 857 ir_node *skip_Cast  (ir_node *node);
 858 /** returns true if node is a Bad node. */
 859 int      is_Bad    (ir_node *node);
 860 /** returns true if the node is not a Block */
 861 int      is_no_Block (ir_node *node);
 862 /** returns true if the node is a Block */
 863 int      is_Block (ir_node *node);
 864 /** returns true if node is a Unknown node. */
 865 int      is_Unknown (ir_node *node);
 866 /** returns true if node is a Proj node or a Filter node in
 867  * intraprocedural view */
 868 int      is_Proj (const ir_node *node);
 869 /** Returns true if the operation manipulates control flow:
 870    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
 871 int is_cfop(ir_node *node);
 872
 873 /** Returns true if the operation manipulates interprocedural control flow:
 874     CallBegin, EndReg, EndExcept */
 875 int is_ip_cfop(ir_node *node);
 876 /** Returns true if the operation can change the control flow because
 877     of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
 878     Bad. */
 879 int is_fragile_op(ir_node *node);
 880 /** Returns the memory operand of fragile operations. */
 881 ir_node *get_fragile_op_mem(ir_node *node);
 882
 883 /*-----------------------------------------------------------------*/
 884 /** Debug aides                                                   **/
 885 /*-----------------------------------------------------------------*/
 886
 887
 888 /** Debug print the node.
 889  *
 890  *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
 891  *  is set.  Else does nothing. */
 892 void    dump_irn(ir_node *n);
 893
 894 #include "ident.h"
 895
 896 #ifdef __GNUC__
 897 /* GNU C has the __FUNCTION__ extension */
 898 #define __MYFUNC__ __FUNCTION__
 899 #else
 900 /* use Filename instead */
 901 #define __MYFUNC__ __FILE__
 902 #endif
 903
 904 /* !!!!!!!!! @@@
 905    Don't format with "\", firmjni gets problems */
 906 /** Output location */
 907 #define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
 908 /** Output the firm kind of the node */
 909 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
 910 /** Output information about a node */
 911 #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))
 912 /** Output information about a node and its block */
 913 #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)))
 914 /** Output information about a type */
 915 #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))
 916 /** Output information about an entity */
 917 #define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
 918 /** Output information about an entity and its type */
 919 #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))
 920 /** Output information about an entity and its owner */
 921 #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))
 922 /** Output information about a graph */
 923 #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))))
 924 /** Output information about an ident */
 925 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
 926 /** Output information about a mode */
 927 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
 928 /** Output information about a loop */
 929 #define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
 930 /** Output information about a tarVal */
 931 #define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
 932
 933 /*@}*/ /* end of ir_node group definition */
 934
 935
 936 #ifdef __cplusplus
 937 }
 938 #endif
 939
 940 # endif /* _IRNODE_H_ */