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 env A map that maps names of entities to the entities.
209 static void sel_methods_walker(ir_node * node, void *env) {
210 pmap *ldname_map = env;
212 /* replace SymConst(name)-operations by SymConst(ent) */
213 if (get_irn_op(node) == op_SymConst) {
214 if (get_SymConst_kind(node) == symconst_addr_name) {
215 pmap_entry * entry = pmap_find(ldname_map, (void *) get_SymConst_name(node));
216 if (entry != NULL) { /* Method is declared in the compiled code */
217 entity * ent = entry->value;
218 if (get_opt_normalize() && (get_entity_visibility(ent) != visibility_external_allocated)) { /* Meth. is defined */
219 set_irg_current_block(current_ir_graph, get_nodes_block(node));
220 ir_node *new_node = copy_const_value(get_atomic_ent_value(ent));
222 DBG_OPT_CSTEVAL(node, new_node);
224 assert(get_entity_irg(ent));
226 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)) {
241 /* We know which method will be called, no dispatch necessary. */
242 called_ent = resolve_ent_polymorphy(get_Alloc_type(skip_Proj(get_Sel_ptr(node))), ent);
243 set_irg_current_block(current_ir_graph, get_nodes_block(node));
245 /* called_ent may not be description: has no Address/Const to Call! */
246 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
247 new_node = copy_const_value(get_atomic_ent_value(called_ent));
249 DBG_OPT_POLY_ALLOC(node, new_node);
250 exchange(node, new_node);
253 assert(get_entity_peculiarity(ent) != peculiarity_inherited);
254 if (!eset_contains(entities, ent)) {
255 /* Entity noch nicht behandelt. Alle (intern oder extern)
256 * implementierten Methoden suchen, die diese Entity
257 * überschreiben. Die Menge an entity.link speichern. */
258 set_entity_link(ent, get_impl_methods(ent));
259 eset_insert(entities, ent);
261 if (get_entity_link(ent) == NULL) {
262 /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
263 * Methode zurückgeben. Damit ist sie insbesondere nicht
264 * ausführbar und nicht erreichbar. */
265 /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
266 fuer die es keine Implementierung gibt. */
267 if (get_entity_peculiarity(ent) == peculiarity_description) {
268 /* This is possible: We call a method in a dead part of the program. */
271 assert(0); /* Why should this happen ??? */
272 //exchange(node, new_Bad());
275 entity ** arr = get_entity_link(ent);
279 printf("\nCall site "); DDMN(node);
280 printf(" in "); DDME(get_irg_entity(current_ir_graph));
281 printf(" can call:\n");
282 for (i = 0; i < ARR_LEN(arr); i++) {
283 printf(" - "); DDME(arr[i]);
284 printf(" with owner "); DDMT(get_entity_owner(arr[i]));
289 if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
290 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
292 /* Die Sel-Operation kann immer nur _einen_ Wert auf eine
293 * interne Methode zurückgeben. Wir können daher die
294 * Sel-Operation durch eine Const- bzw. SymConst-Operation
296 set_irg_current_block(current_ir_graph, get_nodes_block(node));
297 assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
298 peculiarity_existent);
299 new_node = copy_const_value(get_atomic_ent_value(arr[0]));
300 DBG_OPT_POLY(node, new_node);
301 exchange (node, new_node);
309 /** Datenstruktur initialisieren. Zusätzlich werden alle
310 * SymConst(name)-Operationen, die auf interne Methoden verweisen, durch
311 * SymConst(entity)-Operationen ersetzt. */
312 static void sel_methods_init(void) {
314 pmap * ldname_map = pmap_create(); /* Map entity names to entities: to replace SymConst(name) by SymConst(ent). */
316 assert(entities == NULL);
317 entities = eset_create();
318 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
319 entity * ent = get_irg_entity(get_irp_irg(i));
320 /* Nur extern sichtbare Methode können überhaupt mit SymConst
321 * aufgerufen werden. */
322 if (get_entity_visibility(ent) != visibility_local) {
323 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
326 all_irg_walk(sel_methods_walker, NULL, ldname_map);
327 pmap_destroy(ldname_map);
330 /*****************************************************************************/
332 /** Frees the allocated entity map */
333 static void sel_methods_dispose(void) {
336 for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
337 entity ** arr = get_entity_link(ent);
341 set_entity_link(ent, NULL);
343 eset_destroy(entities);
349 * Returns an array of all methods that could be called at a Sel node.
350 * This array contains every entry only once.
352 static entity ** get_Sel_arr(ir_node * sel) {
353 static entity ** NULL_ARRAY = NULL;
357 assert(sel && get_irn_op(sel) == op_Sel);
358 ent = get_Sel_entity(sel);
359 assert(is_method_type(get_entity_type(ent))); /* what else? */
360 arr = get_entity_link(ent);
364 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
365 * kann für polymorphe (abstrakte) Methoden passieren. */
367 NULL_ARRAY = NEW_ARR_F(entity *, 0);
374 * Returns the number of possible called methods at a Sel node.
376 static int get_Sel_n_methods(ir_node * sel) {
377 return ARR_LEN(get_Sel_arr(sel));
381 * Returns the ith possible called method entity at a Sel node.
383 static entity * get_Sel_method(ir_node * sel, int pos) {
384 entity ** arr = get_Sel_arr(sel);
385 assert(pos >= 0 && pos < ARR_LEN(arr));
391 /* --- callee analysis ------------------------------------------------------ */
394 static void callee_ana_node(ir_node * node, eset * methods);
397 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
398 assert(get_irn_mode(node) == mode_T);
399 if (get_irn_link(node) == MARK) {
400 /* already visited */
403 set_irn_link(node, MARK);
405 switch (get_irn_opcode(node)) {
407 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
408 * op_Tuple oder ein Knoten, der eine "freie Methode"
410 ir_node * pred = get_Proj_pred(node);
411 if (get_irn_link(pred) != MARK) {
412 if (get_irn_op(pred) == op_Tuple) {
413 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
415 eset_insert(methods, MARK); /* free method -> unknown */
422 callee_ana_node(get_Tuple_pred(node, n), methods);
426 callee_ana_proj(get_Id_pred(node), n, methods);
430 eset_insert(methods, MARK); /* free method -> unknown */
434 set_irn_link(node, NULL);
438 static void callee_ana_node(ir_node * node, eset * methods) {
441 assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
442 /* rekursion verhindern */
443 if (get_irn_link(node) == MARK) {
444 /* already visited */
447 set_irn_link(node, MARK);
449 switch (get_irn_opcode(node)) {
451 if (get_SymConst_kind(node) == symconst_addr_ent) {
452 entity * ent = get_SymConst_entity(node);
453 assert(ent && is_method_type(get_entity_type(ent)));
454 if (get_entity_visibility(ent) != visibility_external_allocated) {
455 assert(get_entity_irg(ent));
456 eset_insert(methods, ent);
458 eset_insert(methods, MARK); /* free method -> unknown */
461 assert(get_SymConst_kind(node) == symconst_addr_name);
462 /* externe Methode (wegen fix_symconst!) */
463 eset_insert(methods, MARK); /* free method -> unknown */
467 /* polymorphe Methode */
468 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
469 entity * ent = get_Sel_method(node, i);
471 eset_insert(methods, ent);
473 eset_insert(methods, MARK);
482 case iro_Phi: /* Vereinigung */
483 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
484 callee_ana_node(get_Phi_pred(node, i), methods);
489 callee_ana_node(get_Id_pred(node), methods);
493 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
500 eset_insert(methods, MARK); /* free method -> unknown */
504 assert(0 && "invalid opcode or opcode not implemented");
508 set_irn_link(node, NULL);
512 static void callee_walker(ir_node * call, void * env) {
513 if (get_irn_op(call) == op_Call) {
514 eset * methods = eset_create();
516 entity ** arr = NEW_ARR_F(entity *, 0);
517 callee_ana_node(skip_Id(get_Call_ptr(call)), methods);
518 if (eset_contains(methods, MARK)) { /* unknown method */
519 ARR_APP1(entity *, arr, unknown_entity);
521 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
523 ARR_APP1(entity *, arr, ent);
526 #if 0 /* This generates Bad nodes when we don't want it.
527 Call it with a check for valid cgana information in local_optimize. */
528 if (ARR_LEN(arr) == 0 && get_opt_optimize() && get_opt_dyn_meth_dispatch()) {
529 /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
530 * Sel-Operation war, die keine Methoden zurückgeben
531 * konnte. Wir ersetzen die Call-Operation ebenfalls durch
532 * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
534 ir_node *mem = get_Call_mem(call);
535 turn_into_tuple (call, 5 /* pn_Call_max */);
536 set_Tuple_pred(call, pn_Call_M_regular , mem);
537 set_Tuple_pred(call, pn_Call_T_result , new_Bad());
538 set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
539 set_Tuple_pred(call, pn_Call_X_except , new_Bad()); /* new_Jmp() ?? new_Raise() ?? */
540 set_Tuple_pred(call, pn_Call_M_except , new_Bad());
545 /* remove, what we repaired. */
547 for (i = 0; i < ARR_LEN(arr); ++i) {
549 //if (arr[i] == unknown_entity) arr[i] = NULL;
552 set_Call_callee_arr(call, ARR_LEN(arr), arr);
555 eset_destroy(methods);
560 static void remove_Tuples(ir_node * proj, void * env) {
562 if (get_irn_opcode(proj) != iro_Proj) return;
564 new = skip_Tuple(proj);
565 if (new != proj) exchange(proj, new);
569 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
570 * und speichert das Ergebnis in der Call-Operation. (siehe
571 * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
572 * muss bereits aufgebaut sein. */
573 static void callee_ana(void) {
575 /* Alle Graphen analysieren. */
576 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
577 irg_walk_graph(get_irp_irg(i), callee_walker, remove_Tuples, NULL);
578 set_irg_callee_info_state(get_irp_irg(i), irg_callee_info_consistent);
580 set_irp_callee_info_state(irg_callee_info_consistent);
585 /* --- free method analysis ------------------------------------------------- */
588 static void free_mark(ir_node * node, eset * set);
590 static void free_mark_proj(ir_node * node, long n, eset * set) {
591 assert(get_irn_mode(node) == mode_T);
592 if (get_irn_link(node) == MARK) {
593 /* already visited */
596 set_irn_link(node, MARK);
597 switch (get_irn_opcode(node)) {
599 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
600 * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
602 ir_node * pred = get_Proj_pred(node);
603 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
604 free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
606 /* nothing: da in "free_ana_walker" behandelt. */
612 free_mark(get_Tuple_pred(node, n), set);
616 free_mark_proj(get_Id_pred(node), n, set);
622 /* nothing: Die Operationen werden in "free_ana_walker" selbst
627 assert(0 && "unexpected opcode or opcode not implemented");
630 set_irn_link(node, NULL);
634 static void free_mark(ir_node * node, eset * set) {
636 // assert(mode_is_reference(get_irn_mode(node)));
637 if (get_irn_link(node) == MARK) {
638 return; /* already visited */
640 set_irn_link(node, MARK);
641 switch (get_irn_opcode(node)) {
643 entity * ent = get_Sel_entity(node);
644 if (is_method_type(get_entity_type(ent))) {
645 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
646 eset_insert(set, get_Sel_method(node, i));
652 if (get_SymConst_kind(node) == symconst_addr_ent) {
653 entity * ent = get_SymConst_entity(node);
654 if (is_method_type(get_entity_type(ent))) {
655 eset_insert(set, ent);
658 assert(get_SymConst_kind(node) == symconst_addr_name);
659 /* nothing: SymConst points to extern method */
664 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
665 free_mark(get_Phi_pred(node, i), set);
669 free_mark(get_Id_pred(node), set);
672 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
675 /* nothing: Wird unten behandelt! */
678 set_irn_link(node, NULL);
682 static void free_ana_walker(ir_node * node, eset * set) {
684 if (get_irn_link(node) == MARK) {
685 /* bereits in einem Zyklus besucht. */
688 switch (get_irn_opcode(node)) {
699 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
702 set_irn_link(node, MARK);
703 for (i = get_Call_arity(node) - 1; i >= 0; --i) {
704 ir_node * pred = get_Call_param(node, i);
705 if (mode_is_reference(get_irn_mode(pred))) {
706 free_mark(pred, set);
710 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
711 * jemand das Gegenteil implementiert. */
713 set_irn_link(node, MARK);
714 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
715 ir_node * pred = get_irn_n(node, i);
716 if (mode_is_reference(get_irn_mode(pred))) {
717 free_mark(pred, set);
722 set_irn_link(node, NULL);
726 /* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
727 * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
728 * SymConst-Operationen müssen in passende Const-Operationen
729 * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
730 * auf eine echt externe Methode. */
731 static entity ** get_free_methods(void)
733 eset * set = eset_create();
735 entity ** arr = NEW_ARR_F(entity *, 0);
738 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
739 ir_graph * irg = get_irp_irg(i);
740 entity * ent = get_irg_entity(irg);
741 /* insert "external visible" methods. */
742 if (get_entity_visibility(ent) != visibility_local) {
743 eset_insert(set, ent);
745 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
746 z.B. da die Adresse einer Methode abgespeichert wird. */
747 irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
750 /* insert sticky methods, too */
751 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
752 ir_graph * irg = get_irp_irg(i);
753 entity * ent = get_irg_entity(irg);
754 /* insert "external visible" methods. */
755 if (get_entity_stickyness (ent) == stickyness_sticky) {
756 eset_insert(set, ent);
760 /* Hauptprogramm ist auch dann frei, wenn es nicht "external
762 if (get_irp_main_irg()) {
763 eset_insert(set, get_irg_entity(get_irp_main_irg()));
765 /* Wandle Menge in Feld um. Effizienter. */
766 for (ent = eset_first(set); ent; ent = eset_next(set)) {
767 ARR_APP1(entity *, arr, ent);
774 void cgana(int *length, entity ***free_methods) {
775 entity ** free_meths, **p;
778 free_meths = get_free_methods();
780 sel_methods_dispose();
782 /* Convert the flexible array to an array that can be handled
784 p = (entity **)malloc(sizeof(*p) * ARR_LEN(free_meths));
785 memcpy(p, free_meths, ARR_LEN(free_meths) * sizeof(*p));
787 *length = ARR_LEN(free_meths);
790 DEL_ARR_F(free_meths);
795 static void destruct_walker(ir_node * node, void * env) {
796 if (get_irn_op(node) == op_Call) {
797 remove_Call_callee_arr(node);
801 void free_callee_info(ir_graph *irg) {
802 irg_walk_graph(irg, destruct_walker, NULL, NULL);
803 set_irg_callee_info_state(irg, irg_callee_info_none);
807 /* Optimize the address expressions passed to call nodes.
809 * This optimization performs the following transformations for
811 * - All SymConst operations that refer to intern methods are replaced
812 * by Const operations refering to the corresponding entity.
813 * - Sel nodes, that select entities that are not overwritten are
814 * replaced by Const nodes refering to the selected entity.
815 * - Sel nodes, for witch no method exists at all are replaced by Bad
817 * - Sel nodes with a pointer input that is an Alloc node are replaced
818 * by Const nodes refering to the entity that implements the method in
819 * the type given by the Alloc node.
821 void opt_call_addrs(void) {
823 sel_methods_dispose();
826 pmap * ldname_map = pmap_create();
827 assert(entities == NULL);
828 entities = eset_create();
829 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
830 entity * ent = get_irg_entity(get_irp_irg(i));
831 /* Nur extern sichtbare Methoden können überhaupt mit SymConst
832 * aufgerufen werden. */
833 if (get_entity_visibility(ent) != local) {
834 pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
837 all_irg_walk((irg_walk_func *) sel_methods_walker, NULL, ldname_map);
838 pmap_destroy(ldname_map);