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

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