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)
97 size_t size = sizeof(ir_graph) + additional_graph_data_size;
98 char *ptr = xmalloc(size);
101 return (ir_graph *) (ptr + additional_graph_data_size);
104 #if USE_EXPLICIT_PHI_IN_STACK
105 /* really defined in ircons.c */
106 typedef struct Phi_in_stack Phi_in_stack;
107 Phi_in_stack *new_Phi_in_stack();
108 void free_Phi_in_stack(Phi_in_stack *s);
111 /* Allocates a list of nodes:
112 - The start block containing a start node and Proj nodes for it's four
113 results (X, M, P, Tuple).
114 - The end block containing an end node. This block is not matured after
115 new_ir_graph as predecessors need to be added to it.
116 - The current block, which is empty and also not matured.
117 Further it allocates several datastructures needed for graph construction
121 new_r_ir_graph (entity *ent, int n_loc)
124 ir_node *first_block;
128 res->kind = k_ir_graph;
130 #ifdef FIRM_EDGES_INPLACE
131 edges_init_graph(res);
134 /* inform statistics here, as blocks will be already build on this graph */
135 hook_new_graph(res, ent);
137 current_ir_graph = res;
139 /*-- initialized for each graph. --*/
140 if (get_opt_precise_exc_context()) {
141 res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
142 dereferenced in this graph plus one for
143 the store plus one for links to fragile
144 operations. n_loc is not the number of
145 parameters to the procedure! */
148 res->n_loc = n_loc + 1; /* number of local variables that are never
149 dereferenced in this graph plus one for
150 the store. This is not the number of parameters
154 /* descriptions will be allocated on demand */
155 res->loc_descriptions = NULL;
157 res->visited = 0; /* visited flag, for the ir walker */
158 res->block_visited = 0; /* visited flag, for the 'block'-walker */
160 #if USE_EXPLICIT_PHI_IN_STACK
161 res->Phi_in_stack = new_Phi_in_stack(); /* A stack needed for automatic Phi
164 res->kind = k_ir_graph;
165 res->obst = xmalloc (sizeof(*res->obst));
166 obstack_init (res->obst);
167 res->value_table = new_identities (); /* value table for global value
168 numbering for optimizing use in
172 res->phase_state = phase_building;
173 res->op_pin_state_pinned = op_pin_state_pinned;
174 res->outs_state = outs_none;
175 res->dom_state = dom_none;
176 res->typeinfo_state = irg_typeinfo_none;
177 res->loopinfo_state = loopinfo_none;
179 /*-- Type information for the procedure of the graph --*/
181 set_entity_irg(ent, res);
183 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
184 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
186 /* Remove type from type list. Must be treated differently than other types. */
187 remove_irp_type_from_list(res->frame_type);
189 /*-- Nodes needed in every graph --*/
190 res->end_block = new_immBlock();
191 res->end = new_End();
192 res->end_reg = res->end;
193 res->end_except = res->end;
195 res->start_block = new_immBlock();
196 res->start = new_Start();
197 res->bad = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
198 res->no_mem = new_ir_node(NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
200 /* Proj results of start node */
201 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
202 res->frame = new_Proj (res->start, mode_P_mach, pn_Start_P_frame_base);
203 res->globals = new_Proj (res->start, mode_P_mach, pn_Start_P_globals);
204 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
205 res->args = new_Proj (res->start, mode_T, pn_Start_T_args);
207 res->graph_nr = get_irp_new_node_nr();
209 res->proj_args = NULL;
211 set_store(res->initial_mem);
213 add_immBlock_pred(res->start_block, projX);
215 * The code generation needs it. leave it in now.
216 * Use of this edge is matter of discussion, unresolved. Also possible:
217 * add_immBlock_pred(res->start_block, res->start_block), but invalid typed.
219 mature_immBlock (res->current_block);
221 /*-- Make a block to start with --*/
222 first_block = new_immBlock();
223 add_immBlock_pred (first_block, projX);
225 res->method_execution_frequency = -1;
232 new_ir_graph (entity *ent, int n_loc)
234 ir_graph *res = new_r_ir_graph (ent, n_loc);
235 add_irp_irg(res); /* remember this graph global. */
239 /* Make a rudimentary ir graph for the constant code.
240 Must look like a correct irg, spare everything else. */
241 ir_graph *new_const_code_irg(void) {
247 /* inform statistics here, as blocks will be already build on this graph */
248 hook_new_graph(res, NULL);
250 current_ir_graph = res;
251 res->n_loc = 1; /* Only the memory. */
252 res->visited = 0; /* visited flag, for the ir walker */
253 res->block_visited=0; /* visited flag, for the 'block'-walker */
254 #if USE_EXPLICIT_PHI_IN_STACK
255 res->Phi_in_stack = NULL;
257 res->kind = k_ir_graph;
258 res->obst = xmalloc (sizeof(*res->obst));
259 obstack_init (res->obst);
260 res->phase_state = phase_building;
261 res->op_pin_state_pinned = op_pin_state_pinned;
262 res->value_table = new_identities (); /* value table for global value
263 numbering for optimizing use in
266 res->frame_type = NULL;
268 /* -- The end block -- */
269 res->end_block = new_immBlock ();
270 res->end = new_End ();
271 res->end_reg = res->end;
272 res->end_except = res->end;
273 mature_immBlock(get_cur_block()); /* mature the end block */
275 /* -- The start block -- */
276 res->start_block = new_immBlock ();
277 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
278 res->no_mem = new_ir_node (NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
279 res->start = new_Start ();
280 /* Proj results of start node */
281 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
282 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
283 add_immBlock_pred (res->start_block, projX);
284 mature_immBlock (res->start_block); /* mature the start block */
286 add_immBlock_pred (new_immBlock (), projX);
287 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
289 /* Set the visited flag high enough that the blocks will never be visited. */
290 set_irn_visited(get_cur_block(), -1);
291 set_Block_block_visited(get_cur_block(), -1);
292 set_Block_block_visited(res->start_block, -1);
293 set_irn_visited(res->start_block, -1);
294 set_irn_visited(res->bad, -1);
295 set_irn_visited(res->no_mem, -1);
297 res->phase_state = phase_high;
302 /* Defined in iropt.c */
303 void del_identities (pset *value_table);
305 /* Frees the passed irgraph.
306 Deallocates all nodes in this graph and the ir_graph structure.
307 Sets the field irgraph in the corresponding entity to NULL.
308 Does not remove the irgraph from the list in irprog (requires
309 inefficient search, call remove_irp_irg by hand).
310 Does not free types, entities or modes that are used only by this
311 graph, nor the entity standing for this graph. */
312 void free_ir_graph (ir_graph *irg) {
314 hook_free_graph(irg);
315 if (irg->outs_state != outs_none) free_outs(irg);
316 if (irg->frame_type) free_type(irg->frame_type);
317 if (irg->value_table) del_identities(irg->value_table);
319 peculiarity pec = get_entity_peculiarity (irg->ent);
320 set_entity_peculiarity (irg->ent, peculiarity_description);
321 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
322 set_entity_peculiarity (irg->ent, pec);
326 obstack_free(irg->obst,NULL);
328 #if USE_EXPLICIT_PHI_IN_STACK
329 free_Phi_in_stack(irg->Phi_in_stack);
331 if (irg->loc_descriptions)
332 free(irg->loc_descriptions);
337 /* access routines for all ir_graph attributes:
339 {attr type} get_irg_{attribute name} (ir_graph *irg);
340 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
343 (is_ir_graph)(const void *thing) {
344 return _is_ir_graph(thing);
347 /* Outputs a unique number for this node */
350 get_irg_graph_nr(ir_graph *irg) {
353 return irg->graph_nr;
360 (get_irg_start_block)(const ir_graph *irg) {
361 return _get_irg_start_block(irg);
365 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
366 _set_irg_start_block(irg, node);
370 (get_irg_start)(const ir_graph *irg) {
371 return _get_irg_start(irg);
375 (set_irg_start)(ir_graph *irg, ir_node *node) {
376 _set_irg_start(irg, node);
380 (get_irg_end_block)(const ir_graph *irg) {
381 return _get_irg_end_block(irg);
385 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
386 _set_irg_end_block(irg, node);
390 (get_irg_end)(const ir_graph *irg) {
391 return _get_irg_end(irg);
395 (set_irg_end)(ir_graph *irg, ir_node *node) {
396 _set_irg_end(irg, node);
400 (get_irg_end_reg)(const ir_graph *irg) {
401 return _get_irg_end_reg(irg);
404 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
405 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
410 (get_irg_end_except)(const ir_graph *irg) {
411 return _get_irg_end_except(irg);
414 void set_irg_end_except (ir_graph *irg, ir_node *node) {
415 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
416 irg->end_except = node;
420 (get_irg_cstore)(const ir_graph *irg) {
421 return _get_irg_cstore(irg);
425 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
426 _set_irg_cstore(irg, node);
430 (get_irg_frame)(const ir_graph *irg) {
431 return _get_irg_frame(irg);
435 (set_irg_frame)(ir_graph *irg, ir_node *node) {
436 _set_irg_frame(irg, node);
440 (get_irg_globals)(const ir_graph *irg) {
441 return _get_irg_globals(irg);
445 (set_irg_globals)(ir_graph *irg, ir_node *node) {
446 _set_irg_globals(irg, node);
450 (get_irg_initial_mem)(const ir_graph *irg) {
451 return _get_irg_initial_mem(irg);
455 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
456 _set_irg_initial_mem(irg, node);
460 (get_irg_args)(const ir_graph *irg) {
461 return _get_irg_args(irg);
465 (set_irg_args)(ir_graph *irg, ir_node *node) {
466 _set_irg_args(irg, node);
470 (get_irg_proj_args) (const ir_graph *irg) {
471 return _get_irg_proj_args (irg);
475 (set_irg_proj_args) (ir_graph *irg, ir_node **nodes) {
476 _set_irg_proj_args (irg, nodes);
480 (get_irg_bad)(const ir_graph *irg) {
481 return _get_irg_bad(irg);
485 (set_irg_bad)(ir_graph *irg, ir_node *node) {
486 _set_irg_bad(irg, node);
490 (get_irg_no_mem)(const ir_graph *irg) {
491 return _get_irg_no_mem(irg);
495 (set_irg_no_mem)(ir_graph *irg, ir_node *node) {
496 _set_irg_no_mem(irg, node);
500 (get_irg_current_block)(const ir_graph *irg) {
501 return _get_irg_current_block(irg);
505 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
506 _set_irg_current_block(irg, node);
510 (get_irg_entity)(const ir_graph *irg) {
511 return _get_irg_entity(irg);
515 (set_irg_entity)(ir_graph *irg, entity *ent) {
516 _set_irg_entity(irg, ent);
520 (get_irg_frame_type)(const ir_graph *irg) {
521 return _get_irg_frame_type(irg);
525 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
526 _set_irg_frame_type(irg, ftp);
530 /* To test for a frame type */
532 is_frame_type(const type *ftp) {
534 if (is_Class_type(ftp)) {
535 for (i = 0; i < get_irp_n_irgs(); i++) {
536 const type *frame_tp = get_irg_frame_type(get_irp_irg(i));
537 if (ftp == frame_tp) return true;
544 get_irg_n_locs (ir_graph *irg)
546 if (get_opt_precise_exc_context())
547 return irg->n_loc - 1 - 1;
549 return irg->n_loc - 1;
553 set_irg_n_loc (ir_graph *irg, int n_loc)
555 if (get_opt_precise_exc_context())
556 irg->n_loc = n_loc + 1 + 1;
558 irg->n_loc = n_loc + 1;
563 /* Returns the obstack associated with the graph. */
565 (get_irg_obstack)(const ir_graph *irg) {
566 return _get_irg_obstack(irg);
570 * Returns true if the node n is allocated on the storage of graph irg.
572 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
574 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
576 struct _obstack_chunk *p;
579 * checks weather the ir_node pointer is on the obstack.
580 * A more sophisticated check would test the "whole" ir_node
582 for (p = irg->obst->chunk; p; p = p->prev) {
583 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
591 (get_irg_phase_state)(const ir_graph *irg) {
592 return _get_irg_phase_state(irg);
596 (set_irg_phase_low)(ir_graph *irg) {
597 _set_irg_phase_low(irg);
601 (get_irg_pinned)(const ir_graph *irg) {
602 return _get_irg_pinned(irg);
606 (get_irg_outs_state)(const ir_graph *irg) {
607 return _get_irg_outs_state(irg);
611 (set_irg_outs_inconsistent)(ir_graph *irg) {
612 _set_irg_outs_inconsistent(irg);
616 (get_irg_dom_state)(const ir_graph *irg) {
617 return _get_irg_dom_state(irg);
621 (set_irg_dom_inconsistent)(ir_graph *irg) {
622 _set_irg_dom_inconsistent(irg);
626 (get_irg_loopinfo_state)(const ir_graph *irg) {
627 return _get_irg_loopinfo_state(irg);
631 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
632 _set_irg_loopinfo_state(irg, s);
636 set_irg_loopinfo_inconsistent(ir_graph *irg) {
637 if (irg->loopinfo_state == loopinfo_ip_consistent)
638 irg->loopinfo_state = loopinfo_ip_inconsistent;
640 else if (irg->loopinfo_state == loopinfo_consistent)
641 irg->loopinfo_state = loopinfo_inconsistent;
643 else if (irg->loopinfo_state == loopinfo_cf_ip_consistent)
644 irg->loopinfo_state = loopinfo_cf_ip_inconsistent;
646 else if (irg->loopinfo_state == loopinfo_cf_consistent)
647 irg->loopinfo_state = loopinfo_cf_inconsistent;
651 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
652 _set_irg_pinned(irg, p);
655 irg_callee_info_state
656 (get_irg_callee_info_state)(const ir_graph *irg) {
657 return _get_irg_callee_info_state(irg);
661 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
662 _set_irg_callee_info_state(irg, s);
666 (get_irg_inline_property)(const ir_graph *irg) {
667 return _get_irg_inline_property(irg);
671 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
672 _set_irg_inline_property(irg, s);
676 (set_irg_link)(ir_graph *irg, void *thing) {
677 _set_irg_link(irg, thing);
681 (get_irg_link)(const ir_graph *irg) {
682 return _get_irg_link(irg);
685 /** maximum visited flag content of all ir_graph visited fields. */
686 static unsigned long max_irg_visited = 0;
689 (get_irg_visited)(const ir_graph *irg) {
690 return _get_irg_visited(irg);
694 set_irg_visited (ir_graph *irg, unsigned long visited)
696 irg->visited = visited;
697 if (irg->visited > max_irg_visited) {
698 max_irg_visited = irg->visited;
703 inc_irg_visited (ir_graph *irg)
705 if (++irg->visited > max_irg_visited) {
706 max_irg_visited = irg->visited;
711 get_max_irg_visited(void)
715 for(i = 0; i < get_irp_n_irgs(); i++)
716 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
718 return max_irg_visited;
721 void set_max_irg_visited(int val) {
722 max_irg_visited = val;
726 inc_max_irg_visited(void)
730 for(i = 0; i < get_irp_n_irgs(); i++)
731 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
734 return max_irg_visited;
738 (get_irg_block_visited)(const ir_graph *irg) {
739 return _get_irg_block_visited(irg);
743 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
744 _set_irg_block_visited(irg, visited);
748 (inc_irg_block_visited)(ir_graph *irg) {
749 _inc_irg_block_visited(irg);
754 * walker Start->End: places Proj nodes into the same block
755 * as it's predecessors
760 static void normalize_proj_walker(ir_node *n, void *env)
763 ir_node *pred = get_Proj_pred(n);
764 ir_node *block = get_nodes_block(pred);
766 set_nodes_block(n, block);
770 /* move Proj nodes into the same block as its predecessors */
771 void normalize_proj_nodes(ir_graph *irg)
773 irg_walk_graph(irg, NULL, normalize_proj_walker, NULL);
774 set_irg_outs_inconsistent(irg);
777 /* set a description for local value n */
778 void set_irg_loc_description(ir_graph *irg, int n, void *description)
780 assert(0 <= n && n < irg->n_loc);
782 if (! irg->loc_descriptions)
783 irg->loc_descriptions = xcalloc(sizeof(*irg->loc_descriptions), irg->n_loc);
785 irg->loc_descriptions[n] = description;
788 /* get the description for local value n */
789 void *get_irg_loc_description(ir_graph *irg, int n)
791 assert(0 <= n && n < irg->n_loc);
792 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
795 /* register additional space in an IR graph */
796 size_t register_additional_graph_data(size_t size)
798 assert(!forbid_new_data && "Too late to register additional node data");
803 return additional_graph_data_size += size;