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