nsz Git - libfirm/blob - ir/opt/tailrec.c

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/opt/tailrec.c
   4  * Purpose:     tail-recursion optimization
   5  * Author:      Michael Beck
   6  * Modified by:
   7  * Created:     08.06.2004
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 2002-2004 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12 #ifdef HAVE_CONFIG_H
  13 # include <config.h>
  14 #endif
  15
  16 #include <assert.h>
  17 #include "tailrec.h"
  18 #include "array.h"
  19 #include "irprog.h"
  20 #include "irgwalk.h"
  21 #include "irgmod.h"
  22 #include "irop.h"
  23 #include "irnode_t.h"
  24 #include "irgraph_t.h"
  25 #include "ircons.h"
  26 #include "irflag.h"
  27 #include "firmstat.h"
  28
  29 /**
  30  * the environment for colelcting data
  31  */
  32 typedef struct _collect_t {
  33   ir_node *proj_X;              /**< initial exec proj */
  34   ir_node *block;               /**< old first block */
  35   int     blk_idx;              /**< cfgpred index of the initial exec in block */
  36   ir_node *proj_m;              /**< linked list of memory from start proj's */
  37   ir_node *proj_data;           /**< linked list of all parameter access proj's */
  38 } collect_t;
  39
  40 /**
  41  * walker for collecting data
  42  */
  43 static void collect_data(ir_node *node, void *env)
  44 {
  45   collect_t *data = env;
  46   ir_node *pred;
  47   ir_op *op;
  48
  49   switch (get_irn_opcode(node)) {
  50   case iro_Proj:
  51     pred = get_Proj_pred(node);
  52
  53     op = get_irn_op(pred);
  54     if (op == op_Proj) {
  55       ir_node *start = get_Proj_pred(pred);
  56
  57       if (get_irn_op(start) == op_Start) {
  58         if (get_Proj_proj(pred) == pn_Start_T_args) {
  59           /* found Proj(ProjT(Start)) */
  60           set_irn_link(node, data->proj_data);
  61           data->proj_data = node;
  62         }
  63       }
  64     }
  65     else if (op == op_Start) {
  66       switch (get_Proj_proj(node)) {
  67         case pn_Start_M:
  68           /* found ProjM(Start) */
  69           set_irn_link(node, data->proj_m);
  70           data->proj_m = node;
  71           break;
  72         case pn_Start_X_initial_exec:
  73           /* found ProjX(Start) */
  74           data->proj_X = node;
  75           break;
  76         default:
  77           break;
  78       }
  79     }
  80     break;
  81   case iro_Block: {
  82     int i, n_pred = get_Block_n_cfgpreds(node);
  83
  84     /*
  85      * the first block has the initial exec as cfg predecessor
  86      */
  87     if (node != current_ir_graph->start_block) {
  88       for (i = 0; i < n_pred; ++i) {
  89         if (get_Block_cfgpred(node, i) == data->proj_X) {
  90           data->block   = node;
  91           data->blk_idx = i;
  92           break;
  93         }
  94       }
  95     }
  96     break;
  97   }
  98   default:
  99     break;
 100   }
 101 }
 102
 103 /**
 104  * do the graph reconstruction for tail-recursion elimination
 105  *
 106  * @param irg           the graph that will reconstructed
 107  * @param rets          linked list of all rets
 108  * @param n_tail_calls  number of tail-recursion calls
 109  */
 110 static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
 111 {
 112   ir_graph *rem_irg = current_ir_graph;
 113   ir_node *end_block = irg->end_block;
 114   ir_node *block, *jmp, *call, *calls;
 115   ir_node **in;
 116   ir_node **phis;
 117   ir_node ***call_params;
 118   ir_node *p;
 119   int i, j, n_params;
 120   collect_t data;
 121   int rem = get_optimize();
 122
 123   assert(n_tail_calls);
 124
 125   /* we add nwe nodes, so the outs are inconsistant */
 126   set_irg_outs_inconsistent(irg);
 127
 128   /* we add new blocks and change the control flow */
 129   set_irg_dom_inconsistent(irg);
 130
 131   /* we add a new loop */
 132   set_irg_loopinfo_inconsistent(irg);
 133
 134   set_optimize(0);
 135
 136   /* collect needed data */
 137   data.proj_X    = NULL;
 138   data.block     = NULL;
 139   data.blk_idx   = -1;
 140   data.proj_m    = NULL;
 141   data.proj_data = NULL;
 142   irg_walk_graph(irg, NULL, collect_data, &data);
 143
 144   /* check number of arguments */
 145   call = get_irn_link(end_block);
 146   n_params = get_Call_n_params(call);
 147
 148   assert(data.proj_X && "Could not find initial exec from Start");
 149   assert(data.block  && "Could not find first block");
 150   assert(data.proj_m && "Could not find ProjM(Start)");
 151   assert((data.proj_data || n_params == 0) && "Could not find Proj(ProjT(Start)) of non-void function");
 152
 153   current_ir_graph = irg;
 154
 155   /* allocate in's for phi and block construction */
 156   NEW_ARR_A(ir_node *, in, n_tail_calls + 1);
 157
 158   in[0] = data.proj_X;
 159
 160   /* turn Return's into Jmp's */
 161   for (i = 1, p = rets; p; p = get_irn_link(p)) {
 162     ir_node *jmp;
 163
 164     set_cur_block(get_nodes_block(p));
 165     jmp = new_Jmp();
 166
 167     exchange(p, new_Bad());
 168     in[i++] = jmp;
 169
 170     add_End_keepalive(get_irg_end(irg), jmp);
 171   }
 172
 173   /* create a new block at start */
 174   block = new_Block(n_tail_calls + 1, in);
 175   jmp   = new_Jmp();
 176
 177   /* the old first block is now the second one */
 178   set_Block_cfgpred(data.block, data.blk_idx, jmp);
 179
 180   /* allocate phi's, position 0 contains the memory phi */
 181   NEW_ARR_A(ir_node *, phis, n_params + 1);
 182
 183   /* build the memory phi */
 184   i = 0;
 185   in[i] = new_rd_Proj(NULL, irg, irg->start_block, irg->start, mode_M, pn_Start_M);
 186   ++i;
 187
 188   for (calls = call; calls; calls = get_irn_link(calls)) {
 189     in[i] = get_Call_mem(calls);
 190     ++i;
 191   }
 192   assert(i == n_tail_calls + 1);
 193
 194   phis[0] = new_rd_Phi(NULL, irg, block, n_tail_calls + 1, in, mode_M);
 195
 196   /* build the data phi's */
 197   if (n_params > 0) {
 198     ir_node *calls;
 199
 200     NEW_ARR_A(ir_node **, call_params, n_params);
 201
 202     /* collect all parameters */
 203     for (i = 0, calls = call; calls; calls = get_irn_link(calls)) {
 204       call_params[i] = get_Call_param_arr(calls);
 205       ++i;
 206     }
 207
 208     /* build new projs and Phi's */
 209     for (i = 0; i < n_params; ++i) {
 210       ir_mode *mode = get_irn_mode(call_params[0][i]);
 211
 212       in[0] = new_rd_Proj(NULL, irg, block, irg->args, mode, i);
 213       for (j = 0; j < n_tail_calls; ++j)
 214         in[j + 1] = call_params[j][i];
 215
 216       phis[i + 1] = new_rd_Phi(NULL, irg, block, n_tail_calls + 1, in, mode);
 217     }
 218   }
 219
 220   /*
 221    * ok, we are here, so we have build and collected all needed Phi's
 222    * now exchange all Projs into links to Phi
 223    */
 224   for (p = data.proj_m; p; p = get_irn_link(p)) {
 225     exchange(p, phis[0]);
 226   }
 227   for (p = data.proj_data; p; p = get_irn_link(p)) {
 228     long proj = get_Proj_proj(p);
 229
 230     assert(0 <= proj && proj < n_params);
 231     exchange(p, phis[proj + 1]);
 232   }
 233
 234   current_ir_graph = rem_irg;
 235   set_optimize(rem);
 236 }
 237
 238 /*
 239  * convert simple tail-calls into loops
 240  */
 241 void opt_tail_rec_irg(ir_graph *irg)
 242 {
 243   ir_node *end_block = irg->end_block;
 244   int n_preds;
 245   int i, n_tail_calls = 0;
 246   ir_node *rets = NULL;
 247
 248   if (! get_opt_tail_recursion() || ! get_opt_optimize())
 249     return;
 250
 251   set_irn_link(end_block, NULL);
 252
 253   n_preds = get_Block_n_cfgpreds(end_block);
 254   for (i = 0; i < n_preds; ++i) {
 255     ir_node *ret = get_Block_cfgpred(end_block, i);
 256     ir_node *proj_m, *call, *call_ptr;
 257     entity *ent;
 258     int j, n_ress;
 259     ir_node **ress;
 260
 261     /* search all returns of a block */
 262     if (get_irn_op(ret) != op_Return)
 263       continue;
 264
 265     /* check, if it's a Return self() */
 266     proj_m = get_Return_mem(ret);
 267
 268     if (get_irn_op(proj_m) != op_Proj)
 269       continue;
 270
 271     call = get_Proj_pred(proj_m);
 272     if (get_irn_op(call) != op_Call)
 273       continue;
 274
 275     /* check if it's a recursive call */
 276     call_ptr = get_Call_ptr(call);
 277
 278     if (get_irn_op(call_ptr) != op_SymConst)
 279       continue;
 280
 281     if (get_SymConst_kind(call_ptr) != symconst_addr_ent)
 282       continue;
 283
 284     ent = get_SymConst_entity(call_ptr);
 285     if (!ent || get_entity_irg(ent) != irg)
 286       continue;
 287
 288     /* ok, mem is routed to a recursive call, check return args */
 289     n_ress = get_Return_n_ress(ret);
 290     ress = get_Return_res_arr(ret);
 291
 292     for (j = 0; j < n_ress; ++j) {
 293       ir_node *proj = ress[j];
 294       ir_node *proj_proj;
 295       ir_node *irn;
 296
 297       if (get_irn_op(proj) != op_Proj) {
 298         /* not routed to a call */
 299         break;
 300       }
 301
 302       proj_proj = get_Proj_pred(proj);
 303
 304       if (get_irn_op(proj) != op_Proj) {
 305         /* not routed to a call */
 306         break;
 307       }
 308
 309       irn = get_Proj_pred(proj_proj);
 310
 311       if (irn != call) {
 312         /* not routed to a call */
 313         break;
 314       }
 315     }
 316     if (j < n_ress)
 317       continue;
 318
 319     /* here, we have found a call */
 320     set_irn_link(call, get_irn_link(end_block));
 321     set_irn_link(end_block, call);
 322     ++n_tail_calls;
 323
 324     /* link all returns, we will need this */
 325     set_irn_link(ret, rets);
 326     rets = ret;
 327   }
 328
 329   /* now, end_block->link contains the list of all tail calls */
 330   if (! n_tail_calls)
 331     return;
 332
 333   do_opt_tail_rec(irg, rets, n_tail_calls);
 334 }
 335
 336 /*
 337  * optimize tail recursion away
 338  */
 339 void opt_tail_recursion(void)
 340 {
 341   int i;
 342
 343   if (! get_opt_tail_recursion() || ! get_opt_optimize())
 344     return;
 345
 346   for (i = 0; i < get_irp_n_irgs(); i++) {
 347     current_ir_graph = get_irp_irg(i);
 348
 349     opt_tail_rec_irg(current_ir_graph);
 350   }
 351 }