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.
23 # include "irgraph_t.h"
24 # include "irprog_t.h"
25 # include "irnode_t.h"
27 # include "irflag_t.h"
32 # include "firmstat.h"
35 ir_graph *current_ir_graph;
36 INLINE ir_graph *get_current_ir_graph(void) {
37 return current_ir_graph;
39 INLINE void set_current_ir_graph(ir_graph *graph) {
40 current_ir_graph = graph;
44 int __interprocedural_view = false;
46 int (get_interprocedural_view)(void) {
47 return __get_interprocedural_view();
50 void (set_interprocedural_view)(int state) {
51 __interprocedural_view = state;
53 /* set function vectors for faster access */
55 __get_irn_arity = __get_irn_inter_arity;
56 __get_irn_n = __get_irn_inter_n;
59 __get_irn_arity = __get_irn_intra_arity;
60 __get_irn_n = __get_irn_intra_n;
64 static ident* frame_type_suffix = NULL;
65 void init_irgraph(void) {
66 frame_type_suffix = new_id_from_chars(FRAME_TP_SUFFIX, strlen(FRAME_TP_SUFFIX));
69 #if USE_EXPLICIT_PHI_IN_STACK
70 /* really defined in ircons.c */
71 typedef struct Phi_in_stack Phi_in_stack;
72 Phi_in_stack *new_Phi_in_stack();
73 void free_Phi_in_stack(Phi_in_stack *s);
76 /* Allocates a list of nodes:
77 - The start block containing a start node and Proj nodes for it's four
78 results (X, M, P, Tuple).
79 - The end block containing an end node. This block is not matured after
80 new_ir_graph as predecessors need to be added to it.
81 - The current block, which is empty and also not matured.
82 Further it allocates several datastructures needed for graph construction
86 new_r_ir_graph (entity *ent, int n_loc)
92 res = (ir_graph *) xmalloc (sizeof (ir_graph));
93 memset(res, 0, sizeof (ir_graph));
94 res->kind = k_ir_graph;
96 /* inform statistics here, as blocks will be already build on this graph */
97 stat_new_graph(res, ent);
99 current_ir_graph = res;
101 /*-- initialized for each graph. --*/
102 if (get_opt_precise_exc_context()) {
103 res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
104 dereferenced in this graph plus one for
105 the store plus one for links to fragile
106 operations. n_loc is not the number of
107 parameters to the procedure! */
110 res->n_loc = n_loc + 1; /* number of local variables that are never
111 dereferenced in this graph plus one for
112 the store. This is not the number of parameters
116 res->visited = 0; /* visited flag, for the ir walker */
117 res->block_visited = 0; /* visited flag, for the 'block'-walker */
119 #if USE_EXPLICIT_PHI_IN_STACK
120 res->Phi_in_stack = new_Phi_in_stack(); /* A stack needed for automatic Phi
123 res->kind = k_ir_graph;
124 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
125 obstack_init (res->obst);
126 res->value_table = new_identities (); /* value table for global value
127 numbering for optimizing use in
131 res->phase_state = phase_building;
132 res->op_pin_state_pinned = op_pin_state_pinned;
133 res->outs_state = outs_none;
134 res->dom_state = dom_none;
135 res->typeinfo_state = irg_typeinfo_none;
136 res->loopinfo_state = loopinfo_none;
138 /*-- Type information for the procedure of the graph --*/
140 set_entity_irg(ent, res);
142 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
143 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
145 /* Remove type from type list. Must be treated differently than other types. */
146 remove_irp_type_from_list(res->frame_type);
148 /*-- Nodes needed in every graph --*/
149 res->end_block = new_immBlock();
150 res->end = new_End();
151 res->end_reg = res->end;
152 res->end_except = res->end;
154 res->start_block = new_immBlock();
155 res->start = new_Start();
156 res->bad = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
157 res->no_mem = new_ir_node(NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
159 /* Proj results of start node */
160 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
161 res->frame = new_Proj (res->start, mode_P_mach, pn_Start_P_frame_base);
162 res->globals = new_Proj (res->start, mode_P_mach, pn_Start_P_globals);
163 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
164 res->args = new_Proj (res->start, mode_T, pn_Start_T_args);
166 res->graph_nr = get_irp_new_node_nr();
169 set_store(res->initial_mem);
171 add_immBlock_pred(res->start_block, projX);
173 * The code generation needs it. leave it in now.
174 * Use of this edge is matter of discussion, unresolved. Also possible:
175 * add_immBlock_pred(res->start_block, res->start_block), but invalid typed.
177 mature_immBlock (res->current_block);
179 /*-- Make a block to start with --*/
180 first_block = new_immBlock();
181 add_immBlock_pred (first_block, projX);
188 new_ir_graph (entity *ent, int n_loc)
190 ir_graph *res = new_r_ir_graph (ent, n_loc);
191 add_irp_irg(res); /* remember this graph global. */
195 /* Make a rudimentary ir graph for the constant code.
196 Must look like a correct irg, spare everything else. */
197 ir_graph *new_const_code_irg(void) {
201 res = (ir_graph *) xmalloc (sizeof(*res));
202 memset(res, 0, sizeof(*res));
204 /* inform statistics here, as blocks will be already build on this graph */
205 stat_new_graph(res, NULL);
207 current_ir_graph = res;
208 res->n_loc = 1; /* Only the memory. */
209 res->visited = 0; /* visited flag, for the ir walker */
210 res->block_visited=0; /* visited flag, for the 'block'-walker */
211 #if USE_EXPLICIT_PHI_IN_STACK
212 res->Phi_in_stack = NULL;
214 res->kind = k_ir_graph;
215 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
216 obstack_init (res->obst);
217 res->phase_state = phase_building;
218 res->op_pin_state_pinned = op_pin_state_pinned;
219 res->value_table = new_identities (); /* value table for global value
220 numbering for optimizing use in
223 res->frame_type = NULL;
224 res->start_block = new_immBlock ();
225 res->end_block = new_immBlock ();
226 res->end = new_End ();
227 res->end_reg = res->end;
228 res->end_except = res->end;
229 mature_immBlock(get_cur_block()); /* mature the end block */
230 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
231 res->no_mem = new_ir_node (NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
232 res->start = new_Start ();
233 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
235 /* Proj results of start node */
236 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
237 add_immBlock_pred (res->start_block, projX);
238 mature_immBlock (res->start_block); /* mature the start block */
240 add_immBlock_pred (new_immBlock (), projX);
241 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
242 /* Set the visited flag high enough that the block will never be visited. */
243 set_irn_visited(get_cur_block(), -1);
244 set_Block_block_visited(get_cur_block(), -1);
245 set_Block_block_visited(res->start_block, -1);
246 set_irn_visited(res->start_block, -1);
247 set_irn_visited(res->bad, -1);
248 set_irn_visited(res->no_mem, -1);
250 res->phase_state = phase_high;
254 /* Defined in iropt.c */
255 void del_identities (pset *value_table);
257 /* Frees the passed irgraph.
258 Deallocates all nodes in this graph and the ir_graph structure.
259 Sets the field irgraph in the corresponding entity to NULL.
260 Does not remove the irgraph from the list in irprog (requires
261 inefficient search, call remove_irp_irg by hand).
262 Does not free types, entities or modes that are used only by this
263 graph, nor the entity standing for this graph. */
264 void free_ir_graph (ir_graph *irg) {
266 stat_free_graph(irg);
267 if (irg->outs_state != outs_none) free_outs(irg);
268 if (irg->frame_type) free_type(irg->frame_type);
269 if (irg->value_table) del_identities(irg->value_table);
271 peculiarity pec = get_entity_peculiarity (irg->ent);
272 set_entity_peculiarity (irg->ent, peculiarity_description);
273 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
274 set_entity_peculiarity (irg->ent, pec);
278 obstack_free(irg->obst,NULL);
280 #if USE_EXPLICIT_PHI_IN_STACK
281 free_Phi_in_stack(irg->Phi_in_stack);
287 /* access routines for all ir_graph attributes:
289 {attr type} get_irg_{attribute name} (ir_graph *irg);
290 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
293 (is_ir_graph)(const void *thing) {
294 return __is_ir_graph(thing);
297 /* Outputs a unique number for this node */
300 get_irg_graph_nr(ir_graph *irg) {
303 return irg->graph_nr;
310 (get_irg_start_block)(const ir_graph *irg) {
311 return __get_irg_start_block(irg);
315 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
316 __set_irg_start_block(irg, node);
320 (get_irg_start)(const ir_graph *irg) {
321 return __get_irg_start(irg);
325 (set_irg_start)(ir_graph *irg, ir_node *node) {
326 __set_irg_start(irg, node);
330 (get_irg_end_block)(const ir_graph *irg) {
331 return __get_irg_end_block(irg);
335 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
336 __set_irg_end_block(irg, node);
340 (get_irg_end)(const ir_graph *irg) {
341 return __get_irg_end(irg);
345 (set_irg_end)(ir_graph *irg, ir_node *node) {
346 __set_irg_end(irg, node);
350 (get_irg_end_reg)(const ir_graph *irg) {
351 return __get_irg_end_reg(irg);
354 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
355 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
360 (get_irg_end_except)(const ir_graph *irg) {
361 return __get_irg_end_except(irg);
364 void set_irg_end_except (ir_graph *irg, ir_node *node) {
365 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
366 irg->end_except = node;
370 (get_irg_cstore)(const ir_graph *irg) {
371 return __get_irg_cstore(irg);
375 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
376 __set_irg_cstore(irg, node);
380 (get_irg_frame)(const ir_graph *irg) {
381 return __get_irg_frame(irg);
385 (set_irg_frame)(ir_graph *irg, ir_node *node) {
386 __set_irg_frame(irg, node);
390 (get_irg_globals)(const ir_graph *irg) {
391 return __get_irg_globals(irg);
395 (set_irg_globals)(ir_graph *irg, ir_node *node) {
396 __set_irg_globals(irg, node);
400 (get_irg_initial_mem)(const ir_graph *irg) {
401 return __get_irg_initial_mem(irg);
405 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
406 __set_irg_initial_mem(irg, node);
410 (get_irg_args)(const ir_graph *irg) {
411 return __get_irg_args(irg);
415 (set_irg_args)(ir_graph *irg, ir_node *node) {
416 __set_irg_args(irg, node);
420 (get_irg_bad)(const ir_graph *irg) {
421 return __get_irg_bad(irg);
425 (set_irg_bad)(ir_graph *irg, ir_node *node) {
426 __set_irg_bad(irg, node);
430 (get_irg_no_mem)(const ir_graph *irg) {
431 return __get_irg_no_mem(irg);
435 (set_irg_no_mem)(ir_graph *irg, ir_node *node) {
436 __set_irg_no_mem(irg, node);
440 (get_irg_current_block)(const ir_graph *irg) {
441 return __get_irg_current_block(irg);
445 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
446 __set_irg_current_block(irg, node);
450 (get_irg_entity)(const ir_graph *irg) {
451 return __get_irg_entity(irg);
455 (set_irg_entity)(ir_graph *irg, entity *ent) {
456 __set_irg_entity(irg, ent);
460 (get_irg_frame_type)(const ir_graph *irg) {
461 return __get_irg_frame_type(irg);
465 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
466 __set_irg_frame_type(irg, ftp);
470 /* To test for a frame type */
472 is_frame_type(const type *ftp) {
474 if (is_class_type(ftp)) {
475 for (i = 0; i < get_irp_n_irgs(); i++) {
476 const type *frame_tp = get_irg_frame_type(get_irp_irg(i));
477 if (ftp == frame_tp) return true;
484 get_irg_n_locs (ir_graph *irg)
486 if (get_opt_precise_exc_context())
487 return irg->n_loc - 1 - 1;
489 return irg->n_loc - 1;
493 set_irg_n_loc (ir_graph *irg, int n_loc)
495 if (get_opt_precise_exc_context())
496 irg->n_loc = n_loc + 1 + 1;
498 irg->n_loc = n_loc + 1;
503 /* Returns the obstack associated with the graph. */
505 (get_irg_obstack)(const ir_graph *irg) {
506 return __get_irg_obstack(irg);
510 * Returns true if the node n is allocated on the storage of graph irg.
512 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
514 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
516 struct _obstack_chunk *p;
519 * checks wheater the ir_node pointer i on the obstack.
520 * A more sophisticated check would test the "whole" ir_node
522 for (p = irg->obst->chunk; p; p = p->prev) {
523 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
531 (get_irg_phase_state)(const ir_graph *irg) {
532 return __get_irg_phase_state(irg);
536 (set_irg_phase_low)(ir_graph *irg) {
537 __set_irg_phase_low(irg);
541 (get_irg_pinned)(const ir_graph *irg) {
542 return __get_irg_pinned(irg);
546 (get_irg_outs_state)(const ir_graph *irg) {
547 return __get_irg_outs_state(irg);
551 (set_irg_outs_inconsistent)(ir_graph *irg) {
552 __set_irg_outs_inconsistent(irg);
556 (get_irg_dom_state)(const ir_graph *irg) {
557 return __get_irg_dom_state(irg);
561 (set_irg_dom_inconsistent)(ir_graph *irg) {
562 __set_irg_dom_inconsistent(irg);
566 (get_irg_loopinfo_state)(const ir_graph *irg) {
567 return __get_irg_loopinfo_state(irg);
571 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
572 __set_irg_loopinfo_state(irg, s);
576 set_irg_loopinfo_inconsistent(ir_graph *irg) {
577 if (irg->loopinfo_state == loopinfo_ip_consistent)
578 irg->loopinfo_state = loopinfo_ip_inconsistent;
580 else if (irg->loopinfo_state == loopinfo_consistent)
581 irg->loopinfo_state = loopinfo_inconsistent;
583 else if (irg->loopinfo_state == loopinfo_cf_ip_consistent)
584 irg->loopinfo_state = loopinfo_cf_ip_inconsistent;
586 else if (irg->loopinfo_state == loopinfo_cf_consistent)
587 irg->loopinfo_state = loopinfo_cf_inconsistent;
591 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
592 __set_irg_pinned(irg, p);
595 irg_callee_info_state
596 (get_irg_callee_info_state)(const ir_graph *irg) {
597 return __get_irg_callee_info_state(irg);
601 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
602 __set_irg_callee_info_state(irg, s);
606 (get_irg_inline_property)(const ir_graph *irg) {
607 return __get_irg_inline_property(irg);
611 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
612 __set_irg_inline_property(irg, s);
616 (set_irg_link)(ir_graph *irg, void *thing) {
617 __set_irg_link(irg, thing);
621 (get_irg_link)(const ir_graph *irg) {
622 return __get_irg_link(irg);
625 /* maximum visited flag content of all ir_graph visited fields. */
626 static int max_irg_visited = 0;
629 (get_irg_visited)(const ir_graph *irg) {
630 return __get_irg_visited(irg);
634 set_irg_visited (ir_graph *irg, unsigned long visited)
636 irg->visited = visited;
637 if (irg->visited > max_irg_visited) {
638 max_irg_visited = irg->visited;
643 inc_irg_visited (ir_graph *irg)
645 if (++irg->visited > max_irg_visited) {
646 max_irg_visited = irg->visited;
651 get_max_irg_visited(void)
655 for(i = 0; i < get_irp_n_irgs(); i++)
656 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
658 return max_irg_visited;
661 void set_max_irg_visited(int val) {
662 max_irg_visited = val;
666 inc_max_irg_visited(void)
670 for(i = 0; i < get_irp_n_irgs(); i++)
671 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
674 return max_irg_visited;
678 (get_irg_block_visited)(const ir_graph *irg) {
679 return __get_irg_block_visited(irg);
683 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
684 __set_irg_block_visited(irg, visited);
688 (inc_irg_block_visited)(ir_graph *irg) {
689 __inc_irg_block_visited(irg);
694 * walker Start->End: places Proj nodes into the same block
695 * as it's predecessors
700 static void normalize_proj_walker(ir_node *n, void *env)
703 ir_node *pred = get_Proj_pred(n);
704 ir_node *block = get_nodes_block(pred);
706 set_nodes_block(n, block);
710 /* put the proj's into the same block as its predecessors */
711 void normalize_proj_nodes(ir_graph *irg)
713 irg_walk_graph(irg, NULL, normalize_proj_walker, NULL);
714 set_irg_outs_inconsistent(irg);