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));
77 res->kind = k_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 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
127 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
129 /* Remove type from type list. Must be treated differently than other types. */
130 remove_irp_type_from_list(res->frame_type);
132 /*-- Nodes needed in every graph --*/
133 res->end_block = new_immBlock();
134 res->end = new_End();
135 res->end_reg = res->end;
136 res->end_except = res->end;
138 res->start_block = new_immBlock();
139 res->start = new_Start();
140 res->bad = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
141 /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
143 /* Proj results of start node */
144 projX = new_Proj (res->start, mode_X, pns_initial_exec);
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->initial_mem = new_Proj (res->start, mode_M, pns_global_store);
148 res->args = new_Proj (res->start, mode_T, pns_args);
150 res->graph_nr = get_irp_new_node_nr();
153 set_store(res->initial_mem);
155 add_in_edge(res->start_block, projX);
157 * The code generation needs it. leave it in now.
158 * Use of this edge is matter of discussion, unresolved. Also possible:
159 * add_in_edge(res->start_block, res->start_block), but invalid typed.
161 mature_block (res->current_block);
163 /*-- Make a block to start with --*/
164 first_block = new_immBlock();
165 add_in_edge (first_block, projX);
171 /* Make a rudimentary ir graph for the constant code.
172 Must look like a correct irg, spare everything else. */
173 ir_graph *new_const_code_irg(void) {
177 res = (ir_graph *) malloc (sizeof(*res));
178 memset(res, 0, sizeof(*res));
180 /* inform statistics here, as blocks will be already build on this graph */
181 stat_new_graph(res, NULL);
183 current_ir_graph = res;
184 res->n_loc = 1; /* Only the memory. */
185 res->visited = 0; /* visited flag, for the ir walker */
186 res->block_visited=0; /* visited flag, for the 'block'-walker */
187 #if USE_EXPLICIT_PHI_IN_STACK
188 res->Phi_in_stack = NULL;
190 res->kind = k_ir_graph;
191 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
192 obstack_init (res->obst);
193 res->phase_state = phase_building;
194 res->pinned = pinned;
195 res->value_table = new_identities (); /* value table for global value
196 numbering for optimizing use in
199 res->frame_type = NULL;
200 res->start_block = new_immBlock ();
201 res->end_block = new_immBlock ();
202 res->end = new_End ();
203 res->end_reg = res->end;
204 res->end_except = res->end;
205 mature_block(get_cur_block());
206 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, 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 res->initial_mem = new_Proj (res->start, mode_M, pns_global_store);
213 set_store(res->initial_mem);
214 add_in_edge(res->start_block, projX);
216 mature_block (res->current_block);
217 add_in_edge (new_immBlock (), projX);
218 mature_block(get_cur_block());
219 /* Set the visited flag high enough that the block will never be visited. */
220 set_irn_visited(get_cur_block(), -1);
221 set_Block_block_visited(get_cur_block(), -1);
222 set_Block_block_visited(res->start_block, -1);
223 set_irn_visited(res->start_block, -1);
224 set_irn_visited(res->bad, -1);
228 /* Defined in iropt.c */
229 void del_identities (pset *value_table);
231 /* Frees the passed irgraph.
232 Deallocates all nodes in this graph and the ir_graph structure.
233 Sets the field irgraph in the corresponding entity to NULL.
234 Does not remove the irgraph from the list in irprog (requires
235 inefficient search, call remove_irp_irg by hand).
236 Does not free types, entities or modes that are used only by this
237 graph, nor the entity standing for this graph. */
238 void free_ir_graph (ir_graph *irg) {
239 stat_free_graph(irg);
240 if (irg->outs_state != no_outs) free_outs(irg);
241 if (irg->frame_type) free_type(irg->frame_type);
242 if (irg->value_table) del_identities(irg->value_table);
244 peculiarity pec = get_entity_peculiarity (irg->ent);
245 set_entity_peculiarity (irg->ent, peculiarity_description);
246 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
247 set_entity_peculiarity (irg->ent, pec);
251 obstack_free(irg->obst,NULL);
253 #if USE_EXPLICIT_PHI_IN_STACK
254 free_Phi_in_stack(irg->Phi_in_stack);
260 /* access routines for all ir_graph attributes:
262 {attr type} get_irg_{attribute name} (ir_graph *irg);
263 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
266 (is_ir_graph)(void *thing) {
267 return __is_ir_graph(thing);
270 /* Outputs a unique number for this node */
273 get_irg_graph_nr(ir_graph *irg) {
276 return irg->graph_nr;
283 (get_irg_start_block)(ir_graph *irg) {
284 return __get_irg_start_block(irg);
288 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
289 __set_irg_start_block(irg, node);
293 (get_irg_start)(ir_graph *irg) {
294 return __get_irg_start(irg);
298 (set_irg_start)(ir_graph *irg, ir_node *node) {
299 __set_irg_start(irg, node);
303 (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) {
309 __set_irg_end_block(irg, node);
313 (get_irg_end)(ir_graph *irg) {
314 return __get_irg_end(irg);
318 (set_irg_end)(ir_graph *irg, ir_node *node) {
319 __set_irg_end(irg, node);
323 (get_irg_end_reg)(ir_graph *irg) {
324 return __get_irg_end_reg(irg);
327 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
328 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
333 (get_irg_end_except)(ir_graph *irg) {
334 return __get_irg_end_except(irg);
337 void set_irg_end_except (ir_graph *irg, ir_node *node) {
338 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
339 irg->end_except = node;
343 (get_irg_cstore)(ir_graph *irg) {
344 return __get_irg_cstore(irg);
348 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
349 __set_irg_cstore(irg, node);
353 (get_irg_frame)(ir_graph *irg) {
354 return __get_irg_frame(irg);
358 (set_irg_frame)(ir_graph *irg, ir_node *node) {
359 __set_irg_frame(irg, node);
363 (get_irg_globals)(ir_graph *irg) {
364 return __get_irg_globals(irg);
368 (set_irg_globals)(ir_graph *irg, ir_node *node) {
369 __set_irg_globals(irg, node);
373 (get_irg_initial_mem)(ir_graph *irg)
375 return __get_irg_initial_mem(irg);
379 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
380 __set_irg_initial_mem(irg, node);
384 (get_irg_args)(ir_graph *irg) {
385 return __get_irg_args(irg);
389 (set_irg_args)(ir_graph *irg, ir_node *node) {
390 __set_irg_args(irg, node);
394 (get_irg_bad)(ir_graph *irg) {
395 return __get_irg_bad(irg);
399 (set_irg_bad)(ir_graph *irg, ir_node *node) {
400 __set_irg_bad(irg, node);
403 /* GL removed: we need unknown with mode for analyses.
405 get_irg_unknown (ir_graph *irg)
411 set_irg_unknown (ir_graph *irg, ir_node *node)
418 (get_irg_current_block)(ir_graph *irg) {
419 return __get_irg_current_block(irg);
423 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
424 __set_irg_current_block(irg, node);
428 (get_irg_ent)(ir_graph *irg) {
429 return __get_irg_ent(irg);
433 (set_irg_ent)(ir_graph *irg, entity *ent) {
434 __set_irg_ent(irg, ent);
438 (get_irg_frame_type)(ir_graph *irg) {
439 return __get_irg_frame_type(irg);
443 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
444 __set_irg_frame_type(irg, ftp);
448 /* To test for a frame type */
450 is_frame_type(type *ftp) {
452 if (is_class_type(ftp)) {
453 for (i = 0; i < get_irp_n_irgs(); i++) {
454 type *frame_tp = get_irg_frame_type(get_irp_irg(i));
455 if (ftp == frame_tp) return true;
462 get_irg_n_locs (ir_graph *irg)
464 if (get_opt_precise_exc_context())
465 return irg->n_loc - 1 - 1;
467 return irg->n_loc - 1;
471 set_irg_n_loc (ir_graph *irg, int n_loc)
473 if (get_opt_precise_exc_context())
474 irg->n_loc = n_loc + 1 + 1;
476 irg->n_loc = n_loc + 1;
481 /* Returns the obstack associated with the graph. */
483 (get_irg_obstack)(ir_graph *irg) {
484 return __get_irg_obstack(irg);
488 * Returns true if the node n is allocated on the storage of graph irg.
490 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
492 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
494 struct _obstack_chunk *p;
497 * checks wheater the ir_node pointer i on the obstack.
498 * A more sophisticated check would test the "whole" ir_node
500 for (p = irg->obst->chunk; p; p = p->prev) {
501 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
509 (get_irg_phase_state)(ir_graph *irg) {
510 return __get_irg_phase_state(irg);
514 (set_irg_phase_low)(ir_graph *irg) {
515 __set_irg_phase_low(irg);
519 (get_irg_pinned)(ir_graph *irg) {
520 return __get_irg_pinned(irg);
524 (get_irg_outs_state)(ir_graph *irg) {
525 return __get_irg_outs_state(irg);
529 (set_irg_outs_inconsistent)(ir_graph *irg) {
530 __set_irg_outs_inconsistent(irg);
534 (get_irg_dom_state)(ir_graph *irg) {
535 return __get_irg_dom_state(irg);
539 (set_irg_dom_inconsistent)(ir_graph *irg) {
540 __set_irg_dom_inconsistent(irg);
544 (get_irg_loopinfo_state)(ir_graph *irg) {
545 return __get_irg_loopinfo_state(irg);
549 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
550 __set_irg_loopinfo_state(irg, s);
554 set_irg_loopinfo_inconsistent(ir_graph *irg) {
555 if (irg->loopinfo_state == loopinfo_ip_consistent)
556 irg->loopinfo_state = loopinfo_ip_inconsistent;
558 else if (irg->loopinfo_state == loopinfo_consistent)
559 irg->loopinfo_state = loopinfo_inconsistent;
561 else if (irg->loopinfo_state == loopinfo_cf_ip_consistent)
562 irg->loopinfo_state = loopinfo_cf_ip_inconsistent;
564 else if (irg->loopinfo_state == loopinfo_cf_consistent)
565 irg->loopinfo_state = loopinfo_cf_inconsistent;
569 (set_irg_pinned)(ir_graph *irg, op_pinned p) {
570 __set_irg_pinned(irg, p);
573 irg_callee_info_state
574 (get_irg_callee_info_state)(ir_graph *irg) {
575 return __get_irg_callee_info_state(irg);
579 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
580 __set_irg_callee_info_state(irg, s);
584 (get_irg_inline_property)(ir_graph *irg) {
585 return __get_irg_inline_property(irg);
589 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
590 __set_irg_inline_property(irg, s);
594 (set_irg_link)(ir_graph *irg, void *thing) {
595 __set_irg_link(irg, thing);
599 (get_irg_link)(ir_graph *irg) {
600 return __get_irg_link(irg);
603 /* maximum visited flag content of all ir_graph visited fields. */
604 static int max_irg_visited = 0;
607 (get_irg_visited)(ir_graph *irg) {
608 return __get_irg_visited(irg);
612 set_irg_visited (ir_graph *irg, unsigned long visited)
614 irg->visited = visited;
615 if (irg->visited > max_irg_visited) {
616 max_irg_visited = irg->visited;
621 inc_irg_visited (ir_graph *irg)
623 if (++irg->visited > max_irg_visited) {
624 max_irg_visited = irg->visited;
629 get_max_irg_visited(void)
633 for(i = 0; i < get_irp_n_irgs(); i++)
634 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
636 return max_irg_visited;
639 void set_max_irg_visited(int val) {
640 max_irg_visited = val;
644 inc_max_irg_visited(void)
648 for(i = 0; i < get_irp_n_irgs(); i++)
649 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
652 return max_irg_visited;
656 (get_irg_block_visited)(ir_graph *irg) {
657 return __get_irg_block_visited(irg);
661 (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) {
667 __inc_irg_block_visited(irg);