doxygen docu fixed
[libfirm] / ir / opt / tailrec.c
index 57a28f4..7666bd8 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 "irgraph_t.h"
 #include "ircons.h"
 #include "irflag.h"
-#include "firmstat.h"
-
-static int n_opt_applications = 0;
+#include "trouts.h"
+#include "return.h"
+#include "irhooks.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 */
-  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 */
+  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)
 {
@@ -57,26 +67,26 @@ static void collect_data(ir_node *node, void *env)
       ir_node *start = get_Proj_pred(pred);
 
       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;
-       }
+           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;
@@ -88,11 +98,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;
-         data->blk_idx = i;
-         break;
-       }
+           if (get_Block_cfgpred(node, i) == data->proj_X) {
+             data->block   = node;
+             data->blk_idx = i;
+             break;
+           }
       }
     }
     break;
@@ -111,8 +121,7 @@ static void collect_data(ir_node *node, void *env)
  */
 static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
 {
-  ir_graph *rem_irg = current_ir_graph;
-  ir_node *end_block = irg->end_block;
+  ir_node *end_block = get_irg_end_block(irg);
   ir_node *block, *jmp, *call, *calls;
   ir_node **in;
   ir_node **phis;
@@ -120,11 +129,13 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   ir_node *p;
   int i, j, n_params;
   collect_t data;
-  int rem = get_optimize();
+  int rem         = get_optimize();
+  entity *ent     = get_irg_entity(irg);
+  type *method_tp = get_entity_type(ent);
 
   assert(n_tail_calls);
 
-  /* we add nwe nodes, so the outs are inconsistant */
+  /* we add new nodes, so the outs are inconsistant */
   set_irg_outs_inconsistent(irg);
 
   /* we add new blocks and change the control flow */
@@ -133,6 +144,10 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   /* we add a new loop */
   set_irg_loopinfo_inconsistent(irg);
 
+  /* calls are removed */
+  set_trouts_inconsistent();
+
+  /* we must build some new nodes WITHOUT CSE */
   set_optimize(0);
 
   /* collect needed data */
@@ -152,8 +167,6 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   assert(data.proj_m && "Could not find ProjM(Start)");
   assert((data.proj_data || n_params == 0) && "Could not find Proj(ProjT(Start)) of non-void function");
 
-  current_ir_graph = irg;
-
   /* allocate in's for phi and block construction */
   NEW_ARR_A(ir_node *, in, n_tail_calls + 1);
 
@@ -162,19 +175,21 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   /* turn Return's into Jmp's */
   for (i = 1, p = rets; p; p = get_irn_link(p)) {
     ir_node *jmp;
+    ir_node *block = get_nodes_block(p);
 
-    set_cur_block(get_nodes_block(p));
-    jmp = new_Jmp();
+    jmp = new_r_Jmp(irg, block);
 
-    exchange(p, new_Bad());
+    exchange(p, new_r_Bad(irg));
     in[i++] = jmp;
 
-    add_End_keepalive(get_irg_end(irg), jmp);
+    /* we might generate an endless loop, so add
+     * the block to the keep-alive list */
+    add_End_keepalive(get_irg_end(irg), block);
   }
 
   /* create a new block at start */
-  block = new_Block(n_tail_calls + 1, in);
-  jmp   = new_Jmp();
+  block = new_r_Block(irg, n_tail_calls + 1, in);
+  jmp   = new_r_Jmp(irg, block);
 
   /* the old first block is now the second one */
   set_Block_cfgpred(data.block, data.blk_idx, jmp);
@@ -184,7 +199,7 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
 
   /* build the memory phi */
   i = 0;
-  in[i] = new_rd_Proj(NULL, irg, irg->start_block, irg->start, mode_M, pn_Start_M);
+  in[i] = new_r_Proj(irg, get_irg_start_block(irg), get_irg_start(irg), mode_M, pn_Start_M);
   ++i;
 
   for (calls = call; calls; calls = get_irn_link(calls)) {
@@ -193,13 +208,13 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
   }
   assert(i == n_tail_calls + 1);
 
-  phis[0] = new_rd_Phi(NULL, irg, block, n_tail_calls + 1, in, mode_M);
+  phis[0] = new_r_Phi(irg, block, n_tail_calls + 1, in, mode_M);
 
   /* build the data phi's */
   if (n_params > 0) {
     ir_node *calls;
 
-    NEW_ARR_A(ir_node **, call_params, n_params);
+    NEW_ARR_A(ir_node **, call_params, n_tail_calls);
 
     /* collect all parameters */
     for (i = 0, calls = call; calls; calls = get_irn_link(calls)) {
@@ -209,13 +224,13 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
 
     /* build new projs and Phi's */
     for (i = 0; i < n_params; ++i) {
-      ir_mode *mode = get_irn_mode(call_params[0][i]);
+      ir_mode *mode = get_type_mode(get_method_param_type(method_tp, i));
 
-      in[0] = new_rd_Proj(NULL, irg, block, irg->args, mode, i);
+      in[0] = new_r_Proj(irg, block, irg->args, mode, i);
       for (j = 0; j < n_tail_calls; ++j)
        in[j + 1] = call_params[j][i];
 
-      phis[i + 1] = new_rd_Phi(NULL, irg, block, n_tail_calls + 1, in, mode);
+      phis[i + 1] = new_r_Phi(irg, block, n_tail_calls + 1, in, mode);
     }
   }
 
@@ -233,23 +248,37 @@ static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
     exchange(p, phis[proj + 1]);
   }
 
-  current_ir_graph = rem_irg;
+  /* 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);
+
   set_optimize(rem);
 }
 
 /*
  * convert simple tail-calls into loops
  */
-void opt_tail_rec_irg(ir_graph *irg)
+int opt_tail_rec_irg(ir_graph *irg)
 {
-  ir_node *end_block = irg->end_block;
+  ir_node *end_block;
   int n_preds;
   int i, n_tail_calls = 0;
   ir_node *rets = NULL;
+  type *mtd_type, *call_type;
 
   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);
+
+  end_block = get_irg_end_block(irg);
   set_irn_link(end_block, NULL);
 
   n_preds = get_Block_n_cfgpreds(end_block);
@@ -290,13 +319,34 @@ void opt_tail_rec_irg(ir_graph *irg)
       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)
       continue;
 
