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