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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irnode_t.h
   4  * Purpose:     Representation of an intermediate operation -- private header.
   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 /**
  14  * @file irnode_t.h
  15  *
  16  * Declarations of an ir node.
  17  *
  18  * @author Martin Trapp, Christian Schaefer
  19  */
  20
  21 # ifndef _IRNODE_T_H_
  22 # define _IRNODE_T_H_
  23
  24 #include "firm_config.h"
  25 #include "irnode.h"
  26 #include "irop_t.h"
  27 #include "irgraph_t.h"
  28 #include "irflag_t.h"
  29 #include "firm_common_t.h"
  30 #include "irdom_t.h" /* For size of struct dom_info. */
  31 #include "dbginfo.h"
  32 #include "irloop.h"
  33 #include "array.h"
  34
  35 #include "set.h"
  36 #include "entity_t.h"
  37 #include "type_t.h"
  38
  39
  40 /** ir node attributes **/
  41
  42 /** Block attributes */
  43 typedef struct {
  44   /* General attributes */
  45   ir_graph *irg;
  46   unsigned long block_visited;  /**< for the walker that walks over all blocks. */
  47   /* Attributes private to construction: */
  48   int matured:1;                /**< if set, all in-nodes of the block are fixed */
  49   int dead:1;                   /**< if set, the block is dead (and could be replace by a Bad */
  50   struct ir_node **graph_arr; /**< array to store all parameters */
  51   /* Attributes holding analyses information */
  52   struct dom_info dom;        /**< Datastructure that holds information about dominators.
  53                  @@@ @todo
  54                  Eventually overlay with graph_arr as only valid
  55                  in different phases.  Eventually inline the whole
  56                  datastructure. */
  57   /*   exc_t exc;  */            /**< role of this block for exception handling */
  58   /*   ir_node *handler_entry; */    /**< handler entry block iff this block is part of a region */
  59   ir_node ** in_cg;           /**< array with predecessors in
  60                    * interprocedural_view, if they differ
  61                    * from intraprocedural predecessors */
  62   int *backedge;              /**< Field n set to true if pred n is backedge.
  63                      @@@ @todo Ev. replace by bitfield! */
  64   int *cg_backedge;           /**< Field n set to true if pred n is interprocedural backedge.
  65                      @@@ @todo Ev. replace by bitfield! */
  66 } block_attr;
  67
  68 /** Start attributes */
  69 typedef struct {
  70   char dummy;
  71   /*   ir_graph *irg;   @@@ now in block */
  72 } start_attr;
  73
  74 /** Cond attributes */
  75 typedef struct {
  76   cond_kind kind;    /**< flavor of Cond */
  77   long default_proj; /**< for optimization: biggest Proj number, i.e. the one
  78                           used for default. */
  79 } cond_attr;
  80
  81 /** Const attributes */
  82 typedef struct {
  83   tarval *tv;        /**< the target value */
  84   type   *tp;        /**< the source type, for analyses. default: type_unknown. */
  85 } const_attr;
  86
  87 typedef struct {
  88   symconst_symbol sym;  // old tori
  89   symconst_kind num;
  90   type *tp;          /**< the source type, for analyses. default: type_unknown. */
  91 } symconst_attr;
  92
  93 /** Sel attributes */
  94 typedef struct {
  95   entity *ent;          /**< entity to select */
  96 } sel_attr;
  97
  98 /** Exception attributes */
  99 typedef struct {
 100   op_pin_state   pin_state;     /**< the pin state for operations that might generate a exception:
 101                                      If it's know that no exception will be generated, could be set to
 102                                      op_pin_state_floats. */
 103 #if PRECISE_EXC_CONTEXT
 104   struct ir_node **frag_arr;    /**< For Phi node construction in case of exception */
 105 #endif
 106 } except_attr;
 107
 108 typedef struct {
 109   except_attr    exc;           /**< the exception attribute. MUST be the first one. */
 110   type *cld_tp;                 /**< type of called procedure */
 111   entity ** callee_arr;         /**< result of callee analysis */
 112 } call_attr;
 113
 114 /** Alloc attributes */
 115 typedef struct {
 116   except_attr    exc;           /**< the exception attribute. MUST be the first one. */
 117   type *type;                   /**< Type of the allocated object.  */
 118   where_alloc where;            /**< stack, heap or other managed part of memory */
 119 } alloc_attr;
 120
 121 /** InstOf attributes */
 122 typedef struct
 123 {
 124   type *ent;
 125   int dfn;
 126 } io_attr;
 127
 128 /** Filter attributes */
 129 typedef struct {
 130   long proj;                 /**< contains the result position to project (Proj) */
 131   ir_node ** in_cg;          /**< array with interprocedural predecessors (Phi) */
 132   int *backedge;              /**< Field n set to true if pred n is backedge.
 133                      @todo Ev. replace by bitfield! */
 134 } filter_attr;
 135
 136 /** EndReg/EndExcept attributes */
 137 typedef struct {
 138   char dummy;
 139 } end_attr;
 140
 141 /** CallBegin attributes */
 142 typedef struct {
 143   ir_node * call;            /**< associated Call-operation */
 144 } callbegin_attr;
 145
 146 /** Cast attributes */
 147 typedef struct {
 148   type *totype;
 149 } cast_attr;
 150
 151 /** Load attributes */
 152 typedef struct {
 153   except_attr    exc;           /**< the exception attribute. MUST be the first one. */
 154   ir_mode        *load_mode;    /**< the mode of this Load operation */
 155   ent_volatility volatility;    /**< the volatility of a Load/Store operation */
 156 } load_attr;
 157
 158 /** Store attributes */
 159 typedef struct {
 160   except_attr    exc;           /**< the exception attribute. MUST be the first one. */
 161   ent_volatility volatility;    /**< the volatility of a Store operation */
 162 } store_attr;
 163
 164 typedef pn_Cmp confirm_attr; /** Attribute to hold compare operation */
 165
 166 /** Some irnodes just have one attribute, these are stored here,
 167    some have more. Their name is 'irnodename_attr' */
 168 typedef union {
 169   start_attr     start; /**< For Start */
 170   block_attr     block; /**< For Block: Fields needed to construct it */
 171   cond_attr      c;     /**< For Cond. */
 172   const_attr     con;   /**< For Const: contains the value of the constant and a type */
 173   symconst_attr  i;     /**< For SymConst. */
 174   sel_attr       s;     /**< For Sel. */
 175   call_attr      call;  /**< For Call: pointer to the type of the method to call */
 176   callbegin_attr callbegin; /**< For CallBegin */
 177   alloc_attr     a;     /**< For Alloc. */
 178   io_attr        io;    /**< For InstOf */
 179   type          *f;     /**< For Free. */
 180   cast_attr      cast;  /**< For Cast. */
 181   load_attr      load;  /**< For Load. */
 182   store_attr     store;  /**< For Store. */
 183   int            phi0_pos;  /**< For Phi. Used to remember the value defined by
 184                    this Phi node.  Needed when the Phi is completed
 185                    to call get_r_internal_value to find the
 186                    predecessors. If this attribute is set, the Phi
 187                    node takes the role of the obsolete Phi0 node,
 188                    therefore the name. */
 189   int *phi_backedge;    /**< For Phi after construction.
 190                            Field n set to true if pred n is backedge.
 191                            @todo Ev. replace by bitfield! */
 192   long           proj;  /**< For Proj: contains the result position to project */
 193   confirm_attr   confirm_cmp;   /**< For Confirm: compare operation */
 194   filter_attr    filter;    /**< For Filter */
 195   end_attr       end;       /**< For EndReg, EndExcept */
 196   except_attr    except; /**< For Phi node construction in case of exceptions */
 197 } attr;
 198
 199
 200 /** common structure of an irnode
 201     if the node has some attributes, they are stored in attr */
 202 struct ir_node {
 203   /* ------- Basics of the representation  ------- */
 204   firm_kind kind;          /**< distinguishes this node from others */
 205   ir_op *op;               /**< Opcode of this node. */
 206   ir_mode *mode;           /**< Mode of this node. */
 207   unsigned long visited;   /**< visited counter for walks of the graph */
 208   struct ir_node **in;     /**< array with predecessors / operands */
 209   void *link;              /**< to attach additional information to the node, e.g.
 210                               used while construction to link Phi0 nodes and
 211                               during optimization to link to nodes that
 212                               shall replace a node. */
 213   /* ------- Fields for optimizations / analysis information ------- */
 214   struct ir_node **out;    /**< array of out edges */
 215   struct dbg_info* dbi;    /**< A pointer to information for debug support. */
 216   /* ------- For debugging ------- */
 217 #ifdef DEBUG_libfirm
 218   int out_valid;           /** < indicate that out edges are valid */
 219   int node_nr;             /**< a unique node number for each node to make output
 220                               readable. */
 221 #endif
 222   /* ------- For analyses -------- */
 223   ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
 224 #ifdef  DO_HEAPANALYSIS
 225   struct abstval *av;
 226   struct section *sec;
 227 #endif
 228   /* ------- Opcode depending fields -------- */
 229   attr attr;               /**< attribute of this node. Depends on opcode.
 230                               Must be last field of struct ir_node. */
 231 };
 232
 233
 234 /** Returns the array with the ins.  The content of the array may not be
 235    changed.  */
 236 ir_node     **get_irn_in            (const ir_node *node);
 237
 238 /** @{ */
 239 /** access attributes directly */
 240 const_attr    get_irn_const_attr    (ir_node *node);
 241 long          get_irn_proj_attr     (ir_node *node);
 242 alloc_attr    get_irn_alloc_attr    (ir_node *node);
 243 type         *get_irn_free_attr     (ir_node *node);
 244 symconst_attr get_irn_symconst_attr (ir_node *node);
 245 type         *get_irn_call_attr     (ir_node *node);
 246 type         *get_irn_funccall_attr (ir_node *node);
 247 sel_attr      get_irn_sel_attr      (ir_node *node);
 248 int           get_irn_phi_attr      (ir_node *node);
 249 block_attr    get_irn_block_attr    (ir_node *node);
 250 load_attr     get_irn_load_attr     (ir_node *node);
 251 store_attr    get_irn_store_attr    (ir_node *node);
 252 except_attr   get_irn_except_attr   (ir_node *node);
 253 /** @} */
 254
 255 /*
 256  * The amount of additional space for custom data to be allocated upon creating a new node.
 257  */
 258 extern unsigned firm_add_node_size;
 259
 260 /*-------------------------------------------------------------------*/
 261 /*  These function are most used in libfirm.  Give them as static    */
 262 /*  functions so they can be inlined.                                */
 263 /*-------------------------------------------------------------------*/
 264
 265 /**
 266  * Checks whether a pointer points to a ir node.
 267  * Intern version for libFirm.
 268  */
 269 static INLINE int
 270 __is_ir_node (const void *thing) {
 271   return (get_kind(thing) == k_ir_node);
 272 }
 273
 274 /**
 275  * Gets the op of a node.
 276  * Intern version for libFirm.
 277  */
 278 static INLINE ir_op *
 279 __get_irn_op (const ir_node *node) {
 280   assert (node);
 281   return node->op;
 282 }
 283
 284 /** Copies all attributes stored in the old node  to the new node.
 285     Assumes both have the same opcode and sufficient size. */
 286 static INLINE void
 287 copy_node_attr(const ir_node *old_node, ir_node *new_node) {
 288   ir_op *op = __get_irn_op(old_node);
 289
 290   /* must always exist */
 291   op->copy_attr(old_node, new_node);
 292 }
 293
 294 /**
 295  * Gets the opcode of a node.
 296  * Intern version for libFirm.
 297  */
 298 static INLINE opcode
 299 __get_irn_opcode (const ir_node *node) {
 300   assert (k_ir_node == get_kind(node));
 301   assert (node -> op);
 302   return node->op->code;
 303 }
 304
 305 /**
 306  * Returns the number of predecessors without the block predecessor.
 307  * Intern version for libFirm.
 308  */
 309 static INLINE int
 310 __get_irn_intra_arity (const ir_node *node) {
 311   assert(node);
 312   return ARR_LEN(node->in) - 1;
 313 }
 314
 315 /**
 316  * Returns the number of predecessors without the block predecessor.
 317  * Intern version for libFirm.
 318  */
 319 static INLINE int
 320 __get_irn_inter_arity (const ir_node *node) {
 321   assert(node);
 322   if (__get_irn_opcode(node) == iro_Filter) {
 323     assert(node->attr.filter.in_cg);
 324     return ARR_LEN(node->attr.filter.in_cg) - 1;
 325   } else if (__get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
 326     return ARR_LEN(node->attr.block.in_cg) - 1;
 327   }
 328   return __get_irn_intra_arity(node);
 329 }
 330
 331 /**
 332  * Returns the number of predecessors without the block predecessor.
 333  * Intern version for libFirm.
 334  */
 335 extern int (*__get_irn_arity)(const ir_node *node);
 336
 337 /**
 338  * Intern version for libFirm.
 339  */
 340 static INLINE ir_node *
 341 __get_irn_intra_n (const ir_node *node, int n) {
 342   assert(node); assert(-1 <= n && n < __get_irn_intra_arity(node));
 343
 344   return (node->in[n + 1] = skip_Id(node->in[n + 1]));
 345 }
 346
 347 /**
 348  * Intern version for libFirm.
 349  */
 350 static INLINE ir_node*
 351 __get_irn_inter_n (const ir_node *node, int n) {
 352   assert(node); assert(-1 <= n && n < __get_irn_inter_arity(node));
 353
 354   /* handle Filter and Block specially */
 355   if (__get_irn_opcode(node) == iro_Filter) {
 356     assert(node->attr.filter.in_cg);
 357     return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
 358   } else if (__get_irn_opcode(node) == iro_Block && node->attr.block.in_cg) {
 359     return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
 360   }
 361
 362   return __get_irn_intra_n (node, n);
 363 }
 364
 365 /**
 366  * Access to the predecessors of a node.
 367  * To iterate over the operands iterate from 0 to i < get_irn_arity(),
 368  * to iterate including the Block predecessor iterate from i = -1 to
 369  * i < get_irn_arity.
 370  * If it is a block, the entry -1 is NULL.
 371  * Intern version for libFirm.
 372  */
 373 extern ir_node *(*__get_irn_n)(const ir_node *node, int n);
 374
 375 /**
 376  * Gets the mode of a node.
 377  * Intern version for libFirm.
 378  */
 379 static INLINE ir_mode *
 380 __get_irn_mode (const ir_node *node)
 381 {
 382   assert (node);
 383   return node->mode;
 384 }
 385
 386 /**
 387  * Sets the mode of a node.
 388  * Intern version of libFirm.
 389  */
 390 static INLINE void
 391 __set_irn_mode (ir_node *node, ir_mode *mode)
 392 {
 393   assert (node);
 394   node->mode = mode;
 395 }
 396
 397 /**
 398  * Gets the visited counter of a node.
 399  * Intern version for libFirm.
 400  */
 401 static INLINE unsigned long
 402 __get_irn_visited (const ir_node *node)
 403 {
 404   assert (node);
 405   return node->visited;
 406 }
 407
 408 /**
 409  * Sets the visited counter of a node.
 410  * Intern version for libFirm.
 411  */
 412 static INLINE void
 413 __set_irn_visited (ir_node *node, unsigned long visited)
 414 {
 415   assert (node);
 416   node->visited = visited;
 417 }
 418
 419 /**
 420  * Mark a node as visited in a graph.
 421  * Intern version for libFirm.
 422  */
 423 static INLINE void
 424 __mark_irn_visited (ir_node *node) {
 425   assert (node);
 426   node->visited = current_ir_graph->visited;
 427 }
 428
 429 /**
 430  * Returns non-zero if a node of was visited.
 431  * Intern version for libFirm.
 432  */
 433 static INLINE int
 434 __irn_visited(const ir_node *node) {
 435   assert (node);
 436   return (node->visited >= current_ir_graph->visited);
 437 }
 438
 439 /**
 440  * Returns non-zero if a node of was NOT visited.
 441  * Intern version for libFirm.
 442  */
 443 static INLINE int
 444 __irn_not_visited(const ir_node *node) {
 445   assert (node);
 446   return (node->visited < current_ir_graph->visited);
 447 }
 448
 449 /**
 450  * Sets the link of a node.
 451  * Intern version of libFirm.
 452  */
 453 static INLINE void
 454 __set_irn_link(ir_node *node, void *link) {
 455   assert (node);
 456   /* Link field is used for Phi construction and various optimizations
 457      in iropt. */
 458   assert(get_irg_phase_state(current_ir_graph) != phase_building);
 459
 460   node->link = link;
 461 }
 462
 463 /**
 464  * Returns the link of a node.
 465  * Intern version of libFirm.
 466  */
 467 static INLINE void *
 468 __get_irn_link(const ir_node *node) {
 469   assert (node && is_ir_node(node));
 470   return node->link;
 471 }
 472
 473 /**
 474  * Returns the pinned state of a node.
 475  * Intern version of libFirm.
 476  */
 477 static INLINE op_pin_state
 478 __get_irn_pinned(const ir_node *node) {
 479   assert(node && is_ir_node(node));
 480   op_pin_state state = __get_op_pinned(__get_irn_op(node));
 481   if (state >= op_pin_state_exc_pinned)
 482     return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
 483   return state;
 484 }
 485
 486 static INLINE int
 487 __is_unop(const ir_node *node) {
 488   assert(node && is_ir_node(node));
 489   return (node->op->opar == oparity_unary);
 490 }
 491
 492 static INLINE int
 493 __is_binop(const ir_node *node) {
 494   assert(node && is_ir_node(node));
 495   return (node->op->opar == oparity_binary);
 496 }
 497
 498 static INLINE int
 499 __is_Bad(const ir_node *node) {
 500   assert(node);
 501   return (node && __get_irn_op(node) == op_Bad);
 502 }
 503
 504 static INLINE int
 505 __is_no_Block(const ir_node *node) {
 506   assert(node && is_ir_node(node));
 507   return (__get_irn_op(node) != op_Block);
 508 }
 509
 510 static INLINE int
 511 __is_Block(const ir_node *node) {
 512   assert(node && is_ir_node(node));
 513   return (__get_irn_op(node) == op_Block);
 514 }
 515
 516 static INLINE ir_node *
 517 __set_Block_dead(ir_node *block) {
 518   assert(__get_irn_op(block) == op_Block);
 519   block->attr.block.dead = 1;
 520   return block;
 521 }
 522
 523 static INLINE int
 524 __is_Block_dead(const ir_node *block) {
 525   ir_op * op = __get_irn_op(block);
 526
 527   if (op == op_Bad)
 528     return 1;
 529   else {
 530     assert(op == op_Block);
 531     return block->attr.block.dead;
 532   }
 533 }
 534
 535 /* this section MUST contain all inline functions */
 536 #define is_ir_node(thing)          __is_ir_node(thing)
 537 #define get_irn_intra_arity(node)  __get_irn_intra_arity(node)
 538 #define get_irn_inter_arity(node)  __get_irn_inter_arity(node)
 539 #define get_irn_arity(node)        __get_irn_arity(node)
 540 #define get_irn_intra_n(node, n)   __get_irn_intra_n(node, n)
 541 #define get_irn_inter_n(node, n)   __get_irn_inter_n(node, n)
 542 #define get_irn_n(node, n)         __get_irn_n(node, n)
 543 #define get_irn_mode(node)         __get_irn_mode(node)
 544 #define set_irn_mode(node, mode)   __set_irn_mode(node, mode)
 545 #define get_irn_op(node)           __get_irn_op(node)
 546 #define get_irn_opcode(node)       __get_irn_opcode(node)
 547 #define get_irn_visited(node)      __get_irn_visited(node)
 548 #define set_irn_visited(node, v)   __set_irn_visited(node, v)
 549 #define mark_irn_visited(node)     __mark_irn_visited(node)
 550 #define irn_visited(node)          __irn_visited(node)
 551 #define irn_not_visited(node)      __irn_not_visited(node)
 552 #define set_irn_link(node, link)   __set_irn_link(node, link)
 553 #define get_irn_link(node)         __get_irn_link(node)
 554 #define is_unop(node)              __is_unop(node)
 555 #define is_binop(node)             __is_binop(node)
 556 #define is_Bad(node)               __is_Bad(node)
 557 #define is_no_Block(node)          __is_no_Block(node)
 558 #define is_Block(node)             __is_Block(node)
 559 #define set_Block_dead(block)      __set_Block_dead(block)
 560 #define is_Block_dead(block)       __is_Block_dead(block)
 561
 562 # endif /* _IRNODE_T_H_ */