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