3 * File name: ir/ana/cgana.c
4 * Purpose: Intraprozedural analyses to estimate the call graph.
5 * Author: Hubert Schmid
9 * Copyright: (c) 1999-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
14 * Intraprozedurale Analyse zur Abschätzung der Aufrufrelation. Es
15 * wird eine Menge von freien Methoden und anschließend die an den
16 * Call-Operationen aufrufbaren Methoden bestimmt.
38 #include "dbginfo_t.h"
42 /* Eindeutige Adresse zur Markierung von besuchten Knoten und zur
43 * Darstellung der unbekannten Methode. */
44 static void * MARK = &MARK;
48 /* --- sel methods ---------------------------------------------------------- */
51 static eset * entities = NULL;
54 /** Bestimmt die eindeutige Methode, die die Methode für den
55 * übergebenen (dynamischen) Typ überschreibt. */
56 static entity * get_implementation(type * class, entity * method) {
58 if (get_entity_peculiarity(method) != peculiarity_description &&
59 get_entity_owner(method) == class) {
62 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i) {
63 entity * e = get_entity_overwrittenby(method, i);
64 if (get_entity_peculiarity(e) != peculiarity_description && get_entity_owner(e) == class) {
68 for (i = get_class_n_supertypes(class) - 1; i >= 0; --i) {
69 entity * e = get_implementation(get_class_supertype(class, i), method);
74 assert(0 && "implementation not found");
78 /** Returns the entity that contains the implementation of the inherited
79 entity if available, else returns the entity passed. */
80 static entity *get_inherited_methods_implementation(entity *inh_meth) {
81 entity *impl_meth = NULL;
82 ir_node *addr = get_atomic_ent_value(inh_meth);
83 assert(addr && "constant entity without value");
85 if (get_irn_op(addr) == op_Const) {
86 impl_meth = tarval_to_entity(get_Const_tarval(addr));
88 assert(0 && "Complex constant values not supported -- address of method should be straight constant!");
90 if (impl_meth && (get_entity_peculiarity(impl_meth) != peculiarity_existent)) {
92 printf("this_meth: "); DDMEO(inh_meth);
93 printf("impl meth: "); DDMEO(impl_meth);
94 assert(!impl_meth || get_entity_peculiarity(impl_meth) == peculiarity_existent);
98 return impl_meth? impl_meth : inh_meth;
102 /** Collect the entity representing the implementation of this
103 * entity (not the same if inherited) and all entities for overwriting
104 * implementations in "set".
105 * If the implementation of the method is not included in the
106 * compilation unit "open" is set to true.
107 * A recursive descend in the overwritten relation.
108 * Cycle-free, therefore must terminate.
111 * @param set A set of entities.
112 * @param size Number of entities in set.
115 static void collect_impls(entity *method, eset *set, int *size, bool *open) {
118 if (get_entity_peculiarity(method) == peculiarity_existent) {
119 if (get_entity_visibility(method) == visibility_external_allocated) {
120 assert(get_entity_irg(method) == NULL);
123 assert(get_entity_irg(method) != NULL);
124 if (!eset_contains(set, method)) {
125 eset_insert(set, method);
131 if (get_entity_peculiarity(method) == peculiarity_inherited) {
132 entity *impl_ent = get_inherited_methods_implementation(method);
133 assert(impl_ent && "no implementation for inherited entity");
134 if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
135 assert(get_entity_irg(impl_ent) == NULL);
138 assert(get_entity_irg(impl_ent) != NULL);
139 if (!eset_contains(set, impl_ent)) {
140 eset_insert(set, impl_ent);
145 /** recursive descend **/
146 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
147 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
151 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
152 * (und implementieren). In der zurückgegebenen Reihung kommt jede
153 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
154 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
155 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
156 * keine Methoden, die "method" überschreiben, so gibt die Methode
161 static entity ** get_impl_methods(entity * method) {
162 eset * set = eset_create();
167 /* Collect all method entities that can be called here */
168 collect_impls(method, set, &size, &open);
170 /* Vorgaenger einfuegen. */
171 if (size == 0 && !open) {
172 /* keine implementierte überschriebene Methode */
176 arr = NEW_ARR_F(entity *, size + 1);
177 arr[0] = NULL; /* Represents open method */
178 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
182 arr = NEW_ARR_F(entity *, size);
183 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
191 /* debug makros used in sel_methods_walker */
192 #define SIZ(x) sizeof(x)/sizeof((x)[0])
194 #define DBG_OPT_NORMALIZE \
195 __dbg_info_merge_pair(new_node, node, dbg_const_eval)
196 #define DBG_OPT_POLY_ALLOC \
200 ons[1] = skip_Proj(get_Sel_ptr(node)); \
201 __dbg_info_merge_sets(&new_node, 1, ons, SIZ(ons), dbg_rem_poly_call); \
203 #define DBG_OPT_POLY \
204 __dbg_info_merge_pair(new_node, node, dbg_rem_poly_call)
208 /** Analyse address computations.
210 * - If the node is a SymConst replace it by Const(ent) if possible.
211 * - If the node is a Sel:
212 * * If the pointer to the Sel comes directly from an Alloc node
213 * replace the Sel by a Const(ent).
216 * @param node The node to analyze
217 * @param ldname_map A map that mapps names of entities to the entities.
219 static void sel_methods_walker(ir_node * node, pmap * ldname_map) {
221 if (get_irn_op(node) == op_SymConst) {
222 /* Wenn möglich SymConst-Operation durch Const-Operation
224 if (get_SymConst_kind(node) == linkage_ptr_info) {
225 pmap_entry *entry = pmap_find(ldname_map, (void *) get_SymConst_ptrinfo(node));
226 if (entry != NULL) { /* Method is declared in the compiled code */
227 entity *ent = entry->value;
228 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) {
229 /* Meth. is defined */
231 assert(get_entity_irg(ent));
232 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
233 new_node = new_d_Const(get_irn_dbg_info(node),
234 mode_P_mach, new_tarval_from_entity(ent, mode_P_mach)); DBG_OPT_NORMALIZE;
235 exchange(node, new_node);
239 } else if (get_irn_op(node) == op_Sel &&
240 is_method_type(get_entity_type(get_Sel_entity(node)))) {
241 entity * ent = get_Sel_entity(node);
242 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
243 (get_irn_op(skip_Proj(get_Sel_ptr(node))) == op_Alloc)) {
246 /* We know which method will be called, no dispatch necessary. */
248 assert(get_entity_peculiarity(ent) != peculiarity_description);
249 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
250 /* @@@ Is this correct?? Alloc could reference a subtype of the owner
251 of Sel that overwrites the method referenced in Sel. */
252 /* @@@ Yes, this is wrong. GL, 10.3.04 */
253 new_node = copy_const_value(get_atomic_ent_value(ent)); DBG_OPT_POLY_ALLOC;
255 called_ent = resolve_ent_polymorphy(get_Alloc_type(skip_Proj(get_Sel_ptr(node))), ent);
256 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
257 /* called_ent may not be description: has no Address/Const to Call! */
258 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
259 new_node = copy_const_value(get_atomic_ent_value(called_ent)); DBG_OPT_POLY_ALLOC;
261 exchange (node, new_node);
263 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
264 if (!eset_contains(entities, ent)) {
265 /* Entity noch nicht behandelt. Alle (intern oder extern)
266 * implementierten Methoden suchen, die diese Entity
267 * überschreiben. Die Menge an entity.link speichern. */
268 set_entity_link(ent, get_impl_methods(ent));
269 eset_insert(entities, ent);
271 if (get_entity_link(ent) == NULL) {
272 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
273 * Methode zurückgeben. Damit ist sie insbesondere nicht
274 * ausführbar und nicht erreichbar. */
275 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
276 fuer die es keine Implementierung gibt. */
277 if (get_entity_peculiarity(ent) == peculiarity_description) {
278 /* @@@ GL Methode um Fehler anzuzeigen aufrufen! */
279 printf("WARNING: Calling method description %s\n in method %s\n of class %s\n which has "
280 "no implementation!\n", get_entity_name(ent),
281 get_entity_name(get_irg_ent(current_ir_graph)),
282 get_type_name(get_entity_owner(get_irg_ent(current_ir_graph))));
283 printf("This happens when compiling a Java Interface that's never really used, i.e., "
284 "no class implementing the interface is ever used.\n");
286 exchange(node, new_Bad());
289 entity ** arr = get_entity_link(ent);
293 printf("\nCall site "); DDMN(node);
294 printf(" in "); DDME(get_irg_ent(current_ir_graph));
295 printf(" can call:\n");
296 for (i = 0; i < ARR_LEN(arr); i++) {
297 printf(" - "); DDME(arr[i]);
298 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
303 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
304 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
306 /* Die Sel-Operation kann immer nur einen Wert auf eine
307 * interne Methode zurückgeben. Wir können daher die
308 * Sel-Operation durch eine Const- bzw. SymConst-Operation
310 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
311 /* assert(get_entity_peculiarity(tarval_to_entity(get_Const_tarval(get_atomic_ent_value(arr[0])))) == peculiarity_existent); */
312 new_node = copy_const_value(get_atomic_ent_value(arr[0])); DBG_OPT_POLY;
313 exchange (node, new_node);
321 /** Datenstruktur initialisieren. Zusätzlich werden alle
322 * SymConst-Operationen, die auf interne Methoden verweisen, durch
323 * Const-Operationen ersetzt. */
324 static void sel_methods_init(void) {
326 pmap * ldname_map = pmap_create(); /* Map entitiy names to entities: to replace SymConst by Const(ent). */
327 assert(entities == NULL);
328 entities = eset_create();
329 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
330 entity * ent = get_irg_ent(get_irp_irg(i));
331 /* Nur extern sichtbare Methode können überhaupt mit SymConst
332 * aufgerufen werden. */
333 if (get_entity_visibility(ent) != visibility_local) {
334 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
337 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
338 pmap_destroy(ldname_map);
341 /*****************************************************************************/
343 /* Datenstruktur freigeben. */
344 static void sel_methods_dispose(void) {
347 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
348 entity ** arr = get_entity_link(ent);
352 set_entity_link(ent, NULL);
354 eset_destroy(entities);
359 /* Gibt die Menge aller Methoden zurück, die an diesem Sel-Knoten
360 * zurückgegeben werden können. Die Liste enthält keine doppelten
362 static entity ** get_Sel_arr(ir_node * sel) {
363 static entity ** NULL_ARRAY = NULL;
366 assert(sel && get_irn_op(sel) == op_Sel);
367 ent = get_Sel_entity(sel);
368 assert(is_method_type(get_entity_type(ent))); /* what else? */
369 arr = get_entity_link(ent);
373 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
374 * kann für polymorphe (abstrakte) Methoden passieren. */
376 NULL_ARRAY = NEW_ARR_F(entity *, 0);
383 static int get_Sel_n_methods(ir_node * sel) {
384 return ARR_LEN(get_Sel_arr(sel));
388 static entity * get_Sel_method(ir_node * sel, int pos) {
389 entity ** arr = get_Sel_arr(sel);
390 assert(pos >= 0 && pos < ARR_LEN(arr));
396 /* --- callee analysis ------------------------------------------------------ */
399 static void callee_ana_node(ir_node * node, eset * methods);
402 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
403 assert(get_irn_mode(node) == mode_T);
404 if (get_irn_link(node) == MARK) {
405 /* already visited */
408 set_irn_link(node, MARK);
410 switch (get_irn_opcode(node)) {
412 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
413 * op_Tuple oder ein Knoten, der eine "freie Methode"
415 ir_node * pred = get_Proj_pred(node);
416 if (get_irn_link(pred) != MARK) {
417 if (get_irn_op(pred) == op_Tuple) {
418 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
420 eset_insert(methods, MARK); /* free method -> unknown */
427 callee_ana_node(get_Tuple_pred(node, n), methods);
431 callee_ana_proj(get_Id_pred(node), n, methods);
435 eset_insert(methods, MARK); /* free method -> unknown */
439 set_irn_link(node, NULL);
443 static void callee_ana_node(ir_node * node, eset * methods) {
446 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
447 /* rekursion verhindern */
448 if (get_irn_link(node) == MARK) {
449 /* already visited */
452 set_irn_link(node, MARK);
454 switch (get_irn_opcode(node)) {
456 /* externe Methode (wegen fix_symconst!) */
457 eset_insert(methods, MARK); /* free method -> unknown */
461 /* interne Methode */
462 entity * ent = tarval_to_entity(get_Const_tarval(node));
463 assert(ent && is_method_type(get_entity_type(ent)));
464 if (get_entity_visibility(ent) != visibility_external_allocated) {
465 if (!get_entity_irg(ent)) {
467 assert(get_entity_irg(ent));
469 eset_insert(methods, ent);
471 eset_insert(methods, MARK); /* free method -> unknown */
477 /* polymorphe Methode */
478 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
479 entity * ent = get_Sel_method(node, i);
481 eset_insert(methods, ent);
483 eset_insert(methods, MARK);
492 case iro_Phi: /* Vereinigung */
493 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
494 callee_ana_node(get_Phi_pred(node, i), methods);
499 callee_ana_node(get_Id_pred(node), methods);
503 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
510 eset_insert(methods, MARK); /* free method -> unknown */
514 assert(0 && "invalid opcode or opcode not implemented");
518 set_irn_link(node, NULL);
522 static void callee_walker(ir_node * call, void * env) {
523 if (get_irn_op(call) == op_Call) {
524 eset * methods = eset_create();
526 entity ** arr = NEW_ARR_F(entity *, 0);
527 callee_ana_node(skip_nop(get_Call_ptr(call)), methods);
528 if (eset_contains(methods, MARK)) { /* unknown method */
529 ARR_APP1(entity *, arr, NULL);
531 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
533 ARR_APP1(entity *, arr, ent);
536 if (ARR_LEN(arr) == 0) {
537 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
538 * Sel-Operation war, die keine Methoden zurückgeben
539 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
540 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
542 /* exchange(call, new_Bad()); invalid firm */
544 ir_node *mem = get_Call_mem(call);
545 turn_into_tuple (call, 5 /* pn_Call_max */);
546 set_Tuple_pred(call, pn_Call_M_regular , mem);
547 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
548 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
549 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
550 set_Tuple_pred(call, pn_Call_M_except , mem);
553 set_Call_callee_arr(call, ARR_LEN(arr), arr);
556 eset_destroy(methods);
561 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
562 * und speichert das Ergebnis in der Call-Operation. (siehe
563 * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
564 * muss bereits aufgebaut sein. */
565 static void callee_ana(void) {
567 /* Alle Graphen analysieren. */
568 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
569 irg_walk_graph(get_irp_irg(i), callee_walker, NULL, NULL);
570 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
576 /* --- free method analysis ------------------------------------------------- */
579 static void free_mark(ir_node * node, eset * set);
581 static void free_mark_proj(ir_node * node, long n, eset * set) {
582 assert(get_irn_mode(node) == mode_T);
583 if (get_irn_link(node) == MARK) {
584 /* already visited */
587 set_irn_link(node, MARK);
588 switch (get_irn_opcode(node)) {
590 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
591 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
593 ir_node * pred = get_Proj_pred(node);
594 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
595 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
597 /* nothing: da in "free_ana_walker" behandelt. */
603 free_mark(get_Tuple_pred(node, n), set);
607 free_mark_proj(get_Id_pred(node), n, set);
613 /* nothing: Die Operationen werden in "free_ana_walker" selbst
618 assert(0 && "unexpected opcode or opcode not implemented");
621 set_irn_link(node, NULL);
625 static void free_mark(ir_node * node, eset * set) {
627 assert(mode_is_reference(get_irn_mode(node)));
628 if (get_irn_link(node) == MARK) {
629 return; /* already visited */
631 set_irn_link(node, MARK);
632 switch (get_irn_opcode(node)) {
634 entity * ent = get_Sel_entity(node);
635 if (is_method_type(get_entity_type(ent))) {
636 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
637 eset_insert(set, get_Sel_method(node, i));
643 /* nothing: SymConst points to extern method */
646 tarval * val = get_Const_tarval(node);
647 if (tarval_is_entity(val)) { /* filter null pointer */
648 entity * ent = tarval_to_entity(val);
649 if (is_method_type(get_entity_type(ent))) {
650 eset_insert(set, ent);
656 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
657 free_mark(get_Phi_pred(node, i), set);
661 free_mark(get_Id_pred(node), set);
664 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
667 /* nothing: Wird unten behandelt! */
670 set_irn_link(node, NULL);
674 static void free_ana_walker(ir_node * node, eset * set) {
676 if (get_irn_link(node) == MARK) {
677 /* bereits in einem Zyklus besucht. */
680 switch (get_irn_opcode(node)) {
691 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
694 set_irn_link(node, MARK);
695 for (i = get_Call_arity(node) - 1; i >= 0; --i) {
696 ir_node * pred = get_Call_param(node, i);
697 if (mode_is_reference(get_irn_mode(pred))) {
698 free_mark(pred, set);
702 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
703 * jemand das Gegenteil implementiert. */
705 set_irn_link(node, MARK);
706 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
707 ir_node * pred = get_irn_n(node, i);
708 if (mode_is_reference(get_irn_mode(pred))) {
709 free_mark(pred, set);
714 set_irn_link(node, NULL);
718 /* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
719 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
720 * SymConst-Operationen müssen in passende Const-Operationen
721 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
722 * auf eine echt externe Methode. */
723 static entity ** get_free_methods(void) {
724 eset * set = eset_create();
726 entity ** arr = NEW_ARR_F(entity *, 0);
729 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
730 ir_graph * irg = get_irp_irg(i);
731 entity * ent = get_irg_ent(irg);
732 /* insert "external visible" methods. */
733 if (get_entity_visibility(ent) != visibility_local) {
734 eset_insert(set, ent);
736 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
737 z.B. da die Adresse einer Methode abgespeichert wird. */
738 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
740 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
742 if (get_irp_main_irg()) {
743 eset_insert(set, get_irg_ent(get_irp_main_irg()));
745 /* Wandle Menge in Feld um. Effizienter. */
746 for (ent = eset_first(set); ent; ent = eset_next(set)) {
747 ARR_APP1(entity *, arr, ent);
754 void cgana(int *length, entity ***free_methods) {
755 entity ** free_meths;
759 free_meths = get_free_methods();
761 sel_methods_dispose();
763 /* Convert the flexible array to an array that can be handled
765 *length = ARR_LEN(free_meths);
766 *free_methods = (entity **)malloc(sizeof(entity *) * (*length));
767 for (i = 0; i < (*length); i++) (*free_methods)[i] = free_meths[i];
768 DEL_ARR_F(free_meths);
773 static void destruct_walker(ir_node * node, void * env) {
774 if (get_irn_op(node) == op_Call) {
775 remove_Call_callee_arr(node);
779 void free_callee_info(ir_graph *irg) {
780 irg_walk_graph(irg, destruct_walker, NULL, NULL);
781 set_irg_callee_info_state(irg, irg_callee_info_none);
785 /* Optimize the address expressions passed to call nodes.
787 * This optimization performs the following transformations for
789 * - All SymConst operations that refer to intern methods are replaced
790 * by Const operations refering to the corresponding entity.
791 * - Sel nodes, that select entities that are not overwritten are
792 * replaced by Const nodes refering to the selected entity.
793 * - Sel nodes, for witch no method exists at all are replaced by Bad
795 * - Sel nodes with a pointer input that is an Alloc node are replaced
796 * by Const nodes refering to the entity that implements the method in
797 * the type given by the Alloc node.
799 void opt_call_addrs(void) {
801 sel_methods_dispose();
804 pmap * ldname_map = pmap_create();
805 assert(entities == NULL);
806 entities = eset_create();
807 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
808 entity * ent = get_irg_ent(get_irp_irg(i));
809 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
810 * aufgerufen werden. */
811 if (get_entity_visibility(ent) != local) {
812 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
815 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
816 pmap_destroy(ldname_map);