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->typeinfo_state = ir_typeinfo_none;
190 set_irp_typeinfo_inconsistent(); /* there is a new graph with typeinfo_none. */
191 res->callee_info_state = irg_callee_info_none;
192 res->loopinfo_state = loopinfo_none;
193 res->class_cast_state = ir_class_casts_transitive;
194 res->extblk_state = ir_extblk_info_none;
195 res->execfreq_state = exec_freq_none;
196 res->fp_model = fp_model_precise;
197 res->mem_disambig_opt = aa_opt_inherited;
199 /*-- Type information for the procedure of the graph --*/
201 set_entity_irg(ent, res);
203 /*-- a class type so that it can contain "inner" methods as in Pascal. --*/
204 res->frame_type = new_type_frame();
206 /* the Anchor node must be created first */
207 res->anchor = new_r_Anchor(res);
209 /*-- Nodes needed in every graph --*/
210 set_irg_end_block (res, new_r_immBlock(res));
211 set_irg_end(res, new_r_End(res, 0, NULL));
213 start_block = new_r_Block_noopt(res, 0, NULL);
214 set_irg_start_block(res, start_block);
215 set_irg_no_mem (res, new_r_NoMem(res));
216 start = new_r_Start(res);
217 set_irg_start (res, start);
219 /* Proj results of start node */
220 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
221 set_irg_initial_exec (res, projX);
222 set_irg_frame (res, new_r_Proj(start, mode_P_data, pn_Start_P_frame_base));
223 set_irg_args (res, new_r_Proj(start, mode_T, pn_Start_T_args));
224 initial_mem = new_r_Proj(start, mode_M, pn_Start_M);
225 set_irg_initial_mem(res, initial_mem);
227 res->index = get_irp_new_irg_idx();
229 res->graph_nr = get_irp_new_node_nr();
232 set_r_cur_block(res, start_block);
233 set_r_store(res, initial_mem);
235 /*-- Make a block to start with --*/
236 first_block = new_r_immBlock(res);
237 set_r_cur_block(res, first_block);
238 add_immBlock_pred(first_block, projX);
240 res->method_execution_frequency = -1.0;
241 res->estimated_node_count = 0;
246 ir_graph *new_ir_graph(ir_entity *ent, int n_loc)
248 ir_graph *res = new_r_ir_graph(ent, n_loc);
249 add_irp_irg(res); /* remember this graph global. */
253 /* Make a rudimentary IR graph for the constant code.
254 Must look like a correct irg, spare everything else. */
255 ir_graph *new_const_code_irg(void)
257 ir_graph *res = alloc_graph();
263 ir_node *start_block;
266 /* inform statistics here, as blocks will be already build on this graph */
267 hook_new_graph(res, NULL);
269 res->n_loc = 1; /* Only the memory. */
270 res->visited = 0; /* visited flag, for the ir walker */
271 res->block_visited = 0; /* visited flag, for the 'block'-walker */
272 res->obst = XMALLOC(struct obstack);
273 obstack_init(res->obst);
274 res->extbb_obst = NULL;
276 res->last_node_idx = 0;
278 res->phase_state = phase_building;
279 res->irg_pinned_state = op_pin_state_pinned;
280 res->extblk_state = ir_extblk_info_none;
281 res->fp_model = fp_model_precise;
283 /* value table for global value numbering for optimizing use in iropt.c */
286 res->frame_type = NULL;
288 /* the Anchor node must be created first */
289 res->anchor = new_r_Anchor(res);
291 /* -- The end block -- */
292 end_block = new_r_Block_noopt(res, 0, NULL);
293 set_irg_end_block(res, end_block);
294 end = new_r_End(res, 0, NULL);
295 set_irg_end(res, end);
297 /* -- The start block -- */
298 start_block = new_r_Block_noopt(res, 0, NULL);
299 set_irg_start_block(res, start_block);
300 no_mem = new_r_NoMem(res);
301 set_irg_no_mem(res, no_mem);
302 start = new_r_Start(res);
303 set_irg_start(res, start);
305 /* Proj results of start node */
306 set_irg_initial_mem(res, new_r_Proj(start, mode_M, pn_Start_M));
307 projX = new_r_Proj(start, mode_X, pn_Start_X_initial_exec);
309 body_block = new_r_Block(res, 1, &projX);
311 set_r_cur_block(res, body_block);
313 /* Set the visited flag high enough that the blocks will never be visited. */
314 set_irn_visited(body_block, -1);
315 set_Block_block_visited(body_block, -1);
316 set_Block_block_visited(start_block, -1);
317 set_irn_visited(start_block, -1);
318 set_irn_visited(no_mem, -1);
324 * Pre-Walker: Copies blocks and nodes from the original method graph
325 * to the copied graph.
327 * @param n A node from the original method graph.
328 * @param env The copied graph.
330 static void copy_all_nodes(ir_node *node, void *env)
332 ir_graph *irg = (ir_graph*)env;
333 ir_node *new_node = irn_copy_into_irg(node, irg);
335 set_irn_link(node, new_node);
337 /* fix access to entities on the stack frame */
338 if (is_Sel(new_node)) {
339 ir_entity *ent = get_Sel_entity(new_node);
340 ir_type *tp = get_entity_owner(ent);
342 if (is_frame_type(tp)) {
343 /* replace by the copied entity */
344 ent = (ir_entity*)get_entity_link(ent);
346 assert(is_entity(ent));
347 assert(get_entity_owner(ent) == get_irg_frame_type(irg));
348 set_Sel_entity(new_node, ent);
354 * Post-walker: Set the predecessors of the copied nodes.
355 * The copied nodes are set as link of their original nodes. The links of
356 * "irn" predecessors are the predecessors of copied node.
358 static void rewire(ir_node *irn, void *env)
361 irn_rewire_inputs(irn);
364 static ir_node *get_new_node(const ir_node *old_node)
366 return (ir_node*) get_irn_link(old_node);
370 * Create a new graph that is a copy of a given one.
372 ir_graph *create_irg_copy(ir_graph *irg)
379 res->visited = 0; /* visited flag, for the ir walker */
380 res->block_visited = 0; /* visited flag, for the 'block'-walker */
381 res->obst = XMALLOC(struct obstack);
382 obstack_init(res->obst);
383 res->extbb_obst = NULL;
385 res->last_node_idx = 0;
387 res->phase_state = irg->phase_state;
388 res->irg_pinned_state = irg->irg_pinned_state;
389 res->extblk_state = ir_extblk_info_none;
390 res->fp_model = irg->fp_model;
394 /* clone the frame type here for safety */
395 irp_reserve_resources(irp, IRP_RESOURCE_ENTITY_LINK);
396 res->frame_type = clone_frame_type(irg->frame_type);
398 res->phase_state = irg->phase_state;
400 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
402 /* copy all nodes from the graph irg to the new graph res */
403 irg_walk_anchors(irg, copy_all_nodes, rewire, res);
405 /* copy the Anchor node */
406 res->anchor = get_new_node(irg->anchor);
408 /* -- The end block -- */
409 set_irg_end_block (res, get_new_node(get_irg_end_block(irg)));
410 set_irg_end (res, get_new_node(get_irg_end(irg)));
412 /* -- The start block -- */
413 set_irg_start_block(res, get_new_node(get_irg_start_block(irg)));
414 set_irg_no_mem (res, get_new_node(get_irg_no_mem(irg)));
415 set_irg_start (res, get_new_node(get_irg_start(irg)));
417 /* Proj results of start node */
418 set_irg_initial_mem(res, get_new_node(get_irg_initial_mem(irg)));
420 /* Copy the node count estimation. Would be strange if this
421 is different from the original one. */
422 res->estimated_node_count = irg->estimated_node_count;
424 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
425 irp_free_resources(irp, IRP_RESOURCE_ENTITY_LINK);
430 /* Frees the passed irgraph.
431 Deallocates all nodes in this graph and the ir_graph structure.
432 Sets the field irgraph in the corresponding entity to NULL.
433 Does not remove the irgraph from the list in irprog (requires
434 inefficient search, call remove_irp_irg by hand).
435 Does not free types, entities or modes that are used only by this
436 graph, nor the entity standing for this graph. */
437 void free_ir_graph(ir_graph *irg)
439 assert(is_ir_graph(irg));
441 edges_deactivate(irg);
443 hook_free_graph(irg);
446 free_type(irg->frame_type);
449 set_entity_irg(irg->ent, NULL); /* not set in const code irg */
452 free_End(get_irg_end(irg));
453 obstack_free(irg->obst,NULL);
455 if (irg->loc_descriptions)
456 free(irg->loc_descriptions);
461 /* access routines for all ir_graph attributes:
463 {attr type} get_irg_{attribute name} (ir_graph *irg);
464 void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
466 int (is_ir_graph)(const void *thing)
468 return _is_ir_graph(thing);
472 /* Outputs a unique number for this node */
473 long get_irg_graph_nr(const ir_graph *irg)
475 return irg->graph_nr;
478 long get_irg_graph_nr(const ir_graph *irg)
480 return PTR_TO_INT(irg);
484 size_t get_irg_idx(const ir_graph *irg)
489 ir_node *(get_idx_irn)(const ir_graph *irg, unsigned idx)
491 return _get_idx_irn(irg, idx);
494 ir_node *(get_irg_start_block)(const ir_graph *irg)
496 return _get_irg_start_block(irg);
499 void (set_irg_start_block)(ir_graph *irg, ir_node *node)
501 _set_irg_start_block(irg, node);
504 ir_node *(get_irg_start)(const ir_graph *irg)
506 return _get_irg_start(irg);
509 void (set_irg_start)(ir_graph *irg, ir_node *node)
511 _set_irg_start(irg, node);
514 ir_node *(get_irg_end_block)(const ir_graph *irg)
516 return _get_irg_end_block(irg);
519 void (set_irg_end_block)(ir_graph *irg, ir_node *node)
521 _set_irg_end_block(irg, node);
524 ir_node *(get_irg_end)(const ir_graph *irg)
526 return _get_irg_end(irg);
529 void (set_irg_end)(ir_graph *irg, ir_node *node)
531 _set_irg_end(irg, node);
534 ir_node *(get_irg_initial_exec)(const ir_graph *irg)
536 return _get_irg_initial_exec(irg);
539 void (set_irg_initial_exec)(ir_graph *irg, ir_node *node)
541 _set_irg_initial_exec(irg, node);
544 ir_node *(get_irg_frame)(const ir_graph *irg)
546 return _get_irg_frame(irg);
549 void (set_irg_frame)(ir_graph *irg, ir_node *node)
551 _set_irg_frame(irg, node);
554 ir_node *(get_irg_initial_mem)(const ir_graph *irg)
556 return _get_irg_initial_mem(irg);
559 void (set_irg_initial_mem)(ir_graph *irg, ir_node *node)
561 _set_irg_initial_mem(irg, node);
564 ir_node *(get_irg_args)(const ir_graph *irg)
566 return _get_irg_args(irg);
569 void (set_irg_args)(ir_graph *irg, ir_node *node)
571 _set_irg_args(irg, node);
574 ir_node *(get_irg_no_mem)(const ir_graph *irg)
576 return _get_irg_no_mem(irg);
579 void (set_irg_no_mem)(ir_graph *irg, ir_node *node)
581 _set_irg_no_mem(irg, node);
584 ir_entity *(get_irg_entity)(const ir_graph *irg)
586 return _get_irg_entity(irg);
589 void (set_irg_entity)(ir_graph *irg, ir_entity *ent)
591 _set_irg_entity(irg, ent);
594 ir_type *(get_irg_frame_type)(ir_graph *irg)
596 return _get_irg_frame_type(irg);
599 void (set_irg_frame_type)(ir_graph *irg, ir_type *ftp)
601 _set_irg_frame_type(irg, ftp);
604 int get_irg_n_locs(ir_graph *irg)
606 return irg->n_loc - 1;
609 /* Returns the obstack associated with the graph. */
611 (get_irg_obstack)(const ir_graph *irg) {
612 return _get_irg_obstack(irg);
616 * Returns true if the node n is allocated on the storage of graph irg.
618 * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
620 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n)
622 struct _obstack_chunk *p;
625 * checks weather the ir_node pointer is on the obstack.
626 * A more sophisticated check would test the "whole" ir_node
628 for (p = irg->obst->chunk; p; p = p->prev) {
629 if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
636 irg_phase_state (get_irg_phase_state)(const ir_graph *irg)
638 return _get_irg_phase_state(irg);
641 void (set_irg_phase_state)(ir_graph *irg, irg_phase_state state)
643 _set_irg_phase_state(irg, state);
646 op_pin_state (get_irg_pinned)(const ir_graph *irg)
648 return _get_irg_pinned(irg);
651 irg_extblk_info_state (get_irg_extblk_state)(const ir_graph *irg)
653 return _get_irg_extblk_state(irg);
656 void (set_irg_extblk_inconsistent)(ir_graph *irg)
658 _set_irg_extblk_inconsistent(irg);
661 irg_loopinfo_state (get_irg_loopinfo_state)(const ir_graph *irg)
663 return _get_irg_loopinfo_state(irg);
666 void (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s)
668 _set_irg_loopinfo_state(irg, s);
671 void (set_irg_loopinfo_inconsistent)(ir_graph *irg)
673 _set_irg_loopinfo_inconsistent(irg);
676 void set_irp_loopinfo_inconsistent(void)
679 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
680 set_irg_loopinfo_inconsistent(get_irp_irg(i));
686 void (set_irg_pinned)(ir_graph *irg, op_pin_state p)
688 _set_irg_pinned(irg, p);
691 irg_callee_info_state (get_irg_callee_info_state)(const ir_graph *irg)
693 return _get_irg_callee_info_state(irg);
696 void (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s)
698 _set_irg_callee_info_state(irg, s);
701 irg_inline_property (get_irg_inline_property)(const ir_graph *irg)
703 return _get_irg_inline_property(irg);
706 void (set_irg_inline_property)(ir_graph *irg, irg_inline_property s)
708 _set_irg_inline_property(irg, s);
711 mtp_additional_properties (get_irg_additional_properties)(const ir_graph *irg)
713 return _get_irg_additional_properties(irg);
716 void (set_irg_additional_properties)(ir_graph *irg, mtp_additional_properties property_mask)
718 _set_irg_additional_properties(irg, property_mask);
721 void (add_irg_additional_properties)(ir_graph *irg, mtp_additional_properties flag)
723 _add_irg_additional_properties(irg, flag);
726 void (set_irg_link)(ir_graph *irg, void *thing)
728 _set_irg_link(irg, thing);
731 void *(get_irg_link)(const ir_graph *irg)
733 return _get_irg_link(irg);
736 ir_visited_t (get_irg_visited)(const ir_graph *irg)
738 return _get_irg_visited(irg);
741 /** maximum visited flag content of all ir_graph visited fields. */
742 static ir_visited_t max_irg_visited = 0;
744 void set_irg_visited(ir_graph *irg, ir_visited_t visited)
746 irg->visited = visited;
747 if (irg->visited > max_irg_visited) {
748 max_irg_visited = irg->visited;
752 void inc_irg_visited(ir_graph *irg)
755 if (irg->visited > max_irg_visited) {
756 max_irg_visited = irg->visited;
760 ir_visited_t get_max_irg_visited(void)
762 return max_irg_visited;
765 void set_max_irg_visited(int val)
767 max_irg_visited = val;
770 ir_visited_t inc_max_irg_visited(void)
774 for (i = 0; i < get_irp_n_irgs(); i++)
775 assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
777 return ++max_irg_visited;
780 ir_visited_t (get_irg_block_visited)(const ir_graph *irg)
782 return _get_irg_block_visited(irg);
785 void (set_irg_block_visited)(ir_graph *irg, ir_visited_t visited)
787 _set_irg_block_visited(irg, visited);
790 void (inc_irg_block_visited)(ir_graph *irg)
792 _inc_irg_block_visited(irg);
795 /* Return the floating point model of this graph. */
796 unsigned (get_irg_fp_model)(const ir_graph *irg)
798 return _get_irg_fp_model(irg);
801 /* Sets the floating point model for this graph. */
802 void set_irg_fp_model(ir_graph *irg, unsigned model)
804 irg->fp_model = model;
807 /* set a description for local value n */
808 void set_irg_loc_description(ir_graph *irg, int n, void *description)
810 assert(0 <= n && n < irg->n_loc);
812 if (! irg->loc_descriptions)
813 irg->loc_descriptions = XMALLOCNZ(void*, irg->n_loc);
815 irg->loc_descriptions[n] = description;
818 /* get the description for local value n */
819 void *get_irg_loc_description(ir_graph *irg, int n)
821 assert(0 <= n && n < irg->n_loc);
822 return irg->loc_descriptions ? irg->loc_descriptions[n] : NULL;
825 void irg_register_phase(ir_graph *irg, ir_phase_id id, ir_phase *phase)
827 assert(id <= PHASE_LAST);
828 assert(irg->phases[id] == NULL);
829 irg->phases[id] = phase;
832 void irg_invalidate_phases(ir_graph *irg)
835 for (p = 0; p <= PHASE_LAST; ++p) {
836 ir_phase *phase = irg->phases[p];
841 irg->phases[p] = NULL;
846 void ir_reserve_resources(ir_graph *irg, ir_resources_t resources)
848 assert((irg->reserved_resources & resources) == 0);
849 irg->reserved_resources |= resources;
852 void ir_free_resources(ir_graph *irg, ir_resources_t resources)
854 assert((irg->reserved_resources & resources) == resources);
855 irg->reserved_resources &= ~resources;
858 ir_resources_t ir_resources_reserved(const ir_graph *irg)
860 return irg->reserved_resources;
864 /* Returns a estimated node count of the irg. */
865 unsigned (get_irg_estimated_node_cnt)(const ir_graph *irg)
867 return _get_irg_estimated_node_cnt(irg);
870 /* Returns the last irn index for this graph. */
871 unsigned get_irg_last_idx(const ir_graph *irg)
873 return irg->last_node_idx;
876 /* register additional space in an IR graph */
877 size_t register_additional_graph_data(size_t size)
879 assert(!forbid_new_data && "Too late to register additional node data");
884 return additional_graph_data_size += size;
887 void (set_irg_state)(ir_graph *irg, ir_graph_state_t state)
889 _set_irg_state(irg, state);
892 void (clear_irg_state)(ir_graph *irg, ir_graph_state_t state)
894 _clear_irg_state(irg, state);
897 int (is_irg_state)(const ir_graph *irg, ir_graph_state_t state)
899 return _is_irg_state(irg, state);