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->last_node_idx = 0;
166 res->inline_property = irg_inline_any;
167 res->additional_properties = mtp_property_inherited; /* inherited from type */
169 res->irg_pinned_state = op_pin_state_pinned;
170 res->typeinfo_state = ir_typeinfo_none;
171 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
172 res->callee_info_state = irg_callee_info_none;
173 res->class_cast_state = ir_class_casts_transitive;
174 res->fp_model = fp_model_precise;
175 res->mem_disambig_opt = aa_opt_inherited;
177 /*-- Type information for the procedure of the graph --*/
179 set_entity_irg(ent, res);
181 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
182 res->frame_type = new_type_frame();
184 /* the Anchor node must be created first */
185 res->anchor = new_r_Anchor(res);
187 /*-- Nodes needed in every graph --*/
188 set_irg_end_block(res, new_r_immBlock(res));
189 set_irg_end(res, new_r_End(res, 0, NULL));
191 start_block = new_r_Block_noopt(res, 0, NULL);
192 set_irg_start_block(res, start_block);
193 set_irg_no_mem (res, new_r_NoMem(res));
194 start = new_r_Start(res);
195 set_irg_start (res, start);
197 /* Proj results of start node */
198 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
199 set_irg_initial_exec (res, projX);
200 set_irg_frame (res, new_r_Proj(start, mode_P_data, pn_Start_P_frame_base));
201 set_irg_args (res, new_r_Proj(start, mode_T, pn_Start_T_args));
202 initial_mem = new_r_Proj(start, mode_M, pn_Start_M);
203 set_irg_initial_mem(res, initial_mem);
205 res->index = get_irp_new_irg_idx();
207 res->graph_nr = get_irp_new_node_nr();
210 set_r_cur_block(res, start_block);
211 set_r_store(res, initial_mem);
213 /*-- Make a block to start with --*/
214 first_block = new_r_Block(res, 1, &projX);
215 set_r_cur_block(res, first_block);
217 res->method_execution_frequency = -1.0;
218 res->estimated_node_count = 0;
223 ir_graph *new_ir_graph(ir_entity *ent, int n_loc)
225 ir_graph *res = new_r_ir_graph(ent, n_loc);
226 add_irp_irg(res); /* remember this graph global. */
230 ir_graph *new_const_code_irg(void)
232 ir_graph *res = alloc_graph();
238 ir_node *start_block;
241 /* inform statistics here, as blocks will be already build on this graph */
242 hook_new_graph(res, NULL);
244 res->n_loc = 1; /* Only the memory. */
245 res->visited = 0; /* visited flag, for the ir walker */
246 res->block_visited = 0; /* visited flag, for the 'block'-walker */
247 res->obst = XMALLOC(struct obstack);
248 obstack_init(res->obst);
250 res->last_node_idx = 0;
252 res->phase_state = phase_building;
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 /* 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->phase_state = irg->phase_state;
356 res->irg_pinned_state = irg->irg_pinned_state;
357 res->fp_model = irg->fp_model;
361 /* clone the frame type here for safety */
362 irp_reserve_resources(irp, IRP_RESOURCE_ENTITY_LINK);
363 res->frame_type = clone_frame_type(irg->frame_type);
365 res->phase_state = irg->phase_state;
367 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
369 /* copy all nodes from the graph irg to the new graph res */
370 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
372 /* copy the Anchor node */
373 res->anchor = get_new_node(irg->anchor);
375 /* -- The end block -- */
376 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
377 set_irg_end (res, get_new_node(get_irg_end(irg)));
379 /* -- The start block -- */
380 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
381 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
382 set_irg_start (res, get_new_node(get_irg_start(irg)));
384 /* Proj results of start node */
385 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
387 /* Copy the node count estimation. Would be strange if this
388 is different from the original one. */
389 res->estimated_node_count = irg->estimated_node_count;
391 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
392 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
397 void free_ir_graph(ir_graph *irg)
399 assert(is_ir_graph(irg));
401 edges_deactivate(irg);
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 struct obstack *(get_irg_obstack)(const ir_graph *irg)
563 return get_irg_obstack_(irg);
566 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
568 struct _obstack_chunk *p;
571 * checks weather the ir_node pointer is on the obstack.
572 * A more sophisticated check would test the "whole" ir_node
574 for (p = irg->obst->chunk; p; p = p->prev) {
575 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
582 irg_phase_state (get_irg_phase_state)(const ir_graph *irg)
584 return get_irg_phase_state_(irg);
587 void (set_irg_phase_state)(ir_graph *irg, irg_phase_state state)
589 set_irg_phase_state_(irg, state);
592 op_pin_state (get_irg_pinned)(const ir_graph *irg)
594 return get_irg_pinned_(irg);
597 void (set_irg_pinned)(ir_graph *irg, op_pin_state p)
599 set_irg_pinned_(irg, p);
602 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
604 return get_irg_callee_info_state_(irg);
607 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
609 set_irg_callee_info_state_(irg, s);
612 irg_inline_property (get_irg_inline_property)(const ir_graph *irg)
614 return get_irg_inline_property_(irg);
617 void (set_irg_inline_property)(ir_graph *irg, irg_inline_property s)
619 set_irg_inline_property_(irg, s);
622 mtp_additional_properties (get_irg_additional_properties)(const ir_graph *irg)
624 return get_irg_additional_properties_(irg);
627 void (set_irg_additional_properties)(ir_graph *irg, mtp_additional_properties property_mask)
629 set_irg_additional_properties_(irg, property_mask);
632 void (add_irg_additional_properties)(ir_graph *irg, mtp_additional_properties flag)
634 add_irg_additional_properties_(irg, flag);
637 void (set_irg_link)(ir_graph *irg, void *thing)
639 set_irg_link_(irg, thing);
642 void *(get_irg_link)(const ir_graph *irg)
644 return get_irg_link_(irg);
647 ir_visited_t (get_irg_visited)(const ir_graph *irg)
649 return get_irg_visited_(irg);
652 /** maximum visited flag content of all ir_graph visited fields. */
653 static ir_visited_t max_irg_visited = 0;
655 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
657 irg->visited = visited;
658 if (irg->visited > max_irg_visited) {
659 max_irg_visited = irg->visited;
663 void inc_irg_visited(ir_graph *irg)
666 if (irg->visited > max_irg_visited) {
667 max_irg_visited = irg->visited;
671 ir_visited_t get_max_irg_visited(void)
673 return max_irg_visited;
676 void set_max_irg_visited(int val)
678 max_irg_visited = val;
681 ir_visited_t inc_max_irg_visited(void)
685 for (i = 0; i < get_irp_n_irgs(); i++)
686 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
688 return ++max_irg_visited;
691 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
693 return get_irg_block_visited_(irg);
696 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
698 set_irg_block_visited_(irg, visited);
701 void (inc_irg_block_visited)(ir_graph *irg)
703 inc_irg_block_visited_(irg);
706 unsigned (get_irg_fp_model)(const ir_graph *irg)
708 return get_irg_fp_model_(irg);
711 void set_irg_fp_model(ir_graph *irg, unsigned model)
713 irg->fp_model = model;
716 void set_irg_loc_description(ir_graph *irg, int n, void *description)
718 assert(0 <= n && n < irg->n_loc);
720 if (! irg->loc_descriptions)
721 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
723 irg->loc_descriptions[n] = description;
726 void *get_irg_loc_description(ir_graph *irg, int n)
728 assert(0 <= n && n < irg->n_loc);
729 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
733 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
735 assert((irg->reserved_resources & resources) == 0);
736 irg->reserved_resources |= resources;
739 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
741 assert((irg->reserved_resources & resources) == resources);
742 irg->reserved_resources &= ~resources;
745 ir_resources_t ir_resources_reserved(const ir_graph *irg)
747 return irg->reserved_resources;
751 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
753 return get_irg_estimated_node_cnt_(irg);
756 unsigned get_irg_last_idx(const ir_graph *irg)
758 return irg->last_node_idx;
761 size_t register_additional_graph_data(size_t size)
763 assert(!forbid_new_data && "Too late to register additional node data");
768 return additional_graph_data_size += size;
771 void add_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
773 irg->constraints |= constraints;
776 void clear_irg_constraints(ir_graph *irg, ir_graph_constraints_t constraints)
778 irg->constraints &= ~constraints;
781 int (irg_is_constrained)(const ir_graph *irg, ir_graph_constraints_t constraints)
783 return irg_is_constrained_(irg, constraints);
786 void (add_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
788 add_irg_properties_(irg, props);
791 void (clear_irg_properties)(ir_graph *irg, ir_graph_properties_t props)
793 clear_irg_properties_(irg, props);
796 int (irg_has_properties)(const ir_graph *irg, ir_graph_properties_t props)
798 return irg_has_properties_(irg, props);