2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Entry point to the representation of procedure code.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
32 #include "irgraph_t.h"
34 #include "irgraph_t.h"
45 #include "irbackedge_t.h"
46 #include "iredges_t.h"
49 #include "iroptimize.h"
52 #define INITIAL_IDX_IRN_MAP_SIZE 1024
53 /** Suffix that is added to every frame type. */
54 #define FRAME_TP_SUFFIX "frame_tp"
57 * Indicates, whether additional data can be registered to graphs.
58 * If set to 1, this is not possible anymore.
60 static int forbid_new_data = 0;
63 * The amount of additional space for custom data to be allocated upon
64 * creating a new graph.
66 static size_t additional_graph_data_size = 0;
68 ir_graph *current_ir_graph;
69 ir_graph *get_current_ir_graph(void)
71 return current_ir_graph;
74 void set_current_ir_graph(ir_graph *graph)
76 current_ir_graph = graph;
79 /** contains the suffix for frame type names */
80 static ident *frame_type_suffix = NULL;
82 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)
98 size_t size = sizeof(ir_graph) + additional_graph_data_size;
99 char *ptr = XMALLOCNZ(char, size);
101 res = (ir_graph *)(ptr + additional_graph_data_size);
102 res->kind = k_ir_graph;
104 /* initialize the idx->node map. */
105 res->idx_irn_map = NEW_ARR_F(ir_node *, INITIAL_IDX_IRN_MAP_SIZE);
106 memset(res->idx_irn_map, 0, INITIAL_IDX_IRN_MAP_SIZE * sizeof(res->idx_irn_map[0]));
112 * Frees an allocated IR graph
114 static void free_graph(ir_graph *irg)
116 char *ptr = (char *)irg;
119 for (i = EDGE_KIND_FIRST; i < EDGE_KIND_LAST; ++i)
120 edges_deactivate_kind(irg, i);
121 DEL_ARR_F(irg->idx_irn_map);
122 free(ptr - additional_graph_data_size);
125 void irg_set_nloc(ir_graph *res, int n_loc)
127 assert(irg_is_constrained(res, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
129 res->n_loc = n_loc + 1; /* number of local variables that are never
130 dereferenced in this graph plus one for
131 the store. This is not the number of
132 parameters to the procedure! */
134 if (res->loc_descriptions) {
135 xfree(res->loc_descriptions);
136 res->loc_descriptions = NULL;
140 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc)
143 ir_node *first_block;
144 ir_node *start, *start_block, *initial_mem, *projX;
148 /* inform statistics here, as blocks will be already build on this graph */
149 hook_new_graph(res, ent);
151 /*-- initialized for each graph. --*/
152 res->kind = k_ir_graph;
153 res->obst = XMALLOC(struct obstack);
154 obstack_init(res->obst);
156 /* graphs are in construction mode by default */
157 add_irg_constraints(res, IR_GRAPH_CONSTRAINT_CONSTRUCTION);
158 irg_set_nloc(res, n_loc);
160 /* descriptions will be allocated on demand */
161 res->loc_descriptions = NULL;
163 res->visited = 0; /* visited flag, for the ir walker */
164 res->block_visited = 0; /* visited flag, for the 'block'-walker */
166 res->last_node_idx = 0;
170 res->irg_pinned_state = op_pin_state_pinned;
171 res->typeinfo_state = ir_typeinfo_none;
172 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
173 res->callee_info_state = irg_callee_info_none;
174 res->class_cast_state = ir_class_casts_transitive;
175 res->fp_model = fp_model_precise;
176 res->mem_disambig_opt = aa_opt_inherited;
178 /*-- Type information for the procedure of the graph --*/
180 set_entity_irg(ent, res);
182 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
183 res->frame_type = new_type_frame();
185 /* the Anchor node must be created first */
186 res->anchor = new_r_Anchor(res);
188 /*-- Nodes needed in every graph --*/
189 set_irg_end_block(res, new_r_immBlock(res));
190 set_irg_end(res, new_r_End(res, 0, NULL));
192 start_block = new_r_Block_noopt(res, 0, NULL);
193 set_irg_start_block(res, start_block);
194 set_irg_no_mem (res, new_r_NoMem(res));
195 start = new_r_Start(res);
196 set_irg_start (res, start);
198 /* Proj results of start node */
199 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
200 set_irg_initial_exec (res, projX);
201 set_irg_frame (res, new_r_Proj(start, mode_P_data, pn_Start_P_frame_base));
202 set_irg_args (res, new_r_Proj(start, mode_T, pn_Start_T_args));
203 initial_mem = new_r_Proj(start, mode_M, pn_Start_M);
204 set_irg_initial_mem(res, initial_mem);
206 res->index = get_irp_new_irg_idx();
208 res->graph_nr = get_irp_new_node_nr();
211 set_r_cur_block(res, start_block);
212 set_r_store(res, initial_mem);
214 /*-- Make a block to start with --*/
215 first_block = new_r_Block(res, 1, &projX);
216 set_r_cur_block(res, first_block);
218 res->method_execution_frequency = -1.0;
219 res->estimated_node_count = 0;
224 ir_graph *new_ir_graph(ir_entity *ent, int n_loc)
226 ir_graph *res = new_r_ir_graph(ent, n_loc);
227 add_irp_irg(res); /* remember this graph global. */
231 ir_graph *new_const_code_irg(void)
233 ir_graph *res = alloc_graph();
239 ir_node *start_block;
242 /* inform statistics here, as blocks will be already build on this graph */
243 hook_new_graph(res, NULL);
245 res->n_loc = 1; /* Only the memory. */
246 res->visited = 0; /* visited flag, for the ir walker */
247 res->block_visited = 0; /* visited flag, for the 'block'-walker */
248 res->obst = XMALLOC(struct obstack);
249 obstack_init(res->obst);
251 res->last_node_idx = 0;
253 res->irg_pinned_state = op_pin_state_pinned;
254 res->fp_model = fp_model_precise;
256 /* value table for global value numbering for optimizing use in iropt.c */
259 res->frame_type = NULL;
261 add_irg_constraints(res, IR_GRAPH_CONSTRAINT_CONSTRUCTION);
263 /* the Anchor node must be created first */
264 res->anchor = new_r_Anchor(res);
266 /* -- The end block -- */
267 end_block = new_r_Block_noopt(res, 0, NULL);
268 set_irg_end_block(res, end_block);
269 end = new_r_End(res, 0, NULL);
270 set_irg_end(res, end);
272 /* -- The start block -- */
273 start_block = new_r_Block_noopt(res, 0, NULL);
274 set_irg_start_block(res, start_block);
275 no_mem = new_r_NoMem(res);
276 set_irg_no_mem(res, no_mem);
277 start = new_r_Start(res);
278 set_irg_start(res, start);
280 /* Proj results of start node */
281 set_irg_initial_mem(res, new_r_Proj(start, mode_M, pn_Start_M));
282 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
284 body_block = new_r_Block(res, 1, &projX);
286 set_r_cur_block(res, body_block);
288 /* Set the visited flag high enough that the blocks will never be visited. */
289 set_irn_visited(body_block, -1);
290 set_Block_block_visited(body_block, -1);
291 set_Block_block_visited(start_block, -1);
292 set_irn_visited(start_block, -1);
298 * Pre-Walker: Copies blocks and nodes from the original method graph
299 * to the copied graph.
301 * @param n A node from the original method graph.
302 * @param env The copied graph.
304 static void copy_all_nodes(ir_node *node, void *env)
306 ir_graph *irg = (ir_graph*)env;
307 ir_node *new_node = irn_copy_into_irg(node, irg);
309 set_irn_link(node, new_node);
311 /* fix access to entities on the stack frame */
312 if (is_Sel(new_node)) {
313 ir_entity *ent = get_Sel_entity(new_node);
314 ir_type *tp = get_entity_owner(ent);
316 if (is_frame_type(tp)) {
317 /* replace by the copied entity */
318 ent = (ir_entity*)get_entity_link(ent);
320 assert(is_entity(ent));
321 assert(get_entity_owner(ent) == get_irg_frame_type(irg));
322 set_Sel_entity(new_node, ent);
328 * Post-walker: Set the predecessors of the copied nodes.
329 * The copied nodes are set as link of their original nodes. The links of
330 * "irn" predecessors are the predecessors of copied node.
332 static void rewire(ir_node *irn, void *env)
335 irn_rewire_inputs(irn);
338 static ir_node *get_new_node(const ir_node *old_node)
340 return (ir_node*) get_irn_link(old_node);
343 ir_graph *create_irg_copy(ir_graph *irg)
350 res->visited = 0; /* visited flag, for the ir walker */
351 res->block_visited = 0; /* visited flag, for the 'block'-walker */
352 res->obst = XMALLOC(struct obstack);
353 obstack_init(res->obst);
355 res->last_node_idx = 0;
357 res->irg_pinned_state = irg->irg_pinned_state;
358 res->fp_model = irg->fp_model;
362 /* clone the frame type here for safety */
363 irp_reserve_resources(irp, IRP_RESOURCE_ENTITY_LINK);
364 res->frame_type = clone_frame_type(irg->frame_type);
366 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
368 /* copy all nodes from the graph irg to the new graph res */
369 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
371 /* copy the Anchor node */
372 res->anchor = get_new_node(irg->anchor);
374 /* -- The end block -- */
375 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
376 set_irg_end (res, get_new_node(get_irg_end(irg)));
378 /* -- The start block -- */
379 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
380 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
381 set_irg_start (res, get_new_node(get_irg_start(irg)));
383 /* Proj results of start node */
384 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
386 /* Copy the node count estimation. Would be strange if this
387 is different from the original one. */
388 res->estimated_node_count = irg->estimated_node_count;
390 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
391 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
396 void free_ir_graph(ir_graph *irg)
398 assert(is_ir_graph(irg));
401 confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_NONE);
403 hook_free_graph(irg);
407 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
410 free_End(get_irg_end(irg));
411 obstack_free(irg->obst, NULL);
413 if (irg->loc_descriptions)
414 free(irg->loc_descriptions);
419 int (is_ir_graph)(const void *thing)
421 return is_ir_graph_(thing);
425 long get_irg_graph_nr(const ir_graph *irg)
427 return irg->graph_nr;
430 long get_irg_graph_nr(const ir_graph *irg)
432 return PTR_TO_INT(irg);
436 size_t get_irg_idx(const ir_graph *irg)
441 ir_node *(get_idx_irn)(const ir_graph *irg, unsigned idx)
443 return get_idx_irn_(irg, idx);
446 ir_node *(get_irg_start_block)(const ir_graph *irg)
448 return get_irg_start_block_(irg);
451 void (set_irg_start_block)(ir_graph *irg, ir_node *node)
453 set_irg_start_block_(irg, node);
456 ir_node *(get_irg_start)(const ir_graph *irg)
458 return get_irg_start_(irg);
461 void (set_irg_start)(ir_graph *irg, ir_node *node)
463 set_irg_start_(irg, node);
466 ir_node *(get_irg_end_block)(const ir_graph *irg)
468 return get_irg_end_block_(irg);
471 void (set_irg_end_block)(ir_graph *irg, ir_node *node)
473 set_irg_end_block_(irg, node);
476 ir_node *(get_irg_end)(const ir_graph *irg)
478 return get_irg_end_(irg);
481 void (set_irg_end)(ir_graph *irg, ir_node *node)
483 set_irg_end_(irg, node);
486 ir_node *(get_irg_initial_exec)(const ir_graph *irg)
488 return get_irg_initial_exec_(irg);
491 void (set_irg_initial_exec)(ir_graph *irg, ir_node *node)
493 set_irg_initial_exec_(irg, node);
496 ir_node *(get_irg_frame)(const ir_graph *irg)
498 return get_irg_frame_(irg);
501 void (set_irg_frame)(ir_graph *irg, ir_node *node)
503 set_irg_frame_(irg, node);
506 ir_node *(get_irg_initial_mem)(const ir_graph *irg)
508 return get_irg_initial_mem_(irg);
511 void (set_irg_initial_mem)(ir_graph *irg, ir_node *node)
513 set_irg_initial_mem_(irg, node);
516 ir_node *(get_irg_args)(const ir_graph *irg)
518 return get_irg_args_(irg);
521 void (set_irg_args)(ir_graph *irg, ir_node *node)
523 set_irg_args_(irg, node);
526 ir_node *(get_irg_no_mem)(const ir_graph *irg)
528 return get_irg_no_mem_(irg);
531 void (set_irg_no_mem)(ir_graph *irg, ir_node *node)
533 set_irg_no_mem_(irg, node);
536 ir_entity *(get_irg_entity)(const ir_graph *irg)
538 return get_irg_entity_(irg);
541 void (set_irg_entity)(ir_graph *irg, ir_entity *ent)
543 set_irg_entity_(irg, ent);
546 ir_type *(get_irg_frame_type)(ir_graph *irg)
548 return get_irg_frame_type_(irg);
551 void (set_irg_frame_type)(ir_graph *irg, ir_type *ftp)
553 set_irg_frame_type_(irg, ftp);
556 int get_irg_n_locs(ir_graph *irg)
558 return irg->n_loc - 1;
561 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
563 struct _obstack_chunk *p;
566 * checks weather the ir_node pointer is on the obstack.
567 * A more sophisticated check would test the "whole" ir_node
569 for (p = irg->obst->chunk; p; p = p->prev) {
570 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
577 op_pin_state (get_irg_pinned)(const ir_graph *irg)
579 return get_irg_pinned_(irg);
582 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
584 return get_irg_callee_info_state_(irg);
587 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
589 set_irg_callee_info_state_(irg, s);
592 void (set_irg_link)(ir_graph *irg, void *thing)
594 set_irg_link_(irg, thing);
597 void *(get_irg_link)(const ir_graph *irg)
599 return get_irg_link_(irg);
602 ir_visited_t (get_irg_visited)(const ir_graph *irg)
604 return get_irg_visited_(irg);
607 /** maximum visited flag content of all ir_graph visited fields. */
608 static ir_visited_t max_irg_visited = 0;
610 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
612 irg->visited = visited;
613 if (irg->visited > max_irg_visited) {
614 max_irg_visited = irg->visited;
618 void inc_irg_visited(ir_graph *irg)
621 if (irg->visited > max_irg_visited) {
622 max_irg_visited = irg->visited;
626 ir_visited_t get_max_irg_visited(void)
628 return max_irg_visited;
631 void set_max_irg_visited(int val)
633 max_irg_visited = val;
636 ir_visited_t inc_max_irg_visited(void)
640 for (i = 0; i < get_irp_n_irgs(); i++)
641 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
643 return ++max_irg_visited;
646 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
648 return get_irg_block_visited_(irg);
651 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
653 set_irg_block_visited_(irg, visited);
656 void (inc_irg_block_visited)(ir_graph *irg)
658 inc_irg_block_visited_(irg);
661 unsigned (get_irg_fp_model)(const ir_graph *irg)
663 return get_irg_fp_model_(irg);
666 void set_irg_fp_model(ir_graph *irg, unsigned model)
668 irg->fp_model = model;
671 void set_irg_loc_description(ir_graph *irg, int n, void *description)
673 assert(0 <= n && n < irg->n_loc);
675 if (! irg->loc_descriptions)
676 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
678 irg->loc_descriptions[n] = description;
681 void *get_irg_loc_description(ir_graph *irg, int n)
683 assert(0 <= n && n < irg->n_loc);
684 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
688 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
690 assert((irg->reserved_resources & resources) == 0);
691 irg->reserved_resources |= resources;
694 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
696 assert((irg->reserved_resources & resources) == resources);
697 irg->reserved_resources &= ~resources;
700 ir_resources_t ir_resources_reserved(const ir_graph *irg)
702 return irg->reserved_resources;
706 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
708 return get_irg_estimated_node_cnt_(irg);
711 unsigned get_irg_last_idx(const ir_graph *irg)
713 return irg->last_node_idx;
716 size_t register_additional_graph_data(size_t size)
718 assert(!forbid_new_data && "Too late to register additional node data");
723 return additional_graph_data_size += size;
726 void add_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
728 irg->constraints |= constraints;
731 void clear_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
733 irg->constraints &= ~constraints;
736 int (irg_is_constrained)(const ir_graph *irg, ir_graph_constraints_t constraints)
738 return irg_is_constrained_(irg, constraints);
741 void (add_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
743 add_irg_properties_(irg, props);
746 void (clear_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
748 clear_irg_properties_(irg, props);
751 int (irg_has_properties)(const ir_graph *irg, ir_graph_properties_t props)
753 return irg_has_properties_(irg, props);
756 typedef void (*assure_property_func)(ir_graph *irg);
758 void assure_irg_properties(ir_graph *irg, ir_graph_properties_t props)
761 ir_graph_properties_t property;
762 assure_property_func func;
763 } property_functions[] = {
764 { IR_GRAPH_PROPERTY_ONE_RETURN, normalize_one_return },
765 { IR_GRAPH_PROPERTY_MANY_RETURNS, normalize_n_returns },
766 { IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES, remove_critical_cf_edges },
767 { IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE, remove_unreachable_code },
768 { IR_GRAPH_PROPERTY_NO_BADS, remove_bads },
769 { IR_GRAPH_PROPERTY_NO_TUPLES, remove_tuples },
770 { IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE, assure_doms },
771 { IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE, assure_postdoms },
772 { IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES, assure_edges },
773 { IR_GRAPH_PROPERTY_CONSISTENT_OUTS, assure_irg_outs },
774 { IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO, assure_loopinfo },
775 { IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE, assure_irg_entity_usage_computed },
776 { IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS, ir_compute_dominance_frontiers },
779 for (i = 0; i < ARRAY_SIZE(property_functions); ++i) {
780 ir_graph_properties_t missing = props & ~irg->properties;
781 if (missing & property_functions[i].property)
782 property_functions[i].func(irg);
784 assert((props & ~irg->properties) == IR_GRAPH_PROPERTIES_NONE);
787 void confirm_irg_properties(ir_graph *irg, ir_graph_properties_t props)
789 clear_irg_properties(irg, ~props);
790 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES))
791 edges_deactivate(irg);
792 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_OUTS)
793 && (irg->properties & IR_GRAPH_PROPERTY_CONSISTENT_OUTS))
795 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS))
796 ir_free_dominance_frontiers(irg);