1d1cd868184128595a7db25607c3e4a9671a0221
[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.h" /* visited flag */
28 # include "irprog.h"
29 # include "irgwalk.h"
30 # include "typewalk.h"
31
32 # include "eset.h"
33 # include "array.h"
34
35 /* walk over an interprocedural graph (callgraph). Visits only graphs in irg_set. */
36 static void irg_walk_cg(ir_node * node, int visited, eset * irg_set,
37                         irg_walk_func *pre, irg_walk_func *post, void * env) {
38   int i;
39   ir_graph * rem = current_ir_graph;
40   ir_node * pred;
41
42   assert(node && node->kind==k_ir_node);
43   if (get_irn_visited(node) >= visited) return;
44
45   set_irn_visited(node, visited);
46
47   pred = skip_Proj(node);
48   if (get_irn_op(pred) == op_CallBegin
49       || get_irn_op(pred) == op_EndReg
50       || get_irn_op(pred) == op_EndExcept) {
51     current_ir_graph = get_irn_irg(pred);
52   }
53
54   if (pre) pre(node, env);
55
56   if (is_no_Block(node))
57     irg_walk_cg(get_nodes_Block(node), visited, irg_set, pre, post, env);
58
59   if (get_irn_op(node) == op_Block) { /* block */
60     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
61       ir_node * exec = get_irn_n(node, i);
62       ir_node * pred = skip_Proj(exec);
63       if ((get_irn_op(pred) != op_CallBegin
64            && get_irn_op(pred) != op_EndReg
65            && get_irn_op(pred) != op_EndExcept)
66           || eset_contains(irg_set, get_irn_irg(pred))) {
67         irg_walk_cg(exec, visited, irg_set, pre, post, env);
68       }
69     }
70   } else if (get_irn_op(node) == op_Filter) {
71     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
72       ir_node * pred = get_irn_n(node, i);
73       if (get_irn_op(pred) == op_Unknown || get_irn_op(pred) == op_Bad) {
74         irg_walk_cg(pred, visited, irg_set, pre, post, env);
75       } else {
76         ir_node * exec;
77         exec = skip_Proj(get_Block_cfgpred(get_nodes_Block(node), i));
78         assert(get_irn_op(exec) == op_CallBegin
79                || get_irn_op(exec) == op_EndReg
80                || get_irn_op(exec) == op_EndExcept);
81         if (eset_contains(irg_set, get_irn_irg(exec))) {
82           current_ir_graph = get_irn_irg(exec);
83           irg_walk_cg(pred, visited, irg_set, pre, post, env);
84           current_ir_graph = rem;
85         }
86       }
87     }
88   } else {
89     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
90       irg_walk_cg(get_irn_n(node, i), visited, irg_set, pre, post, env);
91     }
92   }
93
94   if (post) post(node, env);
95
96   current_ir_graph = rem;
97 }
98
99
100 /* Insert all ir_graphs in irg_set, that are (transitive) reachable. */
101 static void collect_irgs(ir_node * node, eset * irg_set) {
102   if (get_irn_op(node) == op_Call) {
103     int i;
104     for (i = get_Call_n_callees(node) - 1; i >= 0; --i) {
105       entity * ent = get_Call_callee(node, i);
106       ir_graph * irg = ent ? get_entity_irg(ent) : NULL;
107       if (irg && !eset_contains(irg_set, irg)) {
108         eset_insert(irg_set, irg);
109         irg_walk_graph(irg, (irg_walk_func *) collect_irgs, NULL, irg_set);
110       }
111     }
112   }
113 }
114
115 static void
116 irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
117 {
118   int i;
119   assert(node && node->kind==k_ir_node);
120
121   if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
122     set_irn_visited(node, get_irg_visited(current_ir_graph));
123
124     if (pre) pre(node, env);
125
126     if (is_no_Block(node))
127       irg_walk_2(get_nodes_Block(node), pre, post, env);
128     for (i = get_irn_arity(node) - 1; i >= 0; --i)
129       irg_walk_2(get_irn_n(node, i), pre, post, env);
130
131     if (post) post(node, env);
132   }
133   return;
134 }
135
136
137 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
138 {
139   assert(node  && node->kind==k_ir_node);
140   if (interprocedural_view) {
141     eset * irg_set = eset_create();
142     int visited;
143     ir_graph * irg;
144     interprocedural_view = false;
145     eset_insert(irg_set, current_ir_graph);
146     irg_walk(node, (irg_walk_func *) collect_irgs, NULL, irg_set);
147     interprocedural_view = true;
148     visited = get_max_irg_visited() + 1;
149     irg_walk_cg(node, visited, irg_set, pre, post, env);
150     for (irg = eset_first(irg_set); irg; irg = eset_next(irg_set)) {
151       set_irg_visited(irg, visited);
152     }
153     eset_destroy(irg_set);
154   } else {
155     inc_irg_visited(current_ir_graph);
156     irg_walk_2(node, pre, post, env);
157   }
158   return;
159 }
160
161
162 void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
163   ir_graph * rem = current_ir_graph;
164   current_ir_graph = irg;
165   irg_walk(get_irg_end(irg), pre, post, env);
166   current_ir_graph = rem;
167 }
168
169 /* Executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
170    Sets current_ir_graph properly for each walk.  Conserves current
171    current_ir_graph. */
172 void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
173   int i;
174   ir_graph *irg, *rem;
175
176   rem = current_ir_graph;
177
178   for (i = 0; i < get_irp_n_irgs(); i++) {
179     irg = get_irp_irg(i);
180     current_ir_graph = irg;
181     irg_walk(get_irg_end(irg), pre, post, env);
182   }
183   current_ir_graph = rem;
184 }
185
186 /***************************************************************************/
187
188 /* Returns current_ir_graph and sets it to the irg of predecessor index
189    of node n. */
190 static INLINE ir_graph *
191 switch_irg (ir_node *n, int index) {
192   ir_graph *old_current = current_ir_graph;
193
194   if (interprocedural_view) {
195     /* Only Filter and Block nodes can have predecessors in other graphs. */
196     if (get_irn_op(n) == op_Filter)
197       n = get_nodes_Block(n);
198     if (get_irn_op(n) == op_Block) {
199       ir_node *cfop = skip_Proj(get_Block_cfgpred(n, index));
200       if (is_ip_cfop(cfop)) {
201         current_ir_graph = get_irn_irg(cfop);
202       }
203     }
204   }
205
206   return old_current;
207 }
208
209 static void
210 cg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
211 {
212   int i;
213   ir_graph *rem = NULL;
214   assert(node);
215
216   if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
217     set_irn_visited(node, get_irg_visited(current_ir_graph));
218
219     if (pre) pre(node, env);
220
221     if (is_no_Block(node))
222       cg_walk_2(get_nodes_Block(node), pre, post, env);
223     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
224       rem = switch_irg(node, i);
225       cg_walk_2(get_irn_n(node, i), pre, post, env);
226       current_ir_graph = rem;
227     }
228
229     if (post) post(node, env);
230   }
231   return;
232 }
233
234
235 /* Walks all irgs in interprocedural view.  Visits each node only once. */
236 void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
237   int i;
238   ir_graph *rem = current_ir_graph;
239   int rem_view = interprocedural_view;
240
241   interprocedural_view = true;
242
243   inc_max_irg_visited();
244   /* Fix all irg_visited flags */
245   for (i = 0; i < get_irp_n_irgs(); i++)
246     set_irg_visited(get_irp_irg(i), get_max_irg_visited());
247
248   /* Walk starting at unreachable procedures. */
249   for (i = 0; i < get_irp_n_irgs(); i++) {
250     ir_node *sb;
251     current_ir_graph = get_irp_irg(i);
252
253     sb = get_irg_start_block(current_ir_graph);
254     if ((get_Block_n_cfgpreds(sb) > 1) ||
255         (get_nodes_Block(get_Block_cfgpred(sb, 0)) != sb)) continue;
256
257     cg_walk_2(get_irg_end(current_ir_graph), pre, post, env);
258   }
259
260   interprocedural_view = rem_view;
261   current_ir_graph = rem;
262 }
263
264
265 /***************************************************************************/
266
267 /* Walks back from n until it finds a real cf op. */
268 static ir_node *get_cf_op(ir_node *n) {
269   ir_node *pred;
270
271   n = skip_nop(n);
272   n = skip_Tuple(n);
273   pred = skip_Proj(n);
274   if (!(is_cfop(pred) || is_fragile_op(pred) ||
275         (get_irn_op(pred) == op_Bad)))
276     n = get_cf_op(n);
277
278   return skip_Proj(n);
279 }
280
281 static void irg_block_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
282 {
283   int i;
284   assert(get_irn_opcode(node) == iro_Block);
285
286   if(get_Block_block_visited(node) < get_irg_block_visited(current_ir_graph)) {
287     set_Block_block_visited(node, get_irg_block_visited(current_ir_graph));
288
289     if(pre) pre(node, env);
290
291     for(i = get_Block_n_cfgpreds(node) - 1; i >= 0; --i) {
292       /* find the corresponding predecessor block. */
293       ir_node *pred = get_cf_op(get_Block_cfgpred(node, i));
294       pred = get_nodes_Block(pred);
295       if(get_irn_opcode(pred) == iro_Block) {
296         /* recursion */
297         irg_block_walk_2(pred, pre, post, env);
298       }
299       else {
300         assert(get_irn_opcode(pred) == iro_Bad);
301       }
302     }
303
304     if(post) post(node, env);
305   }
306   return;
307 }
308
309
310 /* walks only over Block nodes in the graph.  Has it's own visited
311    flag, so that it can be interleaved with the other walker.         */
312 void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
313 {
314   ir_node *block, *pred;
315   int i;
316
317   assert(node);
318   assert(!interprocedural_view);   /* interprocedural_view not implemented, because it
319                                     * interleaves with irg_walk */
320   inc_irg_block_visited(current_ir_graph);
321   if (is_no_Block(node)) block = get_nodes_Block(node); else block = node;
322   assert(get_irn_opcode(block)  == iro_Block);
323   irg_block_walk_2(block, pre, post, env);
324   /* keepalive: the endless loops ... */
325   if (get_irn_op(node) == op_End)
326     for (i = 0; i < get_irn_arity(node); i++) {
327       pred = get_irn_n(node, i);
328       if (get_irn_op(pred) == op_Block)
329         irg_block_walk_2(pred, pre, post, env);
330     }
331
332   return;
333 }
334
335
336 void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre,
337                           irg_walk_func *post, void *env) {
338   ir_graph * rem = current_ir_graph;
339   current_ir_graph = irg;
340   irg_block_walk(get_irg_end(irg), pre, post, env);
341   current_ir_graph = rem;
342 }
343
344 /********************************************************************/
345
346 typedef struct walk_env {
347   irg_walk_func *pre;
348   irg_walk_func *post;
349   void *env;
350 } walk_env;
351
352 /* Walk to all constant expressions in this entity. */
353 static void walk_entity(entity *ent, void *env) {
354   walk_env *my_env = (walk_env *)env;
355   if (get_entity_variability(ent) != uninitialized) {
356     if (is_atomic_entity(ent)) {
357       irg_walk(get_atomic_ent_value(ent), my_env->pre, my_env->post, my_env->env);
358     } else {
359       int i;
360       for (i = 0; i < get_compound_ent_n_values(ent); i++) {
361         irg_walk(get_compound_ent_value(ent, i), my_env->pre, my_env->post, my_env->env);
362       }
363     }
364   }
365 }
366
367 /* Walks over all code in const_code_irg. */
368 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env) {
369   int i, j;
370   walk_env my_env;
371
372   ir_graph *rem = current_ir_graph;
373   current_ir_graph = get_const_code_irg();
374   inc_irg_visited(current_ir_graph);
375
376   my_env.pre = pre;
377   my_env.post = post;
378   my_env.env = env;
379
380   /* Walk all types that can contain constant entities.  */
381   walk_types_entities(get_glob_type(), &walk_entity, &my_env);
382   for (i = 0; i < get_irp_n_types(); i++)
383     walk_types_entities(get_irp_type(i), &walk_entity, &my_env);
384   for (i = 0; i < get_irp_n_irgs(); i++)
385     walk_types_entities(get_irg_frame_type(get_irp_irg(i)), &walk_entity, &my_env);
386
387   /* Walk constant array bounds. */
388   for (i = 0; i < get_irp_n_types(); i++) {
389     type *tp = get_irp_type(i);
390     if (is_array_type(tp)) {
391       for (j = 0; j < get_array_n_dimensions(tp); j++) {
392         ir_node *n;
393         n = get_array_lower_bound(tp, j);
394         if (n) irg_walk(n, pre, post, env);
395         n = get_array_upper_bound(tp, j);
396         if (n) irg_walk(n, pre, post, env);
397       }
398     }
399   }
400
401   current_ir_graph = rem;
402 }
403
404
405 /********************************************************************/
406 /** Walking support for interprocedural analysis                   **/
407 /**                                                                **/
408 /** @@@ Don't use, not operational yet, doesn't grok recursions!!  **/
409 /** @@@ Header for irgwalk.h, here until it works. **/
410 /**                                                                **/
411 /** Interprocedural walking should not walk all predecessors of    **/
412 /** all nodes.  When leaving a procedure the walker should only    **/
413 /** follow the edge corresponding to the most recent entry of the  **/
414 /** procedure.  The following functions use an internal stack to   **/
415 /** remember the current call site of a procedure.                 **/
416 /** They also set current_ir_graph correctly.                      **/
417 /**                                                                **/
418 /** Usage example:                                                 **/
419 /**                                                                **/
420 /** void init_ip_walk ();                                          **/
421 /** work_on_graph(some_end_node);                                  **/
422 /** void finish_ip_walk();                                         **/
423 /**                                                                **/
424 /** work_on_graph(ir_node *n) {                                    **/
425 /**   for (i = 0; i < get_irn_arity(n); i++) {                     **/
426 /**     if (...) continue;                                         **/
427 /**     ir_node *m = get_irn_ip_pred(n, i);                        **/
428 /**     if !m continue;                                            **/
429 /**     work_on_graph(m);                                          **/
430 /**     return_recur(n, i);                                        **/
431 /**   }                                                            **/
432 /** }                                                              **/
433 /********************************************************************/
434
435 /* Call for i in {0|-1 ... get_irn_arity(n)}.
436    If n is a conventional node returns the same node as get_irn_n(n, i).
437    If the predecessors of n are in the callee of the procedure n belongs
438    to, returns get_irn_n(n, i) if this node is in the callee on the top
439    of the stack, else returns NULL.
440    If the predecessors of n are in a procedure called by the procedure n
441    belongs to pushes the caller on the caller stack in the callee.
442    Sets current_ir_graph to the graph the node returned is in. */
443 ir_node *get_irn_ip_pred(ir_node *n, int pos);
444
445 /* If get_irn_ip_pred() returned a node (not NULL) this must be
446    called to clear up the stacks.
447    Sets current_ir_graph to the graph n is in. */
448 void return_recur(ir_node *n, int pos);
449
450
451 /********************************************************************/
452 /** Walking support for interprocedural analysis                   **/
453 /********************************************************************/
454
455 #define MIN_STACK_SIZE 40
456
457 typedef struct callsite_stack {
458   int tos;
459   ir_node **s;
460 } callsite_stack;
461
462 /* Access the stack in the irg **************************************/
463
464 static INLINE void
465 set_irg_callsite_stack(ir_graph *g, callsite_stack *s) {
466   set_irg_link(g, s);
467 }
468
469 static INLINE callsite_stack *
470 get_irg_callsite_stack(ir_graph *g) {
471   return (callsite_stack *) get_irg_link(g);
472 }
473
474 /* A stack of callsites *********************************************/
475
476 /* @@@ eventually change the implementation so the new_ only sets the field
477    to NULL, and the stack is only allocated if used.  Saves Memory! */
478 static INLINE callsite_stack *
479 new_callsite_stack(ir_graph *g) {
480   callsite_stack *res = (callsite_stack *)malloc(sizeof(callsite_stack));
481   res->tos = 0;
482   res->s = NEW_ARR_F (ir_node *, MIN_STACK_SIZE);
483   set_irg_callsite_stack(g, res);
484   return(res);
485 }
486
487 static INLINE void
488 free_callsite_stack(ir_graph *g) {
489   callsite_stack *s = get_irg_callsite_stack(g);
490   DEL_ARR_F(s->s);
491   free(s);
492 }
493
494 static INLINE void
495 push_callsite(ir_graph *callee, ir_node *callsite) {
496   callsite_stack *s = get_irg_callsite_stack(callee);
497   if (s->tos == ARR_LEN(s->s)) {
498     int nlen = ARR_LEN (s->s) * 2;
499     ARR_RESIZE (ir_node *, s->s, nlen);
500   }
501   s->s[s->tos] = callsite;
502   s->tos++;
503 }
504
505 static INLINE ir_node *
506 get_top_of_callsite_stack(ir_graph *callee) {
507   callsite_stack *s = get_irg_callsite_stack(callee);
508   return (s->s[s->tos-1]);
509 }
510
511 static INLINE
512 ir_node * pop_callsite(ir_graph *callee) {
513   callsite_stack *s = get_irg_callsite_stack(callee);
514   s->tos--;
515   return (s->s[s->tos]);
516 }
517
518
519 /* Initialization routines ******************************************/
520
521 void init_ip_walk (void) {
522   int i;
523   for (i = 0; i < get_irp_n_irgs(); i++)
524     new_callsite_stack(get_irp_irg(i));
525 }
526
527 void finish_ip_walk(void) {
528   int i;
529   for (i = 0; i < get_irp_n_irgs(); i++)
530     free_callsite_stack(get_irp_irg(i));
531   set_irg_link(get_irp_irg(i), NULL);
532 }
533
534 /* walker routines **************************************************/
535
536 /* cf_pred is End* */
537 static INLINE void
538 enter_procedure(ir_node *block, ir_node *cf_pred, int pos) {
539   ir_node *callbegin;
540   ir_graph *irg = get_irn_irg(cf_pred);
541
542   assert(interprocedural_view);
543
544   interprocedural_view = 0;
545   callbegin = skip_Proj(get_irn_n(block, 0));
546   assert(get_irn_op(callbegin) == op_CallBegin);
547   interprocedural_view = 1;
548
549   push_callsite(irg, callbegin);
550   current_ir_graph = irg;
551 }
552
553 /* cf_pred is CallBegin */
554 static INLINE bool
555 leave_procedure(ir_node *block, ir_node *cf_pred, int pos) {
556   ir_node *tos = get_top_of_callsite_stack(current_ir_graph);
557
558   assert(get_irn_op(cf_pred) == op_CallBegin);
559
560   if (tos == cf_pred) {
561     /* We entered this procedure by the call pred pos refers to. */
562     pop_callsite(current_ir_graph);
563     current_ir_graph = get_CallBegin_irg(cf_pred);
564     return true;
565   } else {
566     /* We won't walk. */
567     return false;
568   }
569 }
570
571 ir_node *get_irn_ip_pred(ir_node *n, int pos) {
572
573   if (interprocedural_view) {
574
575     /* Find the cf_pred refering to pos. */
576     ir_node *block = n;
577     ir_node *cf_pred;
578     if (get_irn_opcode(n) == iro_Filter) block = get_nodes_Block(n);
579     cf_pred = skip_Proj(get_irn_n(block, pos));
580
581     /* Check whether we enter or leave a procedure and act according. */
582     if ((get_irn_op(cf_pred) == op_EndReg) ||
583         (get_irn_op(cf_pred) == op_EndExcept))
584       enter_procedure(block, cf_pred, pos);
585     if (get_irn_op(cf_pred) == op_CallBegin)
586       if (!leave_procedure(block, cf_pred, pos)) return NULL;
587   }
588
589   return get_irn_n(n, pos);
590 }
591
592 static INLINE void
593 re_enter_procedure(ir_node *block, ir_node *cf_pred, int pos) {
594   ir_node *callbegin = pop_callsite(current_ir_graph);
595   assert(interprocedural_view);
596   current_ir_graph = get_CallBegin_irg(callbegin);
597 }
598
599 static INLINE void
600 re_leave_procedure(ir_node *block, ir_node *cf_pred, int pos) {
601   ir_node *proj;
602   ir_graph *callee;
603
604   assert(get_irn_op(cf_pred) == op_CallBegin);
605
606   /* Find the irg block is in. */
607   proj = get_Block_cg_cfgpred(block, pos);
608   assert(is_Proj(proj));
609   callee = get_entity_irg(get_Call_callee(get_CallBegin_call(cf_pred),
610                                           get_Proj_proj(proj)));
611   current_ir_graph = callee;
612   push_callsite(callee, cf_pred);
613 }
614
615 void
616 return_recur(ir_node *n, int pos) {
617   ir_node *block;
618   ir_node *cf_pred;
619
620   if (!interprocedural_view) return;
621
622   /* Find the cf_pred refering to pos. */
623   block = n;
624   if (get_irn_opcode(n) == iro_Filter) block = get_nodes_Block(n);
625   cf_pred = skip_Proj(get_irn_n(block, pos));
626
627   /* Check whether we re_enter or re_leave a procedure and act according. */
628   if ((get_irn_op(cf_pred) == op_EndReg) ||
629       (get_irn_op(cf_pred) == op_EndExcept))
630     re_enter_procedure(block, cf_pred, pos);
631   if (get_irn_op(cf_pred) == op_CallBegin)
632     re_leave_procedure(block, cf_pred, pos);
633 }