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 "irtypes.h"
  33 #include "irprog.h"
  34 #include "type_t.h"
  35 #include "entity_t.h"
  36 #include "iredgekinds.h"
  37
  38 #include "irloop.h"
  39
  40 #include "obst.h"
  41 #include "pset.h"
  42 #include "set.h"
  43
  44 /** Suffix that is added to every frame type. */
  45 #define FRAME_TP_SUFFIX "frame_tp"
  46
  47 /**
  48  * Initializes the graph construction module.
  49  */
  50 void firm_init_irgraph(void);
  51
  52 /**
  53  * Set the number of locals for a given graph.
  54  *
  55  * @param irg    the graph
  56  * @param n_loc  number of locals
  57  */
  58 void irg_set_nloc(ir_graph *res, int n_loc);
  59
  60 /**
  61  * Internal constructor that does not add to irp_irgs or the like.
  62  */
  63 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
  64
  65 /**
  66  * Make a rudimentary ir graph for the constant code.
  67  * Must look like a correct irg, spare everything else.
  68  */
  69 ir_graph *new_const_code_irg(void);
  70
  71 /**
  72  * Create a new graph that is a copy of a given one.
  73  * Uses the link fields of the original graphs.
  74  *
  75  * @param irg  The graph that must be copied.
  76  */
  77 ir_graph *create_irg_copy(ir_graph *irg);
  78
  79 /**
  80  * Set the op_pin_state_pinned state of a graph.
  81  *
  82  * @param irg     the IR graph
  83  * @param p       new pin state
  84  */
  85 void set_irg_pinned(ir_graph *irg, op_pin_state p);
  86
  87 /** Returns the obstack associated with the graph. */
  88 struct obstack *get_irg_obstack(const ir_graph *irg);
  89
  90 /**
  91  * Returns true if the node n is allocated on the storage of graph irg.
  92  *
  93  * @param irg   the IR graph
  94  * @param n the IR node
  95  */
  96 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
  97
  98 /*-------------------------------------------------------------------*/
  99 /* inline functions for graphs                                       */
 100 /*-------------------------------------------------------------------*/
 101
 102 static inline int _is_ir_graph(const void *thing)
 103 {
 104         return (get_kind(thing) == k_ir_graph);
 105 }
 106
 107 /** Returns the start block of a graph. */
 108 static inline ir_node *_get_irg_start_block(const ir_graph *irg)
 109 {
 110         return get_irn_n(irg->anchor, anchor_start_block);
 111 }
 112
 113 static inline void _set_irg_start_block(ir_graph *irg, ir_node *node)
 114 {
 115         set_irn_n(irg->anchor, anchor_start_block, node);
 116 }
 117
 118 static inline ir_node *_get_irg_start(const ir_graph *irg)
 119 {
 120         return get_irn_n(irg->anchor, anchor_start);
 121 }
 122
 123 static inline void _set_irg_start(ir_graph *irg, ir_node *node)
 124 {
 125         set_irn_n(irg->anchor, anchor_start, node);
 126 }
 127
 128 static inline ir_node *_get_irg_end_block(const ir_graph *irg)
 129 {
 130         return get_irn_n(irg->anchor, anchor_end_block);
 131 }
 132
 133 static inline void _set_irg_end_block(ir_graph *irg, ir_node *node)
 134 {
 135         set_irn_n(irg->anchor, -1, node);
 136         set_irn_n(irg->anchor, anchor_end_block, node);
 137 }
 138
 139 static inline ir_node *_get_irg_end(const ir_graph *irg)
 140 {
 141         return get_irn_n(irg->anchor, anchor_end);
 142 }
 143
 144 static inline void _set_irg_end(ir_graph *irg, ir_node *node)
 145 {
 146         set_irn_n(irg->anchor, anchor_end, node);
 147 }
 148
 149 static inline ir_node *_get_irg_initial_exec(const ir_graph *irg)
 150 {
 151         return get_irn_n(irg->anchor, anchor_initial_exec);
 152 }
 153
 154 static inline void _set_irg_initial_exec(ir_graph *irg, ir_node *node)
 155 {
 156         set_irn_n(irg->anchor, anchor_initial_exec, node);
 157 }
 158
 159 static inline ir_node *_get_irg_frame(const ir_graph *irg)
 160 {
 161         return get_irn_n(irg->anchor, anchor_frame);
 162 }
 163
 164 static inline void _set_irg_frame(ir_graph *irg, ir_node *node)
 165 {
 166         set_irn_n(irg->anchor, anchor_frame, node);
 167 }
 168
 169 static inline ir_node *_get_irg_tls(const ir_graph *irg)
 170 {
 171         return get_irn_n(irg->anchor, anchor_tls);
 172 }
 173
 174 static inline void _set_irg_tls(ir_graph *irg, ir_node *node)
 175 {
 176         set_irn_n(irg->anchor, anchor_tls, node);
 177 }
 178
 179 static inline ir_node *_get_irg_initial_mem(const ir_graph *irg)
 180 {
 181         return get_irn_n(irg->anchor, anchor_initial_mem);
 182 }
 183
 184 static inline void _set_irg_initial_mem(ir_graph *irg, ir_node *node)
 185 {
 186         set_irn_n(irg->anchor, anchor_initial_mem, node);
 187 }
 188
 189 static inline ir_node *_get_irg_args(const ir_graph *irg)
 190 {
 191         return get_irn_n(irg->anchor, anchor_args);
 192 }
 193
 194 static inline void _set_irg_args(ir_graph *irg, ir_node *node)
 195 {
 196         set_irn_n(irg->anchor, anchor_args, node);
 197 }
 198
 199 static inline ir_node *_get_irg_bad(const ir_graph *irg)
 200 {
 201         return get_irn_n(irg->anchor, anchor_bad);
 202 }
 203
 204 static inline void _set_irg_bad(ir_graph *irg, ir_node *node)
 205 {
 206         set_irn_n(irg->anchor, anchor_bad, node);
 207 }
 208
 209 static inline ir_node * _get_irg_no_mem(const ir_graph *irg)
 210 {
 211         return get_irn_n(irg->anchor, anchor_no_mem);
 212 }
 213
 214 static inline void _set_irg_no_mem(ir_graph *irg, ir_node *node)
 215 {
 216         set_irn_n(irg->anchor, anchor_no_mem, node);
 217 }
 218
 219 static inline ir_entity *_get_irg_entity(const ir_graph *irg)
 220 {
 221         assert(irg);
 222         return irg->ent;
 223 }
 224
 225 static inline void _set_irg_entity(ir_graph *irg, ir_entity *ent)
 226 {
 227         irg->ent = ent;
 228 }
 229
 230 static inline ir_type *_get_irg_frame_type(ir_graph *irg)
 231 {
 232         assert(irg->frame_type);
 233         return irg->frame_type;
 234 }
 235
 236 static inline void _set_irg_frame_type(ir_graph *irg, ir_type *ftp)
 237 {
 238         assert(is_frame_type(ftp));
 239         irg->frame_type = ftp;
 240 }
 241
 242 static inline struct obstack *_get_irg_obstack(const ir_graph *irg)
 243 {
 244         return irg->obst;
 245 }
 246
 247
 248 static inline irg_phase_state _get_irg_phase_state(const ir_graph *irg)
 249 {
 250         return irg->phase_state;
 251 }
 252
 253 static inline void _set_irg_phase_state(ir_graph *irg, irg_phase_state state)
 254 {
 255         irg->phase_state = state;
 256 }
 257
 258 static inline op_pin_state _get_irg_pinned(const ir_graph *irg)
 259 {
 260         return irg->irg_pinned_state;
 261 }
 262
 263 static inline irg_outs_state _get_irg_outs_state(const ir_graph *irg)
 264 {
 265         return irg->outs_state;
 266 }
 267
 268 static inline void _set_irg_outs_inconsistent(ir_graph *irg)
 269 {
 270         if (irg->outs_state == outs_consistent)
 271                 irg->outs_state = outs_inconsistent;
 272 }
 273
 274 static inline irg_extblk_info_state _get_irg_extblk_state(const ir_graph *irg)
 275 {
 276         return irg->extblk_state;
 277 }
 278
 279 static inline void _set_irg_extblk_inconsistent(ir_graph *irg)
 280 {
 281         if (irg->extblk_state == ir_extblk_info_valid)
 282                 irg->extblk_state = ir_extblk_info_invalid;
 283 }
 284
 285 static inline irg_dom_state _get_irg_dom_state(const ir_graph *irg)
 286 {
 287         return irg->dom_state;
 288 }
 289
 290 static inline irg_dom_state _get_irg_postdom_state(const ir_graph *irg)
 291 {
 292         return irg->pdom_state;
 293 }
 294
 295 static inline void _set_irg_doms_inconsistent(ir_graph *irg)
 296 {
 297         if (irg->dom_state != dom_none)
 298                 irg->dom_state = dom_inconsistent;
 299         if (irg->pdom_state != dom_none)
 300                 irg->pdom_state = dom_inconsistent;
 301 }
 302
 303 static inline irg_loopinfo_state _get_irg_loopinfo_state(const ir_graph *irg)
 304 {
 305         return irg->loopinfo_state;
 306 }
 307
 308 static inline void _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s)
 309 {
 310   irg->loopinfo_state = s;
 311 }
 312
 313 static inline void _set_irg_loopinfo_inconsistent(ir_graph *irg)
 314 {
 315         irg->loopinfo_state &= ~loopinfo_valid;
 316 }
 317
 318 static inline void _set_irg_pinned(ir_graph *irg, op_pin_state p)
 319 {
 320         irg->irg_pinned_state = p;
 321 }
 322
 323 static inline irg_callee_info_state _get_irg_callee_info_state(const ir_graph *irg)
 324 {
 325         return irg->callee_info_state;
 326 }
 327
 328 static inline void _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s)
 329 {
 330         irg_callee_info_state irp_state = get_irp_callee_info_state();
 331
 332         irg->callee_info_state = s;
 333
 334         /* I could compare ... but who knows? */
 335         if ((irp_state == irg_callee_info_consistent)  ||
 336             ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 337                 set_irp_callee_info_state(s);
 338 }
 339
 340 static inline irg_inline_property _get_irg_inline_property(const ir_graph *irg)
 341 {
 342         return irg->inline_property;
 343 }
 344
 345 static inline void _set_irg_inline_property(ir_graph *irg, irg_inline_property s)
 346 {
 347         irg->inline_property = s;
 348 }
 349
 350 static inline unsigned _get_irg_additional_properties(const ir_graph *irg)
 351 {
 352         if (irg->additional_properties & mtp_property_inherited)
 353                 return get_method_additional_properties(get_entity_type(irg->ent));
 354         return irg->additional_properties;
 355 }
 356
 357 static inline void _set_irg_additional_properties(ir_graph *irg, unsigned mask)
 358 {
 359         irg->additional_properties = mask & ~mtp_property_inherited;
 360 }
 361
 362 static inline void _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag)
 363 {
 364         unsigned prop = irg->additional_properties;
 365
 366         if (prop & mtp_property_inherited)
 367                 prop = get_method_additional_properties(get_entity_type(irg->ent));
 368         irg->additional_properties = prop | flag;
 369 }
 370
 371 static inline void _set_irg_link(ir_graph *irg, void *thing)
 372 {
 373         irg->link = thing;
 374 }
 375
 376 static inline void *_get_irg_link(const ir_graph *irg)
 377 {
 378         return irg->link;
 379 }
 380
 381 static inline ir_visited_t _get_irg_visited(const ir_graph *irg)
 382 {
 383         return irg->visited;
 384 }
 385
 386 static inline ir_visited_t _get_irg_block_visited(const ir_graph *irg)
 387 {
 388         return irg->block_visited;
 389 }
 390
 391 static inline void _set_irg_block_visited(ir_graph *irg, ir_visited_t visited)
 392 {
 393         irg->block_visited = visited;
 394 }
 395
 396 static inline void _inc_irg_block_visited(ir_graph *irg)
 397 {
 398         ++irg->block_visited;
 399 }
 400
 401 static inline void _dec_irg_block_visited(ir_graph *irg)
 402 {
 403         --irg->block_visited;
 404 }
 405
 406 static inline unsigned _get_irg_estimated_node_cnt(const ir_graph *irg)
 407 {
 408         return irg->estimated_node_count;
 409 }
 410
 411 /* Return the floating point model of this graph. */
 412 static inline unsigned _get_irg_fp_model(const ir_graph *irg)
 413 {
 414         return irg->fp_model;
 415 }
 416
 417 static inline void _set_irg_state(ir_graph *irg, ir_graph_state_t state)
 418 {
 419         irg->state |= state;
 420 }
 421
 422 static inline void _clear_irg_state(ir_graph *irg, ir_graph_state_t state)
 423 {
 424         irg->state &= ~state;
 425 }
 426
 427 static inline int _is_irg_state(const ir_graph *irg, ir_graph_state_t state)
 428 {
 429         return (irg->state & state) == state;
 430 }
 431
 432 /**
 433  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
 434  * @param irg The graph.
 435  * @param irn The node.
 436  * @return    The index allocated for the node.
 437  */
 438 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn) {
 439         unsigned idx = irg->last_node_idx++;
 440         if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
 441                 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
 442
 443         irg->idx_irn_map[idx] = irn;
 444         return idx;
 445 }
 446
 447 /**
 448  * Kill a node from the irg. BEWARE: this kills
 449  * all later created nodes.
 450  */
 451 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
 452 {
 453         unsigned idx = get_irn_idx(n);
 454         assert(idx + 1 == irg->last_node_idx);
 455
 456         if (idx + 1 == irg->last_node_idx)
 457                 --irg->last_node_idx;
 458         irg->idx_irn_map[idx] = NULL;
 459         obstack_free(irg->obst, n);
 460 }
 461
 462 /**
 463  * Get the node for an index.
 464  * @param irg The graph.
 465  * @param idx The index you want the node for.
 466  * @return    The node with that index or NULL, if there is no node with that index.
 467  * @note      The node you got might be dead.
 468  */
 469 static inline ir_node *_get_idx_irn(ir_graph *irg, unsigned idx)
 470 {
 471         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
 472         return irg->idx_irn_map[idx];
 473 }
 474
 475 /**
 476  * Return the number of anchors in this graph.
 477  */
 478 static inline int get_irg_n_anchors(const ir_graph *irg)
 479 {
 480         return get_irn_arity(irg->anchor);
 481 }
 482
 483 /**
 484  * Return anchor for given index
 485  */
 486 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
 487 {
 488         return get_irn_n(irg->anchor, idx);
 489 }
 490
 491 /**
 492  * Set anchor for given index
 493  */
 494 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
 495 {
 496         set_irn_n(irg->anchor, idx, irn);
 497 }
 498
 499
 500
 501 /**
 502  * Register a phase on an irg.
 503  * The phase will then be managed by the irg. This means you can easily
 504  * access the phase when you only have a graph handle, the memory will be
 505  * freed when the graph is freed and some care is taken that the phase data
 506  * will be invalidated/preserved on events like dead code elemination and
 507  * code selection.
 508  */
 509 void irg_register_phase(ir_graph *irg, ir_phase_id id, ir_phase *phase);
 510
 511 /**
 512  * Frees all phase infos attached to an irg
 513  */
 514 void irg_invalidate_phases(ir_graph *irg);
 515
 516 /**
 517  * return phase with given id
 518  */
 519 static inline ir_phase *irg_get_phase(const ir_graph *irg, ir_phase_id id)
 520 {
 521         assert(id <= PHASE_LAST);
 522         return irg->phases[id];
 523 }
 524
 525
 526 #define is_ir_graph(thing)                    _is_ir_graph(thing)
 527 #define get_irg_start_block(irg)              _get_irg_start_block(irg)
 528 #define set_irg_start_block(irg, node)        _set_irg_start_block(irg, node)
 529 #define get_irg_start(irg)                    _get_irg_start(irg)
 530 #define set_irg_start(irg, node)              _set_irg_start(irg, node)
 531 #define get_irg_end_block(irg)                _get_irg_end_block(irg)
 532 #define set_irg_end_block(irg, node)          _set_irg_end_block(irg, node)
 533 #define get_irg_end(irg)                      _get_irg_end(irg)
 534 #define set_irg_end(irg, node)                _set_irg_end(irg, node)
 535 #define get_irg_initial_exec(irg)             _get_irg_initial_exec(irg)
 536 #define set_irg_initial_exec(irg, node)       _set_irg_initial_exec(irg, node)
 537 #define get_irg_frame(irg)                    _get_irg_frame(irg)
 538 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
 539 #define get_irg_tls(irg)                      _get_irg_tls(irg)
 540 #define set_irg_tls(irg, node)                _set_irg_tls(irg, node)
 541 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
 542 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
 543 #define get_irg_args(irg)                     _get_irg_args(irg)
 544 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
 545 #define get_irg_bad(irg)                      _get_irg_bad(irg)
 546 #define set_irg_bad(irg, node)                _set_irg_bad(irg, node)
 547 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
 548 #define set_irn_no_mem(irg, node)             _set_irn_no_mem(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 #define get_idx_irn(irg, idx)                 _get_idx_irn(irg, idx)
 585 #define set_irg_state(irg, state)             _set_irg_state(irg, state)
 586 #define clear_irg_state(irg, state)           _clear_irg_state(irg, state)
 587 #define is_irg_state(irg, state)              _is_irg_state(irg, state)
 588
 589 #endif