2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Entry point to the representation of procedure code -- internal header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_IR_IRGRAPH_T_H
27 #define FIRM_IR_IRGRAPH_T_H
29 #include "firm_types.h"
32 #include "firm_common_t.h"
35 #include "pseudo_irg.h"
38 #include "iredgekinds.h"
46 /** Suffix that is added to every frame type. */
47 #define FRAME_TP_SUFFIX "frame_tp"
50 * Initializes the graph construction module.
52 void firm_init_irgraph(void);
55 * Internal constructor that does not add to irp_irgs or the like.
57 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
60 * Make a rudimentary ir graph for the constant code.
61 * Must look like a correct irg, spare everything else.
63 ir_graph *new_const_code_irg(void);
66 * Create a new graph that is a copy of a given one.
67 * Uses the link fields of the original graphs.
69 * @param irg The graph that must be copied.
71 ir_graph *create_irg_copy(ir_graph *irg);
74 * Set the op_pin_state_pinned state of a graph.
76 * @param irg the IR graph
77 * @param p new pin state
79 void set_irg_pinned(ir_graph *irg, op_pin_state p);
81 /** Returns the obstack associated with the graph. */
82 struct obstack *get_irg_obstack(const ir_graph *irg);
85 * Returns true if the node n is allocated on the storage of graph irg.
87 * @param irg the IR graph
88 * @param n the IR node
90 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
92 /*-------------------------------------------------------------------*/
93 /* inline functions for graphs */
94 /*-------------------------------------------------------------------*/
97 _is_ir_graph(const void *thing) {
98 return (get_kind(thing) == k_ir_graph);
101 /** Returns the start block of a graph. */
102 static INLINE ir_node *
103 _get_irg_start_block(const ir_graph *irg) {
104 return get_irn_intra_n(irg->anchor, anchor_start_block);
108 _set_irg_start_block(ir_graph *irg, ir_node *node) {
109 set_irn_n(irg->anchor, anchor_start_block, node);
112 static INLINE ir_node *
113 _get_irg_start(const ir_graph *irg) {
114 return get_irn_intra_n(irg->anchor, anchor_start);
118 _set_irg_start(ir_graph *irg, ir_node *node) {
119 set_irn_n(irg->anchor, anchor_start, node);
122 static INLINE ir_node *
123 _get_irg_end_block(const ir_graph *irg) {
124 return get_irn_intra_n(irg->anchor, anchor_end_block);
128 _set_irg_end_block(ir_graph *irg, ir_node *node) {
129 set_irn_n(irg->anchor, -1, node);
130 set_irn_n(irg->anchor, anchor_end_block, node);
133 static INLINE ir_node *
134 _get_irg_end(const ir_graph *irg) {
135 return get_irn_intra_n(irg->anchor, anchor_end);
139 _set_irg_end(ir_graph *irg, ir_node *node) {
140 set_irn_n(irg->anchor, anchor_end, node);
143 static INLINE ir_node *
144 _get_irg_end_reg(const ir_graph *irg) {
145 return get_irn_intra_n(irg->anchor, anchor_end_reg);
149 _set_irg_end_reg(ir_graph *irg, ir_node *node) {
150 set_irn_n(irg->anchor, anchor_end_reg, node);
153 static INLINE ir_node *
154 _get_irg_end_except(const ir_graph *irg) {
155 return get_irn_intra_n(irg->anchor, anchor_end_except);
159 _set_irg_end_except(ir_graph *irg, ir_node *node) {
160 set_irn_n(irg->anchor, anchor_end_except, node);
163 static INLINE ir_node *
164 _get_irg_frame(const ir_graph *irg) {
165 return get_irn_intra_n(irg->anchor, anchor_frame);
169 _set_irg_frame(ir_graph *irg, ir_node *node) {
170 set_irn_n(irg->anchor, anchor_frame, node);
173 static INLINE ir_node *
174 _get_irg_globals(const ir_graph *irg) {
175 return get_irn_intra_n(irg->anchor, anchor_globals);
179 _set_irg_globals(ir_graph *irg, ir_node *node) {
180 set_irn_n(irg->anchor, anchor_globals, node);
183 static INLINE ir_node *
184 _get_irg_tls(const ir_graph *irg) {
185 return get_irn_intra_n(irg->anchor, anchor_tls);
189 _set_irg_tls(ir_graph *irg, ir_node *node) {
190 set_irn_n(irg->anchor, anchor_tls, node);
193 static INLINE ir_node *
194 _get_irg_initial_mem(const ir_graph *irg) {
195 return get_irn_intra_n(irg->anchor, anchor_initial_mem);
199 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
200 set_irn_n(irg->anchor, anchor_initial_mem, node);
203 static INLINE ir_node *
204 _get_irg_args(const ir_graph *irg) {
205 return get_irn_intra_n(irg->anchor, anchor_args);
209 _set_irg_args(ir_graph *irg, ir_node *node) {
210 set_irn_n(irg->anchor, anchor_args, node);
213 static INLINE ir_node *
214 _get_irg_value_param_base(const ir_graph *irg) {
215 return get_irn_intra_n(irg->anchor, anchor_value_param_base);
219 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
220 set_irn_n(irg->anchor, anchor_value_param_base, node);
223 static INLINE ir_node *
224 _get_irg_bad(const ir_graph *irg) {
225 return get_irn_intra_n(irg->anchor, anchor_bad);
229 _set_irg_bad(ir_graph *irg, ir_node *node) {
230 set_irn_n(irg->anchor, anchor_bad, node);
233 static INLINE ir_node *
234 _get_irg_no_mem(const ir_graph *irg) {
235 return get_irn_intra_n(irg->anchor, anchor_no_mem);
239 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
240 set_irn_n(irg->anchor, anchor_no_mem, node);
243 static INLINE ir_node *
244 _get_irg_current_block(const ir_graph *irg) {
245 return irg->current_block;
249 _set_irg_current_block(ir_graph *irg, ir_node *node) {
250 irg->current_block = node;
253 static INLINE ir_entity *
254 _get_irg_entity(const ir_graph *irg) {
255 assert(irg && irg->ent);
260 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
264 static INLINE ir_type *
265 _get_irg_frame_type(ir_graph *irg) {
266 assert(irg && irg->frame_type);
267 return irg->frame_type = skip_tid(irg->frame_type);
271 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
272 assert(is_frame_type(ftp));
273 irg->frame_type = ftp;
276 static INLINE struct obstack *
277 _get_irg_obstack(const ir_graph *irg) {
282 static INLINE irg_phase_state
283 _get_irg_phase_state(const ir_graph *irg) {
284 return irg->phase_state;
288 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
289 irg->phase_state = state;
292 static INLINE op_pin_state
293 _get_irg_pinned(const ir_graph *irg) {
294 return irg->irg_pinned_state;
297 static INLINE irg_outs_state
298 _get_irg_outs_state(const ir_graph *irg) {
299 return irg->outs_state;
303 _set_irg_outs_inconsistent(ir_graph *irg) {
304 if (irg->outs_state == outs_consistent)
305 irg->outs_state = outs_inconsistent;
308 static INLINE irg_extblk_state
309 _get_irg_extblk_state(const ir_graph *irg) {
310 return irg->extblk_state;
314 _set_irg_extblk_inconsistent(ir_graph *irg) {
315 if (irg->extblk_state == extblk_valid)
316 irg->extblk_state = extblk_invalid;
319 static INLINE irg_dom_state
320 _get_irg_dom_state(const ir_graph *irg) {
321 return irg->dom_state;
324 static INLINE irg_dom_state
325 _get_irg_postdom_state(const ir_graph *irg) {
326 return irg->pdom_state;
330 _set_irg_doms_inconsistent(ir_graph *irg) {
331 if (irg->dom_state != dom_none)
332 irg->dom_state = dom_inconsistent;
333 if (irg->pdom_state != dom_none)
334 irg->pdom_state = dom_inconsistent;
337 static INLINE irg_loopinfo_state
338 _get_irg_loopinfo_state(const ir_graph *irg) {
339 return irg->loopinfo_state;
343 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
344 irg->loopinfo_state = s;
348 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
349 irg->loopinfo_state &= ~loopinfo_valid;
353 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
354 irg->irg_pinned_state = p;
357 static INLINE irg_callee_info_state
358 _get_irg_callee_info_state(const ir_graph *irg) {
359 return irg->callee_info_state;
363 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
364 irg_callee_info_state irp_state = get_irp_callee_info_state();
366 irg->callee_info_state = s;
368 /* I could compare ... but who knows? */
369 if ((irp_state == irg_callee_info_consistent) ||
370 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
371 set_irp_callee_info_state(s);
374 static INLINE irg_inline_property
375 _get_irg_inline_property(const ir_graph *irg) {
376 return irg->inline_property;
380 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
381 irg->inline_property = s;
384 static INLINE unsigned
385 _get_irg_additional_properties(const ir_graph *irg) {
386 if (irg->additional_properties & mtp_property_inherited)
387 return get_method_additional_properties(get_entity_type(irg->ent));
388 return irg->additional_properties;
392 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
393 irg->additional_properties = mask & ~mtp_property_inherited;
397 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
398 unsigned prop = irg->additional_properties;
400 if (prop & mtp_property_inherited)
401 prop = get_method_additional_properties(get_entity_type(irg->ent));
402 irg->additional_properties = prop | flag;
406 _set_irg_link(ir_graph *irg, void *thing) {
411 _get_irg_link(const ir_graph *irg) {
415 static INLINE unsigned long
416 _get_irg_visited(const ir_graph *irg) {
420 static INLINE unsigned long
421 _get_irg_block_visited(const ir_graph *irg) {
422 return irg->block_visited;
426 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
427 irg->block_visited = visited;
431 _inc_irg_block_visited(ir_graph *irg) {
432 ++irg->block_visited;
436 _dec_irg_block_visited(ir_graph *irg) {
437 --irg->block_visited;
440 static INLINE unsigned
441 _get_irg_estimated_node_cnt(const ir_graph *irg) {
442 return irg->estimated_node_count;
445 /* Return the floating point model of this graph. */
446 static INLINE unsigned
447 _get_irg_fp_model(const ir_graph *irg) {
448 return irg->fp_model;
452 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
453 * @param irg The graph.
454 * @param irn The node.
455 * @return The index allocated for the node.
457 static INLINE unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn) {
458 unsigned idx = irg->last_node_idx++;
459 if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
460 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
462 irg->idx_irn_map[idx] = irn;
467 * Kill a node from the irg. BEWARE: this kills
468 * all later created nodes.
471 irg_kill_node(ir_graph *irg, ir_node *n) {
472 unsigned idx = get_irn_idx(n);
473 assert(idx + 1 == irg->last_node_idx);
475 if (idx + 1 == irg->last_node_idx)
476 --irg->last_node_idx;
477 irg->idx_irn_map[idx] = NULL;
478 obstack_free(irg->obst, n);
482 * Get the node for an index.
483 * @param irg The graph.
484 * @param idx The index you want the node for.
485 * @return The node with that index or NULL, if there is no node with that index.
486 * @note The node you got might be dead.
488 static INLINE ir_node *
489 get_idx_irn(ir_graph *irg, unsigned idx) {
490 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
491 return irg->idx_irn_map[idx];
495 * Return the number of anchors in this graph.
498 get_irg_n_anchors(const ir_graph *irg) {
499 return get_irn_arity(irg->anchor);
503 * Return anchor for given index
505 static INLINE ir_node *
506 get_irg_anchor(const ir_graph *irg, int idx) {
507 return get_irn_intra_n(irg->anchor, idx);
511 * Set anchor for given index
514 set_irg_anchor(ir_graph *irg, int idx, ir_node *irn) {
515 set_irn_n(irg->anchor, idx, irn);
518 #ifdef INTERPROCEDURAL_VIEW
519 extern int firm_interprocedural_view;
522 _get_interprocedural_view(void) {
523 return firm_interprocedural_view;
526 #define get_interprocedural_view() _get_interprocedural_view()
529 #define is_ir_graph(thing) _is_ir_graph(thing)
530 #define get_irg_start_block(irg) _get_irg_start_block(irg)
531 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
532 #define get_irg_start(irg) _get_irg_start(irg)
533 #define set_irg_start(irg, node) _set_irg_start(irg, node)
534 #define get_irg_end_block(irg) _get_irg_end_block(irg)
535 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
536 #define get_irg_end(irg) _get_irg_end(irg)
537 #define set_irg_end(irg, node) _set_irg_end(irg, node)
538 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
539 #define set_irg_end_reg(irg, node) _set_irg_end_reg(irg, node)
540 #define get_irg_end_except(irg) _get_irg_end_except(irg)
541 #define set_irg_end_except(irg, node) _set_irg_end_except(irg, node)
542 #define get_irg_frame(irg) _get_irg_frame(irg)
543 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
544 #define get_irg_globals(irg) _get_irg_globals(irg)
545 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
546 #define get_irg_tls(irg) _get_irg_tls(irg)
547 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
548 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
549 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
550 #define get_irg_args(irg) _get_irg_args(irg)
551 #define set_irg_args(irg, node) _set_irg_args(irg, node)
552 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
553 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
554 #define get_irg_bad(irg) _get_irg_bad(irg)
555 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
556 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
557 #define set_irn_no_mem(irg, node) _set_irn_no_mem(irg, node)
558 #define get_irg_current_block(irg) _get_irg_current_block(irg)
559 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
560 #define get_irg_entity(irg) _get_irg_entity(irg)
561 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
562 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
563 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
564 #define get_irg_obstack(irg) _get_irg_obstack(irg)
565 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
566 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
567 #define get_irg_pinned(irg) _get_irg_pinned(irg)
568 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
569 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
570 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
571 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
572 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
573 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
574 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
575 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
576 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
577 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
578 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
579 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
580 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
581 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
582 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
583 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
584 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
585 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
586 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
587 #define get_irg_link(irg) _get_irg_link(irg)
588 #define get_irg_visited(irg) _get_irg_visited(irg)
589 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
590 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
591 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
592 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
593 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
594 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)