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

   1 /*
   2  * Copyright (C) 1995-2007 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 extern int firm_interprocedural_view;
  86
  87 static INLINE int
  88 _get_interprocedural_view(void) {
  89         return firm_interprocedural_view;
  90 }
  91
  92 static INLINE int
  93 _is_ir_graph(const void *thing) {
  94         return (get_kind(thing) == k_ir_graph);
  95 }
  96
  97 /** Returns the start block of a graph. */
  98 static INLINE ir_node *
  99 _get_irg_start_block(const ir_graph *irg) {
 100         return get_irn_intra_n(irg->anchor, anchor_start_block);
 101 }
 102
 103 static INLINE void
 104 _set_irg_start_block(ir_graph *irg, ir_node *node) {
 105         set_irn_n(irg->anchor, anchor_start_block, node);
 106 }
 107
 108 static INLINE ir_node *
 109 _get_irg_start(const ir_graph *irg) {
 110         return get_irn_intra_n(irg->anchor, anchor_start);
 111 }
 112
 113 static INLINE void
 114 _set_irg_start(ir_graph *irg, ir_node *node) {
 115         set_irn_n(irg->anchor, anchor_start, node);
 116 }
 117
 118 static INLINE ir_node *
 119 _get_irg_end_block(const ir_graph *irg) {
 120         return get_irn_intra_n(irg->anchor, anchor_end_block);
 121 }
 122
 123 static INLINE void
 124 _set_irg_end_block(ir_graph *irg, ir_node *node) {
 125         /* FIXME: if this line is killed the whole graph collapse, why */
 126         set_irn_n(irg->anchor, -1, node);
 127         set_irn_n(irg->anchor, anchor_end_block, node);
 128 }
 129
 130 static INLINE ir_node *
 131 _get_irg_end(const ir_graph *irg) {
 132         return get_irn_intra_n(irg->anchor, anchor_end);
 133 }
 134
 135 static INLINE void
 136 _set_irg_end(ir_graph *irg, ir_node *node) {
 137         set_irn_n(irg->anchor, anchor_end, node);
 138 }
 139
 140 static INLINE ir_node *
 141 _get_irg_end_reg(const ir_graph *irg) {
 142         return get_irn_intra_n(irg->anchor, anchor_end_reg);
 143 }
 144
 145 static INLINE void
 146 _set_irg_end_reg(ir_graph *irg, ir_node *node) {
 147         set_irn_n(irg->anchor, anchor_end_reg, node);
 148 }
 149
 150 static INLINE ir_node *
 151 _get_irg_end_except(const ir_graph *irg) {
 152         return get_irn_intra_n(irg->anchor, anchor_end_except);
 153 }
 154
 155 static INLINE void
 156 _set_irg_end_except(ir_graph *irg, ir_node *node) {
 157         set_irn_n(irg->anchor, anchor_end_except, node);
 158 }
 159
 160 static INLINE ir_node *
 161 _get_irg_frame(const ir_graph *irg) {
 162         return get_irn_intra_n(irg->anchor, anchor_frame);
 163 }
 164
 165 static INLINE void
 166 _set_irg_frame(ir_graph *irg, ir_node *node) {
 167         set_irn_n(irg->anchor, anchor_frame, node);
 168 }
 169
 170 static INLINE ir_node *
 171 _get_irg_globals(const ir_graph *irg) {
 172         return get_irn_intra_n(irg->anchor, anchor_globals);
 173 }
 174
 175 static INLINE void
 176 _set_irg_globals(ir_graph *irg, ir_node *node) {
 177         set_irn_n(irg->anchor, anchor_globals, node);
 178 }
 179
 180 static INLINE ir_node *
 181 _get_irg_tls(const ir_graph *irg) {
 182         return get_irn_intra_n(irg->anchor, anchor_tls);
 183 }
 184
 185 static INLINE void
 186 _set_irg_tls(ir_graph *irg, ir_node *node) {
 187         set_irn_n(irg->anchor, anchor_tls, node);
 188 }
 189
 190 static INLINE ir_node *
 191 _get_irg_initial_mem(const ir_graph *irg) {
 192         return get_irn_intra_n(irg->anchor, anchor_initial_mem);
 193 }
 194
 195 static INLINE void
 196 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
 197         set_irn_n(irg->anchor, anchor_initial_mem, node);
 198 }
 199
 200 static INLINE ir_node *
 201 _get_irg_args(const ir_graph *irg) {
 202         return get_irn_intra_n(irg->anchor, anchor_args);
 203 }
 204
 205 static INLINE void
 206 _set_irg_args(ir_graph *irg, ir_node *node) {
 207         set_irn_n(irg->anchor, anchor_args, node);
 208 }
 209
 210 static INLINE ir_node *
 211 _get_irg_value_param_base(const ir_graph *irg) {
 212         return get_irn_intra_n(irg->anchor, anchor_value_param_base);
 213 }
 214
 215 static INLINE void
 216 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
 217         set_irn_n(irg->anchor, anchor_value_param_base, node);
 218 }
 219
 220 static INLINE ir_node **
 221 _get_irg_proj_args(const ir_graph *irg) {
 222         return irg->proj_args;
 223 }
 224
 225 static INLINE void
 226 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
 227         irg->proj_args = nodes;
 228 }
 229
 230 static INLINE ir_node *
 231 _get_irg_bad(const ir_graph *irg) {
 232         return get_irn_intra_n(irg->anchor, anchor_bad);
 233 }
 234
 235 static INLINE void
 236 _set_irg_bad(ir_graph *irg, ir_node *node) {
 237         set_irn_n(irg->anchor, anchor_bad, node);
 238 }
 239
 240 static INLINE ir_node *
 241 _get_irg_no_mem(const ir_graph *irg) {
 242         return get_irn_intra_n(irg->anchor, anchor_no_mem);
 243 }
 244
 245 static INLINE void
 246 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
 247         set_irn_n(irg->anchor, anchor_no_mem, node);
 248 }
 249
 250 static INLINE ir_node *
 251 _get_irg_current_block(const ir_graph *irg) {
 252         return irg->current_block;
 253 }
 254
 255 static INLINE void
 256 _set_irg_current_block(ir_graph *irg, ir_node *node) {
 257         irg->current_block = node;
 258 }
 259
 260 static INLINE ir_entity *
 261 _get_irg_entity(const ir_graph *irg) {
 262         assert(irg && irg->ent);
 263         return irg->ent;
 264 }
 265
 266 static INLINE void
 267 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
 268         irg->ent = ent;
 269 }
 270
 271 static INLINE ir_type *
 272 _get_irg_frame_type(ir_graph *irg) {
 273         assert(irg && irg->frame_type);
 274         return irg->frame_type = skip_tid(irg->frame_type);
 275 }
 276
 277 static INLINE void
 278 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
 279         assert(is_frame_type(ftp));
 280         irg->frame_type = ftp;
 281 }
 282
 283 static INLINE struct obstack *
 284 _get_irg_obstack(const ir_graph *irg) {
 285         return irg->obst;
 286 }
 287
 288
 289 static INLINE irg_phase_state
 290 _get_irg_phase_state(const ir_graph *irg) {
 291         return irg->phase_state;
 292 }
 293
 294 static INLINE void
 295 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
 296         irg->phase_state = state;
 297 }
 298
 299 static INLINE op_pin_state
 300 _get_irg_pinned(const ir_graph *irg) {
 301         return irg->irg_pinned_state;
 302 }
 303
 304 static INLINE irg_outs_state
 305 _get_irg_outs_state(const ir_graph *irg) {
 306         return irg->outs_state;
 307 }
 308
 309 static INLINE void
 310 _set_irg_outs_inconsistent(ir_graph *irg) {
 311         if (irg->outs_state == outs_consistent)
 312                 irg->outs_state = outs_inconsistent;
 313 }
 314
 315 static INLINE irg_extblk_state
 316 _get_irg_extblk_state(const ir_graph *irg) {
 317   return irg->extblk_state;
 318 }
 319
 320 static INLINE void
 321 _set_irg_extblk_inconsistent(ir_graph *irg) {
 322         if (irg->extblk_state == extblk_valid)
 323                 irg->extblk_state = extblk_invalid;
 324 }
 325
 326 static INLINE irg_dom_state
 327 _get_irg_dom_state(const ir_graph *irg) {
 328         return irg->dom_state;
 329 }
 330
 331 static INLINE irg_dom_state
 332 _get_irg_postdom_state(const ir_graph *irg) {
 333         return irg->pdom_state;
 334 }
 335
 336 static INLINE void
 337 _set_irg_doms_inconsistent(ir_graph *irg) {
 338         if (irg->dom_state != dom_none)
 339                 irg->dom_state = dom_inconsistent;
 340         if (irg->pdom_state != dom_none)
 341                 irg->pdom_state = dom_inconsistent;
 342 }
 343
 344 static INLINE irg_loopinfo_state
 345 _get_irg_loopinfo_state(const ir_graph *irg) {
 346         return irg->loopinfo_state;
 347 }
 348
 349 static INLINE void
 350 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
 351   irg->loopinfo_state = s;
 352 }
 353
 354 static INLINE void
 355 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
 356         irg->loopinfo_state &= ~loopinfo_valid;
 357 }
 358
 359 static INLINE void
 360 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
 361         irg->irg_pinned_state = p;
 362 }
 363
 364 static INLINE irg_callee_info_state
 365 _get_irg_callee_info_state(const ir_graph *irg) {
 366         return irg->callee_info_state;
 367 }
 368
 369 static INLINE void
 370 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
 371         irg_callee_info_state irp_state = get_irp_callee_info_state();
 372
 373         irg->callee_info_state = s;
 374
 375         /* I could compare ... but who knows? */
 376         if ((irp_state == irg_callee_info_consistent)  ||
 377             ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 378                 set_irp_callee_info_state(s);
 379 }
 380
 381 static INLINE irg_inline_property
 382 _get_irg_inline_property(const ir_graph *irg) {
 383         return irg->inline_property;
 384 }
 385
 386 static INLINE void
 387 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
 388         irg->inline_property = s;
 389 }
 390
 391 static INLINE unsigned
 392 _get_irg_additional_properties(const ir_graph *irg) {
 393         if (irg->additional_properties & mtp_property_inherited)
 394                 return get_method_additional_properties(get_entity_type(irg->ent));
 395         return irg->additional_properties;
 396 }
 397
 398 static INLINE void
 399 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
 400         irg->additional_properties = mask & ~mtp_property_inherited;
 401 }
 402
 403 static INLINE void
 404 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
 405         unsigned prop = irg->additional_properties;
 406
 407         if (prop & mtp_property_inherited)
 408                 prop = get_method_additional_properties(get_entity_type(irg->ent));
 409         irg->additional_properties = prop | flag;
 410 }
 411
 412 static INLINE void
 413 _set_irg_link(ir_graph *irg, void *thing) {
 414         irg->link = thing;
 415 }
 416
 417 static INLINE void *
 418 _get_irg_link(const ir_graph *irg) {
 419         return irg->link;
 420 }
 421
 422 static INLINE unsigned long
 423 _get_irg_visited(const ir_graph *irg) {
 424         return irg->visited;
 425 }
 426
 427 static INLINE unsigned long
 428 _get_irg_block_visited(const ir_graph *irg) {
 429         return irg->block_visited;
 430 }
 431
 432 static INLINE void
 433 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
 434         irg->block_visited = visited;
 435 }
 436
 437 static INLINE void
 438 _inc_irg_block_visited(ir_graph *irg) {
 439         ++irg->block_visited;
 440 }
 441
 442 static INLINE void
 443 _dec_irg_block_visited(ir_graph *irg) {
 444         --irg->block_visited;
 445 }
 446
 447 static INLINE unsigned
 448 _get_irg_estimated_node_cnt(const ir_graph *irg) {
 449         return irg->estimated_node_count;
 450 }
 451
 452 /* Return the floating point model of this graph. */
 453 static INLINE unsigned
 454 _get_irg_fp_model(const ir_graph *irg) {
 455         return irg->fp_model;
 456 }
 457
 458 /**
 459  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
 460  * @param irg The graph.
 461  * @param irn The node.
 462  * @return    The index allocated for the node.
 463  */
 464 static INLINE unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn) {
 465         unsigned idx = irg->last_node_idx++;
 466         if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
 467                 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
 468
 469         irg->idx_irn_map[idx] = irn;
 470         return idx;
 471 }
 472
 473 /**
 474  * Kill a node from the irg. BEWARE: this kills
 475  * all later created nodes.
 476  */
 477 static INLINE void
 478 irg_kill_node(ir_graph *irg, ir_node *n) {
 479         unsigned idx = get_irn_idx(n);
 480         assert(idx + 1 == irg->last_node_idx);
 481
 482         if (idx + 1 == irg->last_node_idx)
 483                 --irg->last_node_idx;
 484         irg->idx_irn_map[idx] = NULL;
 485         obstack_free(irg->obst, n);
 486 }
 487
 488 /**
 489  * Get the node for an index.
 490  * @param irg The graph.
 491  * @param idx The index you want the node for.
 492  * @return    The node with that index or NULL, if there is no node with that index.
 493  * @note      The node you got might be dead.
 494  */
 495 static INLINE ir_node *
 496 get_idx_irn(ir_graph *irg, unsigned idx) {
 497         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
 498         return irg->idx_irn_map[idx];
 499 }
 500
 501 /**
 502  * Return the number of anchors in this graph.
 503  */
 504 static INLINE int
 505 get_irg_n_anchors(const ir_graph *irg) {
 506         return get_irn_arity(irg->anchor);
 507 }
 508
 509 /**
 510  * Return anchor for given index
 511  */
 512 static INLINE ir_node *
 513 get_irg_anchor(const ir_graph *irg, int idx) {
 514         return get_irn_intra_n(irg->anchor, idx);
 515 }
 516
 517 /**
 518  * Set anchor for given index
 519  */
 520 static INLINE void
 521 set_irg_anchor(ir_graph *irg, int idx, ir_node *irn) {
 522         set_irn_n(irg->anchor, idx, irn);
 523 }
 524
 525
 526 #define get_interprocedural_view()            _get_interprocedural_view()
 527 #define is_ir_graph(thing)                    _is_ir_graph(thing)
 528 #define get_irg_start_block(irg)              _get_irg_start_block(irg)
 529 #define set_irg_start_block(irg, node)        _set_irg_start_block(irg, node)
 530 #define get_irg_start(irg)                    _get_irg_start(irg)
 531 #define set_irg_start(irg, node)              _set_irg_start(irg, node)
 532 #define get_irg_end_block(irg)                _get_irg_end_block(irg)
 533 #define set_irg_end_block(irg, node)          _set_irg_end_block(irg, node)
 534 #define get_irg_end(irg)                      _get_irg_end(irg)
 535 #define set_irg_end(irg, node)                _set_irg_end(irg, node)
 536 #define get_irg_end_reg(irg)                  _get_irg_end_reg(irg)
 537 #define set_irg_end_reg(irg, node)            _set_irg_end_reg(irg, node)
 538 #define get_irg_end_except(irg)               _get_irg_end_except(irg)
 539 #define set_irg_end_except(irg, node)         _set_irg_end_except(irg, node)
 540 #define get_irg_frame(irg)                    _get_irg_frame(irg)
 541 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
 542 #define get_irg_globals(irg)                  _get_irg_globals(irg)
 543 #define set_irg_globals(irg, node)            _set_irg_globals(irg, node)
 544 #define get_irg_tls(irg)                      _get_irg_tls(irg)
 545 #define set_irg_tls(irg, node)                _set_irg_tls(irg, node)
 546 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
 547 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
 548 #define get_irg_args(irg)                     _get_irg_args(irg)
 549 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
 550 #define get_irg_value_param_base(irg)         _get_irg_value_param_base(irg)
 551 #define set_irg_value_param_base(irg, node)   _set_irg_value_param_base(irg, node)
 552 #define get_irg_bad(irg)                      _get_irg_bad(irg)
 553 #define set_irg_bad(irg, node)                _set_irg_bad(irg, node)
 554 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
 555 #define set_irn_no_mem(irg, node)             _set_irn_no_mem(irg, node)
 556 #define get_irg_current_block(irg)            _get_irg_current_block(irg)
 557 #define set_irg_current_block(irg, node)      _set_irg_current_block(irg, node)
 558 #define get_irg_entity(irg)                   _get_irg_entity(irg)
 559 #define set_irg_entity(irg, ent)              _set_irg_entity(irg, ent)
 560 #define get_irg_frame_type(irg)               _get_irg_frame_type(irg)
 561 #define set_irg_frame_type(irg, ftp)          _set_irg_frame_type(irg, ftp)
 562 #define get_irg_obstack(irg)                  _get_irg_obstack(irg)
 563 #define get_irg_phase_state(irg)              _get_irg_phase_state(irg)
 564 #define set_irg_phase_state(irg, state)       _set_irg_phase_state(irg, state)
 565 #define get_irg_pinned(irg)                   _get_irg_pinned(irg)
 566 #define get_irg_outs_state(irg)               _get_irg_outs_state(irg)
 567 #define set_irg_outs_inconsistent(irg)        _set_irg_outs_inconsistent(irg)
 568 #define get_irg_extblk_state(irg)             _get_irg_extblk_state(irg)
 569 #define set_irg_extblk_inconsistent(irg)      _set_irg_extblk_inconsistent(irg)
 570 #define get_irg_dom_state(irg)                _get_irg_dom_state(irg)
 571 #define get_irg_postdom_state(irg)            _get_irg_postdom_state(irg)
 572 #define set_irg_doms_inconsistent(irg)        _set_irg_doms_inconsistent(irg)
 573 #define get_irg_loopinfo_state(irg)           _get_irg_loopinfo_state(irg)
 574 #define set_irg_loopinfo_state(irg, s)        _set_irg_loopinfo_state(irg, s)
 575 #define set_irg_loopinfo_inconsistent(irg)    _set_irg_loopinfo_inconsistent(irg)
 576 #define set_irg_pinned(irg, p)                _set_irg_pinned(irg, p)
 577 #define get_irg_callee_info_state(irg)        _get_irg_callee_info_state(irg)
 578 #define set_irg_callee_info_state(irg, s)     _set_irg_callee_info_state(irg, s)
 579 #define get_irg_inline_property(irg)          _get_irg_inline_property(irg)
 580 #define set_irg_inline_property(irg, s)       _set_irg_inline_property(irg, s)
 581 #define get_irg_additional_properties(irg)    _get_irg_additional_properties(irg)
 582 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
 583 #define set_irg_additional_property(irg, f)   _set_irg_additional_property(irg, f)
 584 #define set_irg_link(irg, thing)              _set_irg_link(irg, thing)
 585 #define get_irg_link(irg)                     _get_irg_link(irg)
 586 #define get_irg_visited(irg)                  _get_irg_visited(irg)
 587 #define get_irg_block_visited(irg)            _get_irg_block_visited(irg)
 588 #define set_irg_block_visited(irg, v)         _set_irg_block_visited(irg, v)
 589 #define inc_irg_block_visited(irg)            _inc_irg_block_visited(irg)
 590 #define dec_irg_block_visited(irg)            _dec_irg_block_visited(irg)
 591 #define get_irg_estimated_node_cnt(irg)       _get_irg_estimated_node_cnt(irg)
 592 #define get_irg_fp_model(irg)                 _get_irg_fp_model(irg)
 593
 594 #endif