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
33 #include "irgraph_t.h"
35 #include "irgraph_t.h"
45 #include "irbackedge_t.h"
46 #include "iredges_t.h"
51 #define INITIAL_IDX_IRN_MAP_SIZE 1024
54 * Indicates, whether additional data can be registered to graphs.
55 * If set to 1, this is not possible anymore.
57 static int forbid_new_data = 0;
60 * The amount of additional space for custom data to be allocated upon
61 * creating a new graph.
63 static size_t additional_graph_data_size = 0;
65 ir_graph *current_ir_graph;
66 ir_graph *get_current_ir_graph(void)
68 return current_ir_graph;
71 void set_current_ir_graph(ir_graph *graph)
73 current_ir_graph = graph;
76 /** contains the suffix for frame type names */
77 static ident *frame_type_suffix = NULL;
79 /* initialize the IR graph module */
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);
124 * Set the number of locals for a given graph.
126 * @param irg the graph
127 * @param n_loc number of locals
129 void irg_set_nloc(ir_graph *res, int n_loc)
131 assert(res->phase_state == phase_building);
133 res->n_loc = n_loc + 1; /* number of local variables that are never
134 dereferenced in this graph plus one for
135 the store. This is not the number of
136 parameters to the procedure! */
138 if (res->loc_descriptions) {
139 xfree(res->loc_descriptions);
140 res->loc_descriptions = NULL;
144 /* Allocates a list of nodes:
145 - The start block containing a start node and Proj nodes for its four
146 results (X, M, P, Tuple).
147 - The end block containing an end node. This block is not matured after
148 new_ir_graph as predecessors need to be added to it.
149 - The current block, which is empty and also not matured.
150 Further it allocates several datastructures needed for graph construction
153 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc)
156 ir_node *first_block;
157 ir_node *start, *start_block, *initial_mem, *projX;
161 /* inform statistics here, as blocks will be already build on this graph */
162 hook_new_graph(res, ent);
164 /*-- initialized for each graph. --*/
165 res->kind = k_ir_graph;
166 res->obst = XMALLOC(struct obstack);
167 obstack_init(res->obst);
169 res->phase_state = phase_building;
170 irg_set_nloc(res, n_loc);
172 /* descriptions will be allocated on demand */
173 res->loc_descriptions = NULL;
175 res->visited = 0; /* visited flag, for the ir walker */
176 res->block_visited = 0; /* visited flag, for the 'block'-walker */
178 res->extbb_obst = NULL;
180 res->last_node_idx = 0;
185 res->inline_property = irg_inline_any;
186 res->additional_properties = mtp_property_inherited; /* inherited from type */
188 res->irg_pinned_state = op_pin_state_pinned;
189 res->dom_state = dom_none;
190 res->pdom_state = dom_none;
191 res->typeinfo_state = ir_typeinfo_none;
192 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
193 res->callee_info_state = irg_callee_info_none;
194 res->loopinfo_state = loopinfo_none;
195 res->class_cast_state = ir_class_casts_transitive;
196 res->extblk_state = ir_extblk_info_none;
197 res->execfreq_state = exec_freq_none;
198 res->fp_model = fp_model_precise;
199 res->entity_usage_state = ir_entity_usage_not_computed;
200 res->mem_disambig_opt = aa_opt_inherited;
202 /*-- Type information for the procedure of the graph --*/
204 set_entity_irg(ent, res);
206 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
207 res->frame_type = new_type_frame();
209 /* the Anchor node must be created first */
210 res->anchor = new_r_Anchor(res);
212 /*-- Nodes needed in every graph --*/
213 set_irg_end_block (res, new_r_immBlock(res));
214 set_irg_end(res, new_r_End(res, 0, NULL));
216 start_block = new_r_Block_noopt(res, 0, NULL);
217 set_irg_start_block(res, start_block);
218 set_irg_no_mem (res, new_r_NoMem(res));
219 start = new_r_Start(res);
220 set_irg_start (res, start);
222 /* Proj results of start node */
223 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
224 set_irg_initial_exec (res, projX);
225 set_irg_frame (res, new_r_Proj(start, mode_P_data, pn_Start_P_frame_base));
226 set_irg_args (res, new_r_Proj(start, mode_T, pn_Start_T_args));
227 initial_mem = new_r_Proj(start, mode_M, pn_Start_M);
228 set_irg_initial_mem(res, initial_mem);
230 res->index = get_irp_new_irg_idx();
232 res->graph_nr = get_irp_new_node_nr();
235 set_r_cur_block(res, start_block);
236 set_r_store(res, initial_mem);
238 /*-- Make a block to start with --*/
239 first_block = new_r_immBlock(res);
240 set_r_cur_block(res, first_block);
241 add_immBlock_pred(first_block, projX);
243 res->method_execution_frequency = -1.0;
244 res->estimated_node_count = 0;
249 ir_graph *new_ir_graph(ir_entity *ent, int n_loc)
251 ir_graph *res = new_r_ir_graph(ent, n_loc);
252 add_irp_irg(res); /* remember this graph global. */
256 /* Make a rudimentary IR graph for the constant code.
257 Must look like a correct irg, spare everything else. */
258 ir_graph *new_const_code_irg(void)
260 ir_graph *res = alloc_graph();
266 ir_node *start_block;
269 /* inform statistics here, as blocks will be already build on this graph */
270 hook_new_graph(res, NULL);
272 res->n_loc = 1; /* Only the memory. */
273 res->visited = 0; /* visited flag, for the ir walker */
274 res->block_visited = 0; /* visited flag, for the 'block'-walker */
275 res->obst = XMALLOC(struct obstack);
276 obstack_init(res->obst);
277 res->extbb_obst = NULL;
279 res->last_node_idx = 0;
281 res->phase_state = phase_building;
282 res->irg_pinned_state = op_pin_state_pinned;
283 res->extblk_state = ir_extblk_info_none;
284 res->fp_model = fp_model_precise;
286 /* value table for global value numbering for optimizing use in iropt.c */
289 res->frame_type = NULL;
291 /* the Anchor node must be created first */
292 res->anchor = new_r_Anchor(res);
294 /* -- The end block -- */
295 end_block = new_r_Block_noopt(res, 0, NULL);
296 set_irg_end_block(res, end_block);
297 end = new_r_End(res, 0, NULL);
298 set_irg_end(res, end);
300 /* -- The start block -- */
301 start_block = new_r_Block_noopt(res, 0, NULL);
302 set_irg_start_block(res, start_block);
303 no_mem = new_r_NoMem(res);
304 set_irg_no_mem(res, no_mem);
305 start = new_r_Start(res);
306 set_irg_start(res, start);
308 /* Proj results of start node */
309 set_irg_initial_mem(res, new_r_Proj(start, mode_M, pn_Start_M));
310 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
312 body_block = new_r_Block(res, 1, &projX);
314 set_r_cur_block(res, body_block);
316 /* Set the visited flag high enough that the blocks will never be visited. */
317 set_irn_visited(body_block, -1);
318 set_Block_block_visited(body_block, -1);
319 set_Block_block_visited(start_block, -1);
320 set_irn_visited(start_block, -1);
321 set_irn_visited(no_mem, -1);
327 * Pre-Walker: Copies blocks and nodes from the original method graph
328 * to the copied graph.
330 * @param n A node from the original method graph.
331 * @param env The copied graph.
333 static void copy_all_nodes(ir_node *node, void *env)
335 ir_graph *irg = (ir_graph*)env;
336 ir_node *new_node = irn_copy_into_irg(node, irg);
338 set_irn_link(node, new_node);
340 /* fix access to entities on the stack frame */
341 if (is_Sel(new_node)) {
342 ir_entity *ent = get_Sel_entity(new_node);
343 ir_type *tp = get_entity_owner(ent);
345 if (is_frame_type(tp)) {
346 /* replace by the copied entity */
347 ent = (ir_entity*)get_entity_link(ent);
349 assert(is_entity(ent));
350 assert(get_entity_owner(ent) == get_irg_frame_type(irg));
351 set_Sel_entity(new_node, ent);
357 * Post-walker: Set the predecessors of the copied nodes.
358 * The copied nodes are set as link of their original nodes. The links of
359 * "irn" predecessors are the predecessors of copied node.
361 static void rewire(ir_node *irn, void *env)
364 irn_rewire_inputs(irn);
367 static ir_node *get_new_node(const ir_node *old_node)
369 return (ir_node*) get_irn_link(old_node);
373 * Create a new graph that is a copy of a given one.
375 ir_graph *create_irg_copy(ir_graph *irg)
382 res->visited = 0; /* visited flag, for the ir walker */
383 res->block_visited = 0; /* visited flag, for the 'block'-walker */
384 res->obst = XMALLOC(struct obstack);
385 obstack_init(res->obst);
386 res->extbb_obst = NULL;
388 res->last_node_idx = 0;
390 res->phase_state = irg->phase_state;
391 res->irg_pinned_state = irg->irg_pinned_state;
392 res->extblk_state = ir_extblk_info_none;
393 res->fp_model = irg->fp_model;
397 /* clone the frame type here for safety */
398 irp_reserve_resources(irp, IRP_RESOURCE_ENTITY_LINK);
399 res->frame_type = clone_frame_type(irg->frame_type);
401 res->phase_state = irg->phase_state;
403 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
405 /* copy all nodes from the graph irg to the new graph res */
406 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
408 /* copy the Anchor node */
409 res->anchor = get_new_node(irg->anchor);
411 /* -- The end block -- */
412 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
413 set_irg_end (res, get_new_node(get_irg_end(irg)));
415 /* -- The start block -- */
416 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
417 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
418 set_irg_start (res, get_new_node(get_irg_start(irg)));
420 /* Proj results of start node */
421 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
423 /* Copy the node count estimation. Would be strange if this
424 is different from the original one. */
425 res->estimated_node_count = irg->estimated_node_count;
427 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
428 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
433 /* Frees the passed irgraph.
434 Deallocates all nodes in this graph and the ir_graph structure.
435 Sets the field irgraph in the corresponding entity to NULL.
436 Does not remove the irgraph from the list in irprog (requires
437 inefficient search, call remove_irp_irg by hand).
438 Does not free types, entities or modes that are used only by this
439 graph, nor the entity standing for this graph. */
440 void free_ir_graph(ir_graph *irg)
442 assert(is_ir_graph(irg));
444 edges_deactivate(irg);
446 hook_free_graph(irg);
449 free_type(irg->frame_type);
452 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
455 free_End(get_irg_end(irg));
456 obstack_free(irg->obst,NULL);
458 if (irg->loc_descriptions)
459 free(irg->loc_descriptions);
464 /* access routines for all ir_graph attributes:
466 {attr type} get_irg_{attribute name} (ir_graph *irg);
467 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
469 int (is_ir_graph)(const void *thing)
471 return _is_ir_graph(thing);
475 /* Outputs a unique number for this node */
476 long get_irg_graph_nr(const ir_graph *irg)
478 return irg->graph_nr;
481 long get_irg_graph_nr(const ir_graph *irg)
483 return PTR_TO_INT(irg);
487 size_t get_irg_idx(const ir_graph *irg)
492 ir_node *(get_idx_irn)(const ir_graph *irg, unsigned idx)
494 return _get_idx_irn(irg, idx);
497 ir_node *(get_irg_start_block)(const ir_graph *irg)
499 return _get_irg_start_block(irg);
502 void (set_irg_start_block)(ir_graph *irg, ir_node *node)
504 _set_irg_start_block(irg, node);
507 ir_node *(get_irg_start)(const ir_graph *irg)
509 return _get_irg_start(irg);
512 void (set_irg_start)(ir_graph *irg, ir_node *node)
514 _set_irg_start(irg, node);
517 ir_node *(get_irg_end_block)(const ir_graph *irg)
519 return _get_irg_end_block(irg);
522 void (set_irg_end_block)(ir_graph *irg, ir_node *node)
524 _set_irg_end_block(irg, node);
527 ir_node *(get_irg_end)(const ir_graph *irg)
529 return _get_irg_end(irg);
532 void (set_irg_end)(ir_graph *irg, ir_node *node)
534 _set_irg_end(irg, node);
537 ir_node *(get_irg_initial_exec)(const ir_graph *irg)
539 return _get_irg_initial_exec(irg);
542 void (set_irg_initial_exec)(ir_graph *irg, ir_node *node)
544 _set_irg_initial_exec(irg, node);
547 ir_node *(get_irg_frame)(const ir_graph *irg)
549 return _get_irg_frame(irg);
552 void (set_irg_frame)(ir_graph *irg, ir_node *node)
554 _set_irg_frame(irg, node);
557 ir_node *(get_irg_initial_mem)(const ir_graph *irg)
559 return _get_irg_initial_mem(irg);
562 void (set_irg_initial_mem)(ir_graph *irg, ir_node *node)
564 _set_irg_initial_mem(irg, node);
567 ir_node *(get_irg_args)(const ir_graph *irg)
569 return _get_irg_args(irg);
572 void (set_irg_args)(ir_graph *irg, ir_node *node)
574 _set_irg_args(irg, node);
577 ir_node *(get_irg_no_mem)(const ir_graph *irg)
579 return _get_irg_no_mem(irg);
582 void (set_irg_no_mem)(ir_graph *irg, ir_node *node)
584 _set_irg_no_mem(irg, node);
587 ir_entity *(get_irg_entity)(const ir_graph *irg)
589 return _get_irg_entity(irg);
592 void (set_irg_entity)(ir_graph *irg, ir_entity *ent)
594 _set_irg_entity(irg, ent);
597 ir_type *(get_irg_frame_type)(ir_graph *irg)
599 return _get_irg_frame_type(irg);
602 void (set_irg_frame_type)(ir_graph *irg, ir_type *ftp)
604 _set_irg_frame_type(irg, ftp);
607 int get_irg_n_locs(ir_graph *irg)
609 return irg->n_loc - 1;
612 /* Returns the obstack associated with the graph. */
614 (get_irg_obstack)(const ir_graph *irg) {
615 return _get_irg_obstack(irg);
619 * Returns true if the node n is allocated on the storage of graph irg.
621 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
623 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
625 struct _obstack_chunk *p;
628 * checks weather the ir_node pointer is on the obstack.
629 * A more sophisticated check would test the "whole" ir_node
631 for (p = irg->obst->chunk; p; p = p->prev) {
632 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
639 irg_phase_state (get_irg_phase_state)(const ir_graph *irg)
641 return _get_irg_phase_state(irg);
644 void (set_irg_phase_state)(ir_graph *irg, irg_phase_state state)
646 _set_irg_phase_state(irg, state);
649 op_pin_state (get_irg_pinned)(const ir_graph *irg)
651 return _get_irg_pinned(irg);
654 irg_extblk_info_state (get_irg_extblk_state)(const ir_graph *irg)
656 return _get_irg_extblk_state(irg);
659 void (set_irg_extblk_inconsistent)(ir_graph *irg)
661 _set_irg_extblk_inconsistent(irg);
664 irg_dom_state (get_irg_dom_state)(const ir_graph *irg)
666 return _get_irg_dom_state(irg);
669 irg_dom_state (get_irg_postdom_state)(const ir_graph *irg)
671 return _get_irg_postdom_state(irg);
674 void (set_irg_doms_inconsistent)(ir_graph *irg)
676 _set_irg_doms_inconsistent(irg);
679 irg_loopinfo_state (get_irg_loopinfo_state)(const ir_graph *irg)
681 return _get_irg_loopinfo_state(irg);
684 void (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s)
686 _set_irg_loopinfo_state(irg, s);
689 void (set_irg_loopinfo_inconsistent)(ir_graph *irg)
691 _set_irg_loopinfo_inconsistent(irg);
694 void set_irp_loopinfo_inconsistent(void)
697 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
698 set_irg_loopinfo_inconsistent(get_irp_irg(i));
704 void (set_irg_pinned)(ir_graph *irg, op_pin_state p)
706 _set_irg_pinned(irg, p);
709 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
711 return _get_irg_callee_info_state(irg);
714 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
716 _set_irg_callee_info_state(irg, s);
719 irg_inline_property (get_irg_inline_property)(const ir_graph *irg)
721 return _get_irg_inline_property(irg);
724 void (set_irg_inline_property)(ir_graph *irg, irg_inline_property s)
726 _set_irg_inline_property(irg, s);
729 mtp_additional_properties (get_irg_additional_properties)(const ir_graph *irg)
731 return _get_irg_additional_properties(irg);
734 void (set_irg_additional_properties)(ir_graph *irg, mtp_additional_properties property_mask)
736 _set_irg_additional_properties(irg, property_mask);
739 void (add_irg_additional_properties)(ir_graph *irg, mtp_additional_properties flag)
741 _add_irg_additional_properties(irg, flag);
744 void (set_irg_link)(ir_graph *irg, void *thing)
746 _set_irg_link(irg, thing);
749 void *(get_irg_link)(const ir_graph *irg)
751 return _get_irg_link(irg);
754 ir_visited_t (get_irg_visited)(const ir_graph *irg)
756 return _get_irg_visited(irg);
759 /** maximum visited flag content of all ir_graph visited fields. */
760 static ir_visited_t max_irg_visited = 0;
762 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
764 irg->visited = visited;
765 if (irg->visited > max_irg_visited) {
766 max_irg_visited = irg->visited;
770 void inc_irg_visited(ir_graph *irg)
773 if (irg->visited > max_irg_visited) {
774 max_irg_visited = irg->visited;
778 ir_visited_t get_max_irg_visited(void)
780 return max_irg_visited;
783 void set_max_irg_visited(int val)
785 max_irg_visited = val;
788 ir_visited_t inc_max_irg_visited(void)
792 for (i = 0; i < get_irp_n_irgs(); i++)
793 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
795 return ++max_irg_visited;
798 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
800 return _get_irg_block_visited(irg);
803 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
805 _set_irg_block_visited(irg, visited);
808 void (inc_irg_block_visited)(ir_graph *irg)
810 _inc_irg_block_visited(irg);
813 /* Return the floating point model of this graph. */
814 unsigned (get_irg_fp_model)(const ir_graph *irg)
816 return _get_irg_fp_model(irg);
819 /* Sets the floating point model for this graph. */
820 void set_irg_fp_model(ir_graph *irg, unsigned model)
822 irg->fp_model = model;
825 /* set a description for local value n */
826 void set_irg_loc_description(ir_graph *irg, int n, void *description)
828 assert(0 <= n && n < irg->n_loc);
830 if (! irg->loc_descriptions)
831 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
833 irg->loc_descriptions[n] = description;
836 /* get the description for local value n */
837 void *get_irg_loc_description(ir_graph *irg, int n)
839 assert(0 <= n && n < irg->n_loc);
840 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
843 void irg_register_phase(ir_graph *irg, ir_phase_id id, ir_phase *phase)
845 assert(id <= PHASE_LAST);
846 assert(irg->phases[id] == NULL);
847 irg->phases[id] = phase;
850 void irg_invalidate_phases(ir_graph *irg)
853 for (p = 0; p <= PHASE_LAST; ++p) {
854 ir_phase *phase = irg->phases[p];
859 irg->phases[p] = NULL;
864 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
866 assert((irg->reserved_resources & resources) == 0);
867 irg->reserved_resources |= resources;
870 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
872 assert((irg->reserved_resources & resources) == resources);
873 irg->reserved_resources &= ~resources;
876 ir_resources_t ir_resources_reserved(const ir_graph *irg)
878 return irg->reserved_resources;
882 /* Returns a estimated node count of the irg. */
883 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
885 return _get_irg_estimated_node_cnt(irg);
888 /* Returns the last irn index for this graph. */
889 unsigned get_irg_last_idx(const ir_graph *irg)
891 return irg->last_node_idx;
894 /* register additional space in an IR graph */
895 size_t register_additional_graph_data(size_t size)
897 assert(!forbid_new_data && "Too late to register additional node data");
902 return additional_graph_data_size += size;
905 void (set_irg_state)(ir_graph *irg, ir_graph_state_t state)
907 _set_irg_state(irg, state);
910 void (clear_irg_state)(ir_graph *irg, ir_graph_state_t state)
912 _clear_irg_state(irg, state);
915 int (is_irg_state)(const ir_graph *irg, ir_graph_state_t state)
917 return _is_irg_state(irg, state);