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.
35 #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);
85 assert(addr && "constant entity without value");
87 if ((get_irn_op(addr) == op_SymConst) &&
88 (get_SymConst_kind(addr) == symconst_addr_ent)) {
89 impl_meth = get_SymConst_entity(addr);
91 assert(0 && "Complex constant values not supported -- address of method should be straight constant!");
94 if (impl_meth && (get_entity_peculiarity(impl_meth) != peculiarity_existent)) {
96 printf("this_meth: "); DDMEO(inh_meth);
97 printf("impl meth: "); DDMEO(impl_meth);
98 assert(!impl_meth || get_entity_peculiarity(impl_meth) == peculiarity_existent);
102 return impl_meth? impl_meth : inh_meth;
106 /** Collect the entity representing the implementation of this
107 * entity (not the same if inherited) and all entities for overwriting
108 * implementations in "set".
109 * If the implementation of the method is not included in the
110 * compilation unit "open" is set to true.
111 * A recursive descend in the overwritten relation.
112 * Cycle-free, therefore must terminate.
115 * @param set A set of entities.
116 * @param size Number of entities in set.
119 static void collect_impls(entity *method, eset *set, int *size, bool *open) {
122 if (get_entity_peculiarity(method) == peculiarity_existent) {
123 if (get_entity_visibility(method) == visibility_external_allocated) {
124 assert(get_entity_irg(method) == NULL);
127 assert(get_entity_irg(method) != NULL);
128 if (!eset_contains(set, method)) {
129 eset_insert(set, method);
135 if (get_entity_peculiarity(method) == peculiarity_inherited) {
136 entity *impl_ent = get_inherited_methods_implementation(method);
137 assert(impl_ent && "no implementation for inherited entity");
138 if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
139 assert(get_entity_irg(impl_ent) == NULL);
142 assert(get_entity_irg(impl_ent) != NULL);
143 if (!eset_contains(set, impl_ent)) {
144 eset_insert(set, impl_ent);
149 /** recursive descent **/
150 for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
151 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
155 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
156 * (und implementieren). In der zurückgegebenen Reihung kommt jede
157 * Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
158 * (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
159 * wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
160 * keine Methoden, die "method" überschreiben, so gibt die Methode
165 static entity ** get_impl_methods(entity * method) {
166 eset * set = eset_create();
171 /* Collect all method entities that can be called here */
172 collect_impls(method, set, &size, &open);
174 /* Vorgaenger einfuegen. */
175 if (size == 0 && !open) {
176 /* keine implementierte überschriebene Methode */
180 arr = NEW_ARR_F(entity *, size + 1);
181 arr[0] = NULL; /* Represents open method */
182 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
186 arr = NEW_ARR_F(entity *, size);
187 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
195 /* debug makros used in sel_methods_walker */
196 #define SIZ(x) sizeof(x)/sizeof((x)[0])
198 #define DBG_OPT_NORMALIZE \
199 __dbg_info_merge_pair(new_node, node, dbg_const_eval)
200 #define DBG_OPT_POLY_ALLOC \
204 ons[1] = skip_Proj(get_Sel_ptr(node)); \
205 __dbg_info_merge_sets(&new_node, 1, ons, SIZ(ons), dbg_rem_poly_call); \
207 #define DBG_OPT_POLY \
208 __dbg_info_merge_pair(new_node, node, dbg_rem_poly_call)
212 /** Analyse address computations.
214 * - If the node is a SymConst(name) replace it by SymConst(ent) if possible.
215 * - If the node is a Sel:
216 * * If the pointer to the Sel comes directly from an Alloc node
217 * replace the Sel by a SymConst(ent).
220 * @param node The node to analyze
221 * @param ldname_map A map that mapps names of entities to the entities.
223 static void sel_methods_walker(ir_node * node, pmap * ldname_map) {
225 /* SymConst(name)-Operation durch SymConst(ent)-Operation ersetzen. */
226 if (get_irn_op(node) == op_SymConst) {
227 if (get_SymConst_kind(node) == symconst_addr_name) {
228 pmap_entry * entry = pmap_find(ldname_map, (void *) get_SymConst_name(node));
229 if (entry != NULL) { /* Method is declared in the compiled code */
230 entity * ent = entry->value;
231 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) { /* Meth. is defined */
232 set_irg_current_block(current_ir_graph, get_nodes_block(node));
233 ir_node *new_node = copy_const_value(get_atomic_ent_value(ent));
235 assert(get_entity_irg(ent));
237 exchange(node, new_node);
243 else if (get_irn_op(node) == op_Sel &&
244 is_method_type(get_entity_type(get_Sel_entity(node)))) {
245 entity * ent = get_Sel_entity(node);
247 /* Sel from Alloc: replace by constant */
248 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
249 (get_irn_op(skip_Proj(get_Sel_ptr(node))) == op_Alloc)) {
252 /* We know which method will be called, no dispatch necessary. */
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;
258 exchange (node, new_node);
262 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
263 if (!eset_contains(entities, ent)) {
264 /* Entity noch nicht behandelt. Alle (intern oder extern)
265 * implementierten Methoden suchen, die diese Entity
266 * überschreiben. Die Menge an entity.link speichern. */
267 set_entity_link(ent, get_impl_methods(ent));
268 eset_insert(entities, ent);
270 if (get_entity_link(ent) == NULL) {
271 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
272 * Methode zurückgeben. Damit ist sie insbesondere nicht
273 * ausführbar und nicht erreichbar. */
274 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
275 fuer die es keine Implementierung gibt. */
276 if (get_entity_peculiarity(ent) == peculiarity_description) {
277 /* This is possible: We call a method in a dead part of the program. */
280 assert(0); /* Why should this happen ??? */
281 //exchange(node, new_Bad());
284 entity ** arr = get_entity_link(ent);
288 printf("\nCall site "); DDMN(node);
289 printf(" in "); DDME(get_irg_entity(current_ir_graph));
290 printf(" can call:\n");
291 for (i = 0; i < ARR_LEN(arr); i++) {
292 printf(" - "); DDME(arr[i]);
293 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
298 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
299 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
301 /* Die Sel-Operation kann immer nur _einen_ Wert auf eine
302 * interne Methode zurückgeben. Wir können daher die
303 * Sel-Operation durch eine Const- bzw. SymConst-Operation
305 set_irg_current_block(current_ir_graph, get_nodes_block(node));
306 assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
307 peculiarity_existent);
308 new_node = copy_const_value(get_atomic_ent_value(arr[0])); DBG_OPT_POLY;
309 exchange (node, new_node);
317 /** Datenstruktur initialisieren. Zusätzlich werden alle
318 * SymConst-Operationen, die auf interne Methoden verweisen, durch
319 * Const-Operationen ersetzt. */
320 static void sel_methods_init(void) {
322 pmap * ldname_map = pmap_create(); /* Map entitiy names to entities: to replace SymConst by Const(ent). */
323 assert(entities == NULL);
324 entities = eset_create();
325 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
326 entity * ent = get_irg_entity(get_irp_irg(i));
327 /* Nur extern sichtbare Methode können überhaupt mit SymConst
328 * aufgerufen werden. */
329 if (get_entity_visibility(ent) != visibility_local) {
330 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
333 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
334 pmap_destroy(ldname_map);
337 /*****************************************************************************/
339 /* Datenstruktur freigeben. */
340 static void sel_methods_dispose(void) {
343 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
344 entity ** arr = get_entity_link(ent);
348 set_entity_link(ent, NULL);
350 eset_destroy(entities);
355 /* Gibt die Menge aller Methoden zurück, die an diesem Sel-Knoten
356 * zurückgegeben werden können. Die Liste enthält keine doppelten
358 static entity ** get_Sel_arr(ir_node * sel) {
359 static entity ** NULL_ARRAY = NULL;
362 assert(sel && get_irn_op(sel) == op_Sel);
363 ent = get_Sel_entity(sel);
364 assert(is_method_type(get_entity_type(ent))); /* what else? */
365 arr = get_entity_link(ent);
369 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
370 * kann für polymorphe (abstrakte) Methoden passieren. */
372 NULL_ARRAY = NEW_ARR_F(entity *, 0);
379 static int get_Sel_n_methods(ir_node * sel) {
380 return ARR_LEN(get_Sel_arr(sel));
384 static entity * get_Sel_method(ir_node * sel, int pos) {
385 entity ** arr = get_Sel_arr(sel);
386 assert(pos >= 0 && pos < ARR_LEN(arr));
392 /* --- callee analysis ------------------------------------------------------ */
395 static void callee_ana_node(ir_node * node, eset * methods);
398 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
399 assert(get_irn_mode(node) == mode_T);
400 if (get_irn_link(node) == MARK) {
401 /* already visited */
404 set_irn_link(node, MARK);
406 switch (get_irn_opcode(node)) {
408 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
409 * op_Tuple oder ein Knoten, der eine "freie Methode"
411 ir_node * pred = get_Proj_pred(node);
412 if (get_irn_link(pred) != MARK) {
413 if (get_irn_op(pred) == op_Tuple) {
414 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
416 eset_insert(methods, MARK); /* free method -> unknown */
423 callee_ana_node(get_Tuple_pred(node, n), methods);
427 callee_ana_proj(get_Id_pred(node), n, methods);
431 eset_insert(methods, MARK); /* free method -> unknown */
435 set_irn_link(node, NULL);
439 static void callee_ana_node(ir_node * node, eset * methods) {
442 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
443 /* rekursion verhindern */
444 if (get_irn_link(node) == MARK) {
445 /* already visited */
448 set_irn_link(node, MARK);
450 switch (get_irn_opcode(node)) {
452 if (get_SymConst_kind(node) == symconst_addr_ent) {
453 entity * ent = get_SymConst_entity(node);
454 assert(ent && is_method_type(get_entity_type(ent)));
455 if (get_entity_visibility(ent) != visibility_external_allocated) {
456 assert(get_entity_irg(ent));
457 eset_insert(methods, ent);
459 eset_insert(methods, MARK); /* free method -> unknown */
462 assert(get_SymConst_kind(node) == symconst_addr_name);
463 /* externe Methode (wegen fix_symconst!) */
464 eset_insert(methods, MARK); /* free method -> unknown */
468 /* polymorphe Methode */
469 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
470 entity * ent = get_Sel_method(node, i);
472 eset_insert(methods, ent);
474 eset_insert(methods, MARK);
483 case iro_Phi: /* Vereinigung */
484 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
485 callee_ana_node(get_Phi_pred(node, i), methods);
490 callee_ana_node(get_Id_pred(node), methods);
494 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
501 eset_insert(methods, MARK); /* free method -> unknown */
505 assert(0 && "invalid opcode or opcode not implemented");
509 set_irn_link(node, NULL);
513 static void callee_walker(ir_node * call, void * env) {
514 if (get_irn_op(call) == op_Call) {
515 eset * methods = eset_create();
517 entity ** arr = NEW_ARR_F(entity *, 0);
518 callee_ana_node(skip_Id(get_Call_ptr(call)), methods);
519 if (eset_contains(methods, MARK)) { /* unknown method */
520 ARR_APP1(entity *, arr, NULL);
522 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
524 ARR_APP1(entity *, arr, ent);
527 #if 0 /* This generates Bad nodes when we don't want it.
528 Call it with a check for valid cgana information in local_optimize. */
529 if (ARR_LEN(arr) == 0 && get_opt_optimize() && get_opt_dyn_meth_dispatch()) {
530 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
531 * Sel-Operation war, die keine Methoden zurückgeben
532 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
533 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
535 ir_node *mem = get_Call_mem(call);
536 turn_into_tuple (call, 5 /* pn_Call_max */);
537 set_Tuple_pred(call, pn_Call_M_regular , mem);
538 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
539 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
540 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
541 set_Tuple_pred(call, pn_Call_M_except , new_Bad());
546 set_Call_callee_arr(call, ARR_LEN(arr), arr);
549 eset_destroy(methods);
554 static void remove_Tuples(ir_node * proj, void * env) {
556 if (get_irn_opcode(proj) != iro_Proj) return;
558 new = skip_Tuple(proj);
559 if (new != proj) exchange(proj, new);
563 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
564 * und speichert das Ergebnis in der Call-Operation. (siehe
565 * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
566 * muss bereits aufgebaut sein. */
567 static void callee_ana(void) {
569 /* Alle Graphen analysieren. */
570 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
571 irg_walk_graph(get_irp_irg(i), callee_walker, remove_Tuples, NULL);
572 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
574 set_irp_callee_info_state(irg_callee_info_consistent);
579 /* --- free method analysis ------------------------------------------------- */
582 static void free_mark(ir_node * node, eset * set);
584 static void free_mark_proj(ir_node * node, long n, eset * set) {
585 assert(get_irn_mode(node) == mode_T);
586 if (get_irn_link(node) == MARK) {
587 /* already visited */
590 set_irn_link(node, MARK);
591 switch (get_irn_opcode(node)) {
593 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
594 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
596 ir_node * pred = get_Proj_pred(node);
597 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
598 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
600 /* nothing: da in "free_ana_walker" behandelt. */
606 free_mark(get_Tuple_pred(node, n), set);
610 free_mark_proj(get_Id_pred(node), n, set);
616 /* nothing: Die Operationen werden in "free_ana_walker" selbst
621 assert(0 && "unexpected opcode or opcode not implemented");
624 set_irn_link(node, NULL);
628 static void free_mark(ir_node * node, eset * set) {
630 assert(mode_is_reference(get_irn_mode(node)));
631 if (get_irn_link(node) == MARK) {
632 return; /* already visited */
634 set_irn_link(node, MARK);
635 switch (get_irn_opcode(node)) {
637 entity * ent = get_Sel_entity(node);
638 if (is_method_type(get_entity_type(ent))) {
639 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
640 eset_insert(set, get_Sel_method(node, i));
646 if (get_SymConst_kind(node) == symconst_addr_ent) {
647 entity * ent = get_SymConst_entity(node);
648 if (is_method_type(get_entity_type(ent))) {
649 eset_insert(set, ent);
652 assert(get_SymConst_kind(node) == symconst_addr_name);
653 /* nothing: SymConst points to extern method */
658 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
659 free_mark(get_Phi_pred(node, i), set);
663 free_mark(get_Id_pred(node), set);
666 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
669 /* nothing: Wird unten behandelt! */
672 set_irn_link(node, NULL);
676 static void free_ana_walker(ir_node * node, eset * set) {
678 if (get_irn_link(node) == MARK) {
679 /* bereits in einem Zyklus besucht. */
682 switch (get_irn_opcode(node)) {
693 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
696 set_irn_link(node, MARK);
697 for (i = get_Call_arity(node) - 1; i >= 0; --i) {
698 ir_node * pred = get_Call_param(node, i);
699 if (mode_is_reference(get_irn_mode(pred))) {
700 free_mark(pred, set);
704 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
705 * jemand das Gegenteil implementiert. */
707 set_irn_link(node, MARK);
708 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
709 ir_node * pred = get_irn_n(node, i);
710 if (mode_is_reference(get_irn_mode(pred))) {
711 free_mark(pred, set);
716 set_irn_link(node, NULL);
720 /* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
721 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
722 * SymConst-Operationen müssen in passende Const-Operationen
723 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
724 * auf eine echt externe Methode. */
725 static entity ** get_free_methods(void)
727 eset * set = eset_create();
729 entity ** arr = NEW_ARR_F(entity *, 0);
732 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
733 ir_graph * irg = get_irp_irg(i);
734 entity * ent = get_irg_entity(irg);
735 /* insert "external visible" methods. */
736 if (get_entity_visibility(ent) != visibility_local) {
737 eset_insert(set, ent);
739 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
740 z.B. da die Adresse einer Methode abgespeichert wird. */
741 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
744 /* insert sticky methods, too */
745 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
746 ir_graph * irg = get_irp_irg(i);
747 entity * ent = get_irg_entity(irg);
748 /* insert "external visible" methods. */
749 if (get_entity_stickyness (ent) == stickyness_sticky) {
750 eset_insert(set, ent);
754 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
756 if (get_irp_main_irg()) {
757 eset_insert(set, get_irg_entity(get_irp_main_irg()));
759 /* Wandle Menge in Feld um. Effizienter. */
760 for (ent = eset_first(set); ent; ent = eset_next(set)) {
761 ARR_APP1(entity *, arr, ent);
768 void cgana(int *length, entity ***free_methods) {
769 entity ** free_meths;
773 free_meths = get_free_methods();
775 sel_methods_dispose();
777 /* Convert the flexible array to an array that can be handled
779 *length = ARR_LEN(free_meths);
780 *free_methods = (entity **)malloc(sizeof(entity *) * (*length));
781 for (i = 0; i < (*length); i++) (*free_methods)[i] = free_meths[i];
782 DEL_ARR_F(free_meths);
787 static void destruct_walker(ir_node * node, void * env) {
788 if (get_irn_op(node) == op_Call) {
789 remove_Call_callee_arr(node);
793 void free_callee_info(ir_graph *irg) {
794 irg_walk_graph(irg, destruct_walker, NULL, NULL);
795 set_irg_callee_info_state(irg, irg_callee_info_none);
799 /* Optimize the address expressions passed to call nodes.
801 * This optimization performs the following transformations for
803 * - All SymConst operations that refer to intern methods are replaced
804 * by Const operations refering to the corresponding entity.
805 * - Sel nodes, that select entities that are not overwritten are
806 * replaced by Const nodes refering to the selected entity.
807 * - Sel nodes, for witch no method exists at all are replaced by Bad
809 * - Sel nodes with a pointer input that is an Alloc node are replaced
810 * by Const nodes refering to the entity that implements the method in
811 * the type given by the Alloc node.
813 void opt_call_addrs(void) {
815 sel_methods_dispose();
818 pmap * ldname_map = pmap_create();
819 assert(entities == NULL);
820 entities = eset_create();
821 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
822 entity * ent = get_irg_entity(get_irp_irg(i));
823 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
824 * aufgerufen werden. */
825 if (get_entity_visibility(ent) != local) {
826 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
829 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
830 pmap_destroy(ldname_map);