nsz Git - libfirm/blob - ir/ir/irnode.h

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