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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irgraph.c
   4  * Purpose:     Entry point to the representation of procedure code -- internal 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 irgraph_t.h
  15  *
  16  * ir graph construction.
  17  *
  18  * @author Martin Trapp, Christian Schaefer
  19  */
  20
  21
  22 #ifndef _IRGRAPH_T_H_
  23 #define _IRGRAPH_T_H_
  24
  25 #include "firm_types.h"
  26 #include "irgraph.h"
  27
  28 #include "firm_common_t.h"
  29 #include "irtypeinfo.h"
  30 #include "irprog.h"
  31 #include "pseudo_irg.h"
  32 #include "type_t.h"
  33 #include "entity_t.h"
  34 #include "typegmod.h"
  35 #include "tr_inheritance.h"
  36
  37 #include "irloop.h"
  38 #include "execution_frequency.h"
  39
  40 #include "obst.h"
  41 #include "pset.h"
  42 #include "set.h"
  43
  44 #define FRAME_TP_SUFFIX "frame_tp"
  45
  46 /**
  47  * Edge info to put into an irg.
  48  */
  49 typedef struct _irg_edge_info_t {
  50         set *edges;
  51         unsigned activated : 1;
  52 } irg_edge_info_t;
  53
  54 /**
  55  * Index constants for nodes that can be accessed through the graph itself.
  56  */
  57 enum irg_anchors {
  58   anchor_start_block = 0, /**< block the start node will belong to */
  59   anchor_start,           /**< start node of this ir_graph */
  60   anchor_end_block,       /**< block the end node will belong to */
  61   anchor_end,             /**< end node of this ir_graph */
  62   anchor_end_reg,         /**< end node of this ir_graph */
  63   anchor_end_except,      /**< end node of this ir_graph */
  64   anchor_cstore,          /**< constant store -- no more needed!! */
  65   anchor_frame,           /**< method's frame */
  66   anchor_globals,         /**< pointer to the data segment containing all
  67                                globals as well as global procedures. */
  68   anchor_initial_mem,     /**< initial memory of this graph */
  69   anchor_args,            /**< methods arguments */
  70   anchor_bad,             /**< bad node of this ir_graph, the one and
  71                                only in this graph */
  72   anchor_no_mem,          /**< NoMem node of this ir_graph, the one and only in this graph */
  73   anchor_max
  74 };
  75
  76 /** ir_graph holds all information for a procedure */
  77 struct ir_graph {
  78   firm_kind         kind;            /**<  always set to k_ir_graph*/
  79   /* --  Basics of the representation -- */
  80   entity  *ent;           /**< The entity of this procedure, i.e.,
  81                     the type of the procedure and the
  82                     class it belongs to. */
  83   ir_type *frame_type;           /**< A class type representing the stack frame.
  84                                       Can include "inner" methods. */
  85   ir_node *anchors[anchor_max];  /**< anchor nodes */
  86   ir_node **proj_args;           /**< projs of the methods arguments */
  87   struct obstack *obst;          /**< obstack where all of the ir_nodes live */
  88   ir_node *current_block;        /**< block for newly gen_*()-erated ir_nodes */
  89   struct obstack *extbb_obst;    /**< obstack for extended basic block info */
  90
  91   /* -- Fields for graph properties -- */
  92   irg_inline_property inline_property;     /**< How to handle inlineing. */
  93   unsigned additional_properties;          /**< additional graph properties. */
  94
  95   /* -- Fields indicating different states of irgraph -- */
  96   irg_phase_state phase_state;       /**< compiler phase */
  97   op_pin_state irg_pinned_state;     /**< Flag for status of nodes */
  98   irg_outs_state outs_state;         /**< Out edges. */
  99   irg_dom_state dom_state;           /**< Dominator state information */
 100   irg_dom_state pdom_state;          /**< Post Dominator state information */
 101   ir_typeinfo_state typeinfo_state;        /**< Validity of type information */
 102   irg_callee_info_state callee_info_state; /**< Validity of callee information */
 103   irg_loopinfo_state loopinfo_state;       /**< state of loop information */
 104   exec_freq_state   execfreq_state;        /**< state of execution frequency information */
 105   ir_class_cast_state class_cast_state;    /**< kind of cast operations in code. */
 106   irg_extblk_info_state extblk_state;      /**< state of extended basic block info */
 107
 108   /* -- Fields for construction -- */
 109 #if USE_EXPLICIT_PHI_IN_STACK
 110   struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
 111 #endif
 112   int n_loc;                         /**< number of local variable in this
 113                                           procedure including procedure parameters. */
 114   void **loc_descriptions;           /**< storage for local variable desriptions */
 115
 116   /* -- Fields for optimizations / analysis information -- */
 117   pset *value_table;                 /**< hash table for global value numbering (cse)
 118                     for optimizing use in iropt.c */
 119   ir_node **outs;                    /**< Space for the out arrays. */
 120
 121 #ifdef DEBUG_libfirm
 122   int             n_outs;            /**< Size wasted for outs */
 123 #endif /* defined DEBUG_libfirm */
 124   ir_loop *loop;                     /**< The outermost loop */
 125   void *link;                        /**< A void* field to link any information to
 126                     the node. */
 127
 128   ir_graph **callers;                /**< For callgraph analysis. */
 129   unsigned char *caller_isbe;        /**< For callgraph analysis: set if backedge. */
 130   ir_graph **callees;                /**< For callgraph analysis. */
 131   unsigned char *callee_isbe;        /**< For callgraph analysis: set if backedge. */
 132   int        callgraph_loop_depth;         /**< For callgraph analysis */
 133   int        callgraph_recursion_depth;    /**< For callgraph analysis */
 134   double     method_execution_frequency;   /**< For callgraph analysis */
 135
 136   ir_loop   *l;
 137
 138   /* -- Fields for Walking the graph -- */
 139   unsigned long visited;             /**< this flag is an identifier for
 140                     ir walk. it will be incremented
 141                     every time someone walks through
 142                     the graph */
 143   unsigned long block_visited;       /**< same as visited, for a complete block */
 144   unsigned estimated_node_count;     /**< estimated number of nodes in this graph,
 145                                           updated after every walk */
 146 #if FIRM_EDGES_INPLACE
 147   irg_edge_info_t edge_info;  /**< edge info for automatic outs */
 148 #endif
 149 #ifdef DEBUG_libfirm
 150   long graph_nr;              /**< a unique graph number for each graph to make output
 151                    readable. */
 152 #endif
 153
 154 };
 155
 156 /**
 157  * Initializes the graph construction module
 158  */
 159 void firm_init_irgraph(void);
 160
 161 /* Internal constructor that does not add to irp_irgs or the like. */
 162 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
 163
 164 /** Make a rudimentary ir graph for the constant code.
 165    Must look like a correct irg, spare everything else. */
 166 ir_graph *new_const_code_irg(void);
 167
 168 /**
 169  * Set the op_pin_state_pinned state of a graph.
 170  *
 171  * @param irg     the IR graph
 172  * @param p       new pin state
 173  */
 174 INLINE void
 175 set_irg_pinned (ir_graph *irg, op_pin_state p);
 176
 177 /** Returns the obstack associated with the graph. */
 178 struct obstack *get_irg_obstack(const ir_graph *irg);
 179
 180 /**
 181  * Returns true if the node n is allocated on the storage of graph irg.
 182  *
 183  * @param irg   the IR graph
 184  * @param n the IR node
 185  */
 186 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
 187
 188 /*-------------------------------------------------------------------*/
 189 /* inline functions for graphs                                       */
 190 /*-------------------------------------------------------------------*/
 191
 192 extern int firm_interprocedural_view;
 193
 194 static INLINE int
 195 _get_interprocedural_view(void) {
 196   return firm_interprocedural_view;
 197 }
 198
 199 static INLINE int
 200 _is_ir_graph(const void *thing) {
 201   return (get_kind(thing) == k_ir_graph);
 202 }
 203
 204 /** Returns the start block of a graph. */
 205 static INLINE ir_node *
 206 _get_irg_start_block(const ir_graph *irg) {
 207   return irg->anchors[anchor_start_block];
 208 }
 209
 210 static INLINE void
 211 _set_irg_start_block(ir_graph *irg, ir_node *node) {
 212   irg->anchors[anchor_start_block] = node;
 213 }
 214
 215 static INLINE ir_node *
 216 _get_irg_start(const ir_graph *irg) {
 217   return irg->anchors[anchor_start];
 218 }
 219
 220 static INLINE void
 221 _set_irg_start(ir_graph *irg, ir_node *node) {
 222   irg->anchors[anchor_start] = node;
 223 }
 224
 225 static INLINE ir_node *
 226 _get_irg_end_block(const ir_graph *irg) {
 227   return irg->anchors[anchor_end_block];
 228 }
 229
 230 static INLINE void
 231 _set_irg_end_block(ir_graph *irg, ir_node *node) {
 232   irg->anchors[anchor_end_block] = node;
 233 }
 234
 235 static INLINE ir_node *
 236 _get_irg_end(const ir_graph *irg) {
 237   return irg->anchors[anchor_end];
 238 }
 239
 240 static INLINE void
 241 _set_irg_end(ir_graph *irg, ir_node *node) {
 242   irg->anchors[anchor_end] = node;
 243 }
 244
 245 static INLINE ir_node *
 246 _get_irg_end_reg(const ir_graph *irg) {
 247   return irg->anchors[anchor_end_reg];
 248 }
 249
 250 static INLINE ir_node *
 251 _get_irg_end_except (const ir_graph *irg) {
 252   return irg->anchors[anchor_end_except];
 253 }
 254
 255 static INLINE ir_node *
 256 _get_irg_cstore(const ir_graph *irg) {
 257   return irg->anchors[anchor_cstore];
 258 }
 259
 260 static INLINE void
 261 _set_irg_cstore(ir_graph *irg, ir_node *node) {
 262   irg->anchors[anchor_cstore] = node;
 263 }
 264
 265 static INLINE ir_node *
 266 _get_irg_frame(const ir_graph *irg) {
 267   return irg->anchors[anchor_frame];
 268 }
 269
 270 static INLINE void
 271 _set_irg_frame(ir_graph *irg, ir_node *node) {
 272   irg->anchors[anchor_frame] = node;
 273 }
 274
 275 static INLINE ir_node *
 276 _get_irg_globals(const ir_graph *irg) {
 277   return irg->anchors[anchor_globals];
 278 }
 279
 280 static INLINE void
 281 _set_irg_globals(ir_graph *irg, ir_node *node) {
 282   irg->anchors[anchor_globals] = node;
 283 }
 284
 285 static INLINE ir_node *
 286 _get_irg_initial_mem(const ir_graph *irg) {
 287   return irg->anchors[anchor_initial_mem];
 288 }
 289
 290 static INLINE void
 291 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
 292   irg->anchors[anchor_initial_mem] = node;
 293 }
 294
 295 static INLINE ir_node *
 296 _get_irg_args(const ir_graph *irg) {
 297   return irg->anchors[anchor_args];
 298 }
 299
 300 static INLINE void
 301 _set_irg_args(ir_graph *irg, ir_node *node) {
 302   irg->anchors[anchor_args] = node;
 303 }
 304
 305 static INLINE ir_node **
 306 _get_irg_proj_args(const ir_graph *irg) {
 307   return irg->proj_args;
 308 }
 309
 310 static INLINE void
 311 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
 312   irg->proj_args = nodes;
 313 }
 314
 315 static INLINE ir_node *
 316 _get_irg_bad(const ir_graph *irg) {
 317   return irg->anchors[anchor_bad];
 318 }
 319
 320 static INLINE void
 321 _set_irg_bad(ir_graph *irg, ir_node *node) {
 322   irg->anchors[anchor_bad] = node;
 323 }
 324
 325 static INLINE ir_node *
 326 _get_irg_no_mem(const ir_graph *irg) {
 327   return irg->anchors[anchor_no_mem];
 328 }
 329
 330 static INLINE void
 331 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
 332   irg->anchors[anchor_no_mem] = node;
 333 }
 334 static INLINE ir_node *
 335 _get_irg_current_block(const ir_graph *irg) {
 336   return irg->current_block;
 337 }
 338
 339 static INLINE void
 340 _set_irg_current_block(ir_graph *irg, ir_node *node) {
 341   irg->current_block = node;
 342 }
 343
 344 static INLINE entity *
 345 _get_irg_entity(const ir_graph *irg) {
 346   assert(irg && irg->ent);
 347   return irg->ent;
 348 }
 349
 350 static INLINE void
 351 _set_irg_entity(ir_graph *irg, entity *ent) {
 352   irg->ent = ent;
 353 }
 354
 355 static INLINE ir_type *
 356 _get_irg_frame_type(ir_graph *irg) {
 357   assert(irg && irg->frame_type);
 358   return irg->frame_type = skip_tid(irg->frame_type);
 359 }
 360
 361 static INLINE void
 362 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
 363   assert(is_frame_type(ftp));
 364   irg->frame_type = ftp;
 365 }
 366
 367 static INLINE struct obstack *
 368 _get_irg_obstack(const ir_graph *irg) {
 369   return irg->obst;
 370 }
 371
 372
 373 static INLINE irg_phase_state
 374 _get_irg_phase_state(const ir_graph *irg) {
 375   return irg->phase_state;
 376 }
 377
 378 static INLINE void
 379 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
 380   irg->phase_state = state;
 381 }
 382
 383 static INLINE op_pin_state
 384 _get_irg_pinned(const ir_graph *irg) {
 385   return irg->irg_pinned_state;
 386 }
 387
 388 static INLINE irg_outs_state
 389 _get_irg_outs_state(const ir_graph *irg) {
 390   return irg->outs_state;
 391 }
 392
 393 static INLINE void
 394 _set_irg_outs_inconsistent(ir_graph *irg) {
 395   if (irg->outs_state == outs_consistent)
 396     irg->outs_state = outs_inconsistent;
 397 }
 398
 399 static INLINE irg_extblk_state
 400 _get_irg_extblk_state(const ir_graph *irg) {
 401   return irg->extblk_state;
 402 }
 403
 404 static INLINE void
 405 _set_irg_extblk_inconsistent(ir_graph *irg) {
 406   if (irg->extblk_state == extblk_valid)
 407     irg->extblk_state = extblk_invalid;
 408 }
 409
 410 static INLINE irg_dom_state
 411 _get_irg_dom_state(const ir_graph *irg) {
 412   return irg->dom_state;
 413 }
 414
 415 static INLINE irg_dom_state
 416 _get_irg_postdom_state(const ir_graph *irg) {
 417   return irg->pdom_state;
 418 }
 419
 420 static INLINE void
 421 _set_irg_doms_inconsistent(ir_graph *irg) {
 422   if (irg->dom_state != dom_none)
 423     irg->dom_state = dom_inconsistent;
 424   if (irg->pdom_state != dom_none)
 425     irg->pdom_state = dom_inconsistent;
 426 }
 427
 428 static INLINE irg_loopinfo_state
 429 _get_irg_loopinfo_state(const ir_graph *irg) {
 430   return irg->loopinfo_state;
 431 }
 432
 433 static INLINE void
 434 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
 435   irg->loopinfo_state = s;
 436 }
 437
 438 static INLINE void
 439 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
 440   irg->loopinfo_state &= ~loopinfo_valid;
 441 }
 442
 443 static INLINE void
 444 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
 445   irg->irg_pinned_state = p;
 446 }
 447
 448 static INLINE irg_callee_info_state
 449 _get_irg_callee_info_state(const ir_graph *irg) {
 450   return irg->callee_info_state;
 451 }
 452
 453 static INLINE void
 454 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
 455   irg_callee_info_state irp_state = get_irp_callee_info_state();
 456
 457   irg->callee_info_state = s;
 458
 459   /* I could compare ... but who knows? */
 460   if ((irp_state == irg_callee_info_consistent)  ||
 461       ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 462       set_irp_callee_info_state(s);
 463 }
 464
 465 static INLINE irg_inline_property
 466 _get_irg_inline_property(const ir_graph *irg) {
 467   return irg->inline_property;
 468 }
 469
 470 static INLINE void
 471 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
 472   irg->inline_property = s;
 473 }
 474
 475 static INLINE unsigned
 476 _get_irg_additional_properties(const ir_graph *irg) {
 477   if (irg->additional_properties & mtp_property_inherited)
 478     return get_method_additional_properties(get_entity_type(irg->ent));
 479   return irg->additional_properties;
 480 }
 481
 482 static INLINE void
 483 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
 484   /* do not allow to set the mtp_property_inherited flag or
 485    * the automatic inheritance of flags will not work */
 486   irg->additional_properties = mask & ~mtp_property_inherited;
 487 }
 488
 489 static INLINE void
 490 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
 491   unsigned prop = irg->additional_properties;
 492
 493   if (prop & mtp_property_inherited)
 494     prop = get_method_additional_properties(get_entity_type(irg->ent));
 495   irg->additional_properties = prop | flag;
 496 }
 497
 498 static INLINE void
 499 _set_irg_link(ir_graph *irg, void *thing) {
 500   irg->link = thing;
 501 }
 502
 503 static INLINE void *
 504 _get_irg_link(const ir_graph *irg) {
 505   return irg->link;
 506 }
 507
 508 static INLINE unsigned long
 509 _get_irg_visited(const ir_graph *irg) {
 510   return irg->visited;
 511 }
 512
 513 static INLINE unsigned long
 514 _get_irg_block_visited(const ir_graph *irg) {
 515   return irg->block_visited;
 516 }
 517
 518 static INLINE void
 519 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
 520   irg->block_visited = visited;
 521 }
 522
 523 static INLINE void
 524 _inc_irg_block_visited(ir_graph *irg) {
 525   ++irg->block_visited;
 526 }
 527
 528 static INLINE unsigned
 529 _get_irg_estimated_node_cnt(const ir_graph *irg) {
 530   return irg->estimated_node_count;
 531 }
 532
 533 #define get_interprocedural_view()            _get_interprocedural_view()
 534 #define is_ir_graph(thing)                    _is_ir_graph(thing)
 535 #define get_irg_start_block(irg)              _get_irg_start_block(irg)
 536 #define set_irg_start_block(irg, node)        _set_irg_start_block(irg, node)
 537 #define get_irg_start(irg)                    _get_irg_start(irg)
 538 #define set_irg_start(irg, node)              _set_irg_start(irg, node)
 539 #define get_irg_end_block(irg)                _get_irg_end_block(irg)
 540 #define set_irg_end_block(irg, node)          _set_irg_end_block(irg, node)
 541 #define get_irg_end(irg)                      _get_irg_end(irg)
 542 #define set_irg_end(irg, node)                _set_irg_end(irg, node)
 543 #define get_irg_end_reg(irg)                  _get_irg_end_reg(irg)
 544 #define get_irg_end_except(irg)               _get_irg_end_except(irg)
 545 #define get_irg_cstore(irg)                   _get_irg_cstore(irg)
 546 #define set_irg_cstore(irg, node)             _set_irg_cstore(irg, node)
 547 #define get_irg_frame(irg)                    _get_irg_frame(irg)
 548 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
 549 #define get_irg_globals(irg)                  _get_irg_globals(irg)
 550 #define set_irg_globals(irg, node)            _set_irg_globals(irg, node)
 551 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
 552 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
 553 #define get_irg_args(irg)                     _get_irg_args(irg)
 554 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
 555 #define get_irg_bad(irg)                      _get_irg_bad(irg)
 556 #define set_irg_bad(irg, node)                _set_irg_bad(irg, node)
 557 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
 558 #define set_irg_no_mem(irg, node)             _set_irg_no_mem(irg, node)
 559 #define get_irg_current_block(irg)            _get_irg_current_block(irg)
 560 #define set_irg_current_block(irg, node)      _set_irg_current_block(irg, node)
 561 #define get_irg_entity(irg)                   _get_irg_entity(irg)
 562 #define set_irg_entity(irg, ent)              _set_irg_entity(irg, ent)
 563 #define get_irg_frame_type(irg)               _get_irg_frame_type(irg)
 564 #define set_irg_frame_type(irg, ftp)          _set_irg_frame_type(irg, ftp)
 565 #define get_irg_obstack(irg)                  _get_irg_obstack(irg)
 566 #define get_irg_phase_state(irg)              _get_irg_phase_state(irg)
 567 #define set_irg_phase_state(irg, state)       _set_irg_phase_state(irg, state)
 568 #define get_irg_pinned(irg)                   _get_irg_pinned(irg)
 569 #define get_irg_outs_state(irg)               _get_irg_outs_state(irg)
 570 #define set_irg_outs_inconsistent(irg)        _set_irg_outs_inconsistent(irg)
 571 #define get_irg_extblk_state(irg)             _get_irg_extblk_state(irg)
 572 #define set_irg_extblk_inconsistent(irg)      _set_irg_extblk_inconsistent(irg)
 573 #define get_irg_dom_state(irg)                _get_irg_dom_state(irg)
 574 #define get_irg_postdom_state(irg)            _get_irg_postdom_state(irg)
 575 #define set_irg_doms_inconsistent(irg)        _set_irg_doms_inconsistent(irg)
 576 #define get_irg_loopinfo_state(irg)           _get_irg_loopinfo_state(irg)
 577 #define set_irg_loopinfo_state(irg, s)        _set_irg_loopinfo_state(irg, s)
 578 #define set_irg_loopinfo_inconsistent(irg)    _set_irg_loopinfo_inconsistent(irg)
 579 #define set_irg_pinned(irg, p)                _set_irg_pinned(irg, p)
 580 #define get_irg_callee_info_state(irg)        _get_irg_callee_info_state(irg)
 581 #define set_irg_callee_info_state(irg, s)     _set_irg_callee_info_state(irg, s)
 582 #define get_irg_inline_property(irg)          _get_irg_inline_property(irg)
 583 #define set_irg_inline_property(irg, s)       _set_irg_inline_property(irg, s)
 584 #define get_irg_additional_properties(irg)    _get_irg_additional_properties(irg)
 585 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
 586 #define set_irg_additional_property(irg, f)   _set_irg_additional_property(irg, f)
 587 #define set_irg_link(irg, thing)              _set_irg_link(irg, thing)
 588 #define get_irg_link(irg)                     _get_irg_link(irg)
 589 #define get_irg_visited(irg)                  _get_irg_visited(irg)
 590 #define get_irg_block_visited(irg)            _get_irg_block_visited(irg)
 591 #define set_irg_block_visited(irg, v)         _set_irg_block_visited(irg, v)
 592 #define inc_irg_block_visited(irg)            _inc_irg_block_visited(irg)
 593 #define get_irg_estimated_node_cnt(irg)       _get_irg_estimated_node_cnt(irg)
 594
 595 # endif /* _IRGRAPH_T_H_ */