+    /*
+     * Check, that the types match. At least in C
+     * this might fail.
+     */
+    mtd_type  = get_entity_type(ent);
+    call_type = get_Call_type(call);
+
+    if (mtd_type != call_type) {
+      /*
+       * Hmm, the types did not match, bad.
+       * This can happen in C when no prototyp is given
+       * or K&R style is used.
+       */
+#if 0
+      printf("Warning: Tail recursion fails because of different method and call types:\n");
+      dump_type(mtd_type);
+      dump_type(call_type);
+#endif
+      return 0;
+    }
+
     /* here, we have found a call */
     set_irn_link(call, get_irn_link(end_block));
     set_irn_link(end_block, call);
@@ -309,14 +359,16 @@ void opt_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);
-  n_opt_applications++;
 
+  hook_tail_rec(irg, n_tail_calls);
   do_opt_tail_rec(irg, rets, n_tail_calls);
+
+  return n_tail_calls;
 }
 
 /*
@@ -325,16 +377,16 @@ void opt_tail_rec_irg(ir_graph *irg)
 void opt_tail_recursion(void)
 {
   int i;
+  int n_opt_applications = 0;
 
   if (! get_opt_tail_recursion() || ! get_opt_optimize())
     return;
 
-  n_opt_applications = 0;
-
   for (i = 0; i < get_irp_n_irgs(); i++) {
     current_ir_graph = get_irp_irg(i);
 
-    opt_tail_rec_irg(current_ir_graph);
+    if (opt_tail_rec_irg(current_ir_graph))
+      ++n_opt_applications;
   }
 
   if (get_opt_tail_recursion_verbose())