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.
25 # include "irgraph_t.h"
26 # include "irprog_t.h"
27 # include "irnode_t.h"
29 # include "irflag_t.h"
36 # include "iredges_t.h"
39 * Indicates, whether additional data can be registered to graphs.
40 * If set to 1, this is not possible anymore.
42 static int forbid_new_data = 0;
45 * The amount of additional space for custom data to be allocated upon
46 * creating a new graph.
48 static size_t additional_graph_data_size = 0;
50 ir_graph *current_ir_graph;
51 ir_graph *get_current_ir_graph(void) {
52 return current_ir_graph;
54 void set_current_ir_graph(ir_graph *graph) {
55 current_ir_graph = graph;
59 int __interprocedural_view = false;
61 int (get_interprocedural_view)(void) {
62 return _get_interprocedural_view();
65 void (set_interprocedural_view)(int state) {
66 __interprocedural_view = state;
68 /* set function vectors for faster access */
70 _get_irn_arity = _get_irn_inter_arity;
71 _get_irn_n = _get_irn_inter_n;
74 _get_irn_arity = _get_irn_intra_arity;
75 _get_irn_n = _get_irn_intra_n;
79 /** contains the suffix for frame type names */
80 static ident *frame_type_suffix = NULL;
82 /* initialize the IR graph module */
83 void init_irgraph(void) {
84 frame_type_suffix = new_id_from_str(FRAME_TP_SUFFIX);
89 * Allocate a new IR graph.
90 * This function respects the registered graph data. The only reason for
91 * this function is, that there are two locations, where graphs are
92 * allocated (new_r_ir_graph, new_const_code_irg).
93 * @return Memory for a new graph.
95 static ir_graph *alloc_graph(void) {
96 size_t size = sizeof(ir_graph) + additional_graph_data_size;
97 char *ptr = xmalloc(size);
100 return (ir_graph *) (ptr + additional_graph_data_size);
104 * Frees an allocated IR graph
106 static void free_graph(ir_graph *irg) {
107 char *ptr = (char *)irg;
108 free(ptr - additional_graph_data_size);
111 #if USE_EXPLICIT_PHI_IN_STACK
112 /* really defined in ircons.c */
113 typedef struct Phi_in_stack Phi_in_stack;
114 Phi_in_stack *new_Phi_in_stack();
115 void free_Phi_in_stack(Phi_in_stack *s);
118 /* Allocates a list of nodes:
119 - The start block containing a start node and Proj nodes for it's four
120 results (X, M, P, Tuple).
121 - The end block containing an end node. This block is not matured after
122 new_ir_graph as predecessors need to be added to it.
123 - The current block, which is empty and also not matured.
124 Further it allocates several datastructures needed for graph construction
128 new_r_ir_graph (entity *ent, int n_loc)
131 ir_node *first_block;
135 res->kind = k_ir_graph;
137 edges_init_graph(res);
139 /* inform statistics here, as blocks will be already build on this graph */
140 hook_new_graph(res, ent);
142 current_ir_graph = res;
144 /*-- initialized for each graph. --*/
145 if (get_opt_precise_exc_context()) {
146 res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
147 dereferenced in this graph plus one for
148 the store plus one for links to fragile
149 operations. n_loc is not the number of
150 parameters to the procedure! */
153 res->n_loc = n_loc + 1; /* number of local variables that are never
154 dereferenced in this graph plus one for
155 the store. This is not the number of parameters
159 /* descriptions will be allocated on demand */
160 res->loc_descriptions = NULL;
162 res->visited = 0; /* visited flag, for the ir walker */
163 res->block_visited = 0; /* visited flag, for the 'block'-walker */
165 #if USE_EXPLICIT_PHI_IN_STACK
166 res->Phi_in_stack = new_Phi_in_stack(); /* A stack needed for automatic Phi
169 res->kind = k_ir_graph;
170 res->obst = xmalloc (sizeof(*res->obst));
171 obstack_init(res->obst);
172 res->extbb_obst = NULL;
174 res->value_table = new_identities (); /* value table for global value
175 numbering for optimizing use in
179 res->phase_state = phase_building;
180 res->op_pin_state_pinned = op_pin_state_pinned;
181 res->outs_state = outs_none;
182 res->dom_state = dom_none;
183 res->typeinfo_state = ir_typeinfo_none;
184 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
185 res->loopinfo_state = loopinfo_none;
186 res->class_cast_state = ir_class_casts_transitive;
187 res->extblk_state = ir_extblk_info_none;
189 /*-- Type information for the procedure of the graph --*/
191 set_entity_irg(ent, res);
193 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
194 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
196 /* Remove type from type list. Must be treated differently than other types. */
197 remove_irp_type_from_list(res->frame_type);
199 /*-- Nodes needed in every graph --*/
200 res->end_block = new_immBlock();
201 res->end = new_End();
202 res->end_reg = res->end;
203 res->end_except = res->end;
205 res->start_block = new_immBlock();
206 res->start = new_Start();
207 res->bad = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
208 res->no_mem = new_ir_node(NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
210 /* Proj results of start node */
211 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
212 res->frame = new_Proj (res->start, mode_P_mach, pn_Start_P_frame_base);
213 res->globals = new_Proj (res->start, mode_P_mach, pn_Start_P_globals);
214 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
215 res->args = new_Proj (res->start, mode_T, pn_Start_T_args);
217 res->graph_nr = get_irp_new_node_nr();
219 res->proj_args = NULL;
221 set_store(res->initial_mem);
223 add_immBlock_pred(res->start_block, projX);
225 * The code generation needs it. leave it in now.
226 * Use of this edge is matter of discussion, unresolved. Also possible:
227 * add_immBlock_pred(res->start_block, res->start_block), but invalid typed.
229 mature_immBlock (res->current_block);
231 /*-- Make a block to start with --*/
232 first_block = new_immBlock();
233 add_immBlock_pred (first_block, projX);
235 res->method_execution_frequency = -1;
242 new_ir_graph (entity *ent, int n_loc)
244 ir_graph *res = new_r_ir_graph (ent, n_loc);
245 add_irp_irg(res); /* remember this graph global. */
249 /* Make a rudimentary ir graph for the constant code.
250 Must look like a correct irg, spare everything else. */
251 ir_graph *new_const_code_irg(void) {
257 /* inform statistics here, as blocks will be already build on this graph */
258 hook_new_graph(res, NULL);
260 current_ir_graph = res;
261 res->n_loc = 1; /* Only the memory. */
262 res->visited = 0; /* visited flag, for the ir walker */
263 res->block_visited=0; /* visited flag, for the 'block'-walker */
264 #if USE_EXPLICIT_PHI_IN_STACK
265 res->Phi_in_stack = NULL;
267 res->kind = k_ir_graph;
268 res->obst = xmalloc (sizeof(*res->obst));
269 obstack_init (res->obst);
270 res->extbb_obst = NULL;
272 res->phase_state = phase_building;
273 res->op_pin_state_pinned = op_pin_state_pinned;
274 res->extblk_state = ir_extblk_info_none;
276 res->value_table = new_identities (); /* value table for global value
277 numbering for optimizing use in
280 res->frame_type = NULL;
282 /* -- The end block -- */
283 res->end_block = new_immBlock ();
284 res->end = new_End ();
285 res->end_reg = res->end;
286 res->end_except = res->end;
287 mature_immBlock(get_cur_block()); /* mature the end block */
289 /* -- The start block -- */
290 res->start_block = new_immBlock ();
291 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
292 res->no_mem = new_ir_node (NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
293 res->start = new_Start ();
294 /* Proj results of start node */
295 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
296 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
297 add_immBlock_pred (res->start_block, projX);
298 mature_immBlock (res->start_block); /* mature the start block */
300 add_immBlock_pred (new_immBlock (), projX);
301 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
303 /* Set the visited flag high enough that the blocks will never be visited. */
304 set_irn_visited(get_cur_block(), -1);
305 set_Block_block_visited(get_cur_block(), -1);
306 set_Block_block_visited(res->start_block, -1);
307 set_irn_visited(res->start_block, -1);
308 set_irn_visited(res->bad, -1);
309 set_irn_visited(res->no_mem, -1);
311 res->phase_state = phase_high;
316 /* Defined in iropt.c */
317 void del_identities (pset *value_table);
319 /* Frees the passed irgraph.
320 Deallocates all nodes in this graph and the ir_graph structure.
321 Sets the field irgraph in the corresponding entity to NULL.
322 Does not remove the irgraph from the list in irprog (requires
323 inefficient search, call remove_irp_irg by hand).
324 Does not free types, entities or modes that are used only by this
325 graph, nor the entity standing for this graph. */
326 void free_ir_graph (ir_graph *irg) {
327 assert(is_ir_graph(irg));
329 hook_free_graph(irg);
330 if (irg->outs_state != outs_none) free_outs(irg);
331 if (irg->frame_type) free_type(irg->frame_type);
332 if (irg->value_table) del_identities(irg->value_table);
334 peculiarity pec = get_entity_peculiarity (irg->ent);
335 set_entity_peculiarity (irg->ent, peculiarity_description);
336 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
337 set_entity_peculiarity (irg->ent, pec);
341 obstack_free(irg->obst,NULL);
343 #if USE_EXPLICIT_PHI_IN_STACK
344 free_Phi_in_stack(irg->Phi_in_stack);
346 if (irg->loc_descriptions)
347 free(irg->loc_descriptions);
352 /* access routines for all ir_graph attributes:
354 {attr type} get_irg_{attribute name} (ir_graph *irg);
355 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
358 (is_ir_graph)(const void *thing) {
359 return _is_ir_graph(thing);
362 /* Outputs a unique number for this node */
365 get_irg_graph_nr(ir_graph *irg) {
368 return irg->graph_nr;
375 (get_irg_start_block)(const ir_graph *irg) {
376 return _get_irg_start_block(irg);
380 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
381 _set_irg_start_block(irg, node);
385 (get_irg_start)(const ir_graph *irg) {
386 return _get_irg_start(irg);
390 (set_irg_start)(ir_graph *irg, ir_node *node) {
391 _set_irg_start(irg, node);
395 (get_irg_end_block)(const ir_graph *irg) {
396 return _get_irg_end_block(irg);
400 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
401 _set_irg_end_block(irg, node);
405 (get_irg_end)(const ir_graph *irg) {
406 return _get_irg_end(irg);
410 (set_irg_end)(ir_graph *irg, ir_node *node) {
411 _set_irg_end(irg, node);
415 (get_irg_end_reg)(const ir_graph *irg) {
416 return _get_irg_end_reg(irg);
419 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
420 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
425 (get_irg_end_except)(const ir_graph *irg) {
426 return _get_irg_end_except(irg);
429 void set_irg_end_except (ir_graph *irg, ir_node *node) {
430 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
431 irg->end_except = node;
435 (get_irg_cstore)(const ir_graph *irg) {
436 return _get_irg_cstore(irg);
440 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
441 _set_irg_cstore(irg, node);
445 (get_irg_frame)(const ir_graph *irg) {
446 return _get_irg_frame(irg);
450 (set_irg_frame)(ir_graph *irg, ir_node *node) {
451 _set_irg_frame(irg, node);
455 (get_irg_globals)(const ir_graph *irg) {
456 return _get_irg_globals(irg);
460 (set_irg_globals)(ir_graph *irg, ir_node *node) {
461 _set_irg_globals(irg, node);
465 (get_irg_initial_mem)(const ir_graph *irg) {
466 return _get_irg_initial_mem(irg);
470 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
471 _set_irg_initial_mem(irg, node);
475 (get_irg_args)(const ir_graph *irg) {
476 return _get_irg_args(irg);
480 (set_irg_args)(ir_graph *irg, ir_node *node) {
481 _set_irg_args(irg, node);
485 (get_irg_proj_args) (const ir_graph *irg) {
486 return _get_irg_proj_args (irg);
490 (set_irg_proj_args) (ir_graph *irg, ir_node **nodes) {
491 _set_irg_proj_args (irg, nodes);
495 (get_irg_bad)(const ir_graph *irg) {
496 return _get_irg_bad(irg);
500 (set_irg_bad)(ir_graph *irg, ir_node *node) {
501 _set_irg_bad(irg, node);
505 (get_irg_no_mem)(const ir_graph *irg) {
506 return _get_irg_no_mem(irg);
510 (set_irg_no_mem)(ir_graph *irg, ir_node *node) {
511 _set_irg_no_mem(irg, node);
515 (get_irg_current_block)(const ir_graph *irg) {
516 return _get_irg_current_block(irg);
520 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
521 _set_irg_current_block(irg, node);
525 (get_irg_entity)(const ir_graph *irg) {
526 return _get_irg_entity(irg);
530 (set_irg_entity)(ir_graph *irg, entity *ent) {
531 _set_irg_entity(irg, ent);
535 (get_irg_frame_type)(const ir_graph *irg) {
536 return _get_irg_frame_type(irg);
540 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
541 _set_irg_frame_type(irg, ftp);
545 /* To test for a frame type */
547 is_frame_type(const type *ftp) {
549 if (is_Class_type(ftp)) {
550 for (i = 0; i < get_irp_n_irgs(); i++) {
551 const type *frame_tp = get_irg_frame_type(get_irp_irg(i));
552 if (ftp == frame_tp) return true;
559 get_irg_n_locs (ir_graph *irg)
561 if (get_opt_precise_exc_context())
562 return irg->n_loc - 1 - 1;
564 return irg->n_loc - 1;
568 set_irg_n_loc (ir_graph *irg, int n_loc)
570 if (get_opt_precise_exc_context())
571 irg->n_loc = n_loc + 1 + 1;
573 irg->n_loc = n_loc + 1;
578 /* Returns the obstack associated with the graph. */
580 (get_irg_obstack)(const ir_graph *irg) {
581 return _get_irg_obstack(irg);
585 * Returns true if the node n is allocated on the storage of graph irg.
587 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
589 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
591 struct _obstack_chunk *p;
594 * checks weather the ir_node pointer is on the obstack.
595 * A more sophisticated check would test the "whole" ir_node
597 for (p = irg->obst->chunk; p; p = p->prev) {
598 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
606 (get_irg_phase_state)(const ir_graph *irg) {
607 return _get_irg_phase_state(irg);
611 (set_irg_phase_low)(ir_graph *irg) {
612 _set_irg_phase_low(irg);
616 (get_irg_pinned)(const ir_graph *irg) {
617 return _get_irg_pinned(irg);
621 (get_irg_outs_state)(const ir_graph *irg) {
622 return _get_irg_outs_state(irg);
626 (set_irg_outs_inconsistent)(ir_graph *irg) {
627 _set_irg_outs_inconsistent(irg);
631 (get_irg_dom_state)(const ir_graph *irg) {
632 return _get_irg_dom_state(irg);
636 (set_irg_dom_inconsistent)(ir_graph *irg) {
637 _set_irg_dom_inconsistent(irg);
641 (get_irg_loopinfo_state)(const ir_graph *irg) {
642 return _get_irg_loopinfo_state(irg);
646 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
647 _set_irg_loopinfo_state(irg, s);
651 (set_irg_loopinfo_inconsistent)(ir_graph *irg) {
652 _set_irg_loopinfo_inconsistent(irg);
655 void set_irp_loopinfo_inconsistent(void) {
656 int i, n_irgs = get_irp_n_irgs();
657 for (i = 0; i < n_irgs; ++i) {
658 set_irg_loopinfo_inconsistent(get_irp_irg(i));
665 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
666 _set_irg_pinned(irg, p);
669 irg_callee_info_state
670 (get_irg_callee_info_state)(const ir_graph *irg) {
671 return _get_irg_callee_info_state(irg);
675 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
676 _set_irg_callee_info_state(irg, s);
680 (get_irg_inline_property)(const ir_graph *irg) {
681 return _get_irg_inline_property(irg);
685 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
686 _set_irg_inline_property(irg, s);
690 (set_irg_link)(ir_graph *irg, void *thing) {
691 _set_irg_link(irg, thing);
695 (get_irg_link)(const ir_graph *irg) {
696 return _get_irg_link(irg);
699 /** maximum visited flag content of all ir_graph visited fields. */
700 static unsigned long max_irg_visited = 0;
703 (get_irg_visited)(const ir_graph *irg) {
704 return _get_irg_visited(irg);
708 set_irg_visited (ir_graph *irg, unsigned long visited)
710 irg->visited = visited;
711 if (irg->visited > max_irg_visited) {
712 max_irg_visited = irg->visited;
717 inc_irg_visited (ir_graph *irg)
719 if (++irg->visited > max_irg_visited) {
720 max_irg_visited = irg->visited;
725 get_max_irg_visited(void)
729 for(i = 0; i < get_irp_n_irgs(); i++)
730 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
732 return max_irg_visited;
735 void set_max_irg_visited(int val) {
736 max_irg_visited = val;
740 inc_max_irg_visited(void)
744 for(i = 0; i < get_irp_n_irgs(); i++)
745 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
748 return max_irg_visited;
752 (get_irg_block_visited)(const ir_graph *irg) {
753 return _get_irg_block_visited(irg);
757 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
758 _set_irg_block_visited(irg, visited);
762 (inc_irg_block_visited)(ir_graph *irg) {
763 _inc_irg_block_visited(irg);
768 * walker Start->End: places Proj nodes into the same block
769 * as it's predecessors
774 static void normalize_proj_walker(ir_node *n, void *env)
777 ir_node *pred = get_Proj_pred(n);
778 ir_node *block = get_nodes_block(pred);
780 set_nodes_block(n, block);
784 /* move Proj nodes into the same block as its predecessors */
785 void normalize_proj_nodes(ir_graph *irg)
787 irg_walk_graph(irg, NULL, normalize_proj_walker, NULL);
788 set_irg_outs_inconsistent(irg);
791 /* set a description for local value n */
792 void set_irg_loc_description(ir_graph *irg, int n, void *description)
794 assert(0 <= n && n < irg->n_loc);
796 if (! irg->loc_descriptions)
797 irg->loc_descriptions = xcalloc(sizeof(*irg->loc_descriptions), irg->n_loc);
799 irg->loc_descriptions[n] = description;
802 /* get the description for local value n */
803 void *get_irg_loc_description(ir_graph *irg, int n)
805 assert(0 <= n && n < irg->n_loc);
806 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
809 /* register additional space in an IR graph */
810 size_t register_additional_graph_data(size_t size)
812 assert(!forbid_new_data && "Too late to register additional node data");
817 return additional_graph_data_size += size;