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 firm_interprocedural_view = 0;
61 int (get_interprocedural_view)(void) {
62 return _get_interprocedural_view();
65 void (set_interprocedural_view)(int state) {
66 firm_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 firm_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 = mtp_property_inherited; /* inherited from type */
182 res->phase_state = phase_building;
183 res->irg_pinned_state = 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;
238 res->estimated_node_count = 0;
245 new_ir_graph (entity *ent, int n_loc)
247 ir_graph *res = new_r_ir_graph (ent, n_loc);
248 add_irp_irg(res); /* remember this graph global. */
252 /* Make a rudimentary ir graph for the constant code.
253 Must look like a correct irg, spare everything else. */
254 ir_graph *new_const_code_irg(void) {
260 /* inform statistics here, as blocks will be already build on this graph */
261 hook_new_graph(res, NULL);
263 current_ir_graph = res;
264 res->n_loc = 1; /* Only the memory. */
265 res->visited = 0; /* visited flag, for the ir walker */
266 res->block_visited=0; /* visited flag, for the 'block'-walker */
267 #if USE_EXPLICIT_PHI_IN_STACK
268 res->Phi_in_stack = NULL;
270 res->kind = k_ir_graph;
271 res->obst = xmalloc (sizeof(*res->obst));
272 obstack_init (res->obst);
273 res->extbb_obst = NULL;
275 res->phase_state = phase_building;
276 res->irg_pinned_state = op_pin_state_pinned;
277 res->extblk_state = ir_extblk_info_none;
279 res->value_table = new_identities (); /* value table for global value
280 numbering for optimizing use in
283 res->frame_type = NULL;
285 /* -- The end block -- */
286 res->end_block = new_immBlock ();
287 res->end = new_End ();
288 res->end_reg = res->end;
289 res->end_except = res->end;
290 mature_immBlock(get_cur_block()); /* mature the end block */
292 /* -- The start block -- */
293 res->start_block = new_immBlock ();
294 res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
295 res->no_mem = new_ir_node (NULL, res, res->start_block, op_NoMem, mode_M, 0, NULL);
296 res->start = new_Start ();
297 /* Proj results of start node */
298 res->initial_mem = new_Proj (res->start, mode_M, pn_Start_M);
299 projX = new_Proj (res->start, mode_X, pn_Start_X_initial_exec);
300 add_immBlock_pred (res->start_block, projX);
301 mature_immBlock (res->start_block); /* mature the start block */
303 add_immBlock_pred (new_immBlock (), projX);
304 mature_immBlock (get_cur_block()); /* mature the 'body' block for expressions */
306 /* Set the visited flag high enough that the blocks will never be visited. */
307 set_irn_visited(get_cur_block(), -1);
308 set_Block_block_visited(get_cur_block(), -1);
309 set_Block_block_visited(res->start_block, -1);
310 set_irn_visited(res->start_block, -1);
311 set_irn_visited(res->bad, -1);
312 set_irn_visited(res->no_mem, -1);
314 res->phase_state = phase_high;
319 /* Defined in iropt.c */
320 void del_identities (pset *value_table);
322 /* Frees the passed irgraph.
323 Deallocates all nodes in this graph and the ir_graph structure.
324 Sets the field irgraph in the corresponding entity to NULL.
325 Does not remove the irgraph from the list in irprog (requires
326 inefficient search, call remove_irp_irg by hand).
327 Does not free types, entities or modes that are used only by this
328 graph, nor the entity standing for this graph. */
329 void free_ir_graph (ir_graph *irg) {
330 assert(is_ir_graph(irg));
332 hook_free_graph(irg);
333 if (irg->outs_state != outs_none) free_irg_outs(irg);
334 if (irg->frame_type) free_type(irg->frame_type);
335 if (irg->value_table) del_identities(irg->value_table);
337 peculiarity pec = get_entity_peculiarity (irg->ent);
338 set_entity_peculiarity (irg->ent, peculiarity_description);
339 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
340 set_entity_peculiarity (irg->ent, pec);
344 obstack_free(irg->obst,NULL);
346 #if USE_EXPLICIT_PHI_IN_STACK
347 free_Phi_in_stack(irg->Phi_in_stack);
349 if (irg->loc_descriptions)
350 free(irg->loc_descriptions);
355 /* access routines for all ir_graph attributes:
357 {attr type} get_irg_{attribute name} (ir_graph *irg);
358 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
361 (is_ir_graph)(const void *thing) {
362 return _is_ir_graph(thing);
365 /* Outputs a unique number for this node */
368 get_irg_graph_nr(ir_graph *irg) {
371 return irg->graph_nr;
378 (get_irg_start_block)(const ir_graph *irg) {
379 return _get_irg_start_block(irg);
383 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
384 _set_irg_start_block(irg, node);
388 (get_irg_start)(const ir_graph *irg) {
389 return _get_irg_start(irg);
393 (set_irg_start)(ir_graph *irg, ir_node *node) {
394 _set_irg_start(irg, node);
398 (get_irg_end_block)(const ir_graph *irg) {
399 return _get_irg_end_block(irg);
403 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
404 _set_irg_end_block(irg, node);
408 (get_irg_end)(const ir_graph *irg) {
409 return _get_irg_end(irg);
413 (set_irg_end)(ir_graph *irg, ir_node *node) {
414 _set_irg_end(irg, node);
418 (get_irg_end_reg)(const ir_graph *irg) {
419 return _get_irg_end_reg(irg);
422 void set_irg_end_reg (ir_graph *irg, ir_node *node) {
423 assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
428 (get_irg_end_except)(const ir_graph *irg) {
429 return _get_irg_end_except(irg);
432 void set_irg_end_except (ir_graph *irg, ir_node *node) {
433 assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
434 irg->end_except = node;
438 (get_irg_cstore)(const ir_graph *irg) {
439 return _get_irg_cstore(irg);
443 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
444 _set_irg_cstore(irg, node);
448 (get_irg_frame)(const ir_graph *irg) {
449 return _get_irg_frame(irg);
453 (set_irg_frame)(ir_graph *irg, ir_node *node) {
454 _set_irg_frame(irg, node);
458 (get_irg_globals)(const ir_graph *irg) {
459 return _get_irg_globals(irg);
463 (set_irg_globals)(ir_graph *irg, ir_node *node) {
464 _set_irg_globals(irg, node);
468 (get_irg_initial_mem)(const ir_graph *irg) {
469 return _get_irg_initial_mem(irg);
473 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
474 _set_irg_initial_mem(irg, node);
478 (get_irg_args)(const ir_graph *irg) {
479 return _get_irg_args(irg);
483 (set_irg_args)(ir_graph *irg, ir_node *node) {
484 _set_irg_args(irg, node);
488 (get_irg_proj_args) (const ir_graph *irg) {
489 return _get_irg_proj_args (irg);
493 (set_irg_proj_args) (ir_graph *irg, ir_node **nodes) {
494 _set_irg_proj_args (irg, nodes);
498 (get_irg_bad)(const ir_graph *irg) {
499 return _get_irg_bad(irg);
503 (set_irg_bad)(ir_graph *irg, ir_node *node) {
504 _set_irg_bad(irg, node);
508 (get_irg_no_mem)(const ir_graph *irg) {
509 return _get_irg_no_mem(irg);
513 (set_irg_no_mem)(ir_graph *irg, ir_node *node) {
514 _set_irg_no_mem(irg, node);
518 (get_irg_current_block)(const ir_graph *irg) {
519 return _get_irg_current_block(irg);
523 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
524 _set_irg_current_block(irg, node);
528 (get_irg_entity)(const ir_graph *irg) {
529 return _get_irg_entity(irg);
533 (set_irg_entity)(ir_graph *irg, entity *ent) {
534 _set_irg_entity(irg, ent);
538 (get_irg_frame_type)(ir_graph *irg) {
539 return _get_irg_frame_type(irg);
543 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
544 _set_irg_frame_type(irg, ftp);
548 get_irg_n_locs (ir_graph *irg)
550 if (get_opt_precise_exc_context())
551 return irg->n_loc - 1 - 1;
553 return irg->n_loc - 1;
557 set_irg_n_loc (ir_graph *irg, int n_loc)
559 if (get_opt_precise_exc_context())
560 irg->n_loc = n_loc + 1 + 1;
562 irg->n_loc = n_loc + 1;
567 /* Returns the obstack associated with the graph. */
569 (get_irg_obstack)(const ir_graph *irg) {
570 return _get_irg_obstack(irg);
574 * Returns true if the node n is allocated on the storage of graph irg.
576 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
578 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
580 struct _obstack_chunk *p;
583 * checks weather the ir_node pointer is on the obstack.
584 * A more sophisticated check would test the "whole" ir_node
586 for (p = irg->obst->chunk; p; p = p->prev) {
587 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
595 (get_irg_phase_state)(const ir_graph *irg) {
596 return _get_irg_phase_state(irg);
600 (set_irg_phase_low)(ir_graph *irg) {
601 _set_irg_phase_low(irg);
605 (get_irg_pinned)(const ir_graph *irg) {
606 return _get_irg_pinned(irg);
610 (get_irg_outs_state)(const ir_graph *irg) {
611 return _get_irg_outs_state(irg);
615 (set_irg_outs_inconsistent)(ir_graph *irg) {
616 _set_irg_outs_inconsistent(irg);
620 (get_irg_dom_state)(const ir_graph *irg) {
621 return _get_irg_dom_state(irg);
625 (set_irg_dom_inconsistent)(ir_graph *irg) {
626 _set_irg_dom_inconsistent(irg);
630 (get_irg_loopinfo_state)(const ir_graph *irg) {
631 return _get_irg_loopinfo_state(irg);
635 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
636 _set_irg_loopinfo_state(irg, s);
640 (set_irg_loopinfo_inconsistent)(ir_graph *irg) {
641 _set_irg_loopinfo_inconsistent(irg);
644 void set_irp_loopinfo_inconsistent(void) {
645 int i, n_irgs = get_irp_n_irgs();
646 for (i = 0; i < n_irgs; ++i) {
647 set_irg_loopinfo_inconsistent(get_irp_irg(i));
654 (set_irg_pinned)(ir_graph *irg, op_pin_state p) {
655 _set_irg_pinned(irg, p);
658 irg_callee_info_state
659 (get_irg_callee_info_state)(const ir_graph *irg) {
660 return _get_irg_callee_info_state(irg);
664 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
665 _set_irg_callee_info_state(irg, s);
669 (get_irg_inline_property)(const ir_graph *irg) {
670 return _get_irg_inline_property(irg);
674 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
675 _set_irg_inline_property(irg, s);
679 (get_irg_additional_properties)(const ir_graph *irg) {
680 return _get_irg_additional_properties(irg);
684 (set_irg_additional_properties)(ir_graph *irg, unsigned property_mask) {
685 _set_irg_additional_properties(irg, property_mask);
689 (set_irg_additional_property)(ir_graph *irg, mtp_additional_property flag) {
690 _set_irg_additional_property(irg, flag);
694 (set_irg_link)(ir_graph *irg, void *thing) {
695 _set_irg_link(irg, thing);
699 (get_irg_link)(const ir_graph *irg) {
700 return _get_irg_link(irg);
703 /** maximum visited flag content of all ir_graph visited fields. */
704 static unsigned long max_irg_visited = 0;
707 (get_irg_visited)(const ir_graph *irg) {
708 return _get_irg_visited(irg);
712 set_irg_visited (ir_graph *irg, unsigned long visited)
714 irg->visited = visited;
715 if (irg->visited > max_irg_visited) {
716 max_irg_visited = irg->visited;
721 inc_irg_visited (ir_graph *irg)
723 if (++irg->visited > max_irg_visited) {
724 max_irg_visited = irg->visited;
729 get_max_irg_visited(void)
733 for(i = 0; i < get_irp_n_irgs(); i++)
734 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
736 return max_irg_visited;
739 void set_max_irg_visited(int val) {
740 max_irg_visited = val;
744 inc_max_irg_visited(void)
748 for(i = 0; i < get_irp_n_irgs(); i++)
749 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
752 return max_irg_visited;
756 (get_irg_block_visited)(const ir_graph *irg) {
757 return _get_irg_block_visited(irg);
761 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
762 _set_irg_block_visited(irg, visited);
766 (inc_irg_block_visited)(ir_graph *irg) {
767 _inc_irg_block_visited(irg);
772 * walker Start->End: places Proj nodes into the same block
773 * as it's predecessors
778 static void normalize_proj_walker(ir_node *n, void *env)
781 ir_node *pred = get_Proj_pred(n);
782 ir_node *block = get_nodes_block(pred);
784 set_nodes_block(n, block);
788 /* move Proj nodes into the same block as its predecessors */
789 void normalize_proj_nodes(ir_graph *irg)
791 irg_walk_graph(irg, NULL, normalize_proj_walker, NULL);
792 set_irg_outs_inconsistent(irg);
795 /* set a description for local value n */
796 void set_irg_loc_description(ir_graph *irg, int n, void *description)
798 assert(0 <= n && n < irg->n_loc);
800 if (! irg->loc_descriptions)
801 irg->loc_descriptions = xcalloc(sizeof(*irg->loc_descriptions), irg->n_loc);
803 irg->loc_descriptions[n] = description;
806 /* get the description for local value n */
807 void *get_irg_loc_description(ir_graph *irg, int n)
809 assert(0 <= n && n < irg->n_loc);
810 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
813 /* Returns a estimated node count of the irg. */
814 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg) {
815 return _get_irg_estimated_node_cnt(irg);
818 /* register additional space in an IR graph */
819 size_t register_additional_graph_data(size_t size)
821 assert(!forbid_new_data && "Too late to register additional node data");
826 return additional_graph_data_size += size;