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"
50 #define INITIAL_IDX_IRN_MAP_SIZE 1024
53 * Indicates, whether additional data can be registered to graphs.
54 * If set to 1, this is not possible anymore.
56 static int forbid_new_data = 0;
59 * The amount of additional space for custom data to be allocated upon
60 * creating a new graph.
62 static size_t additional_graph_data_size = 0;
64 ir_graph *current_ir_graph;
65 ir_graph *get_current_ir_graph(void)
67 return current_ir_graph;
70 void set_current_ir_graph(ir_graph *graph)
72 current_ir_graph = graph;
75 /** contains the suffix for frame type names */
76 static ident *frame_type_suffix = NULL;
78 void firm_init_irgraph(void)
80 frame_type_suffix = new_id_from_str(FRAME_TP_SUFFIX);
85 * Allocate a new IR graph.
86 * This function respects the registered graph data. The only reason for
87 * this function is, that there are two locations, where graphs are
88 * allocated (new_r_ir_graph, new_const_code_irg).
89 * @return Memory for a new graph.
91 static ir_graph *alloc_graph(void)
94 size_t size = sizeof(ir_graph) + additional_graph_data_size;
95 char *ptr = XMALLOCNZ(char, size);
97 res = (ir_graph *)(ptr + additional_graph_data_size);
98 res->kind = k_ir_graph;
100 /* initialize the idx->node map. */
101 res->idx_irn_map = NEW_ARR_F(ir_node *, INITIAL_IDX_IRN_MAP_SIZE);
102 memset(res->idx_irn_map, 0, INITIAL_IDX_IRN_MAP_SIZE * sizeof(res->idx_irn_map[0]));
108 * Frees an allocated IR graph
110 static void free_graph(ir_graph *irg)
112 char *ptr = (char *)irg;
115 for (i = EDGE_KIND_FIRST; i < EDGE_KIND_LAST; ++i)
116 edges_deactivate_kind(irg, i);
117 DEL_ARR_F(irg->idx_irn_map);
118 free(ptr - additional_graph_data_size);
121 void irg_set_nloc(ir_graph *res, int n_loc)
123 assert(res->phase_state == phase_building);
125 res->n_loc = n_loc + 1; /* number of local variables that are never
126 dereferenced in this graph plus one for
127 the store. This is not the number of
128 parameters to the procedure! */
130 if (res->loc_descriptions) {
131 xfree(res->loc_descriptions);
132 res->loc_descriptions = NULL;
136 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc)
139 ir_node *first_block;
140 ir_node *start, *start_block, *initial_mem, *projX;
144 /* inform statistics here, as blocks will be already build on this graph */
145 hook_new_graph(res, ent);
147 /*-- initialized for each graph. --*/
148 res->kind = k_ir_graph;
149 res->obst = XMALLOC(struct obstack);
150 obstack_init(res->obst);
152 res->phase_state = phase_building;
153 irg_set_nloc(res, n_loc);
155 /* descriptions will be allocated on demand */
156 res->loc_descriptions = NULL;
158 res->visited = 0; /* visited flag, for the ir walker */
159 res->block_visited = 0; /* visited flag, for the 'block'-walker */
161 res->extbb_obst = NULL;
163 res->last_node_idx = 0;
168 res->inline_property = irg_inline_any;
169 res->additional_properties = mtp_property_inherited; /* inherited from type */
171 res->irg_pinned_state = op_pin_state_pinned;
172 res->typeinfo_state = ir_typeinfo_none;
173 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
174 res->callee_info_state = irg_callee_info_none;
175 res->class_cast_state = ir_class_casts_transitive;
176 res->fp_model = fp_model_precise;
177 res->mem_disambig_opt = aa_opt_inherited;
179 /*-- Type information for the procedure of the graph --*/
181 set_entity_irg(ent, res);
183 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
184 res->frame_type = new_type_frame();
186 /* the Anchor node must be created first */
187 res->anchor = new_r_Anchor(res);
189 /*-- Nodes needed in every graph --*/
190 set_irg_end_block(res, new_r_immBlock(res));
191 set_irg_end(res, new_r_End(res, 0, NULL));
193 start_block = new_r_Block_noopt(res, 0, NULL);
194 set_irg_start_block(res, start_block);
195 set_irg_no_mem (res, new_r_NoMem(res));
196 start = new_r_Start(res);
197 set_irg_start (res, start);
199 /* Proj results of start node */
200 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
201 set_irg_initial_exec (res, projX);
202 set_irg_frame (res, new_r_Proj(start, mode_P_data, pn_Start_P_frame_base));
203 set_irg_args (res, new_r_Proj(start, mode_T, pn_Start_T_args));
204 initial_mem = new_r_Proj(start, mode_M, pn_Start_M);
205 set_irg_initial_mem(res, initial_mem);
207 res->index = get_irp_new_irg_idx();
209 res->graph_nr = get_irp_new_node_nr();
212 set_r_cur_block(res, start_block);
213 set_r_store(res, initial_mem);
215 /*-- Make a block to start with --*/
216 first_block = new_r_Block(res, 1, &projX);
217 set_r_cur_block(res, first_block);
219 res->method_execution_frequency = -1.0;
220 res->estimated_node_count = 0;
225 ir_graph *new_ir_graph(ir_entity *ent, int n_loc)
227 ir_graph *res = new_r_ir_graph(ent, n_loc);
228 add_irp_irg(res); /* remember this graph global. */
232 ir_graph *new_const_code_irg(void)
234 ir_graph *res = alloc_graph();
240 ir_node *start_block;
243 /* inform statistics here, as blocks will be already build on this graph */
244 hook_new_graph(res, NULL);
246 res->n_loc = 1; /* Only the memory. */
247 res->visited = 0; /* visited flag, for the ir walker */
248 res->block_visited = 0; /* visited flag, for the 'block'-walker */
249 res->obst = XMALLOC(struct obstack);
250 obstack_init(res->obst);
251 res->extbb_obst = NULL;
253 res->last_node_idx = 0;
255 res->phase_state = phase_building;
256 res->irg_pinned_state = op_pin_state_pinned;
257 res->fp_model = fp_model_precise;
259 /* value table for global value numbering for optimizing use in iropt.c */
262 res->frame_type = NULL;
264 /* the Anchor node must be created first */
265 res->anchor = new_r_Anchor(res);
267 /* -- The end block -- */
268 end_block = new_r_Block_noopt(res, 0, NULL);
269 set_irg_end_block(res, end_block);
270 end = new_r_End(res, 0, NULL);
271 set_irg_end(res, end);
273 /* -- The start block -- */
274 start_block = new_r_Block_noopt(res, 0, NULL);
275 set_irg_start_block(res, start_block);
276 no_mem = new_r_NoMem(res);
277 set_irg_no_mem(res, no_mem);
278 start = new_r_Start(res);
279 set_irg_start(res, start);
281 /* Proj results of start node */
282 set_irg_initial_mem(res, new_r_Proj(start, mode_M, pn_Start_M));
283 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
285 body_block = new_r_Block(res, 1, &projX);
287 set_r_cur_block(res, body_block);
289 /* Set the visited flag high enough that the blocks will never be visited. */
290 set_irn_visited(body_block, -1);
291 set_Block_block_visited(body_block, -1);
292 set_Block_block_visited(start_block, -1);
293 set_irn_visited(start_block, -1);
299 * Pre-Walker: Copies blocks and nodes from the original method graph
300 * to the copied graph.
302 * @param n A node from the original method graph.
303 * @param env The copied graph.
305 static void copy_all_nodes(ir_node *node, void *env)
307 ir_graph *irg = (ir_graph*)env;
308 ir_node *new_node = irn_copy_into_irg(node, irg);
310 set_irn_link(node, new_node);
312 /* fix access to entities on the stack frame */
313 if (is_Sel(new_node)) {
314 ir_entity *ent = get_Sel_entity(new_node);
315 ir_type *tp = get_entity_owner(ent);
317 if (is_frame_type(tp)) {
318 /* replace by the copied entity */
319 ent = (ir_entity*)get_entity_link(ent);
321 assert(is_entity(ent));
322 assert(get_entity_owner(ent) == get_irg_frame_type(irg));
323 set_Sel_entity(new_node, ent);
329 * Post-walker: Set the predecessors of the copied nodes.
330 * The copied nodes are set as link of their original nodes. The links of
331 * "irn" predecessors are the predecessors of copied node.
333 static void rewire(ir_node *irn, void *env)
336 irn_rewire_inputs(irn);
339 static ir_node *get_new_node(const ir_node *old_node)
341 return (ir_node*) get_irn_link(old_node);
344 ir_graph *create_irg_copy(ir_graph *irg)
351 res->visited = 0; /* visited flag, for the ir walker */
352 res->block_visited = 0; /* visited flag, for the 'block'-walker */
353 res->obst = XMALLOC(struct obstack);
354 obstack_init(res->obst);
355 res->extbb_obst = NULL;
357 res->last_node_idx = 0;
359 res->phase_state = irg->phase_state;
360 res->irg_pinned_state = irg->irg_pinned_state;
361 res->fp_model = irg->fp_model;
365 /* clone the frame type here for safety */
366 irp_reserve_resources(irp, IRP_RESOURCE_ENTITY_LINK);
367 res->frame_type = clone_frame_type(irg->frame_type);
369 res->phase_state = irg->phase_state;
371 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
373 /* copy all nodes from the graph irg to the new graph res */
374 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
376 /* copy the Anchor node */
377 res->anchor = get_new_node(irg->anchor);
379 /* -- The end block -- */
380 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
381 set_irg_end (res, get_new_node(get_irg_end(irg)));
383 /* -- The start block -- */
384 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
385 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
386 set_irg_start (res, get_new_node(get_irg_start(irg)));
388 /* Proj results of start node */
389 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
391 /* Copy the node count estimation. Would be strange if this
392 is different from the original one. */
393 res->estimated_node_count = irg->estimated_node_count;
395 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
396 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
401 void free_ir_graph(ir_graph *irg)
403 assert(is_ir_graph(irg));
405 edges_deactivate(irg);
407 hook_free_graph(irg);
411 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
414 free_End(get_irg_end(irg));
415 obstack_free(irg->obst, NULL);
417 if (irg->loc_descriptions)
418 free(irg->loc_descriptions);
423 int (is_ir_graph)(const void *thing)
425 return is_ir_graph_(thing);
429 long get_irg_graph_nr(const ir_graph *irg)
431 return irg->graph_nr;
434 long get_irg_graph_nr(const ir_graph *irg)
436 return PTR_TO_INT(irg);
440 size_t get_irg_idx(const ir_graph *irg)
445 ir_node *(get_idx_irn)(const ir_graph *irg, unsigned idx)
447 return get_idx_irn_(irg, idx);
450 ir_node *(get_irg_start_block)(const ir_graph *irg)
452 return get_irg_start_block_(irg);
455 void (set_irg_start_block)(ir_graph *irg, ir_node *node)
457 set_irg_start_block_(irg, node);
460 ir_node *(get_irg_start)(const ir_graph *irg)
462 return get_irg_start_(irg);
465 void (set_irg_start)(ir_graph *irg, ir_node *node)
467 set_irg_start_(irg, node);
470 ir_node *(get_irg_end_block)(const ir_graph *irg)
472 return get_irg_end_block_(irg);
475 void (set_irg_end_block)(ir_graph *irg, ir_node *node)
477 set_irg_end_block_(irg, node);
480 ir_node *(get_irg_end)(const ir_graph *irg)
482 return get_irg_end_(irg);
485 void (set_irg_end)(ir_graph *irg, ir_node *node)
487 set_irg_end_(irg, node);
490 ir_node *(get_irg_initial_exec)(const ir_graph *irg)
492 return get_irg_initial_exec_(irg);
495 void (set_irg_initial_exec)(ir_graph *irg, ir_node *node)
497 set_irg_initial_exec_(irg, node);
500 ir_node *(get_irg_frame)(const ir_graph *irg)
502 return get_irg_frame_(irg);
505 void (set_irg_frame)(ir_graph *irg, ir_node *node)
507 set_irg_frame_(irg, node);
510 ir_node *(get_irg_initial_mem)(const ir_graph *irg)
512 return get_irg_initial_mem_(irg);
515 void (set_irg_initial_mem)(ir_graph *irg, ir_node *node)
517 set_irg_initial_mem_(irg, node);
520 ir_node *(get_irg_args)(const ir_graph *irg)
522 return get_irg_args_(irg);
525 void (set_irg_args)(ir_graph *irg, ir_node *node)
527 set_irg_args_(irg, node);
530 ir_node *(get_irg_no_mem)(const ir_graph *irg)
532 return get_irg_no_mem_(irg);
535 void (set_irg_no_mem)(ir_graph *irg, ir_node *node)
537 set_irg_no_mem_(irg, node);
540 ir_entity *(get_irg_entity)(const ir_graph *irg)
542 return get_irg_entity_(irg);
545 void (set_irg_entity)(ir_graph *irg, ir_entity *ent)
547 set_irg_entity_(irg, ent);
550 ir_type *(get_irg_frame_type)(ir_graph *irg)
552 return get_irg_frame_type_(irg);
555 void (set_irg_frame_type)(ir_graph *irg, ir_type *ftp)
557 set_irg_frame_type_(irg, ftp);
560 int get_irg_n_locs(ir_graph *irg)
562 return irg->n_loc - 1;
565 struct obstack *(get_irg_obstack)(const ir_graph *irg)
567 return get_irg_obstack_(irg);
570 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
572 struct _obstack_chunk *p;
575 * checks weather the ir_node pointer is on the obstack.
576 * A more sophisticated check would test the "whole" ir_node
578 for (p = irg->obst->chunk; p; p = p->prev) {
579 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
586 irg_phase_state (get_irg_phase_state)(const ir_graph *irg)
588 return get_irg_phase_state_(irg);
591 void (set_irg_phase_state)(ir_graph *irg, irg_phase_state state)
593 set_irg_phase_state_(irg, state);
596 op_pin_state (get_irg_pinned)(const ir_graph *irg)
598 return get_irg_pinned_(irg);
601 void (set_irg_pinned)(ir_graph *irg, op_pin_state p)
603 set_irg_pinned_(irg, p);
606 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
608 return get_irg_callee_info_state_(irg);
611 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
613 set_irg_callee_info_state_(irg, s);
616 irg_inline_property (get_irg_inline_property)(const ir_graph *irg)
618 return get_irg_inline_property_(irg);
621 void (set_irg_inline_property)(ir_graph *irg, irg_inline_property s)
623 set_irg_inline_property_(irg, s);
626 mtp_additional_properties (get_irg_additional_properties)(const ir_graph *irg)
628 return get_irg_additional_properties_(irg);
631 void (set_irg_additional_properties)(ir_graph *irg, mtp_additional_properties property_mask)
633 set_irg_additional_properties_(irg, property_mask);
636 void (add_irg_additional_properties)(ir_graph *irg, mtp_additional_properties flag)
638 add_irg_additional_properties_(irg, flag);
641 void (set_irg_link)(ir_graph *irg, void *thing)
643 set_irg_link_(irg, thing);
646 void *(get_irg_link)(const ir_graph *irg)
648 return get_irg_link_(irg);
651 ir_visited_t (get_irg_visited)(const ir_graph *irg)
653 return get_irg_visited_(irg);
656 /** maximum visited flag content of all ir_graph visited fields. */
657 static ir_visited_t max_irg_visited = 0;
659 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
661 irg->visited = visited;
662 if (irg->visited > max_irg_visited) {
663 max_irg_visited = irg->visited;
667 void inc_irg_visited(ir_graph *irg)
670 if (irg->visited > max_irg_visited) {
671 max_irg_visited = irg->visited;
675 ir_visited_t get_max_irg_visited(void)
677 return max_irg_visited;
680 void set_max_irg_visited(int val)
682 max_irg_visited = val;
685 ir_visited_t inc_max_irg_visited(void)
689 for (i = 0; i < get_irp_n_irgs(); i++)
690 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
692 return ++max_irg_visited;
695 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
697 return get_irg_block_visited_(irg);
700 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
702 set_irg_block_visited_(irg, visited);
705 void (inc_irg_block_visited)(ir_graph *irg)
707 inc_irg_block_visited_(irg);
710 unsigned (get_irg_fp_model)(const ir_graph *irg)
712 return get_irg_fp_model_(irg);
715 void set_irg_fp_model(ir_graph *irg, unsigned model)
717 irg->fp_model = model;
720 void set_irg_loc_description(ir_graph *irg, int n, void *description)
722 assert(0 <= n && n < irg->n_loc);
724 if (! irg->loc_descriptions)
725 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
727 irg->loc_descriptions[n] = description;
730 void *get_irg_loc_description(ir_graph *irg, int n)
732 assert(0 <= n && n < irg->n_loc);
733 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
737 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
739 assert((irg->reserved_resources & resources) == 0);
740 irg->reserved_resources |= resources;
743 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
745 assert((irg->reserved_resources & resources) == resources);
746 irg->reserved_resources &= ~resources;
749 ir_resources_t ir_resources_reserved(const ir_graph *irg)
751 return irg->reserved_resources;
755 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
757 return get_irg_estimated_node_cnt_(irg);
760 unsigned get_irg_last_idx(const ir_graph *irg)
762 return irg->last_node_idx;
765 size_t register_additional_graph_data(size_t size)
767 assert(!forbid_new_data && "Too late to register additional node data");
772 return additional_graph_data_size += size;
775 void (set_irg_state)(ir_graph *irg, ir_graph_state_t state)
777 set_irg_state_(irg, state);
780 void (clear_irg_state)(ir_graph *irg, ir_graph_state_t state)
782 clear_irg_state_(irg, state);
785 int (is_irg_state)(const ir_graph *irg, ir_graph_state_t state)
787 return is_irg_state_(irg, state);