introduced node index: a small unique per graph node number
[libfirm] / ir / ir / irgwalk.c
index 24644f2..ceba751 100644 (file)
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Author: Boris Boesler
-**
-** traverse an ir graph
-** - execute the pre function before recursion
-** - execute the post function after recursion
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/irgwalk.c
+ * Purpose:
+ * Author:      Boris Boesler
+ * Modified by: Goetz Lindenmaier
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1999-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
+/**
+ * @file irgwalk.c
+ *
+ * traverse an ir graph
+ * - execute the pre function before recursion
+ * - execute the post function after recursion
+ */
+
 
 #ifdef HAVE_CONFIG_H
-# include <config.h>
+# include "config.h"
 #endif
 
-# include "irnode.h"
-# include "irgraph.h" /* visited flag */
+#ifdef HAVE_STDLIB_H
+# include <stdlib.h>
+#endif
 
+#include "irnode_t.h"
+#include "irgraph_t.h" /* visited flag */
+#include "irprog.h"
+#include "irgwalk.h"
+#include "typewalk.h"
+#include "irhooks.h"
+#include "ircgcons.h"
 
-void irg_walk_2(ir_node *node,
-             void (pre)(ir_node*, void*), void (post)(ir_node*, void*),
-             void *env)
-{
+#include "eset.h"
+#include "array.h"
+
+/**
+ * Walk over an interprocedural graph (callgraph).
+ * Visits only graphs in irg_set.
+ */
+static void irg_walk_cg(ir_node * node, unsigned long visited, eset * irg_set,
+                        irg_walk_func *pre, irg_walk_func *post, void * env) {
   int i;
+  ir_graph * rem = current_ir_graph;
+  ir_node * pred;
 
+  assert(node && node->kind == k_ir_node);
+  if (get_irn_visited(node) >= visited) return;
 
-  assert(node);
-  /*      printf(" - "); DDMSG2(node);  */
+  set_irn_visited(node, visited);
 
-  if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
+  if (pre) pre(node, env);
 
-/*      printf(" -> "); DDMSG2(node);  */
-    set_irn_visited(node, get_irg_visited(current_ir_graph));
+  pred = skip_Proj(node);
+  if (get_irn_op(pred) == op_CallBegin
+      || get_irn_op(pred) == op_EndReg
+      || get_irn_op(pred) == op_EndExcept) {
+    current_ir_graph = get_irn_irg(pred);
+  }
 
-    if (pre) {
-      pre(node, env);
+  if (is_no_Block(node)) { /* not block */
+    irg_walk_cg(get_nodes_block(node), visited, irg_set, pre, post, env);
+  }
+
+  if (get_irn_op(node) == op_Block) { /* block */
+    for (i = get_irn_arity(node) - 1; i >= 0; --i) {
+      ir_node * exec = get_irn_n(node, i);
+      ir_node * pred = skip_Proj(exec);
+      if ((get_irn_op(pred) != op_CallBegin
+           && get_irn_op(pred) != op_EndReg
+           && get_irn_op(pred) != op_EndExcept)
+          || eset_contains(irg_set, get_irn_irg(pred))) {
+        irg_walk_cg(exec, visited, irg_set, pre, post, env);
+      }
     }
+  } else if (get_irn_op(node) == op_Filter) { /* filter */
+    for (i = get_irn_arity(node) - 1; i >= 0; --i) {
+      ir_node * pred = get_irn_n(node, i);
+      if (get_irn_op(pred) == op_Unknown || get_irn_op(pred) == op_Bad) {
+        irg_walk_cg(pred, visited, irg_set, pre, post, env);
+      } else {
+        ir_node * exec;
+        exec = skip_Proj(get_Block_cfgpred(get_nodes_block(node), i));
 
-    if (is_no_Block(node)) {
-      irg_walk_2(get_nodes_Block(node), pre, post, env);
+        if (op_Bad == get_irn_op (exec)) {
+          continue;
+        }
+
+        assert(get_irn_op(exec) == op_CallBegin
+               || get_irn_op(exec) == op_EndReg
+               || get_irn_op(exec) == op_EndExcept);
+        if (eset_contains(irg_set, get_irn_irg(exec))) {
+          current_ir_graph = get_irn_irg(exec);
+          irg_walk_cg(pred, visited, irg_set, pre, post, env);
+          current_ir_graph = rem;
+        }
+      }
     }
+  } else {                      /* everything else */
     for (i = get_irn_arity(node) - 1; i >= 0; --i) {
-/*        printf("   "); DDMSG2(node); */
-/*        printf("   "); DDMSG2(get_irn_n(node, i)); */
+      irg_walk_cg(get_irn_n(node, i), visited, irg_set, pre, post, env);
+    }
+  }
 
-      irg_walk_2(get_irn_n(node, i), pre, post, env);
+  if (post) post(node, env);
+
+  current_ir_graph = rem;
+}
+
+
+/**
+ * Insert all ir_graphs in irg_set, that are (transitive) reachable.
+ */
+static void collect_irgs(ir_node * node, eset * irg_set) {
+  if (is_Call(node)) {
+    int i;
+    for (i = get_Call_n_callees(node) - 1; i >= 0; --i) {
+      entity * ent = get_Call_callee(node, i);
+      ir_graph * irg = get_entity_irg(ent);
+      if (irg && !eset_contains(irg_set, irg)) {
+        eset_insert(irg_set, irg);
+        irg_walk_graph(irg, (irg_walk_func *) collect_irgs, NULL, irg_set);
+      }
     }
+  }
+}
+
+/**
+ * specialized version of irg_walk_2, called if only pre callback exists
+ *
+ * @return number of visited nodes
+ */
+static unsigned
+irg_walk_2_pre(ir_node *node, irg_walk_func *pre, void * env) {
+  int i;
+  unsigned cnt = 1;
+
+  set_irn_visited(node, current_ir_graph->visited);
+
+  pre(node, env);
+
+  if (node->op != op_Block) {
+    ir_node *pred = get_irn_n(node, -1);
+    if (pred->visited < current_ir_graph->visited)
+      cnt += irg_walk_2_pre(pred, pre, env);
+  }
+  for (i = get_irn_arity(node) - 1; i >= 0; --i) {
+    ir_node *pred = get_irn_n(node, i);
+    if (pred->visited < current_ir_graph->visited)
+      cnt += irg_walk_2_pre(pred, pre, env);
+  }
+  return cnt;
+}
+
+/**
+ * specialized version of irg_walk_2, called if only post callback exists
+ *
+ * @return number of visited nodes
+ */
+static unsigned
+irg_walk_2_post(ir_node *node, irg_walk_func *post, void * env) {
+  int i;
+  unsigned cnt = 1;
+
+  set_irn_visited(node, current_ir_graph->visited);
 
-/*      printf(" <- "); DDMSG2(node);  */
-    if (post)
-      post(node, env);
+  if (node->op != op_Block) {
+    ir_node *pred = get_irn_n(node, -1);
+    if (pred->visited < current_ir_graph->visited)
+      cnt += irg_walk_2_post(pred, post, env);
+  }
+  for (i = get_irn_arity(node) - 1; i >= 0; --i) {
+    ir_node *pred = get_irn_n(node, i);
+    if (pred->visited < current_ir_graph->visited)
+      cnt += irg_walk_2_post(pred, post, env);
+  }
+
+  post(node, env);
+
+  return cnt;
+}
+
+/**
+ * specialized version of irg_walk_2, called if pre and post callbacks exist
+ *
+ * @return number of visited nodes
+ */
+static unsigned
+irg_walk_2_both(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env) {
+  int i;
+  unsigned cnt = 1;
+
+  set_irn_visited(node, current_ir_graph->visited);
+
+  pre(node, env);
+
+  if (node->op != op_Block) {
+    ir_node *pred = get_irn_n(node, -1);
+    if (pred->visited < current_ir_graph->visited)
+      cnt += irg_walk_2_both(pred, pre, post, env);
+  }
+  for (i = get_irn_arity(node) - 1; i >= 0; --i) {
+    ir_node *pred = get_irn_n(node, i);
+    if (pred->visited < current_ir_graph->visited)
+      cnt += irg_walk_2_both(pred, pre, post, env);
+  }
+
+  post(node, env);
+
+  return cnt;
+}
+
+/**
+ * Intraprozedural graph walker.
+ *
+ * @return number of visited nodes
+ */
+static unsigned
+irg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
+{
+  if (node->visited < current_ir_graph->visited) {
+    if      (!post) return irg_walk_2_pre (node, pre, env);
+    else if (!pre)  return irg_walk_2_post(node, post, env);
+    else            return irg_walk_2_both(node, pre, post, env);
+  }
+  return 0;
+}
+
+/* a counter */
+static unsigned nodes_touched = 0;
+
+/*
+ * generic graph walker
+ */
+void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
+{
+  assert(is_ir_node(node));
+
+  if (get_interprocedural_view()) {
+    eset * irg_set = eset_create();
+    unsigned long visited;
+    ir_graph * irg;
+    assert(get_irp_ip_view_state() == ip_view_valid);
+
+    set_interprocedural_view(0);
+    eset_insert(irg_set, current_ir_graph);
+    irg_walk(node, (irg_walk_func *) collect_irgs, NULL, irg_set);
+    set_interprocedural_view(1);
+    visited = get_max_irg_visited() + 1;
+    for (irg = eset_first(irg_set); irg; irg = eset_next(irg_set)) {
+      set_irg_visited(irg, visited);
+    }
+    irg_walk_cg(node, visited, irg_set, pre, post, env);
+    eset_destroy(irg_set);
+  } else {
+    inc_irg_visited(current_ir_graph);
+    nodes_touched = irg_walk_2(node, pre, post, env);
   }
   return;
 }
 
+/*
+ * walk over a graph
+ */
+void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env) {
+  ir_graph * rem = current_ir_graph;
+
+  hook_irg_walk(irg, (generic_func *)pre, (generic_func *)post);
+  current_ir_graph = irg;
+  irg_walk(get_irg_end(irg), pre, post, env);
+  irg->estimated_node_count = nodes_touched;
+  current_ir_graph = rem;
+}
+
+/* Executes irg_walk(end, pre, post, env) for all irgraphs in irprog.
+   Sets current_ir_graph properly for each walk.  Conserves current
+   current_ir_graph. */
+void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
+  int i;
+  ir_graph *irg, *rem;
+
+  rem = current_ir_graph;
+
+  for (i = 0; i < get_irp_n_irgs(); i++) {
+    irg = get_irp_irg(i);
+    current_ir_graph = irg;
+    irg_walk(get_irg_end(irg), pre, post, env);
+  }
+  current_ir_graph = rem;
+}
+
+/***************************************************************************/
+
+/**
+ * Returns current_ir_graph and sets it to the irg of predecessor index
+ * of node n.
+ */
+static INLINE ir_graph *
+switch_irg (ir_node *n, int index) {
+  ir_graph *old_current = current_ir_graph;
 
-void irg_walk(ir_node *node,
-             void (pre)(ir_node*, void*), void (post)(ir_node*, void*),
-             void *env)
+  if (get_interprocedural_view()) {
+    /* Only Filter and Block nodes can have predecessors in other graphs. */
+    if (get_irn_op(n) == op_Filter)
+      n = get_nodes_block(n);
+    if (get_irn_op(n) == op_Block) {
+      ir_node *cfop = skip_Proj(get_Block_cfgpred(n, index));
+      if (is_ip_cfop(cfop)) {
+        current_ir_graph = get_irn_irg(cfop);
+      }
+    }
+  }
+
+  return old_current;
+}
+
+static void
+cg_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * env)
 {
+  int i;
+  ir_graph *rem = NULL;
   assert(node);
-  inc_irg_visited (current_ir_graph);
-  irg_walk_2(node, pre, post, env);
+
+  if (get_irn_visited(node) < get_irg_visited(current_ir_graph)) {
+    set_irn_visited(node, get_irg_visited(current_ir_graph));
+
+    if (pre) pre(node, env);
+
+    if (is_no_Block(node))
+      cg_walk_2(get_nodes_block(node), pre, post, env);
+    for (i = get_irn_arity(node) - 1; i >= 0; --i) {
+      rem = switch_irg(node, i);  /* @@@ AS: Is this wrong? We do have to
+                                             switch to the irg of the predecessor, don't we? */
+      cg_walk_2(get_irn_n(node, i), pre, post, env);
+      current_ir_graph = rem;
+    }
+
+    if (post) post(node, env);
+  }
   return;
 }
 
