update copyright message
[libfirm] / ir / ir / ircgcons.c
1 /*
2  * Copyright (C) 1995-2008 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   Construction and removal of interprocedural representation
23  *          (explicit interprocedural dependencies).
24  * @author  Hubert Schmid
25  * @date    09.06.2002
26  * @version $Id$
27  */
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #ifdef INTERPROCEDURAL_VIEW
33
34 #include <string.h>
35 #include <stdbool.h>
36 #include "ircgcons.h"
37
38 #include "array.h"
39 #include "irprog.h"
40 #include "irnode_t.h"
41 #include "irprog_t.h"
42 #include "ircons_t.h"
43 #include "irgmod.h"
44 #include "irgwalk.h"
45 #include "irflag_t.h"
46 #include "irtools.h"
47
48 /* Return the current state of the interprocedural view. */
49 ip_view_state get_irp_ip_view_state(void) {
50   return irp->ip_view;
51 }
52
53 /* Set the current state of the interprocedural view. */
54 static void set_irp_ip_view(ip_view_state state) {
55   irp->ip_view = state;
56 }
57
58 /* Set the state of the interprocedural view to invalid. */
59 void set_irp_ip_view_invalid(void) {
60   set_irp_ip_view(ip_view_invalid);
61 }
62
63
64 /* Data for each method */
65 typedef struct {
66   int count;                      /* Number of calleers. */
67   bool open;                      /* Open method: called by an unknown caller */
68   ir_node * reg, * mem, ** res;   /* EndReg, Mem and Method return values */
69   ir_node * except, * except_mem; /* EndExcept and Mem for exception return */
70 } irg_data_t;
71
72 static irg_data_t * irg_data_create(void) {
73   irg_data_t *data = xmalloc(sizeof(*data));
74   memset(data, 0, sizeof(*data)); /* init */
75   return data;
76 }
77
78 /** Count the number of callers of each method and mark open methods.
79  *
80  *  Fills the irg_data data structure.
81  *  Open methods are methods with an unknown caller, I.e., methods that
82  *   - are external visible
83  *   - are dereferenced somewhere within the program (i.e., the address of the
84  *     method is stored somewhere). */
85 static void caller_init(int arr_length, ir_entity ** free_methods) {
86   int i, j;
87   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
88     set_entity_link(get_irg_entity(get_irp_irg(i)), irg_data_create());
89   }
90   for (i = arr_length - 1; i >= 0; --i) {
91     irg_data_t * data = get_entity_link(free_methods[i]);
92     data->open = true;
93   }
94   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
95     ir_graph * irg = get_irp_irg(i);
96     ir_node * call;
97     /* We collected all call nodes in a link list at the end node. */
98     for (call = get_irn_link(get_irg_end(irg)); call; call = get_irn_link(call)) {
99       if (get_irn_op(call) != op_Call) continue;
100       for (j = get_Call_n_callees(call) - 1; j >= 0; --j) {
101         ir_entity * ent = get_Call_callee(call, j);
102         if (get_entity_irg(ent)) {
103           irg_data_t * data = get_entity_link(ent);
104 # ifndef CATE_jni
105           assert(get_entity_irg(ent) && data);
106           ++data->count;
107 # endif /* ndef CATE_jni */
108         } else {
109           set_entity_link(ent, NULL);
110         }
111       }
112     }
113   }
114 }
115
116 /*
117 static INLINE ir_node * tail(ir_node * node) {
118   ir_node * link;
119   for (; (link = get_irn_link(node)); node = link) ;
120   return node;
121 }
122 */
123
124 /* Call-Operationen an die "link"-Liste von "call_tail" anhängen (und
125  * "call_tail" aktualisieren), Proj-Operationen in die Liste ihrer Definition
126  * (auch bei Proj->Call Operationen) und Phi-Operationen in die Liste ihres
127  * Grundblocks einfügen. */
128 static void collect_phicallproj_walker(ir_node * node, ir_node ** call_tail) {
129   if (get_irn_op(node) == op_Call) {
130     /* Die Liste von Call an call_tail anhängen. */
131     ir_node * link;
132     assert(get_irn_link(*call_tail) == NULL);
133     set_irn_link(*call_tail, node);
134     /* call_tail aktualisieren: */
135     for (link = get_irn_link(*call_tail); link; *call_tail = link, link = get_irn_link(link)) ;
136   } else if (get_irn_op(node) == op_Proj) {
137     ir_node * head = skip_Proj(get_Proj_pred(node));
138     set_irn_link(node, get_irn_link(head));
139     set_irn_link(head, node);
140     /* call_tail gegebenenfalls aktualisieren: */
141     if (head == *call_tail) {
142       *call_tail = node;
143     }
144   } else if (get_irn_op(node) == op_Phi) {
145     ir_node * block = get_nodes_block(node);
146     set_irn_link(node, get_irn_link(block));
147     set_irn_link(block, node);
148   }
149 }
150
151
152 static void link(ir_node * head, ir_node * node) {
153   if (node) {
154     set_irn_link(node, get_irn_link(head));
155     set_irn_link(head, node);
156   }
157 }
158
159
160 /* Die Call-Operationen aller Graphen an den End-Operationen
161  * verlinken, die Proj-Operationen an ihren Definitionen und die
162  * Phi-Operationen an ihren Grundblöcken. Die Liste der Calls sieht
163  * dann so aus: End -> Call -> Proj -> ... -> Proj -> Call -> Proj ->
164  * ... -> Proj -> NULL. */
165 static void collect_phicallproj(void) {
166   int i;
167
168   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
169     ir_graph * irg = get_irp_irg(i);
170     ir_node * start = get_irg_start(irg);
171     ir_node * end = get_irg_end(irg);
172     current_ir_graph = irg;
173     assert(irg && start);
174
175         set_using_irn_link(irg);
176
177     /* Die speziellen Parameter der Start-Operation extra verlinken,
178      * auch wenn sie nicht im intraprozeduralen Graphen erreichbar
179      * sind. */
180     link(start, get_irg_frame(irg));
181     link(start, get_irg_globals(irg));
182     /* walk */
183     irg_walk_graph(irg, firm_clear_link, (irg_walk_func *) collect_phicallproj_walker, &end);
184
185         clear_using_irn_link(irg);
186   }
187 }
188
189
190 /* Proj-Operation durch Filter-Operation im aktuellen Block ersetzen. */
191 static ir_node * exchange_proj(ir_node * proj) {
192   ir_node * filter;
193   assert(get_irn_op(proj) == op_Proj);
194   filter = new_Filter(get_Proj_pred(proj), get_irn_mode(proj), get_Proj_proj(proj));
195   /* Die Proj- (Id-) Operation sollte im gleichen Grundblock stehen, wie die
196    * Filter-Operation. */
197   set_nodes_block(proj, get_nodes_block(filter));
198   exchange(proj, filter);
199   return filter;
200 }
201
202
203 /* Echt neue Block-Operation erzeugen. CSE abschalten! */
204 static ir_node * create_Block(int n, ir_node ** in) {
205   /* Turn off optimizations so that blocks are not merged again. */
206   int rem_opt = get_opt_optimize();
207   ir_node * block;
208   set_optimize(0);
209   block = new_Block(n, in);
210   set_optimize(rem_opt);
211   return block;
212 }
213
214
215 static void prepare_irg_end(ir_graph * irg, irg_data_t * data);
216 static void prepare_irg_end_except(ir_graph * irg, irg_data_t * data);
217
218
219 /* If we use new_Unknown we get the Unknown of a graph.  This can
220  * cause cycles we don't want to see, as Unknwon is in the Start Block
221  * of the procedure. Use unknown of outermost irg where the start
222  * block has no predecessors. */
223 static INLINE ir_node *get_cg_Unknown(ir_mode *m) {
224   assert((get_Block_n_cfgpreds(get_irg_start_block(get_irp_main_irg())) == 1) &&
225          (get_nodes_block(get_Block_cfgpred(get_irg_start_block(get_irp_main_irg()), 0)) ==
226           get_irg_start_block(get_irp_main_irg())));
227   return new_r_Unknown(get_irp_main_irg(), m);
228 }
229
230
231 /* IRG vorbereiten. Proj-Operationen der Start-Operation in Filter-Operationen
232  * umwandeln. Die künstlichen Steuerzusammenflüsse EndReg und EndExcept
233  * einfügen. An der Start-Operation hängt nach dem Aufruf eine Liste der
234  * entsprechenden Filter-Knoten. */
235 static void prepare_irg(ir_graph * irg, irg_data_t * data) {
236   ir_node * start_block = get_irg_start_block(irg);
237   ir_node * link, * proj;
238   int n_callers = data->count + (data->open ? 1 : 0);
239   ir_node ** in = NEW_ARR_F(ir_node *, n_callers);
240
241   current_ir_graph = irg;
242   set_irg_current_block(irg, start_block);
243
244   /* Grundblock interprozedural machen. */
245   /* "in" ist nicht initialisiert. Das passiert erst in "construct_start". */
246   set_Block_cg_cfgpred_arr(start_block, n_callers, in);
247   /* Proj-Operationen durch Filter-Operationen ersetzen und (sonst) in
248    * den Start-Block verschieben. */
249   for (proj = get_irn_link(get_irg_start(irg)); proj; proj = get_irn_link(proj)) {
250     if (get_Proj_pred(proj) != get_irg_start(irg)
251     || (get_Proj_proj(proj) != pn_Start_X_initial_exec && get_Proj_proj(proj) != pn_Start_T_args)) {
252       ir_node * filter = exchange_proj(proj);
253       set_Filter_cg_pred_arr(filter, n_callers, in);
254     } else {
255       set_nodes_block(proj, start_block);
256     }
257   }
258
259   DEL_ARR_F(in);
260
261   /* Liste der Filter-Operationen herstellen. Dabei muss man beachten,
262    * dass oben für "verschiedene" Proj-Operationen wegen CSE nur eine
263    * Filter-Operation erzeugt worden sein kann. */
264   for (link = get_irg_start(irg), proj = get_irn_link(link); proj; proj = get_irn_link(proj)) {
265     if (get_irn_op(proj) == op_Id) { /* replaced with filter */
266       ir_node * filter = get_Id_pred(proj);
267       assert(get_irn_op(filter) == op_Filter);
268       if (filter != link && get_irn_link(filter) == NULL) {
269     set_irn_link(link, filter);
270     link = filter;
271       }
272     }
273   }
274   /* Globle Einträge für ersetzte Operationen korrigieren. */
275   set_irg_frame      (irg, skip_Id(get_irg_frame(irg)));
276   set_irg_globals    (irg, skip_Id(get_irg_globals(irg)));
277   set_irg_initial_mem(irg, skip_Id(get_irg_initial_mem(irg)));
278
279   /* Unbekannten Aufrufer sofort eintragen. */
280   if (data->open) {
281     set_Block_cg_cfgpred(start_block, 0, get_cg_Unknown(mode_X));
282     for (proj = get_irn_link(get_irg_start(irg)); proj; proj = get_irn_link(proj)) {
283       if (get_irn_op(proj) == op_Filter) {
284     set_Filter_cg_pred(proj, 0, get_cg_Unknown(get_irn_mode(proj)));
285       }
286     }
287     data->count = 1;
288   } else {
289     data->count = 0;
290   }
291
292   prepare_irg_end(irg, data);
293   prepare_irg_end_except(irg, data);
294 }
295
296
297 /* Künstlicher Steuerzusammenfluss EndReg einfügen. */
298 static void prepare_irg_end(ir_graph * irg, irg_data_t * data) {
299   ir_node * end_block   = get_irg_end_block(irg);
300   ir_node * end         = get_irg_end(irg);
301   ir_node **ret_arr     = NULL;
302   ir_node **cfgpred_arr = get_Block_cfgpred_arr(end_block);
303   int i, j;
304   int n_ret = 0;
305
306   for (i = get_Block_n_cfgpreds(end_block) - 1; i >= 0; --i) {
307     if (is_Return(cfgpred_arr[i])) {
308       if (ret_arr) {
309         ARR_APP1(ir_node *, ret_arr, cfgpred_arr[i]);
310       } else {
311         ret_arr = NEW_ARR_F(ir_node *, 1);
312         ret_arr[0] = cfgpred_arr[i];
313       }
314       ++n_ret;
315     }
316   }
317
318   if (n_ret > 0) {
319     int n_res = get_method_n_ress(get_entity_type(get_irg_entity(irg)));
320     ir_node ** in = NEW_ARR_F(ir_node *, n_ret);
321
322     /* block */
323     for (i = n_ret - 1; i >= 0; --i) {
324       set_irg_current_block(irg, get_nodes_block(ret_arr[i]));
325       in[i] = new_Jmp();
326     }
327     create_Block(n_ret, in);
328
329     /* end */
330     data->reg = new_EndReg();
331
332     /* mem */
333     for (i = n_ret - 1; i >= 0; --i) {
334       in[i] = get_Return_mem(ret_arr[i]);
335     }
336     data->mem = new_Phi(n_ret, in, mode_M);
337     /* This Phi is a merge, therefore needs not be kept alive.
338        It might be optimized away, though.  */
339     if (get_End_keepalive(end, get_End_n_keepalives(end)-1 ) == data->mem)
340       set_End_keepalive(end, get_End_n_keepalives(end)-1, new_Bad());
341
342     /* res */
343     data->res = NEW_ARR_F(ir_node *, n_res);
344     for (j = n_res - 1; j >= 0; --j) {
345       ir_mode *mode = NULL;
346       /* In[0] could be a Bad node with wrong mode. */
347       for (i = n_ret - 1; i >= 0; --i) {
348         in[i] = get_Return_res(ret_arr[i], j);
349         if (!mode && get_irn_mode(in[i]) != mode_T)
350           mode = get_irn_mode(in[i]);
351       }
352       if (mode)
353         data->res[j] = new_Phi(n_ret, in, mode);
354       else  /* All preds are Bad */
355         data->res[j] = new_Bad();
356     }
357
358     DEL_ARR_F(in);
359   }
360
361   if (ret_arr) DEL_ARR_F(ret_arr);
362 }
363
364
365 /* Künstlicher Steuerzusammenfluss EndExcept einfügen. */
366 static void prepare_irg_end_except(ir_graph * irg, irg_data_t * data) {
367   ir_node * end_block = get_irg_end_block(irg);
368   ir_node * end = get_irg_end(irg);
369   ir_node ** except_arr = NULL;
370   int i;
371   int n_except = 0;
372   ir_node ** cfgpred_arr = get_Block_cfgpred_arr(end_block);
373   for (i = get_Block_n_cfgpreds(end_block) - 1; i >= 0; --i) {
374     if (! is_Return(cfgpred_arr[i])) {
375       if (except_arr) {
376         ARR_APP1(ir_node *, except_arr, cfgpred_arr[i]);
377       } else {
378         except_arr = NEW_ARR_F(ir_node *, 1);
379         except_arr[0] = cfgpred_arr[i];
380       }
381       ++n_except;
382     }
383   }
384   if (n_except > 0) {
385     ir_node ** in = NEW_ARR_F(ir_node *, n_except);
386     /* block */
387     create_Block(n_except, except_arr);
388     /* end_except */
389     data->except = new_EndExcept();
390     /* mem */
391     for (i = n_except - 1; i >= 0; --i) {
392       ir_node *node = skip_Proj(skip_Tuple(except_arr[i]));
393       ir_op *op = get_irn_op(node);
394       if (op == op_Call) {
395         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, pn_Call_M_except);
396       } else if (op == op_Raise) {
397         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, pn_Raise_M);
398       } else if (op == op_CopyB) {
399         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, pn_CopyB_M_except);
400       } else {
401         assert(is_fragile_op(node));
402         /* We rely that all cfops have the memory output at the same position. */
403         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, 0);
404       }
405     }
406     data->except_mem = new_Phi(n_except, in, mode_M);
407     /* This Phi is a merge, therefor needs not be kept alive.
408        It might be optimized away, though.  */
409     if (get_End_keepalive(end, get_End_n_keepalives(end)-1 )
410     == data->except_mem)
411       set_End_keepalive(end, get_End_n_keepalives(end)-1, new_Bad());
412     DEL_ARR_F(in);
413   }
414   if (except_arr) DEL_ARR_F(except_arr);
415 }
416
417
418 /* Zwischengespeicherte Daten wieder freigeben. */
419 static void cleanup_irg(ir_graph * irg) {
420   ir_entity * ent = get_irg_entity(irg);
421   irg_data_t * data = get_entity_link(ent);
422   assert(data);
423   if (data->res) DEL_ARR_F(data->res);
424   set_entity_link(ent, NULL);
425   free(data);
426 }
427
428
429 /* Alle Phi-Operationen aus "from_block" nach "to_block"
430  * verschieben. Die Phi-Operationen müssen am zugehörigen Grundblock
431  * verlinkt sein. Danach sind sie am neuen Grundblock verlinkt. */
432 static void move_phis(ir_node * from_block, ir_node * to_block) {
433   ir_node * phi;
434   for (phi = get_irn_link(from_block); phi != NULL; phi = get_irn_link(phi)) {
435     set_nodes_block(phi, to_block);
436   }
437   assert(get_irn_link(to_block) == NULL);
438   set_irn_link(to_block, get_irn_link(from_block));
439   set_irn_link(from_block, NULL);
440 }
441
442
443 /* Rekursiv die Operation "node" und alle ihre Vorgänger aus dem Block
444  * "from_block" nach "to_block" verschieben.
445  * Verschiebe ebenfalls die Projs aus diesen Operationen. */
446 static void move_nodes(ir_node * from_block, ir_node * to_block, ir_node * node) {
447   int i,  arity = get_irn_arity(node);
448   ir_node *proj;
449
450   for (i = arity - 1; i >= 0; --i) {
451     ir_node * pred = get_irn_n(node, i);
452     if (get_nodes_block(pred) == from_block) {
453       move_nodes(from_block, to_block, pred);
454     }
455   }
456   set_nodes_block(node, to_block);
457
458   /* Move projs of this node. */
459   proj = get_irn_link(node);
460   for (; proj; proj = skip_Id(get_irn_link(proj))) {
461     if (get_irn_op(proj) != op_Proj && get_irn_op(proj) != op_Filter) continue;
462     if ((get_nodes_block(proj) == from_block) && (skip_Proj(get_irn_n(proj, 0)) == node))
463       set_nodes_block(proj, to_block);
464   }
465 }
466
467
468 /* Abhängigkeiten vom Start-Block und den Filter-Operationen im
469  * Start-Block auf den Aufrufer hinzufügen. */
470 static void construct_start(ir_entity * caller, ir_entity * callee,
471                             ir_node * call, ir_node * exec)
472 {
473   irg_data_t *data  = get_entity_link(callee);
474   ir_graph   *irg   = get_entity_irg(callee);
475   ir_node    *start = get_irg_start(irg);
476   ir_node    *filter;
477   (void) caller;
478
479   assert(irg);
480   assert(get_entity_peculiarity(callee) == peculiarity_existent); /* Else data is not initalized. */
481   assert((0 <= data->count) &&
482          (data->count < get_Block_cg_n_cfgpreds(get_nodes_block(start))));
483
484   set_Block_cg_cfgpred(get_nodes_block(start), data->count, exec);
485   for (filter = get_irn_link(start); filter; filter = get_irn_link(filter)) {
486     if (get_irn_op(filter) != op_Filter) continue;
487     if (get_Proj_pred(filter) == start) {
488       switch ((int) get_Proj_proj(filter)) {
489       case pn_Start_M:
490     set_Filter_cg_pred(filter, data->count, get_Call_mem(call));
491     break;
492       case  pn_Start_P_frame_base:
493     /* "frame_base" wird nur durch Unknown dargestellt. Man kann ihn aber
494      * auch explizit darstellen, wenn sich daraus Vorteile für die
495      * Datenflussanalyse ergeben. */
496     set_Filter_cg_pred(filter, data->count, get_cg_Unknown(get_irn_mode(filter)));
497     break;
498       case pn_Start_P_globals:
499     /* "globals" wird nur durch Unknown dargestellt. Man kann ihn aber auch
500      * explizit darstellen, wenn sich daraus Vorteile für die
501      * Datenflussanalyse ergeben. */
502     set_Filter_cg_pred(filter, data->count, get_cg_Unknown(get_irn_mode(filter)));
503     break;
504       default:
505     /* not reached */
506     assert(0 && "not reached");
507     break;
508       }
509     } else {
510       set_Filter_cg_pred(filter, data->count, get_Call_param(call, get_Proj_proj(filter)));
511     }
512   }
513   ++data->count;
514 }
515
516
517 /* Abhängigkeiten für den Speicherzustand über alle aufgerufenen
518  * Methoden bestimmen. */
519 static void fill_mem(int length, irg_data_t * data[], ir_node * in[]) {
520   int i;
521   for (i = 0; i < length; ++i) {
522     if (data[i]) { /* explicit */
523       if (data[i]->reg) {
524         in[i] = data[i]->mem;
525       } else {
526         in[i] = new_Bad();
527       }
528     } else { /* unknown */
529       in[i] = get_cg_Unknown(mode_M);
530     }
531   }
532 }
533
534
535 /* Abhängigkeiten für den Ausnahme-Speicherzustand über alle
536  * aufgerufenen Methoden bestimmen. */
537 static void fill_except_mem(int length, irg_data_t * data[], ir_node * in[]) {
538   int i;
539   for (i = 0; i < length; ++i) {
540     if (data[i]) { /* explicit */
541       if (data[i]->except) {
542         in[i] = data[i]->except_mem;
543       } else {
544         in[i] = new_Bad();
545       }
546     } else { /* unknown */
547       in[i] = get_cg_Unknown(mode_M);
548     }
549   }
550 }
551
552
553 /* Abhängigkeiten für ein Ergebnis über alle aufgerufenen Methoden
554  * bestimmen. */
555 static void fill_result(int pos, int length, irg_data_t * data[], ir_node * in[], ir_mode *m) {
556   int i;
557   for (i = 0; i < length; ++i) {
558     if (data[i]) { /* explicit */
559       if (data[i]->reg) {
560         in[i] = data[i]->res[pos];
561       } else {
562         in[i] = new_Bad();
563       }
564     } else { /* unknown */
565       in[i] = get_cg_Unknown(m);
566     }
567   }
568 }
569
570
571 /* Proj auf Except-X einer Call-Operation (aus der Link-Liste) bestimmen. */
572 static ir_node * get_except(ir_node * call) {
573   /* Mit CSE könnte man das effizienter machen! Die Methode wird aber für jede
574    * Aufrufstelle nur ein einziges Mal aufgerufen. */
575   ir_node * proj;
576   for (proj = get_irn_link(call); proj && get_irn_op(proj) == op_Proj; proj = get_irn_link(proj)) {
577     if (get_Proj_proj(proj) == 1 && get_irn_op(get_Proj_pred(proj)) == op_Call) {
578       return proj;
579     }
580   }
581   return NULL;
582 }
583
584 /* Returns true if control flow operation exc is predecessor of end
585    block in irg.  Works also for Return nodes, not only exceptions. */
586 static bool exc_branches_to_end(ir_graph *irg, ir_node *exc) {
587   int i;
588   ir_node *end = get_irg_end_block(irg);
589   for (i = get_Block_n_cfgpreds(end) -1; i >= 0; --i)
590     if (get_Block_cfgpred(end, i) == exc) return true;
591   return false;
592 }
593
594 /* Returns true if only caller of irg is "Unknown". */
595 static bool is_outermost_graph(ir_graph *irg) {
596   irg_data_t * data = get_entity_link(get_irg_entity(irg));
597   if (data->count) {
598     return false;
599   } else if (data->open) {
600     /* Die Methode wird nur von "der" unbekannten Aufrufstelle
601      * aufgerufen. Darstellung wird für diese Methode nicht
602      * geändert. */
603   } else {
604     /* Methode kann nicht aufgerufen werden. Die Darstellung wird
605      * für diese Methode nicht geändert. Das kann nicht vorkommen,
606      * wenn zuvor "gc_irgs()" aufgerufen wurde. */
607   }
608   return true;
609 }
610
611 #ifdef INTERPROCEDURAL_VIEW
612 /* Grundblock der Call-Operation aufteilen. CallBegin- und Filter-Operationen
613  * einfügen. Die Steuer- und Datenflussabhängigkeiten von den aufgerufenen
614  * Methoden auf die CallBegin-Operation, und von der Aufrufstelle auf die
615  * aufgerufenen Methoden eintragen. */
616 static void construct_call(ir_node * call) {
617   int i, n_callees;
618   ir_node *post_block, *pre_block, *except_block, * proj, *jmp, *call_begin;
619   ir_node ** in;
620   ir_entity * caller;
621   ir_entity ** callees;
622   ir_graph ** irgs;
623   irg_data_t ** data;
624
625   n_callees  = get_Call_n_callees(call);
626   post_block = get_nodes_block(call); /* block nach dem Aufruf */
627   pre_block  = create_Block(get_Block_n_cfgpreds(post_block),
628                       get_Block_cfgpred_arr(post_block)); /* block vor dem Aufruf (mit CallBegin) */
629   except_block = NULL;
630   jmp = new_Break(); /* Sprung für intraprozedurale Darstellung (in     * pre_block) */
631   call_begin = new_CallBegin(call); /* (in pre_block) */
632   /* CallBegin might be entry to endless recursion. */
633   add_End_keepalive(get_irg_end(get_irn_irg(pre_block)), pre_block);
634
635   in = NEW_ARR_F(ir_node *, n_callees);
636   caller = get_irg_entity(current_ir_graph); /* entity des aktuellen ir_graph */
637   callees = NEW_ARR_F(ir_entity *, n_callees); /* aufgerufene Methoden: entity */
638   irgs = NEW_ARR_F(ir_graph *, n_callees); /* aufgerufene Methoden: ir_graph */
639   data = NEW_ARR_F(irg_data_t *, n_callees); /* aufgerufene Methoden: irg_data_t */
640
641   /* post_block kann bereits interprozedurale Steuerflussvorgänger
642    * besitzen. Diese müssen dann auch noch für den pre_block gesetzt werden. */
643   if (get_Block_cg_cfgpred_arr(post_block)) {
644     set_Block_cg_cfgpred_arr(pre_block, get_Block_cg_n_cfgpreds(post_block),
645                  get_Block_cg_cfgpred_arr(post_block));
646     remove_Block_cg_cfgpred_arr(post_block);
647   }
648
649   /* Operationen verschieben */
650   move_phis(post_block, pre_block);
651   move_nodes(post_block, pre_block, call);
652   set_irn_in(post_block, 1, &jmp);
653
654   /* Wiederverwendete Daten initialisieren. */
655   for (i = 0; i < n_callees; ++i) {
656     callees[i] = get_Call_callee(call, i);
657     irgs[i] = get_entity_irg(callees[i]);
658     data[i] = get_entity_link(callees[i]);
659     /* Only entities that have an irg got a irg_data data structure.
660        In others there is some arbitrary garbage in the link field. */
661     if (!irgs[i]) { assert(!data[i]); data[i] = NULL; }
662   }
663
664   /*
665    * Set flag to suppress verifying placement on proper irg:
666    * optimization can return block on other irg.
667    */
668   set_interprocedural_view(1);
669
670   /* Die interprozeduralen Steuerflussvorgänger des post_block
671    * bestimmen. */
672   for (i = 0; i < n_callees; ++i) {
673     if (data[i]) { /* explicit */
674       if (data[i]->reg) {
675             in[i] = new_r_Proj(irgs[i], get_nodes_block(data[i]->reg),
676                                data[i]->reg, mode_X, data[i]->count);
677       } else {
678             in[i] = new_Bad();
679       }
680     } else { /* unknown */
681       in[i] = get_cg_Unknown(mode_X);
682     }
683   }
684   set_interprocedural_view(0);
685
686   set_Block_cg_cfgpred_arr(post_block, n_callees, in);
687
688   /* Die interprozeduralen Steuerflussvorgänger des except_block
689    * bestimmen. */
690   if ((proj = get_except(call)) != NULL) {
691     int preds = 0;
692     bool exc_to_end = false;
693     if (exc_branches_to_end(current_ir_graph, proj)) {
694       /* The Call aborts the procedure if it returns with an exception.
695          If this is an outermost procedure, the normal handling of exceptions
696          will generate a Break that goes to the end block.  This is illegal
697          Frim. So directly branch to the end block with all exceptions. */
698       exc_to_end = true;
699       if (is_outermost_graph(current_ir_graph)) {
700             except_block = get_irg_end_block(current_ir_graph);
701       } else {
702             irg_data_t * tmp_data = get_entity_link(get_irg_entity(current_ir_graph));
703             except_block = get_nodes_block(tmp_data->except);
704       }
705     } else {
706       except_block = create_Block(1, &proj);
707       set_nodes_block(proj, except_block);
708       exchange(proj, new_Break());
709       set_irg_current_block(current_ir_graph, pre_block);
710       set_irn_n(except_block, 0, new_Proj(call, mode_X, pn_Call_X_except));
711       set_irg_current_block(current_ir_graph, post_block);
712     }
713
714     /*
715      * Set flag to suppress verifying placement on proper irg:
716      * optimization can return block on other irg.
717      */
718     set_interprocedural_view(1);
719
720     for (i = 0; i < n_callees; ++i) {
721       ir_entity * callee = get_Call_callee(call, i);
722       if (data[i]) { /* explicit */
723             if (data[i]->except) {
724               in[i] = new_r_Proj(get_entity_irg(callee), get_nodes_block(data[i]->except),
725                                  data[i]->except, mode_X, data[i]->count);
726             } else {
727               in[i] = new_Bad();
728             }
729       } else { /* unknown */
730             in[i] = get_cg_Unknown(mode_X);
731       }
732     }
733
734     preds = n_callees;
735     if (exc_to_end) {
736       /* append all existing preds of the end block to new in array.
737        * Normal access routine guarantees that with first visit we
738        * get the normal preds, and from then on the _cg_ preds.
739        * (interprocedural view is set!)
740        * Do not add the exc pred of end we are replacing! */
741       for (i = get_Block_n_cfgpreds(except_block)-1; i >= 0; --i) {
742             ir_node *pred = get_Block_cfgpred(except_block, i);
743             if (pred != proj) {
744               ARR_APP1(ir_node *, in, pred);
745               preds++;
746             }
747       }
748     }
749     set_Block_cg_cfgpred_arr(except_block, preds, in);
750   }
751   set_interprocedural_view(0);
752
753   /* Diesen Vorgänger in den Start-Blöcken der aufgerufenen Methoden
754    * eintragen. */
755   set_irg_current_block(current_ir_graph, pre_block);
756   for (i = 0; i < n_callees; ++i) {
757     if (irgs[i]) /* Else there is not graph to call */
758       construct_start(caller, callees[i], call, new_Proj(call_begin, mode_X, i));
759   }
760
761   /* Proj-Operationen in Filter-Operationen umwandeln und
762    * interprozedurale Vorgänger einfügen. */
763   set_irg_current_block(current_ir_graph, post_block);
764   for (proj = get_irn_link(call); proj; proj = get_irn_link(proj)) {
765     if (get_irn_op(proj) != op_Proj) continue;
766     if (skip_Proj(get_Proj_pred(proj)) != call) continue;
767     if (get_Proj_pred(proj) == call) {
768       if (get_Proj_proj(proj) == pn_Call_M_regular) { /* memory */
769             ir_node * filter;
770
771             set_nodes_block(proj, post_block);
772             filter = exchange_proj(proj);
773             /* filter in die Liste der Phis aufnehmen */
774             if (get_irn_link(filter) == NULL) { /* note CSE */
775               set_irn_link(filter, get_irn_link(post_block));
776               set_irn_link(post_block, filter);
777             }
778             fill_mem(n_callees, data, in);
779             set_Filter_cg_pred_arr(filter, n_callees, in);
780       } else if (get_Proj_proj(proj) == pn_Call_X_except) { /* except */
781         /* nothing: siehe oben */
782       } else if (get_Proj_proj(proj) == pn_Call_T_result) { /* results */
783             /* nothing */
784       } else if (get_Proj_proj(proj) == pn_Call_M_except) { /* except_mem */
785         ir_node * filter;
786
787             set_nodes_block(proj, post_block);
788             assert(except_block);
789             set_irg_current_block(current_ir_graph, except_block);
790             filter = exchange_proj(proj);
791             /* filter in die Liste der Phis aufnehmen */
792             if (get_irn_link(filter) == NULL) { /* note CSE */
793               set_irn_link(filter, get_irn_link(except_block));
794               set_irn_link(except_block, filter);
795             }
796             set_irg_current_block(current_ir_graph, post_block);
797             fill_except_mem(n_callees, data, in);
798             set_Filter_cg_pred_arr(filter, n_callees, in);
799       } else {
800         assert(0 && "not reached");
801       }
802     } else { /* result */
803       ir_node * filter;
804
805       assert(is_Proj(get_Proj_pred(proj)) && get_Proj_pred(get_Proj_pred(proj)) == call);
806       set_nodes_block(proj, post_block);
807       filter = exchange_proj(proj);
808       /* filter in die Liste der Phis aufnehmen */
809       if (get_irn_link(filter) == NULL) { /* not CSE */
810             set_irn_link(filter, get_irn_link(post_block));
811             set_irn_link(post_block, filter);
812       }
813       fill_result(get_Proj_proj(filter), n_callees, data, in, get_irn_mode(filter));
814       set_Filter_cg_pred_arr(filter, n_callees, in);
815     }
816   }
817   DEL_ARR_F(in);
818   DEL_ARR_F(callees);
819   DEL_ARR_F(irgs);
820   DEL_ARR_F(data);
821 }
822 #endif
823
824
825 void cg_construct(int arr_len, ir_entity ** free_methods_arr) {
826   int i;
827
828   if (get_irp_ip_view_state() == ip_view_valid) return;
829   if (get_irp_ip_view_state() == ip_view_invalid) cg_destruct();
830   set_irp_ip_view(ip_view_valid);
831
832   collect_phicallproj();
833
834   /* count callers */
835   caller_init(arr_len, free_methods_arr);
836
837   /* prepare irgs */
838   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
839     ir_graph * irg = get_irp_irg(i);
840     ir_entity * ent = get_irg_entity(irg);
841     irg_data_t * data = get_entity_link(ent);
842     if (data->count) {
843       prepare_irg(irg, data);
844     } else if (data->open) {
845       /* Die Methode wird nur von "der" unbekannten Aufrufstelle
846        * aufgerufen. Darstellung wird für diese Methode nicht
847        * geändert. */
848     } else {
849       /* Methode kann nicht aufgerufen werden. Die Darstellung wird
850        * für diese Methode nicht geändert. Das kann nicht vorkommen,
851        * wenn zuvor "gc_irgs()" aufgerufen wurde. */
852     }
853   }
854
855   /* construct calls */
856   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
857     ir_node * node;
858
859     current_ir_graph = get_irp_irg(i);
860     for (node = get_irn_link(get_irg_end(current_ir_graph)); node; node = get_irn_link(node)) {
861       if (get_irn_op(node) == op_Call) {
862         int j, n_callees = get_Call_n_callees(node);
863         for (j = 0; j < n_callees; ++j)
864           if (get_entity_irg(get_Call_callee(node, j)))
865             break;
866           if (j < n_callees)  /* There is an entity with a graph */
867             construct_call(node);
868       }
869     }
870   }
871
872   /* cleanup irgs: Abschlussarbeiten: Die Vorgänger der Methoden noch
873    * explizit setzen und die zwischengespeicherten Daten wieder
874    * freigeben. */
875   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
876     cleanup_irg(get_irp_irg(i));
877   }
878 }
879
880
881
882 static void destruct_walker(ir_node * node, void * env)
883 {
884   (void) env;
885   if (get_irn_op(node) == op_Block) {
886     remove_Block_cg_cfgpred_arr(node);
887     /* Do not turn Break into Jmp.  Better: merge blocks right away.
888        Well, but there are Breaks left.
889        See exc1 from ajacs-rts/Exceptions.java.  */
890     if (get_Block_n_cfgpreds(node) == 1) {
891       ir_node *pred = get_Block_cfgpred(node, 0);
892       if (get_irn_op(pred) == op_Break)
893         exchange(node, get_nodes_block(pred));
894     }
895   } else if (get_irn_op(node) == op_Filter) {
896     set_irg_current_block(current_ir_graph, get_nodes_block(node));
897     exchange(node, new_Proj(get_Filter_pred(node), get_irn_mode(node), get_Filter_proj(node)));
898   } else if (get_irn_op(node) == op_Break) {
899     set_irg_current_block(current_ir_graph, get_nodes_block(node));
900     exchange(node, new_Jmp());
901   } else if (get_irn_op(node) == op_Call) {
902     remove_Call_callee_arr(node);
903   } else if (get_irn_op(node) == op_Proj) {
904     /*  some ProjX end up in strange blocks. */
905     set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
906   }
907 }
908
909
910 void cg_destruct(void) {
911   int i;
912   if (get_irp_ip_view_state() != ip_view_no) {
913     for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
914       ir_graph * irg = get_irp_irg(i);
915       irg_walk_graph(irg, destruct_walker, firm_clear_link, NULL);
916
917       set_irg_frame      (irg, skip_Id(get_irg_frame(irg)));
918       set_irg_globals    (irg, skip_Id(get_irg_globals(irg)));
919       set_irg_initial_mem(irg, skip_Id(get_irg_initial_mem(irg)));
920       set_irg_end_reg    (irg, get_irg_end(irg));
921       set_irg_end_except (irg, get_irg_end(irg));
922
923       set_irg_callee_info_state(irg, irg_callee_info_none);
924     }
925
926     set_irp_ip_view(ip_view_no);
927   }
928 }
929
930 #endif