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