+
+/* Walks all irgs in interprocedural view.  Visits each node only once. */
+void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env) {
+  int i;
+  ir_graph *rem = current_ir_graph;
+  int rem_view = get_interprocedural_view();
+
+  set_interprocedural_view(1);
+
+  inc_max_irg_visited();
+  /* Fix all irg_visited flags */
+  for (i = 0; i < get_irp_n_irgs(); i++)
+    set_irg_visited(get_irp_irg(i), get_max_irg_visited());
+
+  /* Walk starting at unreachable procedures. Only these
+   * have End blocks visible in interprocedural view. */
+  for (i = 0; i < get_irp_n_irgs(); i++) {
+    ir_node *sb;
+    current_ir_graph = get_irp_irg(i);
+
+    sb = get_irg_start_block(current_ir_graph);
+
+    if ((get_Block_n_cfgpreds(sb) > 1) ||
+    (get_nodes_block(get_Block_cfgpred(sb, 0)) != sb)) continue;
+
+    cg_walk_2(get_irg_end(current_ir_graph), pre, post, env);
+  }
+
+  /* Check whether we walked all procedures: there could be procedures
+     with cyclic calls but no call from the outside. */
+  for (i = 0; i < get_irp_n_irgs(); i++) {
+    ir_node *sb;
+    current_ir_graph = get_irp_irg(i);
+
+    /* Test start block: if inner procedure end and end block are not
+     * visible and therefore not marked. */
+    sb = get_irg_start_block(current_ir_graph);
+    if (get_irn_visited(sb) < get_irg_visited(current_ir_graph)) {
+      cg_walk_2(sb, pre, post, env);
+    }
+  }
+
+  /* Walk all endless loops in inner procedures.
+   * We recognize an inner procedure if the End node is not visited. */
+  for (i = 0; i < get_irp_n_irgs(); i++) {
+    ir_node *e;
+    current_ir_graph = get_irp_irg(i);
+    e = get_irg_end(current_ir_graph);
+    if (get_irn_visited(e) < get_irg_visited(current_ir_graph)) {
+      int j;
+      /* Don't visit the End node. */
+      for (j = 0; j < get_End_n_keepalives(e); j++)
+    cg_walk_2(get_End_keepalive(e, j), pre, post, env);
+    }
+  }
+
+  set_interprocedural_view(rem_view);
+  current_ir_graph = rem;
+}
+
+
 /***************************************************************************/
 
 /* Walks back from n until it finds a real cf op. */
