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 = new_id_from_chars(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->op_pin_state_pinned = op_pin_state_pinned;
117 res->outs_state = outs_none;
118 res->dom_state = dom_none;
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);
142 /* Proj results of start node */
143 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
144 res->frame = new_Proj (res->start, mode_P_mach, pn_Start_P_frame_base); res->globals = new_Proj (res->start, mode_P_mach, pn_Start_P_globals);
145 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
146 res->args = new_Proj (res->start, mode_T, pn_Start_T_args);
148 res->graph_nr = get_irp_new_node_nr();
151 set_store(res->initial_mem);
153 add_immBlock_pred(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_immBlock_pred(res->start_block, res->start_block), but invalid typed.
159 mature_immBlock (res->current_block);
161 /*-- Make a block to start with --*/
162 first_block = new_immBlock();
163 add_immBlock_pred (first_block, projX);
169 /* Make a rudimentary ir graph for the constant code.
170 Must look like a correct irg, spare everything else. */
171 ir_graph *new_const_code_irg(void) {
175 res = (ir_graph *) malloc (sizeof(*res));
176 memset(res, 0, sizeof(*res));
178 /* inform statistics here, as blocks will be already build on this graph */
179 stat_new_graph(res, NULL);
181 current_ir_graph = res;
182 res->n_loc = 1; /* Only the memory. */
183 res->visited = 0; /* visited flag, for the ir walker */
184 res->block_visited=0; /* visited flag, for the 'block'-walker */
185 #if USE_EXPLICIT_PHI_IN_STACK
186 res->Phi_in_stack = NULL;
188 res->kind = k_ir_graph;
189 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
190 obstack_init (res->obst);
191 res->phase_state = phase_building;
192 res->op_pin_state_pinned = op_pin_state_pinned;
193 res->value_table = new_identities (); /* value table for global value
194 numbering for optimizing use in
197 res->frame_type = NULL;
198 res->start_block = new_immBlock ();
199 res->end_block = new_immBlock ();
200 res->end = new_End ();
201 res->end_reg = res->end;
202 res->end_except = res->end;
203 mature_immBlock(get_cur_block()); /* mature the end block */
204 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
205 res->start = new_Start ();
206 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
208 /* Proj results of start node */
209 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
210 add_immBlock_pred (res->start_block, projX);
211 mature_immBlock (res->start_block); /* mature the start block */
213 add_immBlock_pred (new_immBlock (), projX);
214 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
215 /* Set the visited flag high enough that the block will never be visited. */
216 set_irn_visited(get_cur_block(), -1);
217 set_Block_block_visited(get_cur_block(), -1);
218 set_Block_block_visited(res->start_block, -1);
219 set_irn_visited(res->start_block, -1);
220 set_irn_visited(res->bad, -1);
222 res->phase_state = phase_high;
226 /* Defined in iropt.c */
227 void del_identities (pset *value_table);
229 /* Frees the passed irgraph.
230 Deallocates all nodes in this graph and the ir_graph structure.
231 Sets the field irgraph in the corresponding entity to NULL.
232 Does not remove the irgraph from the list in irprog (requires
233 inefficient search, call remove_irp_irg by hand).
234 Does not free types, entities or modes that are used only by this
235 graph, nor the entity standing for this graph. */
236 void free_ir_graph (ir_graph *irg) {
238 stat_free_graph(irg);
239 if (irg->outs_state != outs_none) free_outs(irg);
240 if (irg->frame_type) free_type(irg->frame_type);
241 if (irg->value_table) del_identities(irg->value_table);
243 peculiarity pec = get_entity_peculiarity (irg->ent);
244 set_entity_peculiarity (irg->ent, peculiarity_description);
245 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
246 set_entity_peculiarity (irg->ent, pec);
250 obstack_free(irg->obst,NULL);
252 #if USE_EXPLICIT_PHI_IN_STACK
253 free_Phi_in_stack(irg->Phi_in_stack);
259 /* access routines for all ir_graph attributes:
261 {attr type} get_irg_{attribute name} (ir_graph *irg);
262 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
265 (is_ir_graph)(void *thing) {
266 return __is_ir_graph(thing);
269 /* Outputs a unique number for this node */
272 get_irg_graph_nr(ir_graph *irg) {
275 return irg->graph_nr;
282 (get_irg_start_block)(ir_graph *irg) {
283 return __get_irg_start_block(irg);
287 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
288 __set_irg_start_block(irg, node);
292 (get_irg_start)(ir_graph *irg) {
293 return __get_irg_start(irg);
297 (set_irg_start)(ir_graph *irg, ir_node *node) {
298 __set_irg_start(irg, node);
302 (get_irg_end_block)(ir_graph *irg) {
303 return __get_irg_end_block(irg);
307 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
308 __set_irg_end_block(irg, node);
312 (get_irg_end)(ir_graph *irg) {
313 return __get_irg_end(irg);
317 (set_irg_end)(ir_graph *irg, ir_node *node) {
318 __set_irg_end(irg, node);
322 (get_irg_end_reg)(ir_graph *irg) {
323 return __get_irg_end_reg(irg);
326 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
327 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
332 (get_irg_end_except)(ir_graph *irg) {
333 return __get_irg_end_except(irg);
336 void set_irg_end_except (ir_graph *irg, ir_node *node) {
337 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
338 irg->end_except = node;
342 (get_irg_cstore)(ir_graph *irg) {
343 return __get_irg_cstore(irg);
347 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
348 __set_irg_cstore(irg, node);
352 (get_irg_frame)(ir_graph *irg) {
353 return __get_irg_frame(irg);
357 (set_irg_frame)(ir_graph *irg, ir_node *node) {
358 __set_irg_frame(irg, node);
362 (get_irg_globals)(ir_graph *irg) {
363 return __get_irg_globals(irg);
367 (set_irg_globals)(ir_graph *irg, ir_node *node) {
368 __set_irg_globals(irg, node);
372 (get_irg_initial_mem)(ir_graph *irg)
374 return __get_irg_initial_mem(irg);
378 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
379 __set_irg_initial_mem(irg, node);
383 (get_irg_args)(ir_graph *irg) {
384 return __get_irg_args(irg);
388 (set_irg_args)(ir_graph *irg, ir_node *node) {
389 __set_irg_args(irg, node);
393 (get_irg_bad)(ir_graph *irg) {
394 return __get_irg_bad(irg);
398 (set_irg_bad)(ir_graph *irg, ir_node *node) {
399 __set_irg_bad(irg, node);
402 /* GL removed: we need unknown with mode for analyses.
404 get_irg_unknown (ir_graph *irg)
410 set_irg_unknown (ir_graph *irg, ir_node *node)
417 (get_irg_current_block)(ir_graph *irg) {
418 return __get_irg_current_block(irg);
422 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
423 __set_irg_current_block(irg, node);
427 (get_irg_entity)(ir_graph *irg) {
428 return __get_irg_ent(irg);
432 (set_irg_entity)(ir_graph *irg, entity *ent) {
433 __set_irg_ent(irg, ent);
437 (get_irg_frame_type)(ir_graph *irg) {
438 return __get_irg_frame_type(irg);
442 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
443 __set_irg_frame_type(irg, ftp);
447 /* To test for a frame type */
449 is_frame_type(type *ftp) {
451 if (is_class_type(ftp)) {
452 for (i = 0; i < get_irp_n_irgs(); i++) {
453 type *frame_tp = get_irg_frame_type(get_irp_irg(i));
454 if (ftp == frame_tp) return true;
461 get_irg_n_locs (ir_graph *irg)
463 if (get_opt_precise_exc_context())
464 return irg->n_loc - 1 - 1;
466 return irg->n_loc - 1;
470 set_irg_n_loc (ir_graph *irg, int n_loc)
472 if (get_opt_precise_exc_context())
473 irg->n_loc = n_loc + 1 + 1;
475 irg->n_loc = n_loc + 1;
480 /* Returns the obstack associated with the graph. */
482 (get_irg_obstack)(ir_graph *irg) {
483 return __get_irg_obstack(irg);
487 * Returns true if the node n is allocated on the storage of graph irg.
489 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
491 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
493 struct _obstack_chunk *p;
496 * checks wheater the ir_node pointer i on the obstack.
497 * A more sophisticated check would test the "whole" ir_node
499 for (p = irg->obst->chunk; p; p = p->prev) {
500 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
508 (get_irg_phase_state)(ir_graph *irg) {
509 return __get_irg_phase_state(irg);
513 (set_irg_phase_low)(ir_graph *irg) {
514 __set_irg_phase_low(irg);
518 (get_irg_pinned)(ir_graph *irg) {
519 return __get_irg_pinned(irg);
523 (get_irg_outs_state)(ir_graph *irg) {
524 return __get_irg_outs_state(irg);
528 (set_irg_outs_inconsistent)(ir_graph *irg) {
529 __set_irg_outs_inconsistent(irg);
533 (get_irg_dom_state)(ir_graph *irg) {
534 return __get_irg_dom_state(irg);
538 (set_irg_dom_inconsistent)(ir_graph *irg) {
539 __set_irg_dom_inconsistent(irg);
543 (get_irg_loopinfo_state)(ir_graph *irg) {
544 return __get_irg_loopinfo_state(irg);
548 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
549 __set_irg_loopinfo_state(irg, s);
553 set_irg_loopinfo_inconsistent(ir_graph *irg) {
554 if (irg->loopinfo_state == loopinfo_ip_consistent)
555 irg->loopinfo_state = loopinfo_ip_inconsistent;
557 else if (irg->loopinfo_state == loopinfo_consistent)
558 irg->loopinfo_state = loopinfo_inconsistent;
560 else if (irg->loopinfo_state == loopinfo_cf_ip_consistent)
561 irg->loopinfo_state = loopinfo_cf_ip_inconsistent;
563 else if (irg->loopinfo_state == loopinfo_cf_consistent)
564 irg->loopinfo_state = loopinfo_cf_inconsistent;
568 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
569 __set_irg_pinned(irg, p);
572 irg_callee_info_state
573 (get_irg_callee_info_state)(ir_graph *irg) {
574 return __get_irg_callee_info_state(irg);
578 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
579 __set_irg_callee_info_state(irg, s);
583 (get_irg_inline_property)(ir_graph *irg) {
584 return __get_irg_inline_property(irg);
588 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
589 __set_irg_inline_property(irg, s);
593 (set_irg_link)(ir_graph *irg, void *thing) {
594 __set_irg_link(irg, thing);
598 (get_irg_link)(ir_graph *irg) {
599 return __get_irg_link(irg);
602 /* maximum visited flag content of all ir_graph visited fields. */
603 static int max_irg_visited = 0;
606 (get_irg_visited)(ir_graph *irg) {
607 return __get_irg_visited(irg);
611 set_irg_visited (ir_graph *irg, unsigned long visited)
613 irg->visited = visited;
614 if (irg->visited > max_irg_visited) {
615 max_irg_visited = irg->visited;
620 inc_irg_visited (ir_graph *irg)
622 if (++irg->visited > max_irg_visited) {
623 max_irg_visited = irg->visited;
628 get_max_irg_visited(void)
632 for(i = 0; i < get_irp_n_irgs(); i++)
633 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
635 return max_irg_visited;
638 void set_max_irg_visited(int val) {
639 max_irg_visited = val;
643 inc_max_irg_visited(void)
647 for(i = 0; i < get_irp_n_irgs(); i++)
648 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
651 return max_irg_visited;
655 (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) {
661 __set_irg_block_visited(irg, visited);
665 (inc_irg_block_visited)(ir_graph *irg) {
666 __inc_irg_block_visited(irg);