get_divop_resmod() added
[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   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
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 /* Grundblock der Call-Operation aufteilen. CallBegin- und Filter-Operationen
611  * einfügen. Die Steuer- und Datenflussabhängigkeiten von den aufgerufenen
612  * Methoden auf die CallBegin-Operation, und von der Aufrufstelle auf die
613  * aufgerufenen Methoden eintragen. */
614 static void construct_call(ir_node * call) {
615   int i, n_callees;
616   ir_node *post_block, *pre_block, *except_block, * proj, *jmp, *call_begin;
617   ir_node ** in;
618   ir_entity * caller;
619   ir_entity ** callees;
620   ir_graph ** irgs;
621   irg_data_t ** data;
622
623   n_callees  = get_Call_n_callees(call);
624   post_block = get_nodes_block(call); /* block nach dem Aufruf */
625   pre_block  = create_Block(get_Block_n_cfgpreds(post_block),
626                       get_Block_cfgpred_arr(post_block)); /* block vor dem Aufruf (mit CallBegin) */
627   except_block = NULL;
628   jmp = new_Break(); /* Sprung für intraprozedurale Darstellung (in     * pre_block) */
629   call_begin = new_CallBegin(call); /* (in pre_block) */
630   /* CallBegin might be entry to endless recursion. */
631   add_End_keepalive(get_irg_end(get_irn_irg(pre_block)), pre_block);
632
633   in = NEW_ARR_F(ir_node *, n_callees);
634   caller = get_irg_entity(current_ir_graph); /* entity des aktuellen ir_graph */
635   callees = NEW_ARR_F(ir_entity *, n_callees); /* aufgerufene Methoden: entity */
636   irgs = NEW_ARR_F(ir_graph *, n_callees); /* aufgerufene Methoden: ir_graph */
637   data = NEW_ARR_F(irg_data_t *, n_callees); /* aufgerufene Methoden: irg_data_t */
638
639   /* post_block kann bereits interprozedurale Steuerflussvorgänger
640    * besitzen. Diese müssen dann auch noch für den pre_block gesetzt werden. */
641   if (get_Block_cg_cfgpred_arr(post_block)) {
642     set_Block_cg_cfgpred_arr(pre_block, get_Block_cg_n_cfgpreds(post_block),
643                  get_Block_cg_cfgpred_arr(post_block));
644     remove_Block_cg_cfgpred_arr(post_block);
645   }
646
647   /* Operationen verschieben */
648   move_phis(post_block, pre_block);
649   move_nodes(post_block, pre_block, call);
650   set_irn_in(post_block, 1, &jmp);
651
652   /* Wiederverwendete Daten initialisieren. */
653   for (i = 0; i < n_callees; ++i) {
654     callees[i] = get_Call_callee(call, i);
655     irgs[i] = get_entity_irg(callees[i]);
656     data[i] = get_entity_link(callees[i]);
657     /* Only entities that have an irg got a irg_data data structure.
658        In others there is some arbitrary garbage in the link field. */
659     if (!irgs[i]) { assert(!data[i]); data[i] = NULL; }
660   }
661
662   /*
663    * Set flag to suppress verifying placement on proper irg:
664    * optimization can return block on other irg.
665    */
666   set_interprocedural_view(1);
667
668   /* Die interprozeduralen Steuerflussvorgänger des post_block
669    * bestimmen. */
670   for (i = 0; i < n_callees; ++i) {
671     if (data[i]) { /* explicit */
672       if (data[i]->reg) {
673             in[i] = new_r_Proj(irgs[i], get_nodes_block(data[i]->reg),
674                                data[i]->reg, mode_X, data[i]->count);
675       } else {
676             in[i] = new_Bad();
677       }
678     } else { /* unknown */
679       in[i] = get_cg_Unknown(mode_X);
680     }
681   }
682   set_interprocedural_view(0);
683
684   set_Block_cg_cfgpred_arr(post_block, n_callees, in);
685
686   /* Die interprozeduralen Steuerflussvorgänger des except_block
687    * bestimmen. */
688   if ((proj = get_except(call)) != NULL) {
689     int preds = 0;
690     bool exc_to_end = false;
691     if (exc_branches_to_end(current_ir_graph, proj)) {
692       /* The Call aborts the procedure if it returns with an exception.
693          If this is an outermost procedure, the normal handling of exceptions
694          will generate a Break that goes to the end block.  This is illegal
695          Frim. So directly branch to the end block with all exceptions. */
696       exc_to_end = true;
697       if (is_outermost_graph(current_ir_graph)) {
698             except_block = get_irg_end_block(current_ir_graph);
699       } else {
700             irg_data_t * tmp_data = get_entity_link(get_irg_entity(current_ir_graph));
701             except_block = get_nodes_block(tmp_data->except);
702       }
703     } else {
704       except_block = create_Block(1, &proj);
705       set_nodes_block(proj, except_block);
706       exchange(proj, new_Break());
707       set_irg_current_block(current_ir_graph, pre_block);
708       set_irn_n(except_block, 0, new_Proj(call, mode_X, pn_Call_X_except));
709       set_irg_current_block(current_ir_graph, post_block);
710     }
711
712     /*
713      * Set flag to suppress verifying placement on proper irg:
714      * optimization can return block on other irg.
715      */
716     set_interprocedural_view(1);
717
718     for (i = 0; i < n_callees; ++i) {
719       ir_entity * callee = get_Call_callee(call, i);
720       if (data[i]) { /* explicit */
721             if (data[i]->except) {
722               in[i] = new_r_Proj(get_entity_irg(callee), get_nodes_block(data[i]->except),
723                                  data[i]->except, mode_X, data[i]->count);
724             } else {
725               in[i] = new_Bad();
726             }
727       } else { /* unknown */
728             in[i] = get_cg_Unknown(mode_X);
729       }
730     }
731
732     preds = n_callees;
733     if (exc_to_end) {
734       /* append all existing preds of the end block to new in array.
735        * Normal access routine guarantees that with first visit we
736        * get the normal preds, and from then on the _cg_ preds.
737        * (interprocedural view is set!)
738        * Do not add the exc pred of end we are replacing! */
739       for (i = get_Block_n_cfgpreds(except_block)-1; i >= 0; --i) {
740             ir_node *pred = get_Block_cfgpred(except_block, i);
741             if (pred != proj) {
742               ARR_APP1(ir_node *, in, pred);
743               preds++;
744             }
745       }
746     }
747     set_Block_cg_cfgpred_arr(except_block, preds, in);
748   }
749   set_interprocedural_view(0);
750
751   /* Diesen Vorgänger in den Start-Blöcken der aufgerufenen Methoden
752    * eintragen. */
753   set_irg_current_block(current_ir_graph, pre_block);
754   for (i = 0; i < n_callees; ++i) {
755     if (irgs[i]) /* Else there is not graph to call */
756       construct_start(caller, callees[i], call, new_Proj(call_begin, mode_X, i));
757   }
758
759   /* Proj-Operationen in Filter-Operationen umwandeln und
760    * interprozedurale Vorgänger einfügen. */
761   set_irg_current_block(current_ir_graph, post_block);
762   for (proj = get_irn_link(call); proj; proj = get_irn_link(proj)) {
763     if (get_irn_op(proj) != op_Proj) continue;
764     if (skip_Proj(get_Proj_pred(proj)) != call) continue;
765     if (get_Proj_pred(proj) == call) {
766       if (get_Proj_proj(proj) == pn_Call_M_regular) { /* memory */
767             ir_node * filter;
768
769             set_nodes_block(proj, post_block);
770             filter = exchange_proj(proj);
771             /* filter in die Liste der Phis aufnehmen */
772             if (get_irn_link(filter) == NULL) { /* note CSE */
773               set_irn_link(filter, get_irn_link(post_block));
774               set_irn_link(post_block, filter);
775             }
776             fill_mem(n_callees, data, in);
777             set_Filter_cg_pred_arr(filter, n_callees, in);
778       } else if (get_Proj_proj(proj) == pn_Call_X_except) { /* except */
779         /* nothing: siehe oben */
780       } else if (get_Proj_proj(proj) == pn_Call_T_result) { /* results */
781             /* nothing */
782       } else if (get_Proj_proj(proj) == pn_Call_M_except) { /* except_mem */
783         ir_node * filter;
784
785             set_nodes_block(proj, post_block);
786             assert(except_block);
787             set_irg_current_block(current_ir_graph, except_block);
788             filter = exchange_proj(proj);
789             /* filter in die Liste der Phis aufnehmen */
790             if (get_irn_link(filter) == NULL) { /* note CSE */
791               set_irn_link(filter, get_irn_link(except_block));
792               set_irn_link(except_block, filter);
793             }
794             set_irg_current_block(current_ir_graph, post_block);
795             fill_except_mem(n_callees, data, in);
796             set_Filter_cg_pred_arr(filter, n_callees, in);
797       } else {
798         assert(0 && "not reached");
799       }
800     } else { /* result */
801       ir_node * filter;
802
803       assert(is_Proj(get_Proj_pred(proj)) && get_Proj_pred(get_Proj_pred(proj)) == call);
804       set_nodes_block(proj, post_block);
805       filter = exchange_proj(proj);
806       /* filter in die Liste der Phis aufnehmen */
807       if (get_irn_link(filter) == NULL) { /* not CSE */
808             set_irn_link(filter, get_irn_link(post_block));
809             set_irn_link(post_block, filter);
810       }
811       fill_result(get_Proj_proj(filter), n_callees, data, in, get_irn_mode(filter));
812       set_Filter_cg_pred_arr(filter, n_callees, in);
813     }
814   }
815   DEL_ARR_F(in);
816   DEL_ARR_F(callees);
817   DEL_ARR_F(irgs);
818   DEL_ARR_F(data);
819 }
820
821
822 void cg_construct(int arr_len, ir_entity ** free_methods_arr) {
823   int i;
824
825   if (get_irp_ip_view_state() == ip_view_valid) return;
826   if (get_irp_ip_view_state() == ip_view_invalid) cg_destruct();
827   set_irp_ip_view(ip_view_valid);
828
829   collect_phicallproj();
830
831   /* count callers */
832   caller_init(arr_len, free_methods_arr);
833
834   /* prepare irgs */
835   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
836     ir_graph * irg = get_irp_irg(i);
837     ir_entity * ent = get_irg_entity(irg);
838     irg_data_t * data = get_entity_link(ent);
839     if (data->count) {
840       prepare_irg(irg, data);
841     } else if (data->open) {
842       /* Die Methode wird nur von "der" unbekannten Aufrufstelle
843        * aufgerufen. Darstellung wird für diese Methode nicht
844        * geändert. */
845     } else {
846       /* Methode kann nicht aufgerufen werden. Die Darstellung wird
847        * für diese Methode nicht geändert. Das kann nicht vorkommen,
848        * wenn zuvor "gc_irgs()" aufgerufen wurde. */
849     }
850   }
851
852   /* construct calls */
853   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
854     ir_node * node;
855
856     current_ir_graph = get_irp_irg(i);
857     for (node = get_irn_link(get_irg_end(current_ir_graph)); node; node = get_irn_link(node)) {
858       if (get_irn_op(node) == op_Call) {
859         int j, n_callees = get_Call_n_callees(node);
860         for (j = 0; j < n_callees; ++j)
861           if (get_entity_irg(get_Call_callee(node, j)))
862             break;
863           if (j < n_callees)  /* There is an entity with a graph */
864             construct_call(node);
865       }
866     }
867   }
868
869   /* cleanup irgs: Abschlussarbeiten: Die Vorgänger der Methoden noch
870    * explizit setzen und die zwischengespeicherten Daten wieder
871    * freigeben. */
872   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
873     cleanup_irg(get_irp_irg(i));
874   }
875 }
876
877
878
879 static void destruct_walker(ir_node * node, void * env) {
880   if (get_irn_op(node) == op_Block) {
881     remove_Block_cg_cfgpred_arr(node);
882     /* Do not turn Break into Jmp.  Better: merge blocks right away.
883        Well, but there are Breaks left.
884        See exc1 from ajacs-rts/Exceptions.java.  */
885     if (get_Block_n_cfgpreds(node) == 1) {
886       ir_node *pred = get_Block_cfgpred(node, 0);
887       if (get_irn_op(pred) == op_Break)
888         exchange(node, get_nodes_block(pred));
889     }
890   } else if (get_irn_op(node) == op_Filter) {
891     set_irg_current_block(current_ir_graph, get_nodes_block(node));
892     exchange(node, new_Proj(get_Filter_pred(node), get_irn_mode(node), get_Filter_proj(node)));
893   } else if (get_irn_op(node) == op_Break) {
894     set_irg_current_block(current_ir_graph, get_nodes_block(node));
895     exchange(node, new_Jmp());
896   } else if (get_irn_op(node) == op_Call) {
897     remove_Call_callee_arr(node);
898   } else if (get_irn_op(node) == op_Proj) {
899     /*  some ProjX end up in strange blocks. */
900     set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
901   }
902 }
903
904
905 void cg_destruct(void) {
906   int i;
907   if (get_irp_ip_view_state() != ip_view_no) {
908     for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
909       ir_graph * irg = get_irp_irg(i);
910       irg_walk_graph(irg, destruct_walker, firm_clear_link, NULL);
911
912       set_irg_frame      (irg, skip_Id(get_irg_frame(irg)));
913       set_irg_globals    (irg, skip_Id(get_irg_globals(irg)));
914       set_irg_initial_mem(irg, skip_Id(get_irg_initial_mem(irg)));
915       set_irg_end_reg    (irg, get_irg_end(irg));
916       set_irg_end_except (irg, get_irg_end(irg));
917
918       set_irg_callee_info_state(irg, irg_callee_info_none);
919     }
920
921     set_irp_ip_view(ip_view_no);
922   }
923 }