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 edges_init_graph(res);
132 /* inform statistics here, as blocks will be already build on this graph */
133 hook_new_graph(res, ent);
135 current_ir_graph = res;
137 /*-- initialized for each graph. --*/
138 if (get_opt_precise_exc_context()) {
139 res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
140 dereferenced in this graph plus one for
141 the store plus one for links to fragile
142 operations. n_loc is not the number of
143 parameters to the procedure! */
146 res->n_loc = n_loc + 1; /* number of local variables that are never
147 dereferenced in this graph plus one for
148 the store. This is not the number of parameters
152 /* descriptions will be allocated on demand */
153 res->loc_descriptions = NULL;
155 res->visited = 0; /* visited flag, for the ir walker */
156 res->block_visited = 0; /* visited flag, for the 'block'-walker */
158 #if USE_EXPLICIT_PHI_IN_STACK
159 res->Phi_in_stack = new_Phi_in_stack(); /* A stack needed for automatic Phi
162 res->kind = k_ir_graph;
163 res->obst = xmalloc (sizeof(*res->obst));
164 obstack_init (res->obst);
165 res->value_table = new_identities (); /* value table for global value
166 numbering for optimizing use in
170 res->phase_state = phase_building;
171 res->op_pin_state_pinned = op_pin_state_pinned;
172 res->outs_state = outs_none;
173 res->dom_state = dom_none;
174 res->typeinfo_state = irg_typeinfo_none;
175 res->loopinfo_state = loopinfo_none;
177 /*-- Type information for the procedure of the graph --*/
179 set_entity_irg(ent, res);
181 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
182 res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
184 /* Remove type from type list. Must be treated differently than other types. */
185 remove_irp_type_from_list(res->frame_type);
187 /*-- Nodes needed in every graph --*/
188 res->end_block = new_immBlock();
189 res->end = new_End();
190 res->end_reg = res->end;
191 res->end_except = res->end;
193 res->start_block = new_immBlock();
194 res->start = new_Start();
195 res->bad = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
196 res->no_mem = new_ir_node(NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
198 /* Proj results of start node */
199 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
200 res->frame = new_Proj (res->start, mode_P_mach, pn_Start_P_frame_base);
201 res->globals = new_Proj (res->start, mode_P_mach, pn_Start_P_globals);
202 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
203 res->args = new_Proj (res->start, mode_T, pn_Start_T_args);
205 res->graph_nr = get_irp_new_node_nr();
207 res->proj_args = NULL;
209 set_store(res->initial_mem);
211 add_immBlock_pred(res->start_block, projX);
213 * The code generation needs it. leave it in now.
214 * Use of this edge is matter of discussion, unresolved. Also possible:
215 * add_immBlock_pred(res->start_block, res->start_block), but invalid typed.
217 mature_immBlock (res->current_block);
219 /*-- Make a block to start with --*/
220 first_block = new_immBlock();
221 add_immBlock_pred (first_block, projX);
223 res->method_execution_frequency = -1;
230 new_ir_graph (entity *ent, int n_loc)
232 ir_graph *res = new_r_ir_graph (ent, n_loc);
233 add_irp_irg(res); /* remember this graph global. */
237 /* Make a rudimentary ir graph for the constant code.
238 Must look like a correct irg, spare everything else. */
239 ir_graph *new_const_code_irg(void) {
245 /* inform statistics here, as blocks will be already build on this graph */
246 hook_new_graph(res, NULL);
248 current_ir_graph = res;
249 res->n_loc = 1; /* Only the memory. */
250 res->visited = 0; /* visited flag, for the ir walker */
251 res->block_visited=0; /* visited flag, for the 'block'-walker */
252 #if USE_EXPLICIT_PHI_IN_STACK
253 res->Phi_in_stack = NULL;
255 res->kind = k_ir_graph;
256 res->obst = xmalloc (sizeof(*res->obst));
257 obstack_init (res->obst);
258 res->phase_state = phase_building;
259 res->op_pin_state_pinned = op_pin_state_pinned;
260 res->value_table = new_identities (); /* value table for global value
261 numbering for optimizing use in
264 res->frame_type = NULL;
266 /* -- The end block -- */
267 res->end_block = new_immBlock ();
268 res->end = new_End ();
269 res->end_reg = res->end;
270 res->end_except = res->end;
271 mature_immBlock(get_cur_block()); /* mature the end block */
273 /* -- The start block -- */
274 res->start_block = new_immBlock ();
275 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
276 res->no_mem = new_ir_node (NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
277 res->start = new_Start ();
278 /* Proj results of start node */
279 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
280 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
281 add_immBlock_pred (res->start_block, projX);
282 mature_immBlock (res->start_block); /* mature the start block */
284 add_immBlock_pred (new_immBlock (), projX);
285 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
287 /* Set the visited flag high enough that the blocks will never be visited. */
288 set_irn_visited(get_cur_block(), -1);
289 set_Block_block_visited(get_cur_block(), -1);
290 set_Block_block_visited(res->start_block, -1);
291 set_irn_visited(res->start_block, -1);
292 set_irn_visited(res->bad, -1);
293 set_irn_visited(res->no_mem, -1);
295 res->phase_state = phase_high;
300 /* Defined in iropt.c */
301 void del_identities (pset *value_table);
303 /* Frees the passed irgraph.
304 Deallocates all nodes in this graph and the ir_graph structure.
305 Sets the field irgraph in the corresponding entity to NULL.
306 Does not remove the irgraph from the list in irprog (requires
307 inefficient search, call remove_irp_irg by hand).
308 Does not free types, entities or modes that are used only by this
309 graph, nor the entity standing for this graph. */
310 void free_ir_graph (ir_graph *irg) {
312 hook_free_graph(irg);
313 if (irg->outs_state != outs_none) free_outs(irg);
314 if (irg->frame_type) free_type(irg->frame_type);
315 if (irg->value_table) del_identities(irg->value_table);
317 peculiarity pec = get_entity_peculiarity (irg->ent);
318 set_entity_peculiarity (irg->ent, peculiarity_description);
319 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
320 set_entity_peculiarity (irg->ent, pec);
324 obstack_free(irg->obst,NULL);
326 #if USE_EXPLICIT_PHI_IN_STACK
327 free_Phi_in_stack(irg->Phi_in_stack);
329 if (irg->loc_descriptions)
330 free(irg->loc_descriptions);
335 /* access routines for all ir_graph attributes:
337 {attr type} get_irg_{attribute name} (ir_graph *irg);
338 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
341 (is_ir_graph)(const void *thing) {
342 return _is_ir_graph(thing);
345 /* Outputs a unique number for this node */
348 get_irg_graph_nr(ir_graph *irg) {
351 return irg->graph_nr;
358 (get_irg_start_block)(const ir_graph *irg) {
359 return _get_irg_start_block(irg);
363 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
364 _set_irg_start_block(irg, node);
368 (get_irg_start)(const ir_graph *irg) {
369 return _get_irg_start(irg);
373 (set_irg_start)(ir_graph *irg, ir_node *node) {
374 _set_irg_start(irg, node);
378 (get_irg_end_block)(const ir_graph *irg) {
379 return _get_irg_end_block(irg);
383 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
384 _set_irg_end_block(irg, node);
388 (get_irg_end)(const ir_graph *irg) {
389 return _get_irg_end(irg);
393 (set_irg_end)(ir_graph *irg, ir_node *node) {
394 _set_irg_end(irg, node);
398 (get_irg_end_reg)(const ir_graph *irg) {
399 return _get_irg_end_reg(irg);
402 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
403 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
408 (get_irg_end_except)(const ir_graph *irg) {
409 return _get_irg_end_except(irg);
412 void set_irg_end_except (ir_graph *irg, ir_node *node) {
413 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
414 irg->end_except = node;
418 (get_irg_cstore)(const ir_graph *irg) {
419 return _get_irg_cstore(irg);
423 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
424 _set_irg_cstore(irg, node);
428 (get_irg_frame)(const ir_graph *irg) {
429 return _get_irg_frame(irg);
433 (set_irg_frame)(ir_graph *irg, ir_node *node) {
434 _set_irg_frame(irg, node);
438 (get_irg_globals)(const ir_graph *irg) {
439 return _get_irg_globals(irg);
443 (set_irg_globals)(ir_graph *irg, ir_node *node) {
444 _set_irg_globals(irg, node);
448 (get_irg_initial_mem)(const ir_graph *irg) {
449 return _get_irg_initial_mem(irg);
453 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
454 _set_irg_initial_mem(irg, node);
458 (get_irg_args)(const ir_graph *irg) {
459 return _get_irg_args(irg);
463 (set_irg_args)(ir_graph *irg, ir_node *node) {
464 _set_irg_args(irg, node);
468 (get_irg_proj_args) (const ir_graph *irg) {
469 return _get_irg_proj_args (irg);
473 (set_irg_proj_args) (ir_graph *irg, ir_node **nodes) {
474 _set_irg_proj_args (irg, nodes);
478 (get_irg_bad)(const ir_graph *irg) {
479 return _get_irg_bad(irg);
483 (set_irg_bad)(ir_graph *irg, ir_node *node) {
484 _set_irg_bad(irg, node);
488 (get_irg_no_mem)(const ir_graph *irg) {
489 return _get_irg_no_mem(irg);
493 (set_irg_no_mem)(ir_graph *irg, ir_node *node) {
494 _set_irg_no_mem(irg, node);
498 (get_irg_current_block)(const ir_graph *irg) {
499 return _get_irg_current_block(irg);
503 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
504 _set_irg_current_block(irg, node);
508 (get_irg_entity)(const ir_graph *irg) {
509 return _get_irg_entity(irg);
513 (set_irg_entity)(ir_graph *irg, entity *ent) {
514 _set_irg_entity(irg, ent);
518 (get_irg_frame_type)(const ir_graph *irg) {
519 return _get_irg_frame_type(irg);
523 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
524 _set_irg_frame_type(irg, ftp);
528 /* To test for a frame type */
530 is_frame_type(const type *ftp) {
532 if (is_Class_type(ftp)) {
533 for (i = 0; i < get_irp_n_irgs(); i++) {
534 const type *frame_tp = get_irg_frame_type(get_irp_irg(i));
535 if (ftp == frame_tp) return true;
542 get_irg_n_locs (ir_graph *irg)
544 if (get_opt_precise_exc_context())
545 return irg->n_loc - 1 - 1;
547 return irg->n_loc - 1;
551 set_irg_n_loc (ir_graph *irg, int n_loc)
553 if (get_opt_precise_exc_context())
554 irg->n_loc = n_loc + 1 + 1;
556 irg->n_loc = n_loc + 1;
561 /* Returns the obstack associated with the graph. */
563 (get_irg_obstack)(const ir_graph *irg) {
564 return _get_irg_obstack(irg);
568 * Returns true if the node n is allocated on the storage of graph irg.
570 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
572 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
574 struct _obstack_chunk *p;
577 * checks weather the ir_node pointer is on the obstack.
578 * A more sophisticated check would test the "whole" ir_node
580 for (p = irg->obst->chunk; p; p = p->prev) {
581 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
589 (get_irg_phase_state)(const ir_graph *irg) {
590 return _get_irg_phase_state(irg);
594 (set_irg_phase_low)(ir_graph *irg) {
595 _set_irg_phase_low(irg);
599 (get_irg_pinned)(const ir_graph *irg) {
600 return _get_irg_pinned(irg);
604 (get_irg_outs_state)(const ir_graph *irg) {
605 return _get_irg_outs_state(irg);
609 (set_irg_outs_inconsistent)(ir_graph *irg) {
610 _set_irg_outs_inconsistent(irg);
614 (get_irg_dom_state)(const ir_graph *irg) {
615 return _get_irg_dom_state(irg);
619 (set_irg_dom_inconsistent)(ir_graph *irg) {
620 _set_irg_dom_inconsistent(irg);
624 (get_irg_loopinfo_state)(const ir_graph *irg) {
625 return _get_irg_loopinfo_state(irg);
629 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
630 _set_irg_loopinfo_state(irg, s);
634 set_irg_loopinfo_inconsistent(ir_graph *irg) {
635 if (irg->loopinfo_state == loopinfo_ip_consistent)
636 irg->loopinfo_state = loopinfo_ip_inconsistent;
638 else if (irg->loopinfo_state == loopinfo_consistent)
639 irg->loopinfo_state = loopinfo_inconsistent;
641 else if (irg->loopinfo_state == loopinfo_cf_ip_consistent)
642 irg->loopinfo_state = loopinfo_cf_ip_inconsistent;
644 else if (irg->loopinfo_state == loopinfo_cf_consistent)
645 irg->loopinfo_state = loopinfo_cf_inconsistent;
649 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
650 _set_irg_pinned(irg, p);
653 irg_callee_info_state
654 (get_irg_callee_info_state)(const ir_graph *irg) {
655 return _get_irg_callee_info_state(irg);
659 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
660 _set_irg_callee_info_state(irg, s);
664 (get_irg_inline_property)(const ir_graph *irg) {
665 return _get_irg_inline_property(irg);
669 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
670 _set_irg_inline_property(irg, s);
674 (set_irg_link)(ir_graph *irg, void *thing) {
675 _set_irg_link(irg, thing);
679 (get_irg_link)(const ir_graph *irg) {
680 return _get_irg_link(irg);
683 /** maximum visited flag content of all ir_graph visited fields. */
684 static unsigned long max_irg_visited = 0;
687 (get_irg_visited)(const ir_graph *irg) {
688 return _get_irg_visited(irg);
692 set_irg_visited (ir_graph *irg, unsigned long visited)
694 irg->visited = visited;
695 if (irg->visited > max_irg_visited) {
696 max_irg_visited = irg->visited;
701 inc_irg_visited (ir_graph *irg)
703 if (++irg->visited > max_irg_visited) {
704 max_irg_visited = irg->visited;
709 get_max_irg_visited(void)
713 for(i = 0; i < get_irp_n_irgs(); i++)
714 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
716 return max_irg_visited;
719 void set_max_irg_visited(int val) {
720 max_irg_visited = val;
724 inc_max_irg_visited(void)
728 for(i = 0; i < get_irp_n_irgs(); i++)
729 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
732 return max_irg_visited;
736 (get_irg_block_visited)(const ir_graph *irg) {
737 return _get_irg_block_visited(irg);
741 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
742 _set_irg_block_visited(irg, visited);
746 (inc_irg_block_visited)(ir_graph *irg) {
747 _inc_irg_block_visited(irg);
752 * walker Start->End: places Proj nodes into the same block
753 * as it's predecessors
758 static void normalize_proj_walker(ir_node *n, void *env)
761 ir_node *pred = get_Proj_pred(n);
762 ir_node *block = get_nodes_block(pred);
764 set_nodes_block(n, block);
768 /* move Proj nodes into the same block as its predecessors */
769 void normalize_proj_nodes(ir_graph *irg)
771 irg_walk_graph(irg, NULL, normalize_proj_walker, NULL);
772 set_irg_outs_inconsistent(irg);
775 /* set a description for local value n */
776 void set_irg_loc_description(ir_graph *irg, int n, void *description)
778 assert(0 <= n && n < irg->n_loc);
780 if (! irg->loc_descriptions)
781 irg->loc_descriptions = xcalloc(sizeof(*irg->loc_descriptions), irg->n_loc);
783 irg->loc_descriptions[n] = description;
786 /* get the description for local value n */
787 void *get_irg_loc_description(ir_graph *irg, int n)
789 assert(0 <= n && n < irg->n_loc);
790 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
793 /* register additional space in an IR graph */
794 size_t register_additional_graph_data(size_t size)
796 assert(!forbid_new_data && "Too late to register additional node data");
801 return additional_graph_data_size += size;