Replaced set_irn_n(*, -1, *) and get_irn_n(*, -1) by new get_nodes_block()/set_nodes_...
[libfirm] / ir / ir / ircgcons.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   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 HAVE_STRING_H
33 #include <string.h>
34 #endif
35
36 #include <stdbool.h>
37 #include "ircgcons.h"
38
39 #include "array.h"
40 #include "irprog.h"
41 #include "irnode_t.h"
42 #include "irprog_t.h"
43 #include "ircons_t.h"
44 #include "irgmod.h"
45 #include "irgwalk.h"
46 #include "irflag_t.h"
47 #include "irtools.h"
48
49 /* Return the current state of the interprocedural view. */
50 ip_view_state get_irp_ip_view_state(void) {
51   return irp->ip_view;
52 }
53
54 /* Set the current state of the interprocedural view. */
55 static void set_irp_ip_view(ip_view_state state) {
56   irp->ip_view = state;
57 }
58
59 /* Set the state of the interprocedural view to invalid. */
60 void set_irp_ip_view_invalid(void) {
61   set_irp_ip_view(ip_view_invalid);
62 }
63
64
65 /* Data for each method */
66 typedef struct {
67   int count;                      /* Number of calleers. */
68   bool open;                      /* Open method: called by an unknown caller */
69   ir_node * reg, * mem, ** res;   /* EndReg, Mem and Method return values */
70   ir_node * except, * except_mem; /* EndExcept and Mem for exception return */
71 } irg_data_t;
72
73 static irg_data_t * irg_data_create(void) {
74   irg_data_t *data = xmalloc(sizeof(*data));
75   memset(data, 0, sizeof(*data)); /* init */
76   return data;
77 }
78
79 /** Count the number of callers of each method and mark open methods.
80  *
81  *  Fills the irg_data data structure.
82  *  Open methods are methods with an unknown caller, I.e., methods that
83  *   - are external visible
84  *   - are dereferenced somewhere within the program (i.e., the address of the
85  *     method is stored somewhere). */
86 static void caller_init(int arr_length, ir_entity ** free_methods) {
87   int i, j;
88   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
89     set_entity_link(get_irg_entity(get_irp_irg(i)), irg_data_create());
90   }
91   for (i = arr_length - 1; i >= 0; --i) {
92     irg_data_t * data = get_entity_link(free_methods[i]);
93     data->open = true;
94   }
95   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
96     ir_graph * irg = get_irp_irg(i);
97     ir_node * call;
98     /* We collected all call nodes in a link list at the end node. */
99     for (call = get_irn_link(get_irg_end(irg)); call; call = get_irn_link(call)) {
100       if (get_irn_op(call) != op_Call) continue;
101       for (j = get_Call_n_callees(call) - 1; j >= 0; --j) {
102         ir_entity * ent = get_Call_callee(call, j);
103         if (get_entity_irg(ent)) {
104           irg_data_t * data = get_entity_link(ent);
105 # ifndef CATE_jni
106           assert(get_entity_irg(ent) && data);
107           ++data->count;
108 # endif /* ndef CATE_jni */
109         } else {
110           set_entity_link(ent, NULL);
111         }
112       }
113     }
114   }
115 }
116
117 /*
118 static INLINE ir_node * tail(ir_node * node) {
119   ir_node * link;
120   for (; (link = get_irn_link(node)); node = link) ;
121   return node;
122 }
123 */
124
125 /* Call-Operationen an die "link"-Liste von "call_tail" anhängen (und
126  * "call_tail" aktualisieren), Proj-Operationen in die Liste ihrer Definition
127  * (auch bei Proj->Call Operationen) und Phi-Operationen in die Liste ihres
128  * Grundblocks einfügen. */
129 static void collect_phicallproj_walker(ir_node * node, ir_node ** call_tail) {
130   if (get_irn_op(node) == op_Call) {
131     /* Die Liste von Call an call_tail anhängen. */
132     ir_node * link;
133     assert(get_irn_link(*call_tail) == NULL);
134     set_irn_link(*call_tail, node);
135     /* call_tail aktualisieren: */
136     for (link = get_irn_link(*call_tail); link; *call_tail = link, link = get_irn_link(link)) ;
137   } else if (get_irn_op(node) == op_Proj) {
138     ir_node * head = skip_Proj(get_Proj_pred(node));
139     set_irn_link(node, get_irn_link(head));
140     set_irn_link(head, node);
141     /* call_tail gegebenenfalls aktualisieren: */
142     if (head == *call_tail) {
143       *call_tail = node;
144     }
145   } else if (get_irn_op(node) == op_Phi) {
146     ir_node * block = get_nodes_block(node);
147     set_irn_link(node, get_irn_link(block));
148     set_irn_link(block, node);
149   }
150 }
151
152
153 static void link(ir_node * head, ir_node * node) {
154   if (node) {
155     set_irn_link(node, get_irn_link(head));
156     set_irn_link(head, node);
157   }
158 }
159
160
161 /* Die Call-Operationen aller Graphen an den End-Operationen
162  * verlinken, die Proj-Operationen an ihren Definitionen und die
163  * Phi-Operationen an ihren Grundblöcken. Die Liste der Calls sieht
164  * dann so aus: End -> Call -> Proj -> ... -> Proj -> Call -> Proj ->
165  * ... -> Proj -> NULL. */
166 static void collect_phicallproj(void) {
167   int i;
168
169   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
170     ir_graph * irg = get_irp_irg(i);
171     ir_node * start = get_irg_start(irg);
172     ir_node * end = get_irg_end(irg);
173     current_ir_graph = irg;
174     assert(irg && start);
175
176         set_using_irn_link(irg);
177
178     /* Die speziellen Parameter der Start-Operation extra verlinken,
179      * auch wenn sie nicht im intraprozeduralen Graphen erreichbar
180      * sind. */
181     link(start, get_irg_frame(irg));
182     link(start, get_irg_globals(irg));
183     /* walk */
184     irg_walk_graph(irg, firm_clear_link, (irg_walk_func *) collect_phicallproj_walker, &end);
185
186         clear_using_irn_link(irg);
187   }
188 }
189
190
191 /* Proj-Operation durch Filter-Operation im aktuellen Block ersetzen. */
192 static ir_node * exchange_proj(ir_node * proj) {
193   ir_node * filter;
194   assert(get_irn_op(proj) == op_Proj);
195   filter = new_Filter(get_Proj_pred(proj), get_irn_mode(proj), get_Proj_proj(proj));
196   /* Die Proj- (Id-) Operation sollte im gleichen Grundblock stehen, wie die
197    * Filter-Operation. */
198   set_nodes_block(proj, get_nodes_block(filter));
199   exchange(proj, filter);
200   return filter;
201 }
202
203
204 /* Echt neue Block-Operation erzeugen. CSE abschalten! */
205 static ir_node * create_Block(int n, ir_node ** in) {
206   /* Turn off optimizations so that blocks are not merged again. */
207   int rem_opt = get_opt_optimize();
208   ir_node * block;
209   set_optimize(0);
210   block = new_Block(n, in);
211   set_optimize(rem_opt);
212   return block;
213 }
214
215
216 static void prepare_irg_end(ir_graph * irg, irg_data_t * data);
217 static void prepare_irg_end_except(ir_graph * irg, irg_data_t * data);
218
219
220 /* If we use new_Unknown we get the Unknown of a graph.  This can
221  * cause cycles we don't want to see, as Unknwon is in the Start Block
222  * of the procedure. Use unknown of outermost irg where the start
223  * block has no predecessors. */
224 static INLINE ir_node *get_cg_Unknown(ir_mode *m) {
225   assert((get_Block_n_cfgpreds(get_irg_start_block(get_irp_main_irg())) == 1) &&
226          (get_nodes_block(get_Block_cfgpred(get_irg_start_block(get_irp_main_irg()), 0)) ==
227           get_irg_start_block(get_irp_main_irg())));
228   return new_r_Unknown(get_irp_main_irg(), m);
229 }
230
231
232 /* IRG vorbereiten. Proj-Operationen der Start-Operation in Filter-Operationen
233  * umwandeln. Die künstlichen Steuerzusammenflüsse EndReg und EndExcept
234  * einfügen. An der Start-Operation hängt nach dem Aufruf eine Liste der
235  * entsprechenden Filter-Knoten. */
236 static void prepare_irg(ir_graph * irg, irg_data_t * data) {
237   ir_node * start_block = get_irg_start_block(irg);
238   ir_node * link, * proj;
239   int n_callers = data->count + (data->open ? 1 : 0);
240   ir_node ** in = NEW_ARR_F(ir_node *, n_callers);
241
242   current_ir_graph = irg;
243   set_irg_current_block(irg, start_block);
244
245   /* Grundblock interprozedural machen. */
246   /* "in" ist nicht initialisiert. Das passiert erst in "construct_start". */
247   set_Block_cg_cfgpred_arr(start_block, n_callers, in);
248   /* Proj-Operationen durch Filter-Operationen ersetzen und (sonst) in
249    * den Start-Block verschieben. */
250   for (proj = get_irn_link(get_irg_start(irg)); proj; proj = get_irn_link(proj)) {
251     if (get_Proj_pred(proj) != get_irg_start(irg)
252     || (get_Proj_proj(proj) != pn_Start_X_initial_exec && get_Proj_proj(proj) != pn_Start_T_args)) {
253       ir_node * filter = exchange_proj(proj);
254       set_Filter_cg_pred_arr(filter, n_callers, in);
255     } else {
256       set_nodes_block(proj, start_block);
257     }
258   }
259
260   DEL_ARR_F(in);
261
262   /* Liste der Filter-Operationen herstellen. Dabei muss man beachten,
263    * dass oben für "verschiedene" Proj-Operationen wegen CSE nur eine
264    * Filter-Operation erzeugt worden sein kann. */
265   for (link = get_irg_start(irg), proj = get_irn_link(link); proj; proj = get_irn_link(proj)) {
266     if (get_irn_op(proj) == op_Id) { /* replaced with filter */
267       ir_node * filter = get_Id_pred(proj);
268       assert(get_irn_op(filter) == op_Filter);
269       if (filter != link && get_irn_link(filter) == NULL) {
270     set_irn_link(link, filter);
271     link = filter;
272       }
273     }
274   }
275   /* Globle Einträge für ersetzte Operationen korrigieren. */
276   set_irg_frame      (irg, skip_Id(get_irg_frame(irg)));
277   set_irg_globals    (irg, skip_Id(get_irg_globals(irg)));
278   set_irg_initial_mem(irg, skip_Id(get_irg_initial_mem(irg)));
279
280   /* Unbekannten Aufrufer sofort eintragen. */
281   if (data->open) {
282     set_Block_cg_cfgpred(start_block, 0, get_cg_Unknown(mode_X));
283     for (proj = get_irn_link(get_irg_start(irg)); proj; proj = get_irn_link(proj)) {
284       if (get_irn_op(proj) == op_Filter) {
285     set_Filter_cg_pred(proj, 0, get_cg_Unknown(get_irn_mode(proj)));
286       }
287     }
288     data->count = 1;
289   } else {
290     data->count = 0;
291   }
292
293   prepare_irg_end(irg, data);
294   prepare_irg_end_except(irg, data);
295 }
296
297
298 /* Künstlicher Steuerzusammenfluss EndReg einfügen. */
299 static void prepare_irg_end(ir_graph * irg, irg_data_t * data) {
300   ir_node * end_block   = get_irg_end_block(irg);
301   ir_node * end         = get_irg_end(irg);
302   ir_node **ret_arr     = NULL;
303   ir_node **cfgpred_arr = get_Block_cfgpred_arr(end_block);
304   int i, j;
305   int n_ret = 0;
306
307   for (i = get_Block_n_cfgpreds(end_block) - 1; i >= 0; --i) {
308     if (is_Return(cfgpred_arr[i])) {
309       if (ret_arr) {
310         ARR_APP1(ir_node *, ret_arr, cfgpred_arr[i]);
311       } else {
312         ret_arr = NEW_ARR_F(ir_node *, 1);
313         ret_arr[0] = cfgpred_arr[i];
314       }
315       ++n_ret;
316     }
317   }
318
319   if (n_ret > 0) {
320     int n_res = get_method_n_ress(get_entity_type(get_irg_entity(irg)));
321     ir_node ** in = NEW_ARR_F(ir_node *, n_ret);
322
323     /* block */
324     for (i = n_ret - 1; i >= 0; --i) {
325       set_irg_current_block(irg, get_nodes_block(ret_arr[i]));
326       in[i] = new_Jmp();
327     }
328     create_Block(n_ret, in);
329
330     /* end */
331     data->reg = new_EndReg();
332
333     /* mem */
334     for (i = n_ret - 1; i >= 0; --i) {
335       in[i] = get_Return_mem(ret_arr[i]);
336     }
337     data->mem = new_Phi(n_ret, in, mode_M);
338     /* This Phi is a merge, therefore needs not be kept alive.
339        It might be optimized away, though.  */
340     if (get_End_keepalive(end, get_End_n_keepalives(end)-1 ) == data->mem)
341       set_End_keepalive(end, get_End_n_keepalives(end)-1, new_Bad());
342
343     /* res */
344     data->res = NEW_ARR_F(ir_node *, n_res);
345     for (j = n_res - 1; j >= 0; --j) {
346       ir_mode *mode = NULL;
347       /* In[0] could be a Bad node with wrong mode. */
348       for (i = n_ret - 1; i >= 0; --i) {
349         in[i] = get_Return_res(ret_arr[i], j);
350         if (!mode && get_irn_mode(in[i]) != mode_T)
351           mode = get_irn_mode(in[i]);
352       }
353       if (mode)
354         data->res[j] = new_Phi(n_ret, in, mode);
355       else  /* All preds are Bad */
356         data->res[j] = new_Bad();
357     }
358
359     DEL_ARR_F(in);
360   }
361
362   if (ret_arr) DEL_ARR_F(ret_arr);
363 }
364
365
366 /* Künstlicher Steuerzusammenfluss EndExcept einfügen. */
367 static void prepare_irg_end_except(ir_graph * irg, irg_data_t * data) {
368   ir_node * end_block = get_irg_end_block(irg);
369   ir_node * end = get_irg_end(irg);
370   ir_node ** except_arr = NULL;
371   int i;
372   int n_except = 0;
373   ir_node ** cfgpred_arr = get_Block_cfgpred_arr(end_block);
374   for (i = get_Block_n_cfgpreds(end_block) - 1; i >= 0; --i) {
375     if (! is_Return(cfgpred_arr[i])) {
376       if (except_arr) {
377         ARR_APP1(ir_node *, except_arr, cfgpred_arr[i]);
378       } else {
379         except_arr = NEW_ARR_F(ir_node *, 1);
380         except_arr[0] = cfgpred_arr[i];
381       }
382       ++n_except;
383     }
384   }
385   if (n_except > 0) {
386     ir_node ** in = NEW_ARR_F(ir_node *, n_except);
387     /* block */
388     create_Block(n_except, except_arr);
389     /* end_except */
390     data->except = new_EndExcept();
391     /* mem */
392     for (i = n_except - 1; i >= 0; --i) {
393       ir_node *node = skip_Proj(skip_Tuple(except_arr[i]));
394       ir_op *op = get_irn_op(node);
395       if (op == op_Call) {
396         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, pn_Call_M_except);
397       } else if (op == op_Raise) {
398         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, pn_Raise_M);
399       } else if (op == op_CopyB) {
400         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, pn_CopyB_M_except);
401       } else {
402         assert(is_fragile_op(node));
403         /* We rely that all cfops have the memory output at the same position. */
404         in[i] = new_r_Proj(irg, get_nodes_block(node), node, mode_M, 0);
405       }
406     }
407     data->except_mem = new_Phi(n_except, in, mode_M);
408     /* This Phi is a merge, therefor needs not be kept alive.
409        It might be optimized away, though.  */
410     if (get_End_keepalive(end, get_End_n_keepalives(end)-1 )
411     == data->except_mem)
412       set_End_keepalive(end, get_End_n_keepalives(end)-1, new_Bad());
413     DEL_ARR_F(in);
414   }
415   if (except_arr) DEL_ARR_F(except_arr);
416 }
417
418
419 /* Zwischengespeicherte Daten wieder freigeben. */
420 static void cleanup_irg(ir_graph * irg) {
421   ir_entity * ent = get_irg_entity(irg);
422   irg_data_t * data = get_entity_link(ent);
423   assert(data);
424   if (data->res) DEL_ARR_F(data->res);
425   set_entity_link(ent, NULL);
426   free(data);
427 }
428
429
430 /* Alle Phi-Operationen aus "from_block" nach "to_block"
431  * verschieben. Die Phi-Operationen müssen am zugehörigen Grundblock
432  * verlinkt sein. Danach sind sie am neuen Grundblock verlinkt. */
433 static void move_phis(ir_node * from_block, ir_node * to_block) {
434   ir_node * phi;
435   for (phi = get_irn_link(from_block); phi != NULL; phi = get_irn_link(phi)) {
436     set_nodes_block(phi, to_block);
437   }
438   assert(get_irn_link(to_block) == NULL);
439   set_irn_link(to_block, get_irn_link(from_block));
440   set_irn_link(from_block, NULL);
441 }
442
443
444 /* Rekursiv die Operation "node" und alle ihre Vorgänger aus dem Block
445  * "from_block" nach "to_block" verschieben.
446  * Verschiebe ebenfalls die Projs aus diesen Operationen. */
447 static void move_nodes(ir_node * from_block, ir_node * to_block, ir_node * node) {
448   int i,  arity = get_irn_arity(node);
449   ir_node *proj;
450
451   for (i = arity - 1; i >= 0; --i) {
452     ir_node * pred = get_irn_n(node, i);
453     if (get_nodes_block(pred) == from_block) {
454       move_nodes(from_block, to_block, pred);
455     }
456   }
457   set_nodes_block(node, to_block);
458
459   /* Move projs of this node. */
460   proj = get_irn_link(node);
461   for (; proj; proj = skip_Id(get_irn_link(proj))) {
462     if (get_irn_op(proj) != op_Proj && get_irn_op(proj) != op_Filter) continue;
463     if ((get_nodes_block(proj) == from_block) && (skip_Proj(get_irn_n(proj, 0)) == node))
464       set_nodes_block(proj, to_block);
465   }
466 }
467
468
469 /* Abhängigkeiten vom Start-Block und den Filter-Operationen im
470  * Start-Block auf den Aufrufer hinzufügen. */
471 static void construct_start(ir_entity * caller, ir_entity * callee,
472                             ir_node * call, ir_node * exec)
473 {
474   irg_data_t *data  = get_entity_link(callee);
475   ir_graph   *irg   = get_entity_irg(callee);
476   ir_node    *start = get_irg_start(irg);
477   ir_node    *filter;
478   (void) caller;
479
480   assert(irg);
481   assert(get_entity_peculiarity(callee) == peculiarity_existent); /* Else data is not initalized. */
482   assert((0 <= data->count) &&
483          (data->count < get_Block_cg_n_cfgpreds(get_nodes_block(start))));
484
485   set_Block_cg_cfgpred(get_nodes_block(start), data->count, exec);
486   for (filter = get_irn_link(start); filter; filter = get_irn_link(filter)) {
487     if (get_irn_op(filter) != op_Filter) continue;
488     if (get_Proj_pred(filter) == start) {
489       switch ((int) get_Proj_proj(filter)) {
490       case pn_Start_M:
491     set_Filter_cg_pred(filter, data->count, get_Call_mem(call));
492     break;
493       case  pn_Start_P_frame_base:
494     /* "frame_base" wird nur durch Unknown dargestellt. Man kann ihn aber
495      * auch explizit darstellen, wenn sich daraus Vorteile für die
496      * Datenflussanalyse ergeben. */
497     set_Filter_cg_pred(filter, data->count, get_cg_Unknown(get_irn_mode(filter)));
498     break;
499       case pn_Start_P_globals:
500     /* "globals" wird nur durch Unknown dargestellt. Man kann ihn aber auch
501      * explizit darstellen, wenn sich daraus Vorteile für die
502      * Datenflussanalyse ergeben. */
503     set_Filter_cg_pred(filter, data->count, get_cg_Unknown(get_irn_mode(filter)));
504     break;
505       default:
506     /* not reached */
507     assert(0 && "not reached");
508     break;
509       }
510     } else {
511       set_Filter_cg_pred(filter, data->count, get_Call_param(call, get_Proj_proj(filter)));
512     }
513   }
514   ++data->count;
515 }
516
517
518 /* Abhängigkeiten für den Speicherzustand über alle aufgerufenen
519  * Methoden bestimmen. */
520 static void fill_mem(int length, irg_data_t * data[], ir_node * in[]) {
521   int i;
522   for (i = 0; i < length; ++i) {
523     if (data[i]) { /* explicit */
524       if (data[i]->reg) {
525         in[i] = data[i]->mem;
526       } else {
527         in[i] = new_Bad();
528       }
529     } else { /* unknown */
530       in[i] = get_cg_Unknown(mode_M);
531     }
532   }
533 }
534
535
536 /* Abhängigkeiten für den Ausnahme-Speicherzustand über alle
537  * aufgerufenen Methoden bestimmen. */
538 static void fill_except_mem(int length, irg_data_t * data[], ir_node * in[]) {
539   int i;
540   for (i = 0; i < length; ++i) {
541     if (data[i]) { /* explicit */
542       if (data[i]->except) {
543         in[i] = data[i]->except_mem;
544       } else {
545         in[i] = new_Bad();
546       }
547     } else { /* unknown */
548       in[i] = get_cg_Unknown(mode_M);
549     }
550   }
551 }
552
553
554 /* Abhängigkeiten für ein Ergebnis über alle aufgerufenen Methoden
555  * bestimmen. */
556 static void fill_result(int pos, int length, irg_data_t * data[], ir_node * in[], ir_mode *m) {
557   int i;
558   for (i = 0; i < length; ++i) {
559     if (data[i]) { /* explicit */
560       if (data[i]->reg) {
561         in[i] = data[i]->res[pos];
562       } else {
563         in[i] = new_Bad();
564       }
565     } else { /* unknown */
566       in[i] = get_cg_Unknown(m);
567     }
568   }
569 }
570
571
572 /* Proj auf Except-X einer Call-Operation (aus der Link-Liste) bestimmen. */
573 static ir_node * get_except(ir_node * call) {
574   /* Mit CSE könnte man das effizienter machen! Die Methode wird aber für jede
575    * Aufrufstelle nur ein einziges Mal aufgerufen. */
576   ir_node * proj;
577   for (proj = get_irn_link(call); proj && get_irn_op(proj) == op_Proj; proj = get_irn_link(proj)) {
578     if (get_Proj_proj(proj) == 1 && get_irn_op(get_Proj_pred(proj)) == op_Call) {
579       return proj;
580     }
581   }
582   return NULL;
583 }
584
585 /* Returns true if control flow operation exc is predecessor of end
586    block in irg.  Works also for Return nodes, not only exceptions. */
587 static bool exc_branches_to_end(ir_graph *irg, ir_node *exc) {
588   int i;
589   ir_node *end = get_irg_end_block(irg);
590   for (i = get_Block_n_cfgpreds(end) -1; i >= 0; --i)
591     if (get_Block_cfgpred(end, i) == exc) return true;
592   return false;
593 }
594
595 /* Returns true if only caller of irg is "Unknown". */
596 static bool is_outermost_graph(ir_graph *irg) {
597   irg_data_t * data = get_entity_link(get_irg_entity(irg));
598   if (data->count) {
599     return false;
600   } else if (data->open) {
601     /* Die Methode wird nur von "der" unbekannten Aufrufstelle
602      * aufgerufen. Darstellung wird für diese Methode nicht
603      * geändert. */
604   } else {
605     /* Methode kann nicht aufgerufen werden. Die Darstellung wird
606      * für diese Methode nicht geändert. Das kann nicht vorkommen,
607      * wenn zuvor "gc_irgs()" aufgerufen wurde. */
608   }
609   return true;
610 }
611
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
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_frame      (irg, skip_Id(get_irg_frame(irg)));
917       set_irg_globals    (irg, skip_Id(get_irg_globals(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 }