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