added missing include
[libfirm] / ir / opt / tailrec.c
index 509b2ab..f6210c2 100644 (file)
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
 #ifdef HAVE_CONFIG_H
-# include <config.h>
+# include "config.h"
+#endif
+
+#ifdef HAVE_ALLOCA_H
+#include <alloca.h>
+#endif
+#ifdef HAVE_MALLOC_H
+#include <malloc.h>
+#endif
+#ifdef HAVE_STRING_H
+#include <string.h>
 #endif
 
 #include <assert.h>
 #include "tailrec.h"
 #include "array.h"
+#include "irprog.h"
 #include "irgwalk.h"
 #include "irgmod.h"
 #include "irop.h"
 #include "irgraph_t.h"
 #include "ircons.h"
 #include "irflag.h"
-#include "tv.h"
-#include "firmstat.h"
+#include "trouts.h"
+#include "return.h"
 
 /**
- * the environment for colelcting data
+ * the environment for collecting data
  */
 typedef struct _collect_t {
-  ir_node *proj_X;             /**< initial exec proj */
-  ir_node *block;              /**< old first block */
-  ir_node *proj_m;             /**< linked list of memory from start proj's */
-  ir_node *proj_data;          /**< linked list of all parameter access proj's */
+  ir_node *proj_X;      /**< initial exec proj */
+  ir_node *block;       /**< old first block */
+  int     blk_idx;      /**< cfgpred index of the initial exec in block */
+  ir_node *proj_m;      /**< linked list of memory from start proj's */
+  ir_node *proj_data;   /**< linked list of all parameter access proj's */
 } collect_t;
 
 /**
- * walker for collecting data
+ * walker for collecting data, fills a collect_t environment
  */
 static void collect_data(ir_node *node, void *env)
 {
@@ -45,35 +57,35 @@ static void collect_data(ir_node *node, void *env)
   ir_node *pred;
   ir_op *op;
 
-  switch (intern_get_irn_opcode(node)) {
+  switch (get_irn_opcode(node)) {
   case iro_Proj:
     pred = get_Proj_pred(node);
 
-    op = intern_get_irn_op(pred);
+    op = get_irn_op(pred);
     if (op == op_Proj) {
       ir_node *start = get_Proj_pred(pred);
 
-      if (intern_get_irn_op(start) == op_Start) {
-       if (get_Proj_proj(pred) == pn_Start_T_args) {
-         /* found Proj(ProjT(Start)) */
-         set_irn_link(node, data->proj_data);
-         data->proj_data = node;
-       }
+      if (get_irn_op(start) == op_Start) {
+           if (get_Proj_proj(pred) == pn_Start_T_args) {
+             /* found Proj(ProjT(Start)) */
+             set_irn_link(node, data->proj_data);
+             data->proj_data = node;
+           }
       }
     }
     else if (op == op_Start) {
       switch (get_Proj_proj(node)) {
         case pn_Start_M:
           /* found ProjM(Start) */
-         set_irn_link(node, data->proj_m);
-         data->proj_m = node;
-         break;
-       case pn_Start_X_initial_exec:
-         /* found ProjX(Start) */
-         data->proj_X = node;
-         break;
-       default:
-         break;
+             set_irn_link(node, data->proj_m);
+             data->proj_m = node;
+             break;
+           case pn_Start_X_initial_exec:
+             /* found ProjX(Start) */
+             data->proj_X = node;
+             break;
+           default:
+             break;
       }
     }
     break;
@@ -85,10 +97,11 @@ static void collect_data(ir_node *node, void *env)
      */
     if (node != current_ir_graph->start_block) {
       for (i = 0; i < n_pred; ++i) {
-       if (get_Block_cfgpred(node, i) == data->proj_X) {
-         data->block = node;
-         break;
-       }
+           if (get_Block_cfgpred(node, i) == data->proj_X) {
+             data->block   = node;
+             data->blk_idx = i;
+             break;
+           }
       }
     }
     break;
@@ -120,11 +133,21 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
 
   assert(n_tail_calls);
 
+  /* we add nwe nodes, so the outs are inconsistant */
+  set_irg_outs_inconsistent(irg);
+
+  /* we add new blocks and change the control flow */
+  set_irg_dom_inconsistent(irg);
+
+  /* we add a new loop */
+  set_irg_loopinfo_inconsistent(irg);
+
   set_optimize(0);
 
   /* collect needed data */
   data.proj_X    = NULL;
   data.block     = NULL;
+  data.blk_idx   = -1;
   data.proj_m    = NULL;
   data.proj_data = NULL;
   irg_walk_graph(irg, NULL, collect_data, &data);
@@ -149,7 +172,7 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   for (i = 1, p = rets; p; p = get_irn_link(p)) {
     ir_node *jmp;
 
-    switch_block(get_nodes_Block(p));
+    set_cur_block(get_nodes_block(p));
     jmp = new_Jmp();
 
     exchange(p, new_Bad());
@@ -163,12 +186,7 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   jmp   = new_Jmp();
 
   /* the old first block is now the second one */
-  for (i = 0; i < get_Block_n_cfgpreds(data.block); ++i) {
-    if (get_Block_cfgpred(data.block, i) == data.proj_X) {
-      set_Block_cfgpred(data.block, i, jmp);
-      break;
-    }
-  }
+  set_Block_cfgpred(data.block, data.blk_idx, jmp);
 
   /* allocate phi's, position 0 contains the memory phi */
   NEW_ARR_A(ir_node *, phis, n_params + 1);
@@ -182,6 +200,8 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
     in[i] = get_Call_mem(calls);
     ++i;
   }
+  assert(i == n_tail_calls + 1);
+
   phis[0] = new_rd_Phi(NULL, irg, block, n_tail_calls + 1, in, mode_M);
 
   /* build the data phi's */
@@ -222,14 +242,21 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
     exchange(p, phis[proj + 1]);
   }
 
+  /* tail recursion was done, all info is invalid */
+  set_irg_dom_inconsistent(irg);
+  set_irg_outs_inconsistent(irg);
+  set_irg_loopinfo_state(current_ir_graph, loopinfo_cf_inconsistent);
+  set_trouts_inconsistent();
+  set_irg_callee_info_state(irg, irg_callee_info_inconsistent);
+
   current_ir_graph = rem_irg;
   set_optimize(rem);
 }
 
-/**
+/*
  * convert simple tail-calls into loops
  */
-void optimize_tail_rec_irg(ir_graph *irg)
+int opt_tail_rec_irg(ir_graph *irg)
 {
   ir_node *end_block = irg->end_block;
   int n_preds;
@@ -237,44 +264,43 @@ void optimize_tail_rec_irg(ir_graph *irg)
   ir_node *rets = NULL;
 
   if (! get_opt_tail_recursion() || ! get_opt_optimize())
-    return;
+    return 0;
+
+  /*
+   * This tail recursion optimization works best
+   * if the Returns are normalized.
+   */
+  normalize_n_returns(irg);
 
   set_irn_link(end_block, NULL);
 
   n_preds = get_Block_n_cfgpreds(end_block);
   for (i = 0; i < n_preds; ++i) {
     ir_node *ret = get_Block_cfgpred(end_block, i);
-    ir_node *proj_m, *call, *call_ptr;
-    tarval *tv;
+    ir_node *call, *call_ptr;
     entity *ent;
     int j, n_ress;
     ir_node **ress;
 
     /* search all returns of a block */
-    if (intern_get_irn_op(ret) != op_Return)
+    if (get_irn_op(ret) != op_Return)
       continue;
 
     /* check, if it's a Return self() */
-    proj_m = get_Return_mem(ret);
-
-    if (intern_get_irn_op(proj_m) != op_Proj)
-      continue;
-
-    call = get_Proj_pred(proj_m);
-    if (intern_get_irn_op(call) != op_Call)
+    call = skip_Proj(get_Return_mem(ret));
+    if (get_irn_op(call) != op_Call)
       continue;
 
     /* check if it's a recursive call */
     call_ptr = get_Call_ptr(call);
 
-    if (intern_get_irn_op(call_ptr) != op_Const)
+    if (get_irn_op(call_ptr) != op_SymConst)
       continue;
 
-    tv = get_Const_tarval(call_ptr);
-    if (! tarval_is_entity(tv))
+    if (get_SymConst_kind(call_ptr) != symconst_addr_ent)
       continue;
 
-    ent = tarval_to_entity(tv);
+    ent = get_SymConst_entity(call_ptr);
     if (!ent || get_entity_irg(ent) != irg)
       continue;
 
@@ -283,27 +309,11 @@ void optimize_tail_rec_irg(ir_graph *irg)
     ress = get_Return_res_arr(ret);
 
     for (j = 0; j < n_ress; ++j) {
-      ir_node *proj = ress[j];
-      ir_node *proj_proj;
-      ir_node *irn;
-
-      if (intern_get_irn_op(proj) != op_Proj) {
-       /* not routed to a call */
-       break;
-      }
-
-      proj_proj = get_Proj_pred(proj);
-
-      if (intern_get_irn_op(proj) != op_Proj) {
-       /* not routed to a call */
-       break;
-      }
-
-      irn = get_Proj_pred(proj_proj);
+      ir_node *irn = skip_Proj(skip_Proj(ress[j]));
 
       if (irn != call) {
-       /* not routed to a call */
-       break;
+           /* not routed to a call */
+           break;
       }
     }
     if (j < n_ress)
@@ -321,22 +331,35 @@ void optimize_tail_rec_irg(ir_graph *irg)
 
   /* now, end_block->link contains the list of all tail calls */
   if (! n_tail_calls)
-    return;
+    return 0;
+
+  if (get_opt_tail_recursion_verbose() && get_firm_verbosity() > 1)
+    printf("  Performing tail recursion for graph %s and %d Calls\n",
+          get_entity_ld_name(get_irg_entity(irg)), n_tail_calls);
 
   do_opt_tail_rec(irg, rets, n_tail_calls);
+
+  return n_tail_calls;
 }
 
-/**
+/*
  * optimize tail recursion away
  */
-void optimize_tail_recursion(void)
+void opt_tail_recursion(void)
 {
+  int i;
+  int n_opt_applications = 0;
+
   if (! get_opt_tail_recursion() || ! get_opt_optimize())
     return;
 
   for (i = 0; i < get_irp_n_irgs(); i++) {
     current_ir_graph = get_irp_irg(i);
 
-    optimize_tail_rec_irg(current_ir_graph);
+    if (opt_tail_rec_irg(current_ir_graph))
+      ++n_opt_applications;
   }
+
+  if (get_opt_tail_recursion_verbose())
+    printf("Performed tail recursion for %d of %d graphs\n", n_opt_applications, get_irp_n_irgs());
 }