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; /* Projection numbers for Start. */
 246
 247
 248 /** Test whether arbitrary node is frame pointer.
 249  *
 250  * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 251  * from Start.  If so returns frame type, else Null. */
 252 type *is_frame_pointer(ir_node *n);
 253
 254 /** Test whether arbitrary node is globals pointer.
 255  *
 256  * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
 257  * from Start.  If so returns global type, else Null. */
 258 type *is_globals_pointer(ir_node *n);
 259
 260 /** Test whether arbitrary node is value arg base.
 261  *
 262  * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
 263  * from Start.   If so returns 1, else 0. */
 264 int   is_value_arg_pointer(ir_node *n);
 265
 266
 267 /* @@@ no more supported  */
 268 ir_node **get_Block_cfgpred_arr (ir_node *node);
 269 int       get_Block_n_cfgpreds (ir_node *node);
 270 ir_node  *get_Block_cfgpred (ir_node *node, int pos);
 271 void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 272 bool      get_Block_matured (ir_node *node);
 273 void      set_Block_matured (ir_node *node, bool matured);
 274 unsigned long get_Block_block_visited (ir_node *node);
 275 void      set_Block_block_visited (ir_node *node, unsigned long visit);
 276 /* For this current_ir_graph must be set. */
 277 void      mark_Block_block_visited(ir_node *node);
 278 int       Block_not_block_visited(ir_node *node);
 279
 280 /* Set and remove interprocedural predecessors. If the interprocedural
 281  * predecessors are removed, the node has the same predecessors in
 282  * both views.
 283  * @@@ Maybe better:  arity is zero if no cg preds. */
 284 void      set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
 285 void      set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
 286 /* @@@ not supported */
 287 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
 288 /* Returns the number of interprocedural predecessors.  0 if none. */
 289 int       get_Block_cg_n_cfgpreds(ir_node * node);
 290 ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
 291 /* frees the memory. */
 292 void      remove_Block_cg_cfgpred_arr(ir_node * node);
 293
 294 int  get_End_n_keepalives(ir_node *end);
 295 ir_node *get_End_keepalive(ir_node *end, int pos);
 296 void add_End_keepalive (ir_node *end, ir_node *ka);
 297 void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
 298 /* Some parts of the End node are allocated separately -- their memory
 299    is not recovered by dead_node_elimination if a End node is dead.
 300    free_End frees these data structures. */
 301 void free_End (ir_node *end);
 302
 303
 304 /* We distinguish three kinds of Cond nodes.  These can be distinguished
 305    by the mode of the selector operand and an internal flag of type cond_kind.
 306    First we distinguish binary Conds and switch Conds.
 307    A binary Cond has as selector a boolean value.  Proj(0) projects the control
 308    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
 309    is recognized by the boolean selector.
 310    The switch Cond has as selector an unsigned integer.  It produces as result
 311    an n+1 Tuple (cf0, ... , cfn) of control flows.
 312    We differ two flavours of this Cond.  The first, the dense Cond, passes
 313    control along output i if the selector value is i, 0 <= i <= n.  If the
 314    selector value is >n it passes control along output n.
 315    The second Cond flavor differes in the treatment of cases not specified in
 316    the source program.  It magically knows about the existence of Proj nodes.
 317    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
 318    exists.  Else it passes control along output n (even if this Proj does not
 319    exist.)  This Cond we call "fragmentary".  There is a special constructor
 320    new_defaultProj that automatically sets the flavor.
 321    The two switch flavors are distinguished by a flag of type cond_kind.
 322    Default flavor is "dense"
 323 */
 324 typedef enum {
 325   dense,        /**< Default. Missing Proj nodes are dead control flow. */
 326   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
 327            Proj nodes mean default control flow, i.e., Proj(n). */
 328 } cond_kind;
 329
 330 ir_node  *get_Cond_selector (ir_node *node);
 331 void      set_Cond_selector (ir_node *node, ir_node *selector);
 332 cond_kind get_Cond_kind (ir_node *node);
 333 void      set_Cond_kind (ir_node *node, cond_kind kind);
 334 long      get_Cond_defaultProj (ir_node *node);
 335
 336 /**
 337  * Projection numbers for conditions.
 338  */
 339 typedef enum {
 340   pn_Cond_false,    /**< Control flow if operand is "false". */
 341   pn_Cond_true      /**< Control flow if operand is "true".  */
 342 } pn_Cond;  /* Projection numbers for Cond. */
 343
 344 ir_node  *get_Return_mem (ir_node *node);
 345 void      set_Return_mem (ir_node *node, ir_node *mem);
 346 ir_node **get_Return_res_arr (ir_node *node);
 347 int       get_Return_n_ress (ir_node *node);
 348 ir_node  *get_Return_res (ir_node *node, int pos);
 349 void      set_Return_res (ir_node *node, int pos, ir_node *res);
 350
 351 ir_node *get_Raise_mem (ir_node *node);
 352 void     set_Raise_mem (ir_node *node, ir_node *mem);
 353 ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
 354 void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
 355
 356 /**
 357  * Projection numbers for Raise.
 358  */
 359 typedef enum {
 360   pn_Raise_X,    /**< Execution result. */
 361   pn_Raise_M     /**< Memory result.    */
 362 } pn_Raise;  /* Projection numbers for Raise. */
 363
 364 tarval  *get_Const_tarval (ir_node *node);
 365 void     set_Const_tarval (ir_node *node, tarval *con);
 366 /* The source language type.  Must be an atomic type.  Mode of type must
 367    be mode of node. For tarvals from entities type must be pointer to
 368    entity type. */
 369 type    *get_Const_type   (ir_node *node);
 370 void     set_Const_type   (ir_node *node, type *tp);
 371
 372 /**  This enum names the three different kinds of symbolic Constants
 373      represented by SymConst.  The content of the attribute type_or_id
 374      depends on this tag.  Use the proper access routine after testing
 375      this flag. */
 376
 377 typedef enum {
 378   symconst_type_tag,    /**< The SymConst is a type tag for the given type.
 379                            Type_or_id_p is type *. */
 380   symconst_size,        /**< The SymConst is the size of the given type.
 381                            Type_or_id_p is type *. */
 382   symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
 383                            by the linker.  The pointer is represented by a string.
 384                            Type_or_id_p is ident *. */
 385   symconst_addr_ent     /**< The SymConst is a symbolic pointer to be filled in
 386                            by the linker.  The pointer is represented by an entity.
 387                            Type_or_id_p is entity *. */
 388 } symconst_kind;
 389
 390 /** SymConst attributes
 391     This union contains the symbolic information represented by the node  */
 392 union symconst_symbol {
 393   type   *type_p;
 394   ident  *ident_p;
 395   entity *entity_p;
 396 };
 397
 398
 399 typedef union symconst_symbol symconst_symbol;
 400
 401
 402 /** Access the kind of the SymConst. */
 403 symconst_kind get_SymConst_kind (const ir_node *node);
 404 void          set_SymConst_kind (ir_node *node, symconst_kind num);
 405
 406 /** Only to access SymConst of kind type_tag or size.  Else assertion: */
 407 type    *get_SymConst_type (ir_node *node);
 408 void     set_SymConst_type (ir_node *node, type *tp);
 409
 410 /** Only to access SymConst of kind addr_name.  Else assertion: */
 411 ident   *get_SymConst_name (ir_node *node);
 412 void     set_SymConst_name (ir_node *node, ident *name);
 413
 414 /** Only to access SymConst of kind addr_ent.  Else assertion: */
 415 entity  *get_SymConst_entity (ir_node *node);
 416 void     set_SymConst_entity (ir_node *node, entity *ent);
 417
 418 /** Sets both: type and ptrinfo.  Needed to treat the node independent of
 419    its semantics.  Does a memcpy for the memory sym points to. */
 420 /* write 'union': firmjni then does not create a method... */
 421 union symconst_symbol get_SymConst_symbol (ir_node *node);
 422 void                  set_SymConst_symbol (ir_node *node,
 423                                            union symconst_symbol sym);
 424
 425 ir_node *get_Sel_mem (ir_node *node);
 426 void     set_Sel_mem (ir_node *node, ir_node *mem);
 427 ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 428 void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 429 ir_node **get_Sel_index_arr (ir_node *node);
 430 int      get_Sel_n_indexs (ir_node *node);
 431 ir_node *get_Sel_index (ir_node *node, int pos);
 432 void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 433 entity  *get_Sel_entity (ir_node *node); /* entity to select */
 434 void     set_Sel_entity (ir_node *node, entity *ent);
 435
 436 /**
 437  * Projection numbers for result of Call node: use for Proj nodes!
 438  */
 439 typedef enum {
 440   pn_Call_M_regular = 0,  /**< The memory result. */
 441   pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
 442   pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
 443                  passed by value (for compound result types). */
 444   pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
 445   pn_Call_M_except  = 3,  /**< The memory result in case the called method terminated with
 446                  an exception */
 447   pn_Call_max       = 5   /**< number of prejections from a Call */
 448 } pn_Call;   /* Projection numbers for Call. */
 449
 450 ir_node *get_Call_mem (ir_node *node);
 451 void     set_Call_mem (ir_node *node, ir_node *mem);
 452 ir_node *get_Call_ptr (ir_node *node);
 453 void     set_Call_ptr (ir_node *node, ir_node *ptr);
 454 ir_node **get_Call_param_arr (ir_node *node);
 455 /** Gets the number of parameters of a call. */
 456 int      get_Call_n_params (ir_node *node);
 457 /** Gets the call parameter at position pos. */
 458 ir_node *get_Call_param (ir_node *node, int pos);
 459 /** Sets the call parameter at position pos. */
 460 void     set_Call_param (ir_node *node, int pos, ir_node *param);
 461 /** Gets the type of a call. */
 462 type    *get_Call_type (ir_node *node);
 463 /** Sets the type of a call. */
 464 void     set_Call_type (ir_node *node, type *tp);
 465 /** Gets the arity of a call. Identical to get_Call_n_params(). */
 466 int      get_Call_arity (ir_node *node);
 467
 468 /* Set, get and remove the callee-analysis.
 469    The array is only accessible if information is valid.
 470    It contains NULL for called methods that are not within
 471    the compilation unit. */
 472 int     Call_has_callees      (ir_node *node);
 473 int     get_Call_n_callees    (ir_node * node);
 474 entity *get_Call_callee       (ir_node * node, int pos);
 475 /* assumes current_ir_graph set properly! */
 476 void    set_Call_callee_arr   (ir_node * node, int n, entity ** arr);
 477 void    remove_Call_callee_arr(ir_node * node);
 478
 479 ir_node  *get_CallBegin_ptr  (ir_node *node);
 480 void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
 481 ir_node  *get_CallBegin_call (ir_node *node);
 482 void      set_CallBegin_call (ir_node *node, ir_node *call);
 483
 484 ir_node *get_FuncCall_ptr (ir_node *node);
 485 void     set_FuncCall_ptr (ir_node *node, ir_node *ptr);
 486 ir_node **get_FuncCall_param_arr (ir_node *node);
 487 /** Gets the number of parameters of a func call. */
 488 int      get_FuncCall_n_params (ir_node *node);
 489 /** Gets the func call parameter at position pos. */
 490 ir_node *get_FuncCall_param (ir_node *node, int pos);
 491 /** Sets the func call parameter at position pos. */
 492 void     set_FuncCall_param (ir_node *node, int pos, ir_node *param);
 493 /** Gets the type of a func call. */
 494 type    *get_FuncCall_type (ir_node *node);
 495 /** Sets the type of a func call. */
 496 void     set_FuncCall_type (ir_node *node, type *tp);
 497 /** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
 498 int      get_FuncCall_arity (ir_node *node);
 499
 500 /* Set, get and remove the callee-analysis.
 501    The array is only accessible if information is valid.
 502    It contains NULL for called methods that are not within
 503    the compilation unit. */
 504 int     FuncCall_has_callees      (ir_node *node);
 505 int     get_FuncCall_n_callees    (ir_node * node);
 506 entity *get_FuncCall_callee       (ir_node * node, int pos);
 507 /* assumes current_ir_graph set properly! */
 508 void    set_FuncCall_callee_arr   (ir_node * node, int n, entity ** arr);
 509 void    remove_FuncCall_callee_arr(ir_node * node);
 510
 511 /* For unary and binary arithmetic operations the access to the
 512    operands can be factored out.  Left is the first, right the
 513    second arithmetic value  as listed in tech report 1999-44.
 514    unops are: Minus, Abs, Not, Conv, Cast
 515    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 516    Shr, Shrs, Rot, Cmp */
 517 int      is_unop (ir_node *node);
 518 ir_node *get_unop_op (ir_node *node);
 519 void     set_unop_op (ir_node *node, ir_node *op);
 520 int      is_binop (ir_node *node);
 521 ir_node *get_binop_left (ir_node *node);
 522 void     set_binop_left (ir_node *node, ir_node *left);
 523 ir_node *get_binop_right (ir_node *node);
 524 void     set_binop_right (ir_node *node, ir_node *right);
 525
 526 ir_node *get_Add_left (ir_node *node);
 527 void     set_Add_left (ir_node *node, ir_node *left);
 528 ir_node *get_Add_right (ir_node *node);
 529 void     set_Add_right (ir_node *node, ir_node *right);
 530
 531 ir_node *get_Sub_left (ir_node *node);
 532 void     set_Sub_left (ir_node *node, ir_node *left);
 533 ir_node *get_Sub_right (ir_node *node);
 534 void     set_Sub_right (ir_node *node, ir_node *right);
 535
 536 ir_node *get_Minus_op (ir_node *node);
 537 void     set_Minus_op (ir_node *node, ir_node *op);
 538
 539 ir_node *get_Mul_left (ir_node *node);
 540 void     set_Mul_left (ir_node *node, ir_node *left);
 541 ir_node *get_Mul_right (ir_node *node);
 542 void     set_Mul_right (ir_node *node, ir_node *right);
 543
 544 ir_node *get_Quot_left (ir_node *node);
 545 void     set_Quot_left (ir_node *node, ir_node *left);
 546 ir_node *get_Quot_right (ir_node *node);
 547 void     set_Quot_right (ir_node *node, ir_node *right);
 548 ir_node *get_Quot_mem (ir_node *node);
 549 void     set_Quot_mem (ir_node *node, ir_node *mem);
 550
 551 /**
 552  * Projection numbers for Quot: use for Proj nodes!
 553  */
 554 typedef enum {
 555   pn_Quot_M,           /**< Memory result.    */
 556   pn_Quot_X_except,    /**< Execution result if exception occured. */
 557   pn_Quot_res          /**< Result of computation. */
 558 } pn_Quot;  /* Projection numbers for Quot. */
 559
 560 ir_node *get_DivMod_left (ir_node *node);
 561 void     set_DivMod_left (ir_node *node, ir_node *left);
 562 ir_node *get_DivMod_right (ir_node *node);
 563 void     set_DivMod_right (ir_node *node, ir_node *right);
 564 ir_node *get_DivMod_mem (ir_node *node);
 565 void     set_DivMod_mem (ir_node *node, ir_node *mem);
 566
 567 /**
 568  * Projection numbers for DivMod: use for Proj nodes!
 569  */
 570 typedef enum {
 571   pn_DivMod_M,           /**< Memory result.    */
 572   pn_DivMod_X_except,    /**< Execution result if exception occured. */
 573   pn_DivMod_res_div,     /**< Result of computation a / b. */
 574   pn_DivMod_res_mod      /**< Result of computation a % b. */
 575 } pn_DivMod;  /* Projection numbers for DivMod. */
 576
 577 ir_node *get_Div_left (ir_node *node);
 578 void     set_Div_left (ir_node *node, ir_node *left);
 579 ir_node *get_Div_right (ir_node *node);
 580 void     set_Div_right (ir_node *node, ir_node *right);
 581 ir_node *get_Div_mem (ir_node *node);
 582 void     set_Div_mem (ir_node *node, ir_node *mem);
 583
 584 /**
 585  * Projection numbers for Div: use for Proj nodes!
 586  */
 587 typedef enum {
 588   pn_Div_M,           /**< Memory result.    */
 589   pn_Div_X_except,    /**< Execution result if exception occured. */
 590   pn_Div_res          /**< Result of computation. */
 591 } pn_Div;  /* Projection numbers for Div. */
 592
 593 ir_node *get_Mod_left (ir_node *node);
 594 void     set_Mod_left (ir_node *node, ir_node *left);
 595 ir_node *get_Mod_right (ir_node *node);
 596 void     set_Mod_right (ir_node *node, ir_node *right);
 597 ir_node *get_Mod_mem (ir_node *node);
 598 void     set_Mod_mem (ir_node *node, ir_node *mem);
 599
 600 /**
 601  * Projection numbers for Mod: use for Proj nodes!
 602  */
 603 typedef enum {
 604   pn_Mod_M,           /**< Memory result.    */
 605   pn_Mod_X_except,    /**< Execution result if exception occured. */
 606   pn_Mod_res          /**< Result of computation. */
 607 } pn_Mod;  /* Projection numbers for Mod. */
 608
 609 ir_node *get_Abs_op (ir_node *node);
 610 void     set_Abs_op (ir_node *node, ir_node *op);
 611
 612 ir_node *get_And_left (ir_node *node);
 613 void     set_And_left (ir_node *node, ir_node *left);
 614 ir_node *get_And_right (ir_node *node);
 615 void     set_And_right (ir_node *node, ir_node *right);
 616
 617 ir_node *get_Or_left (ir_node *node);
 618 void     set_Or_left (ir_node *node, ir_node *left);
 619 ir_node *get_Or_right (ir_node *node);
 620 void     set_Or_right (ir_node *node, ir_node *right);
 621
 622 ir_node *get_Eor_left (ir_node *node);
 623 void     set_Eor_left (ir_node *node, ir_node *left);
 624 ir_node *get_Eor_right (ir_node *node);
 625 void     set_Eor_right (ir_node *node, ir_node *right);
 626
 627 ir_node *get_Not_op (ir_node *node);
 628 void     set_Not_op (ir_node *node, ir_node *op);
 629
 630 /**
 631  * Projection numbers for Cmp are defined several times.
 632  * The bit patterns are used for various tests, so don't change.
 633  * The "unordered" values are possible results of comparing
 634  * floating point numbers.
 635  */
 636 typedef enum {
 637   pn_Cmp_False = 0,   /**< false */
 638   pn_Cmp_Eq,          /**< equal */
 639   pn_Cmp_Lt,          /**< less */
 640   pn_Cmp_Le,          /**< less or equal */
 641   pn_Cmp_Gt,          /**< greater */
 642   pn_Cmp_Ge,          /**< greater or equal */
 643   pn_Cmp_Lg,          /**< less or greater */
 644   pn_Cmp_Leg = 7,     /**< less, equal or greater = ordered */
 645   pn_Cmp_Uo,          /**< unordered */
 646   pn_Cmp_Ue,          /**< unordered or equal */
 647   pn_Cmp_Ul,          /**< unordered or less */
 648   pn_Cmp_Ule,         /**< unordered, less or equal */
 649   pn_Cmp_Ug,          /**< unordered or greater */
 650   pn_Cmp_Uge,         /**< unordered, greater or equal */
 651   pn_Cmp_Ne,          /**< unordered, less or greater = not equal */
 652   pn_Cmp_True = 15    /**< true */
 653   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
 654 } pn_Cmp;   /* Projection numbers for Cmp */
 655 /* #define not_mask pn_Cmp_Leg */
 656
 657 const char *get_pnc_string(int pnc);
 658 int         get_negated_pnc(int pnc);
 659 ir_node *get_Cmp_left (ir_node *node);
 660 void     set_Cmp_left (ir_node *node, ir_node *left);
 661 ir_node *get_Cmp_right (ir_node *node);
 662 void     set_Cmp_right (ir_node *node, ir_node *right);
 663
 664 ir_node *get_Shl_left (ir_node *node);
 665 void     set_Shl_left (ir_node *node, ir_node *left);
 666 ir_node *get_Shl_right (ir_node *node);
 667 void     set_Shl_right (ir_node *node, ir_node *right);
 668
 669 ir_node *get_Shr_left (ir_node *node);
 670 void     set_Shr_left (ir_node *node, ir_node *left);
 671 ir_node *get_Shr_right (ir_node *node);
 672 void     set_Shr_right (ir_node *node, ir_node *right);
 673
 674 ir_node *get_Shrs_left (ir_node *node);
 675 void     set_Shrs_left (ir_node *node, ir_node *left);
 676 ir_node *get_Shrs_right (ir_node *node);
 677 void     set_Shrs_right (ir_node *node, ir_node *right);
 678
 679 ir_node *get_Rot_left (ir_node *node);
 680 void     set_Rot_left (ir_node *node, ir_node *left);
 681 ir_node *get_Rot_right (ir_node *node);
 682 void     set_Rot_right (ir_node *node, ir_node *right);
 683
 684 ir_node *get_Conv_op (ir_node *node);
 685 void     set_Conv_op (ir_node *node, ir_node *op);
 686
 687 /* Does Cast need a mem operator?
 688  * Cast should only depend on the type, not on the state of an
 689  * entity.  But:  we initialze various fields after Alloc, that
 690  * are accessed in the cast.  This required some precaution, to
 691  * get the right memory into the Loads generated from the cast.
 692  */
 693 ir_node *get_Cast_op (ir_node *node);
 694 void     set_Cast_op (ir_node *node, ir_node *op);
 695 type    *get_Cast_type (ir_node *node);
 696 void     set_Cast_type (ir_node *node, type *to_tp);
 697
 698 /** Returns true if n is Phi or Filter in interprocedural_view.
 699    Returns false if irg in phase building and the Phi has zero
 700    predecessors: it's a Phi0. */
 701 int       is_Phi (ir_node *n);
 702 /** Returns true  if irg in phase building and the Phi has zero
 703    predecessors: it's a Phi0. */
 704 int       is_Phi0 (ir_node *n);
 705 /* These routines also work for Filter nodes in interprocedural view. */
 706 ir_node **get_Phi_preds_arr (ir_node *node);
 707 int       get_Phi_n_preds (ir_node *node);
 708 ir_node  *get_Phi_pred (ir_node *node, int pos);
 709 void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 710
 711 ir_node  *get_Filter_pred(ir_node *node);
 712 void      set_Filter_pred(ir_node *node, ir_node *pred);
 713 long      get_Filter_proj(ir_node *node);
 714 void      set_Filter_proj(ir_node *node, long proj);
 715 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 716  * @@@ Maybe better:  arity is zero if no cg preds. */
 717 void     set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
 718 void     set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
 719 int      get_Filter_n_cg_preds(ir_node *node);
 720 ir_node *get_Filter_cg_pred(ir_node *node, int pos);
 721
 722 /**
 723  * Projection numbers for Load: use for Proj nodes!
 724  */
 725 typedef enum {
 726   pn_Load_M,         /**< Memory result.    */
 727   pn_Load_X_except,  /**< Execution result if exception occured. */
 728   pn_Load_res        /**< Result of load operation. */
 729 } pn_Load;  /* Projection numbers for Load. */
 730
 731 ir_node *get_Load_mem (ir_node *node);
 732 void     set_Load_mem (ir_node *node, ir_node *mem);
 733 ir_node *get_Load_ptr (ir_node *node);
 734 void     set_Load_ptr (ir_node *node, ir_node *ptr);
 735
 736 /**
 737  * Projection numbers for Store: use for Proj nodes!
 738  */
 739 typedef enum {
 740   pn_Store_M,         /**< Memory result.    */
 741   pn_Store_X_except   /**< Execution result if exception occured. */
 742 } pn_Store;  /* Projection numbers for Store. */
 743
 744 ir_node *get_Store_mem (ir_node *node);
 745 void     set_Store_mem (ir_node *node, ir_node *mem);
 746 ir_node *get_Store_ptr (ir_node *node);
 747 void     set_Store_ptr (ir_node *node, ir_node *ptr);
 748 ir_node *get_Store_value (ir_node *node);
 749 void     set_Store_value (ir_node *node, ir_node *value);
 750
 751 /**
 752  * Projection numbers for Alloc: use for Proj nodes!
 753  */
 754 typedef enum {
 755   pn_Alloc_M,    /**< Memory result. */
 756   pn_Alloc_X_except,    /**< Execution result if exception occured. */
 757   pn_Alloc_res   /**< Result of allocation. */
 758 } pn_Alloc;  /* Projection numbers for Alloc. */
 759
 760 ir_node *get_Alloc_mem (ir_node *node);
 761 void     set_Alloc_mem (ir_node *node, ir_node *mem);
 762 ir_node *get_Alloc_size (ir_node *node);
 763 void     set_Alloc_size (ir_node *node, ir_node *size);
 764 type    *get_Alloc_type (ir_node *node);
 765 void     set_Alloc_type (ir_node *node, type *tp);
 766
 767 /** The allocation place. */
 768 typedef enum {
 769   stack_alloc,          /**< Alloc allocates the object on the stack. */
 770   heap_alloc            /**< Alloc allocates the object on the heap. */
 771 } where_alloc;
 772
 773 where_alloc  get_Alloc_where (ir_node *node);
 774 void         set_Alloc_where (ir_node *node, where_alloc where);
 775
 776 ir_node *get_Free_mem (ir_node *node);
 777 void     set_Free_mem (ir_node *node, ir_node *mem);
 778 ir_node *get_Free_ptr (ir_node *node);
 779 void     set_Free_ptr (ir_node *node, ir_node *ptr);
 780 ir_node *get_Free_size (ir_node *node);
 781 void     set_Free_size (ir_node *node, ir_node *size);
 782 type    *get_Free_type (ir_node *node);
 783 void     set_Free_type (ir_node *node, type *tp);
 784
 785 ir_node **get_Sync_preds_arr (ir_node *node);
 786 int       get_Sync_n_preds (ir_node *node);
 787 ir_node  *get_Sync_pred (ir_node *node, int pos);
 788 void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 789
 790 ir_node  *get_Proj_pred (ir_node *node);
 791 void      set_Proj_pred (ir_node *node, ir_node *pred);
 792 long      get_Proj_proj (ir_node *node);
 793 void      set_Proj_proj (ir_node *node, long proj);
 794
 795 ir_node **get_Tuple_preds_arr (ir_node *node);
 796 int       get_Tuple_n_preds (ir_node *node);
 797 ir_node  *get_Tuple_pred (ir_node *node, int pos);
 798 void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 799
 800 ir_node  *get_Id_pred (ir_node *node);
 801 void      set_Id_pred (ir_node *node, ir_node *pred);
 802
 803 /** Confirm has a single result and returns 'value' unchanged.
 804  *  The node expresses a restriction on 'value':
 805  *  'value' 'cmp' 'bound' == true.                                 */
 806 ir_node *get_Confirm_value (ir_node *node);
 807 void     set_Confirm_value (ir_node *node, ir_node *value);
 808 ir_node *get_Confirm_bound (ir_node *node);
 809 void     set_Confirm_bound (ir_node *node, ir_node *bound);
 810 pn_Cmp   get_Confirm_cmp   (ir_node *node);
 811 void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
 812
 813 /*
 814  *
 815  * NAME Auxiliary routines
 816  *
 817  *  Not properly documented ;-)
 818  *
 819  */
 820
 821 /** returns operand of node if node is a Proj. */
 822 ir_node *skip_Proj (ir_node *node);
 823 /** returns operand of node if node is a Id */
 824 ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
 825 /* returns corresponding operand of Tuple if node is a Proj from
 826    a Tuple. */
 827 ir_node *skip_Tuple (ir_node *node);
 828 /** returns operand of node if node is a Cast */
 829 ir_node *skip_Cast  (ir_node *node);
 830 /** returns true if node is a Bad node. */
 831 int      is_Bad    (ir_node *node);
 832 /** returns true if the node is not a Block */
 833 int      is_no_Block (ir_node *node);
 834 /** returns true if the node is a Block */
 835 int      is_Block (ir_node *node);
 836 /** returns true if node is a Unknown node. */
 837 int      is_Unknown (ir_node *node);
 838 /** returns true if node is a Proj node or a Filter node in
 839  * intraprocedural view */
 840 int      is_Proj (const ir_node *node);
 841 /** Returns true if the operation manipulates control flow:
 842    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
 843 int is_cfop(ir_node *node);
 844
 845 /** Returns true if the operation manipulates interprocedural control flow:
 846     CallBegin, EndReg, EndExcept */
 847 int is_ip_cfop(ir_node *node);
 848 /** Returns true if the operation can change the control flow because
 849     of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
 850     Bad. */
 851 int is_fragile_op(ir_node *node);
 852 /** Returns the memory operand of fragile operations. */
 853 ir_node *get_fragile_op_mem(ir_node *node);
 854
 855 /*-----------------------------------------------------------------*/
 856 /** Debug aides                                                   **/
 857 /*-----------------------------------------------------------------*/
 858
 859
 860 /** Debug print the node.
 861  *
 862  *  Writes the node, all its attributes and the predecessors to stdout if DEBUG_libfirm
 863  *  is set.  Else does nothing. */
 864 void    dump_irn(ir_node *n);
 865
 866 #include "ident.h"
 867
 868 #ifdef __GNUC__
 869 /* GNU C has the __FUNCTION__ extension */
 870 #define __MYFUNC__ __FUNCTION__
 871 #else
 872 /* use Filename instead */
 873 #define __MYFUNC__ __FILE__
 874 #endif
 875
 876 /* !!!!!!!!! @@@
 877    Don't format with "\", firmjni gets problems */
 878 /** Output location */
 879 #define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
 880 /** Output the firm kind of the node */
 881 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
 882 /** Output information about a node */
 883 #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))
 884 /** Output information about a node and its block */
 885 #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)))
 886 /** Output information about a type */
 887 #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))
 888 /** Output information about an entity */
 889 #define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
 890 /** Output information about an entity and its type */
 891 #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))
 892 /** Output information about an entity and its owner */
 893 #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))
 894 /** Output information about a graph */
 895 #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))))
 896 /** Output information about an ident */
 897 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (void *)(X))
 898 /** Output information about a mode */
 899 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
 900 /** Output information about a loop */
 901 #define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
 902 /** Output information about a tarVal */
 903 #define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
 904
 905 /*@}*/ /* end of ir_node group definition */
 906
 907
 908 #ifdef __cplusplus
 909 }
 910 #endif
 911
 912 # endif /* _IRNODE_H_ */