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