gcc/tree-tailcall.c

   1 /* Tail call optimization on trees.
   2    Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #include "config.h"
  22 #include "system.h"
  23 #include "coretypes.h"
  24 #include "tm.h"
  25 #include "tree.h"
  26 #include "rtl.h"
  27 #include "tm_p.h"
  28 #include "hard-reg-set.h"
  29 #include "basic-block.h"
  30 #include "function.h"
  31 #include "tree-flow.h"
  32 #include "tree-dump.h"
  33 #include "diagnostic.h"
  34 #include "except.h"
  35 #include "tree-pass.h"
  36 #include "flags.h"
  37 #include "langhooks.h"
  38
  39 /* The file implements the tail recursion elimination.  It is also used to
  40    analyze the tail calls in general, passing the results to the rtl level
  41    where they are used for sibcall optimization.
  42
  43    In addition to the standard tail recursion elimination, we handle the most
  44    trivial cases of making the call tail recursive by creating accumulators.
  45    For example the following function
  46
  47    int sum (int n)
  48    {
  49      if (n > 0)
  50        return n + sum (n - 1);
  51      else
  52        return 0;
  53    }
  54
  55    is transformed into
  56
  57    int sum (int n)
  58    {
  59      int acc = 0;
  60
  61      while (n > 0)
  62        acc += n--;
  63
  64      return acc;
  65    }
  66
  67    To do this, we maintain two accumulators (a_acc and m_acc) that indicate
  68    when we reach the return x statement, we should return a_acc + x * m_acc
  69    instead.  They are initially initialized to 0 and 1, respectively,
  70    so the semantics of the function is obviously preserved.  If we are
  71    guaranteed that the value of the accumulator never change, we
  72    omit the accumulator.
  73
  74    There are three cases how the function may exit.  The first one is
  75    handled in adjust_return_value, the other two in adjust_accumulator_values
  76    (the second case is actually a special case of the third one and we
  77    present it separately just for clarity):
  78
  79    1) Just return x, where x is not in any of the remaining special shapes.
  80       We rewrite this to a gimple equivalent of return m_acc * x + a_acc.
  81
  82    2) return f (...), where f is the current function, is rewritten in a
  83       classical tail-recursion elimination way, into assignment of arguments
  84       and jump to the start of the function.  Values of the accumulators
  85       are unchanged.
  86
  87    3) return a + m * f(...), where a and m do not depend on call to f.
  88       To preserve the semantics described before we want this to be rewritten
  89       in such a way that we finally return
  90
  91       a_acc + (a + m * f(...)) * m_acc = (a_acc + a * m_acc) + (m * m_acc) * f(...).
  92
  93       I.e. we increase a_acc by a * m_acc, multiply m_acc by m and
  94       eliminate the tail call to f.  Special cases when the value is just
  95       added or just multiplied are obtained by setting a = 0 or m = 1.
  96
  97    TODO -- it is possible to do similar tricks for other operations.  */
  98
  99 /* A structure that describes the tailcall.  */
 100
 101 struct tailcall
 102 {
 103   /* The block in that the call occur.  */
 104   basic_block call_block;
 105
 106   /* The iterator pointing to the call statement.  */
 107   block_stmt_iterator call_bsi;
 108
 109   /* True if it is a call to the current function.  */
 110   bool tail_recursion;
 111
 112   /* The return value of the caller is mult * f + add, where f is the return
 113      value of the call.  */
 114   tree mult, add;
 115
 116   /* Next tailcall in the chain.  */
 117   struct tailcall *next;
 118 };
 119
 120 /* The variables holding the value of multiplicative and additive
 121    accumulator.  */
 122 static tree m_acc, a_acc;
 123
 124 static bool suitable_for_tail_opt_p (void);
 125 static bool optimize_tail_call (struct tailcall *, bool);
 126 static void eliminate_tail_call (struct tailcall *);
 127 static void find_tail_calls (basic_block, struct tailcall **);
 128
 129 /* Returns false when the function is not suitable for tail call optimization
 130    from some reason (e.g. if it takes variable number of arguments).  */
 131
 132 static bool
 133 suitable_for_tail_opt_p (void)
 134 {
 135   int i;
 136
 137   if (current_function_stdarg)
 138     return false;
 139
 140   /* No local variable nor structure field should be call-clobbered.  We
 141      ignore any kind of memory tag, as these are not real variables.  */
 142   for (i = 0; i < (int) VARRAY_ACTIVE_SIZE (referenced_vars); i++)
 143     {
 144       tree var = VARRAY_TREE (referenced_vars, i);
 145
 146       if (!(TREE_STATIC (var) || DECL_EXTERNAL (var))
 147           && (var_ann (var)->mem_tag_kind == NOT_A_TAG
 148               || var_ann (var)->mem_tag_kind == STRUCT_FIELD)
 149           && is_call_clobbered (var))
 150         return false;
 151     }
 152
 153   return true;
 154 }
 155 /* Returns false when the function is not suitable for tail call optimization
 156    from some reason (e.g. if it takes variable number of arguments).
 157    This test must pass in addition to suitable_for_tail_opt_p in order to make
 158    tail call discovery happen.  */
 159
 160 static bool
 161 suitable_for_tail_call_opt_p (void)
 162 {
 163   tree param;
 164
 165   /* alloca (until we have stack slot life analysis) inhibits
 166      sibling call optimizations, but not tail recursion.  */
 167   if (current_function_calls_alloca)
 168     return false;
 169
 170   /* If we are using sjlj exceptions, we may need to add a call to
 171      _Unwind_SjLj_Unregister at exit of the function.  Which means
 172      that we cannot do any sibcall transformations.  */
 173   if (USING_SJLJ_EXCEPTIONS && current_function_has_exception_handlers ())
 174     return false;
 175
 176   /* Any function that calls setjmp might have longjmp called from
 177      any called function.  ??? We really should represent this
 178      properly in the CFG so that this needn't be special cased.  */
 179   if (current_function_calls_setjmp)
 180     return false;
 181
 182   /* ??? It is OK if the argument of a function is taken in some cases,
 183      but not in all cases.  See PR15387 and PR19616.  Revisit for 4.1.  */
 184   for (param = DECL_ARGUMENTS (current_function_decl);
 185        param;
 186        param = TREE_CHAIN (param))
 187     if (TREE_ADDRESSABLE (param))
 188       return false;
 189
 190   return true;
 191 }
 192
 193 /* Checks whether the expression EXPR in stmt AT is independent of the
 194    statement pointed by BSI (in a sense that we already know EXPR's value
 195    at BSI).  We use the fact that we are only called from the chain of
 196    basic blocks that have only single successor.  Returns the expression
 197    containing the value of EXPR at BSI.  */
 198
 199 static tree
 200 independent_of_stmt_p (tree expr, tree at, block_stmt_iterator bsi)
 201 {
 202   basic_block bb, call_bb, at_bb;
 203   edge e;
 204   edge_iterator ei;
 205
 206   if (is_gimple_min_invariant (expr))
 207     return expr;
 208
 209   if (TREE_CODE (expr) != SSA_NAME)
 210     return NULL_TREE;
 211
 212   /* Mark the blocks in the chain leading to the end.  */
 213   at_bb = bb_for_stmt (at);
 214   call_bb = bb_for_stmt (bsi_stmt (bsi));
 215   for (bb = call_bb; bb != at_bb; bb = single_succ (bb))
 216     bb->aux = &bb->aux;
 217   bb->aux = &bb->aux;
 218
 219   while (1)
 220     {
 221       at = SSA_NAME_DEF_STMT (expr);
 222       bb = bb_for_stmt (at);
 223
 224       /* The default definition or defined before the chain.  */
 225       if (!bb || !bb->aux)
 226         break;
 227
 228       if (bb == call_bb)
 229         {
 230           for (; !bsi_end_p (bsi); bsi_next (&bsi))
 231             if (bsi_stmt (bsi) == at)
 232               break;
 233
 234           if (!bsi_end_p (bsi))
 235             expr = NULL_TREE;
 236           break;
 237         }
 238
 239       if (TREE_CODE (at) != PHI_NODE)
 240         {
 241           expr = NULL_TREE;
 242           break;
 243         }
 244
 245       FOR_EACH_EDGE (e, ei, bb->preds)
 246         if (e->src->aux)
 247           break;
 248       gcc_assert (e);
 249
 250       expr = PHI_ARG_DEF_FROM_EDGE (at, e);
 251       if (TREE_CODE (expr) != SSA_NAME)
 252         {
 253           /* The value is a constant.  */
 254           break;
 255         }
 256     }
 257
 258   /* Unmark the blocks.  */
 259   for (bb = call_bb; bb != at_bb; bb = single_succ (bb))
 260     bb->aux = NULL;
 261   bb->aux = NULL;
 262
 263   return expr;
 264 }
 265
 266 /* Simulates the effect of an assignment of ASS in STMT on the return value
 267    of the tail recursive CALL passed in ASS_VAR.  M and A are the
 268    multiplicative and the additive factor for the real return value.  */
 269
 270 static bool
 271 process_assignment (tree ass, tree stmt, block_stmt_iterator call, tree *m,
 272                     tree *a, tree *ass_var)
 273 {
 274   tree op0, op1, non_ass_var;
 275   tree dest = TREE_OPERAND (ass, 0);
 276   tree src = TREE_OPERAND (ass, 1);
 277   enum tree_code code = TREE_CODE (src);
 278   tree src_var = src;
 279
 280   /* See if this is a simple copy operation of an SSA name to the function
 281      result.  In that case we may have a simple tail call.  Ignore type
 282      conversions that can never produce extra code between the function
 283      call and the function return.  */
 284   STRIP_NOPS (src_var);
 285   if (TREE_CODE (src_var) == SSA_NAME)
 286     {
 287       if (src_var != *ass_var)
 288         return false;
 289
 290       *ass_var = dest;
 291       return true;
 292     }
 293
 294   if (TREE_CODE_CLASS (code) != tcc_binary)
 295     return false;
 296
 297   /* Accumulator optimizations will reverse the order of operations.
 298      We can only do that for floating-point types if we're assuming
 299      that addition and multiplication are associative.  */
 300   if (!flag_unsafe_math_optimizations)
 301     if (FLOAT_TYPE_P (TREE_TYPE (DECL_RESULT (current_function_decl))))
 302       return false;
 303
 304   /* We only handle the code like
 305
 306      x = call ();
 307      y = m * x;
 308      z = y + a;
 309      return z;
 310
 311      TODO -- Extend it for cases where the linear transformation of the output
 312      is expressed in a more complicated way.  */
 313
 314   op0 = TREE_OPERAND (src, 0);
 315   op1 = TREE_OPERAND (src, 1);
 316
 317   if (op0 == *ass_var
 318       && (non_ass_var = independent_of_stmt_p (op1, stmt, call)))
 319     ;
 320   else if (op1 == *ass_var
 321            && (non_ass_var = independent_of_stmt_p (op0, stmt, call)))
 322     ;
 323   else
 324     return false;
 325
 326   switch (code)
 327     {
 328     case PLUS_EXPR:
 329       /* There should be no previous addition.  TODO -- it should be fairly
 330          straightforward to lift this restriction -- just allow storing
 331          more complicated expressions in *A, and gimplify it in
 332          adjust_accumulator_values.  */
 333       if (*a)
 334         return false;
 335       *a = non_ass_var;
 336       *ass_var = dest;
 337       return true;
 338
 339     case MULT_EXPR:
 340       /* Similar remark applies here.  Handling multiplication after addition
 341          is just slightly more complicated -- we need to multiply both *A and
 342          *M.  */
 343       if (*a || *m)
 344         return false;
 345       *m = non_ass_var;
 346       *ass_var = dest;
 347       return true;
 348
 349       /* TODO -- Handle other codes (NEGATE_EXPR, MINUS_EXPR).  */
 350
 351     default:
 352       return false;
 353     }
 354 }
 355
 356 /* Propagate VAR through phis on edge E.  */
 357
 358 static tree
 359 propagate_through_phis (tree var, edge e)
 360 {
 361   basic_block dest = e->dest;
 362   tree phi;
 363
 364   for (phi = phi_nodes (dest); phi; phi = PHI_CHAIN (phi))
 365     if (PHI_ARG_DEF_FROM_EDGE (phi, e) == var)
 366       return PHI_RESULT (phi);
 367
 368   return var;
 369 }
 370
 371 /* Finds tailcalls falling into basic block BB. The list of found tailcalls is
 372    added to the start of RET.  */
 373
 374 static void
 375 find_tail_calls (basic_block bb, struct tailcall **ret)
 376 {
 377   tree ass_var, ret_var, stmt, func, param, args, call = NULL_TREE;
 378   block_stmt_iterator bsi, absi;
 379   bool tail_recursion;
 380   struct tailcall *nw;
 381   edge e;
 382   tree m, a;
 383   basic_block abb;
 384   stmt_ann_t ann;
 385
 386   if (!single_succ_p (bb))
 387     return;
 388
 389   for (bsi = bsi_last (bb); !bsi_end_p (bsi); bsi_prev (&bsi))
 390     {
 391       stmt = bsi_stmt (bsi);
 392
 393       /* Ignore labels.  */
 394       if (TREE_CODE (stmt) == LABEL_EXPR)
 395         continue;
 396
 397       /* Check for a call.  */
 398       if (TREE_CODE (stmt) == MODIFY_EXPR)
 399         {
 400           ass_var = TREE_OPERAND (stmt, 0);
 401           call = TREE_OPERAND (stmt, 1);
 402           if (TREE_CODE (call) == WITH_SIZE_EXPR)
 403             call = TREE_OPERAND (call, 0);
 404         }
 405       else
 406         {
 407           ass_var = NULL_TREE;
 408           call = stmt;
 409         }
 410
 411       if (TREE_CODE (call) == CALL_EXPR)
 412         break;
 413
 414       /* If the statement has virtual or volatile operands, fail.  */
 415       ann = stmt_ann (stmt);
 416       if (NUM_V_MAY_DEFS (V_MAY_DEF_OPS (ann))
 417           || NUM_V_MUST_DEFS (V_MUST_DEF_OPS (ann))
 418           || NUM_VUSES (VUSE_OPS (ann))
 419           || ann->has_volatile_ops)
 420         return;
 421     }
 422
 423   if (bsi_end_p (bsi))
 424     {
 425       edge_iterator ei;
 426       /* Recurse to the predecessors.  */
 427       FOR_EACH_EDGE (e, ei, bb->preds)
 428         find_tail_calls (e->src, ret);
 429
 430       return;
 431     }
 432
 433   /* We found the call, check whether it is suitable.  */
 434   tail_recursion = false;
 435   func = get_callee_fndecl (call);
 436   if (func == current_function_decl)
 437     {
 438       for (param = DECL_ARGUMENTS (func), args = TREE_OPERAND (call, 1);
 439            param && args;
 440            param = TREE_CHAIN (param), args = TREE_CHAIN (args))
 441         {
 442           tree arg = TREE_VALUE (args);
 443           if (param != arg)
 444             {
 445               /* Make sure there are no problems with copying.  The parameter
 446                  have a copyable type and the two arguments must have reasonably
 447                  equivalent types.  The latter requirement could be relaxed if
 448                  we emitted a suitable type conversion statement.  */
 449               if (!is_gimple_reg_type (TREE_TYPE (param))
 450                   || !lang_hooks.types_compatible_p (TREE_TYPE (param),
 451                                                      TREE_TYPE (arg)))
 452                 break;
 453
 454               /* The parameter should be a real operand, so that phi node
 455                  created for it at the start of the function has the meaning
 456                  of copying the value.  This test implies is_gimple_reg_type
 457                  from the previous condition, however this one could be
 458                  relaxed by being more careful with copying the new value
 459                  of the parameter (emitting appropriate MODIFY_EXPR and
 460                  updating the virtual operands).  */
 461               if (!is_gimple_reg (param))
 462                 break;
 463             }
 464         }
 465       if (!args && !param)
 466         tail_recursion = true;
 467     }
 468
 469   /* Now check the statements after the call.  None of them has virtual
 470      operands, so they may only depend on the call through its return
 471      value.  The return value should also be dependent on each of them,
 472      since we are running after dce.  */
 473   m = NULL_TREE;
 474   a = NULL_TREE;
 475
 476   abb = bb;
 477   absi = bsi;
 478   while (1)
 479     {
 480       bsi_next (&absi);
 481
 482       while (bsi_end_p (absi))
 483         {
 484           ass_var = propagate_through_phis (ass_var, single_succ_edge (abb));
 485           abb = single_succ (abb);
 486           absi = bsi_start (abb);
 487         }
 488
 489       stmt = bsi_stmt (absi);
 490
 491       if (TREE_CODE (stmt) == LABEL_EXPR)
 492         continue;
 493
 494       if (TREE_CODE (stmt) == RETURN_EXPR)
 495         break;
 496
 497       if (TREE_CODE (stmt) != MODIFY_EXPR)
 498         return;
 499
 500       if (!process_assignment (stmt, stmt, bsi, &m, &a, &ass_var))
 501         return;
 502     }
 503
 504   /* See if this is a tail call we can handle.  */
 505   ret_var = TREE_OPERAND (stmt, 0);
 506   if (ret_var
 507       && TREE_CODE (ret_var) == MODIFY_EXPR)
 508     {
 509       tree ret_op = TREE_OPERAND (ret_var, 1);
 510       STRIP_NOPS (ret_op);
 511       if (!tail_recursion
 512           && TREE_CODE (ret_op) != SSA_NAME)
 513         return;
 514
 515       if (!process_assignment (ret_var, stmt, bsi, &m, &a, &ass_var))
 516         return;
 517       ret_var = TREE_OPERAND (ret_var, 0);
 518     }
 519
 520   /* We may proceed if there either is no return value, or the return value
 521      is identical to the call's return.  */
 522   if (ret_var
 523       && (ret_var != ass_var))
 524     return;
 525
 526   /* If this is not a tail recursive call, we cannot handle addends or
 527      multiplicands.  */
 528   if (!tail_recursion && (m || a))
 529     return;
 530
 531   nw = xmalloc (sizeof (struct tailcall));
 532
 533   nw->call_block = bb;
 534   nw->call_bsi = bsi;
 535
 536   nw->tail_recursion = tail_recursion;
 537
 538   nw->mult = m;
 539   nw->add = a;
 540
 541   nw->next = *ret;
 542   *ret = nw;
 543 }
 544
 545 /* Adjust the accumulator values according to A and M after BSI, and update
 546    the phi nodes on edge BACK.  */
 547
 548 static void
 549 adjust_accumulator_values (block_stmt_iterator bsi, tree m, tree a, edge back)
 550 {
 551   tree stmt, var, phi, tmp;
 552   tree ret_type = TREE_TYPE (DECL_RESULT (current_function_decl));
 553   tree a_acc_arg = a_acc, m_acc_arg = m_acc;
 554
 555   if (a)
 556     {
 557       if (m_acc)
 558         {
 559           if (integer_onep (a))
 560             var = m_acc;
 561           else
 562             {
 563               stmt = build (MODIFY_EXPR, ret_type, NULL_TREE,
 564                             build (MULT_EXPR, ret_type, m_acc, a));
 565
 566               tmp = create_tmp_var (ret_type, "acc_tmp");
 567               add_referenced_tmp_var (tmp);
 568
 569               var = make_ssa_name (tmp, stmt);
 570               TREE_OPERAND (stmt, 0) = var;
 571               bsi_insert_after (&bsi, stmt, BSI_NEW_STMT);
 572             }
 573         }
 574       else
 575         var = a;
 576
 577       stmt = build (MODIFY_EXPR, ret_type, NULL_TREE,
 578                     build (PLUS_EXPR, ret_type, a_acc, var));
 579       var = make_ssa_name (SSA_NAME_VAR (a_acc), stmt);
 580       TREE_OPERAND (stmt, 0) = var;
 581       bsi_insert_after (&bsi, stmt, BSI_NEW_STMT);
 582       a_acc_arg = var;
 583     }
 584
 585   if (m)
 586     {
 587       stmt = build (MODIFY_EXPR, ret_type, NULL_TREE,
 588                     build (MULT_EXPR, ret_type, m_acc, m));
 589       var = make_ssa_name (SSA_NAME_VAR (m_acc), stmt);
 590       TREE_OPERAND (stmt, 0) = var;
 591       bsi_insert_after (&bsi, stmt, BSI_NEW_STMT);
 592       m_acc_arg = var;
 593     }
 594
 595   if (a_acc)
 596     {
 597       for (phi = phi_nodes (back->dest); phi; phi = PHI_CHAIN (phi))
 598         if (PHI_RESULT (phi) == a_acc)
 599           break;
 600
 601       add_phi_arg (phi, a_acc_arg, back);
 602     }
 603
 604   if (m_acc)
 605     {
 606       for (phi = phi_nodes (back->dest); phi; phi = PHI_CHAIN (phi))
 607         if (PHI_RESULT (phi) == m_acc)
 608           break;
 609
 610       add_phi_arg (phi, m_acc_arg, back);
 611     }
 612 }
 613
 614 /* Adjust value of the return at the end of BB according to M and A
 615    accumulators.  */
 616
 617 static void
 618 adjust_return_value (basic_block bb, tree m, tree a)
 619 {
 620   tree ret_stmt = last_stmt (bb), ret_var, var, stmt, tmp;
 621   tree ret_type = TREE_TYPE (DECL_RESULT (current_function_decl));
 622   block_stmt_iterator bsi = bsi_last (bb);
 623
 624   gcc_assert (TREE_CODE (ret_stmt) == RETURN_EXPR);
 625
 626   ret_var = TREE_OPERAND (ret_stmt, 0);
 627   if (!ret_var)
 628     return;
 629
 630   if (TREE_CODE (ret_var) == MODIFY_EXPR)
 631     {
 632       ret_var->common.ann = (tree_ann_t) stmt_ann (ret_stmt);
 633       bsi_replace (&bsi, ret_var, true);
 634       SSA_NAME_DEF_STMT (TREE_OPERAND (ret_var, 0)) = ret_var;
 635       ret_var = TREE_OPERAND (ret_var, 0);
 636       ret_stmt = build1 (RETURN_EXPR, TREE_TYPE (ret_stmt), ret_var);
 637       bsi_insert_after (&bsi, ret_stmt, BSI_NEW_STMT);
 638     }
 639
 640   if (m)
 641     {
 642       stmt = build (MODIFY_EXPR, ret_type, NULL_TREE,
 643                     build (MULT_EXPR, ret_type, m_acc, ret_var));
 644
 645       tmp = create_tmp_var (ret_type, "acc_tmp");
 646       add_referenced_tmp_var (tmp);
 647
 648       var = make_ssa_name (tmp, stmt);
 649       TREE_OPERAND (stmt, 0) = var;
 650       bsi_insert_before (&bsi, stmt, BSI_SAME_STMT);
 651     }
 652   else
 653     var = ret_var;
 654
 655   if (a)
 656     {
 657       stmt = build (MODIFY_EXPR, ret_type, NULL_TREE,
 658                     build (PLUS_EXPR, ret_type, a_acc, var));
 659
 660       tmp = create_tmp_var (ret_type, "acc_tmp");
 661       add_referenced_tmp_var (tmp);
 662
 663       var = make_ssa_name (tmp, stmt);
 664       TREE_OPERAND (stmt, 0) = var;
 665       bsi_insert_before (&bsi, stmt, BSI_SAME_STMT);
 666     }
 667
 668   TREE_OPERAND (ret_stmt, 0) = var;
 669   update_stmt (ret_stmt);
 670 }
 671
 672 /* Eliminates tail call described by T.  TMP_VARS is a list of
 673    temporary variables used to copy the function arguments.  */
 674
 675 static void
 676 eliminate_tail_call (struct tailcall *t)
 677 {
 678   tree param, stmt, args, rslt, call;
 679   basic_block bb, first;
 680   edge e;
 681   tree phi;
 682   stmt_ann_t ann;
 683   v_may_def_optype v_may_defs;
 684   unsigned i;
 685   block_stmt_iterator bsi;
 686
 687   stmt = bsi_stmt (t->call_bsi);
 688   ann = stmt_ann (stmt);
 689   bb = t->call_block;
 690
 691   if (dump_file && (dump_flags & TDF_DETAILS))
 692     {
 693       fprintf (dump_file, "Eliminated tail recursion in bb %d : ",
 694                bb->index);
 695       print_generic_stmt (dump_file, stmt, TDF_SLIM);
 696       fprintf (dump_file, "\n");
 697     }
 698
 699   if (TREE_CODE (stmt) == MODIFY_EXPR)
 700     stmt = TREE_OPERAND (stmt, 1);
 701
 702   first = single_succ (ENTRY_BLOCK_PTR);
 703
 704   /* Remove the code after call_bsi that will become unreachable.  The
 705      possibly unreachable code in other blocks is removed later in
 706      cfg cleanup.  */
 707   bsi = t->call_bsi;
 708   bsi_next (&bsi);
 709   while (!bsi_end_p (bsi))
 710     {
 711       tree t = bsi_stmt (bsi);
 712       /* Do not remove the return statement, so that redirect_edge_and_branch
 713          sees how the block ends.  */
 714       if (TREE_CODE (t) == RETURN_EXPR)
 715         break;
 716
 717       bsi_remove (&bsi);
 718       release_defs (t);
 719     }
 720
 721   /* Replace the call by a jump to the start of function.  */
 722   e = redirect_edge_and_branch (single_succ_edge (t->call_block), first);
 723   gcc_assert (e);
 724   PENDING_STMT (e) = NULL_TREE;
 725
 726   /* Add phi node entries for arguments.  Not every PHI node corresponds to
 727      a function argument (there may be PHI nodes for virtual definitions of the
 728      eliminated calls), so we search for a PHI corresponding to each argument
 729      rather than searching for which argument a PHI node corresponds to.  */
 730
 731   for (param = DECL_ARGUMENTS (current_function_decl),
 732        args = TREE_OPERAND (stmt, 1);
 733        param;
 734        param = TREE_CHAIN (param),
 735        args = TREE_CHAIN (args))
 736     {
 737
 738       for (phi = phi_nodes (first); phi; phi = PHI_CHAIN (phi))
 739         if (param == SSA_NAME_VAR (PHI_RESULT (phi)))
 740           break;
 741
 742       /* The phi node indeed does not have to be there, in case the operand is
 743          invariant in the function.  */
 744       if (!phi)
 745         continue;
 746
 747       add_phi_arg (phi, TREE_VALUE (args), e);
 748     }
 749
 750   /* Add phi nodes for the call clobbered variables.  */
 751   v_may_defs = V_MAY_DEF_OPS (ann);
 752   for (i = 0; i < NUM_V_MAY_DEFS (v_may_defs); i++)
 753     {
 754       param = SSA_NAME_VAR (V_MAY_DEF_RESULT (v_may_defs, i));
 755       for (phi = phi_nodes (first); phi; phi = PHI_CHAIN (phi))
 756         if (param == SSA_NAME_VAR (PHI_RESULT (phi)))
 757           break;
 758
 759       if (!phi)
 760         {
 761           tree name = var_ann (param)->default_def;
 762           tree new_name;
 763
 764           if (!name)
 765             {
 766               /* It may happen that the tag does not have a default_def in case
 767                  when all uses of it are dominated by a MUST_DEF.  This however
 768                  means that it is not necessary to add a phi node for this
 769                  tag.  */
 770               continue;
 771             }
 772           new_name = make_ssa_name (param, SSA_NAME_DEF_STMT (name));
 773
 774           var_ann (param)->default_def = new_name;
 775           phi = create_phi_node (name, first);
 776           SSA_NAME_DEF_STMT (name) = phi;
 777           add_phi_arg (phi, new_name, single_succ_edge (ENTRY_BLOCK_PTR));
 778
 779           /* For all calls the same set of variables should be clobbered.  This
 780              means that there always should be the appropriate phi node except
 781              for the first time we eliminate the call.  */
 782           gcc_assert (EDGE_COUNT (first->preds) <= 2);
 783         }
 784
 785       add_phi_arg (phi, V_MAY_DEF_OP (v_may_defs, i), e);
 786     }
 787
 788   /* Update the values of accumulators.  */
 789   adjust_accumulator_values (t->call_bsi, t->mult, t->add, e);
 790
 791   call = bsi_stmt (t->call_bsi);
 792   if (TREE_CODE (call) == MODIFY_EXPR)
 793     {
 794       rslt = TREE_OPERAND (call, 0);
 795
 796       /* Result of the call will no longer be defined.  So adjust the
 797          SSA_NAME_DEF_STMT accordingly.  */
 798       SSA_NAME_DEF_STMT (rslt) = build_empty_stmt ();
 799     }
 800
 801   bsi_remove (&t->call_bsi);
 802   release_defs (call);
 803 }
 804
 805 /* Optimizes the tailcall described by T.  If OPT_TAILCALLS is true, also
 806    mark the tailcalls for the sibcall optimization.  */
 807
 808 static bool
 809 optimize_tail_call (struct tailcall *t, bool opt_tailcalls)
 810 {
 811   if (t->tail_recursion)
 812     {
 813       eliminate_tail_call (t);
 814       return true;
 815     }
 816
 817   if (opt_tailcalls)
 818     {
 819       tree stmt = bsi_stmt (t->call_bsi);
 820
 821       stmt = get_call_expr_in (stmt);
 822       CALL_EXPR_TAILCALL (stmt) = 1;
 823       if (dump_file && (dump_flags & TDF_DETAILS))
 824         {
 825           fprintf (dump_file, "Found tail call ");
 826           print_generic_expr (dump_file, stmt, dump_flags);
 827           fprintf (dump_file, " in bb %i\n", t->call_block->index);
 828         }
 829     }
 830
 831   return false;
 832 }
 833
 834 /* Optimizes tail calls in the function, turning the tail recursion
 835    into iteration.  */
 836
 837 static void
 838 tree_optimize_tail_calls_1 (bool opt_tailcalls)
 839 {
 840   edge e;
 841   bool phis_constructed = false;
 842   struct tailcall *tailcalls = NULL, *act, *next;
 843   bool changed = false;
 844   basic_block first = single_succ (ENTRY_BLOCK_PTR);
 845   tree stmt, param, ret_type, tmp, phi;
 846   edge_iterator ei;
 847
 848   if (!suitable_for_tail_opt_p ())
 849     return;
 850   if (opt_tailcalls)
 851     opt_tailcalls = suitable_for_tail_call_opt_p ();
 852
 853   FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
 854     {
 855       /* Only traverse the normal exits, i.e. those that end with return
 856          statement.  */
 857       stmt = last_stmt (e->src);
 858
 859       if (stmt
 860           && TREE_CODE (stmt) == RETURN_EXPR)
 861         find_tail_calls (e->src, &tailcalls);
 862     }
 863
 864   /* Construct the phi nodes and accumulators if necessary.  */
 865   a_acc = m_acc = NULL_TREE;
 866   for (act = tailcalls; act; act = act->next)
 867     {
 868       if (!act->tail_recursion)
 869         continue;
 870
 871       if (!phis_constructed)
 872         {
 873           /* Ensure that there is only one predecessor of the block.  */
 874           if (!single_pred_p (first))
 875             first = split_edge (single_succ_edge (ENTRY_BLOCK_PTR));
 876
 877           /* Copy the args if needed.  */
 878           for (param = DECL_ARGUMENTS (current_function_decl);
 879                param;
 880                param = TREE_CHAIN (param))
 881             if (is_gimple_reg (param)
 882                 && var_ann (param)
 883                 /* Also parameters that are only defined but never used need not
 884                    be copied.  */
 885                 && (var_ann (param)->default_def
 886                     && TREE_CODE (var_ann (param)->default_def) == SSA_NAME))
 887             {
 888               tree name = var_ann (param)->default_def;
 889               tree new_name = make_ssa_name (param, SSA_NAME_DEF_STMT (name));
 890               tree phi;
 891
 892               var_ann (param)->default_def = new_name;
 893               phi = create_phi_node (name, first);
 894               SSA_NAME_DEF_STMT (name) = phi;
 895               add_phi_arg (phi, new_name, single_pred_edge (first));
 896             }
 897           phis_constructed = true;
 898         }
 899
 900       if (act->add && !a_acc)
 901         {
 902           ret_type = TREE_TYPE (DECL_RESULT (current_function_decl));
 903
 904           tmp = create_tmp_var (ret_type, "add_acc");
 905           add_referenced_tmp_var (tmp);
 906
 907           phi = create_phi_node (tmp, first);
 908           add_phi_arg (phi,
 909                        /* RET_TYPE can be a float when -ffast-maths is
 910                           enabled.  */
 911                        fold_convert (ret_type, integer_zero_node),
 912                        single_pred_edge (first));
 913           a_acc = PHI_RESULT (phi);
 914         }
 915
 916       if (act->mult && !m_acc)
 917         {
 918           ret_type = TREE_TYPE (DECL_RESULT (current_function_decl));
 919
 920           tmp = create_tmp_var (ret_type, "mult_acc");
 921           add_referenced_tmp_var (tmp);
 922
 923           phi = create_phi_node (tmp, first);
 924           add_phi_arg (phi,
 925                        /* RET_TYPE can be a float when -ffast-maths is
 926                           enabled.  */
 927                        fold_convert (ret_type, integer_one_node),
 928                        single_pred_edge (first));
 929           m_acc = PHI_RESULT (phi);
 930         }
 931     }
 932
 933   for (; tailcalls; tailcalls = next)
 934     {
 935       next = tailcalls->next;
 936       changed |= optimize_tail_call (tailcalls, opt_tailcalls);
 937       free (tailcalls);
 938     }
 939
 940   if (a_acc || m_acc)
 941     {
 942       /* Modify the remaining return statements.  */
 943       FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
 944         {
 945           stmt = last_stmt (e->src);
 946
 947           if (stmt
 948               && TREE_CODE (stmt) == RETURN_EXPR)
 949             adjust_return_value (e->src, m_acc, a_acc);
 950         }
 951     }
 952
 953   if (changed)
 954     {
 955       free_dominance_info (CDI_DOMINATORS);
 956       cleanup_tree_cfg ();
 957     }
 958 }
 959
 960 static void
 961 execute_tail_recursion (void)
 962 {
 963   tree_optimize_tail_calls_1 (false);
 964 }
 965
 966 static bool
 967 gate_tail_calls (void)
 968 {
 969   return flag_optimize_sibling_calls != 0;
 970 }
 971
 972 static void
 973 execute_tail_calls (void)
 974 {
 975   tree_optimize_tail_calls_1 (true);
 976 }
 977
 978 struct tree_opt_pass pass_tail_recursion =
 979 {
 980   "tailr",                              /* name */
 981   NULL,                                 /* gate */
 982   execute_tail_recursion,               /* execute */
 983   NULL,                                 /* sub */
 984   NULL,                                 /* next */
 985   0,                                    /* static_pass_number */
 986   0,                                    /* tv_id */
 987   PROP_cfg | PROP_ssa | PROP_alias,     /* properties_required */
 988   0,                                    /* properties_provided */
 989   0,                                    /* properties_destroyed */
 990   0,                                    /* todo_flags_start */
 991   TODO_dump_func | TODO_verify_ssa,     /* todo_flags_finish */
 992   0                                     /* letter */
 993 };
 994
 995 struct tree_opt_pass pass_tail_calls =
 996 {
 997   "tailc",                              /* name */
 998   gate_tail_calls,                      /* gate */
 999   execute_tail_calls,                   /* execute */
1000   NULL,                                 /* sub */
1001   NULL,                                 /* next */
1002   0,                                    /* static_pass_number */
1003   0,                                    /* tv_id */
1004   PROP_cfg | PROP_ssa | PROP_alias,     /* properties_required */
1005   0,                                    /* properties_provided */
1006   0,                                    /* properties_destroyed */
1007   0,                                    /* todo_flags_start */
1008   TODO_dump_func | TODO_verify_ssa,     /* todo_flags_finish */
1009   0                                     /* letter */
1010 };