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