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"
28 ir_graph *current_ir_graph;
29 INLINE ir_graph *get_current_ir_graph(void) {
30 return current_ir_graph;
32 INLINE void set_current_ir_graph(ir_graph *graph) {
33 current_ir_graph = graph;
37 bool interprocedural_view = false;
38 INLINE bool get_interprocedural_view(void) {
39 return interprocedural_view;
41 INLINE void set_interprocedural_view(bool state) {
42 interprocedural_view = state;
45 static ident* frame_type_suffix = NULL;
46 void init_irgraph(void) {
47 frame_type_suffix = id_from_str(FRAME_TP_SUFFIX, strlen(FRAME_TP_SUFFIX));
50 #if USE_EXPLICIT_PHI_IN_STACK
51 /* really defined in ircons.c */
52 typedef struct Phi_in_stack Phi_in_stack;
53 Phi_in_stack *new_Phi_in_stack();
54 void free_Phi_in_stack(Phi_in_stack *s);
57 /* Allocates a list of nodes:
58 - The start block containing a start node and Proj nodes for it's four
59 results (X, M, P, Tuple).
60 - The end block containing an end node. This block is not matured after
61 new_ir_graph as predecessors need to be added to it.
62 - The current block, which is empty and also not matured.
63 Further it allocates several datastructures needed for graph construction
67 new_ir_graph (entity *ent, int n_loc)
73 res = (ir_graph *) malloc (sizeof (ir_graph));
74 memset(res, 0, sizeof (ir_graph));
77 current_ir_graph = res;
78 add_irp_irg(res); /* remember this graph global. */
81 * initialized for each graph. **/
82 #if PRECISE_EXC_CONTEXT
83 res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
84 dereferenced in this graph plus one for
85 the store plus one for links to fragile
86 operations. n_loc is not the number of
87 parameters to the procedure! */
89 res->n_loc = n_loc + 1; /* number of local variables that are never
90 dereferenced in this graph plus one for
91 the store. This is not the number of parameters
95 res->visited = 0; /* visited flag, for the ir walker */
96 res->block_visited=0; /* visited flag, for the 'block'-walker */
98 #if USE_EXPLICIT_PHI_IN_STACK
99 res->Phi_in_stack = new_Phi_in_stack(); /* A stack needed for automatic Phi
102 res->kind = k_ir_graph;
103 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
104 obstack_init (res->obst);
105 res->value_table = new_identities (); /* value table for global value
106 numbering for optimizing use in
110 res->phase_state = phase_building;
111 res->pinned = pinned;
112 res->outs_state = no_outs;
113 res->dom_state = no_dom;
114 res->typeinfo_state = irg_typeinfo_none;
115 res->loopinfo_state = loopinfo_none;
117 /** Type information for the procedure of the graph **/
119 set_entity_irg(ent, res);
122 contain "inner" methods as in Pascal. **/
123 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
124 /* Remove type from type list. Must be treated differently than other types. */
125 remove_irp_type_from_list(res->frame_type);
127 /** Nodes needed in every graph **/
128 res->end_block = new_immBlock ();
129 res->end = new_End ();
130 res->end_reg = res->end;
131 res->end_except = res->end;
133 res->start_block = new_immBlock ();
134 res->start = new_Start ();
135 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
136 /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
138 /* Proj results of start node */
139 projX = new_Proj (res->start, mode_X, pns_initial_exec);
140 set_store (new_Proj (res->start, mode_M, pns_global_store));
141 res->frame = new_Proj (res->start, mode_P_mach, pns_frame_base);
142 res->globals = new_Proj (res->start, mode_P_mach, pns_globals);
143 res->args = new_Proj (res->start, mode_T, pns_args);
145 res->graph_nr = get_irp_new_node_nr();
149 add_in_edge(res->start_block, projX);
151 * The code generation needs it. leave it in now.
152 * Use of this edge is matter of discussion, unresolved. Also possible:
153 * add_in_edge(res->start_block, res->start_block), but invalid typed.
155 mature_block (res->current_block);
157 /** Make a block to start with **/
158 first_block = new_immBlock ();
159 add_in_edge (first_block, projX);
165 /* Make a rudimentary ir graph for the constant code.
166 Must look like a correct irg, spare everything else. */
167 ir_graph *new_const_code_irg(void) {
171 res = (ir_graph *) malloc (sizeof(*res));
172 memset(res, 0, sizeof(*res));
174 current_ir_graph = res;
175 res->n_loc = 1; /* Only the memory. */
176 res->visited = 0; /* visited flag, for the ir walker */
177 res->block_visited=0; /* visited flag, for the 'block'-walker */
178 #if USE_EXPLICIT_PHI_IN_STACK
179 res->Phi_in_stack = NULL;
181 res->kind = k_ir_graph;
182 res->obst = (struct obstack *) xmalloc (sizeof (struct obstack));
183 obstack_init (res->obst);
184 res->phase_state = phase_building;
185 res->pinned = pinned;
186 res->value_table = new_identities (); /* value table for global value
187 numbering for optimizing use in
190 res->frame_type = NULL;
191 res->start_block = new_immBlock ();
192 res->end_block = new_immBlock ();
193 res->end = new_End ();
194 res->end_reg = res->end;
195 res->end_except = res->end;
196 mature_block(get_cur_block());
197 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
198 /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
199 res->start = new_Start ();
201 /* Proj results of start node */
202 projX = new_Proj (res->start, mode_X, pns_initial_exec);
203 set_store (new_Proj (res->start, mode_M, pns_global_store));
204 add_in_edge(res->start_block, projX);
205 mature_block (res->current_block);
206 add_in_edge (new_immBlock (), projX);
207 mature_block(get_cur_block());
208 /* Set the visited flag high enough that the block will never be visited. */
209 set_irn_visited(get_cur_block(), -1);
210 set_Block_block_visited(get_cur_block(), -1);
211 set_Block_block_visited(res->start_block, -1);
212 set_irn_visited(res->start_block, -1);
213 set_irn_visited(res->bad, -1);
217 /* Defined in iropt.c */
218 void del_identities (pset *value_table);
220 /* Frees the passed irgraph.
221 Deallocates all nodes in this graph and the ir_graph structure.
222 Sets the field irgraph in the corresponding entity to NULL.
223 Does not remove the irgraph from the list in irprog (requires
224 inefficient search, call remove_irp_irg by hand).
225 Does not free types, entities or modes that are used only by this
226 graph, nor the entity standing for this graph. */
227 void free_ir_graph (ir_graph *irg) {
228 if (irg->ent) set_entity_irg(irg->ent, NULL); /* not set in const code irg */
230 if (irg->frame_type) free_type(irg->frame_type);
231 if (irg->value_table) del_identities(irg->value_table);
232 if (irg->outs_state != no_outs) free_outs(irg);
233 obstack_free(irg->obst,NULL);
235 #if USE_EXPLICIT_PHI_IN_STACK
236 free_Phi_in_stack(irg->Phi_in_stack);
242 /* access routines for all ir_graph attributes:
244 {attr type} get_irg_{attribute name} (ir_graph *irg);
245 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
248 is_ir_graph(void *thing) {
250 if (get_kind(thing) == k_ir_graph)
256 /* Outputs a unique number for this node */
259 get_irg_graph_nr(ir_graph *irg) {
262 return irg->graph_nr;
269 get_irg_start_block (ir_graph *irg)
271 return irg->start_block;
275 set_irg_start_block (ir_graph *irg, ir_node *node)
277 irg->start_block = node;
281 get_irg_start (ir_graph *irg)
287 set_irg_start(ir_graph *irg, ir_node *node)
293 get_irg_end_block (ir_graph *irg)
295 return irg->end_block;
299 set_irg_end_block (ir_graph *irg, ir_node *node)
301 irg->end_block = node;
305 get_irg_end (ir_graph *irg)
311 set_irg_end (ir_graph *irg, ir_node *node)
317 get_irg_end_reg (ir_graph *irg) {
320 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
321 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
325 ir_node *get_irg_end_except (ir_graph *irg) {
326 return irg->end_except;
329 void set_irg_end_except (ir_graph *irg, ir_node *node) {
330 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
331 irg->end_except = node;
335 get_irg_cstore (ir_graph *irg)
341 set_irg_cstore (ir_graph *irg, ir_node *node)
347 get_irg_frame (ir_graph *irg)
353 set_irg_frame (ir_graph *irg, ir_node *node)
359 get_irg_globals (ir_graph *irg)
365 set_irg_globals (ir_graph *irg, ir_node *node)
371 get_irg_args (ir_graph *irg)
377 set_irg_args (ir_graph *irg, ir_node *node)
383 get_irg_bad (ir_graph *irg)
389 set_irg_bad (ir_graph *irg, ir_node *node)
394 /* GL removed: we need unknown with mode for analyses.
396 get_irg_unknown (ir_graph *irg)
402 set_irg_unknown (ir_graph *irg, ir_node *node)
409 get_irg_current_block (ir_graph *irg)
411 return irg->current_block;
415 set_irg_current_block (ir_graph *irg, ir_node *node)
417 irg->current_block = node;
421 get_irg_ent (ir_graph *irg)
423 assert(irg && irg->ent);
428 set_irg_ent (ir_graph *irg, entity *ent)
434 get_irg_frame_type (ir_graph *irg)
436 assert(irg && irg->frame_type);
437 return irg->frame_type;
441 set_irg_frame_type (ir_graph *irg, type *ftp)
443 assert(is_class_type(ftp));
444 irg->frame_type = 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 PRECISE_EXC_CONTEXT
465 return irg->n_loc - 1 - 1;
467 return irg->n_loc - 1;
472 set_irg_n_loc (ir_graph *irg, int n_loc)
474 #if PRECISE_EXC_CONTEXT
475 irg->n_loc = n_loc + 1 + 1;
477 irg->n_loc = n_loc + 1;
483 /* Returns the obstack associated with the graph. */
484 struct obstack *get_irg_obstack(ir_graph *irg) {
489 * Returns true if the node n is allocated on the storage of graph irg.
491 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
493 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
495 struct _obstack_chunk *p;
498 * checks wheater the ir_node pointer i on the obstack.
499 * A more sophisticated check would test the "whole" ir_node
501 for (p = irg->obst->chunk; p; p = p->prev) {
502 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
510 get_irg_phase_state (ir_graph *irg) {
511 return irg->phase_state;
515 set_irg_phase_low(ir_graph *irg) {
516 irg->phase_state = phase_low;
520 get_irg_pinned (ir_graph *irg) {
525 get_irg_outs_state(ir_graph *irg) {
526 return irg->outs_state;
530 set_irg_outs_inconsistent(ir_graph *irg) {
531 irg->outs_state = outs_inconsistent;
535 get_irg_dom_state(ir_graph *irg) {
536 return irg->dom_state;
540 set_irg_dom_inconsistent(ir_graph *irg) {
541 irg->dom_state = dom_inconsistent;
545 get_irg_loopinfo_state(ir_graph *irg) {
546 return irg->loopinfo_state;
549 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
550 irg->loopinfo_state = 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 irg->loopinfo_state = loopinfo_inconsistent;
562 set_irg_pinned (ir_graph *irg, op_pinned p) {
567 irg_callee_info_state get_irg_callee_info_state(ir_graph *irg) {
568 return irg->callee_info_state;
571 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
572 irg->callee_info_state = s;
575 irg_inline_property get_irg_inline_property(ir_graph *irg) {
576 return irg->inline_property;
578 void set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
579 irg->inline_property = s;
584 set_irg_link (ir_graph *irg, void *thing) {
589 get_irg_link (ir_graph *irg) {
593 /* maximum visited flag content of all ir_graph visited fields. */
594 static int max_irg_visited = 0;
597 get_irg_visited (ir_graph *irg)
603 set_irg_visited (ir_graph *irg, unsigned long visited)
605 irg->visited = visited;
606 if (irg->visited > max_irg_visited) {
607 max_irg_visited = irg->visited;
612 inc_irg_visited (ir_graph *irg)
614 if (++irg->visited > max_irg_visited) {
615 max_irg_visited = irg->visited;
620 get_max_irg_visited(void)
624 for(i = 0; i < get_irp_n_irgs(); i++)
625 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
627 return max_irg_visited;
630 void set_max_irg_visited(int val) {
631 max_irg_visited = val;
635 inc_max_irg_visited(void)
639 for(i = 0; i < get_irp_n_irgs(); i++)
640 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
643 return max_irg_visited;
647 get_irg_block_visited (ir_graph *irg)
649 return irg->block_visited;
653 set_irg_block_visited (ir_graph *irg, unsigned long visited)
655 irg->block_visited = visited;
659 inc_irg_block_visited (ir_graph *irg)
661 ++irg->block_visited;