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->inline_property = irg_inline_any;
180 res->additional_properties = 0;
182 res->phase_state = phase_building;
183 res->op_pin_state_pinned = op_pin_state_pinned;
184 res->outs_state = outs_none;
185 res->dom_state = dom_none;
186 res->typeinfo_state = ir_typeinfo_none;
187 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
188 res->callee_info_state = irg_callee_info_none;
189 res->loopinfo_state = loopinfo_none;
190 res->execfreq_state = exec_freq_none;
191 res->class_cast_state = ir_class_casts_transitive;
192 res->extblk_state = ir_extblk_info_none;
194 /*-- Type information for the procedure of the graph --*/
196 set_entity_irg(ent, res);
198 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
199 res->frame_type = new_type_frame(mangle(get_entity_ident(ent), frame_type_suffix));
201 /*-- Nodes needed in every graph --*/
202 res->end_block = new_immBlock();
203 res->end = new_End();
204 res->end_reg = res->end;
205 res->end_except = res->end;
207 res->start_block = new_immBlock();
208 res->start = new_Start();
209 res->bad = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
210 res->no_mem = new_ir_node(NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
212 /* Proj results of start node */
213 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
214 res->frame = new_Proj (res->start, mode_P_data, pn_Start_P_frame_base);
215 res->globals = new_Proj (res->start, mode_P_data, pn_Start_P_globals);
216 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
217 res->args = new_Proj (res->start, mode_T, pn_Start_T_args);
219 res->graph_nr = get_irp_new_node_nr();
221 res->proj_args = NULL;
223 set_store(res->initial_mem);
225 add_immBlock_pred(res->start_block, projX);
227 * The code generation needs it. leave it in now.
228 * Use of this edge is matter of discussion, unresolved. Also possible:
229 * add_immBlock_pred(res->start_block, res->start_block), but invalid typed.
231 mature_immBlock (res->current_block);
233 /*-- Make a block to start with --*/
234 first_block = new_immBlock();
235 add_immBlock_pred (first_block, projX);
237 res->method_execution_frequency = -1;
244 new_ir_graph (entity *ent, int n_loc)
246 ir_graph *res = new_r_ir_graph (ent, n_loc);
247 add_irp_irg(res); /* remember this graph global. */
251 /* Make a rudimentary ir graph for the constant code.
252 Must look like a correct irg, spare everything else. */
253 ir_graph *new_const_code_irg(void) {
259 /* inform statistics here, as blocks will be already build on this graph */
260 hook_new_graph(res, NULL);
262 current_ir_graph = res;
263 res->n_loc = 1; /* Only the memory. */
264 res->visited = 0; /* visited flag, for the ir walker */
265 res->block_visited=0; /* visited flag, for the 'block'-walker */
266 #if USE_EXPLICIT_PHI_IN_STACK
267 res->Phi_in_stack = NULL;
269 res->kind = k_ir_graph;
270 res->obst = xmalloc (sizeof(*res->obst));
271 obstack_init (res->obst);
272 res->extbb_obst = NULL;
274 res->phase_state = phase_building;
275 res->op_pin_state_pinned = op_pin_state_pinned;
276 res->extblk_state = ir_extblk_info_none;
278 res->value_table = new_identities (); /* value table for global value
279 numbering for optimizing use in
282 res->frame_type = NULL;
284 /* -- The end block -- */
285 res->end_block = new_immBlock ();
286 res->end = new_End ();
287 res->end_reg = res->end;
288 res->end_except = res->end;
289 mature_immBlock(get_cur_block()); /* mature the end block */
291 /* -- The start block -- */
292 res->start_block = new_immBlock ();
293 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
294 res->no_mem = new_ir_node (NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
295 res->start = new_Start ();
296 /* Proj results of start node */
297 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
298 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
299 add_immBlock_pred (res->start_block, projX);
300 mature_immBlock (res->start_block); /* mature the start block */
302 add_immBlock_pred (new_immBlock (), projX);
303 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
305 /* Set the visited flag high enough that the blocks will never be visited. */
306 set_irn_visited(get_cur_block(), -1);
307 set_Block_block_visited(get_cur_block(), -1);
308 set_Block_block_visited(res->start_block, -1);
309 set_irn_visited(res->start_block, -1);
310 set_irn_visited(res->bad, -1);
311 set_irn_visited(res->no_mem, -1);
313 res->phase_state = phase_high;
318 /* Defined in iropt.c */
319 void del_identities (pset *value_table);
321 /* Frees the passed irgraph.
322 Deallocates all nodes in this graph and the ir_graph structure.
323 Sets the field irgraph in the corresponding entity to NULL.
324 Does not remove the irgraph from the list in irprog (requires
325 inefficient search, call remove_irp_irg by hand).
326 Does not free types, entities or modes that are used only by this
327 graph, nor the entity standing for this graph. */
328 void free_ir_graph (ir_graph *irg) {
329 assert(is_ir_graph(irg));
331 hook_free_graph(irg);
332 if (irg->outs_state != outs_none) free_irg_outs(irg);
333 if (irg->frame_type) free_type(irg->frame_type);
334 if (irg->value_table) del_identities(irg->value_table);
336 peculiarity pec = get_entity_peculiarity (irg->ent);
337 set_entity_peculiarity (irg->ent, peculiarity_description);
338 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
339 set_entity_peculiarity (irg->ent, pec);
343 obstack_free(irg->obst,NULL);
345 #if USE_EXPLICIT_PHI_IN_STACK
346 free_Phi_in_stack(irg->Phi_in_stack);
348 if (irg->loc_descriptions)
349 free(irg->loc_descriptions);
354 /* access routines for all ir_graph attributes:
356 {attr type} get_irg_{attribute name} (ir_graph *irg);
357 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
360 (is_ir_graph)(const void *thing) {
361 return _is_ir_graph(thing);
364 /* Outputs a unique number for this node */
367 get_irg_graph_nr(ir_graph *irg) {
370 return irg->graph_nr;
377 (get_irg_start_block)(const ir_graph *irg) {
378 return _get_irg_start_block(irg);
382 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
383 _set_irg_start_block(irg, node);
387 (get_irg_start)(const ir_graph *irg) {
388 return _get_irg_start(irg);
392 (set_irg_start)(ir_graph *irg, ir_node *node) {
393 _set_irg_start(irg, node);
397 (get_irg_end_block)(const ir_graph *irg) {
398 return _get_irg_end_block(irg);
402 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
403 _set_irg_end_block(irg, node);
407 (get_irg_end)(const ir_graph *irg) {
408 return _get_irg_end(irg);
412 (set_irg_end)(ir_graph *irg, ir_node *node) {
413 _set_irg_end(irg, node);
417 (get_irg_end_reg)(const ir_graph *irg) {
418 return _get_irg_end_reg(irg);
421 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
422 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
427 (get_irg_end_except)(const ir_graph *irg) {
428 return _get_irg_end_except(irg);
431 void set_irg_end_except (ir_graph *irg, ir_node *node) {
432 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
433 irg->end_except = node;
437 (get_irg_cstore)(const ir_graph *irg) {
438 return _get_irg_cstore(irg);
442 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
443 _set_irg_cstore(irg, node);
447 (get_irg_frame)(const ir_graph *irg) {
448 return _get_irg_frame(irg);
452 (set_irg_frame)(ir_graph *irg, ir_node *node) {
453 _set_irg_frame(irg, node);
457 (get_irg_globals)(const ir_graph *irg) {
458 return _get_irg_globals(irg);
462 (set_irg_globals)(ir_graph *irg, ir_node *node) {
463 _set_irg_globals(irg, node);
467 (get_irg_initial_mem)(const ir_graph *irg) {
468 return _get_irg_initial_mem(irg);
472 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
473 _set_irg_initial_mem(irg, node);
477 (get_irg_args)(const ir_graph *irg) {
478 return _get_irg_args(irg);
482 (set_irg_args)(ir_graph *irg, ir_node *node) {
483 _set_irg_args(irg, node);
487 (get_irg_proj_args) (const ir_graph *irg) {
488 return _get_irg_proj_args (irg);
492 (set_irg_proj_args) (ir_graph *irg, ir_node **nodes) {
493 _set_irg_proj_args (irg, nodes);
497 (get_irg_bad)(const ir_graph *irg) {
498 return _get_irg_bad(irg);
502 (set_irg_bad)(ir_graph *irg, ir_node *node) {
503 _set_irg_bad(irg, node);
507 (get_irg_no_mem)(const ir_graph *irg) {
508 return _get_irg_no_mem(irg);
512 (set_irg_no_mem)(ir_graph *irg, ir_node *node) {
513 _set_irg_no_mem(irg, node);
517 (get_irg_current_block)(const ir_graph *irg) {
518 return _get_irg_current_block(irg);
522 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
523 _set_irg_current_block(irg, node);
527 (get_irg_entity)(const ir_graph *irg) {
528 return _get_irg_entity(irg);
532 (set_irg_entity)(ir_graph *irg, entity *ent) {
533 _set_irg_entity(irg, ent);
537 (get_irg_frame_type)(ir_graph *irg) {
538 return _get_irg_frame_type(irg);
542 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
543 _set_irg_frame_type(irg, ftp);
547 get_irg_n_locs (ir_graph *irg)
549 if (get_opt_precise_exc_context())
550 return irg->n_loc - 1 - 1;
552 return irg->n_loc - 1;
556 set_irg_n_loc (ir_graph *irg, int n_loc)
558 if (get_opt_precise_exc_context())
559 irg->n_loc = n_loc + 1 + 1;
561 irg->n_loc = n_loc + 1;
566 /* Returns the obstack associated with the graph. */
568 (get_irg_obstack)(const ir_graph *irg) {
569 return _get_irg_obstack(irg);
573 * Returns true if the node n is allocated on the storage of graph irg.
575 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
577 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
579 struct _obstack_chunk *p;
582 * checks weather the ir_node pointer is on the obstack.
583 * A more sophisticated check would test the "whole" ir_node
585 for (p = irg->obst->chunk; p; p = p->prev) {
586 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
594 (get_irg_phase_state)(const ir_graph *irg) {
595 return _get_irg_phase_state(irg);
599 (set_irg_phase_low)(ir_graph *irg) {
600 _set_irg_phase_low(irg);
604 (get_irg_pinned)(const ir_graph *irg) {
605 return _get_irg_pinned(irg);
609 (get_irg_outs_state)(const ir_graph *irg) {
610 return _get_irg_outs_state(irg);
614 (set_irg_outs_inconsistent)(ir_graph *irg) {
615 _set_irg_outs_inconsistent(irg);
619 (get_irg_dom_state)(const ir_graph *irg) {
620 return _get_irg_dom_state(irg);
624 (set_irg_dom_inconsistent)(ir_graph *irg) {
625 _set_irg_dom_inconsistent(irg);
629 (get_irg_loopinfo_state)(const ir_graph *irg) {
630 return _get_irg_loopinfo_state(irg);
634 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
635 _set_irg_loopinfo_state(irg, s);
639 (set_irg_loopinfo_inconsistent)(ir_graph *irg) {
640 _set_irg_loopinfo_inconsistent(irg);
643 void set_irp_loopinfo_inconsistent(void) {
644 int i, n_irgs = get_irp_n_irgs();
645 for (i = 0; i < n_irgs; ++i) {
646 set_irg_loopinfo_inconsistent(get_irp_irg(i));
653 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
654 _set_irg_pinned(irg, p);
657 irg_callee_info_state
658 (get_irg_callee_info_state)(const ir_graph *irg) {
659 return _get_irg_callee_info_state(irg);
663 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
664 _set_irg_callee_info_state(irg, s);
668 (get_irg_inline_property)(const ir_graph *irg) {
669 return _get_irg_inline_property(irg);
673 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
674 _set_irg_inline_property(irg, s);
678 (get_irg_additional_properties)(const ir_graph *irg) {
679 return _get_irg_additional_properties(irg);
683 (set_irg_additional_properties)(ir_graph *irg, unsigned property_mask) {
684 _set_irg_additional_properties(irg, property_mask);
688 (set_irg_additional_property)(ir_graph *irg, irg_additional_property flag) {
689 _set_irg_additional_property(irg, flag);
693 (set_irg_link)(ir_graph *irg, void *thing) {
694 _set_irg_link(irg, thing);
698 (get_irg_link)(const ir_graph *irg) {
699 return _get_irg_link(irg);
702 /** maximum visited flag content of all ir_graph visited fields. */
703 static unsigned long max_irg_visited = 0;
706 (get_irg_visited)(const ir_graph *irg) {
707 return _get_irg_visited(irg);
711 set_irg_visited (ir_graph *irg, unsigned long visited)
713 irg->visited = visited;
714 if (irg->visited > max_irg_visited) {
715 max_irg_visited = irg->visited;
720 inc_irg_visited (ir_graph *irg)
722 if (++irg->visited > max_irg_visited) {
723 max_irg_visited = irg->visited;
728 get_max_irg_visited(void)
732 for(i = 0; i < get_irp_n_irgs(); i++)
733 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
735 return max_irg_visited;
738 void set_max_irg_visited(int val) {
739 max_irg_visited = val;
743 inc_max_irg_visited(void)
747 for(i = 0; i < get_irp_n_irgs(); i++)
748 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
751 return max_irg_visited;
755 (get_irg_block_visited)(const ir_graph *irg) {
756 return _get_irg_block_visited(irg);
760 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
761 _set_irg_block_visited(irg, visited);
765 (inc_irg_block_visited)(ir_graph *irg) {
766 _inc_irg_block_visited(irg);
771 * walker Start->End: places Proj nodes into the same block
772 * as it's predecessors
777 static void normalize_proj_walker(ir_node *n, void *env)
780 ir_node *pred = get_Proj_pred(n);
781 ir_node *block = get_nodes_block(pred);
783 set_nodes_block(n, block);
787 /* move Proj nodes into the same block as its predecessors */
788 void normalize_proj_nodes(ir_graph *irg)
790 irg_walk_graph(irg, NULL, normalize_proj_walker, NULL);
791 set_irg_outs_inconsistent(irg);
794 /* set a description for local value n */
795 void set_irg_loc_description(ir_graph *irg, int n, void *description)
797 assert(0 <= n && n < irg->n_loc);
799 if (! irg->loc_descriptions)
800 irg->loc_descriptions = xcalloc(sizeof(*irg->loc_descriptions), irg->n_loc);
802 irg->loc_descriptions[n] = description;
805 /* get the description for local value n */
806 void *get_irg_loc_description(ir_graph *irg, int n)
808 assert(0 <= n && n < irg->n_loc);
809 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
812 /* register additional space in an IR graph */
813 size_t register_additional_graph_data(size_t size)
815 assert(!forbid_new_data && "Too late to register additional node data");
820 return additional_graph_data_size += size;