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"
33 #include "irtypeinfo.h"
35 #include "pseudo_irg.h"
38 #include "iredgekinds.h"
42 #include "execution_frequency.h"
48 /** Prefix that is added to every frame type. */
49 #define FRAME_TP_SUFFIX "frame_tp"
52 * Edge info to put into an irg.
54 typedef struct _irg_edge_info_t {
55 set *edges; /**< a set containing all edges of a graph. */
56 unsigned activated : 1; /**< set if edges are activated for the graph. */
59 typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
62 * Index constants for nodes that can be accessed through the graph itself.
65 anchor_start_block = 0, /**< block the start node will belong to */
66 anchor_start, /**< start node of this ir_graph */
67 anchor_end_block, /**< block the end node will belong to */
68 anchor_end, /**< end node of this ir_graph */
69 anchor_end_reg, /**< end node of this ir_graph */
70 anchor_end_except, /**< end node of this ir_graph */
71 anchor_frame, /**< method's frame */
72 anchor_globals, /**< pointer to the data segment containing all
73 globals as well as global procedures. */
74 anchor_tls, /**< pointer to the thread local storage containing all
76 anchor_initial_mem, /**< initial memory of this graph */
77 anchor_args, /**< methods arguments */
78 anchor_value_param_base, /**< method value param base */
79 anchor_bad, /**< bad node of this ir_graph, the one and
81 anchor_no_mem, /**< NoMem node of this ir_graph, the one and only in this graph */
85 /** A callgraph entry for callees. */
86 typedef struct cg_callee_entry {
87 ir_graph *irg; /**< The called irg. */
88 ir_node **call_list; /**< The list of all calls to the irg. */
89 int max_depth; /**< Maximum depth of all Call nodes to irg. */
93 * An ir_graph holds all information for a procedure.
96 firm_kind kind; /**< Always set to k_ir_graph. */
97 /* -- Basics of the representation -- */
98 ir_entity *ent; /**< The entity of this procedure, i.e.,
99 the type of the procedure and the
100 class it belongs to. */
101 ir_type *frame_type; /**< A class type representing the stack frame.
102 Can include "inner" methods. */
103 ir_node *anchors[anchor_max]; /**< List of anchor nodes. */
104 ir_node **proj_args; /**< Projs of the methods arguments. */
105 struct obstack *obst; /**< The obstack where all of the ir_nodes live. */
106 ir_node *current_block; /**< Current block for newly gen_*()-erated ir_nodes. */
107 struct obstack *extbb_obst; /**< The obstack for extended basic block info. */
109 unsigned last_node_idx; /**< The last IR node index for this graph. */
111 /* -- Fields for graph properties -- */
112 irg_inline_property inline_property; /**< How to handle inlineing. */
113 unsigned additional_properties; /**< Additional graph properties. */
115 /* -- Fields indicating different states of irgraph -- */
116 irg_phase_state phase_state; /**< Compiler phase. */
117 op_pin_state irg_pinned_state; /**< Flag for status of nodes. */
118 irg_outs_state outs_state; /**< Out edges. */
119 irg_dom_state dom_state; /**< Dominator state information. */
120 irg_dom_state pdom_state; /**< Post Dominator state information. */
121 ir_typeinfo_state typeinfo_state; /**< Validity of type information. */
122 irg_callee_info_state callee_info_state; /**< Validity of callee information. */
123 irg_loopinfo_state loopinfo_state; /**< State of loop information. */
124 ir_class_cast_state class_cast_state; /**< Kind of cast operations in code. */
125 irg_extblk_info_state extblk_state; /**< State of extended basic block info. */
126 exec_freq_state execfreq_state; /**< Execution frequency state. */
127 ir_address_taken_computed_state adr_taken_state; /**< Address taken state. */
128 unsigned mem_disambig_opt; /**< Options for the memory disambiguator. */
129 unsigned fp_model; /**< floating point model of the graph. */
131 /* -- Fields for construction -- */
132 #if USE_EXPLICIT_PHI_IN_STACK
133 struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
135 int n_loc; /**< Number of local variables in this
136 procedure including procedure parameters. */
137 void **loc_descriptions; /**< Storage for local variable descriptions. */
139 /* -- Fields for optimizations / analysis information -- */
140 pset *value_table; /**< Hash table for global value numbering (cse)
141 for optimizing use in iropt.c */
142 ir_node **outs; /**< Space for the out arrays. */
144 ir_loop *loop; /**< The outermost loop for this graph. */
145 void *link; /**< A void* field to link any information to
148 ir_graph **callers; /**< For callgraph analysis: list of caller graphs. */
149 unsigned char *caller_isbe; /**< For callgraph analysis: set if backedge. */
150 cg_callee_entry **callees; /**< For callgraph analysis: list of callee calls */
151 unsigned char *callee_isbe; /**< For callgraph analysis: set if backedge. */
152 int callgraph_loop_depth; /**< For callgraph analysis */
153 int callgraph_recursion_depth; /**< For callgraph analysis */
154 double method_execution_frequency; /**< For callgraph analysis */
156 ir_loop *l; /**< For callgraph analysis. */
158 /* -- Fields for Walking the graph -- */
159 unsigned long visited; /**< this flag is an identifier for
160 ir walk. it will be incremented
161 every time someone walks through
163 unsigned long block_visited; /**< same as visited, for a complete block */
165 unsigned estimated_node_count; /**< estimated number of nodes in this graph,
166 updated after every walk */
167 irg_edges_info_t edge_info; /**< edge info for automatic outs */
168 ir_node **idx_irn_map; /**< Array mapping node indexes to nodes. */
171 int n_outs; /**< Size wasted for outs */
172 long graph_nr; /**< a unique graph number for each graph to make output
177 unsigned using_visited : 1; /**< set to 1 if we are currently using the visited flag */
178 unsigned using_block_visited : 1; /**< set to 1 if we are currently using the block_visited flag */
179 unsigned using_irn_link : 1; /**< set to 1 if we are currently using the irn_link fields */
184 * Initializes the graph construction module
186 void firm_init_irgraph(void);
188 /* Internal constructor that does not add to irp_irgs or the like. */
189 ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
191 /** Make a rudimentary ir graph for the constant code.
192 Must look like a correct irg, spare everything else. */
193 ir_graph *new_const_code_irg(void);
196 * Set the op_pin_state_pinned state of a graph.
198 * @param irg the IR graph
199 * @param p new pin state
202 set_irg_pinned (ir_graph *irg, op_pin_state p);
204 /** Returns the obstack associated with the graph. */
205 struct obstack *get_irg_obstack(const ir_graph *irg);
208 * Returns true if the node n is allocated on the storage of graph irg.
210 * @param irg the IR graph
211 * @param n the IR node
213 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
215 /*-------------------------------------------------------------------*/
216 /* inline functions for graphs */
217 /*-------------------------------------------------------------------*/
219 extern int firm_interprocedural_view;
222 _get_interprocedural_view(void) {
223 return firm_interprocedural_view;
227 _is_ir_graph(const void *thing) {
228 return (get_kind(thing) == k_ir_graph);
231 /** Returns the start block of a graph. */
232 static INLINE ir_node *
233 _get_irg_start_block(const ir_graph *irg) {
234 return irg->anchors[anchor_start_block];
238 _set_irg_start_block(ir_graph *irg, ir_node *node) {
239 irg->anchors[anchor_start_block] = node;
242 static INLINE ir_node *
243 _get_irg_start(const ir_graph *irg) {
244 return irg->anchors[anchor_start];
248 _set_irg_start(ir_graph *irg, ir_node *node) {
249 irg->anchors[anchor_start] = node;
252 static INLINE ir_node *
253 _get_irg_end_block(const ir_graph *irg) {
254 return irg->anchors[anchor_end_block];
258 _set_irg_end_block(ir_graph *irg, ir_node *node) {
259 irg->anchors[anchor_end_block] = node;
262 static INLINE ir_node *
263 _get_irg_end(const ir_graph *irg) {
264 return irg->anchors[anchor_end];
268 _set_irg_end(ir_graph *irg, ir_node *node) {
269 irg->anchors[anchor_end] = node;
272 static INLINE ir_node *
273 _get_irg_end_reg(const ir_graph *irg) {
274 return irg->anchors[anchor_end_reg];
277 static INLINE ir_node *
278 _get_irg_end_except (const ir_graph *irg) {
279 return irg->anchors[anchor_end_except];
282 static INLINE ir_node *
283 _get_irg_frame(const ir_graph *irg) {
284 return irg->anchors[anchor_frame];
288 _set_irg_frame(ir_graph *irg, ir_node *node) {
289 irg->anchors[anchor_frame] = node;
292 static INLINE ir_node *
293 _get_irg_globals(const ir_graph *irg) {
294 return irg->anchors[anchor_globals];
298 _set_irg_globals(ir_graph *irg, ir_node *node) {
299 irg->anchors[anchor_globals] = node;
302 static INLINE ir_node *
303 _get_irg_tls(const ir_graph *irg) {
304 return irg->anchors[anchor_tls];
308 _set_irg_tls(ir_graph *irg, ir_node *node) {
309 irg->anchors[anchor_tls] = node;
312 static INLINE ir_node *
313 _get_irg_initial_mem(const ir_graph *irg) {
314 return irg->anchors[anchor_initial_mem];
318 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
319 irg->anchors[anchor_initial_mem] = node;
322 static INLINE ir_node *
323 _get_irg_args(const ir_graph *irg) {
324 return irg->anchors[anchor_args];
328 _set_irg_args(ir_graph *irg, ir_node *node) {
329 irg->anchors[anchor_args] = node;
332 static INLINE ir_node *
333 _get_irg_value_param_base(const ir_graph *irg) {
334 return irg->anchors[anchor_value_param_base];
338 _set_irg_value_param_base(ir_graph *irg, ir_node *node) {
339 irg->anchors[anchor_value_param_base] = node;
342 static INLINE ir_node **
343 _get_irg_proj_args(const ir_graph *irg) {
344 return irg->proj_args;
348 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
349 irg->proj_args = nodes;
352 static INLINE ir_node *
353 _get_irg_bad(const ir_graph *irg) {
354 return irg->anchors[anchor_bad];
358 _set_irg_bad(ir_graph *irg, ir_node *node) {
359 irg->anchors[anchor_bad] = node;
362 static INLINE ir_node *
363 _get_irg_no_mem(const ir_graph *irg) {
364 return irg->anchors[anchor_no_mem];
368 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
369 irg->anchors[anchor_no_mem] = node;
371 static INLINE ir_node *
372 _get_irg_current_block(const ir_graph *irg) {
373 return irg->current_block;
377 _set_irg_current_block(ir_graph *irg, ir_node *node) {
378 irg->current_block = node;
381 static INLINE ir_entity *
382 _get_irg_entity(const ir_graph *irg) {
383 assert(irg && irg->ent);
388 _set_irg_entity(ir_graph *irg, ir_entity *ent) {
392 static INLINE ir_type *
393 _get_irg_frame_type(ir_graph *irg) {
394 assert(irg && irg->frame_type);
395 return irg->frame_type = skip_tid(irg->frame_type);
399 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
400 assert(is_frame_type(ftp));
401 irg->frame_type = ftp;
404 static INLINE struct obstack *
405 _get_irg_obstack(const ir_graph *irg) {
410 static INLINE irg_phase_state
411 _get_irg_phase_state(const ir_graph *irg) {
412 return irg->phase_state;
416 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
417 irg->phase_state = state;
420 static INLINE op_pin_state
421 _get_irg_pinned(const ir_graph *irg) {
422 return irg->irg_pinned_state;
425 static INLINE irg_outs_state
426 _get_irg_outs_state(const ir_graph *irg) {
427 return irg->outs_state;
431 _set_irg_outs_inconsistent(ir_graph *irg) {
432 if (irg->outs_state == outs_consistent)
433 irg->outs_state = outs_inconsistent;
436 static INLINE irg_extblk_state
437 _get_irg_extblk_state(const ir_graph *irg) {
438 return irg->extblk_state;
442 _set_irg_extblk_inconsistent(ir_graph *irg) {
443 if (irg->extblk_state == extblk_valid)
444 irg->extblk_state = extblk_invalid;
447 static INLINE irg_dom_state
448 _get_irg_dom_state(const ir_graph *irg) {
449 return irg->dom_state;
452 static INLINE irg_dom_state
453 _get_irg_postdom_state(const ir_graph *irg) {
454 return irg->pdom_state;
458 _set_irg_doms_inconsistent(ir_graph *irg) {
459 if (irg->dom_state != dom_none)
460 irg->dom_state = dom_inconsistent;
461 if (irg->pdom_state != dom_none)
462 irg->pdom_state = dom_inconsistent;
465 static INLINE irg_loopinfo_state
466 _get_irg_loopinfo_state(const ir_graph *irg) {
467 return irg->loopinfo_state;
471 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
472 irg->loopinfo_state = s;
476 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
477 irg->loopinfo_state &= ~loopinfo_valid;
481 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
482 irg->irg_pinned_state = p;
485 static INLINE irg_callee_info_state
486 _get_irg_callee_info_state(const ir_graph *irg) {
487 return irg->callee_info_state;
491 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
492 irg_callee_info_state irp_state = get_irp_callee_info_state();
494 irg->callee_info_state = s;
496 /* I could compare ... but who knows? */
497 if ((irp_state == irg_callee_info_consistent) ||
498 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
499 set_irp_callee_info_state(s);
502 static INLINE irg_inline_property
503 _get_irg_inline_property(const ir_graph *irg) {
504 return irg->inline_property;
508 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
509 irg->inline_property = s;
512 static INLINE unsigned
513 _get_irg_additional_properties(const ir_graph *irg) {
514 if (irg->additional_properties & mtp_property_inherited)
515 return get_method_additional_properties(get_entity_type(irg->ent));
516 return irg->additional_properties;
520 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
521 irg->additional_properties = mask & ~mtp_property_inherited;
525 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
526 unsigned prop = irg->additional_properties;
528 if (prop & mtp_property_inherited)
529 prop = get_method_additional_properties(get_entity_type(irg->ent));
530 irg->additional_properties = prop | flag;
534 _set_irg_link(ir_graph *irg, void *thing) {
539 _get_irg_link(const ir_graph *irg) {
543 static INLINE unsigned long
544 _get_irg_visited(const ir_graph *irg) {
548 static INLINE unsigned long
549 _get_irg_block_visited(const ir_graph *irg) {
550 return irg->block_visited;
554 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
555 irg->block_visited = visited;
559 _inc_irg_block_visited(ir_graph *irg) {
560 ++irg->block_visited;
564 _dec_irg_block_visited(ir_graph *irg) {
565 --irg->block_visited;
568 static INLINE unsigned
569 _get_irg_estimated_node_cnt(const ir_graph *irg) {
570 return irg->estimated_node_count;
573 /* Return the floating point model of this graph. */
574 static INLINE unsigned
575 _get_irg_fp_model(const ir_graph *irg) {
576 return irg->fp_model;
580 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
581 * @param irg The graph.
582 * @param irn The node.
583 * @return The index allocated for the node.
585 static INLINE unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn) {
586 unsigned idx = irg->last_node_idx++;
587 if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
588 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
590 irg->idx_irn_map[idx] = irn;
595 * Kill a node from the irg. BEWARE: this kills
596 * all later created nodes.
599 irg_kill_node(ir_graph *irg, ir_node *n) {
600 unsigned idx = get_irn_idx(n);
601 assert(idx + 1 == irg->last_node_idx);
603 if (idx + 1 == irg->last_node_idx)
604 --irg->last_node_idx;
605 irg->idx_irn_map[idx] = NULL;
606 obstack_free(irg->obst, n);
610 * Get the node for an index.
611 * @param irg The graph.
612 * @param idx The index you want the node for.
613 * @return The node with that index or NULL, if there is no node with that index.
614 * @note The node you got might be dead.
616 static INLINE ir_node *
617 get_idx_irn(ir_graph *irg, unsigned idx) {
618 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
619 return irg->idx_irn_map[idx];
622 #define get_interprocedural_view() _get_interprocedural_view()
623 #define is_ir_graph(thing) _is_ir_graph(thing)
624 #define get_irg_start_block(irg) _get_irg_start_block(irg)
625 #define set_irg_start_block(irg, node) _set_irg_start_block(irg, node)
626 #define get_irg_start(irg) _get_irg_start(irg)
627 #define set_irg_start(irg, node) _set_irg_start(irg, node)
628 #define get_irg_end_block(irg) _get_irg_end_block(irg)
629 #define set_irg_end_block(irg, node) _set_irg_end_block(irg, node)
630 #define get_irg_end(irg) _get_irg_end(irg)
631 #define set_irg_end(irg, node) _set_irg_end(irg, node)
632 #define get_irg_end_reg(irg) _get_irg_end_reg(irg)
633 #define get_irg_end_except(irg) _get_irg_end_except(irg)
634 #define get_irg_frame(irg) _get_irg_frame(irg)
635 #define set_irg_frame(irg, node) _set_irg_frame(irg, node)
636 #define get_irg_globals(irg) _get_irg_globals(irg)
637 #define set_irg_globals(irg, node) _set_irg_globals(irg, node)
638 #define get_irg_tls(irg) _get_irg_tls(irg)
639 #define set_irg_tls(irg, node) _set_irg_tls(irg, node)
640 #define get_irg_initial_mem(irg) _get_irg_initial_mem(irg)
641 #define set_irg_initial_mem(irg, node) _set_irg_initial_mem(irg, node)
642 #define get_irg_args(irg) _get_irg_args(irg)
643 #define set_irg_args(irg, node) _set_irg_args(irg, node)
644 #define get_irg_value_param_base(irg) _get_irg_value_param_base(irg)
645 #define set_irg_value_param_base(irg, node) _set_irg_value_param_base(irg, node)
646 #define get_irg_bad(irg) _get_irg_bad(irg)
647 #define set_irg_bad(irg, node) _set_irg_bad(irg, node)
648 #define get_irg_no_mem(irg) _get_irg_no_mem(irg)
649 #define set_irg_no_mem(irg, node) _set_irg_no_mem(irg, node)
650 #define get_irg_current_block(irg) _get_irg_current_block(irg)
651 #define set_irg_current_block(irg, node) _set_irg_current_block(irg, node)
652 #define get_irg_entity(irg) _get_irg_entity(irg)
653 #define set_irg_entity(irg, ent) _set_irg_entity(irg, ent)
654 #define get_irg_frame_type(irg) _get_irg_frame_type(irg)
655 #define set_irg_frame_type(irg, ftp) _set_irg_frame_type(irg, ftp)
656 #define get_irg_obstack(irg) _get_irg_obstack(irg)
657 #define get_irg_phase_state(irg) _get_irg_phase_state(irg)
658 #define set_irg_phase_state(irg, state) _set_irg_phase_state(irg, state)
659 #define get_irg_pinned(irg) _get_irg_pinned(irg)
660 #define get_irg_outs_state(irg) _get_irg_outs_state(irg)
661 #define set_irg_outs_inconsistent(irg) _set_irg_outs_inconsistent(irg)
662 #define get_irg_extblk_state(irg) _get_irg_extblk_state(irg)
663 #define set_irg_extblk_inconsistent(irg) _set_irg_extblk_inconsistent(irg)
664 #define get_irg_dom_state(irg) _get_irg_dom_state(irg)
665 #define get_irg_postdom_state(irg) _get_irg_postdom_state(irg)
666 #define set_irg_doms_inconsistent(irg) _set_irg_doms_inconsistent(irg)
667 #define get_irg_loopinfo_state(irg) _get_irg_loopinfo_state(irg)
668 #define set_irg_loopinfo_state(irg, s) _set_irg_loopinfo_state(irg, s)
669 #define set_irg_loopinfo_inconsistent(irg) _set_irg_loopinfo_inconsistent(irg)
670 #define set_irg_pinned(irg, p) _set_irg_pinned(irg, p)
671 #define get_irg_callee_info_state(irg) _get_irg_callee_info_state(irg)
672 #define set_irg_callee_info_state(irg, s) _set_irg_callee_info_state(irg, s)
673 #define get_irg_inline_property(irg) _get_irg_inline_property(irg)
674 #define set_irg_inline_property(irg, s) _set_irg_inline_property(irg, s)
675 #define get_irg_additional_properties(irg) _get_irg_additional_properties(irg)
676 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
677 #define set_irg_additional_property(irg, f) _set_irg_additional_property(irg, f)
678 #define set_irg_link(irg, thing) _set_irg_link(irg, thing)
679 #define get_irg_link(irg) _get_irg_link(irg)
680 #define get_irg_visited(irg) _get_irg_visited(irg)
681 #define get_irg_block_visited(irg) _get_irg_block_visited(irg)
682 #define set_irg_block_visited(irg, v) _set_irg_block_visited(irg, v)
683 #define inc_irg_block_visited(irg) _inc_irg_block_visited(irg)
684 #define dec_irg_block_visited(irg) _dec_irg_block_visited(irg)
685 #define get_irg_estimated_node_cnt(irg) _get_irg_estimated_node_cnt(irg)
686 #define get_irg_fp_model(irg) _get_irg_fp_model(irg)