never move around flag mofying nodes
[libfirm] / ir / ana / cgana.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief      Intraprozedural analyses to estimate the call graph.
23  * @author     Hubert Schmid
24  * @date       09.06.2002
25  * @version    $Id$
26  * @summary
27  *  Interprocedural analysis to estimate the calling relation.
28  *
29  *  This analysis computes all entities representing methods that
30  *  can be called at a Call node.  Further it computes a set of
31  *  methods that are 'free', i.e., their adress is handled by
32  *  the program directly, or they are visible external.
33  */
34 #ifdef HAVE_CONFIG_H
35 # include "config.h"
36 #endif
37
38 #ifdef HAVE_STRING_H
39 # include <string.h>
40 #endif
41
42 #include "cgana.h"
43 #include "rta.h"
44
45 #include "xmalloc.h"
46 #include "irnode_t.h"
47 #include "irmode_t.h"
48 #include "irprog_t.h"
49 #include "irgwalk.h"
50 #include "ircons.h"
51 #include "irgmod.h"
52 #include "iropt.h"
53
54 #include "irflag_t.h"
55 #include "dbginfo_t.h"
56 #include "iropt_dbg.h"
57
58 #include "eset.h"
59 #include "pmap.h"
60 #include "array.h"
61
62 #include "irdump.h"
63
64 #include "irhooks.h"
65
66
67
68 /* unambiguous address used as a mark. */
69 static void *MARK = &MARK;
70
71 static eset *entities = NULL;
72
73 /*--------------------------------------------------------------------------*/
74 /* The analysis                                                             */
75 /*--------------------------------------------------------------------------*/
76
77
78 /*--------------------------------------------------------------------------*/
79 /* Initialize datastructures, remove unwanted constructs, optimize          */
80 /* call target computations.                                                */
81 /*--------------------------------------------------------------------------*/
82
83 /** Returns the entity that contains the implementation of the inherited
84  *  entity if available, else returns the entity passed. */
85 static ir_entity *get_inherited_methods_implementation(ir_entity *inh_meth) {
86         assert(get_atomic_ent_value(inh_meth) && "constant entity without value");
87         assert((get_irn_op(get_atomic_ent_value(inh_meth)) == op_SymConst) &&
88                (get_SymConst_kind(get_atomic_ent_value(inh_meth)) == symconst_addr_ent) &&
89                "Complex constant values not supported -- address of method should be straight constant!");
90
91         return get_SymConst_entity(get_atomic_ent_value(inh_meth));
92 }
93
94 /** Collect the entity representing the implementation of this
95  *  method (not the same if inherited) and all entities for overwriting
96  *  implementations in "set".
97  *  If the implementation of the method is not included in the
98  *  compilation unit "open" is set to true.
99  *  A recursive descend in the overwritten relation.
100  *  Cycle-free, therefore must terminate.
101  *
102  * @param method
103  * @param set      A set of entities.
104  * @param size     Number of entities in set.
105  * @param open
106  */
107 static void collect_impls(ir_entity *method, eset *set, int *size, int *open) {
108         int i;
109         ir_entity *impl;
110
111         /* Add the implementation to the set if it contains an irg, else
112            remember that there are more methods called. */
113         impl = method;
114         if (get_entity_peculiarity(method) == peculiarity_inherited)
115                 impl = get_inherited_methods_implementation(method);
116
117         if (get_entity_peculiarity(method) != peculiarity_description) {
118                 eset_insert(set, impl);
119                 ++(*size);
120         }
121
122         /*- recursive descent -*/
123         for (i = get_entity_n_overwrittenby(method) - 1; i >= 0; --i)
124                 collect_impls(get_entity_overwrittenby(method, i), set, size, open);
125 }
126
127 /** Alle Methoden bestimmen, die die übergebene Methode überschreiben
128  *  (und implementieren). In der zurückgegebenen Reihung kommt jede
129  *  Methode nur einmal vor. Der Wert 'NULL' steht für unbekannte
130  *  (externe) Methoden. Die zurückgegebene Reihung muß vom Aufrufer
131  *  wieder freigegeben werden (siehe "DEL_ARR_F"). Gibt es überhaupt
132  *  keine Methoden, die "method" überschreiben, so gibt die Methode
133  *  "NULL" zurück.
134  *
135  *  @param method
136  */
137 static ir_entity ** get_impl_methods(ir_entity * method) {
138         eset * set = eset_create();
139         int size = 0;
140         ir_entity ** arr;
141         int open = 0;
142
143         /* Collect all method entities that can be called here */
144         collect_impls(method, set, &size, &open);
145
146         /* Vorgaenger einfuegen. */
147         if (size == 0 && !open) {
148                 /* keine implementierte überschriebene Methode */
149                 arr = NULL;
150         } else if (open) {
151                 ir_entity * ent;
152                 arr = NEW_ARR_F(ir_entity *, size + 1);
153                 arr[0] = NULL;  /* Represents open method */
154                 for (ent = eset_first(set); size > 0; ent = eset_next(set), --size)
155                         arr[size] = ent;
156         } else {
157                 ir_entity * ent;
158                 arr = NEW_ARR_F(ir_entity *, size);
159                 for (size -= 1, ent = eset_first(set); size >= 0; ent = eset_next(set), --size)
160                         arr[size] = ent;
161         }
162         eset_destroy(set);
163         return arr;
164 }
165
166 /** Analyze address computations.
167  *
168  *  Compute for all Sel nodes the set of methods that can be selected.
169  *  For each entity we store the set of subentities in the link field.
170  *
171  *  Further do some optimizations:
172  *  - Call standard optimizations for Sel nodes: this removes polymorphic
173  *    calls.
174  *  - If the node is a SymConst(name) replace it by SymConst(ent) if possible.
175  *    For this we precomputed a map name->entity.  Nowadays, we no more support
176  *    this and assert.
177  *  - If the node is a Sel:
178  *    If we found only a single method that can be called, replace the Sel
179  *    by a SymConst.  This is more powerful than the analysis in opt_polymorphy,
180  *    as here we walk the type graph.  In opt_polymorphy we only apply a local
181  *    pattern.
182  *
183  *  @param node The node to analyze
184  *  @param env  A map that maps names of entities to the entities.
185  */
186 static void sel_methods_walker(ir_node * node, void *env) {
187         pmap *ldname_map = env;
188         ir_entity **arr;
189
190         /* Call standard optimizations */
191         if (is_Sel(node)) {
192                 ir_node *new_node = optimize_in_place(node);
193                 if (node != new_node)
194                         exchange(node, new_node);
195         }
196
197         /* replace SymConst(name)-operations by SymConst(ent) */
198         if (get_irn_op(node) == op_SymConst) {
199                 if (get_SymConst_kind(node) == symconst_addr_name) {
200                         pmap_entry * entry = pmap_find(ldname_map, (void *) get_SymConst_name(node));
201                         if (entry != NULL) { /* Method is declared in the compiled code */
202                                 assert(0 && "There should not be a SymConst[addr_name] addressing a method with an implementation"
203                                         "in this compilation unit.  Use a SymConst[addr_ent].");
204                         }
205                 }
206         }
207         else if (get_irn_op(node) == op_Sel &&
208                 is_Method_type(get_entity_type(get_Sel_entity(node)))) {
209                         ir_entity * ent = get_SymConst_entity(get_atomic_ent_value(get_Sel_entity(node)));
210                         assert(get_entity_peculiarity(ent) != peculiarity_inherited);
211
212                         if (!eset_contains(entities, ent)) {
213                                 /* Entity not yet handled. Find all (internal or external)
214                                  * implemented methods that overwrites this entity.
215                                  * This set is stored in the entity link. */
216                                 set_entity_link(ent, get_impl_methods(ent));
217                                 eset_insert(entities, ent);
218                         }
219
220                         /* -- As an add on we get an optimization that removes polymorphic calls.
221                         This optimization is more powerful than that in transform_node_Sel().  -- */
222                         arr = get_entity_link(ent);
223                         if (arr == NULL) {
224                                 /*
225                                  * The Sel node never returns a pointer to a usable method.
226                                  * We could not call it, but it may be description:
227                                  * We call a method in a dead part of the program.
228                                  */
229                                 assert (get_entity_peculiarity(ent) == peculiarity_description);
230                         }
231                         else if (get_opt_optimize() && get_opt_closed_world() && get_opt_dyn_meth_dispatch() &&
232                                 (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
233                                         ir_node *new_node;
234
235                                         /*
236                                          * The Sel node returns only one possible method.
237                                          * So we could replace the Sel node by a SymConst.
238                                          * This method must exists.
239                                          */
240                                         set_irg_current_block(current_ir_graph, get_nodes_block(node));
241                                         assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
242                                                 peculiarity_existent);
243                                         new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(arr[0]));
244                                         DBG_OPT_POLY(node, new_node);
245                                         exchange(node, new_node);
246                         }
247         }
248 }
249
250 /** Initialize auxiliary data structures.
251  *
252  *  Computes a set of entities that overwrite an entity and contain
253  *  an implementation. The set is stored in the entity's link field.
254  *
255  *  Further replaces Sel nodes where this set contains exactly one
256  *  method by SymConst nodes.
257  *  Finally asserts if there is a SymConst(name) if there could be a
258  *  SymConst(ent). */
259 static void sel_methods_init(void) {
260         int i;
261         pmap * ldname_map = pmap_create();   /* Map entity names to entities: to replace
262                                                                                  SymConst(name) by SymConst(ent). */
263         assert(entities == NULL);
264         entities = eset_create();
265         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
266                 ir_entity * ent = get_irg_entity(get_irp_irg(i));
267                 /* only external visible methods are allowed to call by a SymConst_ptr_name */
268                 if (get_entity_visibility(ent) != visibility_local) {
269                         pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
270                 }
271         }
272
273         all_irg_walk(sel_methods_walker, NULL, ldname_map);
274         pmap_destroy(ldname_map);
275 }
276
277 /*--------------------------------------------------------------------------*/
278 /* Find free methods.
279  *
280  * We expect that each entity has an array with all implementations in its
281  * link field.                                                              */
282 /*--------------------------------------------------------------------------*/
283
284 /**
285  * Returns an array of all methods that could be called at a Sel node.
286  * This array contains every entry only once.
287  *
288  * @param sel  the Sel node
289  */
290 static ir_entity ** get_Sel_arr(ir_node * sel) {
291         static ir_entity ** NULL_ARRAY = NULL;
292         ir_entity * ent;
293         ir_entity ** arr;
294
295         assert(is_Sel(sel));
296         ent = get_Sel_entity(sel);
297         ent = get_inherited_methods_implementation(ent);
298
299         assert(is_Method_type(get_entity_type(ent))); /* what else? */
300         arr = get_entity_link(ent);
301         if (arr) {
302                 return arr;
303         } else {
304                 /* "NULL" zeigt an, dass keine Implementierung existiert. Dies
305                  * kann für polymorphe (abstrakte) Methoden passieren. */
306                 if (!NULL_ARRAY) {
307                         NULL_ARRAY = NEW_ARR_F(ir_entity *, 0);
308                 }
309                 return NULL_ARRAY;
310         }
311 }
312
313 /**
314  * Returns the number of possible called methods at a Sel node.
315  *
316  * @param sel  the Sel node
317  */
318 static int get_Sel_n_methods(ir_node * sel) {
319         return ARR_LEN(get_Sel_arr(sel));
320 }
321
322 /**
323  * Returns the ith possible called method entity at a Sel node.
324  */
325 static ir_entity * get_Sel_method(ir_node * sel, int pos) {
326         ir_entity ** arr = get_Sel_arr(sel);
327         assert(pos >= 0 && pos < ARR_LEN(arr));
328         return arr[pos];
329 }
330
331 static void free_mark(ir_node * node, eset * set);
332
333 static void free_mark_proj(ir_node * node, long n, eset * set) {
334         assert(get_irn_mode(node) == mode_T);
335         if (get_irn_link(node) == MARK) {
336                 /* already visited */
337                 return;
338         }
339         set_irn_link(node, MARK);
340         switch (get_irn_opcode(node)) {
341         case iro_Proj: {
342                 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
343                  * op_Tuple oder ein Knoten, der in "free_ana_walker" behandelt
344                  * wird. */
345                 ir_node * pred = get_Proj_pred(node);
346                 if (get_irn_link(pred) != MARK && get_irn_op(pred) == op_Tuple) {
347                         free_mark_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, set);
348                 } else {
349                         /* nothing: da in "free_ana_walker" behandelt. */
350                 }
351                 break;
352         }
353
354         case iro_Tuple:
355                 free_mark(get_Tuple_pred(node, n), set);
356                 break;
357
358         case iro_Id:
359                 free_mark_proj(get_Id_pred(node), n, set);
360                 break;
361
362         case iro_Start:
363         case iro_Alloc:
364         case iro_Load:
365                 /* nothing: Die Operationen werden in free_ana_walker() selbst
366                  * behandelt. */
367                 break;
368
369         default:
370                 assert(0 && "unexpected opcode or opcode not implemented");
371                 break;
372         }
373         set_irn_link(node, NULL);
374 }
375
376 /**
377  * Called for predecessors nodes of "interesting" ones.
378  * Interesting ones include all nodes that can somehow make
379  * a method visible.
380  *
381  * If a method (or a set of methods in case of polymorph calls) gets visible,
382  * add it to the set of 'free' methods
383  *
384  * @param node  the current visited node
385  * @param set   the set of all free methods
386  */
387 static void free_mark(ir_node *node, eset * set) {
388         int i;
389
390         if (get_irn_link(node) == MARK)
391                 return; /* already visited */
392
393         set_irn_link(node, MARK);
394
395         switch (get_irn_opcode(node)) {
396         case iro_Sel: {
397                 ir_entity * ent = get_Sel_entity(node);
398                 if (is_Method_type(get_entity_type(ent))) {
399                         for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
400                                 eset_insert(set, get_Sel_method(node, i));
401                         }
402                 }
403                 break;
404                                   }
405         case iro_SymConst:
406                 if (get_SymConst_kind(node) == symconst_addr_ent) {
407                         ir_entity * ent = get_SymConst_entity(node);
408                         if (is_Method_type(get_entity_type(ent))) {
409                                 eset_insert(set, ent);
410                         }
411                 } else {
412                         assert(get_SymConst_kind(node) == symconst_addr_name);
413                         /* nothing: SymConst points to extern method */
414                 }
415                 break;
416
417         case iro_Phi:
418                 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
419                         free_mark(get_Phi_pred(node, i), set);
420                 }
421                 break;
422         case iro_Id:
423                 free_mark(get_Id_pred(node), set);
424                 break;
425         case iro_Proj:
426                 free_mark_proj(get_Proj_pred(node), get_Proj_proj(node), set);
427                 break;
428         default:
429                 /* nothing: Wird unten behandelt! */
430                 break;
431         }
432         set_irn_link(node, NULL);
433 }
434
435 /**
436  * post-walker. Find method addresses.
437  */
438 static void free_ana_walker(ir_node *node, void *env) {
439         eset *set = env;
440         int i;
441
442         if (get_irn_link(node) == MARK) {
443                 /* already visited */
444                 return;
445         }
446         switch (get_irn_opcode(node)) {
447                 /* special nodes */
448         case iro_Sel:
449         case iro_SymConst:
450         case iro_Const:
451         case iro_Phi:
452         case iro_Id:
453         case iro_Proj:
454         case iro_Tuple:
455                 /* nothing */
456                 break;
457                 /* Sonderbehandlung, da der Funktionszeigereingang natürlich kein
458                  * Verräter ist. */
459         case iro_Call:
460                 set_irn_link(node, MARK);
461                 for (i = get_Call_n_params(node) - 1; i >= 0; --i) {
462                         ir_node *pred = get_Call_param(node, i);
463                         if (mode_is_reference(get_irn_mode(pred))) {
464                                 free_mark(pred, set);
465                         }
466                 }
467                 break;
468                 /* other nodes: Alle anderen Knoten nehmen wir als Verräter an, bis
469                  * jemand das Gegenteil implementiert. */
470         default:
471                 set_irn_link(node, MARK);
472                 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
473                         ir_node * pred = get_irn_n(node, i);
474                         if (mode_is_reference(get_irn_mode(pred))) {
475                                 free_mark(pred, set);
476                         }
477                 }
478                 break;
479         }
480         set_irn_link(node, NULL);
481 }
482
483 /**
484  * Add all method addresses in global initializers to the set.
485  *
486  * @note
487  * We do NOT check the type here, just it it's an entity address.
488  * The reason for this is code like:
489  *
490  * void *p = function;
491  *
492  * which is sometimes used to anchor functions.
493  */
494 static void add_method_address(ir_entity *ent, eset *set)
495 {
496         ir_node *n;
497         ir_type *tp;
498         int i;
499
500         /* do not check uninitialized values */
501         if (get_entity_variability(ent) == variability_uninitialized)
502                 return;
503
504         if (is_atomic_entity(ent)) {
505                 tp = get_entity_type(ent);
506
507                 /* ignore methods: these of course reference it's address */
508                 if (is_Method_type(tp))
509                         return;
510
511                 /* let's check if it's the address of a function */
512                 n = get_atomic_ent_value(ent);
513                 if (is_SymConst(n) && get_SymConst_kind(n) == symconst_addr_ent) {
514                         ent = get_SymConst_entity(n);
515
516                         if (is_Method_type(get_entity_type(ent)))
517                                 eset_insert(set, ent);
518                 }
519         } else {
520                 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
521                         n = get_compound_ent_value(ent, i);
522
523                         /* let's check if it's the address of a function */
524                         if (is_SymConst(n) && get_SymConst_kind(n) == symconst_addr_ent) {
525                                 ir_entity *ent = get_SymConst_entity(n);
526
527                                 if (is_Method_type(get_entity_type(ent)))
528                                         eset_insert(set, ent);
529                         }
530                 }
531         }
532 }
533
534 /**
535  * returns a list of 'free' methods, i.e., the methods that can be called
536  * from external or via function pointers.
537  *
538  * Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
539  * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
540  * SymConst(name)-Operationen müssen in passende SymConst(ent)-Operationen
541  * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
542  * auf eine echt externe Methode.
543  */
544 static ir_entity ** get_free_methods(void)
545 {
546         eset *free_set = eset_create();
547         int i;
548         ir_entity **arr = NEW_ARR_F(ir_entity *, 0);
549         ir_entity *ent;
550         ir_graph *irg;
551         ir_type *glob;
552
553         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
554                 irg = get_irp_irg(i);
555                 ent = get_irg_entity(irg);
556                 /* insert "external visible" methods. */
557                 if (get_entity_visibility(ent) != visibility_local) {
558                         eset_insert(free_set, ent);
559                 }
560                 /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
561                    z.B. da die Adresse einer Methode abgespeichert wird. */
562                 irg_walk_graph(irg, NULL, free_ana_walker, free_set);
563         }
564
565         /* insert sticky methods, too */
566         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
567                 ent = get_irg_entity(get_irp_irg(i));
568                 /* insert "sticky" methods. */
569                 if (get_entity_stickyness (ent) == stickyness_sticky) {
570                         eset_insert(free_set, ent);
571                 }
572         }
573
574         /* insert all methods that are used in global variables initializers */
575         glob = get_glob_type();
576         for (i = get_class_n_members(glob) - 1; i >= 0; --i) {
577                 ent = get_class_member(glob, i);
578
579                 add_method_address(ent, free_set);
580         }
581
582         /* the main program is even then "free", if it's not external visible. */
583         irg = get_irp_main_irg();
584         if (irg)
585                 eset_insert(free_set, get_irg_entity(irg));
586
587         /* Finally, transform the set into an array. */
588         for (ent = eset_first(free_set); ent; ent = eset_next(free_set)) {
589                 ARR_APP1(ir_entity *, arr, ent);
590         }
591         eset_destroy(free_set);
592
593         return arr;
594 }
595
596 /*--------------------------------------------------------------------------*/
597 /* Callee analysis.                                                         */
598 /*--------------------------------------------------------------------------*/
599
600 static void callee_ana_node(ir_node * node, eset * methods);
601
602 static void callee_ana_proj(ir_node * node, long n, eset * methods) {
603         assert(get_irn_mode(node) == mode_T);
604         if (get_irn_link(node) == MARK) {
605                 /* already visited */
606                 return;
607         }
608         set_irn_link(node, MARK);
609
610         switch (get_irn_opcode(node)) {
611         case iro_Proj: {
612                 /* proj_proj: in einem "sinnvollen" Graphen kommt jetzt ein
613                  * op_Tuple oder ein Knoten, der eine "freie Methode"
614                  * zurückgibt. */
615                 ir_node * pred = get_Proj_pred(node);
616                 if (get_irn_link(pred) != MARK) {
617                         if (get_irn_op(pred) == op_Tuple) {
618                                 callee_ana_proj(get_Tuple_pred(pred, get_Proj_proj(node)), n, methods);
619                         } else {
620                                 eset_insert(methods, MARK); /* free method -> unknown */
621                         }
622                 }
623                 break;
624                                    }
625
626         case iro_Tuple:
627                 callee_ana_node(get_Tuple_pred(node, n), methods);
628                 break;
629
630         case iro_Id:
631                 callee_ana_proj(get_Id_pred(node), n, methods);
632                 break;
633
634         default:
635                 eset_insert(methods, MARK); /* free method -> unknown */
636                 break;
637         }
638
639         set_irn_link(node, NULL);
640 }
641
642 /**
643  * Analyse a Call address.
644  *
645  * @param node     the node representing the call address
646  * @param methods  after call contains the set of all possibly called entities
647  */
648 static void callee_ana_node(ir_node *node, eset *methods) {
649         int i;
650
651         assert(mode_is_reference(get_irn_mode(node)) || is_Bad(node));
652         /* Beware of recursion */
653         if (get_irn_link(node) == MARK) {
654                 /* already visited */
655                 return;
656         }
657         set_irn_link(node, MARK);
658
659         switch (get_irn_opcode(node)) {
660         case iro_Const:
661                 /* A direct address call. We tread this as an external
662                 call and ignore it completely. */
663                 eset_insert(methods, MARK); /* free method -> unknown */
664                 break;
665         case iro_SymConst:
666                 if (get_SymConst_kind(node) == symconst_addr_ent) {
667                         ir_entity *ent = get_SymConst_entity(node);
668                         assert(ent && is_Method_type(get_entity_type(ent)));
669                         eset_insert(methods, ent);
670                 } else {
671                         assert(get_SymConst_kind(node) == symconst_addr_name);
672                         /* externe Methode (wegen fix_symconst!) */
673                         eset_insert(methods, MARK); /* free method -> unknown */
674                 }
675                 break;
676         case iro_Sel:
677                 /* polymorphe Methode */
678                 for (i = get_Sel_n_methods(node) - 1; i >= 0; --i) {
679                         ir_entity * ent = get_Sel_method(node, i);
680                         if (ent) {
681                                 eset_insert(methods, ent);
682                         } else {
683                                 eset_insert(methods, MARK);
684                         }
685                 }
686                 break;
687
688         case iro_Bad:
689                 /* nothing */
690                 break;
691
692         case iro_Phi:
693                 for (i = get_Phi_n_preds(node) - 1; i >= 0; --i) {
694                         callee_ana_node(get_Phi_pred(node, i), methods);
695                 }
696                 break;
697
698         case iro_Mux:
699                 callee_ana_node(get_Mux_false(node), methods);
700                 callee_ana_node(get_Mux_true(node), methods);
701                 break;
702
703         case iro_Psi:
704                 for (i = get_Psi_n_conds(node) - 1; i >= 0; --i) {
705                         callee_ana_node(get_Psi_val(node, i), methods);
706                 }
707                 callee_ana_node(get_Psi_default(node), methods);
708                 break;
709
710         case iro_Id:
711                 callee_ana_node(get_Id_pred(node), methods);
712                 break;
713
714         case iro_Proj:
715                 callee_ana_proj(get_Proj_pred(node), get_Proj_proj(node), methods);
716                 break;
717
718         case iro_Add:
719         case iro_Sub:
720         case iro_Conv:
721                 /* extern */
722                 eset_insert(methods, MARK); /* free method -> unknown */
723                 break;
724
725         default:
726                 assert(0 && "invalid opcode or opcode not implemented");
727                 break;
728         }
729
730         set_irn_link(node, NULL);
731 }
732
733 /**
734  * Walker: Analyses every call node and calculates an array of possible
735  * callees for that call.
736  */
737 static void callee_walker(ir_node * call, void * env) {
738         (void) env;
739         if (is_Call(call)) {
740                 eset * methods = eset_create();
741                 ir_entity * ent;
742                 ir_entity ** arr = NEW_ARR_F(ir_entity *, 0);
743                 assert(get_irn_op(get_Call_ptr(call)) != op_Id);
744                 callee_ana_node(get_Call_ptr(call), methods);
745                 if (eset_contains(methods, MARK)) { /* unknown method */
746                         ARR_APP1(ir_entity *, arr, unknown_entity);
747                 }
748                 for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
749                         if (ent != MARK) {
750                                 ARR_APP1(ir_entity *, arr, ent);
751                         }
752                 }
753 #if 0  /* This generates Bad nodes when we don't want it.
754                   Call it with a check for valid cgana information in local_optimize. */
755                 if (ARR_LEN(arr) == 0 && get_opt_optimize() && get_opt_closed_world() && get_opt_dyn_meth_dispatch()) {
756                         /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
757                          * Sel-Operation war, die keine Methoden zurückgeben
758                          * konnte. Wir ersetzen die Call-Operation ebenfalls durch
759                          * eine Bad-Operation. Die Verlinkung muss wiederhergestellt
760                          * werden! */
761                         ir_node *mem = get_Call_mem(call);
762                         ir_node *blk = get_nodes_block(call);
763                         turn_into_tuple (call, pn_Call_max);
764                         set_Tuple_pred(call, pn_Call_M_regular       , mem);
765                         set_Tuple_pred(call, pn_Call_T_result        , new_Bad());
766                         set_Tuple_pred(call, pn_Call_P_value_res_base, new_Bad());
767                         set_Tuple_pred(call, pn_Call_X_regular       , new_r_Jmp(current_ir_graph, blk));
768                         set_Tuple_pred(call, pn_Call_X_except        , new_Bad());  /* new_Jmp() ?? new_Raise() ?? */
769                         set_Tuple_pred(call, pn_Call_M_except        , new_Bad());
770
771                 } else
772 #endif
773                 {
774                         set_Call_callee_arr(call, ARR_LEN(arr), arr);
775                 }
776                 DEL_ARR_F(arr);
777                 eset_destroy(methods);
778         }
779 }
780
781 /**
782  * Walker: Removes all tuple.
783  */
784 static void remove_Tuples(ir_node *proj, void *env) {
785         ir_node *nn;
786         (void) env;
787         if (! is_Proj(proj)) return;
788
789         nn = skip_Tuple(proj);
790         if (nn != proj) exchange(proj, nn);
791 }
792
793
794 /* Bestimmt für jede Call-Operation die Menge der aufrufbaren Methode
795  * und speichert das Ergebnis in der Call-Operation. (siehe
796  * "set_Call_callee"). "sel_methods" wird für den Aufbau benötigt und
797  * muss bereits aufgebaut sein. */
798 static void callee_ana(void) {
799         int i;
800         /* Alle Graphen analysieren. */
801         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
802                 ir_graph *irg = get_irp_irg(i);
803                 irg_walk_graph(irg, callee_walker, remove_Tuples, NULL);
804                 set_irg_callee_info_state(irg, irg_callee_info_consistent);
805         }
806         set_irp_callee_info_state(irg_callee_info_consistent);
807 }
808
809 /*--------------------------------------------------------------------------*/
810 /* Cleanup after analyses.                                                  */
811 /*--------------------------------------------------------------------------*/
812
813 /** Frees intermediate data structures. */
814 static void sel_methods_dispose(void) {
815         ir_entity * ent;
816         assert(entities);
817         for (ent = eset_first(entities); ent; ent = eset_next(entities)) {
818                 ir_entity ** arr = get_entity_link(ent);
819                 if (arr) {
820                         DEL_ARR_F(arr);
821                 }
822                 set_entity_link(ent, NULL);
823         }
824         eset_destroy(entities);
825         entities = NULL;
826 }
827
828 /*--------------------------------------------------------------------------*/
829 /* Freeing the callee arrays.                                               */
830 /*--------------------------------------------------------------------------*/
831
832 static void destruct_walker(ir_node * node, void * env) {
833         (void) env;
834         if (is_Call(node)) {
835                 remove_Call_callee_arr(node);
836         }
837 }
838
839 /*--------------------------------------------------------------------------*/
840 /* Main drivers.                                                            */
841 /*--------------------------------------------------------------------------*/
842
843 void cgana(int *length, ir_entity ***free_methods) {
844         ir_entity ** free_meths, **p;
845
846         /* Optimize Sel/SymConst nodes and compute all methods that implement an entity. */
847         sel_methods_init();
848         free_meths = get_free_methods();
849         callee_ana();
850         sel_methods_dispose();
851
852         /* Convert the flexible array to an array that can be handled
853            by standard C. */
854         p = xmalloc(sizeof(*p) * ARR_LEN(free_meths));
855         memcpy(p, free_meths, ARR_LEN(free_meths) * sizeof(*p));
856
857         *length       = ARR_LEN(free_meths);
858         *free_methods = p;
859
860         DEL_ARR_F(free_meths);
861 }
862
863 void free_callee_info(ir_graph *irg) {
864         irg_walk_graph(irg, destruct_walker, NULL, NULL);
865         set_irg_callee_info_state(irg, irg_callee_info_none);
866 }
867
868 void free_irp_callee_info(void) {
869         int i;
870         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
871                 free_callee_info(get_irp_irg(i));
872         }
873 }
874
875 /* Optimize the address expressions passed to call nodes.
876  *
877  * This optimization performs the following transformations for
878  * all ir graphs:
879  * - All SymConst operations that refer to intern methods are replaced
880  *   by Const operations referring to the corresponding entity.
881  * - Sel nodes, that select entities that are not overwritten are
882  *   replaced by Const nodes referring to the selected entity.
883  * - Sel nodes, for which no method exists at all are replaced by Bad
884  *   nodes.
885  * - Sel nodes with a pointer input that is an Alloc node are replaced
886  *   by Const nodes referring to the entity that implements the method in
887  *   the type given by the Alloc node.
888  */
889 void opt_call_addrs(void) {
890         sel_methods_init();
891         sel_methods_dispose();
892 }