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