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.
39 #include "dbginfo_t.h"
43 /* Eindeutige Adresse zur Markierung von besuchten Knoten und zur
44 * Darstellung der unbekannten Methode. */
45 static void * MARK = &MARK;
49 /* --- sel methods ---------------------------------------------------------- */
52 static eset * entities = NULL;
55 /** Bestimmt die eindeutige Methode, die die Methode für den
56 * übergebenen (dynamischen) Typ überschreibt. */
57 static entity * get_implementation(type * class, entity * method) {
59 if (get_entity_peculiarity(method) != peculiarity_description &&
60 get_entity_owner(method) == class) {
63 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i) {
64 entity * e = get_entity_overwrittenby(method, i);
65 if (get_entity_peculiarity(e) != peculiarity_description && get_entity_owner(e) == class) {
69 for (i = get_class_n_supertypes(class) - 1; i >= 0; --i) {
70 entity * e = get_implementation(get_class_supertype(class, i), method);
75 assert(0 && "implementation not found");
79 /** Returns the entity that contains the implementation of the inherited
80 entity if available, else returns the entity passed. */
81 static entity *get_inherited_methods_implementation(entity *inh_meth) {
82 entity *impl_meth = NULL;
83 ir_node *addr = get_atomic_ent_value(inh_meth);
84 assert(addr && "constant entity without value");
86 if (get_irn_op(addr) == op_Const) {
87 impl_meth = tarval_to_entity(get_Const_tarval(addr));
89 assert(0 && "Complex constant values not supported -- address of method should be straight constant!");
91 if (impl_meth && (get_entity_peculiarity(impl_meth) != peculiarity_existent)) {
93 printf("this_meth: "); DDMEO(inh_meth);
94 printf("impl meth: "); DDMEO(impl_meth);
95 assert(!impl_meth || get_entity_peculiarity(impl_meth) == peculiarity_existent);
99 return impl_meth? impl_meth : inh_meth;
103 /** Collect the entity representing the implementation of this
104 * entity (not the same if inherited) and all entities for overwriting
105 * implementations in "set".
106 * If the implementation of the method is not included in the
107 * compilation unit "open" is set to true.
108 * A recursive descend in the overwritten relation.
109 * Cycle-free, therefore must terminate.
112 * @param set A set of entities.
113 * @param size Number of entities in set.
116 static void collect_impls(entity *method, eset *set, int *size, bool *open) {
119 if (get_entity_peculiarity(method) == peculiarity_existent) {
120 if (get_entity_visibility(method) == visibility_external_allocated) {
121 assert(get_entity_irg(method) == NULL);
124 assert(get_entity_irg(method) != NULL);
125 if (!eset_contains(set, method)) {
126 eset_insert(set, method);
132 if (get_entity_peculiarity(method) == peculiarity_inherited) {
133 entity *impl_ent = get_inherited_methods_implementation(method);
134 assert(impl_ent && "no implementation for inherited entity");
135 if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
136 assert(get_entity_irg(impl_ent) == NULL);
139 assert(get_entity_irg(impl_ent) != NULL);
140 if (!eset_contains(set, impl_ent)) {
141 eset_insert(set, impl_ent);
146 /** recursive descend **/
147 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
148 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
152 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
153 * (und implementieren). In der zurückgegebenen Reihung kommt jede
154 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
155 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
156 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
157 * keine Methoden, die "method" überschreiben, so gibt die Methode
162 static entity ** get_impl_methods(entity * method) {
163 eset * set = eset_create();
168 /* Collect all method entities that can be called here */
169 collect_impls(method, set, &size, &open);
171 /* Vorgaenger einfuegen. */
172 if (size == 0 && !open) {
173 /* keine implementierte überschriebene Methode */
177 arr = NEW_ARR_F(entity *, size + 1);
178 arr[0] = NULL; /* Represents open method */
179 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
183 arr = NEW_ARR_F(entity *, size);
184 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
192 /* debug makros used in sel_methods_walker */
193 #define SIZ(x) sizeof(x)/sizeof((x)[0])
195 #define DBG_OPT_NORMALIZE \
196 __dbg_info_merge_pair(new_node, node, dbg_const_eval)
197 #define DBG_OPT_POLY_ALLOC \
201 ons[1] = skip_Proj(get_Sel_ptr(node)); \
202 __dbg_info_merge_sets(&new_node, 1, ons, SIZ(ons), dbg_rem_poly_call); \
204 #define DBG_OPT_POLY \
205 __dbg_info_merge_pair(new_node, node, dbg_rem_poly_call)
209 /** Analyse address computations.
211 * - If the node is a SymConst replace it by Const(ent) if possible.
212 * - If the node is a Sel:
213 * * If the pointer to the Sel comes directly from an Alloc node
214 * replace the Sel by a Const(ent).
217 * @param node The node to analyze
218 * @param ldname_map A map that mapps names of entities to the entities.
220 static void sel_methods_walker(ir_node * node, pmap * ldname_map) {
222 if (get_irn_op(node) == op_SymConst) {
223 /* Wenn möglich SymConst-Operation durch Const-Operation
225 if (get_SymConst_kind(node) == linkage_ptr_info) {
226 pmap_entry *entry = pmap_find(ldname_map, (void *) get_SymConst_ptrinfo(node));
227 if (entry != NULL) { /* Method is declared in the compiled code */
228 entity *ent = entry->value;
229 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) {
230 /* Meth. is defined */
232 assert(get_entity_irg(ent));
233 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
234 new_node = new_d_Const(get_irn_dbg_info(node),
235 mode_P_mach, new_tarval_from_entity(ent, mode_P_mach)); DBG_OPT_NORMALIZE;
236 exchange(node, new_node);
240 } else if (get_irn_op(node) == op_Sel &&
241 is_method_type(get_entity_type(get_Sel_entity(node)))) {
242 entity * ent = get_Sel_entity(node);
243 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
244 (get_irn_op(skip_Proj(get_Sel_ptr(node))) == op_Alloc)) {
247 /* We know which method will be called, no dispatch necessary. */
249 assert(get_entity_peculiarity(ent) != peculiarity_description);
250 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
251 /* @@@ Is this correct?? Alloc could reference a subtype of the owner
252 of Sel that overwrites the method referenced in Sel. */
253 /* @@@ Yes, this is wrong. GL, 10.3.04 */
254 new_node = copy_const_value(get_atomic_ent_value(ent)); DBG_OPT_POLY_ALLOC;
256 called_ent = resolve_ent_polymorphy(get_Alloc_type(skip_Proj(get_Sel_ptr(node))), ent);
257 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
258 /* called_ent may not be description: has no Address/Const to Call! */
259 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
260 new_node = copy_const_value(get_atomic_ent_value(called_ent)); DBG_OPT_POLY_ALLOC;
262 exchange (node, new_node);
264 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
265 if (!eset_contains(entities, ent)) {
266 /* Entity noch nicht behandelt. Alle (intern oder extern)
267 * implementierten Methoden suchen, die diese Entity
268 * überschreiben. Die Menge an entity.link speichern. */
269 set_entity_link(ent, get_impl_methods(ent));
270 eset_insert(entities, ent);
272 if (get_entity_link(ent) == NULL) {
273 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
274 * Methode zurückgeben. Damit ist sie insbesondere nicht
275 * ausführbar und nicht erreichbar. */
276 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
277 fuer die es keine Implementierung gibt. */
278 if (get_entity_peculiarity(ent) == peculiarity_description) {
279 /* @@@ GL Methode um Fehler anzuzeigen aufrufen! */
280 printf("WARNING: Calling method description %s\n in method %s\n of class %s\n which has "
281 "no implementation!\n", get_entity_name(ent),
282 get_entity_name(get_irg_ent(current_ir_graph)),
283 get_type_name(get_entity_owner(get_irg_ent(current_ir_graph))));
284 printf("This happens when compiling a Java Interface that's never really used, i.e., "
285 "no class implementing the interface is ever used.\n");
287 exchange(node, new_Bad());
290 entity ** arr = get_entity_link(ent);
294 printf("\nCall site "); DDMN(node);
295 printf(" in "); DDME(get_irg_ent(current_ir_graph));
296 printf(" can call:\n");
297 for (i = 0; i < ARR_LEN(arr); i++) {
298 printf(" - "); DDME(arr[i]);
299 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
304 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
305 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
307 /* Die Sel-Operation kann immer nur einen Wert auf eine
308 * interne Methode zurückgeben. Wir können daher die
309 * Sel-Operation durch eine Const- bzw. SymConst-Operation
311 set_irg_current_block(current_ir_graph, get_nodes_Block(node));
312 /* assert(get_entity_peculiarity(tarval_to_entity(get_Const_tarval(get_atomic_ent_value(arr[0])))) == peculiarity_existent); */
313 new_node = copy_const_value(get_atomic_ent_value(arr[0])); DBG_OPT_POLY;
314 exchange (node, new_node);
322 /** Datenstruktur initialisieren. Zusätzlich werden alle
323 * SymConst-Operationen, die auf interne Methoden verweisen, durch
324 * Const-Operationen ersetzt. */
325 static void sel_methods_init(void) {
327 pmap * ldname_map = pmap_create(); /* Map entitiy names to entities: to replace SymConst by Const(ent). */
328 assert(entities == NULL);
329 entities = eset_create();
330 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
331 entity * ent = get_irg_ent(get_irp_irg(i));
332 /* Nur extern sichtbare Methode können überhaupt mit SymConst
333 * aufgerufen werden. */
334 if (get_entity_visibility(ent) != visibility_local) {
335 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
338 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
339 pmap_destroy(ldname_map);
342 /*****************************************************************************/
344 /* Datenstruktur freigeben. */
345 static void sel_methods_dispose(void) {
348 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
349 entity ** arr = get_entity_link(ent);
353 set_entity_link(ent, NULL);
355 eset_destroy(entities);
360 /* Gibt die Menge aller Methoden zurück, die an diesem Sel-Knoten
361 * zurückgegeben werden können. Die Liste enthält keine doppelten
363 static entity ** get_Sel_arr(ir_node * sel) {
364 static entity ** NULL_ARRAY = NULL;
367 assert(sel && get_irn_op(sel) == op_Sel);
368 ent = get_Sel_entity(sel);
369 assert(is_method_type(get_entity_type(ent))); /* what else? */
370 arr = get_entity_link(ent);
374 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
375 * kann für polymorphe (abstrakte) Methoden passieren. */
377 NULL_ARRAY = NEW_ARR_F(entity *, 0);
384 static int get_Sel_n_methods(ir_node * sel) {
385 return ARR_LEN(get_Sel_arr(sel));
389 static entity * get_Sel_method(ir_node * sel, int pos) {
390 entity ** arr = get_Sel_arr(sel);
391 assert(pos >= 0 && pos < ARR_LEN(arr));
397 /* --- callee analysis ------------------------------------------------------ */
400 static void callee_ana_node(ir_node * node, eset * methods);
403 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
404 assert(get_irn_mode(node) == mode_T);
405 if (get_irn_link(node) == MARK) {
406 /* already visited */
409 set_irn_link(node, MARK);
411 switch (get_irn_opcode(node)) {
413 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
414 * op_Tuple oder ein Knoten, der eine "freie Methode"
416 ir_node * pred = get_Proj_pred(node);
417 if (get_irn_link(pred) != MARK) {
418 if (get_irn_op(pred) == op_Tuple) {
419 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
421 eset_insert(methods, MARK); /* free method -> unknown */
428 callee_ana_node(get_Tuple_pred(node, n), methods);
432 callee_ana_proj(get_Id_pred(node), n, methods);
436 eset_insert(methods, MARK); /* free method -> unknown */
440 set_irn_link(node, NULL);
444 static void callee_ana_node(ir_node * node, eset * methods) {
447 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
448 /* rekursion verhindern */
449 if (get_irn_link(node) == MARK) {
450 /* already visited */
453 set_irn_link(node, MARK);
455 switch (get_irn_opcode(node)) {
457 /* externe Methode (wegen fix_symconst!) */
458 eset_insert(methods, MARK); /* free method -> unknown */
462 /* interne Methode */
463 entity * ent = tarval_to_entity(get_Const_tarval(node));
464 assert(ent && is_method_type(get_entity_type(ent)));
465 if (get_entity_visibility(ent) != visibility_external_allocated) {
466 if (!get_entity_irg(ent)) {
468 assert(get_entity_irg(ent));
470 eset_insert(methods, ent);
472 eset_insert(methods, MARK); /* free method -> unknown */
478 /* polymorphe Methode */
479 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
480 entity * ent = get_Sel_method(node, i);
482 eset_insert(methods, ent);
484 eset_insert(methods, MARK);
493 case iro_Phi: /* Vereinigung */
494 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
495 callee_ana_node(get_Phi_pred(node, i), methods);
500 callee_ana_node(get_Id_pred(node), methods);
504 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
511 eset_insert(methods, MARK); /* free method -> unknown */
515 assert(0 && "invalid opcode or opcode not implemented");
519 set_irn_link(node, NULL);
523 static void callee_walker(ir_node * call, void * env) {
524 if (get_irn_op(call) == op_Call) {
525 eset * methods = eset_create();
527 entity ** arr = NEW_ARR_F(entity *, 0);
528 callee_ana_node(skip_nop(get_Call_ptr(call)), methods);
529 if (eset_contains(methods, MARK)) { /* unknown method */
530 ARR_APP1(entity *, arr, NULL);
532 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
534 ARR_APP1(entity *, arr, ent);
537 if (ARR_LEN(arr) == 0) {
538 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
539 * Sel-Operation war, die keine Methoden zurückgeben
540 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
541 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
543 /* exchange(call, new_Bad()); invalid firm */
545 ir_node *mem = get_Call_mem(call);
546 turn_into_tuple (call, 5 /* pn_Call_max */);
547 set_Tuple_pred(call, pn_Call_M_regular , mem);
548 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
549 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
550 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
551 set_Tuple_pred(call, pn_Call_M_except , mem);
554 set_Call_callee_arr(call, ARR_LEN(arr), arr);
557 eset_destroy(methods);
562 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
563 * und speichert das Ergebnis in der Call-Operation. (siehe
564 * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
565 * muss bereits aufgebaut sein. */
566 static void callee_ana(void) {
568 /* Alle Graphen analysieren. */
569 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
570 irg_walk_graph(get_irp_irg(i), callee_walker, NULL, NULL);
571 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
577 /* --- free method analysis ------------------------------------------------- */
580 static void free_mark(ir_node * node, eset * set);
582 static void free_mark_proj(ir_node * node, long n, eset * set) {
583 assert(get_irn_mode(node) == mode_T);
584 if (get_irn_link(node) == MARK) {
585 /* already visited */
588 set_irn_link(node, MARK);
589 switch (get_irn_opcode(node)) {
591 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
592 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
594 ir_node * pred = get_Proj_pred(node);
595 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
596 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
598 /* nothing: da in "free_ana_walker" behandelt. */
604 free_mark(get_Tuple_pred(node, n), set);
608 free_mark_proj(get_Id_pred(node), n, set);
614 /* nothing: Die Operationen werden in "free_ana_walker" selbst
619 assert(0 && "unexpected opcode or opcode not implemented");
622 set_irn_link(node, NULL);
626 static void free_mark(ir_node * node, eset * set) {
628 assert(mode_is_reference(get_irn_mode(node)));
629 if (get_irn_link(node) == MARK) {
630 return; /* already visited */
632 set_irn_link(node, MARK);
633 switch (get_irn_opcode(node)) {
635 entity * ent = get_Sel_entity(node);
636 if (is_method_type(get_entity_type(ent))) {
637 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
638 eset_insert(set, get_Sel_method(node, i));
644 /* nothing: SymConst points to extern method */
647 tarval * val = get_Const_tarval(node);
648 if (tarval_is_entity(val)) { /* filter null pointer */
649 entity * ent = tarval_to_entity(val);
650 if (is_method_type(get_entity_type(ent))) {
651 eset_insert(set, ent);
657 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
658 free_mark(get_Phi_pred(node, i), set);
662 free_mark(get_Id_pred(node), set);
665 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
668 /* nothing: Wird unten behandelt! */
671 set_irn_link(node, NULL);
675 static void free_ana_walker(ir_node * node, eset * set) {
677 if (get_irn_link(node) == MARK) {
678 /* bereits in einem Zyklus besucht. */
681 switch (get_irn_opcode(node)) {
692 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
695 set_irn_link(node, MARK);
696 for (i = get_Call_arity(node) - 1; i >= 0; --i) {
697 ir_node * pred = get_Call_param(node, i);
698 if (mode_is_reference(get_irn_mode(pred))) {
699 free_mark(pred, set);
703 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
704 * jemand das Gegenteil implementiert. */
706 set_irn_link(node, MARK);
707 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
708 ir_node * pred = get_irn_n(node, i);
709 if (mode_is_reference(get_irn_mode(pred))) {
710 free_mark(pred, set);
715 set_irn_link(node, NULL);
719 /* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
720 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
721 * SymConst-Operationen müssen in passende Const-Operationen
722 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
723 * auf eine echt externe Methode. */
724 static entity ** get_free_methods(void) {
725 eset * set = eset_create();
727 entity ** arr = NEW_ARR_F(entity *, 0);
730 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
731 ir_graph * irg = get_irp_irg(i);
732 entity * ent = get_irg_ent(irg);
733 /* insert "external visible" methods. */
734 if (get_entity_visibility(ent) != visibility_local) {
735 eset_insert(set, ent);
737 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
738 z.B. da die Adresse einer Methode abgespeichert wird. */
739 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
741 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
743 if (get_irp_main_irg()) {
744 eset_insert(set, get_irg_ent(get_irp_main_irg()));
746 /* Wandle Menge in Feld um. Effizienter. */
747 for (ent = eset_first(set); ent; ent = eset_next(set)) {
748 ARR_APP1(entity *, arr, ent);
755 void cgana(int *length, entity ***free_methods) {
756 entity ** free_meths;
760 free_meths = get_free_methods();
762 sel_methods_dispose();
764 /* Convert the flexible array to an array that can be handled
766 *length = ARR_LEN(free_meths);
767 *free_methods = (entity **)malloc(sizeof(entity *) * (*length));
768 for (i = 0; i < (*length); i++) (*free_methods)[i] = free_meths[i];
769 DEL_ARR_F(free_meths);
774 static void destruct_walker(ir_node * node, void * env) {
775 if (get_irn_op(node) == op_Call) {
776 remove_Call_callee_arr(node);
780 void free_callee_info(ir_graph *irg) {
781 irg_walk_graph(irg, destruct_walker, NULL, NULL);
782 set_irg_callee_info_state(irg, irg_callee_info_none);
786 /* Optimize the address expressions passed to call nodes.
788 * This optimization performs the following transformations for
790 * - All SymConst operations that refer to intern methods are replaced
791 * by Const operations refering to the corresponding entity.
792 * - Sel nodes, that select entities that are not overwritten are
793 * replaced by Const nodes refering to the selected entity.
794 * - Sel nodes, for witch no method exists at all are replaced by Bad
796 * - Sel nodes with a pointer input that is an Alloc node are replaced
797 * by Const nodes refering to the entity that implements the method in
798 * the type given by the Alloc node.
800 void opt_call_addrs(void) {
802 sel_methods_dispose();
805 pmap * ldname_map = pmap_create();
806 assert(entities == NULL);
807 entities = eset_create();
808 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
809 entity * ent = get_irg_ent(get_irp_irg(i));
810 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
811 * aufgerufen werden. */
812 if (get_entity_visibility(ent) != local) {
813 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
816 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
817 pmap_destroy(ldname_map);