2 * Copyright (C) 1995-2007 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);
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);
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);
62 * Set the op_pin_state_pinned state of a graph.
64 * @param irg the IR graph
65 * @param p new pin state
68 set_irg_pinned (ir_graph *irg, op_pin_state p);
70 /** Returns the obstack associated with the graph. */
71 struct obstack *get_irg_obstack(const ir_graph *irg);
74 * Returns true if the node n is allocated on the storage of graph irg.
76 * @param irg the IR graph
77 * @param n the IR node
79 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
81 /*-------------------------------------------------------------------*/
82 /* inline functions for graphs */
83 /*-------------------------------------------------------------------*/
85 extern int firm_interprocedural_view;
88 _get_interprocedural_view(void) {
89 return firm_interprocedural_view;
93 _is_ir_graph(const void *thing) {
94 return (get_kind(thing) == k_ir_graph);
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);
104 _set_irg_start_block(ir_graph *irg, ir_node *node) {
105 set_irn_n(irg->anchor, anchor_start_block, node);
108 static INLINE ir_node *
109 _get_irg_start(const ir_graph *irg) {
110 return get_irn_intra_n(irg->anchor, anchor_start);
114 _set_irg_start(ir_graph *irg, ir_node *node) {
115 set_irn_n(irg->anchor, anchor_start, node);
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);
124 _set_irg_end_block(ir_graph *irg, ir_node *node) {
125 set_irn_n(irg->anchor, -1, node);
126 set_irn_n(irg->anchor, anchor_end_block, node);
129 static INLINE ir_node *
130 _get_irg_end(const ir_graph *irg) {
131 return get_irn_intra_n(irg->anchor, anchor_end);
135 _set_irg_end(ir_graph *irg, ir_node *node) {
136 set_irn_n(irg->anchor, anchor_end, node);
139 static INLINE ir_node *
140 _get_irg_end_reg(const ir_graph *irg) {
141 return get_irn_intra_n(irg->anchor, anchor_end_reg);
145 _set_irg_end_reg(ir_graph *irg, ir_node *node) {
146 set_irn_n(irg->anchor, anchor_end_reg, node);
149 static INLINE ir_node *
150 _get_irg_end_except(const ir_graph *irg) {
151 return get_irn_intra_n(irg->anchor, anchor_end_except);
155 _set_irg_end_except(ir_graph *irg, ir_node *node) {
156 set_irn_n(irg->anchor, anchor_end_except, node);
159 static INLINE ir_node *
160 _get_irg_frame(const ir_graph *irg) {
161 return get_irn_intra_n(irg->anchor, anchor_frame);
165 _set_irg_frame(ir_graph *irg, ir_node *node) {
166 set_irn_n(irg->anchor, anchor_frame, node);
169 static INLINE ir_node *
170 _get_irg_globals(const ir_graph *irg) {
171 return get_irn_intra_n(irg->anchor, anchor_globals);
175 _set_irg_globals(ir_graph *irg, ir_node *node) {
176 set_irn_n(irg->anchor, anchor_globals, node);
179 static INLINE ir_node *
180 _get_irg_tls(const ir_graph *irg) {
181 return get_irn_intra_n(irg->anchor, anchor_tls);
185 _set_irg_tls(ir_graph *irg, ir_node *node) {
186 set_irn_n(irg->anchor, anchor_tls, node);
189 static INLINE ir_node *
190 _get_irg_initial_mem(const ir_graph *irg) {
191 return get_irn_intra_n(irg->anchor, anchor_initial_mem);
195 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
196 set_irn_n(irg->anchor, anchor_initial_mem, node);
199 static INLINE ir_node *
200 _get_irg_args(const ir_graph *irg) {
201 return get_irn_intra_n(irg->anchor, anchor_args);
205 _set_irg_args(ir_graph *irg, ir_node *node) {
206 set_irn_n(irg->anchor, anchor_args, node);
209 static INLINE ir_node *
210 _get_irg_value_param_base(const ir_graph *irg) {
211 return get_irn_intra_n(irg->anchor, anchor_value_param_base);
215 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
216 set_irn_n(irg->anchor, anchor_value_param_base, node);
219 static INLINE ir_node **
220 _get_irg_proj_args(const ir_graph *irg) {
221 return irg->proj_args;
225 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
226 irg->proj_args = nodes;
229 static INLINE ir_node *
230 _get_irg_bad(const ir_graph *irg) {
231 return get_irn_intra_n(irg->anchor, anchor_bad);
235 _set_irg_bad(ir_graph *irg, ir_node *node) {
236 set_irn_n(irg->anchor, anchor_bad, node);
239 static INLINE ir_node *
240 _get_irg_no_mem(const ir_graph *irg) {
241 return get_irn_intra_n(irg->anchor, anchor_no_mem);
245 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
246 set_irn_n(irg->anchor, anchor_no_mem, node);
249 static INLINE ir_node *
250 _get_irg_current_block(const ir_graph *irg) {
251 return irg->current_block;
255 _set_irg_current_block(ir_graph *irg, ir_node *node) {
256 irg->current_block = node;
259 static INLINE ir_entity *
260 _get_irg_entity(const ir_graph *irg) {
261 assert(irg && irg->ent);
266 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
270 static INLINE ir_type *
271 _get_irg_frame_type(ir_graph *irg) {
272 assert(irg && irg->frame_type);
273 return irg->frame_type = skip_tid(irg->frame_type);
277 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
278 assert(is_frame_type(ftp));
279 irg->frame_type = ftp;
282 static INLINE struct obstack *
283 _get_irg_obstack(const ir_graph *irg) {
288 static INLINE irg_phase_state
289 _get_irg_phase_state(const ir_graph *irg) {
290 return irg->phase_state;
294 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
295 irg->phase_state = state;
298 static INLINE op_pin_state
299 _get_irg_pinned(const ir_graph *irg) {
300 return irg->irg_pinned_state;
303 static INLINE irg_outs_state
304 _get_irg_outs_state(const ir_graph *irg) {
305 return irg->outs_state;
309 _set_irg_outs_inconsistent(ir_graph *irg) {
310 if (irg->outs_state == outs_consistent)
311 irg->outs_state = outs_inconsistent;
314 static INLINE irg_extblk_state
315 _get_irg_extblk_state(const ir_graph *irg) {
316 return irg->extblk_state;
320 _set_irg_extblk_inconsistent(ir_graph *irg) {
321 if (irg->extblk_state == extblk_valid)
322 irg->extblk_state = extblk_invalid;
325 static INLINE irg_dom_state
326 _get_irg_dom_state(const ir_graph *irg) {
327 return irg->dom_state;
330 static INLINE irg_dom_state
331 _get_irg_postdom_state(const ir_graph *irg) {
332 return irg->pdom_state;
336 _set_irg_doms_inconsistent(ir_graph *irg) {
337 if (irg->dom_state != dom_none)
338 irg->dom_state = dom_inconsistent;
339 if (irg->pdom_state != dom_none)
340 irg->pdom_state = dom_inconsistent;
343 static INLINE irg_loopinfo_state
344 _get_irg_loopinfo_state(const ir_graph *irg) {
345 return irg->loopinfo_state;
349 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
350 irg->loopinfo_state = s;
354 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
355 irg->loopinfo_state &= ~loopinfo_valid;
359 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
360 irg->irg_pinned_state = p;
363 static INLINE irg_callee_info_state
364 _get_irg_callee_info_state(const ir_graph *irg) {
365 return irg->callee_info_state;
369 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
370 irg_callee_info_state irp_state = get_irp_callee_info_state();
372 irg->callee_info_state = s;
374 /* I could compare ... but who knows? */
375 if ((irp_state == irg_callee_info_consistent) ||
376 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
377 set_irp_callee_info_state(s);
380 static INLINE irg_inline_property
381 _get_irg_inline_property(const ir_graph *irg) {
382 return irg->inline_property;
386 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
387 irg->inline_property = s;
390 static INLINE unsigned
391 _get_irg_additional_properties(const ir_graph *irg) {
392 if (irg->additional_properties & mtp_property_inherited)
393 return get_method_additional_properties(get_entity_type(irg->ent));
394 return irg->additional_properties;
398 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
399 irg->additional_properties = mask & ~mtp_property_inherited;
403 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
404 unsigned prop = irg->additional_properties;
406 if (prop & mtp_property_inherited)
407 prop = get_method_additional_properties(get_entity_type(irg->ent));
408 irg->additional_properties = prop | flag;
412 _set_irg_link(ir_graph *irg, void *thing) {
417 _get_irg_link(const ir_graph *irg) {
421 static INLINE unsigned long
422 _get_irg_visited(const ir_graph *irg) {
426 static INLINE unsigned long
427 _get_irg_block_visited(const ir_graph *irg) {
428 return irg->block_visited;
432 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
433 irg->block_visited = visited;
437 _inc_irg_block_visited(ir_graph *irg) {
438 ++irg->block_visited;
442 _dec_irg_block_visited(ir_graph *irg) {
443 --irg->block_visited;
446 static INLINE unsigned
447 _get_irg_estimated_node_cnt(const ir_graph *irg) {
448 return irg->estimated_node_count;
451 /* Return the floating point model of this graph. */
452 static INLINE unsigned
453 _get_irg_fp_model(const ir_graph *irg) {
454 return irg->fp_model;
458 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
459 * @param irg The graph.
460 * @param irn The node.
461 * @return The index allocated for the node.
463 static INLINE unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn) {
464 unsigned idx = irg->last_node_idx++;
465 if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
466 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
468 irg->idx_irn_map[idx] = irn;
473 * Kill a node from the irg. BEWARE: this kills
474 * all later created nodes.
477 irg_kill_node(ir_graph *irg, ir_node *n) {
478 unsigned idx = get_irn_idx(n);
479 assert(idx + 1 == irg->last_node_idx);
481 if (idx + 1 == irg->last_node_idx)
482 --irg->last_node_idx;
483 irg->idx_irn_map[idx] = NULL;
484 obstack_free(irg->obst, n);
488 * Get the node for an index.
489 * @param irg The graph.
490 * @param idx The index you want the node for.
491 * @return The node with that index or NULL, if there is no node with that index.
492 * @note The node you got might be dead.
494 static INLINE ir_node *
495 get_idx_irn(ir_graph *irg, unsigned idx) {
496 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
497 return irg->idx_irn_map[idx];
501 * Return the number of anchors in this graph.
504 get_irg_n_anchors(const ir_graph *irg) {
505 return get_irn_arity(irg->anchor);
509 * Return anchor for given index
511 static INLINE ir_node *
512 get_irg_anchor(const ir_graph *irg, int idx) {
513 return get_irn_intra_n(irg->anchor, idx);
517 * Set anchor for given index
520 set_irg_anchor(ir_graph *irg, int idx, ir_node *irn) {
521 set_irn_n(irg->anchor, idx, irn);
525 #define get_interprocedural_view() _get_interprocedural_view()
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_end_reg(irg) _get_irg_end_reg(irg)
536 #define set_irg_end_reg(irg, node) _set_irg_end_reg(irg, node)
537 #define get_irg_end_except(irg) _get_irg_end_except(irg)
538 #define set_irg_end_except(irg, node) _set_irg_end_except(irg, node)
539 #define get_irg_frame(irg) _get_irg_frame(irg)
540 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
541 #define get_irg_globals(irg) _get_irg_globals(irg)
542 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
543 #define get_irg_tls(irg) _get_irg_tls(irg)
544 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
545 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
546 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
547 #define get_irg_args(irg) _get_irg_args(irg)
548 #define set_irg_args(irg, node) _set_irg_args(irg, node)
549 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
550 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
551 #define get_irg_bad(irg) _get_irg_bad(irg)
552 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
553 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
554 #define set_irn_no_mem(irg, node) _set_irn_no_mem(irg, node)
555 #define get_irg_current_block(irg) _get_irg_current_block(irg)
556 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
557 #define get_irg_entity(irg) _get_irg_entity(irg)
558 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
559 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
560 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
561 #define get_irg_obstack(irg) _get_irg_obstack(irg)
562 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
563 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
564 #define get_irg_pinned(irg) _get_irg_pinned(irg)
565 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
566 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
567 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
568 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
569 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
570 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
571 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
572 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
573 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
574 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
575 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
576 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
577 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
578 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
579 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
580 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
581 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
582 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
583 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
584 #define get_irg_link(irg) _get_irg_link(irg)
585 #define get_irg_visited(irg) _get_irg_visited(irg)
586 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
587 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
588 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
589 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
590 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
591 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)