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

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