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 #ifdef HAVE_ALLOCA_H
  17 #include <alloca.h>
  18 #endif
  19 #ifdef HAVE_MALLOC_H
  20 #include <malloc.h>
  21 #endif
  22 #ifdef HAVE_STRING_H
  23 #include <string.h>
  24 #endif
  25
  26 #include <assert.h>
  27 #include "tailrec.h"
  28 #include "array.h"
  29 #include "irprog_t.h"
  30 #include "irgwalk.h"
  31 #include "irgmod.h"
  32 #include "irop.h"
  33 #include "irnode_t.h"
  34 #include "irgraph_t.h"
  35 #include "ircons.h"
  36 #include "irflag.h"
  37 #include "trouts.h"
  38 #include "return.h"
  39 #include "scalar_replace.h"
  40 #include "irouts.h"
  41 #include "irhooks.h"
  42
  43 /**
  44  * the environment for collecting data
  45  */
  46 typedef struct _collect_t {
  47   ir_node *proj_X;      /**< initial exec proj */
  48   ir_node *block;       /**< old first block */
  49   int     blk_idx;      /**< cfgpred index of the initial exec in block */
  50   ir_node *proj_m;      /**< linked list of memory from start proj's */
  51   ir_node *proj_data;   /**< linked list of all parameter access proj's */
  52 } collect_t;
  53
  54 /**
  55  * walker for collecting data, fills a collect_t environment
  56  */
  57 static void collect_data(ir_node *node, void *env)
  58 {
  59   collect_t *data = env;
  60   ir_node *pred;
  61   ir_op *op;
  62
  63   switch (get_irn_opcode(node)) {
  64   case iro_Proj:
  65     pred = get_Proj_pred(node);
  66
  67     op = get_irn_op(pred);
  68     if (op == op_Proj) {
  69       ir_node *start = get_Proj_pred(pred);
  70
  71       if (get_irn_op(start) == op_Start) {
  72         if (get_Proj_proj(pred) == pn_Start_T_args) {
  73                 /* found Proj(ProjT(Start)) */
  74                 set_irn_link(node, data->proj_data);
  75                 data->proj_data = node;
  76         }
  77       }
  78     }
  79     else if (op == op_Start) {
  80       switch (get_Proj_proj(node)) {
  81         case pn_Start_M:
  82           /* found ProjM(Start) */
  83               set_irn_link(node, data->proj_m);
  84               data->proj_m = node;
  85               break;
  86             case pn_Start_X_initial_exec:
  87               /* found ProjX(Start) */
  88               data->proj_X = node;
  89               break;
  90             default:
  91               break;
  92       }
  93     }
  94     break;
  95   case iro_Block: {
  96     int i, n_pred = get_Block_n_cfgpreds(node);
  97
  98     /*
  99      * the first block has the initial exec as cfg predecessor
 100      */
 101     if (node != current_ir_graph->start_block) {
 102       for (i = 0; i < n_pred; ++i) {
 103         if (get_Block_cfgpred(node, i) == data->proj_X) {
 104                 data->block   = node;
 105                 data->blk_idx = i;
 106                 break;
 107         }
 108       }
 109     }
 110     break;
 111   }
 112   default:
 113     break;
 114   }
 115 }
 116
 117 /**
 118  * do the graph reconstruction for tail-recursion elimination
 119  *
 120  * @param irg           the graph that will reconstructed
 121  * @param rets          linked list of all rets
 122  * @param n_tail_calls  number of tail-recursion calls
 123  */
 124 static void do_opt_tail_rec(ir_graph *irg, ir_node *rets, int n_tail_calls)
 125 {
 126   ir_node *end_block = get_irg_end_block(irg);
 127   ir_node *block, *jmp, *call, *calls;
 128   ir_node **in;
 129   ir_node **phis;
 130   ir_node ***call_params;
 131   ir_node *p;
 132   int i, j, n_params;
 133   collect_t data;
 134   int rem            = get_optimize();
 135   entity *ent        = get_irg_entity(irg);
 136   ir_type *method_tp = get_entity_type(ent);
 137
 138   assert(n_tail_calls);
 139
 140   /* we add new nodes, so the outs are inconsistent */
 141   set_irg_outs_inconsistent(irg);
 142
 143   /* we add new blocks and change the control flow */
 144   set_irg_doms_inconsistent(irg);
 145   set_irg_extblk_inconsistent(irg);
 146
 147   /* we add a new loop */
 148   set_irg_loopinfo_inconsistent(irg);
 149
 150   /* calls are removed */
 151   set_trouts_inconsistent();
 152
 153   /* we must build some new nodes WITHOUT CSE */
 154   set_optimize(0);
 155
 156   /* collect needed data */
 157   data.proj_X    = NULL;
 158   data.block     = NULL;
 159   data.blk_idx   = -1;
 160   data.proj_m    = NULL;
 161   data.proj_data = NULL;
 162   irg_walk_graph(irg, NULL, collect_data, &data);
 163
 164   /* check number of arguments */
 165   call = get_irn_link(end_block);
 166   n_params = get_Call_n_params(call);
 167
 168   assert(data.proj_X && "Could not find initial exec from Start");
 169   assert(data.block  && "Could not find first block");
 170   assert(data.proj_m && "Could not find ProjM(Start)");
 171   assert((data.proj_data || n_params == 0) && "Could not find Proj(ProjT(Start)) of non-void function");
 172
 173   /* allocate in's for phi and block construction */
 174   NEW_ARR_A(ir_node *, in, n_tail_calls + 1);
 175
 176   in[0] = data.proj_X;
 177
 178   /* turn Return's into Jmp's */
 179   for (i = 1, p = rets; p; p = get_irn_link(p)) {
 180     ir_node *jmp;
 181     ir_node *block = get_nodes_block(p);
 182
 183     jmp = new_r_Jmp(irg, block);
 184
 185     exchange(p, new_r_Bad(irg));
 186     in[i++] = jmp;
 187
 188     /* we might generate an endless loop, so add
 189      * the block to the keep-alive list */
 190     add_End_keepalive(get_irg_end(irg), block);
 191   }
 192
 193   /* create a new block at start */
 194   block = new_r_Block(irg, n_tail_calls + 1, in);
 195   jmp   = new_r_Jmp(irg, block);
 196
 197   /* the old first block is now the second one */
 198   set_Block_cfgpred(data.block, data.blk_idx, jmp);
 199
 200   /* allocate phi's, position 0 contains the memory phi */
 201   NEW_ARR_A(ir_node *, phis, n_params + 1);
 202
 203   /* build the memory phi */
 204   i = 0;
 205   in[i] = new_r_Proj(irg, get_irg_start_block(irg), get_irg_start(irg), mode_M, pn_Start_M);
 206   ++i;
 207
 208   for (calls = call; calls; calls = get_irn_link(calls)) {
 209     in[i] = get_Call_mem(calls);
 210     ++i;
 211   }
 212   assert(i == n_tail_calls + 1);
 213
 214   phis[0] = new_r_Phi(irg, block, n_tail_calls + 1, in, mode_M);
 215
 216   /* build the data phi's */
 217   if (n_params > 0) {
 218     ir_node *calls;
 219
 220     NEW_ARR_A(ir_node **, call_params, n_tail_calls);
 221
 222     /* collect all parameters */
 223     for (i = 0, calls = call; calls; calls = get_irn_link(calls)) {
 224       call_params[i] = get_Call_param_arr(calls);
 225       ++i;
 226     }
 227
 228     /* build new projs and Phi's */
 229     for (i = 0; i < n_params; ++i) {
 230       ir_mode *mode = get_type_mode(get_method_param_type(method_tp, i));
 231
 232       in[0] = new_r_Proj(irg, block, irg->args, mode, i);
 233       for (j = 0; j < n_tail_calls; ++j)
 234         in[j + 1] = call_params[j][i];
 235
 236       phis[i + 1] = new_r_Phi(irg, block, n_tail_calls + 1, in, mode);
 237     }
 238   }
 239
 240   /*
 241    * ok, we are here, so we have build and collected all needed Phi's
 242    * now exchange all Projs into links to Phi
 243    */
 244   for (p = data.proj_m; p; p = get_irn_link(p)) {
 245     exchange(p, phis[0]);
 246   }
 247   for (p = data.proj_data; p; p = get_irn_link(p)) {
 248     long proj = get_Proj_proj(p);
 249
 250     assert(0 <= proj && proj < n_params);
 251     exchange(p, phis[proj + 1]);
 252   }
 253
 254   /* tail recursion was done, all info is invalid */
 255   set_irg_doms_inconsistent(irg);
 256   set_irg_outs_inconsistent(irg);
 257   set_irg_extblk_inconsistent(irg);
 258   set_irg_loopinfo_state(current_ir_graph, loopinfo_cf_inconsistent);
 259   set_trouts_inconsistent();
 260   set_irg_callee_info_state(irg, irg_callee_info_inconsistent);
 261
 262   set_optimize(rem);
 263 }
 264
 265 /**
 266  * Check the lifetime of locals in the given graph.
 267  * Tail recursion can only be done, if we can prove that
 268  * the lifetime of locals end with the recursive call.
 269  * We do this by checking that no address of a local variable is
 270  * stored or transmitted as an argument to a call.
 271  *
 272  * @return non-zero if it's ok to do tail recursion
 273  */
 274 static int check_lifetime_of_locals(ir_graph *irg)
 275 {
 276   ir_node *irg_frame = get_irg_frame(irg);
 277   int i;
 278
 279   if (get_irg_outs_state(irg) != outs_consistent)
 280     compute_irg_outs(irg);
 281
 282   for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
 283     ir_node *succ = get_irn_out(irg_frame, i);
 284
 285     if (is_Sel(succ) && is_address_taken(succ))
 286       return 0;
 287   }
 288   return 1;
 289 }
 290
 291 /*
 292  * convert simple tail-calls into loops
 293  */
 294 int opt_tail_rec_irg(ir_graph *irg)
 295 {
 296   ir_node *end_block;
 297   int i, n_tail_calls = 0;
 298   ir_node *rets = NULL;
 299   ir_type *mtd_type, *call_type;
 300
 301   if (! get_opt_tail_recursion() || ! get_opt_optimize())
 302     return 0;
 303
 304   if (! check_lifetime_of_locals(irg))
 305     return 0;
 306
 307   /*
 308    * This tail recursion optimization works best
 309    * if the Returns are normalized.
 310    */
 311   normalize_n_returns(irg);
 312
 313   end_block = get_irg_end_block(irg);
 314   set_irn_link(end_block, NULL);
 315
 316   for (i = get_Block_n_cfgpreds(end_block) - 1; i >= 0; --i) {
 317     ir_node *ret = get_Block_cfgpred(end_block, i);
 318     ir_node *call, *call_ptr;
 319     entity *ent;
 320     int j;
 321     ir_node **ress;
 322
 323     /* search all Returns of a block */
 324     if (! is_Return(ret))
 325       continue;
 326
 327     /* check, if it's a Return self() */
 328     call = skip_Proj(get_Return_mem(ret));
 329     if (! is_Call(call))
 330       continue;
 331
 332     /* check if it's a recursive call */
 333     call_ptr = get_Call_ptr(call);
 334
 335     if (get_irn_op(call_ptr) != op_SymConst)
 336       continue;
 337
 338     if (get_SymConst_kind(call_ptr) != symconst_addr_ent)
 339       continue;
 340
 341     ent = get_SymConst_entity(call_ptr);
 342     if (!ent || get_entity_irg(ent) != irg)
 343       continue;
 344
 345     /* ok, mem is routed to a recursive call, check return args */
 346     ress = get_Return_res_arr(ret);
 347     for (j = get_Return_n_ress(ret) - 1; j >= 0; --j) {
 348       ir_node *irn = skip_Proj(skip_Proj(ress[j]));
 349
 350       if (irn != call) {
 351               /* not routed to a call */
 352               break;
 353       }
 354     }
 355     if (j >= 0)
 356       continue;
 357
 358     /*
 359      * Check, that the types match. At least in C
 360      * this might fail.
 361      */
 362     mtd_type  = get_entity_type(ent);
 363     call_type = get_Call_type(call);
 364
 365     if (mtd_type != call_type) {
 366       /*
 367        * Hmm, the types did not match, bad.
 368        * This can happen in C when no prototype is given
 369        * or K&R style is used.
 370        */
 371 #if 0
 372       printf("Warning: Tail recursion fails because of different method and call types:\n");
 373       dump_type(mtd_type);
 374       dump_type(call_type);
 375 #endif
 376       return 0;
 377     }
 378
 379     /* here, we have found a call */
 380     set_irn_link(call, get_irn_link(end_block));
 381     set_irn_link(end_block, call);
 382     ++n_tail_calls;
 383
 384     /* link all returns, we will need this */
 385     set_irn_link(ret, rets);
 386     rets = ret;
 387   }
 388
 389   /* now, end_block->link contains the list of all tail calls */
 390   if (! n_tail_calls)
 391     return 0;
 392
 393   if (get_opt_tail_recursion_verbose() && get_firm_verbosity() > 1)
 394     printf("  Performing tail recursion for graph %s and %d Calls\n",
 395            get_entity_ld_name(get_irg_entity(irg)), n_tail_calls);
 396
 397   hook_tail_rec(irg, n_tail_calls);
 398   do_opt_tail_rec(irg, rets, n_tail_calls);
 399
 400   return n_tail_calls;
 401 }
 402
 403 /*
 404  * optimize tail recursion away
 405  */
 406 void opt_tail_recursion(void)
 407 {
 408   int i;
 409   int n_opt_applications = 0;
 410   ir_graph *irg;
 411
 412   if (! get_opt_tail_recursion() || ! get_opt_optimize())
 413     return;
 414
 415   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
 416     irg = get_irp_irg(i);
 417
 418     if (opt_tail_rec_irg(irg))
 419       ++n_opt_applications;
 420   }
 421
 422   if (get_opt_tail_recursion_verbose())
 423     printf("Performed tail recursion for %d of %d graphs\n", n_opt_applications, get_irp_n_irgs());
 424 }