-ir_node *get_cf_op(ir_node *n) {
+static ir_node *get_cf_op(ir_node *n) {
   ir_node *pred;
 
-  n = skip_nop(n);
+  n = skip_Id(n);
   n = skip_Tuple(n);
   pred = skip_Proj(n);
   if (!(is_cfop(pred) || is_fragile_op(pred) ||
-       (get_irn_op(pred) == op_Bad)))
+    (get_irn_op(pred) == op_Bad)))
     n = get_cf_op(n);
 
   return skip_Proj(n);
 }
 
-void irg_block_walk_2(ir_node *node, void (pre)(ir_node*, void*),
-                     void (post)(ir_node*, void*), void *env)
+static void irg_block_walk_2(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
 {
   int i;
 
-  assert(get_irn_opcode(node) == iro_Block);
+  if (Block_not_block_visited(node)) {
+    mark_Block_block_visited(node);
 
-  if(get_Block_block_visited(node) < get_irg_block_visited(current_ir_graph)) {
-    set_Block_block_visited(node, get_irg_block_visited(current_ir_graph));
-
-    if(pre)
-      pre(node, env);
+    if(pre) pre(node, env);
 
     for(i = get_Block_n_cfgpreds(node) - 1; i >= 0; --i) {
-
       /* find the corresponding predecessor block. */
       ir_node *pred = get_cf_op(get_Block_cfgpred(node, i));
-      /* GL: I'm not sure whether this assert must go through.  There
-         could be Id chains?? Tuple/Proj .... */
-
-      assert(is_cfop(pred) || is_fragile_op(pred) ||
-            (get_irn_op(pred) == op_Bad));
-      pred = get_nodes_Block(pred);
+      pred = get_nodes_block(pred);
       if(get_irn_opcode(pred) == iro_Block) {
-       /* recursion */
-       irg_block_walk_2(pred, pre, post, env);
+        /* recursion */
+        irg_block_walk_2(pred, pre, post, env);
       }
       else {
-       assert(get_irn_opcode(pred) == iro_Bad);
+        assert(get_irn_opcode(pred) == iro_Bad);
       }
     }
 
-    if(post)
-      post(node, env);
+    if(post) post(node, env);
   }
   return;
 }
@@ -120,14 +451,116 @@ void irg_block_walk_2(ir_node *node, void (pre)(ir_node*, void*),
 
 /* walks only over Block nodes in the graph.  Has it's own visited
    flag, so that it can be interleaved with the other walker.         */
-void irg_block_walk(ir_node *node,
-                   void (pre)(ir_node*, void*), void (post)(ir_node*, void*),
-                   void *env)
+void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env)
 {
+  ir_node *block, *pred;
+  int i;
+
+  hook_irg_block_walk(current_ir_graph, node, (generic_func *)pre, (generic_func *)post);
+
   assert(node);
+  assert(!get_interprocedural_view());   /* interprocedural_view not implemented, because it
+                    * interleaves with irg_walk */
   inc_irg_block_visited(current_ir_graph);
-  if (is_no_Block(node)) node = get_nodes_Block(node);
-  assert(get_irn_opcode(node)  == iro_Block);
-  irg_block_walk_2(node, pre, post, env);
+  if (is_no_Block(node)) block = get_nodes_block(node); else block = node;
+  assert(get_irn_op(block) == op_Block);
+  irg_block_walk_2(block, pre, post, env);
+
+  /* keepalive: the endless loops ... */
+  if (get_irn_op(node) == op_End) {
+    int arity = get_irn_arity(node);
+    for (i = 0; i < arity; i++) {
+      pred = get_irn_n(node, i);
+      if (get_irn_op(pred) == op_Block)
+        irg_block_walk_2(pred, pre, post, env);
+    }
+    /* Sometimes the blocks died, but are still reachable through Phis.
+     * Make sure the algorithms that try to remove these reach them. */
+    for (i = 0; i < arity; i++) {
+      pred = get_irn_n(node, i);
+      if (get_irn_op(pred) == op_Phi) {
+        ir_node *block = get_nodes_block(pred);
+
+        if (! is_Bad(block))
+          irg_block_walk_2(block, pre, post, env);
+      }
+    }
+  }
+
   return;
 }
+
+/*
+ * walk over a graph block wise
+ */
+void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre,
+              irg_walk_func *post, void *env) {
+  ir_graph * rem = current_ir_graph;
+  current_ir_graph = irg;
+  irg_block_walk(get_irg_end(irg), pre, post, env);
+  current_ir_graph = rem;
+}
+
+/********************************************************************/
+
+typedef struct walk_env {
+  irg_walk_func *pre;
+  irg_walk_func *post;
+  void *env;
+} walk_env;
+
+/**
+ * Walk to all constant expressions in this entity.
+ */
+static void walk_entity(entity *ent, void *env)
+{
+  walk_env *my_env = (walk_env *)env;
+
+  if (get_entity_variability(ent) != variability_uninitialized) {
+    if (is_atomic_entity(ent)) {
+      irg_walk(get_atomic_ent_value(ent), my_env->pre, my_env->post, my_env->env);
+    }
+    else {
+      int i, n_vals = get_compound_ent_n_values(ent);
+
+      for (i = 0; i < n_vals; i++)
+        irg_walk(get_compound_ent_value(ent, i), my_env->pre, my_env->post, my_env->env);
+    }
+  }
+}
+
+/* Walks over all code in const_code_irg. */
+void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env) {
+  int i, j;
+  walk_env my_env;
+
+  ir_graph *rem = current_ir_graph;
+  current_ir_graph = get_const_code_irg();
+  inc_irg_visited(current_ir_graph);
+
+  my_env.pre = pre;
+  my_env.post = post;
+  my_env.env = env;
+
+  /* Walk all types that can contain constant entities.  */
+  walk_types_entities(get_glob_type(), &walk_entity, &my_env);
+  for (i = 0; i < get_irp_n_types(); i++)
+    walk_types_entities(get_irp_type(i), &walk_entity, &my_env);
+  for (i = 0; i < get_irp_n_irgs(); i++)
+    walk_types_entities(get_irg_frame_type(get_irp_irg(i)), &walk_entity, &my_env);
+
+  /* Walk constant array bounds. */
+  for (i = 0; i < get_irp_n_types(); i++) {
+    ir_type *tp = get_irp_type(i);
+    if (is_Array_type(tp)) {
+      for (j = 0; j < get_array_n_dimensions(tp); j++) {
+        ir_node *n = get_array_lower_bound(tp, j);
+        if (n) irg_walk(n, pre, post, env);
+        n = get_array_upper_bound(tp, j);
+        if (n) irg_walk(n, pre, post, env);
+      }
+    }
+  }
+
+  current_ir_graph = rem;
+}