2 * Copyright (C) 1995-2008 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 Intraprozedural analyses to estimate the call graph.
23 * @author Hubert Schmid
27 * Interprocedural analysis to estimate the calling relation.
29 * This analysis computes all entities representing methods that
30 * can be called at a Call node. Further it computes a set of
31 * methods that are 'free', i.e., their adress is handled by
32 * the program directly, or they are visible external.
56 #include "dbginfo_t.h"
57 #include "iropt_dbg.h"
66 /* unambiguous address used as a mark. */
67 static void *MARK = &MARK;
69 static eset *entities = NULL;
71 /*--------------------------------------------------------------------------*/
73 /*--------------------------------------------------------------------------*/
76 /*--------------------------------------------------------------------------*/
77 /* Initialize datastructures, remove unwanted constructs, optimize */
78 /* call target computations. */
79 /*--------------------------------------------------------------------------*/
81 /** Returns the entity that contains the implementation of the inherited
82 * entity if available, else returns the entity passed. */
83 static ir_entity *get_inherited_methods_implementation(ir_entity *inh_meth) {
84 ir_node *value = get_atomic_ent_value(inh_meth);
85 assert(value && "constant entity without value");
86 assert(is_SymConst_addr_ent(value) &&
87 "Complex constant values not supported -- address of method should be straight constant!");
89 return get_SymConst_entity(value);
92 /** Collect the entity representing the implementation of this
93 * method (not the same if inherited) and all entities for overwriting
94 * implementations in "set".
95 * If the implementation of the method is not included in the
96 * compilation unit "open" is set to true.
97 * A recursive descend in the overwritten relation.
98 * Cycle-free, therefore must terminate.
101 * @param set A set of entities.
102 * @param size Number of entities in set.
105 static void collect_impls(ir_entity *method, eset *set, int *size, int *open) {
109 /* Add the implementation to the set if it contains an irg, else
110 remember that there are more methods called. */
112 if (get_entity_peculiarity(method) == peculiarity_inherited)
113 impl = get_inherited_methods_implementation(method);
115 if (get_entity_peculiarity(method) != peculiarity_description) {
116 eset_insert(set, impl);
120 /*- recursive descent -*/
121 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
122 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
125 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
126 * (und implementieren). In der zurückgegebenen Reihung kommt jede
127 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
128 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
129 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
130 * keine Methoden, die "method" überschreiben, so gibt die Methode
135 static ir_entity ** get_impl_methods(ir_entity * method) {
136 eset * set = eset_create();
141 /* Collect all method entities that can be called here */
142 collect_impls(method, set, &size, &open);
144 /* Vorgaenger einfuegen. */
145 if (size == 0 && !open) {
146 /* keine implementierte überschriebene Methode */
150 arr = NEW_ARR_F(ir_entity *, size + 1);
151 arr[0] = NULL; /* Represents open method */
152 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
156 arr = NEW_ARR_F(ir_entity *, size);
157 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
164 /** Analyze address computations.
166 * Compute for all Sel nodes the set of methods that can be selected.
167 * For each entity we store the set of subentities in the link field.
169 * Further do some optimizations:
170 * - Call standard optimizations for Sel nodes: this removes polymorphic
172 * - If the node is a SymConst(name) replace it by SymConst(ent) if possible.
173 * For this we precomputed a map name->entity. Nowadays, we no more support
175 * - If the node is a Sel:
176 * If we found only a single method that can be called, replace the Sel
177 * by a SymConst. This is more powerful than the analysis in opt_polymorphy,
178 * as here we walk the type graph. In opt_polymorphy we only apply a local
181 * @param node The node to analyze
182 * @param env A map that maps names of entities to the entities.
184 static void sel_methods_walker(ir_node *node, void *env) {
185 pmap *ldname_map = env;
188 /* Call standard optimizations */
190 ir_node *new_node = optimize_in_place(node);
191 if (node != new_node) {
192 exchange(node, new_node);
197 /* replace SymConst(name)-operations by SymConst(ent) */
198 if (is_SymConst(node)) {
199 if (get_SymConst_kind(node) == symconst_addr_name) {
200 pmap_entry *entry = pmap_find(ldname_map, get_SymConst_name(node));
201 if (entry != NULL) { /* Method is declared in the compiled code */
202 assert(!"There should not be a SymConst[addr_name] addressing a method with an implementation"
203 "in this compilation unit. Use a SymConst[addr_ent].");
206 } else if (is_Sel(node) && is_Method_type(get_entity_type(get_Sel_entity(node)))) {
207 ir_entity *ent = get_SymConst_entity(get_atomic_ent_value(get_Sel_entity(node)));
208 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
210 if (!eset_contains(entities, ent)) {
211 /* Entity not yet handled. Find all (internal or external)
212 * implemented methods that overwrites this entity.
213 * This set is stored in the entity link. */
214 set_entity_link(ent, get_impl_methods(ent));
215 eset_insert(entities, ent);
218 /* -- As an add on we get an optimization that removes polymorphic calls.
219 This optimization is more powerful than that in transform_node_Sel(). -- */
220 arr = get_entity_link(ent);
223 * The Sel node never returns a pointer to a usable method.
224 * We could not call it, but it may be description:
225 * We call a method in a dead part of the program.
227 assert(get_entity_peculiarity(ent) == peculiarity_description);
229 else if (get_opt_closed_world() && get_opt_dyn_meth_dispatch() &&
230 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
234 * The Sel node returns only one possible method.
235 * So we could replace the Sel node by a SymConst.
236 * This method must exists.
238 set_irg_current_block(current_ir_graph, get_nodes_block(node));
239 assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
240 peculiarity_existent);
241 new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(arr[0]));
242 DBG_OPT_POLY(node, new_node);
243 exchange(node, new_node);
249 * Initialize auxiliary data structures.
251 * Computes a set of entities that overwrite an entity and contain
252 * an implementation. The set is stored in the entity's link field.
254 * Further replaces Sel nodes where this set contains exactly one
255 * method by SymConst nodes.
256 * Finally asserts if there is a SymConst(name) if there could be a
259 static void sel_methods_init(void) {
261 pmap *ldname_map = pmap_create(); /* Map entity names to entities: to replace
262 SymConst(name) by SymConst(ent). */
263 assert(entities == NULL);
264 entities = eset_create();
265 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
266 ir_entity * ent = get_irg_entity(get_irp_irg(i));
267 /* only external visible methods are allowed to call by a SymConst_ptr_name */
268 if (get_entity_visibility(ent) != visibility_local) {
269 pmap_insert(ldname_map, (void *)get_entity_ld_ident(ent), ent);
273 all_irg_walk(sel_methods_walker, NULL, ldname_map);
274 pmap_destroy(ldname_map);
277 /*--------------------------------------------------------------------------*/
278 /* Find free methods.
280 * We expect that each entity has an array with all implementations in its
282 /*--------------------------------------------------------------------------*/
285 * Returns an array of all methods that could be called at a Sel node.
286 * This array contains every entry only once.
288 * @param sel the Sel node
290 static ir_entity ** get_Sel_arr(ir_node * sel) {
291 static ir_entity ** NULL_ARRAY = NULL;
296 ent = get_Sel_entity(sel);
297 ent = get_inherited_methods_implementation(ent);
299 assert(is_Method_type(get_entity_type(ent))); /* what else? */
300 arr = get_entity_link(ent);
304 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
305 * kann für polymorphe (abstrakte) Methoden passieren. */
307 NULL_ARRAY = NEW_ARR_F(ir_entity *, 0);
314 * Returns the number of possible called methods at a Sel node.
316 * @param sel the Sel node
318 static int get_Sel_n_methods(ir_node * sel) {
319 return ARR_LEN(get_Sel_arr(sel));
323 * Returns the ith possible called method entity at a Sel node.
325 static ir_entity * get_Sel_method(ir_node * sel, int pos) {
326 ir_entity ** arr = get_Sel_arr(sel);
327 assert(pos >= 0 && pos < ARR_LEN(arr));
332 static void free_mark(ir_node * node, eset * set);
334 static void free_mark_proj(ir_node * node, long n, eset * set) {
335 assert(get_irn_mode(node) == mode_T);
336 if (get_irn_link(node) == MARK) {
337 /* already visited */
340 set_irn_link(node, MARK);
341 switch (get_irn_opcode(node)) {
343 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
344 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
346 ir_node * pred = get_Proj_pred(node);
347 if (get_irn_link(pred) != MARK && is_Tuple(pred)) {
348 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
350 /* nothing: da in "free_ana_walker" behandelt. */
356 free_mark(get_Tuple_pred(node, n), set);
360 free_mark_proj(get_Id_pred(node), n, set);
366 /* nothing: Die Operationen werden in free_ana_walker() selbst
371 assert(0 && "unexpected opcode or opcode not implemented");
374 // set_irn_link(node, NULL);
378 * Called for predecessors nodes of "interesting" ones.
379 * Interesting ones include all nodes that can somehow make
382 * If a method (or a set of methods in case of polymorph calls) gets visible,
383 * add it to the set of 'free' methods
385 * @param node the current visited node
386 * @param set the set of all free methods
388 static void free_mark(ir_node *node, eset * set) {
391 if (get_irn_link(node) == MARK)
392 return; /* already visited */
394 set_irn_link(node, MARK);
396 switch (get_irn_opcode(node)) {
398 ir_entity *ent = get_Sel_entity(node);
399 if (is_method_entity(ent)) {
400 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
401 eset_insert(set, get_Sel_method(node, i));
407 if (get_SymConst_kind(node) == symconst_addr_ent) {
408 ir_entity *ent = get_SymConst_entity(node);
409 if (is_method_entity(ent)) {
410 eset_insert(set, ent);
413 assert(get_SymConst_kind(node) == symconst_addr_name);
414 /* nothing: SymConst points to extern method */
419 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
420 free_mark(get_Phi_pred(node, i), set);
424 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
433 * post-walker. Find method addresses.
435 static void free_ana_walker(ir_node *node, void *env) {
439 if (get_irn_link(node) == MARK) {
440 /* already visited */
443 switch (get_irn_opcode(node)) {
455 /* we must handle Call nodes specially, because their call address input
456 do not expose a method address. */
457 set_irn_link(node, MARK);
458 for (i = get_Call_n_params(node) - 1; i >= 0; --i) {
459 ir_node *pred = get_Call_param(node, i);
460 if (mode_is_reference(get_irn_mode(pred))) {
461 free_mark(pred, set);
466 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
467 * jemand das Gegenteil implementiert. */
468 set_irn_link(node, MARK);
469 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
470 ir_node *pred = get_irn_n(node, i);
471 if (mode_is_reference(get_irn_mode(pred))) {
472 free_mark(pred, set);
480 * Add all method addresses in global new style initializers to the set.
483 * We do NOT check the type here, just it it's an entity address.
484 * The reason for this is code like:
486 * void *p = function;
488 * which is sometimes used to anchor functions.
490 static void add_method_address_inititializer(ir_initializer_t *initializer,
496 switch (initializer->kind) {
497 case IR_INITIALIZER_CONST:
498 n = initializer->consti.value;
500 /* let's check if it's the address of a function */
502 ir_entity *ent = get_Global_entity(n);
504 if (is_Method_type(get_entity_type(ent)))
505 eset_insert(set, ent);
508 case IR_INITIALIZER_TARVAL:
509 case IR_INITIALIZER_NULL:
511 case IR_INITIALIZER_COMPOUND:
512 for (i = 0; i < initializer->compound.n_initializers; ++i) {
513 ir_initializer_t *sub_initializer
514 = initializer->compound.initializers[i];
515 add_method_address_inititializer(sub_initializer, set);
519 panic("invalid initializer found");
523 * Add all method addresses in global initializers to the set.
526 * We do NOT check the type here, just it it's an entity address.
527 * The reason for this is code like:
529 * void *p = function;
531 * which is sometimes used to anchor functions.
533 static void add_method_address(ir_entity *ent, eset *set)
539 /* do not check uninitialized values */
540 if (get_entity_variability(ent) == variability_uninitialized)
543 if (ent->has_initializer) {
544 add_method_address_inititializer(get_entity_initializer(ent), set);
545 } else if (is_atomic_entity(ent)) {
546 tp = get_entity_type(ent);
548 /* ignore methods: these of course reference it's address */
549 if (is_Method_type(tp))
552 /* let's check if it's the address of a function */
553 n = get_atomic_ent_value(ent);
555 ent = get_Global_entity(n);
557 if (is_Method_type(get_entity_type(ent)))
558 eset_insert(set, ent);
561 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
562 n = get_compound_ent_value(ent, i);
564 /* let's check if it's the address of a function */
566 ir_entity *ent = get_Global_entity(n);
568 if (is_Method_type(get_entity_type(ent)))
569 eset_insert(set, ent);
576 * returns a list of 'free' methods, i.e., the methods that can be called
577 * from external or via function pointers.
579 * Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
580 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
581 * SymConst(name)-Operationen müssen in passende SymConst(ent)-Operationen
582 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
583 * auf eine echt externe Methode.
585 static ir_entity **get_free_methods(int *length)
587 eset *free_set = eset_create();
594 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
595 irg = get_irp_irg(i);
596 ent = get_irg_entity(irg);
597 if (get_entity_visibility(ent) != visibility_local) {
598 /* insert non-local (external) methods. */
599 eset_insert(free_set, ent);
600 } else if (get_entity_stickyness(ent) == stickyness_sticky) {
601 /* insert "sticky" methods. */
602 eset_insert(free_set, ent);
605 ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
606 /* Find all method entities that gets "visible" through this graphs,
607 * for instance because their address is stored. */
608 irg_walk_graph(irg, firm_clear_link, free_ana_walker, free_set);
609 ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
612 /* insert all methods that are used in global variables initializers */
613 tp = get_glob_type();
614 for (i = get_class_n_members(tp) - 1; i >= 0; --i) {
615 ent = get_class_member(tp, i);
616 add_method_address(ent, free_set);
619 for (i = get_struct_n_members(tp) - 1; i >= 0; --i) {
620 ent = get_struct_member(tp, i);
621 add_method_address(ent, free_set);
624 /* the main program is even then "free", if it's not external visible. */
625 irg = get_irp_main_irg();
627 eset_insert(free_set, get_irg_entity(irg));
629 /* Finally, transform the set into an array. */
630 *length = eset_count(free_set);
631 arr = XMALLOCN(ir_entity*, *length);
632 for (i = 0, ent = eset_first(free_set); ent; ent = eset_next(free_set)) {
635 eset_destroy(free_set);
640 /*--------------------------------------------------------------------------*/
641 /* Callee analysis. */
642 /*--------------------------------------------------------------------------*/
644 static void callee_ana_node(ir_node * node, eset * methods);
646 static void callee_ana_proj(ir_node *node, long n, eset *methods) {
647 assert(get_irn_mode(node) == mode_T);
648 if (get_irn_link(node) == MARK) {
649 /* already visited */
652 set_irn_link(node, MARK);
654 switch (get_irn_opcode(node)) {
656 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
657 * op_Tuple oder ein Knoten, der eine "freie Methode"
659 ir_node *pred = get_Proj_pred(node);
660 if (get_irn_link(pred) != MARK) {
661 if (is_Tuple(pred)) {
662 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
664 eset_insert(methods, unknown_entity); /* free method -> unknown */
671 callee_ana_node(get_Tuple_pred(node, n), methods);
675 eset_insert(methods, unknown_entity); /* free method -> unknown */
681 * Analyse a Call address.
683 * @param node the node representing the call address
684 * @param methods after call contains the set of all possibly called entities
686 static void callee_ana_node(ir_node *node, eset *methods) {
689 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
690 /* Beware of recursion */
691 if (get_irn_link(node) == MARK) {
692 /* already visited */
695 set_irn_link(node, MARK);
697 switch (get_irn_opcode(node)) {
699 /* A direct address call. We tread this as an external
700 call and ignore it completely. */
701 eset_insert(methods, unknown_entity); /* free method -> unknown */
704 if (get_SymConst_kind(node) == symconst_addr_ent) {
705 ir_entity *ent = get_SymConst_entity(node);
706 assert(ent && is_method_entity(ent));
707 eset_insert(methods, ent);
709 assert(get_SymConst_kind(node) == symconst_addr_name);
710 /* external method (because fix_symconst()!) */
711 eset_insert(methods, unknown_entity); /* free method -> unknown */
715 /* polymorphic method */
716 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
717 ir_entity *ent = get_Sel_method(node, i);
719 eset_insert(methods, ent);
721 eset_insert(methods, unknown_entity);
731 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
732 callee_ana_node(get_Phi_pred(node, i), methods);
737 callee_ana_node(get_Mux_false(node), methods);
738 callee_ana_node(get_Mux_true(node), methods);
742 callee_ana_node(get_Id_pred(node), methods);
746 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
753 eset_insert(methods, unknown_entity); /* free method -> unknown */
757 assert(0 && "invalid opcode or opcode not implemented");
763 * Walker: Analyses every Call node and calculates an array of possible
764 * callees for that call.
766 static void callee_walker(ir_node *call, void *env) {
769 eset *methods = eset_create();
774 callee_ana_node(get_Call_ptr(call), methods);
775 arr = NEW_ARR_F(ir_entity *, eset_count(methods));
776 for (i = 0, ent = eset_first(methods); ent; ent = eset_next(methods)) {
778 /* we want the unknown_entity on the zero position for easy tests later */
779 if (ent == unknown_entity) {
781 arr[0] = unknown_entity;
785 set_Call_callee_arr(call, ARR_LEN(arr), arr);
787 eset_destroy(methods);
792 * Walker: Removes all tuple.
794 static void remove_Tuples(ir_node *proj, void *env) {
797 if (! is_Proj(proj)) return;
799 nn = skip_Tuple(proj);
800 if (nn != proj) exchange(proj, nn);
805 * Determine for every Call the set of possibly called methods and stores it
806 * inside the Call (@see set_Call_callee()).
807 * Uses the sel_methods set with much be already calculated.
809 static void callee_ana(void) {
811 /* analyse all graphs */
812 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
813 ir_graph *irg = get_irp_irg(i);
814 irg_walk_graph(irg, callee_walker, remove_Tuples, NULL);
815 set_irg_callee_info_state(irg, irg_callee_info_consistent);
817 set_irp_callee_info_state(irg_callee_info_consistent);
820 /*--------------------------------------------------------------------------*/
821 /* Cleanup after analyses. */
822 /*--------------------------------------------------------------------------*/
824 /** Frees intermediate data structures. */
825 static void sel_methods_dispose(void) {
828 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
829 ir_entity ** arr = get_entity_link(ent);
833 set_entity_link(ent, NULL);
835 eset_destroy(entities);
839 /*--------------------------------------------------------------------------*/
840 /* Freeing the callee arrays. */
841 /*--------------------------------------------------------------------------*/
843 static void destruct_walker(ir_node * node, void * env) {
846 remove_Call_callee_arr(node);
850 /*--------------------------------------------------------------------------*/
852 /*--------------------------------------------------------------------------*/
854 void cgana(int *length, ir_entity ***free_methods) {
855 /* Optimize Sel/SymConst nodes and compute all methods that implement an entity. */
857 *free_methods = get_free_methods(length);
859 sel_methods_dispose();
862 void free_callee_info(ir_graph *irg) {
863 irg_walk_graph(irg, destruct_walker, NULL, NULL);
864 set_irg_callee_info_state(irg, irg_callee_info_none);
867 void free_irp_callee_info(void) {
869 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
870 free_callee_info(get_irp_irg(i));
874 /* Optimize the address expressions passed to call nodes.
876 * This optimization performs the following transformations for
878 * - All SymConst operations that refer to intern methods are replaced
879 * by Const operations referring to the corresponding entity.
880 * - Sel nodes, that select entities that are not overwritten are
881 * replaced by Const nodes referring to the selected entity.
882 * - Sel nodes, for which no method exists at all are replaced by Bad
884 * - Sel nodes with a pointer input that is an Alloc node are replaced
885 * by Const nodes referring to the entity that implements the method in
886 * the type given by the Alloc node.
888 void opt_call_addrs(void) {
890 sel_methods_dispose();