Update copyright years in gcc/
[gcc.git] / gcc / tree-tailcall.c
1 /* Tail call optimization on trees.
2 Copyright (C) 2003-2013 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 3, 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 COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
19
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "tm.h"
24 #include "tree.h"
25 #include "tm_p.h"
26 #include "basic-block.h"
27 #include "function.h"
28 #include "tree-flow.h"
29 #include "gimple-pretty-print.h"
30 #include "except.h"
31 #include "tree-pass.h"
32 #include "flags.h"
33 #include "langhooks.h"
34 #include "dbgcnt.h"
35 #include "target.h"
36 #include "common/common-target.h"
37
38 /* The file implements the tail recursion elimination. It is also used to
39 analyze the tail calls in general, passing the results to the rtl level
40 where they are used for sibcall optimization.
41
42 In addition to the standard tail recursion elimination, we handle the most
43 trivial cases of making the call tail recursive by creating accumulators.
44 For example the following function
45
46 int sum (int n)
47 {
48 if (n > 0)
49 return n + sum (n - 1);
50 else
51 return 0;
52 }
53
54 is transformed into
55
56 int sum (int n)
57 {
58 int acc = 0;
59
60 while (n > 0)
61 acc += n--;
62
63 return acc;
64 }
65
66 To do this, we maintain two accumulators (a_acc and m_acc) that indicate
67 when we reach the return x statement, we should return a_acc + x * m_acc
68 instead. They are initially initialized to 0 and 1, respectively,
69 so the semantics of the function is obviously preserved. If we are
70 guaranteed that the value of the accumulator never change, we
71 omit the accumulator.
72
73 There are three cases how the function may exit. The first one is
74 handled in adjust_return_value, the other two in adjust_accumulator_values
75 (the second case is actually a special case of the third one and we
76 present it separately just for clarity):
77
78 1) Just return x, where x is not in any of the remaining special shapes.
79 We rewrite this to a gimple equivalent of return m_acc * x + a_acc.
80
81 2) return f (...), where f is the current function, is rewritten in a
82 classical tail-recursion elimination way, into assignment of arguments
83 and jump to the start of the function. Values of the accumulators
84 are unchanged.
85
86 3) return a + m * f(...), where a and m do not depend on call to f.
87 To preserve the semantics described before we want this to be rewritten
88 in such a way that we finally return
89
90 a_acc + (a + m * f(...)) * m_acc = (a_acc + a * m_acc) + (m * m_acc) * f(...).
91
92 I.e. we increase a_acc by a * m_acc, multiply m_acc by m and
93 eliminate the tail call to f. Special cases when the value is just
94 added or just multiplied are obtained by setting a = 0 or m = 1.
95
96 TODO -- it is possible to do similar tricks for other operations. */
97
98 /* A structure that describes the tailcall. */
99
100 struct tailcall
101 {
102 /* The iterator pointing to the call statement. */
103 gimple_stmt_iterator call_gsi;
104
105 /* True if it is a call to the current function. */
106 bool tail_recursion;
107
108 /* The return value of the caller is mult * f + add, where f is the return
109 value of the call. */
110 tree mult, add;
111
112 /* Next tailcall in the chain. */
113 struct tailcall *next;
114 };
115
116 /* The variables holding the value of multiplicative and additive
117 accumulator. */
118 static tree m_acc, a_acc;
119
120 static bool suitable_for_tail_opt_p (void);
121 static bool optimize_tail_call (struct tailcall *, bool);
122 static void eliminate_tail_call (struct tailcall *);
123 static void find_tail_calls (basic_block, struct tailcall **);
124
125 /* Returns false when the function is not suitable for tail call optimization
126 from some reason (e.g. if it takes variable number of arguments). */
127
128 static bool
129 suitable_for_tail_opt_p (void)
130 {
131 if (cfun->stdarg)
132 return false;
133
134 return true;
135 }
136 /* Returns false when the function is not suitable for tail call optimization
137 from some reason (e.g. if it takes variable number of arguments).
138 This test must pass in addition to suitable_for_tail_opt_p in order to make
139 tail call discovery happen. */
140
141 static bool
142 suitable_for_tail_call_opt_p (void)
143 {
144 tree param;
145
146 /* alloca (until we have stack slot life analysis) inhibits
147 sibling call optimizations, but not tail recursion. */
148 if (cfun->calls_alloca)
149 return false;
150
151 /* If we are using sjlj exceptions, we may need to add a call to
152 _Unwind_SjLj_Unregister at exit of the function. Which means
153 that we cannot do any sibcall transformations. */
154 if (targetm_common.except_unwind_info (&global_options) == UI_SJLJ
155 && current_function_has_exception_handlers ())
156 return false;
157
158 /* Any function that calls setjmp might have longjmp called from
159 any called function. ??? We really should represent this
160 properly in the CFG so that this needn't be special cased. */
161 if (cfun->calls_setjmp)
162 return false;
163
164 /* ??? It is OK if the argument of a function is taken in some cases,
165 but not in all cases. See PR15387 and PR19616. Revisit for 4.1. */
166 for (param = DECL_ARGUMENTS (current_function_decl);
167 param;
168 param = DECL_CHAIN (param))
169 if (TREE_ADDRESSABLE (param))
170 return false;
171
172 return true;
173 }
174
175 /* Checks whether the expression EXPR in stmt AT is independent of the
176 statement pointed to by GSI (in a sense that we already know EXPR's value
177 at GSI). We use the fact that we are only called from the chain of
178 basic blocks that have only single successor. Returns the expression
179 containing the value of EXPR at GSI. */
180
181 static tree
182 independent_of_stmt_p (tree expr, gimple at, gimple_stmt_iterator gsi)
183 {
184 basic_block bb, call_bb, at_bb;
185 edge e;
186 edge_iterator ei;
187
188 if (is_gimple_min_invariant (expr))
189 return expr;
190
191 if (TREE_CODE (expr) != SSA_NAME)
192 return NULL_TREE;
193
194 /* Mark the blocks in the chain leading to the end. */
195 at_bb = gimple_bb (at);
196 call_bb = gimple_bb (gsi_stmt (gsi));
197 for (bb = call_bb; bb != at_bb; bb = single_succ (bb))
198 bb->aux = &bb->aux;
199 bb->aux = &bb->aux;
200
201 while (1)
202 {
203 at = SSA_NAME_DEF_STMT (expr);
204 bb = gimple_bb (at);
205
206 /* The default definition or defined before the chain. */
207 if (!bb || !bb->aux)
208 break;
209
210 if (bb == call_bb)
211 {
212 for (; !gsi_end_p (gsi); gsi_next (&gsi))
213 if (gsi_stmt (gsi) == at)
214 break;
215
216 if (!gsi_end_p (gsi))
217 expr = NULL_TREE;
218 break;
219 }
220
221 if (gimple_code (at) != GIMPLE_PHI)
222 {
223 expr = NULL_TREE;
224 break;
225 }
226
227 FOR_EACH_EDGE (e, ei, bb->preds)
228 if (e->src->aux)
229 break;
230 gcc_assert (e);
231
232 expr = PHI_ARG_DEF_FROM_EDGE (at, e);
233 if (TREE_CODE (expr) != SSA_NAME)
234 {
235 /* The value is a constant. */
236 break;
237 }
238 }
239
240 /* Unmark the blocks. */
241 for (bb = call_bb; bb != at_bb; bb = single_succ (bb))
242 bb->aux = NULL;
243 bb->aux = NULL;
244
245 return expr;
246 }
247
248 /* Simulates the effect of an assignment STMT on the return value of the tail
249 recursive CALL passed in ASS_VAR. M and A are the multiplicative and the
250 additive factor for the real return value. */
251
252 static bool
253 process_assignment (gimple stmt, gimple_stmt_iterator call, tree *m,
254 tree *a, tree *ass_var)
255 {
256 tree op0, op1 = NULL_TREE, non_ass_var = NULL_TREE;
257 tree dest = gimple_assign_lhs (stmt);
258 enum tree_code code = gimple_assign_rhs_code (stmt);
259 enum gimple_rhs_class rhs_class = get_gimple_rhs_class (code);
260 tree src_var = gimple_assign_rhs1 (stmt);
261
262 /* See if this is a simple copy operation of an SSA name to the function
263 result. In that case we may have a simple tail call. Ignore type
264 conversions that can never produce extra code between the function
265 call and the function return. */
266 if ((rhs_class == GIMPLE_SINGLE_RHS || gimple_assign_cast_p (stmt))
267 && (TREE_CODE (src_var) == SSA_NAME))
268 {
269 /* Reject a tailcall if the type conversion might need
270 additional code. */
271 if (gimple_assign_cast_p (stmt)
272 && TYPE_MODE (TREE_TYPE (dest)) != TYPE_MODE (TREE_TYPE (src_var)))
273 return false;
274
275 if (src_var != *ass_var)
276 return false;
277
278 *ass_var = dest;
279 return true;
280 }
281
282 switch (rhs_class)
283 {
284 case GIMPLE_BINARY_RHS:
285 op1 = gimple_assign_rhs2 (stmt);
286
287 /* Fall through. */
288
289 case GIMPLE_UNARY_RHS:
290 op0 = gimple_assign_rhs1 (stmt);
291 break;
292
293 default:
294 return false;
295 }
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_associative_math)
301 if (FLOAT_TYPE_P (TREE_TYPE (DECL_RESULT (current_function_decl))))
302 return false;
303
304 if (rhs_class == GIMPLE_UNARY_RHS)
305 ;
306 else if (op0 == *ass_var
307 && (non_ass_var = independent_of_stmt_p (op1, stmt, call)))
308 ;
309 else if (op1 == *ass_var
310 && (non_ass_var = independent_of_stmt_p (op0, stmt, call)))
311 ;
312 else
313 return false;
314
315 switch (code)
316 {
317 case PLUS_EXPR:
318 *a = non_ass_var;
319 *ass_var = dest;
320 return true;
321
322 case MULT_EXPR:
323 *m = non_ass_var;
324 *ass_var = dest;
325 return true;
326
327 case NEGATE_EXPR:
328 if (FLOAT_TYPE_P (TREE_TYPE (op0)))
329 *m = build_real (TREE_TYPE (op0), dconstm1);
330 else
331 *m = build_int_cst (TREE_TYPE (op0), -1);
332
333 *ass_var = dest;
334 return true;
335
336 case MINUS_EXPR:
337 if (*ass_var == op0)
338 *a = fold_build1 (NEGATE_EXPR, TREE_TYPE (non_ass_var), non_ass_var);
339 else
340 {
341 if (FLOAT_TYPE_P (TREE_TYPE (non_ass_var)))
342 *m = build_real (TREE_TYPE (non_ass_var), dconstm1);
343 else
344 *m = build_int_cst (TREE_TYPE (non_ass_var), -1);
345
346 *a = fold_build1 (NEGATE_EXPR, TREE_TYPE (non_ass_var), non_ass_var);
347 }
348
349 *ass_var = dest;
350 return true;
351
352 /* TODO -- Handle POINTER_PLUS_EXPR. */
353
354 default:
355 return false;
356 }
357 }
358
359 /* Propagate VAR through phis on edge E. */
360
361 static tree
362 propagate_through_phis (tree var, edge e)
363 {
364 basic_block dest = e->dest;
365 gimple_stmt_iterator gsi;
366
367 for (gsi = gsi_start_phis (dest); !gsi_end_p (gsi); gsi_next (&gsi))
368 {
369 gimple phi = gsi_stmt (gsi);
370 if (PHI_ARG_DEF_FROM_EDGE (phi, e) == var)
371 return PHI_RESULT (phi);
372 }
373 return var;
374 }
375
376 /* Finds tailcalls falling into basic block BB. The list of found tailcalls is
377 added to the start of RET. */
378
379 static void
380 find_tail_calls (basic_block bb, struct tailcall **ret)
381 {
382 tree ass_var = NULL_TREE, ret_var, func, param;
383 gimple stmt, call = NULL;
384 gimple_stmt_iterator gsi, agsi;
385 bool tail_recursion;
386 struct tailcall *nw;
387 edge e;
388 tree m, a;
389 basic_block abb;
390 size_t idx;
391 tree var;
392
393 if (!single_succ_p (bb))
394 return;
395
396 for (gsi = gsi_last_bb (bb); !gsi_end_p (gsi); gsi_prev (&gsi))
397 {
398 stmt = gsi_stmt (gsi);
399
400 /* Ignore labels, returns, clobbers and debug stmts. */
401 if (gimple_code (stmt) == GIMPLE_LABEL
402 || gimple_code (stmt) == GIMPLE_RETURN
403 || gimple_clobber_p (stmt)
404 || is_gimple_debug (stmt))
405 continue;
406
407 /* Check for a call. */
408 if (is_gimple_call (stmt))
409 {
410 call = stmt;
411 ass_var = gimple_call_lhs (stmt);
412 break;
413 }
414
415 /* If the statement references memory or volatile operands, fail. */
416 if (gimple_references_memory_p (stmt)
417 || gimple_has_volatile_ops (stmt))
418 return;
419 }
420
421 if (gsi_end_p (gsi))
422 {
423 edge_iterator ei;
424 /* Recurse to the predecessors. */
425 FOR_EACH_EDGE (e, ei, bb->preds)
426 find_tail_calls (e->src, ret);
427
428 return;
429 }
430
431 /* If the LHS of our call is not just a simple register, we can't
432 transform this into a tail or sibling call. This situation happens,
433 in (e.g.) "*p = foo()" where foo returns a struct. In this case
434 we won't have a temporary here, but we need to carry out the side
435 effect anyway, so tailcall is impossible.
436
437 ??? In some situations (when the struct is returned in memory via
438 invisible argument) we could deal with this, e.g. by passing 'p'
439 itself as that argument to foo, but it's too early to do this here,
440 and expand_call() will not handle it anyway. If it ever can, then
441 we need to revisit this here, to allow that situation. */
442 if (ass_var && !is_gimple_reg (ass_var))
443 return;
444
445 /* We found the call, check whether it is suitable. */
446 tail_recursion = false;
447 func = gimple_call_fndecl (call);
448 if (func == current_function_decl)
449 {
450 tree arg;
451
452 for (param = DECL_ARGUMENTS (func), idx = 0;
453 param && idx < gimple_call_num_args (call);
454 param = DECL_CHAIN (param), idx ++)
455 {
456 arg = gimple_call_arg (call, idx);
457 if (param != arg)
458 {
459 /* Make sure there are no problems with copying. The parameter
460 have a copyable type and the two arguments must have reasonably
461 equivalent types. The latter requirement could be relaxed if
462 we emitted a suitable type conversion statement. */
463 if (!is_gimple_reg_type (TREE_TYPE (param))
464 || !useless_type_conversion_p (TREE_TYPE (param),
465 TREE_TYPE (arg)))
466 break;
467
468 /* The parameter should be a real operand, so that phi node
469 created for it at the start of the function has the meaning
470 of copying the value. This test implies is_gimple_reg_type
471 from the previous condition, however this one could be
472 relaxed by being more careful with copying the new value
473 of the parameter (emitting appropriate GIMPLE_ASSIGN and
474 updating the virtual operands). */
475 if (!is_gimple_reg (param))
476 break;
477 }
478 }
479 if (idx == gimple_call_num_args (call) && !param)
480 tail_recursion = true;
481 }
482
483 /* Make sure the tail invocation of this function does not refer
484 to local variables. */
485 FOR_EACH_LOCAL_DECL (cfun, idx, var)
486 {
487 if (TREE_CODE (var) != PARM_DECL
488 && auto_var_in_fn_p (var, cfun->decl)
489 && (ref_maybe_used_by_stmt_p (call, var)
490 || call_may_clobber_ref_p (call, var)))
491 return;
492 }
493
494 /* Now check the statements after the call. None of them has virtual
495 operands, so they may only depend on the call through its return
496 value. The return value should also be dependent on each of them,
497 since we are running after dce. */
498 m = NULL_TREE;
499 a = NULL_TREE;
500
501 abb = bb;
502 agsi = gsi;
503 while (1)
504 {
505 tree tmp_a = NULL_TREE;
506 tree tmp_m = NULL_TREE;
507 gsi_next (&agsi);
508
509 while (gsi_end_p (agsi))
510 {
511 ass_var = propagate_through_phis (ass_var, single_succ_edge (abb));
512 abb = single_succ (abb);
513 agsi = gsi_start_bb (abb);
514 }
515
516 stmt = gsi_stmt (agsi);
517
518 if (gimple_code (stmt) == GIMPLE_LABEL)
519 continue;
520
521 if (gimple_code (stmt) == GIMPLE_RETURN)
522 break;
523
524 if (gimple_clobber_p (stmt))
525 continue;
526
527 if (is_gimple_debug (stmt))
528 continue;
529
530 if (gimple_code (stmt) != GIMPLE_ASSIGN)
531 return;
532
533 /* This is a gimple assign. */
534 if (! process_assignment (stmt, gsi, &tmp_m, &tmp_a, &ass_var))
535 return;
536
537 if (tmp_a)
538 {
539 tree type = TREE_TYPE (tmp_a);
540 if (a)
541 a = fold_build2 (PLUS_EXPR, type, fold_convert (type, a), tmp_a);
542 else
543 a = tmp_a;
544 }
545 if (tmp_m)
546 {
547 tree type = TREE_TYPE (tmp_m);
548 if (m)
549 m = fold_build2 (MULT_EXPR, type, fold_convert (type, m), tmp_m);
550 else
551 m = tmp_m;
552
553 if (a)
554 a = fold_build2 (MULT_EXPR, type, fold_convert (type, a), tmp_m);
555 }
556 }
557
558 /* See if this is a tail call we can handle. */
559 ret_var = gimple_return_retval (stmt);
560
561 /* We may proceed if there either is no return value, or the return value
562 is identical to the call's return. */
563 if (ret_var
564 && (ret_var != ass_var))
565 return;
566
567 /* If this is not a tail recursive call, we cannot handle addends or
568 multiplicands. */
569 if (!tail_recursion && (m || a))
570 return;
571
572 nw = XNEW (struct tailcall);
573
574 nw->call_gsi = gsi;
575
576 nw->tail_recursion = tail_recursion;
577
578 nw->mult = m;
579 nw->add = a;
580
581 nw->next = *ret;
582 *ret = nw;
583 }
584
585 /* Helper to insert PHI_ARGH to the phi of VAR in the destination of edge E. */
586
587 static void
588 add_successor_phi_arg (edge e, tree var, tree phi_arg)
589 {
590 gimple_stmt_iterator gsi;
591
592 for (gsi = gsi_start_phis (e->dest); !gsi_end_p (gsi); gsi_next (&gsi))
593 if (PHI_RESULT (gsi_stmt (gsi)) == var)
594 break;
595
596 gcc_assert (!gsi_end_p (gsi));
597 add_phi_arg (gsi_stmt (gsi), phi_arg, e, UNKNOWN_LOCATION);
598 }
599
600 /* Creates a GIMPLE statement which computes the operation specified by
601 CODE, OP0 and OP1 to a new variable with name LABEL and inserts the
602 statement in the position specified by GSI and UPDATE. Returns the
603 tree node of the statement's result. */
604
605 static tree
606 adjust_return_value_with_ops (enum tree_code code, const char *label,
607 tree acc, tree op1, gimple_stmt_iterator gsi)
608 {
609
610 tree ret_type = TREE_TYPE (DECL_RESULT (current_function_decl));
611 tree result = make_temp_ssa_name (ret_type, NULL, label);
612 gimple stmt;
613
614 if (types_compatible_p (TREE_TYPE (acc), TREE_TYPE (op1)))
615 stmt = gimple_build_assign_with_ops (code, result, acc, op1);
616 else
617 {
618 tree rhs = fold_convert (TREE_TYPE (acc),
619 fold_build2 (code,
620 TREE_TYPE (op1),
621 fold_convert (TREE_TYPE (op1), acc),
622 op1));
623 rhs = force_gimple_operand_gsi (&gsi, rhs,
624 false, NULL, true, GSI_CONTINUE_LINKING);
625 stmt = gimple_build_assign (result, rhs);
626 }
627
628 gsi_insert_before (&gsi, stmt, GSI_NEW_STMT);
629 return result;
630 }
631
632 /* Creates a new GIMPLE statement that adjusts the value of accumulator ACC by
633 the computation specified by CODE and OP1 and insert the statement
634 at the position specified by GSI as a new statement. Returns new SSA name
635 of updated accumulator. */
636
637 static tree
638 update_accumulator_with_ops (enum tree_code code, tree acc, tree op1,
639 gimple_stmt_iterator gsi)
640 {
641 gimple stmt;
642 tree var = copy_ssa_name (acc, NULL);
643 if (types_compatible_p (TREE_TYPE (acc), TREE_TYPE (op1)))
644 stmt = gimple_build_assign_with_ops (code, var, acc, op1);
645 else
646 {
647 tree rhs = fold_convert (TREE_TYPE (acc),
648 fold_build2 (code,
649 TREE_TYPE (op1),
650 fold_convert (TREE_TYPE (op1), acc),
651 op1));
652 rhs = force_gimple_operand_gsi (&gsi, rhs,
653 false, NULL, false, GSI_CONTINUE_LINKING);
654 stmt = gimple_build_assign (var, rhs);
655 }
656 gsi_insert_after (&gsi, stmt, GSI_NEW_STMT);
657 return var;
658 }
659
660 /* Adjust the accumulator values according to A and M after GSI, and update
661 the phi nodes on edge BACK. */
662
663 static void
664 adjust_accumulator_values (gimple_stmt_iterator gsi, tree m, tree a, edge back)
665 {
666 tree var, a_acc_arg, m_acc_arg;
667
668 if (m)
669 m = force_gimple_operand_gsi (&gsi, m, true, NULL, true, GSI_SAME_STMT);
670 if (a)
671 a = force_gimple_operand_gsi (&gsi, a, true, NULL, true, GSI_SAME_STMT);
672
673 a_acc_arg = a_acc;
674 m_acc_arg = m_acc;
675 if (a)
676 {
677 if (m_acc)
678 {
679 if (integer_onep (a))
680 var = m_acc;
681 else
682 var = adjust_return_value_with_ops (MULT_EXPR, "acc_tmp", m_acc,
683 a, gsi);
684 }
685 else
686 var = a;
687
688 a_acc_arg = update_accumulator_with_ops (PLUS_EXPR, a_acc, var, gsi);
689 }
690
691 if (m)
692 m_acc_arg = update_accumulator_with_ops (MULT_EXPR, m_acc, m, gsi);
693
694 if (a_acc)
695 add_successor_phi_arg (back, a_acc, a_acc_arg);
696
697 if (m_acc)
698 add_successor_phi_arg (back, m_acc, m_acc_arg);
699 }
700
701 /* Adjust value of the return at the end of BB according to M and A
702 accumulators. */
703
704 static void
705 adjust_return_value (basic_block bb, tree m, tree a)
706 {
707 tree retval;
708 gimple ret_stmt = gimple_seq_last_stmt (bb_seq (bb));
709 gimple_stmt_iterator gsi = gsi_last_bb (bb);
710
711 gcc_assert (gimple_code (ret_stmt) == GIMPLE_RETURN);
712
713 retval = gimple_return_retval (ret_stmt);
714 if (!retval || retval == error_mark_node)
715 return;
716
717 if (m)
718 retval = adjust_return_value_with_ops (MULT_EXPR, "mul_tmp", m_acc, retval,
719 gsi);
720 if (a)
721 retval = adjust_return_value_with_ops (PLUS_EXPR, "acc_tmp", a_acc, retval,
722 gsi);
723 gimple_return_set_retval (ret_stmt, retval);
724 update_stmt (ret_stmt);
725 }
726
727 /* Subtract COUNT and FREQUENCY from the basic block and it's
728 outgoing edge. */
729 static void
730 decrease_profile (basic_block bb, gcov_type count, int frequency)
731 {
732 edge e;
733 bb->count -= count;
734 if (bb->count < 0)
735 bb->count = 0;
736 bb->frequency -= frequency;
737 if (bb->frequency < 0)
738 bb->frequency = 0;
739 if (!single_succ_p (bb))
740 {
741 gcc_assert (!EDGE_COUNT (bb->succs));
742 return;
743 }
744 e = single_succ_edge (bb);
745 e->count -= count;
746 if (e->count < 0)
747 e->count = 0;
748 }
749
750 /* Returns true if argument PARAM of the tail recursive call needs to be copied
751 when the call is eliminated. */
752
753 static bool
754 arg_needs_copy_p (tree param)
755 {
756 tree def;
757
758 if (!is_gimple_reg (param))
759 return false;
760
761 /* Parameters that are only defined but never used need not be copied. */
762 def = ssa_default_def (cfun, param);
763 if (!def)
764 return false;
765
766 return true;
767 }
768
769 /* Eliminates tail call described by T. TMP_VARS is a list of
770 temporary variables used to copy the function arguments. */
771
772 static void
773 eliminate_tail_call (struct tailcall *t)
774 {
775 tree param, rslt;
776 gimple stmt, call;
777 tree arg;
778 size_t idx;
779 basic_block bb, first;
780 edge e;
781 gimple phi;
782 gimple_stmt_iterator gsi;
783 gimple orig_stmt;
784
785 stmt = orig_stmt = gsi_stmt (t->call_gsi);
786 bb = gsi_bb (t->call_gsi);
787
788 if (dump_file && (dump_flags & TDF_DETAILS))
789 {
790 fprintf (dump_file, "Eliminated tail recursion in bb %d : ",
791 bb->index);
792 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
793 fprintf (dump_file, "\n");
794 }
795
796 gcc_assert (is_gimple_call (stmt));
797
798 first = single_succ (ENTRY_BLOCK_PTR);
799
800 /* Remove the code after call_gsi that will become unreachable. The
801 possibly unreachable code in other blocks is removed later in
802 cfg cleanup. */
803 gsi = t->call_gsi;
804 gsi_next (&gsi);
805 while (!gsi_end_p (gsi))
806 {
807 gimple t = gsi_stmt (gsi);
808 /* Do not remove the return statement, so that redirect_edge_and_branch
809 sees how the block ends. */
810 if (gimple_code (t) == GIMPLE_RETURN)
811 break;
812
813 gsi_remove (&gsi, true);
814 release_defs (t);
815 }
816
817 /* Number of executions of function has reduced by the tailcall. */
818 e = single_succ_edge (gsi_bb (t->call_gsi));
819 decrease_profile (EXIT_BLOCK_PTR, e->count, EDGE_FREQUENCY (e));
820 decrease_profile (ENTRY_BLOCK_PTR, e->count, EDGE_FREQUENCY (e));
821 if (e->dest != EXIT_BLOCK_PTR)
822 decrease_profile (e->dest, e->count, EDGE_FREQUENCY (e));
823
824 /* Replace the call by a jump to the start of function. */
825 e = redirect_edge_and_branch (single_succ_edge (gsi_bb (t->call_gsi)),
826 first);
827 gcc_assert (e);
828 PENDING_STMT (e) = NULL;
829
830 /* Add phi node entries for arguments. The ordering of the phi nodes should
831 be the same as the ordering of the arguments. */
832 for (param = DECL_ARGUMENTS (current_function_decl),
833 idx = 0, gsi = gsi_start_phis (first);
834 param;
835 param = DECL_CHAIN (param), idx++)
836 {
837 if (!arg_needs_copy_p (param))
838 continue;
839
840 arg = gimple_call_arg (stmt, idx);
841 phi = gsi_stmt (gsi);
842 gcc_assert (param == SSA_NAME_VAR (PHI_RESULT (phi)));
843
844 add_phi_arg (phi, arg, e, gimple_location (stmt));
845 gsi_next (&gsi);
846 }
847
848 /* Update the values of accumulators. */
849 adjust_accumulator_values (t->call_gsi, t->mult, t->add, e);
850
851 call = gsi_stmt (t->call_gsi);
852 rslt = gimple_call_lhs (call);
853 if (rslt != NULL_TREE)
854 {
855 /* Result of the call will no longer be defined. So adjust the
856 SSA_NAME_DEF_STMT accordingly. */
857 SSA_NAME_DEF_STMT (rslt) = gimple_build_nop ();
858 }
859
860 gsi_remove (&t->call_gsi, true);
861 release_defs (call);
862 }
863
864 /* Optimizes the tailcall described by T. If OPT_TAILCALLS is true, also
865 mark the tailcalls for the sibcall optimization. */
866
867 static bool
868 optimize_tail_call (struct tailcall *t, bool opt_tailcalls)
869 {
870 if (t->tail_recursion)
871 {
872 eliminate_tail_call (t);
873 return true;
874 }
875
876 if (opt_tailcalls)
877 {
878 gimple stmt = gsi_stmt (t->call_gsi);
879
880 gimple_call_set_tail (stmt, true);
881 if (dump_file && (dump_flags & TDF_DETAILS))
882 {
883 fprintf (dump_file, "Found tail call ");
884 print_gimple_stmt (dump_file, stmt, 0, dump_flags);
885 fprintf (dump_file, " in bb %i\n", (gsi_bb (t->call_gsi))->index);
886 }
887 }
888
889 return false;
890 }
891
892 /* Creates a tail-call accumulator of the same type as the return type of the
893 current function. LABEL is the name used to creating the temporary
894 variable for the accumulator. The accumulator will be inserted in the
895 phis of a basic block BB with single predecessor with an initial value
896 INIT converted to the current function return type. */
897
898 static tree
899 create_tailcall_accumulator (const char *label, basic_block bb, tree init)
900 {
901 tree ret_type = TREE_TYPE (DECL_RESULT (current_function_decl));
902 tree tmp = make_temp_ssa_name (ret_type, NULL, label);
903 gimple phi;
904
905 phi = create_phi_node (tmp, bb);
906 /* RET_TYPE can be a float when -ffast-maths is enabled. */
907 add_phi_arg (phi, fold_convert (ret_type, init), single_pred_edge (bb),
908 UNKNOWN_LOCATION);
909 return PHI_RESULT (phi);
910 }
911
912 /* Optimizes tail calls in the function, turning the tail recursion
913 into iteration. */
914
915 static unsigned int
916 tree_optimize_tail_calls_1 (bool opt_tailcalls)
917 {
918 edge e;
919 bool phis_constructed = false;
920 struct tailcall *tailcalls = NULL, *act, *next;
921 bool changed = false;
922 basic_block first = single_succ (ENTRY_BLOCK_PTR);
923 tree param;
924 gimple stmt;
925 edge_iterator ei;
926
927 if (!suitable_for_tail_opt_p ())
928 return 0;
929 if (opt_tailcalls)
930 opt_tailcalls = suitable_for_tail_call_opt_p ();
931
932 FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
933 {
934 /* Only traverse the normal exits, i.e. those that end with return
935 statement. */
936 stmt = last_stmt (e->src);
937
938 if (stmt
939 && gimple_code (stmt) == GIMPLE_RETURN)
940 find_tail_calls (e->src, &tailcalls);
941 }
942
943 /* Construct the phi nodes and accumulators if necessary. */
944 a_acc = m_acc = NULL_TREE;
945 for (act = tailcalls; act; act = act->next)
946 {
947 if (!act->tail_recursion)
948 continue;
949
950 if (!phis_constructed)
951 {
952 /* Ensure that there is only one predecessor of the block
953 or if there are existing degenerate PHI nodes. */
954 if (!single_pred_p (first)
955 || !gimple_seq_empty_p (phi_nodes (first)))
956 first = split_edge (single_succ_edge (ENTRY_BLOCK_PTR));
957
958 /* Copy the args if needed. */
959 for (param = DECL_ARGUMENTS (current_function_decl);
960 param;
961 param = DECL_CHAIN (param))
962 if (arg_needs_copy_p (param))
963 {
964 tree name = ssa_default_def (cfun, param);
965 tree new_name = make_ssa_name (param, SSA_NAME_DEF_STMT (name));
966 gimple phi;
967
968 set_ssa_default_def (cfun, param, new_name);
969 phi = create_phi_node (name, first);
970 add_phi_arg (phi, new_name, single_pred_edge (first),
971 EXPR_LOCATION (param));
972 }
973 phis_constructed = true;
974 }
975
976 if (act->add && !a_acc)
977 a_acc = create_tailcall_accumulator ("add_acc", first,
978 integer_zero_node);
979
980 if (act->mult && !m_acc)
981 m_acc = create_tailcall_accumulator ("mult_acc", first,
982 integer_one_node);
983 }
984
985 if (a_acc || m_acc)
986 {
987 /* When the tail call elimination using accumulators is performed,
988 statements adding the accumulated value are inserted at all exits.
989 This turns all other tail calls to non-tail ones. */
990 opt_tailcalls = false;
991 }
992
993 for (; tailcalls; tailcalls = next)
994 {
995 next = tailcalls->next;
996 changed |= optimize_tail_call (tailcalls, opt_tailcalls);
997 free (tailcalls);
998 }
999
1000 if (a_acc || m_acc)
1001 {
1002 /* Modify the remaining return statements. */
1003 FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
1004 {
1005 stmt = last_stmt (e->src);
1006
1007 if (stmt
1008 && gimple_code (stmt) == GIMPLE_RETURN)
1009 adjust_return_value (e->src, m_acc, a_acc);
1010 }
1011 }
1012
1013 if (changed)
1014 free_dominance_info (CDI_DOMINATORS);
1015
1016 /* Add phi nodes for the virtual operands defined in the function to the
1017 header of the loop created by tail recursion elimination. Do so
1018 by triggering the SSA renamer. */
1019 if (phis_constructed)
1020 mark_virtual_operands_for_renaming (cfun);
1021
1022 if (changed)
1023 return TODO_cleanup_cfg | TODO_update_ssa_only_virtuals;
1024 return 0;
1025 }
1026
1027 static unsigned int
1028 execute_tail_recursion (void)
1029 {
1030 return tree_optimize_tail_calls_1 (false);
1031 }
1032
1033 static bool
1034 gate_tail_calls (void)
1035 {
1036 return flag_optimize_sibling_calls != 0 && dbg_cnt (tail_call);
1037 }
1038
1039 static unsigned int
1040 execute_tail_calls (void)
1041 {
1042 return tree_optimize_tail_calls_1 (true);
1043 }
1044
1045 struct gimple_opt_pass pass_tail_recursion =
1046 {
1047 {
1048 GIMPLE_PASS,
1049 "tailr", /* name */
1050 OPTGROUP_NONE, /* optinfo_flags */
1051 gate_tail_calls, /* gate */
1052 execute_tail_recursion, /* execute */
1053 NULL, /* sub */
1054 NULL, /* next */
1055 0, /* static_pass_number */
1056 TV_NONE, /* tv_id */
1057 PROP_cfg | PROP_ssa, /* properties_required */
1058 0, /* properties_provided */
1059 0, /* properties_destroyed */
1060 0, /* todo_flags_start */
1061 TODO_verify_ssa /* todo_flags_finish */
1062 }
1063 };
1064
1065 struct gimple_opt_pass pass_tail_calls =
1066 {
1067 {
1068 GIMPLE_PASS,
1069 "tailc", /* name */
1070 OPTGROUP_NONE, /* optinfo_flags */
1071 gate_tail_calls, /* gate */
1072 execute_tail_calls, /* execute */
1073 NULL, /* sub */
1074 NULL, /* next */
1075 0, /* static_pass_number */
1076 TV_NONE, /* tv_id */
1077 PROP_cfg | PROP_ssa, /* properties_required */
1078 0, /* properties_provided */
1079 0, /* properties_destroyed */
1080 0, /* todo_flags_start */
1081 TODO_verify_ssa /* todo_flags_finish */
1082 }
1083 };