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

   1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe      3 2002/02/28 13:33:52
   2  * All rights reserved.
   3  */
   4
   5 /* $Id$ */
   6
   7 # ifndef _IRNODE_H_
   8 # define _IRNODE_H_
   9
  10 /** Projection numbers of compare: use for Proj nodes! */
  11 typedef enum {
  12   False = 0,            /**< false */
  13   Eq,                   /**< equal */
  14   Lt,                   /**< less */
  15   Le,                   /**< less or equal */
  16   Gt,                   /**< greater */
  17   Ge,                   /**< greater or equal */
  18   Lg,                   /**< less or greater */
  19   Leg = 7,              /**< less, equal or greater = ordered */
  20   Uo,                   /**< unordered */
  21   Ue,                   /**< unordered or equal */
  22   Ul,                   /**< unordered or less */
  23   Ule,                  /**< unordered, less or equal */
  24   Ug,                   /**< unordered or greater */
  25   Uge,                  /**< unordered, greater or equal */
  26   Ne,                   /**< unordered, less or greater = not equal */
  27   True = 15             /**< true */
  28   /* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for jni interface */
  29 } pnc_number;
  30 #define not_mask Leg
  31
  32 # include "tv.h"
  33 # include "irgraph.h"
  34 # include "entity.h"
  35 # include "firm_common.h"
  36 # include "irop.h"
  37 # include "irmode.h"
  38 # include "type.h"
  39 # include "dbginfo.h"
  40 # include "exc.h"
  41
  42 /**
  43  * @file irnode.h
  44  *
  45  * @author Martin Trapp, Christian Schaefer
  46  *
  47  * Declarations of an ir node.
  48  */
  49
  50 /**
  51  * @defgroup ir_node Declarations of an ir node.
  52  *
  53  * The type definiton of ir_node is also in irgraph.h to resolve
  54  *  recursion between irnode.h and irgraph.h
  55  *
  56  * ir_node - a datatype representing a Firm node
  57  *
  58  *  The common fields are:
  59  *
  60  *  - firm_kind - A firm_kind tag containing k_type.  This is useful
  61  *                for dynamically checking whether a node is a ir_node.
  62  *  - arity     - The number of predecessors in the Firm graph.
  63  *  - in        - A list with the predecessors in the Firm graph.  There are
  64  *                routines to access individual elements and to obtain the
  65  *                array.  The method returning the array should not be used.
  66  *  - mode      - The mode of the node.  There are routines to get the mode
  67  *                but also to access the mode's fields directly.
  68  *  - opcode    - The opcode of the node. There are routines to get the opcode
  69  *                but also to access the opcode's fields directly.
  70  *  - node_nr   - A unique number for the node.  Available only if debugging
  71  *                is turned on.
  72  * @{
  73  */
  74
  75 #ifndef _IR_NODE_TYPEDEF_
  76 #define _IR_NODE_TYPEDEF_
  77 typedef struct ir_node ir_node;
  78 #endif
  79
  80 /**
  81  *   you can work on the graph without considering the different types
  82  *   of nodes, it's just a big graph.
  83  */
  84
  85 /**
  86  *   Checks whether a pointer points to a ir node.
  87  *
  88  *   @param thing     an arbitrary pointer
  89  *
  90  *   @return
  91  *       true if the thing is a ir mode, else false
  92  */
  93 int
  94 is_ir_node (void *thing);
  95
  96 /** returns the number of predecessors without the block predecessor: */
  97 int                  get_irn_arity         (const ir_node *node);
  98
  99 /** Replaces the old in array by a new one that will contain the ins given in
 100    the parameters.  Conserves the block predecessor.  It copies the array passed.
 101    This function is necessary to ajust in arrays of blocks, calls and phis.
 102    Assumes that current_ir_graph is set to the graph containing "node".
 103    "in" must contain all predecessors except the block that are required for
 104    the nodes opcode. */
 105 INLINE void          set_irn_in            (ir_node *node, int arity,
 106                                             ir_node *in[]);
 107 /* to iterate through the predecessors without touching the array. No
 108    order of predecessors guaranteed.
 109    To iterate over the operands iterate from 0 to i < get_irn_arity(),
 110    to iterate including the Block predecessor iterate from i = -1 to
 111    i < get_irn_arity. */
 112 /* Access predecessor n */
 113 /* get_irn_n removes Id predecessors. */
 114 INLINE ir_node      *get_irn_n             (ir_node *node, int n);
 115 INLINE void          set_irn_n             (ir_node *node, int n, ir_node *in);
 116 /** Sets the mode struct of node */
 117 INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
 118 /** Gets the mode struct. */
 119 INLINE ir_mode      *get_irn_mode          (const ir_node *node);
 120 /** Gets the mode-enum modecode. */
 121 INLINE modecode      get_irn_modecode      (const ir_node *node);
 122 /** Gets the ident for a string representation of the mode .*/
 123 INLINE ident        *get_irn_modeident     (const ir_node *node);
 124 /** Gets the opcode struct of the node */
 125 INLINE ir_op        *get_irn_op            (const ir_node *node);
 126 /** Sets the opcode struct of the node. */
 127 INLINE void          set_irn_op            (ir_node *node, ir_op *op);
 128 /** Gets the opcode-enum of the node. */
 129 INLINE opcode        get_irn_opcode        (const ir_node *node);
 130 /** Get the string representation of the opcode. */
 131 INLINE const char   *get_irn_opname        (const ir_node *node);
 132 /** Get the ident for a string representation of the opcode. */
 133 INLINE ident        *get_irn_opident       (const ir_node *node);
 134 INLINE unsigned long get_irn_visited (const ir_node *node);
 135 INLINE void          set_irn_visited (ir_node *node, unsigned long visited);
 136 /** Sets visited to get_irg_visited(current_ir_graph). */
 137 INLINE void          mark_irn_visited (ir_node *node);
 138 /** Returns 1 if visited < get_irg_visited(current_ir_graph).  */
 139 INLINE int           irn_not_visited  (const ir_node *node);
 140 /** Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
 141 INLINE int           irn_visited      (const ir_node *node);
 142 INLINE void          set_irn_link          (ir_node *node, void *link);
 143 INLINE void         *get_irn_link          (const ir_node *node);
 144
 145 /** Outputs a unique number for this node if libfirm is compiled for
 146    debugging, (configure with --enable-debug) else returns 0. */
 147 INLINE long get_irn_node_nr(const ir_node *node);
 148
 149 /** Returns the ir_graph this node belongs to. Only valid for
 150  * CallBegin, EndReg and EndExcept */
 151 INLINE ir_graph *get_irn_irg(ir_node *node);
 152
 153 /**
 154  * irnode constructor.
 155  * Create a new irnode in irg, with an op, mode, arity and
 156  * some incoming irnodes.
 157  * If arity is negative, a node with a dynamic array is created.
 158  */
 159 INLINE ir_node *
 160 new_ir_node (dbg_info *db,
 161              ir_graph *irg,
 162              ir_node *block,
 163              ir_op *op,
 164              ir_mode *mode,
 165              int arity,
 166              ir_node *in[]);
 167
 168 /*
 169  *
 170  * NAME access functions for node fields.
 171  *
 172  *  Not properly documented ;-)
 173  *
 174  */
 175
 176 /* this works for all except Block */
 177 INLINE ir_node  *get_nodes_Block (ir_node *node);
 178 INLINE void      set_nodes_Block (ir_node *node, ir_node *block);
 179
 180 /** Projection numbers for result of Start node: use for Proj nodes! */
 181 typedef enum {
 182   pns_initial_exec,     /**< Projection on an executable, the initial control
 183                            flow. */
 184   pns_global_store,     /**< Projection on the global store */
 185   pns_frame_base,       /**< Projection on the frame base */
 186   pns_globals,          /**< Projection on the pointer to the data segment
 187                            containing _all_ global entities. */
 188   pns_args,             /**< Projection on all arguments */
 189   pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
 190                              type of this method. */
 191 } pns_number;
 192
 193 /* @@@ no more supported  */
 194 INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
 195 int              get_Block_n_cfgpreds (ir_node *node);
 196 INLINE ir_node  *get_Block_cfgpred (ir_node *node, int pos);
 197 INLINE void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
 198 INLINE bool      get_Block_matured (ir_node *node);
 199 INLINE void      set_Block_matured (ir_node *node, bool matured);
 200 INLINE unsigned long get_Block_block_visited (ir_node *node);
 201 INLINE void      set_Block_block_visited (ir_node *node, unsigned long visit);
 202 /* For this current_ir_graph must be set. */
 203 INLINE void      mark_Block_block_visited(ir_node *node);
 204 INLINE int       Block_not_block_visited(ir_node *node);
 205
 206 /* Set and remove interprocedural predecessors. If the interprocedural
 207  * predecessors are removed, the node has the same predecessors in
 208  * both views.
 209  * @@@ Maybe better:  arity is zero if no cg preds. */
 210 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
 211 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
 212 /* @@@ not supported */
 213 ir_node ** get_Block_cg_cfgpred_arr(ir_node * node);
 214 /* Returns the number of interproc predecessors.  0 if none. */
 215 int get_Block_cg_n_cfgpreds(ir_node * node);
 216 ir_node * get_Block_cg_cfgpred(ir_node * node, int pos);
 217 /* frees the memory. */
 218 void remove_Block_cg_cfgpred_arr(ir_node * node);
 219
 220 INLINE int  get_End_n_keepalives(ir_node *end);
 221 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
 222 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
 223 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
 224 /* Some parts of the End node are allocated seperately -- their memory
 225    is not recovered by dead_node_elimination if a End node is dead.
 226    free_End frees these data structures. */
 227 INLINE void free_End (ir_node *end);
 228
 229 ir_graph *get_EndReg_irg (const ir_node *end);
 230 ir_graph *get_EndExcept_irg  (const ir_node *end);
 231
 232 /* We distinguish three kinds of Cond nodes.  These can be distinguished
 233    by the mode of the selector operand and an internal flag of type cond_kind.
 234    First we distinguish binary Conds and switch Conds.
 235    A binary Cond has as selector a boolean value.  Proj(0) projects the control
 236    flow for case "False", Proj(1) the control flow for "True".  A binary Cond
 237    is recognized by the boolean selector.
 238    The switch Cond has as selector an unsigned integer.  It produces as result
 239    an n+1 Tuple (cf0, ... , cfn) of control flows.
 240    We differ two flavours of this Cond.  The first, the dense Cond, passes
 241    control along output i if the selector value is i, 0 <= i <= n.  If the
 242    selector value is >n it passes control along output n.
 243    The second Cond flavor differes in the treatment of cases not specified in
 244    the source program.  It magically knows about the existence of Proj nodes.
 245    It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
 246    exists.  Else it passes control along output n (even if this Proj does not
 247    exist.)  This Cond we call "fragmentary".  There is a special constructor
 248    new_defaultProj that automatically sets the flavor.
 249    The two switch flavors are distinguished by a flag of type cond_kind.
 250    Default flavor is "dense"
 251 */
 252 typedef enum {
 253   dense,        /**< Default. Missing Proj nodes are dead control flow. */
 254   fragmentary   /**< Special. No control flow optimizations allowed.  Missing
 255                    Proj nodes mean default control flow, i.e., Proj(n). */
 256 } cond_kind;
 257
 258 INLINE ir_node  *get_Cond_selector (ir_node *node);
 259 INLINE void      set_Cond_selector (ir_node *node, ir_node *selector);
 260 INLINE cond_kind get_Cond_kind (ir_node *node);
 261 INLINE void      set_Cond_kind (ir_node *node, cond_kind kind);
 262
 263 INLINE ir_node  *get_Return_mem (ir_node *node);
 264 INLINE void      set_Return_mem (ir_node *node, ir_node *mem);
 265 INLINE ir_node **get_Return_res_arr (ir_node *node);
 266 INLINE int       get_Return_n_ress (ir_node *node);
 267 INLINE ir_node  *get_Return_res (ir_node *node, int pos);
 268 INLINE void      set_Return_res (ir_node *node, int pos, ir_node *res);
 269
 270 INLINE ir_node *get_Raise_mem (ir_node *node);
 271 INLINE void     set_Raise_mem (ir_node *node, ir_node *mem);
 272 INLINE ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
 273 INLINE void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
 274
 275 INLINE tarval  *get_Const_tarval (ir_node *node);
 276 INLINE void     set_Const_tarval (ir_node *node, tarval *con);
 277
 278 /**  This enum names the three different kinds of symbolic Constants
 279      represented by SymConst.  The content of the attribute type_or_id
 280      depends on this tag.  Use the proper access routine after testing
 281      this flag. */
 282 typedef enum {
 283   type_tag,          /**< The SymConst is a type tag for the given type.
 284                         Type_or_id_p is type *. */
 285   size,              /**< The SymConst is the size of the given type.
 286                         Type_or_id_p is type *. */
 287   linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
 288                         by the linker. Type_or_id_p is ident *. */
 289 } symconst_kind;
 290 typedef union type_or_id * type_or_id_p;
 291 INLINE symconst_kind get_SymConst_kind (const ir_node *node);
 292 INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
 293 /* Only to access SymConst of kind type_tag or size.  Else assertion: */
 294 INLINE type    *get_SymConst_type (ir_node *node);
 295 INLINE void     set_SymConst_type (ir_node *node, type *tp);
 296 /* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
 297 INLINE ident   *get_SymConst_ptrinfo (ir_node *node);
 298 INLINE void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
 299 /* Sets both: type and ptrinfo.  Needed to treat the node independent of
 300    its semantics.  Does a memcpy for the memory tori points to. */
 301 INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
 302 INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
 303
 304 INLINE ir_node *get_Sel_mem (ir_node *node);
 305 INLINE void     set_Sel_mem (ir_node *node, ir_node *mem);
 306 INLINE ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
 307 INLINE void     set_Sel_ptr (ir_node *node, ir_node *ptr);
 308 INLINE ir_node **get_Sel_index_arr (ir_node *node);
 309 INLINE int      get_Sel_n_indexs (ir_node *node);
 310 INLINE ir_node *get_Sel_index (ir_node *node, int pos);
 311 INLINE void     set_Sel_index (ir_node *node, int pos, ir_node *index);
 312 INLINE entity  *get_Sel_entity (ir_node *node); /* entity to select */
 313 INLINE void     set_Sel_entity (ir_node *node, entity *ent);
 314
 315 /* @@@ ajacs specific node -- not supported */
 316 type           *get_InstOf_ent   (ir_node *node);
 317 void            set_InstOf_ent   (ir_node *node, type *ent);
 318 ir_node        *get_InstOf_obj   (ir_node *node);
 319 void            set_InstOf_obj   (ir_node *node, ir_node *obj);
 320 ir_node        *get_InstOf_store (ir_node *node);
 321 void            set_InstOf_store (ir_node *node, ir_node *obj);
 322
 323 INLINE ir_node *get_Call_mem (ir_node *node);
 324 INLINE void     set_Call_mem (ir_node *node, ir_node *mem);
 325 INLINE ir_node *get_Call_ptr (ir_node *node);
 326 INLINE void     set_Call_ptr (ir_node *node, ir_node *ptr);
 327 INLINE ir_node **get_Call_param_arr (ir_node *node);
 328 /** Gets the number of parameters of a call. */
 329 INLINE int      get_Call_n_params (ir_node *node);
 330 /** Gets the call parameter at position pos. */
 331 INLINE ir_node *get_Call_param (ir_node *node, int pos);
 332 /** Sets the call parameter at position pos. */
 333 INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
 334 /** Gets the type of a call. */
 335 INLINE type    *get_Call_type (ir_node *node);
 336 /** Sets the type of a call. */
 337 INLINE void     set_Call_type (ir_node *node, type *tp);
 338 /** Gets the arity of a call. Identical to get_Call_n_params(). */
 339 INLINE int      get_Call_arity (ir_node *node);
 340
 341 /* Set, get and remove the callee-analysis. */
 342 int get_Call_n_callees(ir_node * node);
 343 entity * get_Call_callee(ir_node * node, int pos);
 344 void set_Call_callee_arr(ir_node * node, int n, entity ** arr);
 345 void remove_Call_callee_arr(ir_node * node);
 346
 347 ir_node * get_CallBegin_ptr (ir_node *node);
 348 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
 349 ir_graph *get_CallBegin_irg (ir_node *node);
 350 ir_node *get_CallBegin_call (ir_node *node);
 351 void set_CallBegin_call (ir_node *node, ir_node *call);
 352
 353 /* For unary and binary arithmetic operations the access to the
 354    operands can be factored out.  Left is the first, right the
 355    second arithmetic value  as listed in tech report 1999-44.
 356    unops are: Minus, Abs, Not, Conv
 357    binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
 358    Shr, Shrs, Rot, Cmp */
 359 INLINE int      is_unop (ir_node *node);
 360 INLINE ir_node *get_unop_op (ir_node *node);
 361 INLINE void     set_unop_op (ir_node *node, ir_node *op);
 362 INLINE int      is_binop (ir_node *node);
 363 INLINE ir_node *get_binop_left (ir_node *node);
 364 INLINE void     set_binop_left (ir_node *node, ir_node *left);
 365 INLINE ir_node *get_binop_right (ir_node *node);
 366 INLINE void     set_binop_right (ir_node *node, ir_node *right);
 367
 368 INLINE ir_node *get_Add_left (ir_node *node);
 369 INLINE void     set_Add_left (ir_node *node, ir_node *left);
 370 INLINE ir_node *get_Add_right (ir_node *node);
 371 INLINE void     set_Add_right (ir_node *node, ir_node *right);
 372
 373 INLINE ir_node *get_Sub_left (ir_node *node);
 374 INLINE void     set_Sub_left (ir_node *node, ir_node *left);
 375 INLINE ir_node *get_Sub_right (ir_node *node);
 376 INLINE void     set_Sub_right (ir_node *node, ir_node *right);
 377
 378 INLINE ir_node *get_Minus_op (ir_node *node);
 379 INLINE void     set_Minus_op (ir_node *node, ir_node *op);
 380
 381 INLINE ir_node *get_Mul_left (ir_node *node);
 382 INLINE void     set_Mul_left (ir_node *node, ir_node *left);
 383 INLINE ir_node *get_Mul_right (ir_node *node);
 384 INLINE void     set_Mul_right (ir_node *node, ir_node *right);
 385
 386 INLINE ir_node *get_Quot_left (ir_node *node);
 387 INLINE void     set_Quot_left (ir_node *node, ir_node *left);
 388 INLINE ir_node *get_Quot_right (ir_node *node);
 389 INLINE void     set_Quot_right (ir_node *node, ir_node *right);
 390 INLINE ir_node *get_Quot_mem (ir_node *node);
 391 INLINE void     set_Quot_mem (ir_node *node, ir_node *mem);
 392
 393 INLINE ir_node *get_DivMod_left (ir_node *node);
 394 INLINE void     set_DivMod_left (ir_node *node, ir_node *left);
 395 INLINE ir_node *get_DivMod_right (ir_node *node);
 396 INLINE void     set_DivMod_right (ir_node *node, ir_node *right);
 397 INLINE ir_node *get_DivMod_mem (ir_node *node);
 398 INLINE void     set_DivMod_mem (ir_node *node, ir_node *mem);
 399
 400 INLINE ir_node *get_Div_left (ir_node *node);
 401 INLINE void     set_Div_left (ir_node *node, ir_node *left);
 402 INLINE ir_node *get_Div_right (ir_node *node);
 403 INLINE void     set_Div_right (ir_node *node, ir_node *right);
 404 INLINE ir_node *get_Div_mem (ir_node *node);
 405 INLINE void     set_Div_mem (ir_node *node, ir_node *mem);
 406
 407 INLINE ir_node *get_Mod_left (ir_node *node);
 408 INLINE void     set_Mod_left (ir_node *node, ir_node *left);
 409 INLINE ir_node *get_Mod_right (ir_node *node);
 410 INLINE void     set_Mod_right (ir_node *node, ir_node *right);
 411 INLINE ir_node *get_Mod_mem (ir_node *node);
 412 INLINE void     set_Mod_mem (ir_node *node, ir_node *mem);
 413
 414 INLINE ir_node *get_Abs_op (ir_node *node);
 415 INLINE void     set_Abs_op (ir_node *node, ir_node *op);
 416
 417 INLINE ir_node *get_And_left (ir_node *node);
 418 INLINE void     set_And_left (ir_node *node, ir_node *left);
 419 INLINE ir_node *get_And_right (ir_node *node);
 420 INLINE void     set_And_right (ir_node *node, ir_node *right);
 421
 422 INLINE ir_node *get_Or_left (ir_node *node);
 423 INLINE void     set_Or_left (ir_node *node, ir_node *left);
 424 INLINE ir_node *get_Or_right (ir_node *node);
 425 INLINE void     set_Or_right (ir_node *node, ir_node *right);
 426
 427 INLINE ir_node *get_Eor_left (ir_node *node);
 428 INLINE void     set_Eor_left (ir_node *node, ir_node *left);
 429 INLINE ir_node *get_Eor_right (ir_node *node);
 430 INLINE void     set_Eor_right (ir_node *node, ir_node *right);
 431
 432 INLINE ir_node *get_Not_op (ir_node *node);
 433 INLINE void     set_Not_op (ir_node *node, ir_node *op);
 434
 435 INLINE const char *get_pnc_string(int pnc);
 436
 437 INLINE int   get_negated_pnc(int pnc);
 438 INLINE ir_node *get_Cmp_left (ir_node *node);
 439 INLINE void     set_Cmp_left (ir_node *node, ir_node *left);
 440 INLINE ir_node *get_Cmp_right (ir_node *node);
 441 INLINE void     set_Cmp_right (ir_node *node, ir_node *right);
 442
 443 INLINE ir_node *get_Shl_left (ir_node *node);
 444 INLINE void     set_Shl_left (ir_node *node, ir_node *left);
 445 INLINE ir_node *get_Shl_right (ir_node *node);
 446 INLINE void     set_Shl_right (ir_node *node, ir_node *right);
 447
 448 INLINE ir_node *get_Shr_left (ir_node *node);
 449 INLINE void     set_Shr_left (ir_node *node, ir_node *left);
 450 INLINE ir_node *get_Shr_right (ir_node *node);
 451 INLINE void     set_Shr_right (ir_node *node, ir_node *right);
 452
 453 INLINE ir_node *get_Shrs_left (ir_node *node);
 454 INLINE void     set_Shrs_left (ir_node *node, ir_node *left);
 455 INLINE ir_node *get_Shrs_right (ir_node *node);
 456 INLINE void     set_Shrs_right (ir_node *node, ir_node *right);
 457
 458 INLINE ir_node *get_Rot_left (ir_node *node);
 459 INLINE void     set_Rot_left (ir_node *node, ir_node *left);
 460 INLINE ir_node *get_Rot_right (ir_node *node);
 461 INLINE void     set_Rot_right (ir_node *node, ir_node *right);
 462
 463 INLINE ir_node *get_Conv_op (ir_node *node);
 464 INLINE void     set_Conv_op (ir_node *node, ir_node *op);
 465
 466 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
 467 INLINE int       get_Phi_n_preds (ir_node *node);
 468 INLINE ir_node  *get_Phi_pred (ir_node *node, int pos);
 469 INLINE void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
 470
 471 INLINE ir_node  *get_Filter_pred(ir_node *node);
 472 INLINE void      set_Filter_pred(ir_node *node, ir_node *pred);
 473 INLINE long      get_Filter_proj(ir_node *node);
 474 INLINE void      set_Filter_proj(ir_node *node, long proj);
 475 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 476  * @@@ Maybe better:  arity is zero if no cg preds. */
 477 void             set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
 478 void             set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
 479 int              get_Filter_n_cg_preds(ir_node *node);
 480 ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
 481
 482 INLINE ir_node *get_Load_mem (ir_node *node);
 483 INLINE void     set_Load_mem (ir_node *node, ir_node *mem);
 484 INLINE ir_node *get_Load_ptr (ir_node *node);
 485 INLINE void     set_Load_ptr (ir_node *node, ir_node *ptr);
 486
 487 INLINE ir_node *get_Store_mem (ir_node *node);
 488 INLINE void     set_Store_mem (ir_node *node, ir_node *mem);
 489 INLINE ir_node *get_Store_ptr (ir_node *node);
 490 INLINE void     set_Store_ptr (ir_node *node, ir_node *ptr);
 491 INLINE ir_node *get_Store_value (ir_node *node);
 492 INLINE void     set_Store_value (ir_node *node, ir_node *value);
 493
 494 INLINE ir_node *get_Alloc_mem (ir_node *node);
 495 INLINE void     set_Alloc_mem (ir_node *node, ir_node *mem);
 496 INLINE ir_node *get_Alloc_size (ir_node *node);
 497 INLINE void     set_Alloc_size (ir_node *node, ir_node *size);
 498 INLINE type    *get_Alloc_type (ir_node *node);
 499 INLINE void     set_Alloc_type (ir_node *node, type *tp);
 500
 501 /** allocation place. */
 502 typedef enum {
 503   stack_alloc,          /**< Alloc allocates the object on the stack. */
 504   heap_alloc            /**< Alloc allocates the object on the heap. */
 505 } where_alloc;
 506
 507 INLINE where_alloc  get_Alloc_where (ir_node *node);
 508 INLINE void         set_Alloc_where (ir_node *node, where_alloc where);
 509
 510 INLINE ir_node *get_Free_mem (ir_node *node);
 511 INLINE void     set_Free_mem (ir_node *node, ir_node *mem);
 512 INLINE ir_node *get_Free_ptr (ir_node *node);
 513 INLINE void     set_Free_ptr (ir_node *node, ir_node *ptr);
 514 INLINE ir_node *get_Free_size (ir_node *node);
 515 INLINE void     set_Free_size (ir_node *node, ir_node *size);
 516 INLINE type    *get_Free_type (ir_node *node);
 517 INLINE void     set_Free_type (ir_node *node, type *tp);
 518
 519 INLINE ir_node **get_Sync_preds_arr (ir_node *node);
 520 INLINE int       get_Sync_n_preds (ir_node *node);
 521 INLINE ir_node  *get_Sync_pred (ir_node *node, int pos);
 522 INLINE void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
 523
 524 INLINE ir_node  *get_Proj_pred (ir_node *node);
 525 INLINE void      set_Proj_pred (ir_node *node, ir_node *pred);
 526 INLINE long      get_Proj_proj (ir_node *node);
 527 INLINE void      set_Proj_proj (ir_node *node, long proj);
 528
 529 INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
 530 INLINE int       get_Tuple_n_preds (ir_node *node);
 531 INLINE ir_node  *get_Tuple_pred (ir_node *node, int pos);
 532 INLINE void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
 533
 534 INLINE ir_node  *get_Id_pred (ir_node *node);
 535 INLINE void      set_Id_pred (ir_node *node, ir_node *pred);
 536
 537
 538 /*
 539  *
 540  * NAME Auxiliary routines
 541  *
 542  *  Not properly documented ;-)
 543  *
 544  */
 545
 546 /** returns operand of node if node is a Proj. */
 547 INLINE ir_node *skip_Proj (ir_node *node);
 548 /** returns operand of node if node is a Id */
 549 INLINE ir_node *skip_nop  (ir_node *node);
 550 INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
 551 /* returns corresponding operand of Tuple if node is a Proj from
 552    a Tuple. */
 553 INLINE ir_node *skip_Tuple (ir_node *node);
 554 /** returns true if node is a Bad node. */
 555 INLINE int      is_Bad    (ir_node *node);
 556 /** returns true if the node is not a Block */
 557 INLINE int      is_no_Block (ir_node *node);
 558 /** returns true if the node is a Block */
 559 INLINE int      is_Block (ir_node *node);
 560 /** returns true if node is a Proj node or a Filter node in
 561  * intraprocedural view */
 562 INLINE int      is_Proj (const ir_node *node);
 563 /** Returns true if the operation manipulates control flow:
 564    Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
 565 int is_cfop(ir_node *node);
 566
 567 /** Returns true if the operation manipulates interprocedural control flow:
 568    CallBegin, EndReg, EndExcept */
 569 int is_ip_cfop(ir_node *node);
 570 /** Returns true if the operation can change the control flow because
 571    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
 572    Bad. */
 573 ir_graph *get_ip_cfop_irg(ir_node *n);
 574
 575 int is_fragile_op(ir_node *node);
 576 /** Returns the memory operand of fragile operations. */
 577 ir_node *get_fragile_op_mem(ir_node *node);
 578
 579 #include "ident.h"
 580
 581 #ifdef __GNUC__
 582 /* GNU C has the __FUNCTION__ extension */
 583 #define __MYFUNC__ __FUNCTION__
 584 #else
 585 /* use Filename instead */
 586 #define __MYFUNC__ __FILE__
 587 #endif
 588
 589 /* !!!!!!!!! @@@
 590    Don't format with "\", firmjni gets problems */
 591 /** Output location */
 592 #define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
 593 /** Output the firm kind of the node */
 594 #define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (X));
 595 /** Output information about a node */
 596 #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), (X))
 597 /** Output information about a node and its block */
 598 #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)))
 599 /** Output information about a type */
 600 #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), (X))
 601 /** Output information about an entity */
 602 #define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
 603 /** Output information about an entity and its owner */
 604 #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), (X))
 605 /** Output information about a graph */
 606 #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), (X))
 607 /** Output information about an ident */
 608 #define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (X))
 609 /** Output information about a mode */
 610 #define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (X))
 611 /** Output information about a loop */
 612 #define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (X))
 613 /** Output information about a tarVal */
 614 #define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (X));
 615
 616 /*@}*/ /* end of ir_node group definition */
 617
 618
 619 # endif /* _IRNODE_H_ */