irg_walk_anchors() added. Needed for iredges.
[libfirm] / ir / ir / irgwalk.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irgwalk.c
4  * Purpose:
5  * Author:      Boris Boesler
6  * Modified by: Goetz Lindenmaier
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1999-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14  * @file irgwalk.c
15  *
16  * traverse an ir graph
17  * - execute the pre function before recursion
18  * - execute the post function after recursion
19  */
20
21
22 #ifdef HAVE_CONFIG_H
23 # include "config.h"
24 #endif
25
26 #ifdef HAVE_STDLIB_H
27 # include <stdlib.h>
28 #endif
29
30 #include "irnode_t.h"
31 #include "irgraph_t.h" /* visited flag */
32 #include "irprog.h"
33 #include "irgwalk.h"
34 #include "typewalk.h"
35 #include "irhooks.h"
36 #include "ircgcons.h"
37
38 #include "eset.h"
39 #include "array.h"
40
41 /**
42  * Walk over an interprocedural graph (callgraph).
43  * Visits only graphs in irg_set.
44  */
45 static void irg_walk_cg(ir_node * node, unsigned long visited, eset * irg_set,
46                         irg_walk_func *pre, irg_walk_func *post, void * env) {
47   int i;
48   ir_graph * rem = current_ir_graph;
49   ir_node * pred;
50
51   assert(node && node->kind == k_ir_node);
52   if (get_irn_visited(node) >= visited) return;
53
54   set_irn_visited(node, visited);
55
56   if (pre) pre(node, env);
57
58   pred = skip_Proj(node);
59   if (get_irn_op(pred) == op_CallBegin
60       || get_irn_op(pred) == op_EndReg
61       || get_irn_op(pred) == op_EndExcept) {
62     current_ir_graph = get_irn_irg(pred);
63   }
64
65   if (is_no_Block(node)) { /* not block */
66     irg_walk_cg(get_nodes_block(node), visited, irg_set, pre, post, env);
67   }
68
69   if (get_irn_op(node) == op_Block) { /* block */
70     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
71       ir_node * exec = get_irn_n(node, i);
72       ir_node * pred = skip_Proj(exec);
73       if ((get_irn_op(pred) != op_CallBegin
74            && get_irn_op(pred) != op_EndReg
75            && get_irn_op(pred) != op_EndExcept)
76           || eset_contains(irg_set, get_irn_irg(pred))) {
77         irg_walk_cg(exec, visited, irg_set, pre, post, env);
78       }
79     }
80   } else if (get_irn_op(node) == op_Filter) { /* filter */
81     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
82       ir_node * pred = get_irn_n(node, i);
83       if (get_irn_op(pred) == op_Unknown || get_irn_op(pred) == op_Bad) {
84         irg_walk_cg(pred, visited, irg_set, pre, post, env);
85       } else {
86         ir_node * exec;
87         exec = skip_Proj(get_Block_cfgpred(get_nodes_block(node), i));
88
89         if (op_Bad == get_irn_op (exec)) {
90           continue;
91         }
92
93         assert(get_irn_op(exec) == op_CallBegin
94                || get_irn_op(exec) == op_EndReg
95                || get_irn_op(exec) == op_EndExcept);
96         if (eset_contains(irg_set, get_irn_irg(exec))) {
97           current_ir_graph = get_irn_irg(exec);
98           irg_walk_cg(pred, visited, irg_set, pre, post, env);
99           current_ir_graph = rem;
100         }
101       }
102     }
103   } else {                      /* everything else */
104     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
105       irg_walk_cg(get_irn_n(node, i), visited, irg_set, pre, post, env);
106     }
107   }
108
109   if (post) post(node, env);
110
111   current_ir_graph = rem;
112 }
113
114
115 /**
116  * Insert all ir_graphs in irg_set, that are (transitive) reachable.
117  */
118 static void collect_irgs(ir_node * node, eset * irg_set) {
119   if (is_Call(node)) {
120     int i;
121     for (i = get_Call_n_callees(node) - 1; i >= 0; --i) {
122       entity * ent = get_Call_callee(node, i);
123       ir_graph * irg = get_entity_irg(ent);
124       if (irg && !eset_contains(irg_set, irg)) {
125         eset_insert(irg_set, irg);
126         irg_walk_graph(irg, (irg_walk_func *) collect_irgs, NULL, irg_set);
127       }
128     }
129   }
130 }
131
132 /**
133  * specialized version of irg_walk_2, called if only pre callback exists
134  *
135  * @return number of visited nodes
136  */
137 static unsigned
138 irg_walk_2_pre(ir_node *node, irg_walk_func *pre, void * env) {
139   int i;
140   unsigned cnt = 1;
141
142   set_irn_visited(node, current_ir_graph->visited);
143
144   pre(node, env);
145
146   if (node->op != op_Block) {
147     ir_node *pred = get_irn_n(node, -1);
148     if (pred->visited < current_ir_graph->visited)
149       cnt += irg_walk_2_pre(pred, pre, env);
150   }
151   for (i = get_irn_arity(node) - 1; i >= 0; --i) {
152     ir_node *pred = get_irn_n(node, i);
153     if (pred->visited < current_ir_graph->visited)
154       cnt += irg_walk_2_pre(pred, pre, env);
155   }
156   return cnt;
157 }
158
159 /**
160  * specialized version of irg_walk_2, called if only post callback exists
161  *
162  * @return number of visited nodes
163  */
164 static unsigned
165 irg_walk_2_post(ir_node *node, irg_walk_func *post, void * env) {
166   int i;
167   unsigned cnt = 1;
168
169   set_irn_visited(node, current_ir_graph->visited);
170
171   if (node->op != op_Block) {
172     ir_node *pred = get_irn_n(node, -1);
173     if (pred->visited < current_ir_graph->visited)
174       cnt += irg_walk_2_post(pred, post, env);
175   }
176   for (i = get_irn_arity(node) - 1; i >= 0; --i) {
177     ir_node *pred = get_irn_n(node, i);
178     if (pred->visited < current_ir_graph->visited)
179       cnt += irg_walk_2_post(pred, post, env);
180   }
181
182   post(node, env);
183
184   return cnt;
185 }
186
187 /**
188  * specialized version of irg_walk_2, called if pre and post callbacks exist
189  *
190  * @return number of visited nodes
191  */
192 static unsigned
193 irg_walk_2_both(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env) {
194   int i;
195   unsigned cnt = 1;
196
197   set_irn_visited(node, current_ir_graph->visited);
198
199   pre(node, env);
200
201   if (node->op != op_Block) {
202     ir_node *pred = get_irn_n(node, -1);
203     if (pred->visited < current_ir_graph->visited)
204       cnt += irg_walk_2_both(pred, pre, post, env);
205   }
206   for (i = get_irn_arity(node) - 1; i >= 0; --i) {
207     ir_node *pred = get_irn_n(node, i);
208     if (pred->visited < current_ir_graph->visited)
209       cnt += irg_walk_2_both(pred, pre, post, env);
210   }
211
212   post(node, env);
213
214   return cnt;
215 }
216
217 /**
218  * Intraprozedural graph walker.
219  *
220  * @return number of visited nodes
221  */
222 static unsigned
223 irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
224 {
225   if (node->visited < current_ir_graph->visited) {
226     if      (!post) return irg_walk_2_pre (node, pre, env);
227     else if (!pre)  return irg_walk_2_post(node, post, env);
228     else            return irg_walk_2_both(node, pre, post, env);
229   }
230   return 0;
231 }
232
233 /* a counter */
234 static unsigned nodes_touched = 0;
235
236 /*
237  * generic graph walker
238  */
239 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
240 {
241   assert(is_ir_node(node));
242
243   if (get_interprocedural_view()) {
244     eset * irg_set = eset_create();
245     unsigned long visited;
246     ir_graph * irg;
247     assert(get_irp_ip_view_state() == ip_view_valid);
248
249     set_interprocedural_view(0);
250     eset_insert(irg_set, current_ir_graph);
251     irg_walk(node, (irg_walk_func *) collect_irgs, NULL, irg_set);
252     set_interprocedural_view(1);
253     visited = get_max_irg_visited() + 1;
254     for (irg = eset_first(irg_set); irg; irg = eset_next(irg_set)) {
255       set_irg_visited(irg, visited);
256     }
257     irg_walk_cg(node, visited, irg_set, pre, post, env);
258     eset_destroy(irg_set);
259   } else {
260     inc_irg_visited(current_ir_graph);
261     nodes_touched = irg_walk_2(node, pre, post, env);
262   }
263   return;
264 }
265
266 /*
267  * walk over a graph
268  */
269 void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
270   ir_graph * rem = current_ir_graph;
271
272   hook_irg_walk(irg, (generic_func *)pre, (generic_func *)post);
273   current_ir_graph = irg;
274   irg_walk(get_irg_end(irg), pre, post, env);
275   irg->estimated_node_count = nodes_touched;
276   current_ir_graph = rem;
277 }
278
279 /* Executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
280    Sets current_ir_graph properly for each walk.  Conserves current
281    current_ir_graph. */
282 void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
283   int i;
284   ir_graph *irg, *rem;
285
286   rem = current_ir_graph;
287
288   for (i = 0; i < get_irp_n_irgs(); i++) {
289     irg = get_irp_irg(i);
290     current_ir_graph = irg;
291     irg_walk(get_irg_end(irg), pre, post, env);
292   }
293   current_ir_graph = rem;
294 }
295
296 /***************************************************************************/
297
298 /**
299  * Returns current_ir_graph and sets it to the irg of predecessor index
300  * of node n.
301  */
302 static INLINE ir_graph *
303 switch_irg (ir_node *n, int index) {
304   ir_graph *old_current = current_ir_graph;
305
306   if (get_interprocedural_view()) {
307     /* Only Filter and Block nodes can have predecessors in other graphs. */
308     if (get_irn_op(n) == op_Filter)
309       n = get_nodes_block(n);
310     if (get_irn_op(n) == op_Block) {
311       ir_node *cfop = skip_Proj(get_Block_cfgpred(n, index));
312       if (is_ip_cfop(cfop)) {
313         current_ir_graph = get_irn_irg(cfop);
314       }
315     }
316   }
317
318   return old_current;
319 }
320
321 static void
322 cg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
323 {
324   int i;
325   ir_graph *rem = NULL;
326   assert(node);
327
328   if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
329     set_irn_visited(node, get_irg_visited(current_ir_graph));
330
331     if (pre) pre(node, env);
332
333     if (is_no_Block(node))
334       cg_walk_2(get_nodes_block(node), pre, post, env);
335     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
336       rem = switch_irg(node, i);  /* @@@ AS: Is this wrong? We do have to
337                                              switch to the irg of the predecessor, don't we? */
338       cg_walk_2(get_irn_n(node, i), pre, post, env);
339       current_ir_graph = rem;
340     }
341
342     if (post) post(node, env);
343   }
344   return;
345 }
346
347
348 /* Walks all irgs in interprocedural view.  Visits each node only once. */
349 void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
350   int i;
351   ir_graph *rem = current_ir_graph;
352   int rem_view = get_interprocedural_view();
353
354   set_interprocedural_view(1);
355
356   inc_max_irg_visited();
357   /* Fix all irg_visited flags */
358   for (i = 0; i < get_irp_n_irgs(); i++)
359     set_irg_visited(get_irp_irg(i), get_max_irg_visited());
360
361   /* Walk starting at unreachable procedures. Only these
362    * have End blocks visible in interprocedural view. */
363   for (i = 0; i < get_irp_n_irgs(); i++) {
364     ir_node *sb;
365     current_ir_graph = get_irp_irg(i);
366
367     sb = get_irg_start_block(current_ir_graph);
368
369     if ((get_Block_n_cfgpreds(sb) > 1) ||
370     (get_nodes_block(get_Block_cfgpred(sb, 0)) != sb)) continue;
371
372     cg_walk_2(get_irg_end(current_ir_graph), pre, post, env);
373   }
374
375   /* Check whether we walked all procedures: there could be procedures
376      with cyclic calls but no call from the outside. */
377   for (i = 0; i < get_irp_n_irgs(); i++) {
378     ir_node *sb;
379     current_ir_graph = get_irp_irg(i);
380
381     /* Test start block: if inner procedure end and end block are not
382      * visible and therefore not marked. */
383     sb = get_irg_start_block(current_ir_graph);
384     if (get_irn_visited(sb) < get_irg_visited(current_ir_graph)) {
385       cg_walk_2(sb, pre, post, env);
386     }
387   }
388
389   /* Walk all endless loops in inner procedures.
390    * We recognize an inner procedure if the End node is not visited. */
391   for (i = 0; i < get_irp_n_irgs(); i++) {
392     ir_node *e;
393     current_ir_graph = get_irp_irg(i);
394     e = get_irg_end(current_ir_graph);
395     if (get_irn_visited(e) < get_irg_visited(current_ir_graph)) {
396       int j;
397       /* Don't visit the End node. */
398       for (j = 0; j < get_End_n_keepalives(e); j++)
399     cg_walk_2(get_End_keepalive(e, j), pre, post, env);
400     }
401   }
402
403   set_interprocedural_view(rem_view);
404   current_ir_graph = rem;
405 }
406
407
408 /***************************************************************************/
409
410 /* Walks back from n until it finds a real cf op. */
411 static ir_node *get_cf_op(ir_node *n) {
412   ir_node *pred;
413
414   n = skip_Id(n);
415   n = skip_Tuple(n);
416   pred = skip_Proj(n);
417   if (!(is_cfop(pred) || is_fragile_op(pred) ||
418     (get_irn_op(pred) == op_Bad)))
419     n = get_cf_op(n);
420
421   return skip_Proj(n);
422 }
423
424 static void irg_block_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
425 {
426   int i;
427
428   if (Block_not_block_visited(node)) {
429     mark_Block_block_visited(node);
430
431     if(pre) pre(node, env);
432
433     for(i = get_Block_n_cfgpreds(node) - 1; i >= 0; --i) {
434       /* find the corresponding predecessor block. */
435       ir_node *pred = get_cf_op(get_Block_cfgpred(node, i));
436       pred = get_nodes_block(pred);
437       if(get_irn_opcode(pred) == iro_Block) {
438         /* recursion */
439         irg_block_walk_2(pred, pre, post, env);
440       }
441       else {
442         assert(get_irn_opcode(pred) == iro_Bad);
443       }
444     }
445
446     if(post) post(node, env);
447   }
448   return;
449 }
450
451
452 /* walks only over Block nodes in the graph.  Has it's own visited
453    flag, so that it can be interleaved with the other walker.         */
454 void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
455 {
456   ir_node *block, *pred;
457   int i;
458
459   hook_irg_block_walk(current_ir_graph, node, (generic_func *)pre, (generic_func *)post);
460
461   assert(node);
462   assert(!get_interprocedural_view());   /* interprocedural_view not implemented, because it
463                     * interleaves with irg_walk */
464   inc_irg_block_visited(current_ir_graph);
465   if (is_no_Block(node)) block = get_nodes_block(node); else block = node;
466   assert(get_irn_op(block) == op_Block);
467   irg_block_walk_2(block, pre, post, env);
468
469   /* keepalive: the endless loops ... */
470   if (get_irn_op(node) == op_End) {
471     int arity = get_irn_arity(node);
472     for (i = 0; i < arity; i++) {
473       pred = get_irn_n(node, i);
474       if (get_irn_op(pred) == op_Block)
475         irg_block_walk_2(pred, pre, post, env);
476     }
477     /* Sometimes the blocks died, but are still reachable through Phis.
478      * Make sure the algorithms that try to remove these reach them. */
479     for (i = 0; i < arity; i++) {
480       pred = get_irn_n(node, i);
481       if (get_irn_op(pred) == op_Phi) {
482         ir_node *block = get_nodes_block(pred);
483
484         if (! is_Bad(block))
485           irg_block_walk_2(block, pre, post, env);
486       }
487     }
488   }
489
490   return;
491 }
492
493 /*
494  * walk over a graph block wise
495  */
496 void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre,
497               irg_walk_func *post, void *env) {
498   ir_graph * rem = current_ir_graph;
499   current_ir_graph = irg;
500   irg_block_walk(get_irg_end(irg), pre, post, env);
501   current_ir_graph = rem;
502 }
503
504 /*
505  * Additionally walk over all anchors. Do NOT increase the visit flag.
506  */
507 void irg_walk_anchors(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
508   int i;
509   ir_graph * rem = current_ir_graph;
510   current_ir_graph = irg;
511
512   for (i = 0; i < anchor_max; ++i) {
513     ir_node *anchor = irg->anchors[i];
514
515     irg_walk_2(anchor, pre, post, env);
516   }
517   current_ir_graph = rem;
518 }
519
520 /********************************************************************/
521
522 typedef struct walk_env {
523   irg_walk_func *pre;
524   irg_walk_func *post;
525   void *env;
526 } walk_env;
527
528 /**
529  * Walk to all constant expressions in this entity.
530  */
531 static void walk_entity(entity *ent, void *env)
532 {
533   walk_env *my_env = (walk_env *)env;
534
535   if (get_entity_variability(ent) != variability_uninitialized) {
536     if (is_atomic_entity(ent)) {
537       irg_walk(get_atomic_ent_value(ent), my_env->pre, my_env->post, my_env->env);
538     }
539     else {
540       int i, n_vals = get_compound_ent_n_values(ent);
541
542       for (i = 0; i < n_vals; i++)
543         irg_walk(get_compound_ent_value(ent, i), my_env->pre, my_env->post, my_env->env);
544     }
545   }
546 }
547
548 /* Walks over all code in const_code_irg. */
549 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env) {
550   int i, j;
551   walk_env my_env;
552
553   ir_graph *rem = current_ir_graph;
554   current_ir_graph = get_const_code_irg();
555   inc_irg_visited(current_ir_graph);
556
557   my_env.pre = pre;
558   my_env.post = post;
559   my_env.env = env;
560
561   /* Walk all types that can contain constant entities.  */
562   walk_types_entities(get_glob_type(), &walk_entity, &my_env);
563   for (i = 0; i < get_irp_n_types(); i++)
564     walk_types_entities(get_irp_type(i), &walk_entity, &my_env);
565   for (i = 0; i < get_irp_n_irgs(); i++)
566     walk_types_entities(get_irg_frame_type(get_irp_irg(i)), &walk_entity, &my_env);
567
568   /* Walk constant array bounds. */
569   for (i = 0; i < get_irp_n_types(); i++) {
570     ir_type *tp = get_irp_type(i);
571     if (is_Array_type(tp)) {
572       for (j = 0; j < get_array_n_dimensions(tp); j++) {
573         ir_node *n = get_array_lower_bound(tp, j);
574         if (n) irg_walk(n, pre, post, env);
575         n = get_array_upper_bound(tp, j);
576         if (n) irg_walk(n, pre, post, env);
577       }
578     }
579   }
580
581   current_ir_graph = rem;
582 }