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(res->phase_state == phase_building);
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 res->phase_state = phase_building;
155 irg_set_nloc(res, n_loc);
157 /* descriptions will be allocated on demand */
158 res->loc_descriptions = NULL;
160 res->visited = 0; /* visited flag, for the ir walker */
161 res->block_visited = 0; /* visited flag, for the 'block'-walker */
163 res->last_node_idx = 0;
167 res->inline_property = irg_inline_any;
168 res->additional_properties = mtp_property_inherited; /* inherited from type */
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->phase_state = phase_building;
254 res->irg_pinned_state = op_pin_state_pinned;
255 res->fp_model = fp_model_precise;
257 /* value table for global value numbering for optimizing use in iropt.c */
260 res->frame_type = NULL;
262 /* the Anchor node must be created first */
263 res->anchor = new_r_Anchor(res);
265 /* -- The end block -- */
266 end_block = new_r_Block_noopt(res, 0, NULL);
267 set_irg_end_block(res, end_block);
268 end = new_r_End(res, 0, NULL);
269 set_irg_end(res, end);
271 /* -- The start block -- */
272 start_block = new_r_Block_noopt(res, 0, NULL);
273 set_irg_start_block(res, start_block);
274 no_mem = new_r_NoMem(res);
275 set_irg_no_mem(res, no_mem);
276 start = new_r_Start(res);
277 set_irg_start(res, start);
279 /* Proj results of start node */
280 set_irg_initial_mem(res, new_r_Proj(start, mode_M, pn_Start_M));
281 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
283 body_block = new_r_Block(res, 1, &projX);
285 set_r_cur_block(res, body_block);
287 /* Set the visited flag high enough that the blocks will never be visited. */
288 set_irn_visited(body_block, -1);
289 set_Block_block_visited(body_block, -1);
290 set_Block_block_visited(start_block, -1);
291 set_irn_visited(start_block, -1);
297 * Pre-Walker: Copies blocks and nodes from the original method graph
298 * to the copied graph.
300 * @param n A node from the original method graph.
301 * @param env The copied graph.
303 static void copy_all_nodes(ir_node *node, void *env)
305 ir_graph *irg = (ir_graph*)env;
306 ir_node *new_node = irn_copy_into_irg(node, irg);
308 set_irn_link(node, new_node);
310 /* fix access to entities on the stack frame */
311 if (is_Sel(new_node)) {
312 ir_entity *ent = get_Sel_entity(new_node);
313 ir_type *tp = get_entity_owner(ent);
315 if (is_frame_type(tp)) {
316 /* replace by the copied entity */
317 ent = (ir_entity*)get_entity_link(ent);
319 assert(is_entity(ent));
320 assert(get_entity_owner(ent) == get_irg_frame_type(irg));
321 set_Sel_entity(new_node, ent);
327 * Post-walker: Set the predecessors of the copied nodes.
328 * The copied nodes are set as link of their original nodes. The links of
329 * "irn" predecessors are the predecessors of copied node.
331 static void rewire(ir_node *irn, void *env)
334 irn_rewire_inputs(irn);
337 static ir_node *get_new_node(const ir_node *old_node)
339 return (ir_node*) get_irn_link(old_node);
342 ir_graph *create_irg_copy(ir_graph *irg)
349 res->visited = 0; /* visited flag, for the ir walker */
350 res->block_visited = 0; /* visited flag, for the 'block'-walker */
351 res->obst = XMALLOC(struct obstack);
352 obstack_init(res->obst);
354 res->last_node_idx = 0;
356 res->phase_state = irg->phase_state;
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 res->phase_state = irg->phase_state;
368 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
370 /* copy all nodes from the graph irg to the new graph res */
371 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
373 /* copy the Anchor node */
374 res->anchor = get_new_node(irg->anchor);
376 /* -- The end block -- */
377 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
378 set_irg_end (res, get_new_node(get_irg_end(irg)));
380 /* -- The start block -- */
381 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
382 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
383 set_irg_start (res, get_new_node(get_irg_start(irg)));
385 /* Proj results of start node */
386 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
388 /* Copy the node count estimation. Would be strange if this
389 is different from the original one. */
390 res->estimated_node_count = irg->estimated_node_count;
392 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
393 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
398 void free_ir_graph(ir_graph *irg)
400 assert(is_ir_graph(irg));
402 edges_deactivate(irg);
404 hook_free_graph(irg);
408 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
411 free_End(get_irg_end(irg));
412 obstack_free(irg->obst, NULL);
414 if (irg->loc_descriptions)
415 free(irg->loc_descriptions);
420 int (is_ir_graph)(const void *thing)
422 return is_ir_graph_(thing);
426 long get_irg_graph_nr(const ir_graph *irg)
428 return irg->graph_nr;
431 long get_irg_graph_nr(const ir_graph *irg)
433 return PTR_TO_INT(irg);
437 size_t get_irg_idx(const ir_graph *irg)
442 ir_node *(get_idx_irn)(const ir_graph *irg, unsigned idx)
444 return get_idx_irn_(irg, idx);
447 ir_node *(get_irg_start_block)(const ir_graph *irg)
449 return get_irg_start_block_(irg);
452 void (set_irg_start_block)(ir_graph *irg, ir_node *node)
454 set_irg_start_block_(irg, node);
457 ir_node *(get_irg_start)(const ir_graph *irg)
459 return get_irg_start_(irg);
462 void (set_irg_start)(ir_graph *irg, ir_node *node)
464 set_irg_start_(irg, node);
467 ir_node *(get_irg_end_block)(const ir_graph *irg)
469 return get_irg_end_block_(irg);
472 void (set_irg_end_block)(ir_graph *irg, ir_node *node)
474 set_irg_end_block_(irg, node);
477 ir_node *(get_irg_end)(const ir_graph *irg)
479 return get_irg_end_(irg);
482 void (set_irg_end)(ir_graph *irg, ir_node *node)
484 set_irg_end_(irg, node);
487 ir_node *(get_irg_initial_exec)(const ir_graph *irg)
489 return get_irg_initial_exec_(irg);
492 void (set_irg_initial_exec)(ir_graph *irg, ir_node *node)
494 set_irg_initial_exec_(irg, node);
497 ir_node *(get_irg_frame)(const ir_graph *irg)
499 return get_irg_frame_(irg);
502 void (set_irg_frame)(ir_graph *irg, ir_node *node)
504 set_irg_frame_(irg, node);
507 ir_node *(get_irg_initial_mem)(const ir_graph *irg)
509 return get_irg_initial_mem_(irg);
512 void (set_irg_initial_mem)(ir_graph *irg, ir_node *node)
514 set_irg_initial_mem_(irg, node);
517 ir_node *(get_irg_args)(const ir_graph *irg)
519 return get_irg_args_(irg);
522 void (set_irg_args)(ir_graph *irg, ir_node *node)
524 set_irg_args_(irg, node);
527 ir_node *(get_irg_no_mem)(const ir_graph *irg)
529 return get_irg_no_mem_(irg);
532 void (set_irg_no_mem)(ir_graph *irg, ir_node *node)
534 set_irg_no_mem_(irg, node);
537 ir_entity *(get_irg_entity)(const ir_graph *irg)
539 return get_irg_entity_(irg);
542 void (set_irg_entity)(ir_graph *irg, ir_entity *ent)
544 set_irg_entity_(irg, ent);
547 ir_type *(get_irg_frame_type)(ir_graph *irg)
549 return get_irg_frame_type_(irg);
552 void (set_irg_frame_type)(ir_graph *irg, ir_type *ftp)
554 set_irg_frame_type_(irg, ftp);
557 int get_irg_n_locs(ir_graph *irg)
559 return irg->n_loc - 1;
562 struct obstack *(get_irg_obstack)(const ir_graph *irg)
564 return get_irg_obstack_(irg);
567 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
569 struct _obstack_chunk *p;
572 * checks weather the ir_node pointer is on the obstack.
573 * A more sophisticated check would test the "whole" ir_node
575 for (p = irg->obst->chunk; p; p = p->prev) {
576 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
583 irg_phase_state (get_irg_phase_state)(const ir_graph *irg)
585 return get_irg_phase_state_(irg);
588 void (set_irg_phase_state)(ir_graph *irg, irg_phase_state state)
590 set_irg_phase_state_(irg, state);
593 op_pin_state (get_irg_pinned)(const ir_graph *irg)
595 return get_irg_pinned_(irg);
598 void (set_irg_pinned)(ir_graph *irg, op_pin_state p)
600 set_irg_pinned_(irg, p);
603 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
605 return get_irg_callee_info_state_(irg);
608 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
610 set_irg_callee_info_state_(irg, s);
613 irg_inline_property (get_irg_inline_property)(const ir_graph *irg)
615 return get_irg_inline_property_(irg);
618 void (set_irg_inline_property)(ir_graph *irg, irg_inline_property s)
620 set_irg_inline_property_(irg, s);
623 mtp_additional_properties (get_irg_additional_properties)(const ir_graph *irg)
625 return get_irg_additional_properties_(irg);
628 void (set_irg_additional_properties)(ir_graph *irg, mtp_additional_properties property_mask)
630 set_irg_additional_properties_(irg, property_mask);
633 void (add_irg_additional_properties)(ir_graph *irg, mtp_additional_properties flag)
635 add_irg_additional_properties_(irg, flag);
638 void (set_irg_link)(ir_graph *irg, void *thing)
640 set_irg_link_(irg, thing);
643 void *(get_irg_link)(const ir_graph *irg)
645 return get_irg_link_(irg);
648 ir_visited_t (get_irg_visited)(const ir_graph *irg)
650 return get_irg_visited_(irg);
653 /** maximum visited flag content of all ir_graph visited fields. */
654 static ir_visited_t max_irg_visited = 0;
656 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
658 irg->visited = visited;
659 if (irg->visited > max_irg_visited) {
660 max_irg_visited = irg->visited;
664 void inc_irg_visited(ir_graph *irg)
667 if (irg->visited > max_irg_visited) {
668 max_irg_visited = irg->visited;
672 ir_visited_t get_max_irg_visited(void)
674 return max_irg_visited;
677 void set_max_irg_visited(int val)
679 max_irg_visited = val;
682 ir_visited_t inc_max_irg_visited(void)
686 for (i = 0; i < get_irp_n_irgs(); i++)
687 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
689 return ++max_irg_visited;
692 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
694 return get_irg_block_visited_(irg);
697 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
699 set_irg_block_visited_(irg, visited);
702 void (inc_irg_block_visited)(ir_graph *irg)
704 inc_irg_block_visited_(irg);
707 unsigned (get_irg_fp_model)(const ir_graph *irg)
709 return get_irg_fp_model_(irg);
712 void set_irg_fp_model(ir_graph *irg, unsigned model)
714 irg->fp_model = model;
717 void set_irg_loc_description(ir_graph *irg, int n, void *description)
719 assert(0 <= n && n < irg->n_loc);
721 if (! irg->loc_descriptions)
722 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
724 irg->loc_descriptions[n] = description;
727 void *get_irg_loc_description(ir_graph *irg, int n)
729 assert(0 <= n && n < irg->n_loc);
730 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
734 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
736 assert((irg->reserved_resources & resources) == 0);
737 irg->reserved_resources |= resources;
740 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
742 assert((irg->reserved_resources & resources) == resources);
743 irg->reserved_resources &= ~resources;
746 ir_resources_t ir_resources_reserved(const ir_graph *irg)
748 return irg->reserved_resources;
752 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
754 return get_irg_estimated_node_cnt_(irg);
757 unsigned get_irg_last_idx(const ir_graph *irg)
759 return irg->last_node_idx;
762 size_t register_additional_graph_data(size_t size)
764 assert(!forbid_new_data && "Too late to register additional node data");
769 return additional_graph_data_size += size;
772 void add_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
774 irg->constraints |= constraints;
777 void clear_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
779 irg->constraints &= ~constraints;
782 int (irg_is_constrained)(const ir_graph *irg, ir_graph_constraints_t constraints)
784 return irg_is_constrained_(irg, constraints);
787 void (add_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
789 add_irg_properties_(irg, props);
792 void (clear_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
794 clear_irg_properties_(irg, props);
797 int (irg_has_properties)(const ir_graph *irg, ir_graph_properties_t props)
799 return irg_has_properties_(irg, props);
802 typedef void (*assure_property_func)(ir_graph *irg);
804 void assure_irg_properties(ir_graph *irg, ir_graph_properties_t props)
807 ir_graph_properties_t property;
808 assure_property_func func;
809 } property_functions[] = {
810 { IR_GRAPH_PROPERTY_ONE_RETURN, normalize_one_return },
811 { IR_GRAPH_PROPERTY_MANY_RETURNS, normalize_n_returns },
812 { IR_GRAPH_PROPERTY_NO_CRITICAL_EDGES, remove_critical_cf_edges },
813 { IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE, remove_unreachable_code },
814 { IR_GRAPH_PROPERTY_NO_BADS, remove_bads },
815 { IR_GRAPH_PROPERTY_NO_TUPLES, remove_tuples },
816 { IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE, assure_doms },
817 { IR_GRAPH_PROPERTY_CONSISTENT_POSTDOMINANCE, assure_postdoms },
818 { IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES, assure_edges },
819 { IR_GRAPH_PROPERTY_CONSISTENT_OUTS, assure_irg_outs },
820 { IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO, assure_loopinfo },
821 { IR_GRAPH_PROPERTY_CONSISTENT_ENTITY_USAGE, assure_irg_entity_usage_computed },
822 { IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS, ir_compute_dominance_frontiers },
825 for (i = 0; i < ARRAY_SIZE(property_functions); ++i) {
826 ir_graph_properties_t missing = props & ~irg->properties;
827 if (missing & property_functions[i].property)
828 property_functions[i].func(irg);
830 assert((props & ~irg->properties) == IR_GRAPH_PROPERTIES_NONE);
833 void confirm_irg_properties(ir_graph *irg, ir_graph_properties_t props)
835 clear_irg_properties(irg, ~props);
836 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_OUT_EDGES))
837 edges_deactivate(irg);
838 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_OUTS)
839 && (irg->properties & IR_GRAPH_PROPERTY_CONSISTENT_OUTS))
841 if (! (props & IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE_FRONTIERS))
842 ir_free_dominance_frontiers(irg);