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"
40 /* Eindeutige Adresse zur Markierung von besuchten Knoten und zur
41 * Darstellung der unbekannten Methode. */
42 static void * MARK = &MARK;
46 /* --- sel methods ---------------------------------------------------------- */
49 static eset * entities = NULL;
52 /** Bestimmt die eindeutige Methode, die die Methode für den
53 * übergebenen (dynamischen) Typ überschreibt. */
54 static entity * get_implementation(type * class, entity * method) {
56 if (get_entity_peculiarity(method) != peculiarity_description &&
57 get_entity_owner(method) == class) {
60 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i) {
61 entity * e = get_entity_overwrittenby(method, i);
62 if (get_entity_peculiarity(e) != peculiarity_description && get_entity_owner(e) == class) {
66 for (i = get_class_n_supertypes(class) - 1; i >= 0; --i) {
67 entity * e = get_implementation(get_class_supertype(class, i), method);
72 assert(0 && "implementation not found");
76 /** Returns the entity that contains the implementation of the inherited
77 entity if available, else returns the entity passed. */
78 static entity *get_inherited_methods_implementation(entity *inh_meth) {
79 entity *impl_meth = NULL;
80 ir_node *addr = get_atomic_ent_value(inh_meth);
81 assert(addr && "constant entity without value");
83 if (get_irn_op(addr) == op_Const) {
84 impl_meth = tarval_to_entity(get_Const_tarval(addr));
86 assert(0 && "Complex constant values not supported -- address of method should be straight constant!");
88 if (impl_meth && (get_entity_peculiarity(impl_meth) != peculiarity_existent)) {
90 printf("this_meth: "); DDMEO(inh_meth);
91 printf("impl meth: "); DDMEO(impl_meth);
92 assert(!impl_meth || get_entity_peculiarity(impl_meth) == peculiarity_existent);
96 return impl_meth? impl_meth : inh_meth;
100 /** Collect the entity representing the implementation of this
101 * entity (not the same if inherited) and all entities for overwriting
102 * implementations in "set".
103 * If the implementation of the method is not included in the
104 * compilation unit "open" is set to true.
105 * A recursive descend in the overwritten relation.
106 * Cycle-free, therefore must terminate.
109 * @param set A set of entities.
110 * @param size Number of entities in set.
113 static void collect_impls(entity *method, eset *set, int *size, bool *open) {
116 if (get_entity_peculiarity(method) == peculiarity_existent) {
117 if (get_entity_visibility(method) == visibility_external_allocated) {
118 assert(get_entity_irg(method) == NULL);
121 assert(get_entity_irg(method) != NULL);
122 if (!eset_contains(set, method)) {
123 eset_insert(set, method);
129 if (get_entity_peculiarity(method) == peculiarity_inherited) {
130 entity *impl_ent = get_inherited_methods_implementation(method);
131 assert(impl_ent && "no implementation for inherited entity");
132 if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
133 assert(get_entity_irg(impl_ent) == NULL);
136 assert(get_entity_irg(impl_ent) != NULL);
137 if (!eset_contains(set, impl_ent)) {
138 eset_insert(set, impl_ent);
143 /** recursive descend **/
144 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
145 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
149 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
150 * (und implementieren). In der zurückgegebenen Reihung kommt jede
151 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
152 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
153 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
154 * keine Methoden, die "method" überschreiben, so gibt die Methode
159 static entity ** get_impl_methods(entity * method) {
160 eset * set = eset_create();
165 /* Collect all method entities that can be called here */
166 collect_impls(method, set, &size, &open);
168 /* Vorgaenger einfuegen. */
169 if (size == 0 && !open) {
170 /* keine implementierte überschriebene Methode */
174 arr = NEW_ARR_F(entity *, size + 1);
175 arr[0] = NULL; /* Represents open method */
176 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
180 arr = NEW_ARR_F(entity *, size);
181 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
189 /* debug makros used in sel_methods_walker */
190 #define SIZ(x) sizeof(x)/sizeof((x)[0])
192 #define DBG_OPT_NORMALIZE \
193 __dbg_info_merge_pair(new_node, node, dbg_const_eval)
194 #define DBG_OPT_POLY_ALLOC \
198 ons[1] = skip_Proj(get_Sel_ptr(node)); \
199 __dbg_info_merge_sets(&new_node, 1, ons, SIZ(ons), dbg_rem_poly_call); \
201 #define DBG_OPT_POLY \
202 __dbg_info_merge_pair(new_node, node, dbg_rem_poly_call)
206 /** Analyse address computations.
208 * - If the node is a SymConst replace it by Const(ent) if possible.
209 * - If the node is a Sel:
210 * * If the pointer to the Sel comes directly from an Alloc node
211 * replace the Sel by a Const(ent).
214 * @param node The node to analyze
215 * @param ldname_map A map that mapps names of entities to the entities.
217 static void sel_methods_walker(ir_node * node, pmap * ldname_map) {
219 if (get_irn_op(node) == op_SymConst) {
220 /* Wenn möglich SymConst-Operation durch Const-Operation
222 if (get_SymConst_kind(node) == linkage_ptr_info) {
223 pmap_entry *entry = pmap_find(ldname_map, (void *) get_SymConst_ptrinfo(node));
224 if (entry != NULL) { /* Method is declared in the compiled code */
225 entity *ent = entry->value;
226 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) {
227 /* Meth. is defined */
229 assert(get_entity_irg(ent));
230 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
231 new_node = new_d_Const(get_irn_dbg_info(node),
232 mode_P_mach, new_tarval_from_entity(ent, mode_P_mach)); DBG_OPT_NORMALIZE;
233 exchange(node, new_node);
237 } else if (get_irn_op(node) == op_Sel &&
238 is_method_type(get_entity_type(get_Sel_entity(node)))) {
239 entity * ent = get_Sel_entity(node);
240 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
241 (get_irn_op(skip_Proj(get_Sel_ptr(node))) == op_Alloc)) {
244 /* We know which method will be called, no dispatch necessary. */
246 assert(get_entity_peculiarity(ent) != peculiarity_description);
247 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
248 /* @@@ Is this correct?? Alloc could reference a subtype of the owner
249 of Sel that overwrites the method referenced in Sel. */
250 /* @@@ Yes, this is wrong. GL, 10.3.04 */
251 new_node = copy_const_value(get_atomic_ent_value(ent)); DBG_OPT_POLY_ALLOC;
253 called_ent = resolve_ent_polymorphy(get_Alloc_type(skip_Proj(get_Sel_ptr(node))), ent);
254 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
255 /* called_ent may not be description: has no Address/Const to Call! */
256 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
257 new_node = copy_const_value(get_atomic_ent_value(called_ent)); DBG_OPT_POLY_ALLOC;
259 exchange (node, new_node);
261 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
262 if (!eset_contains(entities, ent)) {
263 /* Entity noch nicht behandelt. Alle (intern oder extern)
264 * implementierten Methoden suchen, die diese Entity
265 * überschreiben. Die Menge an entity.link speichern. */
266 set_entity_link(ent, get_impl_methods(ent));
267 eset_insert(entities, ent);
269 if (get_entity_link(ent) == NULL) {
270 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
271 * Methode zurückgeben. Damit ist sie insbesondere nicht
272 * ausführbar und nicht erreichbar. */
273 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
274 fuer die es keine Implementierung gibt. */
275 if (get_entity_peculiarity(ent) == peculiarity_description) {
276 /* @@@ GL Methode um Fehler anzuzeigen aufrufen! */
277 printf("WARNING: Calling method description %s\n in method %s\n of class %s\n which has "
278 "no implementation!\n", get_entity_name(ent),
279 get_entity_name(get_irg_ent(current_ir_graph)),
280 get_type_name(get_entity_owner(get_irg_ent(current_ir_graph))));
281 printf("This happens when compiling a Java Interface that's never really used, i.e., "
282 "no class implementing the interface is ever used.\n");
284 exchange(node, new_Bad());
287 entity ** arr = get_entity_link(ent);
291 printf("\nCall site "); DDMN(node);
292 printf(" in "); DDME(get_irg_ent(current_ir_graph));
293 printf(" can call:\n");
294 for (i = 0; i < ARR_LEN(arr); i++) {
295 printf(" - "); DDME(arr[i]);
296 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
301 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
302 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
304 /* Die Sel-Operation kann immer nur einen Wert auf eine
305 * interne Methode zurückgeben. Wir können daher die
306 * Sel-Operation durch eine Const- bzw. SymConst-Operation
308 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
309 /* assert(get_entity_peculiarity(tarval_to_entity(get_Const_tarval(get_atomic_ent_value(arr[0])))) == peculiarity_existent); */
310 new_node = copy_const_value(get_atomic_ent_value(arr[0])); DBG_OPT_POLY;
311 exchange (node, new_node);
319 /** Datenstruktur initialisieren. Zusätzlich werden alle
320 * SymConst-Operationen, die auf interne Methoden verweisen, durch
321 * Const-Operationen ersetzt. */
322 static void sel_methods_init(void) {
324 pmap * ldname_map = pmap_create(); /* Map entitiy names to entities: to replace SymConst by Const(ent). */
325 assert(entities == NULL);
326 entities = eset_create();
327 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
328 entity * ent = get_irg_ent(get_irp_irg(i));
329 /* Nur extern sichtbare Methode können überhaupt mit SymConst
330 * aufgerufen werden. */
331 if (get_entity_visibility(ent) != visibility_local) {
332 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
335 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
336 pmap_destroy(ldname_map);
339 /*****************************************************************************/
341 /* Datenstruktur freigeben. */
342 static void sel_methods_dispose(void) {
345 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
346 entity ** arr = get_entity_link(ent);
350 set_entity_link(ent, NULL);
352 eset_destroy(entities);
357 /* Gibt die Menge aller Methoden zurück, die an diesem Sel-Knoten
358 * zurückgegeben werden können. Die Liste enthält keine doppelten
360 static entity ** get_Sel_arr(ir_node * sel) {
361 static entity ** NULL_ARRAY = NULL;
364 assert(sel && get_irn_op(sel) == op_Sel);
365 ent = get_Sel_entity(sel);
366 assert(is_method_type(get_entity_type(ent))); /* what else? */
367 arr = get_entity_link(ent);
371 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
372 * kann für polymorphe (abstrakte) Methoden passieren. */
374 NULL_ARRAY = NEW_ARR_F(entity *, 0);
381 static int get_Sel_n_methods(ir_node * sel) {
382 return ARR_LEN(get_Sel_arr(sel));
386 static entity * get_Sel_method(ir_node * sel, int pos) {
387 entity ** arr = get_Sel_arr(sel);
388 assert(pos >= 0 && pos < ARR_LEN(arr));
394 /* --- callee analysis ------------------------------------------------------ */
397 static void callee_ana_node(ir_node * node, eset * methods);
400 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
401 assert(get_irn_mode(node) == mode_T);
402 if (get_irn_link(node) == MARK) {
403 /* already visited */
406 set_irn_link(node, MARK);
408 switch (get_irn_opcode(node)) {
410 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
411 * op_Tuple oder ein Knoten, der eine "freie Methode"
413 ir_node * pred = get_Proj_pred(node);
414 if (get_irn_link(pred) != MARK) {
415 if (get_irn_op(pred) == op_Tuple) {
416 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
418 eset_insert(methods, MARK); /* free method -> unknown */
425 callee_ana_node(get_Tuple_pred(node, n), methods);
429 callee_ana_proj(get_Id_pred(node), n, methods);
433 eset_insert(methods, MARK); /* free method -> unknown */
437 set_irn_link(node, NULL);
441 static void callee_ana_node(ir_node * node, eset * methods) {
444 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
445 /* rekursion verhindern */
446 if (get_irn_link(node) == MARK) {
447 /* already visited */
450 set_irn_link(node, MARK);
452 switch (get_irn_opcode(node)) {
454 /* externe Methode (wegen fix_symconst!) */
455 eset_insert(methods, MARK); /* free method -> unknown */
459 /* interne Methode */
460 entity * ent = tarval_to_entity(get_Const_tarval(node));
461 assert(ent && is_method_type(get_entity_type(ent)));
462 if (get_entity_visibility(ent) != visibility_external_allocated) {
463 assert(get_entity_irg(ent));
464 eset_insert(methods, ent);
466 eset_insert(methods, MARK); /* free method -> unknown */
472 /* polymorphe Methode */
473 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
474 entity * ent = get_Sel_method(node, i);
476 eset_insert(methods, ent);
478 eset_insert(methods, MARK);
487 case iro_Phi: /* Vereinigung */
488 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
489 callee_ana_node(get_Phi_pred(node, i), methods);
494 callee_ana_node(get_Id_pred(node), methods);
498 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
505 eset_insert(methods, MARK); /* free method -> unknown */
509 assert(0 && "invalid opcode or opcode not implemented");
513 set_irn_link(node, NULL);
517 static void callee_walker(ir_node * call, void * env) {
518 if (get_irn_op(call) == op_Call) {
519 eset * methods = eset_create();
521 entity ** arr = NEW_ARR_F(entity *, 0);
522 callee_ana_node(skip_nop(get_Call_ptr(call)), methods);
523 if (eset_contains(methods, MARK)) { /* unknown method */
524 ARR_APP1(entity *, arr, NULL);
526 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
528 ARR_APP1(entity *, arr, ent);
531 if (ARR_LEN(arr) == 0) {
532 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
533 * Sel-Operation war, die keine Methoden zurückgeben
534 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
535 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
537 /* exchange(call, new_Bad()); invalid firm */
539 ir_node *mem = get_Call_mem(call);
540 turn_into_tuple (call, 5 /* pn_Call_max */);
541 set_Tuple_pred(call, pn_Call_M_regular , mem);
542 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
543 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
544 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
545 set_Tuple_pred(call, pn_Call_M_except , mem);
548 set_Call_callee_arr(call, ARR_LEN(arr), arr);
551 eset_destroy(methods);
556 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
557 * und speichert das Ergebnis in der Call-Operation. (siehe
558 * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
559 * muss bereits aufgebaut sein. */
560 static void callee_ana(void) {
562 /* Alle Graphen analysieren. */
563 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
564 irg_walk_graph(get_irp_irg(i), callee_walker, NULL, NULL);
565 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
571 /* --- free method analysis ------------------------------------------------- */
574 static void free_mark(ir_node * node, eset * set);
576 static void free_mark_proj(ir_node * node, long n, eset * set) {
577 assert(get_irn_mode(node) == mode_T);
578 if (get_irn_link(node) == MARK) {
579 /* already visited */
582 set_irn_link(node, MARK);
583 switch (get_irn_opcode(node)) {
585 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
586 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
588 ir_node * pred = get_Proj_pred(node);
589 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
590 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
592 /* nothing: da in "free_ana_walker" behandelt. */
598 free_mark(get_Tuple_pred(node, n), set);
602 free_mark_proj(get_Id_pred(node), n, set);
608 /* nothing: Die Operationen werden in "free_ana_walker" selbst
613 assert(0 && "unexpected opcode or opcode not implemented");
616 set_irn_link(node, NULL);
620 static void free_mark(ir_node * node, eset * set) {
622 assert(mode_is_reference(get_irn_mode(node)));
623 if (get_irn_link(node) == MARK) {
624 return; /* already visited */
626 set_irn_link(node, MARK);
627 switch (get_irn_opcode(node)) {
629 entity * ent = get_Sel_entity(node);
630 if (is_method_type(get_entity_type(ent))) {
631 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
632 eset_insert(set, get_Sel_method(node, i));
638 /* nothing: SymConst points to extern method */
641 tarval * val = get_Const_tarval(node);
642 if (tarval_is_entity(val)) { /* filter null pointer */
643 entity * ent = tarval_to_entity(val);
644 if (is_method_type(get_entity_type(ent))) {
645 eset_insert(set, ent);
651 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
652 free_mark(get_Phi_pred(node, i), set);
656 free_mark(get_Id_pred(node), set);
659 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
662 /* nothing: Wird unten behandelt! */
665 set_irn_link(node, NULL);
669 static void free_ana_walker(ir_node * node, eset * set) {
671 if (get_irn_link(node) == MARK) {
672 /* bereits in einem Zyklus besucht. */
675 switch (get_irn_opcode(node)) {
686 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
689 set_irn_link(node, MARK);
690 for (i = get_Call_arity(node) - 1; i >= 0; --i) {
691 ir_node * pred = get_Call_param(node, i);
692 if (mode_is_reference(get_irn_mode(pred))) {
693 free_mark(pred, set);
697 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
698 * jemand das Gegenteil implementiert. */
700 set_irn_link(node, MARK);
701 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
702 ir_node * pred = get_irn_n(node, i);
703 if (mode_is_reference(get_irn_mode(pred))) {
704 free_mark(pred, set);
709 set_irn_link(node, NULL);
713 /* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
714 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
715 * SymConst-Operationen müssen in passende Const-Operationen
716 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
717 * auf eine echt externe Methode. */
718 static entity ** get_free_methods(void) {
719 eset * set = eset_create();
721 entity ** arr = NEW_ARR_F(entity *, 0);
724 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
725 ir_graph * irg = get_irp_irg(i);
726 entity * ent = get_irg_ent(irg);
727 /* insert "external visible" methods. */
728 if (get_entity_visibility(ent) != visibility_local) {
729 eset_insert(set, ent);
731 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
732 z.B. da die Adresse einer Methode abgespeichert wird. */
733 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
735 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
737 if (get_irp_main_irg()) {
738 eset_insert(set, get_irg_ent(get_irp_main_irg()));
740 /* Wandle Menge in Feld um. Effizienter. */
741 for (ent = eset_first(set); ent; ent = eset_next(set)) {
742 ARR_APP1(entity *, arr, ent);
749 void cgana(int *length, entity ***free_methods) {
750 entity ** free_meths;
754 free_meths = get_free_methods();
756 sel_methods_dispose();
758 /* Convert the flexible array to an array that can be handled
760 *length = ARR_LEN(free_meths);
761 *free_methods = (entity **)malloc(sizeof(entity *) * (*length));
762 for (i = 0; i < (*length); i++) (*free_methods)[i] = free_meths[i];
763 DEL_ARR_F(free_meths);
766 /* Optimize the address expressions passed to call nodes.
767 * Alle SymConst-Operationen, die auf interne Methoden verweisen,
768 * werden durch Const-Operationen ersetzt.
769 * Sel Knoten deren entitaeten nicht ueberschrieben werden, werden
770 * durch Const ersetzt.
771 * Sel Knoten, fuer die keine Implementierung existiert, werden
772 * durch Bad ersetzt. */
773 void opt_call_addrs(void) {
775 sel_methods_dispose();
778 pmap * ldname_map = pmap_create();
779 assert(entities == NULL);
780 entities = eset_create();
781 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
782 entity * ent = get_irg_ent(get_irp_irg(i));
783 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
784 * aufgerufen werden. */
785 if (get_entity_visibility(ent) != local) {
786 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
789 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
790 pmap_destroy(ldname_map);