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

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    Entry point to the representation of procedure code -- internal header.
  23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  * @version  $Id$
  25  */
  26 #ifndef FIRM_IR_IRGRAPH_T_H
  27 #define FIRM_IR_IRGRAPH_T_H
  28
  29 #include "firm_types.h"
  30 #include "irgraph.h"
  31
  32 #include "firm_common_t.h"
  33 #include "irtypes.h"
  34 #include "irprog.h"
  35 #include "pseudo_irg.h"
  36 #include "type_t.h"
  37 #include "entity_t.h"
  38 #include "iredgekinds.h"
  39
  40 #include "irloop.h"
  41
  42 #include "obst.h"
  43 #include "pset.h"
  44 #include "set.h"
  45
  46 /** Suffix that is added to every frame type. */
  47 #define FRAME_TP_SUFFIX "frame_tp"
  48
  49 /**
  50  * Initializes the graph construction module
  51  */
  52 void firm_init_irgraph(void);
  53
  54 /* Internal constructor that does not add to irp_irgs or the like. */
  55 ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
  56
  57 /** Make a rudimentary ir graph for the constant code.
  58    Must look like a correct irg, spare everything else. */
  59 ir_graph *new_const_code_irg(void);
  60
  61 /**
  62  * Set the op_pin_state_pinned state of a graph.
  63  *
  64  * @param irg     the IR graph
  65  * @param p       new pin state
  66  */
  67 INLINE void
  68 set_irg_pinned (ir_graph *irg, op_pin_state p);
  69
  70 /** Returns the obstack associated with the graph. */
  71 struct obstack *get_irg_obstack(const ir_graph *irg);
  72
  73 /**
  74  * Returns true if the node n is allocated on the storage of graph irg.
  75  *
  76  * @param irg   the IR graph
  77  * @param n the IR node
  78  */
  79 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
  80
  81 /*-------------------------------------------------------------------*/
  82 /* inline functions for graphs                                       */
  83 /*-------------------------------------------------------------------*/
  84
  85 static INLINE int
  86 _is_ir_graph(const void *thing) {
  87         return (get_kind(thing) == k_ir_graph);
  88 }
  89
  90 /** Returns the start block of a graph. */
  91 static INLINE ir_node *
  92 _get_irg_start_block(const ir_graph *irg) {
  93         return get_irn_intra_n(irg->anchor, anchor_start_block);
  94 }
  95
  96 static INLINE void
  97 _set_irg_start_block(ir_graph *irg, ir_node *node) {
  98         set_irn_n(irg->anchor, anchor_start_block, node);
  99 }
 100
 101 static INLINE ir_node *
 102 _get_irg_start(const ir_graph *irg) {
 103         return get_irn_intra_n(irg->anchor, anchor_start);
 104 }
 105
 106 static INLINE void
 107 _set_irg_start(ir_graph *irg, ir_node *node) {
 108         set_irn_n(irg->anchor, anchor_start, node);
 109 }
 110
 111 static INLINE ir_node *
 112 _get_irg_end_block(const ir_graph *irg) {
 113         return get_irn_intra_n(irg->anchor, anchor_end_block);
 114 }
 115
 116 static INLINE void
 117 _set_irg_end_block(ir_graph *irg, ir_node *node) {
 118         set_irn_n(irg->anchor, -1, node);
 119         set_irn_n(irg->anchor, anchor_end_block, node);
 120 }
 121
 122 static INLINE ir_node *
 123 _get_irg_end(const ir_graph *irg) {
 124         return get_irn_intra_n(irg->anchor, anchor_end);
 125 }
 126
 127 static INLINE void
 128 _set_irg_end(ir_graph *irg, ir_node *node) {
 129         set_irn_n(irg->anchor, anchor_end, node);
 130 }
 131
 132 static INLINE ir_node *
 133 _get_irg_end_reg(const ir_graph *irg) {
 134         return get_irn_intra_n(irg->anchor, anchor_end_reg);
 135 }
 136
 137 static INLINE void
 138 _set_irg_end_reg(ir_graph *irg, ir_node *node) {
 139         set_irn_n(irg->anchor, anchor_end_reg, node);
 140 }
 141
 142 static INLINE ir_node *
 143 _get_irg_end_except(const ir_graph *irg) {
 144         return get_irn_intra_n(irg->anchor, anchor_end_except);
 145 }
 146
 147 static INLINE void
 148 _set_irg_end_except(ir_graph *irg, ir_node *node) {
 149         set_irn_n(irg->anchor, anchor_end_except, node);
 150 }
 151
 152 static INLINE ir_node *
 153 _get_irg_frame(const ir_graph *irg) {
 154         return get_irn_intra_n(irg->anchor, anchor_frame);
 155 }
 156
 157 static INLINE void
 158 _set_irg_frame(ir_graph *irg, ir_node *node) {
 159         set_irn_n(irg->anchor, anchor_frame, node);
 160 }
 161
 162 static INLINE ir_node *
 163 _get_irg_globals(const ir_graph *irg) {
 164         return get_irn_intra_n(irg->anchor, anchor_globals);
 165 }
 166
 167 static INLINE void
 168 _set_irg_globals(ir_graph *irg, ir_node *node) {
 169         set_irn_n(irg->anchor, anchor_globals, node);
 170 }
 171
 172 static INLINE ir_node *
 173 _get_irg_tls(const ir_graph *irg) {
 174         return get_irn_intra_n(irg->anchor, anchor_tls);
 175 }
 176
 177 static INLINE void
 178 _set_irg_tls(ir_graph *irg, ir_node *node) {
 179         set_irn_n(irg->anchor, anchor_tls, node);
 180 }
 181
 182 static INLINE ir_node *
 183 _get_irg_initial_mem(const ir_graph *irg) {
 184         return get_irn_intra_n(irg->anchor, anchor_initial_mem);
 185 }
 186
 187 static INLINE void
 188 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
 189         set_irn_n(irg->anchor, anchor_initial_mem, node);
 190 }
 191
 192 static INLINE ir_node *
 193 _get_irg_args(const ir_graph *irg) {
 194         return get_irn_intra_n(irg->anchor, anchor_args);
 195 }
 196
 197 static INLINE void
 198 _set_irg_args(ir_graph *irg, ir_node *node) {
 199         set_irn_n(irg->anchor, anchor_args, node);
 200 }
 201
 202 static INLINE ir_node *
 203 _get_irg_value_param_base(const ir_graph *irg) {
 204         return get_irn_intra_n(irg->anchor, anchor_value_param_base);
 205 }
 206
 207 static INLINE void
 208 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
 209         set_irn_n(irg->anchor, anchor_value_param_base, node);
 210 }
 211
 212 static INLINE ir_node *
 213 _get_irg_bad(const ir_graph *irg) {
 214         return get_irn_intra_n(irg->anchor, anchor_bad);
 215 }
 216
 217 static INLINE void
 218 _set_irg_bad(ir_graph *irg, ir_node *node) {
 219         set_irn_n(irg->anchor, anchor_bad, node);
 220 }
 221
 222 static INLINE ir_node *
 223 _get_irg_no_mem(const ir_graph *irg) {
 224         return get_irn_intra_n(irg->anchor, anchor_no_mem);
 225 }
 226
 227 static INLINE void
 228 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
 229         set_irn_n(irg->anchor, anchor_no_mem, node);
 230 }
 231
 232 static INLINE ir_node *
 233 _get_irg_current_block(const ir_graph *irg) {
 234         return irg->current_block;
 235 }
 236
 237 static INLINE void
 238 _set_irg_current_block(ir_graph *irg, ir_node *node) {
 239         irg->current_block = node;
 240 }
 241
 242 static INLINE ir_entity *
 243 _get_irg_entity(const ir_graph *irg) {
 244         assert(irg && irg->ent);
 245         return irg->ent;
 246 }
 247
 248 static INLINE void
 249 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
 250         irg->ent = ent;
 251 }
 252
 253 static INLINE ir_type *
 254 _get_irg_frame_type(ir_graph *irg) {
 255         assert(irg && irg->frame_type);
 256         return irg->frame_type = skip_tid(irg->frame_type);
 257 }
 258
 259 static INLINE void
 260 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
 261         assert(is_frame_type(ftp));
 262         irg->frame_type = ftp;
 263 }
 264
 265 static INLINE struct obstack *
 266 _get_irg_obstack(const ir_graph *irg) {
 267         return irg->obst;
 268 }
 269
 270
 271 static INLINE irg_phase_state
 272 _get_irg_phase_state(const ir_graph *irg) {
 273         return irg->phase_state;
 274 }
 275
 276 static INLINE void
 277 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
 278         irg->phase_state = state;
 279 }
 280
 281 static INLINE op_pin_state
 282 _get_irg_pinned(const ir_graph *irg) {
 283         return irg->irg_pinned_state;
 284 }
 285
 286 static INLINE irg_outs_state
 287 _get_irg_outs_state(const ir_graph *irg) {
 288         return irg->outs_state;
 289 }
 290
 291 static INLINE void
 292 _set_irg_outs_inconsistent(ir_graph *irg) {
 293         if (irg->outs_state == outs_consistent)
 294                 irg->outs_state = outs_inconsistent;
 295 }
 296
 297 static INLINE irg_extblk_state
 298 _get_irg_extblk_state(const ir_graph *irg) {
 299   return irg->extblk_state;
 300 }
 301
 302 static INLINE void
 303 _set_irg_extblk_inconsistent(ir_graph *irg) {
 304         if (irg->extblk_state == extblk_valid)
 305                 irg->extblk_state = extblk_invalid;
 306 }
 307
 308 static INLINE irg_dom_state
 309 _get_irg_dom_state(const ir_graph *irg) {
 310         return irg->dom_state;
 311 }
 312
 313 static INLINE irg_dom_state
 314 _get_irg_postdom_state(const ir_graph *irg) {
 315         return irg->pdom_state;
 316 }
 317
 318 static INLINE void
 319 _set_irg_doms_inconsistent(ir_graph *irg) {
 320         if (irg->dom_state != dom_none)
 321                 irg->dom_state = dom_inconsistent;
 322         if (irg->pdom_state != dom_none)
 323                 irg->pdom_state = dom_inconsistent;
 324 }
 325
 326 static INLINE irg_loopinfo_state
 327 _get_irg_loopinfo_state(const ir_graph *irg) {
 328         return irg->loopinfo_state;
 329 }
 330
 331 static INLINE void
 332 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
 333   irg->loopinfo_state = s;
 334 }
 335
 336 static INLINE void
 337 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
 338         irg->loopinfo_state &= ~loopinfo_valid;
 339 }
 340
 341 static INLINE void
 342 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
 343         irg->irg_pinned_state = p;
 344 }
 345
 346 static INLINE irg_callee_info_state
 347 _get_irg_callee_info_state(const ir_graph *irg) {
 348         return irg->callee_info_state;
 349 }
 350
 351 static INLINE void
 352 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
 353         irg_callee_info_state irp_state = get_irp_callee_info_state();
 354
 355         irg->callee_info_state = s;
 356
 357         /* I could compare ... but who knows? */
 358         if ((irp_state == irg_callee_info_consistent)  ||
 359             ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 360                 set_irp_callee_info_state(s);
 361 }
 362
 363 static INLINE irg_inline_property
 364 _get_irg_inline_property(const ir_graph *irg) {
 365         return irg->inline_property;
 366 }
 367
 368 static INLINE void
 369 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
 370         irg->inline_property = s;
 371 }
 372
 373 static INLINE unsigned
 374 _get_irg_additional_properties(const ir_graph *irg) {
 375         if (irg->additional_properties & mtp_property_inherited)
 376                 return get_method_additional_properties(get_entity_type(irg->ent));
 377         return irg->additional_properties;
 378 }
 379
 380 static INLINE void
 381 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
 382         irg->additional_properties = mask & ~mtp_property_inherited;
 383 }
 384
 385 static INLINE void
 386 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
 387         unsigned prop = irg->additional_properties;
 388
 389         if (prop & mtp_property_inherited)
 390                 prop = get_method_additional_properties(get_entity_type(irg->ent));
 391         irg->additional_properties = prop | flag;
 392 }
 393
 394 static INLINE void
 395 _set_irg_link(ir_graph *irg, void *thing) {
 396         irg->link = thing;
 397 }
 398
 399 static INLINE void *
 400 _get_irg_link(const ir_graph *irg) {
 401         return irg->link;
 402 }
 403
 404 static INLINE unsigned long
 405 _get_irg_visited(const ir_graph *irg) {
 406         return irg->visited;
 407 }
 408
 409 static INLINE unsigned long
 410 _get_irg_block_visited(const ir_graph *irg) {
 411         return irg->block_visited;
 412 }
 413
 414 static INLINE void
 415 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
 416         irg->block_visited = visited;
 417 }
 418
 419 static INLINE void
 420 _inc_irg_block_visited(ir_graph *irg) {
 421         ++irg->block_visited;
 422 }
 423
 424 static INLINE void
 425 _dec_irg_block_visited(ir_graph *irg) {
 426         --irg->block_visited;
 427 }
 428
 429 static INLINE unsigned
 430 _get_irg_estimated_node_cnt(const ir_graph *irg) {
 431         return irg->estimated_node_count;
 432 }
 433
 434 /* Return the floating point model of this graph. */
 435 static INLINE unsigned
 436 _get_irg_fp_model(const ir_graph *irg) {
 437         return irg->fp_model;
 438 }
 439
 440 /**
 441  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
 442  * @param irg The graph.
 443  * @param irn The node.
 444  * @return    The index allocated for the node.
 445  */
 446 static INLINE unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn) {
 447         unsigned idx = irg->last_node_idx++;
 448         if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
 449                 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
 450
 451         irg->idx_irn_map[idx] = irn;
 452         return idx;
 453 }
 454
 455 /**
 456  * Kill a node from the irg. BEWARE: this kills
 457  * all later created nodes.
 458  */
 459 static INLINE void
 460 irg_kill_node(ir_graph *irg, ir_node *n) {
 461         unsigned idx = get_irn_idx(n);
 462         assert(idx + 1 == irg->last_node_idx);
 463
 464         if (idx + 1 == irg->last_node_idx)
 465                 --irg->last_node_idx;
 466         irg->idx_irn_map[idx] = NULL;
 467         obstack_free(irg->obst, n);
 468 }
 469
 470 /**
 471  * Get the node for an index.
 472  * @param irg The graph.
 473  * @param idx The index you want the node for.
 474  * @return    The node with that index or NULL, if there is no node with that index.
 475  * @note      The node you got might be dead.
 476  */
 477 static INLINE ir_node *
 478 get_idx_irn(ir_graph *irg, unsigned idx) {
 479         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
 480         return irg->idx_irn_map[idx];
 481 }
 482
 483 /**
 484  * Return the number of anchors in this graph.
 485  */
 486 static INLINE int
 487 get_irg_n_anchors(const ir_graph *irg) {
 488         return get_irn_arity(irg->anchor);
 489 }
 490
 491 /**
 492  * Return anchor for given index
 493  */
 494 static INLINE ir_node *
 495 get_irg_anchor(const ir_graph *irg, int idx) {
 496         return get_irn_intra_n(irg->anchor, idx);
 497 }
 498
 499 /**
 500  * Set anchor for given index
 501  */
 502 static INLINE void
 503 set_irg_anchor(ir_graph *irg, int idx, ir_node *irn) {
 504         set_irn_n(irg->anchor, idx, irn);
 505 }
 506
 507 #ifdef INTERPROCEDURAL_VIEW
 508 extern int firm_interprocedural_view;
 509
 510 static INLINE int
 511 _get_interprocedural_view(void) {
 512         return firm_interprocedural_view;
 513 }
 514
 515 #define get_interprocedural_view()            _get_interprocedural_view()
 516 #endif
 517
 518 #define is_ir_graph(thing)                    _is_ir_graph(thing)
 519 #define get_irg_start_block(irg)              _get_irg_start_block(irg)
 520 #define set_irg_start_block(irg, node)        _set_irg_start_block(irg, node)
 521 #define get_irg_start(irg)                    _get_irg_start(irg)
 522 #define set_irg_start(irg, node)              _set_irg_start(irg, node)
 523 #define get_irg_end_block(irg)                _get_irg_end_block(irg)
 524 #define set_irg_end_block(irg, node)          _set_irg_end_block(irg, node)
 525 #define get_irg_end(irg)                      _get_irg_end(irg)
 526 #define set_irg_end(irg, node)                _set_irg_end(irg, node)
 527 #define get_irg_end_reg(irg)                  _get_irg_end_reg(irg)
 528 #define set_irg_end_reg(irg, node)            _set_irg_end_reg(irg, node)
 529 #define get_irg_end_except(irg)               _get_irg_end_except(irg)
 530 #define set_irg_end_except(irg, node)         _set_irg_end_except(irg, node)
 531 #define get_irg_frame(irg)                    _get_irg_frame(irg)
 532 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
 533 #define get_irg_globals(irg)                  _get_irg_globals(irg)
 534 #define set_irg_globals(irg, node)            _set_irg_globals(irg, node)
 535 #define get_irg_tls(irg)                      _get_irg_tls(irg)
 536 #define set_irg_tls(irg, node)                _set_irg_tls(irg, node)
 537 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
 538 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
 539 #define get_irg_args(irg)                     _get_irg_args(irg)
 540 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
 541 #define get_irg_value_param_base(irg)         _get_irg_value_param_base(irg)
 542 #define set_irg_value_param_base(irg, node)   _set_irg_value_param_base(irg, node)
 543 #define get_irg_bad(irg)                      _get_irg_bad(irg)
 544 #define set_irg_bad(irg, node)                _set_irg_bad(irg, node)
 545 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
 546 #define set_irn_no_mem(irg, node)             _set_irn_no_mem(irg, node)
 547 #define get_irg_current_block(irg)            _get_irg_current_block(irg)
 548 #define set_irg_current_block(irg, node)      _set_irg_current_block(irg, node)
 549 #define get_irg_entity(irg)                   _get_irg_entity(irg)
 550 #define set_irg_entity(irg, ent)              _set_irg_entity(irg, ent)
 551 #define get_irg_frame_type(irg)               _get_irg_frame_type(irg)
 552 #define set_irg_frame_type(irg, ftp)          _set_irg_frame_type(irg, ftp)
 553 #define get_irg_obstack(irg)                  _get_irg_obstack(irg)
 554 #define get_irg_phase_state(irg)              _get_irg_phase_state(irg)
 555 #define set_irg_phase_state(irg, state)       _set_irg_phase_state(irg, state)
 556 #define get_irg_pinned(irg)                   _get_irg_pinned(irg)
 557 #define get_irg_outs_state(irg)               _get_irg_outs_state(irg)
 558 #define set_irg_outs_inconsistent(irg)        _set_irg_outs_inconsistent(irg)
 559 #define get_irg_extblk_state(irg)             _get_irg_extblk_state(irg)
 560 #define set_irg_extblk_inconsistent(irg)      _set_irg_extblk_inconsistent(irg)
 561 #define get_irg_dom_state(irg)                _get_irg_dom_state(irg)
 562 #define get_irg_postdom_state(irg)            _get_irg_postdom_state(irg)
 563 #define set_irg_doms_inconsistent(irg)        _set_irg_doms_inconsistent(irg)
 564 #define get_irg_loopinfo_state(irg)           _get_irg_loopinfo_state(irg)
 565 #define set_irg_loopinfo_state(irg, s)        _set_irg_loopinfo_state(irg, s)
 566 #define set_irg_loopinfo_inconsistent(irg)    _set_irg_loopinfo_inconsistent(irg)
 567 #define set_irg_pinned(irg, p)                _set_irg_pinned(irg, p)
 568 #define get_irg_callee_info_state(irg)        _get_irg_callee_info_state(irg)
 569 #define set_irg_callee_info_state(irg, s)     _set_irg_callee_info_state(irg, s)
 570 #define get_irg_inline_property(irg)          _get_irg_inline_property(irg)
 571 #define set_irg_inline_property(irg, s)       _set_irg_inline_property(irg, s)
 572 #define get_irg_additional_properties(irg)    _get_irg_additional_properties(irg)
 573 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
 574 #define set_irg_additional_property(irg, f)   _set_irg_additional_property(irg, f)
 575 #define set_irg_link(irg, thing)              _set_irg_link(irg, thing)
 576 #define get_irg_link(irg)                     _get_irg_link(irg)
 577 #define get_irg_visited(irg)                  _get_irg_visited(irg)
 578 #define get_irg_block_visited(irg)            _get_irg_block_visited(irg)
 579 #define set_irg_block_visited(irg, v)         _set_irg_block_visited(irg, v)
 580 #define inc_irg_block_visited(irg)            _inc_irg_block_visited(irg)
 581 #define dec_irg_block_visited(irg)            _dec_irg_block_visited(irg)
 582 #define get_irg_estimated_node_cnt(irg)       _get_irg_estimated_node_cnt(irg)
 583 #define get_irg_fp_model(irg)                 _get_irg_fp_model(irg)
 584
 585 #endif