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