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.
15 * Intraprozedurale Analyse zur Abschätzung der Aufrufrelation. Es
16 * wird eine Menge von freien Methoden und anschließend die an den
17 * Call-Operationen aufrufbaren Methoden bestimmt.
36 #include "dbginfo_t.h"
37 #include "iropt_dbg.h"
47 /* Eindeutige Adresse zur Markierung von besuchten Knoten und zur
48 * Darstellung der unbekannten Methode. */
49 static void * MARK = &MARK;
53 /* --- sel methods ---------------------------------------------------------- */
56 static eset * entities = NULL;
59 /** Bestimmt die eindeutige Methode, die die Methode für den
60 * übergebenen (dynamischen) Typ überschreibt. */
61 static entity * get_implementation(type * class, entity * method) {
63 if (get_entity_peculiarity(method) != peculiarity_description &&
64 get_entity_owner(method) == class) {
67 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i) {
68 entity * e = get_entity_overwrittenby(method, i);
69 if (get_entity_peculiarity(e) != peculiarity_description && get_entity_owner(e) == class) {
73 for (i = get_class_n_supertypes(class) - 1; i >= 0; --i) {
74 entity * e = get_implementation(get_class_supertype(class, i), method);
79 assert(0 && "implementation not found");
83 /** Returns the entity that contains the implementation of the inherited
84 entity if available, else returns the entity passed. */
85 static entity *get_inherited_methods_implementation(entity *inh_meth) {
86 entity *impl_meth = NULL;
87 ir_node *addr = get_atomic_ent_value(inh_meth);
89 assert(addr && "constant entity without value");
91 if ((get_irn_op(addr) == op_SymConst) &&
92 (get_SymConst_kind(addr) == symconst_addr_ent)) {
93 impl_meth = get_SymConst_entity(addr);
95 assert(0 && "Complex constant values not supported -- address of method should be straight constant!");
98 if (impl_meth && (get_entity_peculiarity(impl_meth) != peculiarity_existent)) {
100 printf("this_meth: "); DDMEO(inh_meth);
101 printf("impl meth: "); DDMEO(impl_meth);
102 assert(!impl_meth || get_entity_peculiarity(impl_meth) == peculiarity_existent);
106 return impl_meth? impl_meth : inh_meth;
110 /** Collect the entity representing the implementation of this
111 * entity (not the same if inherited) and all entities for overwriting
112 * implementations in "set".
113 * If the implementation of the method is not included in the
114 * compilation unit "open" is set to true.
115 * A recursive descend in the overwritten relation.
116 * Cycle-free, therefore must terminate.
119 * @param set A set of entities.
120 * @param size Number of entities in set.
123 static void collect_impls(entity *method, eset *set, int *size, bool *open) {
126 if (get_entity_peculiarity(method) == peculiarity_existent) {
127 if ((get_entity_visibility(method) == visibility_external_allocated)
128 && (NULL == get_entity_irg(method))) {
131 assert(get_entity_irg(method) != NULL);
132 if (!eset_contains(set, method)) {
133 eset_insert(set, method);
139 if (get_entity_peculiarity(method) == peculiarity_inherited) {
140 entity *impl_ent = get_inherited_methods_implementation(method);
141 assert(impl_ent && "no implementation for inherited entity");
142 if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
143 assert(get_entity_irg(impl_ent) == NULL);
146 assert(get_entity_irg(impl_ent) != NULL);
147 if (!eset_contains(set, impl_ent)) {
148 eset_insert(set, impl_ent);
153 /*- recursive descent -*/
154 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
155 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
159 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
160 * (und implementieren). In der zurückgegebenen Reihung kommt jede
161 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
162 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
163 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
164 * keine Methoden, die "method" überschreiben, so gibt die Methode
169 static entity ** get_impl_methods(entity * method) {
170 eset * set = eset_create();
175 /* Collect all method entities that can be called here */
176 collect_impls(method, set, &size, &open);
178 /* Vorgaenger einfuegen. */
179 if (size == 0 && !open) {
180 /* keine implementierte überschriebene Methode */
184 arr = NEW_ARR_F(entity *, size + 1);
185 arr[0] = NULL; /* Represents open method */
186 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
190 arr = NEW_ARR_F(entity *, size);
191 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
198 /** Analyse address computations.
200 * - If the node is a SymConst(name) replace it by SymConst(ent) if possible.
201 * - If the node is a Sel:
202 * * If the pointer to the Sel comes directly from an Alloc node
203 * replace the Sel by a SymConst(ent).
206 * @param node The node to analyze
207 * @param ldname_map A map that mapps names of entities to the entities.
209 static void sel_methods_walker(ir_node * node, pmap * ldname_map) {
211 /* replace SymConst(name)-operations by SymConst(ent) */
212 if (get_irn_op(node) == op_SymConst) {
213 if (get_SymConst_kind(node) == symconst_addr_name) {
214 pmap_entry * entry = pmap_find(ldname_map, (void *) get_SymConst_name(node));
215 if (entry != NULL) { /* Method is declared in the compiled code */
216 entity * ent = entry->value;
217 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) { /* Meth. is defined */
218 set_irg_current_block(current_ir_graph, get_nodes_block(node));
219 ir_node *new_node = copy_const_value(get_atomic_ent_value(ent));
221 DBG_OPT_CSTEVAL(node, new_node);
223 assert(get_entity_irg(ent));
225 exchange(node, new_node);
231 else if (get_irn_op(node) == op_Sel &&
232 is_method_type(get_entity_type(get_Sel_entity(node)))) {
233 entity * ent = get_Sel_entity(node);
235 /* Sel from Alloc: replace by constant */
236 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
237 (get_irn_op(skip_Proj(get_Sel_ptr(node))) == op_Alloc)) {
240 /* We know which method will be called, no dispatch necessary. */
241 called_ent = resolve_ent_polymorphy(get_Alloc_type(skip_Proj(get_Sel_ptr(node))), ent);
242 set_irg_current_block(current_ir_graph, get_nodes_block(node));
243 /* called_ent may not be description: has no Address/Const to Call! */
244 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
245 new_node = copy_const_value(get_atomic_ent_value(called_ent));
247 DBG_OPT_POLY_ALLOC(node, new_node);
248 exchange(node, new_node);
252 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
253 if (!eset_contains(entities, ent)) {
254 /* Entity noch nicht behandelt. Alle (intern oder extern)
255 * implementierten Methoden suchen, die diese Entity
256 * überschreiben. Die Menge an entity.link speichern. */
257 set_entity_link(ent, get_impl_methods(ent));
258 eset_insert(entities, ent);
260 if (get_entity_link(ent) == NULL) {
261 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
262 * Methode zurückgeben. Damit ist sie insbesondere nicht
263 * ausführbar und nicht erreichbar. */
264 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
265 fuer die es keine Implementierung gibt. */
266 if (get_entity_peculiarity(ent) == peculiarity_description) {
267 /* This is possible: We call a method in a dead part of the program. */
270 assert(0); /* Why should this happen ??? */
271 //exchange(node, new_Bad());
274 entity ** arr = get_entity_link(ent);
278 printf("\nCall site "); DDMN(node);
279 printf(" in "); DDME(get_irg_entity(current_ir_graph));
280 printf(" can call:\n");
281 for (i = 0; i < ARR_LEN(arr); i++) {
282 printf(" - "); DDME(arr[i]);
283 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
288 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
289 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
291 /* Die Sel-Operation kann immer nur _einen_ Wert auf eine
292 * interne Methode zurückgeben. Wir können daher die
293 * Sel-Operation durch eine Const- bzw. SymConst-Operation
295 set_irg_current_block(current_ir_graph, get_nodes_block(node));
296 assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
297 peculiarity_existent);
298 new_node = copy_const_value(get_atomic_ent_value(arr[0]));
299 DBG_OPT_POLY(node, new_node);
300 exchange (node, new_node);
308 /** Datenstruktur initialisieren. Zusätzlich werden alle
309 * SymConst(name)-Operationen, die auf interne Methoden verweisen, durch
310 * SymConst(entity)-Operationen ersetzt. */
311 static void sel_methods_init(void) {
313 pmap * ldname_map = pmap_create(); /* Map entitiy names to entities: to replace SymConst(name) by SymConst(ent). */
315 assert(entities == NULL);
316 entities = eset_create();
317 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
318 entity * ent = get_irg_entity(get_irp_irg(i));
319 /* Nur extern sichtbare Methode können überhaupt mit SymConst
320 * aufgerufen werden. */
321 if (get_entity_visibility(ent) != visibility_local) {
322 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
325 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
326 pmap_destroy(ldname_map);
329 /*****************************************************************************/
331 /* Datenstruktur freigeben. */
332 static void sel_methods_dispose(void) {
335 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
336 entity ** arr = get_entity_link(ent);
340 set_entity_link(ent, NULL);
342 eset_destroy(entities);
347 /* Gibt die Menge aller Methoden zurück, die an diesem Sel-Knoten
348 * zurückgegeben werden können. Die Liste enthält keine doppelten
350 static entity ** get_Sel_arr(ir_node * sel) {
351 static entity ** NULL_ARRAY = NULL;
354 assert(sel && get_irn_op(sel) == op_Sel);
355 ent = get_Sel_entity(sel);
356 assert(is_method_type(get_entity_type(ent))); /* what else? */
357 arr = get_entity_link(ent);
361 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
362 * kann für polymorphe (abstrakte) Methoden passieren. */
364 NULL_ARRAY = NEW_ARR_F(entity *, 0);
371 static int get_Sel_n_methods(ir_node * sel) {
372 return ARR_LEN(get_Sel_arr(sel));
376 static entity * get_Sel_method(ir_node * sel, int pos) {
377 entity ** arr = get_Sel_arr(sel);
378 assert(pos >= 0 && pos < ARR_LEN(arr));
384 /* --- callee analysis ------------------------------------------------------ */
387 static void callee_ana_node(ir_node * node, eset * methods);
390 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
391 assert(get_irn_mode(node) == mode_T);
392 if (get_irn_link(node) == MARK) {
393 /* already visited */
396 set_irn_link(node, MARK);
398 switch (get_irn_opcode(node)) {
400 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
401 * op_Tuple oder ein Knoten, der eine "freie Methode"
403 ir_node * pred = get_Proj_pred(node);
404 if (get_irn_link(pred) != MARK) {
405 if (get_irn_op(pred) == op_Tuple) {
406 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
408 eset_insert(methods, MARK); /* free method -> unknown */
415 callee_ana_node(get_Tuple_pred(node, n), methods);
419 callee_ana_proj(get_Id_pred(node), n, methods);
423 eset_insert(methods, MARK); /* free method -> unknown */
427 set_irn_link(node, NULL);
431 static void callee_ana_node(ir_node * node, eset * methods) {
434 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
435 /* rekursion verhindern */
436 if (get_irn_link(node) == MARK) {
437 /* already visited */
440 set_irn_link(node, MARK);
442 switch (get_irn_opcode(node)) {
444 if (get_SymConst_kind(node) == symconst_addr_ent) {
445 entity * ent = get_SymConst_entity(node);
446 assert(ent && is_method_type(get_entity_type(ent)));
447 if (get_entity_visibility(ent) != visibility_external_allocated) {
448 assert(get_entity_irg(ent));
449 eset_insert(methods, ent);
451 eset_insert(methods, MARK); /* free method -> unknown */
454 assert(get_SymConst_kind(node) == symconst_addr_name);
455 /* externe Methode (wegen fix_symconst!) */
456 eset_insert(methods, MARK); /* free method -> unknown */
460 /* polymorphe Methode */
461 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
462 entity * ent = get_Sel_method(node, i);
464 eset_insert(methods, ent);
466 eset_insert(methods, MARK);
475 case iro_Phi: /* Vereinigung */
476 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
477 callee_ana_node(get_Phi_pred(node, i), methods);
482 callee_ana_node(get_Id_pred(node), methods);
486 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
493 eset_insert(methods, MARK); /* free method -> unknown */
497 assert(0 && "invalid opcode or opcode not implemented");
501 set_irn_link(node, NULL);
505 static void callee_walker(ir_node * call, void * env) {
506 if (get_irn_op(call) == op_Call) {
507 eset * methods = eset_create();
509 entity ** arr = NEW_ARR_F(entity *, 0);
510 callee_ana_node(skip_Id(get_Call_ptr(call)), methods);
511 if (eset_contains(methods, MARK)) { /* unknown method */
512 ARR_APP1(entity *, arr, unknown_entity);
514 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
516 ARR_APP1(entity *, arr, ent);
519 #if 0 /* This generates Bad nodes when we don't want it.
520 Call it with a check for valid cgana information in local_optimize. */
521 if (ARR_LEN(arr) == 0 && get_opt_optimize() && get_opt_dyn_meth_dispatch()) {
522 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
523 * Sel-Operation war, die keine Methoden zurückgeben
524 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
525 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
527 ir_node *mem = get_Call_mem(call);
528 turn_into_tuple (call, 5 /* pn_Call_max */);
529 set_Tuple_pred(call, pn_Call_M_regular , mem);
530 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
531 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
532 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
533 set_Tuple_pred(call, pn_Call_M_except , new_Bad());
538 /* remove, what we repaired. */
540 for (i = 0; i < ARR_LEN(arr); ++i) {
542 //if (arr[i] == unknown_entity) arr[i] = NULL;
545 set_Call_callee_arr(call, ARR_LEN(arr), arr);
548 eset_destroy(methods);
553 static void remove_Tuples(ir_node * proj, void * env) {
555 if (get_irn_opcode(proj) != iro_Proj) return;
557 new = skip_Tuple(proj);
558 if (new != proj) exchange(proj, new);
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, remove_Tuples, NULL);
571 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
573 set_irp_callee_info_state(irg_callee_info_consistent);
578 /* --- free method analysis ------------------------------------------------- */
581 static void free_mark(ir_node * node, eset * set);
583 static void free_mark_proj(ir_node * node, long n, eset * set) {
584 assert(get_irn_mode(node) == mode_T);
585 if (get_irn_link(node) == MARK) {
586 /* already visited */
589 set_irn_link(node, MARK);
590 switch (get_irn_opcode(node)) {
592 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
593 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
595 ir_node * pred = get_Proj_pred(node);
596 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
597 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
599 /* nothing: da in "free_ana_walker" behandelt. */
605 free_mark(get_Tuple_pred(node, n), set);
609 free_mark_proj(get_Id_pred(node), n, set);
615 /* nothing: Die Operationen werden in "free_ana_walker" selbst
620 assert(0 && "unexpected opcode or opcode not implemented");
623 set_irn_link(node, NULL);
627 static void free_mark(ir_node * node, eset * set) {
629 // assert(mode_is_reference(get_irn_mode(node)));
630 if (get_irn_link(node) == MARK) {
631 return; /* already visited */
633 set_irn_link(node, MARK);
634 switch (get_irn_opcode(node)) {
636 entity * ent = get_Sel_entity(node);
637 if (is_method_type(get_entity_type(ent))) {
638 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
639 eset_insert(set, get_Sel_method(node, i));
645 if (get_SymConst_kind(node) == symconst_addr_ent) {
646 entity * ent = get_SymConst_entity(node);
647 if (is_method_type(get_entity_type(ent))) {
648 eset_insert(set, ent);
651 assert(get_SymConst_kind(node) == symconst_addr_name);
652 /* nothing: SymConst points to extern method */
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)
726 eset * set = eset_create();
728 entity ** arr = NEW_ARR_F(entity *, 0);
731 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
732 ir_graph * irg = get_irp_irg(i);
733 entity * ent = get_irg_entity(irg);
734 /* insert "external visible" methods. */
735 if (get_entity_visibility(ent) != visibility_local) {
736 eset_insert(set, ent);
738 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
739 z.B. da die Adresse einer Methode abgespeichert wird. */
740 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
743 /* insert sticky methods, too */
744 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
745 ir_graph * irg = get_irp_irg(i);
746 entity * ent = get_irg_entity(irg);
747 /* insert "external visible" methods. */
748 if (get_entity_stickyness (ent) == stickyness_sticky) {
749 eset_insert(set, ent);
753 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
755 if (get_irp_main_irg()) {
756 eset_insert(set, get_irg_entity(get_irp_main_irg()));
758 /* Wandle Menge in Feld um. Effizienter. */
759 for (ent = eset_first(set); ent; ent = eset_next(set)) {
760 ARR_APP1(entity *, arr, ent);
767 void cgana(int *length, entity ***free_methods) {
768 entity ** free_meths, **p;
771 free_meths = get_free_methods();
773 sel_methods_dispose();
775 /* Convert the flexible array to an array that can be handled
777 p = (entity **)malloc(sizeof(*p) * ARR_LEN(free_meths));
778 memcpy(p, free_meths, ARR_LEN(free_meths) * sizeof(*p));
780 *length = ARR_LEN(free_meths);
783 DEL_ARR_F(free_meths);
788 static void destruct_walker(ir_node * node, void * env) {
789 if (get_irn_op(node) == op_Call) {
790 remove_Call_callee_arr(node);
794 void free_callee_info(ir_graph *irg) {
795 irg_walk_graph(irg, destruct_walker, NULL, NULL);
796 set_irg_callee_info_state(irg, irg_callee_info_none);
800 /* Optimize the address expressions passed to call nodes.
802 * This optimization performs the following transformations for
804 * - All SymConst operations that refer to intern methods are replaced
805 * by Const operations refering to the corresponding entity.
806 * - Sel nodes, that select entities that are not overwritten are
807 * replaced by Const nodes refering to the selected entity.
808 * - Sel nodes, for witch no method exists at all are replaced by Bad
810 * - Sel nodes with a pointer input that is an Alloc node are replaced
811 * by Const nodes refering to the entity that implements the method in
812 * the type given by the Alloc node.
814 void opt_call_addrs(void) {
816 sel_methods_dispose();
819 pmap * ldname_map = pmap_create();
820 assert(entities == NULL);
821 entities = eset_create();
822 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
823 entity * ent = get_irg_entity(get_irp_irg(i));
824 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
825 * aufgerufen werden. */
826 if (get_entity_visibility(ent) != local) {
827 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
830 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
831 pmap_destroy(ldname_map);