3 * File name: ir/ir/irgwalk.c
5 * Author: Boris Boesler
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1999-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
14 * traverse an ir graph
15 * - execute the pre function before recursion
16 * - execute the post function after recursion
26 # include "irnode_t.h"
27 # include "irgraph.h" /* visited flag */
30 # include "typewalk.h"
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) {
39 ir_graph * rem = current_ir_graph;
42 assert(node && node->kind==k_ir_node);
43 if (get_irn_visited(node) >= visited) return;
45 set_irn_visited(node, visited);
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);
54 if (pre) pre(node, env);
56 if (is_no_Block(node))
57 irg_walk_cg(get_nodes_Block(node), visited, irg_set, pre, post, env);
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);
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);
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;
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);
94 if (post) post(node, env);
96 current_ir_graph = rem;
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) {
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);
116 irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
119 assert(node && node->kind==k_ir_node);
121 if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
122 set_irn_visited(node, get_irg_visited(current_ir_graph));
124 if (pre) pre(node, env);
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);
131 if (post) post(node, env);
137 void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
139 assert(node && node->kind==k_ir_node);
140 if (interprocedural_view) {
141 eset * irg_set = eset_create();
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);
153 eset_destroy(irg_set);
155 inc_irg_visited(current_ir_graph);
156 irg_walk_2(node, pre, post, env);
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;
169 /* Executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
170 Sets current_ir_graph properly for each walk. Conserves current
172 void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
176 rem = current_ir_graph;
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);
183 current_ir_graph = rem;
186 /***************************************************************************/
188 /* Returns current_ir_graph and sets it to the irg of predecessor index
190 static INLINE ir_graph *
191 switch_irg (ir_node *n, int index) {
192 ir_graph *old_current = current_ir_graph;
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);
210 cg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
213 ir_graph *rem = NULL;
216 if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
217 set_irn_visited(node, get_irg_visited(current_ir_graph));
219 if (pre) pre(node, env);
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;
229 if (post) post(node, env);
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) {
238 ir_graph *rem = current_ir_graph;
239 int rem_view = interprocedural_view;
241 interprocedural_view = true;
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());
248 /* Walk starting at unreachable procedures. */
249 for (i = 0; i < get_irp_n_irgs(); i++) {
251 current_ir_graph = get_irp_irg(i);
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;
257 cg_walk_2(get_irg_end(current_ir_graph), pre, post, env);
260 interprocedural_view = rem_view;
261 current_ir_graph = rem;
265 /***************************************************************************/
267 /* Walks back from n until it finds a real cf op. */
268 static ir_node *get_cf_op(ir_node *n) {
274 if (!(is_cfop(pred) || is_fragile_op(pred) ||
275 (get_irn_op(pred) == op_Bad)))
281 static void irg_block_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
284 assert(get_irn_opcode(node) == iro_Block);
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));
289 if(pre) pre(node, env);
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) {
297 irg_block_walk_2(pred, pre, post, env);
300 assert(get_irn_opcode(pred) == iro_Bad);
304 if(post) post(node, env);
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)
314 ir_node *block, *pred;
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);
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;
344 /********************************************************************/
346 typedef struct walk_env {
352 /* Walk to all constant expressions in this entity. */
353 static void walk_entity(entity *ent, void *env)
355 walk_env *my_env = (walk_env *)env;
357 if (get_entity_variability(ent) != variability_uninitialized) {
358 if (is_atomic_entity(ent)) {
359 irg_walk(get_atomic_ent_value(ent), my_env->pre, my_env->post, my_env->env);
362 int i, n = get_compound_ent_n_values(ent);
364 for (i = 0; i < n; i++)
365 irg_walk(get_compound_ent_value(ent, i), my_env->pre, my_env->post, my_env->env);
370 /* Walks over all code in const_code_irg. */
371 void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env) {
375 ir_graph *rem = current_ir_graph;
376 current_ir_graph = get_const_code_irg();
377 inc_irg_visited(current_ir_graph);
383 /* Walk all types that can contain constant entities. */
384 walk_types_entities(get_glob_type(), &walk_entity, &my_env);
385 for (i = 0; i < get_irp_n_types(); i++)
386 walk_types_entities(get_irp_type(i), &walk_entity, &my_env);
387 for (i = 0; i < get_irp_n_irgs(); i++)
388 walk_types_entities(get_irg_frame_type(get_irp_irg(i)), &walk_entity, &my_env);
390 /* Walk constant array bounds. */
391 for (i = 0; i < get_irp_n_types(); i++) {
392 type *tp = get_irp_type(i);
393 if (is_array_type(tp)) {
394 for (j = 0; j < get_array_n_dimensions(tp); j++) {
396 n = get_array_lower_bound(tp, j);
397 if (n) irg_walk(n, pre, post, env);
398 n = get_array_upper_bound(tp, j);
399 if (n) irg_walk(n, pre, post, env);
404 current_ir_graph = rem;
408 /********************************************************************/
409 /** Walking support for interprocedural analysis **/
411 /** @@@ Don't use, not operational yet, doesn't grok recursions!! **/
412 /** @@@ Header for irgwalk.h, here until it works. **/
414 /** Interprocedural walking should not walk all predecessors of **/
415 /** all nodes. When leaving a procedure the walker should only **/
416 /** follow the edge corresponding to the most recent entry of the **/
417 /** procedure. The following functions use an internal stack to **/
418 /** remember the current call site of a procedure. **/
419 /** They also set current_ir_graph correctly. **/
421 /** Usage example: **/
423 /** void init_ip_walk (); **/
424 /** work_on_graph(some_end_node); **/
425 /** void finish_ip_walk(); **/
427 /** work_on_graph(ir_node *n) { **/
428 /** for (i = 0; i < get_irn_arity(n); i++) { **/
429 /** if (...) continue; **/
430 /** ir_node *m = get_irn_ip_pred(n, i); **/
431 /** if !m continue; **/
432 /** work_on_graph(m); **/
433 /** return_recur(n, i); **/
436 /********************************************************************/
438 /* Call for i in {0|-1 ... get_irn_arity(n)}.
439 If n is a conventional node returns the same node as get_irn_n(n, i).
440 If the predecessors of n are in the callee of the procedure n belongs
441 to, returns get_irn_n(n, i) if this node is in the callee on the top
442 of the stack, else returns NULL.
443 If the predecessors of n are in a procedure called by the procedure n
444 belongs to pushes the caller on the caller stack in the callee.
445 Sets current_ir_graph to the graph the node returned is in. */
446 ir_node *get_irn_ip_pred(ir_node *n, int pos);
448 /* If get_irn_ip_pred() returned a node (not NULL) this must be
449 called to clear up the stacks.
450 Sets current_ir_graph to the graph n is in. */
451 void return_recur(ir_node *n, int pos);
454 /********************************************************************/
455 /** Walking support for interprocedural analysis **/
456 /********************************************************************/
458 #define MIN_STACK_SIZE 40
460 typedef struct callsite_stack {
465 /* Access the stack in the irg **************************************/
468 set_irg_callsite_stack(ir_graph *g, callsite_stack *s) {
472 static INLINE callsite_stack *
473 get_irg_callsite_stack(ir_graph *g) {
474 return (callsite_stack *) get_irg_link(g);
477 /* A stack of callsites *********************************************/
479 /* @@@ eventually change the implementation so the new_ only sets the field
480 to NULL, and the stack is only allocated if used. Saves Memory! */
481 static INLINE callsite_stack *
482 new_callsite_stack(ir_graph *g) {
483 callsite_stack *res = (callsite_stack *)malloc(sizeof(callsite_stack));
485 res->s = NEW_ARR_F (ir_node *, MIN_STACK_SIZE);
486 set_irg_callsite_stack(g, res);
491 free_callsite_stack(ir_graph *g) {
492 callsite_stack *s = get_irg_callsite_stack(g);
498 push_callsite(ir_graph *callee, ir_node *callsite) {
499 callsite_stack *s = get_irg_callsite_stack(callee);
500 if (s->tos == ARR_LEN(s->s)) {
501 int nlen = ARR_LEN (s->s) * 2;
502 ARR_RESIZE (ir_node *, s->s, nlen);
504 s->s[s->tos] = callsite;
508 static INLINE ir_node *
509 get_top_of_callsite_stack(ir_graph *callee) {
510 callsite_stack *s = get_irg_callsite_stack(callee);
511 return (s->s[s->tos-1]);
515 ir_node * pop_callsite(ir_graph *callee) {
516 callsite_stack *s = get_irg_callsite_stack(callee);
518 return (s->s[s->tos]);
522 /* Initialization routines ******************************************/
524 void init_ip_walk (void) {
526 for (i = 0; i < get_irp_n_irgs(); i++)
527 new_callsite_stack(get_irp_irg(i));
530 void finish_ip_walk(void) {
532 for (i = 0; i < get_irp_n_irgs(); i++)
533 free_callsite_stack(get_irp_irg(i));
534 set_irg_link(get_irp_irg(i), NULL);
537 /* walker routines **************************************************/
539 /* cf_pred is End* */
541 enter_procedure(ir_node *block, ir_node *cf_pred, int pos) {
543 ir_graph *irg = get_irn_irg(cf_pred);
545 assert(interprocedural_view);
547 interprocedural_view = 0;
548 callbegin = skip_Proj(get_irn_n(block, 0));
549 assert(get_irn_op(callbegin) == op_CallBegin);
550 interprocedural_view = 1;
552 push_callsite(irg, callbegin);
553 current_ir_graph = irg;
556 /* cf_pred is CallBegin */
558 leave_procedure(ir_node *block, ir_node *cf_pred, int pos) {
559 ir_node *tos = get_top_of_callsite_stack(current_ir_graph);
561 assert(get_irn_op(cf_pred) == op_CallBegin);
563 if (tos == cf_pred) {
564 /* We entered this procedure by the call pred pos refers to. */
565 pop_callsite(current_ir_graph);
566 current_ir_graph = get_CallBegin_irg(cf_pred);
574 ir_node *get_irn_ip_pred(ir_node *n, int pos) {
576 if (interprocedural_view) {
578 /* Find the cf_pred refering to pos. */
581 if (get_irn_opcode(n) == iro_Filter) block = get_nodes_Block(n);
582 cf_pred = skip_Proj(get_irn_n(block, pos));
584 /* Check whether we enter or leave a procedure and act according. */
585 if ((get_irn_op(cf_pred) == op_EndReg) ||
586 (get_irn_op(cf_pred) == op_EndExcept))
587 enter_procedure(block, cf_pred, pos);
588 if (get_irn_op(cf_pred) == op_CallBegin)
589 if (!leave_procedure(block, cf_pred, pos)) return NULL;
592 return get_irn_n(n, pos);
596 re_enter_procedure(ir_node *block, ir_node *cf_pred, int pos) {
597 ir_node *callbegin = pop_callsite(current_ir_graph);
598 assert(interprocedural_view);
599 current_ir_graph = get_CallBegin_irg(callbegin);
603 re_leave_procedure(ir_node *block, ir_node *cf_pred, int pos) {
607 assert(get_irn_op(cf_pred) == op_CallBegin);
609 /* Find the irg block is in. */
610 proj = get_Block_cg_cfgpred(block, pos);
611 assert(is_Proj(proj));
612 callee = get_entity_irg(get_Call_callee(get_CallBegin_call(cf_pred),
613 get_Proj_proj(proj)));
614 current_ir_graph = callee;
615 push_callsite(callee, cf_pred);
619 return_recur(ir_node *n, int pos) {
623 if (!interprocedural_view) return;
625 /* Find the cf_pred refering to pos. */
627 if (get_irn_opcode(n) == iro_Filter) block = get_nodes_Block(n);
628 cf_pred = skip_Proj(get_irn_n(block, pos));
630 /* Check whether we re_enter or re_leave a procedure and act according. */
631 if ((get_irn_op(cf_pred) == op_EndReg) ||
632 (get_irn_op(cf_pred) == op_EndExcept))
633 re_enter_procedure(block, cf_pred, pos);
634 if (get_irn_op(cf_pred) == op_CallBegin)
635 re_leave_procedure(block, cf_pred, pos);