3 * File name: ir/ir/irgraph.c
4 * Purpose: Entry point to the representation of procedure code.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
20 # include "irgraph_t.h"
21 # include "irprog_t.h"
23 # include "irflag_t.h"
28 # include "firmstat.h"
30 ir_graph *current_ir_graph;
31 INLINE ir_graph *get_current_ir_graph(void) {
32 return current_ir_graph;
34 INLINE void set_current_ir_graph(ir_graph *graph) {
35 current_ir_graph = graph;
39 bool interprocedural_view = false;
40 INLINE bool get_interprocedural_view(void) {
41 return interprocedural_view;
43 INLINE void set_interprocedural_view(bool state) {
44 interprocedural_view = state;
47 static ident* frame_type_suffix = NULL;
48 void init_irgraph(void) {
49 frame_type_suffix = id_from_str(FRAME_TP_SUFFIX, strlen(FRAME_TP_SUFFIX));
52 #if USE_EXPLICIT_PHI_IN_STACK
53 /* really defined in ircons.c */
54 typedef struct Phi_in_stack Phi_in_stack;
55 Phi_in_stack *new_Phi_in_stack();
56 void free_Phi_in_stack(Phi_in_stack *s);
59 /* Allocates a list of nodes:
60 - The start block containing a start node and Proj nodes for it's four
61 results (X, M, P, Tuple).
62 - The end block containing an end node. This block is not matured after
63 new_ir_graph as predecessors need to be added to it.
64 - The current block, which is empty and also not matured.
65 Further it allocates several datastructures needed for graph construction
69 new_ir_graph (entity *ent, int n_loc)
75 res = (ir_graph *) malloc (sizeof (ir_graph));
76 memset(res, 0, sizeof (ir_graph));
79 /* inform statistics here, as blocks will be already build on this graph */
80 stat_new_graph(res, ent);
82 current_ir_graph = res;
83 add_irp_irg(res); /* remember this graph global. */
85 /*-- initialized for each graph. --*/
86 if (get_opt_precise_exc_context()) {
87 res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
88 dereferenced in this graph plus one for
89 the store plus one for links to fragile
90 operations. n_loc is not the number of
91 parameters to the procedure! */
94 res->n_loc = n_loc + 1; /* number of local variables that are never
95 dereferenced in this graph plus one for
96 the store. This is not the number of parameters
100 res->visited = 0; /* visited flag, for the ir walker */
101 res->block_visited=0; /* visited flag, for the 'block'-walker */
103 #if USE_EXPLICIT_PHI_IN_STACK
104 res->Phi_in_stack = new_Phi_in_stack(); /* A stack needed for automatic Phi
107 res->kind = k_ir_graph;
108 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
109 obstack_init (res->obst);
110 res->value_table = new_identities (); /* value table for global value
111 numbering for optimizing use in
115 res->phase_state = phase_building;
116 res->pinned = pinned;
117 res->outs_state = no_outs;
118 res->dom_state = no_dom;
119 res->typeinfo_state = irg_typeinfo_none;
120 res->loopinfo_state = loopinfo_none;
122 /*-- Type information for the procedure of the graph --*/
124 set_entity_irg(ent, res);
126 /*-- contain "inner" methods as in Pascal. --*/
127 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
128 /* Remove type from type list. Must be treated differently than other types. */
129 remove_irp_type_from_list(res->frame_type);
131 /*-- Nodes needed in every graph --*/
132 res->end_block = new_immBlock ();
133 res->end = new_End ();
134 res->end_reg = res->end;
135 res->end_except = res->end;
137 res->start_block = new_immBlock ();
138 res->start = new_Start ();
139 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
140 /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
142 /* Proj results of start node */
143 projX = new_Proj (res->start, mode_X, pns_initial_exec);
144 set_store (new_Proj (res->start, mode_M, pns_global_store));
145 res->frame = new_Proj (res->start, mode_P_mach, pns_frame_base);
146 res->globals = new_Proj (res->start, mode_P_mach, pns_globals);
147 res->args = new_Proj (res->start, mode_T, pns_args);
149 res->graph_nr = get_irp_new_node_nr();
153 add_in_edge(res->start_block, projX);
155 * The code generation needs it. leave it in now.
156 * Use of this edge is matter of discussion, unresolved. Also possible:
157 * add_in_edge(res->start_block, res->start_block), but invalid typed.
159 mature_block (res->current_block);
161 /*-- Make a block to start with --*/
162 first_block = new_immBlock ();
163 add_in_edge (first_block, projX);
170 /* Make a rudimentary ir graph for the constant code.
171 Must look like a correct irg, spare everything else. */
172 ir_graph *new_const_code_irg(void) {
176 res = (ir_graph *) malloc (sizeof(*res));
177 memset(res, 0, sizeof(*res));
179 /* inform statistics here, as blocks will be already build on this graph */
180 stat_new_graph(res, NULL);
182 current_ir_graph = res;
183 res->n_loc = 1; /* Only the memory. */
184 res->visited = 0; /* visited flag, for the ir walker */
185 res->block_visited=0; /* visited flag, for the 'block'-walker */
186 #if USE_EXPLICIT_PHI_IN_STACK
187 res->Phi_in_stack = NULL;
189 res->kind = k_ir_graph;
190 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
191 obstack_init (res->obst);
192 res->phase_state = phase_building;
193 res->pinned = pinned;
194 res->value_table = new_identities (); /* value table for global value
195 numbering for optimizing use in
198 res->frame_type = NULL;
199 res->start_block = new_immBlock ();
200 res->end_block = new_immBlock ();
201 res->end = new_End ();
202 res->end_reg = res->end;
203 res->end_except = res->end;
204 mature_block(get_cur_block());
205 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
206 /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
207 res->start = new_Start ();
209 /* Proj results of start node */
210 projX = new_Proj (res->start, mode_X, pns_initial_exec);
211 set_store (new_Proj (res->start, mode_M, pns_global_store));
212 add_in_edge(res->start_block, projX);
213 mature_block (res->current_block);
214 add_in_edge (new_immBlock (), projX);
215 mature_block(get_cur_block());
216 /* Set the visited flag high enough that the block will never be visited. */
217 set_irn_visited(get_cur_block(), -1);
218 set_Block_block_visited(get_cur_block(), -1);
219 set_Block_block_visited(res->start_block, -1);
220 set_irn_visited(res->start_block, -1);
221 set_irn_visited(res->bad, -1);
225 /* Defined in iropt.c */
226 void del_identities (pset *value_table);
228 /* Frees the passed irgraph.
229 Deallocates all nodes in this graph and the ir_graph structure.
230 Sets the field irgraph in the corresponding entity to NULL.
231 Does not remove the irgraph from the list in irprog (requires
232 inefficient search, call remove_irp_irg by hand).
233 Does not free types, entities or modes that are used only by this
234 graph, nor the entity standing for this graph. */
235 void free_ir_graph (ir_graph *irg) {
236 stat_free_graph(irg);
237 if (irg->outs_state != no_outs) free_outs(irg);
238 if (irg->frame_type) free_type(irg->frame_type);
239 if (irg->value_table) del_identities(irg->value_table);
240 if (irg->ent) set_entity_irg(irg->ent, NULL); /* not set in const code irg */
242 obstack_free(irg->obst,NULL);
244 #if USE_EXPLICIT_PHI_IN_STACK
245 free_Phi_in_stack(irg->Phi_in_stack);
251 /* access routines for all ir_graph attributes:
253 {attr type} get_irg_{attribute name} (ir_graph *irg);
254 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
257 is_ir_graph(void *thing) {
259 if (get_kind(thing) == k_ir_graph)
265 /* Outputs a unique number for this node */
268 get_irg_graph_nr(ir_graph *irg) {
271 return irg->graph_nr;
278 (get_irg_start_block)(ir_graph *irg)
280 return __get_irg_start_block(irg);
284 (set_irg_start_block)(ir_graph *irg, ir_node *node)
286 __set_irg_start_block(irg, node);
290 (get_irg_start)(ir_graph *irg)
292 return __get_irg_start(irg);
296 (set_irg_start)(ir_graph *irg, ir_node *node)
298 __set_irg_start(irg, node);
302 (get_irg_end_block)(ir_graph *irg)
304 return __get_irg_end_block(irg);
308 (set_irg_end_block)(ir_graph *irg, ir_node *node)
310 __set_irg_end_block(irg, node);
314 (get_irg_end)(ir_graph *irg)
316 return __get_irg_end(irg);
320 (set_irg_end)(ir_graph *irg, ir_node *node)
322 __set_irg_end(irg, node);
326 (get_irg_end_reg)(ir_graph *irg) {
327 return __get_irg_end_reg(irg);
330 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
331 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
336 (get_irg_end_except)(ir_graph *irg) {
337 return __get_irg_end_except(irg);
340 void set_irg_end_except (ir_graph *irg, ir_node *node) {
341 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
342 irg->end_except = node;
346 (get_irg_cstore)(ir_graph *irg)
348 return __get_irg_cstore(irg);
352 (set_irg_cstore)(ir_graph *irg, ir_node *node)
354 __set_irg_cstore(irg, node);
358 (get_irg_frame)(ir_graph *irg)
360 return __get_irg_frame(irg);
364 (set_irg_frame)(ir_graph *irg, ir_node *node)
366 __set_irg_frame(irg, node);
370 (get_irg_globals)(ir_graph *irg)
372 return __get_irg_globals(irg);
376 (set_irg_globals)(ir_graph *irg, ir_node *node)
378 __set_irg_globals(irg, node);
382 (get_irg_args)(ir_graph *irg)
384 return __get_irg_args(irg);
388 (set_irg_args)(ir_graph *irg, ir_node *node)
390 __set_irg_args(irg, node);
394 (get_irg_bad)(ir_graph *irg)
396 return __get_irg_bad(irg);
400 (set_irg_bad)(ir_graph *irg, ir_node *node)
402 __set_irg_bad(irg, node);
405 /* GL removed: we need unknown with mode for analyses.
407 get_irg_unknown (ir_graph *irg)
413 set_irg_unknown (ir_graph *irg, ir_node *node)
420 (get_irg_current_block)(ir_graph *irg)
422 return __get_irg_current_block(irg);
426 (set_irg_current_block)(ir_graph *irg, ir_node *node)
428 __set_irg_current_block(irg, node);
432 (get_irg_ent)(ir_graph *irg)
434 return __get_irg_ent(irg);
438 (set_irg_ent)(ir_graph *irg, entity *ent)
440 __set_irg_ent(irg, ent);
444 (get_irg_frame_type)(ir_graph *irg)
446 return __get_irg_frame_type(irg);
450 (set_irg_frame_type)(ir_graph *irg, type *ftp)
452 __set_irg_frame_type(irg, ftp);
456 /* To test for a frame type */
458 is_frame_type(type *ftp) {
460 if (is_class_type(ftp)) {
461 for (i = 0; i < get_irp_n_irgs(); i++) {
462 type *frame_tp = get_irg_frame_type(get_irp_irg(i));
463 if (ftp == frame_tp) return true;
470 get_irg_n_locs (ir_graph *irg)
472 if (get_opt_precise_exc_context())
473 return irg->n_loc - 1 - 1;
475 return irg->n_loc - 1;
479 set_irg_n_loc (ir_graph *irg, int n_loc)
481 if (get_opt_precise_exc_context())
482 irg->n_loc = n_loc + 1 + 1;
484 irg->n_loc = n_loc + 1;
489 /* Returns the obstack associated with the graph. */
491 (get_irg_obstack)(ir_graph *irg) {
492 return __get_irg_obstack(irg);
496 * Returns true if the node n is allocated on the storage of graph irg.
498 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
500 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
502 struct _obstack_chunk *p;
505 * checks wheater the ir_node pointer i on the obstack.
506 * A more sophisticated check would test the "whole" ir_node
508 for (p = irg->obst->chunk; p; p = p->prev) {
509 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
517 get_irg_phase_state (ir_graph *irg) {
518 return irg->phase_state;
522 set_irg_phase_low(ir_graph *irg) {
523 irg->phase_state = phase_low;
527 get_irg_pinned (ir_graph *irg) {
532 get_irg_outs_state(ir_graph *irg) {
533 return irg->outs_state;
537 set_irg_outs_inconsistent(ir_graph *irg) {
538 irg->outs_state = outs_inconsistent;
542 get_irg_dom_state(ir_graph *irg) {
543 return irg->dom_state;
547 set_irg_dom_inconsistent(ir_graph *irg) {
548 irg->dom_state = dom_inconsistent;
552 get_irg_loopinfo_state(ir_graph *irg) {
553 return irg->loopinfo_state;
556 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
557 irg->loopinfo_state = s;
561 set_irg_loopinfo_inconsistent(ir_graph *irg) {
562 if (irg->loopinfo_state == loopinfo_ip_consistent)
563 irg->loopinfo_state = loopinfo_ip_inconsistent;
565 irg->loopinfo_state = loopinfo_inconsistent;
569 set_irg_pinned (ir_graph *irg, op_pinned p) {
574 irg_callee_info_state get_irg_callee_info_state(ir_graph *irg) {
575 return irg->callee_info_state;
578 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
579 irg->callee_info_state = s;
582 irg_inline_property get_irg_inline_property(ir_graph *irg) {
583 return irg->inline_property;
585 void set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
586 irg->inline_property = s;
591 (set_irg_link)(ir_graph *irg, void *thing) {
592 __set_irg_link(irg, thing);
596 (get_irg_link)(ir_graph *irg) {
597 return __get_irg_link(irg);
600 /* maximum visited flag content of all ir_graph visited fields. */
601 static int max_irg_visited = 0;
604 (get_irg_visited)(ir_graph *irg)
606 return __get_irg_visited(irg);
610 set_irg_visited (ir_graph *irg, unsigned long visited)
612 irg->visited = visited;
613 if (irg->visited > max_irg_visited) {
614 max_irg_visited = irg->visited;
619 inc_irg_visited (ir_graph *irg)
621 if (++irg->visited > max_irg_visited) {
622 max_irg_visited = irg->visited;
627 get_max_irg_visited(void)
631 for(i = 0; i < get_irp_n_irgs(); i++)
632 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
634 return max_irg_visited;
637 void set_max_irg_visited(int val) {
638 max_irg_visited = val;
642 inc_max_irg_visited(void)
646 for(i = 0; i < get_irp_n_irgs(); i++)
647 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
650 return max_irg_visited;
654 (get_irg_block_visited)(ir_graph *irg)
656 return __get_irg_block_visited(irg);
660 (set_irg_block_visited)(ir_graph *irg, unsigned long visited)
662 __set_irg_block_visited(irg, visited);
666 (inc_irg_block_visited)(ir_graph *irg)
668 __inc_irg_block_visited(irg);