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 * übergebenene (dynamischen) Typ überschreibt. */
54 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 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) {
115 if (get_entity_peculiarity(method) == peculiarity_existent) {
116 if (get_entity_visibility(method) == visibility_external_allocated) {
117 assert(get_entity_irg(method) == NULL);
120 assert(get_entity_irg(method) != NULL);
121 if (!eset_contains(set, method)) {
122 eset_insert(set, method);
127 if (get_entity_peculiarity(method) == peculiarity_inherited) {
128 entity *impl_ent = get_inherited_methods_implementation(method);
129 assert(impl_ent && "no implementation for inherited entity");
130 if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
131 assert(get_entity_irg(impl_ent) == NULL);
134 assert(get_entity_irg(impl_ent) != NULL);
135 if (!eset_contains(set, impl_ent)) {
136 eset_insert(set, impl_ent);
141 /** recursive descend **/
142 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
143 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
147 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
148 * (und implementieren). In der zurückgegebenen Reihung kommt jede
149 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
150 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
151 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
152 * keine Methoden, die "method" überschreiben, so gibt die Methode
157 static entity ** get_impl_methods(entity * method) {
158 eset * set = eset_create();
163 /* Collect all method entities that can be called here */
164 collect_impls(method, set, &size, &open);
166 /* Vorgaenger einfuegen. */
167 if (size == 0 && !open) {
168 /* keine implementierte überschriebene Methode */
172 arr = NEW_ARR_F(entity *, size + 1);
173 arr[0] = NULL; /* Represents open method */
174 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
178 arr = NEW_ARR_F(entity *, size);
179 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
187 /* debug makros used in sel_methods_walker */
188 #define SIZ(x) sizeof(x)/sizeof((x)[0])
190 #define DBG_OPT_NORMALIZE \
191 __dbg_info_merge_pair(new_node, node, dbg_const_eval)
192 #define DBG_OPT_POLY_ALLOC \
196 ons[1] = skip_Proj(get_Sel_ptr(node)); \
197 __dbg_info_merge_sets(&new_node, 1, ons, SIZ(ons), dbg_rem_poly_call); \
199 #define DBG_OPT_POLY \
200 __dbg_info_merge_pair(new_node, node, dbg_rem_poly_call)
203 static void sel_methods_walker(ir_node * node, pmap * ldname_map) {
204 if (get_irn_op(node) == op_SymConst) {
205 /* Wenn möglich SymConst-Operation durch Const-Operation
207 if (get_SymConst_kind(node) == linkage_ptr_info) {
208 pmap_entry * entry = pmap_find(ldname_map, (void *) get_SymConst_ptrinfo(node));
209 if (entry != NULL) { /* Method is declared in the compiled code */
210 entity * ent = entry->value;
211 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) { /* Meth. is defined */
213 assert(get_entity_irg(ent));
214 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
215 new_node = new_d_Const(get_irn_dbg_info(node),
216 mode_P_mach, new_tarval_from_entity(ent, mode_P_mach)); DBG_OPT_NORMALIZE;
217 exchange(node, new_node);
221 } else if (get_irn_op(node) == op_Sel &&
222 is_method_type(get_entity_type(get_Sel_entity(node)))) {
223 entity * ent = get_Sel_entity(node);
224 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
225 (get_irn_op(skip_Proj(get_Sel_ptr(node))) == op_Alloc)) {
228 /* We know which method will be called, no dispatch necessary. */
230 assert(get_entity_peculiarity(ent) != peculiarity_description);
231 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
232 /* @@@ Is this correct?? Alloc could reference a subtype of the owner
233 of Sel that overwrites the method referenced in Sel. */
234 /* @@@ Yes, this is wrong. GL, 10.3.04 */
235 new_node = copy_const_value(get_atomic_ent_value(ent)); DBG_OPT_POLY_ALLOC;
237 called_ent = resolve_ent_polymorphy(get_Alloc_type(skip_Proj(get_Sel_ptr(node))), ent);
238 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
239 /* called_ent may not be description: has no Address/Const to Call! */
240 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
241 new_node = copy_const_value(get_atomic_ent_value(called_ent)); DBG_OPT_POLY_ALLOC;
243 exchange (node, new_node);
245 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
246 if (!eset_contains(entities, ent)) {
247 /* Entity noch nicht behandelt. Alle (intern oder extern)
248 * implementierten Methoden suchen, die diese Entity
249 * überschreiben. Die Menge an entity.link speichern. */
250 set_entity_link(ent, get_impl_methods(ent));
251 eset_insert(entities, ent);
253 if (get_entity_link(ent) == NULL) {
254 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
255 * Methode zurückgeben. Damit ist sie insbesondere nicht
256 * ausführbar und nicht erreichbar. */
257 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
258 fuer die es keine Implementierung gibt. */
259 if (get_entity_peculiarity(ent) == peculiarity_description) {
260 /* @@@ GL Methode um Fehler anzuzeigen aufrufen! */
261 printf("WARNING: Calling method description %s\n in method %s\n of class %s\n which has "
262 "no implementation!\n", get_entity_name(ent),
263 get_entity_name(get_irg_ent(current_ir_graph)),
264 get_type_name(get_entity_owner(get_irg_ent(current_ir_graph))));
265 printf("This happens when compiling a Java Interface that's never really used, i.e., "
266 "no class implementing the interface is ever used.\n");
268 exchange(node, new_Bad());
271 entity ** arr = get_entity_link(ent);
275 printf("\nCall site "); DDMN(node);
276 printf(" in "); DDME(get_irg_ent(current_ir_graph));
277 printf(" can call:\n");
278 for (i = 0; i < ARR_LEN(arr); i++) {
279 printf(" - "); DDME(arr[i]);
280 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
285 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
286 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
288 /* Die Sel-Operation kann immer nur einen Wert auf eine
289 * interne Methode zurückgeben. Wir können daher die
290 * Sel-Operation durch eine Const- bzw. SymConst-Operation
292 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
293 /* assert(get_entity_peculiarity(tarval_to_entity(get_Const_tarval(get_atomic_ent_value(arr[0])))) == peculiarity_existent); */
294 new_node = copy_const_value(get_atomic_ent_value(arr[0])); DBG_OPT_POLY;
295 exchange (node, new_node);
303 /* Datenstruktur initialisieren. Zusätzlich werden alle
304 * SymConst-Operationen, die auf interne Methoden verweisen, durch
305 * Const-Operationen ersetzt. */
306 static void sel_methods_init(void) {
308 pmap * ldname_map = pmap_create();
309 assert(entities == NULL);
310 entities = eset_create();
311 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
312 entity * ent = get_irg_ent(get_irp_irg(i));
313 /* Nur extern sichtbare Methode können überhaupt mit SymConst
314 * aufgerufen werden. */
315 if (get_entity_visibility(ent) != visibility_local) {
316 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
319 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
320 pmap_destroy(ldname_map);
323 /*****************************************************************************/
325 /* Datenstruktur freigeben. */
326 static void sel_methods_dispose(void) {
329 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
330 entity ** arr = get_entity_link(ent);
334 set_entity_link(ent, NULL);
336 eset_destroy(entities);
341 /* Gibt die Menge aller Methoden zurück, die an diesem Sel-Knoten
342 * zurückgegeben werden können. Die Liste enthält keine doppelten
344 static entity ** get_Sel_arr(ir_node * sel) {
345 static entity ** NULL_ARRAY = NULL;
348 assert(sel && get_irn_op(sel) == op_Sel);
349 ent = get_Sel_entity(sel);
350 assert(is_method_type(get_entity_type(ent))); /* what else? */
351 arr = get_entity_link(ent);
355 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
356 * kann für polymorphe (abstrakte) Methoden passieren. */
358 NULL_ARRAY = NEW_ARR_F(entity *, 0);
365 static int get_Sel_n_methods(ir_node * sel) {
366 return ARR_LEN(get_Sel_arr(sel));
370 static entity * get_Sel_method(ir_node * sel, int pos) {
371 entity ** arr = get_Sel_arr(sel);
372 assert(pos >= 0 && pos < ARR_LEN(arr));
378 /* --- callee analysis ------------------------------------------------------ */
381 static void callee_ana_node(ir_node * node, eset * methods);
384 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
385 assert(get_irn_mode(node) == mode_T);
386 if (get_irn_link(node) == MARK) {
387 /* already visited */
390 set_irn_link(node, MARK);
392 switch (get_irn_opcode(node)) {
394 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
395 * op_Tuple oder ein Knoten, der eine "freie Methode"
397 ir_node * pred = get_Proj_pred(node);
398 if (get_irn_link(pred) != MARK) {
399 if (get_irn_op(pred) == op_Tuple) {
400 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
402 eset_insert(methods, MARK); /* free method -> unknown */
409 callee_ana_node(get_Tuple_pred(node, n), methods);
413 callee_ana_proj(get_Id_pred(node), n, methods);
417 eset_insert(methods, MARK); /* free method -> unknown */
421 set_irn_link(node, NULL);
425 static void callee_ana_node(ir_node * node, eset * methods) {
428 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
429 /* rekursion verhindern */
430 if (get_irn_link(node) == MARK) {
431 /* already visited */
434 set_irn_link(node, MARK);
436 switch (get_irn_opcode(node)) {
438 /* externe Methode (wegen fix_symconst!) */
439 eset_insert(methods, MARK); /* free method -> unknown */
443 /* interne Methode */
444 entity * ent = tarval_to_entity(get_Const_tarval(node));
445 assert(ent && is_method_type(get_entity_type(ent)));
446 if (get_entity_visibility(ent) != visibility_external_allocated) {
447 assert(get_entity_irg(ent));
448 eset_insert(methods, ent);
450 eset_insert(methods, MARK); /* free method -> unknown */
456 /* polymorphe Methode */
457 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
458 entity * ent = get_Sel_method(node, i);
460 eset_insert(methods, ent);
462 eset_insert(methods, MARK);
471 case iro_Phi: /* Vereinigung */
472 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
473 callee_ana_node(get_Phi_pred(node, i), methods);
478 callee_ana_node(get_Id_pred(node), methods);
482 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
489 eset_insert(methods, MARK); /* free method -> unknown */
493 assert(0 && "invalid opcode or opcode not implemented");
497 set_irn_link(node, NULL);
501 static void callee_walker(ir_node * call, void * env) {
502 if (get_irn_op(call) == op_Call) {
503 eset * methods = eset_create();
505 entity ** arr = NEW_ARR_F(entity *, 0);
506 callee_ana_node(skip_nop(get_Call_ptr(call)), methods);
507 if (eset_contains(methods, MARK)) { /* unknown method */
508 ARR_APP1(entity *, arr, NULL);
510 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
512 ARR_APP1(entity *, arr, ent);
515 if (ARR_LEN(arr) == 0) {
516 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
517 * Sel-Operation war, die keine Methoden zurückgeben
518 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
519 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
521 /* exchange(call, new_Bad()); invalid firm */
523 ir_node *mem = get_Call_mem(call);
524 turn_into_tuple (call, 5 /* pn_Call_max */);
525 set_Tuple_pred(call, pn_Call_M_regular , mem);
526 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
527 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
528 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
529 set_Tuple_pred(call, pn_Call_M_except , mem);
532 set_Call_callee_arr(call, ARR_LEN(arr), arr);
535 eset_destroy(methods);
540 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
541 * und speichert das Ergebnis in der Call-Operation. (siehe
542 * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
543 * muss bereits aufgebaut sein. */
544 static void callee_ana(void) {
546 /* Alle Graphen analysieren. */
547 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
548 irg_walk_graph(get_irp_irg(i), callee_walker, NULL, NULL);
549 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
555 /* --- free method analysis ------------------------------------------------- */
558 static void free_mark(ir_node * node, eset * set);
560 static void free_mark_proj(ir_node * node, long n, eset * set) {
561 assert(get_irn_mode(node) == mode_T);
562 if (get_irn_link(node) == MARK) {
563 /* already visited */
566 set_irn_link(node, MARK);
567 switch (get_irn_opcode(node)) {
569 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
570 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
572 ir_node * pred = get_Proj_pred(node);
573 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
574 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
576 /* nothing: da in "free_ana_walker" behandelt. */
582 free_mark(get_Tuple_pred(node, n), set);
586 free_mark_proj(get_Id_pred(node), n, set);
592 /* nothing: Die Operationen werden in "free_ana_walker" selbst
597 assert(0 && "unexpected opcode or opcode not implemented");
600 set_irn_link(node, NULL);
604 static void free_mark(ir_node * node, eset * set) {
606 assert(mode_is_reference(get_irn_mode(node)));
607 if (get_irn_link(node) == MARK) {
608 return; /* already visited */
610 set_irn_link(node, MARK);
611 switch (get_irn_opcode(node)) {
613 entity * ent = get_Sel_entity(node);
614 if (is_method_type(get_entity_type(ent))) {
615 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
616 eset_insert(set, get_Sel_method(node, i));
622 /* nothing: SymConst points to extern method */
625 tarval * val = get_Const_tarval(node);
626 if (tarval_is_entity(val)) { /* filter null pointer */
627 entity * ent = tarval_to_entity(val);
628 if (is_method_type(get_entity_type(ent))) {
629 eset_insert(set, ent);
635 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
636 free_mark(get_Phi_pred(node, i), set);
640 free_mark(get_Id_pred(node), set);
643 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
646 /* nothing: Wird unten behandelt! */
649 set_irn_link(node, NULL);
653 static void free_ana_walker(ir_node * node, eset * set) {
655 if (get_irn_link(node) == MARK) {
656 /* bereits in einem Zyklus besucht. */
659 switch (get_irn_opcode(node)) {
670 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
673 set_irn_link(node, MARK);
674 for (i = get_Call_arity(node) - 1; i >= 0; --i) {
675 ir_node * pred = get_Call_param(node, i);
676 if (mode_is_reference(get_irn_mode(pred))) {
677 free_mark(pred, set);
681 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
682 * jemand das Gegenteil implementiert. */
684 set_irn_link(node, MARK);
685 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
686 ir_node * pred = get_irn_n(node, i);
687 if (mode_is_reference(get_irn_mode(pred))) {
688 free_mark(pred, set);
693 set_irn_link(node, NULL);
697 /* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
698 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
699 * SymConst-Operationen müssen in passende Const-Operationen
700 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
701 * auf eine echt externe Methode. */
702 static entity ** get_free_methods(void) {
703 eset * set = eset_create();
705 entity ** arr = NEW_ARR_F(entity *, 0);
708 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
709 ir_graph * irg = get_irp_irg(i);
710 entity * ent = get_irg_ent(irg);
711 /* insert "external visible" methods. */
712 if (get_entity_visibility(ent) != visibility_local) {
713 eset_insert(set, ent);
715 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
716 z.B. da die Adresse einer Methode abgespeichert wird. */
717 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
719 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
721 if (get_irp_main_irg()) {
722 eset_insert(set, get_irg_ent(get_irp_main_irg()));
724 /* Wandle Menge in Feld um. Effizienter. */
725 for (ent = eset_first(set); ent; ent = eset_next(set)) {
726 ARR_APP1(entity *, arr, ent);
733 void cgana(int *length, entity ***free_methods) {
734 entity ** free_meths;
738 free_meths = get_free_methods();
740 sel_methods_dispose();
742 /* Convert the flexible array to an array that can be handled
744 *length = ARR_LEN(free_meths);
745 *free_methods = (entity **)malloc(sizeof(entity *) * (*length));
746 for (i = 0; i < (*length); i++) (*free_methods)[i] = free_meths[i];
747 DEL_ARR_F(free_meths);
750 /* Optimize the address expressions passed to call nodes.
751 * Alle SymConst-Operationen, die auf interne Methoden verweisen,
752 * werden durch Const-Operationen ersetzt.
753 * Sel Knoten deren entitaeten nicht ueberschrieben werden, werden
754 * durch Const ersetzt.
755 * Sel Knoten, fuer die keine Implementierung existiert, werden
756 * durch Bad ersetzt. */
757 void opt_call_addrs(void) {
759 sel_methods_dispose();
762 pmap * ldname_map = pmap_create();
763 assert(entities == NULL);
764 entities = eset_create();
765 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
766 entity * ent = get_irg_ent(get_irp_irg(i));
767 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
768 * aufgerufen werden. */
769 if (get_entity_visibility(ent) != local) {
770 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
773 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
774 pmap_destroy(ldname_map);