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
55 * Indicates, whether additional data can be registered to graphs.
56 * If set to 1, this is not possible anymore.
58 static int forbid_new_data = 0;
61 * The amount of additional space for custom data to be allocated upon
62 * creating a new graph.
64 static size_t additional_graph_data_size = 0;
66 ir_graph *current_ir_graph;
67 ir_graph *get_current_ir_graph(void)
69 return current_ir_graph;
72 void set_current_ir_graph(ir_graph *graph)
74 current_ir_graph = graph;
77 /** contains the suffix for frame type names */
78 static ident *frame_type_suffix = NULL;
80 void firm_init_irgraph(void)
82 frame_type_suffix = new_id_from_str(FRAME_TP_SUFFIX);
87 * Allocate a new IR graph.
88 * This function respects the registered graph data. The only reason for
89 * this function is, that there are two locations, where graphs are
90 * allocated (new_r_ir_graph, new_const_code_irg).
91 * @return Memory for a new graph.
93 static ir_graph *alloc_graph(void)
96 size_t size = sizeof(ir_graph) + additional_graph_data_size;
97 char *ptr = XMALLOCNZ(char, size);
99 res = (ir_graph *)(ptr + additional_graph_data_size);
100 res->kind = k_ir_graph;
102 /* initialize the idx->node map. */
103 res->idx_irn_map = NEW_ARR_F(ir_node *, INITIAL_IDX_IRN_MAP_SIZE);
104 memset(res->idx_irn_map, 0, INITIAL_IDX_IRN_MAP_SIZE * sizeof(res->idx_irn_map[0]));
110 * Frees an allocated IR graph
112 static void free_graph(ir_graph *irg)
114 char *ptr = (char *)irg;
117 for (i = EDGE_KIND_FIRST; i < EDGE_KIND_LAST; ++i)
118 edges_deactivate_kind(irg, i);
119 DEL_ARR_F(irg->idx_irn_map);
120 free(ptr - additional_graph_data_size);
123 void irg_set_nloc(ir_graph *res, int n_loc)
125 assert(irg_is_constrained(res, IR_GRAPH_CONSTRAINT_CONSTRUCTION));
127 res->n_loc = n_loc + 1; /* number of local variables that are never
128 dereferenced in this graph plus one for
129 the store. This is not the number of
130 parameters to the procedure! */
132 if (res->loc_descriptions) {
133 xfree(res->loc_descriptions);
134 res->loc_descriptions = NULL;
138 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc)
141 ir_node *first_block;
142 ir_node *start, *start_block, *initial_mem, *projX;
146 /* inform statistics here, as blocks will be already build on this graph */
147 hook_new_graph(res, ent);
149 /*-- initialized for each graph. --*/
150 res->kind = k_ir_graph;
151 res->obst = XMALLOC(struct obstack);
152 obstack_init(res->obst);
154 /* graphs are in construction mode by default */
155 add_irg_constraints(res, IR_GRAPH_CONSTRAINT_CONSTRUCTION);
156 irg_set_nloc(res, n_loc);
158 /* descriptions will be allocated on demand */
159 res->loc_descriptions = NULL;
161 res->visited = 0; /* visited flag, for the ir walker */
162 res->block_visited = 0; /* visited flag, for the 'block'-walker */
164 res->last_node_idx = 0;
168 res->irg_pinned_state = op_pin_state_pinned;
169 res->typeinfo_state = ir_typeinfo_none;
170 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
171 res->callee_info_state = irg_callee_info_none;
172 res->class_cast_state = ir_class_casts_transitive;
173 res->fp_model = fp_model_precise;
174 res->mem_disambig_opt = aa_opt_inherited;
176 /*-- Type information for the procedure of the graph --*/
178 set_entity_irg(ent, res);
180 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
181 res->frame_type = new_type_frame();
183 /* the Anchor node must be created first */
184 res->anchor = new_r_Anchor(res);
186 /*-- Nodes needed in every graph --*/
187 set_irg_end_block(res, new_r_immBlock(res));
188 set_irg_end(res, new_r_End(res, 0, NULL));
190 start_block = new_r_Block_noopt(res, 0, NULL);
191 set_irg_start_block(res, start_block);
192 set_irg_no_mem (res, new_r_NoMem(res));
193 start = new_r_Start(res);
194 set_irg_start (res, start);
196 /* Proj results of start node */
197 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
198 set_irg_initial_exec (res, projX);
199 set_irg_frame (res, new_r_Proj(start, mode_P_data, pn_Start_P_frame_base));
200 set_irg_args (res, new_r_Proj(start, mode_T, pn_Start_T_args));
201 initial_mem = new_r_Proj(start, mode_M, pn_Start_M);
202 set_irg_initial_mem(res, initial_mem);
204 res->index = get_irp_new_irg_idx();
206 res->graph_nr = get_irp_new_node_nr();
209 set_r_cur_block(res, start_block);
210 set_r_store(res, initial_mem);
212 /*-- Make a block to start with --*/
213 first_block = new_r_Block(res, 1, &projX);
214 set_r_cur_block(res, first_block);
216 res->method_execution_frequency = -1.0;
217 res->estimated_node_count = 0;
222 ir_graph *new_ir_graph(ir_entity *ent, int n_loc)
224 ir_graph *res = new_r_ir_graph(ent, n_loc);
225 add_irp_irg(res); /* remember this graph global. */
229 ir_graph *new_const_code_irg(void)
231 ir_graph *res = alloc_graph();
237 ir_node *start_block;
240 /* inform statistics here, as blocks will be already build on this graph */
241 hook_new_graph(res, NULL);
243 res->n_loc = 1; /* Only the memory. */
244 res->visited = 0; /* visited flag, for the ir walker */
245 res->block_visited = 0; /* visited flag, for the 'block'-walker */
246 res->obst = XMALLOC(struct obstack);
247 obstack_init(res->obst);
249 res->last_node_idx = 0;
251 res->irg_pinned_state = op_pin_state_pinned;
252 res->fp_model = fp_model_precise;
254 /* value table for global value numbering for optimizing use in iropt.c */
257 res->frame_type = NULL;
259 add_irg_constraints(res, IR_GRAPH_CONSTRAINT_CONSTRUCTION);
261 /* the Anchor node must be created first */
262 res->anchor = new_r_Anchor(res);
264 /* -- The end block -- */
265 end_block = new_r_Block_noopt(res, 0, NULL);
266 set_irg_end_block(res, end_block);
267 end = new_r_End(res, 0, NULL);
268 set_irg_end(res, end);
270 /* -- The start block -- */
271 start_block = new_r_Block_noopt(res, 0, NULL);
272 set_irg_start_block(res, start_block);
273 no_mem = new_r_NoMem(res);
274 set_irg_no_mem(res, no_mem);
275 start = new_r_Start(res);
276 set_irg_start(res, start);
278 /* Proj results of start node */
279 set_irg_initial_mem(res, new_r_Proj(start, mode_M, pn_Start_M));
280 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
282 body_block = new_r_Block(res, 1, &projX);
284 set_r_cur_block(res, body_block);
286 /* Set the visited flag high enough that the blocks will never be visited. */
287 set_irn_visited(body_block, -1);
288 set_Block_block_visited(body_block, -1);
289 set_Block_block_visited(start_block, -1);
290 set_irn_visited(start_block, -1);
296 * Pre-Walker: Copies blocks and nodes from the original method graph
297 * to the copied graph.
299 * @param n A node from the original method graph.
300 * @param env The copied graph.
302 static void copy_all_nodes(ir_node *node, void *env)
304 ir_graph *irg = (ir_graph*)env;
305 ir_node *new_node = irn_copy_into_irg(node, irg);
307 set_irn_link(node, new_node);
309 /* fix access to entities on the stack frame */
310 if (is_Sel(new_node)) {
311 ir_entity *ent = get_Sel_entity(new_node);
312 ir_type *tp = get_entity_owner(ent);
314 if (is_frame_type(tp)) {
315 /* replace by the copied entity */
316 ent = (ir_entity*)get_entity_link(ent);
318 assert(is_entity(ent));
319 assert(get_entity_owner(ent) == get_irg_frame_type(irg));
320 set_Sel_entity(new_node, ent);
326 * Post-walker: Set the predecessors of the copied nodes.
327 * The copied nodes are set as link of their original nodes. The links of
328 * "irn" predecessors are the predecessors of copied node.
330 static void rewire(ir_node *irn, void *env)
333 irn_rewire_inputs(irn);
336 static ir_node *get_new_node(const ir_node *old_node)
338 return (ir_node*) get_irn_link(old_node);
341 ir_graph *create_irg_copy(ir_graph *irg)
348 res->visited = 0; /* visited flag, for the ir walker */
349 res->block_visited = 0; /* visited flag, for the 'block'-walker */
350 res->obst = XMALLOC(struct obstack);
351 obstack_init(res->obst);
353 res->last_node_idx = 0;
355 res->irg_pinned_state = irg->irg_pinned_state;
356 res->fp_model = irg->fp_model;
360 /* clone the frame type here for safety */
361 irp_reserve_resources(irp, IRP_RESOURCE_ENTITY_LINK);
362 res->frame_type = clone_frame_type(irg->frame_type);
364 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
366 /* copy all nodes from the graph irg to the new graph res */
367 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
369 /* copy the Anchor node */
370 res->anchor = get_new_node(irg->anchor);
372 /* -- The end block -- */
373 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
374 set_irg_end (res, get_new_node(get_irg_end(irg)));
376 /* -- The start block -- */
377 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
378 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
379 set_irg_start (res, get_new_node(get_irg_start(irg)));
381 /* Proj results of start node */
382 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
384 /* Copy the node count estimation. Would be strange if this
385 is different from the original one. */
386 res->estimated_node_count = irg->estimated_node_count;
388 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
389 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
394 void free_ir_graph(ir_graph *irg)
396 assert(is_ir_graph(irg));
399 confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_NONE);
401 hook_free_graph(irg);
405 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
408 free_End(get_irg_end(irg));
409 obstack_free(irg->obst, NULL);
411 if (irg->loc_descriptions)
412 free(irg->loc_descriptions);
417 int (is_ir_graph)(const void *thing)
419 return is_ir_graph_(thing);
423 long get_irg_graph_nr(const ir_graph *irg)
425 return irg->graph_nr;
428 long get_irg_graph_nr(const ir_graph *irg)
430 return PTR_TO_INT(irg);
434 size_t get_irg_idx(const ir_graph *irg)
439 ir_node *(get_idx_irn)(const ir_graph *irg, unsigned idx)
441 return get_idx_irn_(irg, idx);
444 ir_node *(get_irg_start_block)(const ir_graph *irg)
446 return get_irg_start_block_(irg);
449 void (set_irg_start_block)(ir_graph *irg, ir_node *node)
451 set_irg_start_block_(irg, node);
454 ir_node *(get_irg_start)(const ir_graph *irg)
456 return get_irg_start_(irg);
459 void (set_irg_start)(ir_graph *irg, ir_node *node)
461 set_irg_start_(irg, node);
464 ir_node *(get_irg_end_block)(const ir_graph *irg)
466 return get_irg_end_block_(irg);
469 void (set_irg_end_block)(ir_graph *irg, ir_node *node)
471 set_irg_end_block_(irg, node);
474 ir_node *(get_irg_end)(const ir_graph *irg)
476 return get_irg_end_(irg);
479 void (set_irg_end)(ir_graph *irg, ir_node *node)
481 set_irg_end_(irg, node);
484 ir_node *(get_irg_initial_exec)(const ir_graph *irg)
486 return get_irg_initial_exec_(irg);
489 void (set_irg_initial_exec)(ir_graph *irg, ir_node *node)
491 set_irg_initial_exec_(irg, node);
494 ir_node *(get_irg_frame)(const ir_graph *irg)
496 return get_irg_frame_(irg);
499 void (set_irg_frame)(ir_graph *irg, ir_node *node)
501 set_irg_frame_(irg, node);
504 ir_node *(get_irg_initial_mem)(const ir_graph *irg)
506 return get_irg_initial_mem_(irg);
509 void (set_irg_initial_mem)(ir_graph *irg, ir_node *node)
511 set_irg_initial_mem_(irg, node);
514 ir_node *(get_irg_args)(const ir_graph *irg)
516 return get_irg_args_(irg);
519 void (set_irg_args)(ir_graph *irg, ir_node *node)
521 set_irg_args_(irg, node);
524 ir_node *(get_irg_no_mem)(const ir_graph *irg)
526 return get_irg_no_mem_(irg);
529 void (set_irg_no_mem)(ir_graph *irg, ir_node *node)
531 set_irg_no_mem_(irg, node);
534 ir_entity *(get_irg_entity)(const ir_graph *irg)
536 return get_irg_entity_(irg);
539 void (set_irg_entity)(ir_graph *irg, ir_entity *ent)
541 set_irg_entity_(irg, ent);
544 ir_type *(get_irg_frame_type)(ir_graph *irg)
546 return get_irg_frame_type_(irg);
549 void (set_irg_frame_type)(ir_graph *irg, ir_type *ftp)
551 set_irg_frame_type_(irg, ftp);
554 int get_irg_n_locs(ir_graph *irg)
556 return irg->n_loc - 1;
559 struct obstack *(get_irg_obstack)(const ir_graph *irg)
561 return get_irg_obstack_(irg);
564 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
566 struct _obstack_chunk *p;
569 * checks weather the ir_node pointer is on the obstack.
570 * A more sophisticated check would test the "whole" ir_node
572 for (p = irg->obst->chunk; p; p = p->prev) {
573 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
580 op_pin_state (get_irg_pinned)(const ir_graph *irg)
582 return get_irg_pinned_(irg);
585 void (set_irg_pinned)(ir_graph *irg, op_pin_state p)
587 set_irg_pinned_(irg, p);
590 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
592 return get_irg_callee_info_state_(irg);
595 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
597 set_irg_callee_info_state_(irg, s);
600 void (set_irg_link)(ir_graph *irg, void *thing)
602 set_irg_link_(irg, thing);
605 void *(get_irg_link)(const ir_graph *irg)
607 return get_irg_link_(irg);
610 ir_visited_t (get_irg_visited)(const ir_graph *irg)
612 return get_irg_visited_(irg);
615 /** maximum visited flag content of all ir_graph visited fields. */
616 static ir_visited_t max_irg_visited = 0;
618 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
620 irg->visited = visited;
621 if (irg->visited > max_irg_visited) {
622 max_irg_visited = irg->visited;
626 void inc_irg_visited(ir_graph *irg)
629 if (irg->visited > max_irg_visited) {
630 max_irg_visited = irg->visited;
634 ir_visited_t get_max_irg_visited(void)
636 return max_irg_visited;
639 void set_max_irg_visited(int val)
641 max_irg_visited = val;
644 ir_visited_t inc_max_irg_visited(void)
648 for (i = 0; i < get_irp_n_irgs(); i++)
649 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
651 return ++max_irg_visited;
654 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
656 return get_irg_block_visited_(irg);
659 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
661 set_irg_block_visited_(irg, visited);
664 void (inc_irg_block_visited)(ir_graph *irg)
666 inc_irg_block_visited_(irg);
669 unsigned (get_irg_fp_model)(const ir_graph *irg)
671 return get_irg_fp_model_(irg);
674 void set_irg_fp_model(ir_graph *irg, unsigned model)
676 irg->fp_model = model;
679 void set_irg_loc_description(ir_graph *irg, int n, void *description)
681 assert(0 <= n && n < irg->n_loc);
683 if (! irg->loc_descriptions)
684 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
686 irg->loc_descriptions[n] = description;
689 void *get_irg_loc_description(ir_graph *irg, int n)
691 assert(0 <= n && n < irg->n_loc);
692 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
696 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
698 assert((irg->reserved_resources & resources) == 0);
699 irg->reserved_resources |= resources;
702 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
704 assert((irg->reserved_resources & resources) == resources);
705 irg->reserved_resources &= ~resources;
708 ir_resources_t ir_resources_reserved(const ir_graph *irg)
710 return irg->reserved_resources;
714 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
716 return get_irg_estimated_node_cnt_(irg);
719 unsigned get_irg_last_idx(const ir_graph *irg)
721 return irg->last_node_idx;
724 size_t register_additional_graph_data(size_t size)
726 assert(!forbid_new_data && "Too late to register additional node data");
731 return additional_graph_data_size += size;
734 void add_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
736 irg->constraints |= constraints;
739 void clear_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
741 irg->constraints &= ~constraints;
744 int (irg_is_constrained)(const ir_graph *irg, ir_graph_constraints_t constraints)
746 return irg_is_constrained_(irg, constraints);
749 void (add_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
751 add_irg_properties_(irg, props);
754 void (clear_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
756 clear_irg_properties_(irg, props);
759 int (irg_has_properties)(const ir_graph *irg, ir_graph_properties_t props)
761 return irg_has_properties_(irg, props);
764 typedef void (*assure_property_func)(ir_graph *irg);
766 void assure_irg_properties(ir_graph *irg, ir_graph_properties_t props)
769 ir_graph_properties_t property;
770 assure_property_func func;
771 } property_functions[] = {
772 { IR_GRAPH_PROPERTY_ONE_RETURN, normalize_one_return },
773 { IR_GRAPH_PROPERTY_MANY_RETURNS, normalize_n_returns },
774 { IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES, remove_critical_cf_edges },
775 { IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE, remove_unreachable_code },
776 { IR_GRAPH_PROPERTY_NO_BADS, remove_bads },
777 { IR_GRAPH_PROPERTY_NO_TUPLES, remove_tuples },
778 { IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE, assure_doms },
779 { IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE, assure_postdoms },
780 { IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES, assure_edges },
781 { IR_GRAPH_PROPERTY_CONSISTENT_OUTS, assure_irg_outs },
782 { IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO, assure_loopinfo },
783 { IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE, assure_irg_entity_usage_computed },
784 { IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS, ir_compute_dominance_frontiers },
787 for (i = 0; i < ARRAY_SIZE(property_functions); ++i) {
788 ir_graph_properties_t missing = props & ~irg->properties;
789 if (missing & property_functions[i].property)
790 property_functions[i].func(irg);
792 assert((props & ~irg->properties) == IR_GRAPH_PROPERTIES_NONE);
795 void confirm_irg_properties(ir_graph *irg, ir_graph_properties_t props)
797 clear_irg_properties(irg, ~props);
798 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES))
799 edges_deactivate(irg);
800 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_OUTS)
801 && (irg->properties & IR_GRAPH_PROPERTY_CONSISTENT_OUTS))
803 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS))
804 ir_free_dominance_frontiers(irg);