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

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