* gimple-ssa-store-merging.c (struct store_immediate_info): Add
[official-gcc.git] / gcc / tree-ssa-loop-niter.c
blobb97f1dba0f6631b237606e44c43b64c31c00c7ed
1 /* Functions to determine/estimate number of iterations of a loop.
2 Copyright (C) 2004-2017 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any
9 later version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
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/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "backend.h"
24 #include "rtl.h"
25 #include "tree.h"
26 #include "gimple.h"
27 #include "tree-pass.h"
28 #include "ssa.h"
29 #include "gimple-pretty-print.h"
30 #include "diagnostic-core.h"
31 #include "stor-layout.h"
32 #include "fold-const.h"
33 #include "calls.h"
34 #include "intl.h"
35 #include "gimplify.h"
36 #include "gimple-iterator.h"
37 #include "tree-cfg.h"
38 #include "tree-ssa-loop-ivopts.h"
39 #include "tree-ssa-loop-niter.h"
40 #include "tree-ssa-loop.h"
41 #include "cfgloop.h"
42 #include "tree-chrec.h"
43 #include "tree-scalar-evolution.h"
44 #include "params.h"
45 #include "tree-dfa.h"
48 /* The maximum number of dominator BBs we search for conditions
49 of loop header copies we use for simplifying a conditional
50 expression. */
51 #define MAX_DOMINATORS_TO_WALK 8
55 Analysis of number of iterations of an affine exit test.
59 /* Bounds on some value, BELOW <= X <= UP. */
61 struct bounds
63 mpz_t below, up;
67 /* Splits expression EXPR to a variable part VAR and constant OFFSET. */
69 static void
70 split_to_var_and_offset (tree expr, tree *var, mpz_t offset)
72 tree type = TREE_TYPE (expr);
73 tree op0, op1;
74 bool negate = false;
76 *var = expr;
77 mpz_set_ui (offset, 0);
79 switch (TREE_CODE (expr))
81 case MINUS_EXPR:
82 negate = true;
83 /* Fallthru. */
85 case PLUS_EXPR:
86 case POINTER_PLUS_EXPR:
87 op0 = TREE_OPERAND (expr, 0);
88 op1 = TREE_OPERAND (expr, 1);
90 if (TREE_CODE (op1) != INTEGER_CST)
91 break;
93 *var = op0;
94 /* Always sign extend the offset. */
95 wi::to_mpz (wi::to_wide (op1), offset, SIGNED);
96 if (negate)
97 mpz_neg (offset, offset);
98 break;
100 case INTEGER_CST:
101 *var = build_int_cst_type (type, 0);
102 wi::to_mpz (wi::to_wide (expr), offset, TYPE_SIGN (type));
103 break;
105 default:
106 break;
110 /* From condition C0 CMP C1 derives information regarding the value range
111 of VAR, which is of TYPE. Results are stored in to BELOW and UP. */
113 static void
114 refine_value_range_using_guard (tree type, tree var,
115 tree c0, enum tree_code cmp, tree c1,
116 mpz_t below, mpz_t up)
118 tree varc0, varc1, ctype;
119 mpz_t offc0, offc1;
120 mpz_t mint, maxt, minc1, maxc1;
121 wide_int minv, maxv;
122 bool no_wrap = nowrap_type_p (type);
123 bool c0_ok, c1_ok;
124 signop sgn = TYPE_SIGN (type);
126 switch (cmp)
128 case LT_EXPR:
129 case LE_EXPR:
130 case GT_EXPR:
131 case GE_EXPR:
132 STRIP_SIGN_NOPS (c0);
133 STRIP_SIGN_NOPS (c1);
134 ctype = TREE_TYPE (c0);
135 if (!useless_type_conversion_p (ctype, type))
136 return;
138 break;
140 case EQ_EXPR:
141 /* We could derive quite precise information from EQ_EXPR, however,
142 such a guard is unlikely to appear, so we do not bother with
143 handling it. */
144 return;
146 case NE_EXPR:
147 /* NE_EXPR comparisons do not contain much of useful information,
148 except for cases of comparing with bounds. */
149 if (TREE_CODE (c1) != INTEGER_CST
150 || !INTEGRAL_TYPE_P (type))
151 return;
153 /* Ensure that the condition speaks about an expression in the same
154 type as X and Y. */
155 ctype = TREE_TYPE (c0);
156 if (TYPE_PRECISION (ctype) != TYPE_PRECISION (type))
157 return;
158 c0 = fold_convert (type, c0);
159 c1 = fold_convert (type, c1);
161 if (operand_equal_p (var, c0, 0))
163 mpz_t valc1;
165 /* Case of comparing VAR with its below/up bounds. */
166 mpz_init (valc1);
167 wi::to_mpz (wi::to_wide (c1), valc1, TYPE_SIGN (type));
168 if (mpz_cmp (valc1, below) == 0)
169 cmp = GT_EXPR;
170 if (mpz_cmp (valc1, up) == 0)
171 cmp = LT_EXPR;
173 mpz_clear (valc1);
175 else
177 /* Case of comparing with the bounds of the type. */
178 wide_int min = wi::min_value (type);
179 wide_int max = wi::max_value (type);
181 if (wi::to_wide (c1) == min)
182 cmp = GT_EXPR;
183 if (wi::to_wide (c1) == max)
184 cmp = LT_EXPR;
187 /* Quick return if no useful information. */
188 if (cmp == NE_EXPR)
189 return;
191 break;
193 default:
194 return;
197 mpz_init (offc0);
198 mpz_init (offc1);
199 split_to_var_and_offset (expand_simple_operations (c0), &varc0, offc0);
200 split_to_var_and_offset (expand_simple_operations (c1), &varc1, offc1);
202 /* We are only interested in comparisons of expressions based on VAR. */
203 if (operand_equal_p (var, varc1, 0))
205 std::swap (varc0, varc1);
206 mpz_swap (offc0, offc1);
207 cmp = swap_tree_comparison (cmp);
209 else if (!operand_equal_p (var, varc0, 0))
211 mpz_clear (offc0);
212 mpz_clear (offc1);
213 return;
216 mpz_init (mint);
217 mpz_init (maxt);
218 get_type_static_bounds (type, mint, maxt);
219 mpz_init (minc1);
220 mpz_init (maxc1);
221 /* Setup range information for varc1. */
222 if (integer_zerop (varc1))
224 wi::to_mpz (0, minc1, TYPE_SIGN (type));
225 wi::to_mpz (0, maxc1, TYPE_SIGN (type));
227 else if (TREE_CODE (varc1) == SSA_NAME
228 && INTEGRAL_TYPE_P (type)
229 && get_range_info (varc1, &minv, &maxv) == VR_RANGE)
231 gcc_assert (wi::le_p (minv, maxv, sgn));
232 wi::to_mpz (minv, minc1, sgn);
233 wi::to_mpz (maxv, maxc1, sgn);
235 else
237 mpz_set (minc1, mint);
238 mpz_set (maxc1, maxt);
241 /* Compute valid range information for varc1 + offc1. Note nothing
242 useful can be derived if it overflows or underflows. Overflow or
243 underflow could happen when:
245 offc1 > 0 && varc1 + offc1 > MAX_VAL (type)
246 offc1 < 0 && varc1 + offc1 < MIN_VAL (type). */
247 mpz_add (minc1, minc1, offc1);
248 mpz_add (maxc1, maxc1, offc1);
249 c1_ok = (no_wrap
250 || mpz_sgn (offc1) == 0
251 || (mpz_sgn (offc1) < 0 && mpz_cmp (minc1, mint) >= 0)
252 || (mpz_sgn (offc1) > 0 && mpz_cmp (maxc1, maxt) <= 0));
253 if (!c1_ok)
254 goto end;
256 if (mpz_cmp (minc1, mint) < 0)
257 mpz_set (minc1, mint);
258 if (mpz_cmp (maxc1, maxt) > 0)
259 mpz_set (maxc1, maxt);
261 if (cmp == LT_EXPR)
263 cmp = LE_EXPR;
264 mpz_sub_ui (maxc1, maxc1, 1);
266 if (cmp == GT_EXPR)
268 cmp = GE_EXPR;
269 mpz_add_ui (minc1, minc1, 1);
272 /* Compute range information for varc0. If there is no overflow,
273 the condition implied that
275 (varc0) cmp (varc1 + offc1 - offc0)
277 We can possibly improve the upper bound of varc0 if cmp is LE_EXPR,
278 or the below bound if cmp is GE_EXPR.
280 To prove there is no overflow/underflow, we need to check below
281 four cases:
282 1) cmp == LE_EXPR && offc0 > 0
284 (varc0 + offc0) doesn't overflow
285 && (varc1 + offc1 - offc0) doesn't underflow
287 2) cmp == LE_EXPR && offc0 < 0
289 (varc0 + offc0) doesn't underflow
290 && (varc1 + offc1 - offc0) doesn't overfloe
292 In this case, (varc0 + offc0) will never underflow if we can
293 prove (varc1 + offc1 - offc0) doesn't overflow.
295 3) cmp == GE_EXPR && offc0 < 0
297 (varc0 + offc0) doesn't underflow
298 && (varc1 + offc1 - offc0) doesn't overflow
300 4) cmp == GE_EXPR && offc0 > 0
302 (varc0 + offc0) doesn't overflow
303 && (varc1 + offc1 - offc0) doesn't underflow
305 In this case, (varc0 + offc0) will never overflow if we can
306 prove (varc1 + offc1 - offc0) doesn't underflow.
308 Note we only handle case 2 and 4 in below code. */
310 mpz_sub (minc1, minc1, offc0);
311 mpz_sub (maxc1, maxc1, offc0);
312 c0_ok = (no_wrap
313 || mpz_sgn (offc0) == 0
314 || (cmp == LE_EXPR
315 && mpz_sgn (offc0) < 0 && mpz_cmp (maxc1, maxt) <= 0)
316 || (cmp == GE_EXPR
317 && mpz_sgn (offc0) > 0 && mpz_cmp (minc1, mint) >= 0));
318 if (!c0_ok)
319 goto end;
321 if (cmp == LE_EXPR)
323 if (mpz_cmp (up, maxc1) > 0)
324 mpz_set (up, maxc1);
326 else
328 if (mpz_cmp (below, minc1) < 0)
329 mpz_set (below, minc1);
332 end:
333 mpz_clear (mint);
334 mpz_clear (maxt);
335 mpz_clear (minc1);
336 mpz_clear (maxc1);
337 mpz_clear (offc0);
338 mpz_clear (offc1);
341 /* Stores estimate on the minimum/maximum value of the expression VAR + OFF
342 in TYPE to MIN and MAX. */
344 static void
345 determine_value_range (struct loop *loop, tree type, tree var, mpz_t off,
346 mpz_t min, mpz_t max)
348 int cnt = 0;
349 mpz_t minm, maxm;
350 basic_block bb;
351 wide_int minv, maxv;
352 enum value_range_type rtype = VR_VARYING;
354 /* If the expression is a constant, we know its value exactly. */
355 if (integer_zerop (var))
357 mpz_set (min, off);
358 mpz_set (max, off);
359 return;
362 get_type_static_bounds (type, min, max);
364 /* See if we have some range info from VRP. */
365 if (TREE_CODE (var) == SSA_NAME && INTEGRAL_TYPE_P (type))
367 edge e = loop_preheader_edge (loop);
368 signop sgn = TYPE_SIGN (type);
369 gphi_iterator gsi;
371 /* Either for VAR itself... */
372 rtype = get_range_info (var, &minv, &maxv);
373 /* Or for PHI results in loop->header where VAR is used as
374 PHI argument from the loop preheader edge. */
375 for (gsi = gsi_start_phis (loop->header); !gsi_end_p (gsi); gsi_next (&gsi))
377 gphi *phi = gsi.phi ();
378 wide_int minc, maxc;
379 if (PHI_ARG_DEF_FROM_EDGE (phi, e) == var
380 && (get_range_info (gimple_phi_result (phi), &minc, &maxc)
381 == VR_RANGE))
383 if (rtype != VR_RANGE)
385 rtype = VR_RANGE;
386 minv = minc;
387 maxv = maxc;
389 else
391 minv = wi::max (minv, minc, sgn);
392 maxv = wi::min (maxv, maxc, sgn);
393 /* If the PHI result range are inconsistent with
394 the VAR range, give up on looking at the PHI
395 results. This can happen if VR_UNDEFINED is
396 involved. */
397 if (wi::gt_p (minv, maxv, sgn))
399 rtype = get_range_info (var, &minv, &maxv);
400 break;
405 mpz_init (minm);
406 mpz_init (maxm);
407 if (rtype != VR_RANGE)
409 mpz_set (minm, min);
410 mpz_set (maxm, max);
412 else
414 gcc_assert (wi::le_p (minv, maxv, sgn));
415 wi::to_mpz (minv, minm, sgn);
416 wi::to_mpz (maxv, maxm, sgn);
418 /* Now walk the dominators of the loop header and use the entry
419 guards to refine the estimates. */
420 for (bb = loop->header;
421 bb != ENTRY_BLOCK_PTR_FOR_FN (cfun) && cnt < MAX_DOMINATORS_TO_WALK;
422 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
424 edge e;
425 tree c0, c1;
426 gimple *cond;
427 enum tree_code cmp;
429 if (!single_pred_p (bb))
430 continue;
431 e = single_pred_edge (bb);
433 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
434 continue;
436 cond = last_stmt (e->src);
437 c0 = gimple_cond_lhs (cond);
438 cmp = gimple_cond_code (cond);
439 c1 = gimple_cond_rhs (cond);
441 if (e->flags & EDGE_FALSE_VALUE)
442 cmp = invert_tree_comparison (cmp, false);
444 refine_value_range_using_guard (type, var, c0, cmp, c1, minm, maxm);
445 ++cnt;
448 mpz_add (minm, minm, off);
449 mpz_add (maxm, maxm, off);
450 /* If the computation may not wrap or off is zero, then this
451 is always fine. If off is negative and minv + off isn't
452 smaller than type's minimum, or off is positive and
453 maxv + off isn't bigger than type's maximum, use the more
454 precise range too. */
455 if (nowrap_type_p (type)
456 || mpz_sgn (off) == 0
457 || (mpz_sgn (off) < 0 && mpz_cmp (minm, min) >= 0)
458 || (mpz_sgn (off) > 0 && mpz_cmp (maxm, max) <= 0))
460 mpz_set (min, minm);
461 mpz_set (max, maxm);
462 mpz_clear (minm);
463 mpz_clear (maxm);
464 return;
466 mpz_clear (minm);
467 mpz_clear (maxm);
470 /* If the computation may wrap, we know nothing about the value, except for
471 the range of the type. */
472 if (!nowrap_type_p (type))
473 return;
475 /* Since the addition of OFF does not wrap, if OFF is positive, then we may
476 add it to MIN, otherwise to MAX. */
477 if (mpz_sgn (off) < 0)
478 mpz_add (max, max, off);
479 else
480 mpz_add (min, min, off);
483 /* Stores the bounds on the difference of the values of the expressions
484 (var + X) and (var + Y), computed in TYPE, to BNDS. */
486 static void
487 bound_difference_of_offsetted_base (tree type, mpz_t x, mpz_t y,
488 bounds *bnds)
490 int rel = mpz_cmp (x, y);
491 bool may_wrap = !nowrap_type_p (type);
492 mpz_t m;
494 /* If X == Y, then the expressions are always equal.
495 If X > Y, there are the following possibilities:
496 a) neither of var + X and var + Y overflow or underflow, or both of
497 them do. Then their difference is X - Y.
498 b) var + X overflows, and var + Y does not. Then the values of the
499 expressions are var + X - M and var + Y, where M is the range of
500 the type, and their difference is X - Y - M.
501 c) var + Y underflows and var + X does not. Their difference again
502 is M - X + Y.
503 Therefore, if the arithmetics in type does not overflow, then the
504 bounds are (X - Y, X - Y), otherwise they are (X - Y - M, X - Y)
505 Similarly, if X < Y, the bounds are either (X - Y, X - Y) or
506 (X - Y, X - Y + M). */
508 if (rel == 0)
510 mpz_set_ui (bnds->below, 0);
511 mpz_set_ui (bnds->up, 0);
512 return;
515 mpz_init (m);
516 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), m, UNSIGNED);
517 mpz_add_ui (m, m, 1);
518 mpz_sub (bnds->up, x, y);
519 mpz_set (bnds->below, bnds->up);
521 if (may_wrap)
523 if (rel > 0)
524 mpz_sub (bnds->below, bnds->below, m);
525 else
526 mpz_add (bnds->up, bnds->up, m);
529 mpz_clear (m);
532 /* From condition C0 CMP C1 derives information regarding the
533 difference of values of VARX + OFFX and VARY + OFFY, computed in TYPE,
534 and stores it to BNDS. */
536 static void
537 refine_bounds_using_guard (tree type, tree varx, mpz_t offx,
538 tree vary, mpz_t offy,
539 tree c0, enum tree_code cmp, tree c1,
540 bounds *bnds)
542 tree varc0, varc1, ctype;
543 mpz_t offc0, offc1, loffx, loffy, bnd;
544 bool lbound = false;
545 bool no_wrap = nowrap_type_p (type);
546 bool x_ok, y_ok;
548 switch (cmp)
550 case LT_EXPR:
551 case LE_EXPR:
552 case GT_EXPR:
553 case GE_EXPR:
554 STRIP_SIGN_NOPS (c0);
555 STRIP_SIGN_NOPS (c1);
556 ctype = TREE_TYPE (c0);
557 if (!useless_type_conversion_p (ctype, type))
558 return;
560 break;
562 case EQ_EXPR:
563 /* We could derive quite precise information from EQ_EXPR, however, such
564 a guard is unlikely to appear, so we do not bother with handling
565 it. */
566 return;
568 case NE_EXPR:
569 /* NE_EXPR comparisons do not contain much of useful information, except for
570 special case of comparing with the bounds of the type. */
571 if (TREE_CODE (c1) != INTEGER_CST
572 || !INTEGRAL_TYPE_P (type))
573 return;
575 /* Ensure that the condition speaks about an expression in the same type
576 as X and Y. */
577 ctype = TREE_TYPE (c0);
578 if (TYPE_PRECISION (ctype) != TYPE_PRECISION (type))
579 return;
580 c0 = fold_convert (type, c0);
581 c1 = fold_convert (type, c1);
583 if (TYPE_MIN_VALUE (type)
584 && operand_equal_p (c1, TYPE_MIN_VALUE (type), 0))
586 cmp = GT_EXPR;
587 break;
589 if (TYPE_MAX_VALUE (type)
590 && operand_equal_p (c1, TYPE_MAX_VALUE (type), 0))
592 cmp = LT_EXPR;
593 break;
596 return;
597 default:
598 return;
601 mpz_init (offc0);
602 mpz_init (offc1);
603 split_to_var_and_offset (expand_simple_operations (c0), &varc0, offc0);
604 split_to_var_and_offset (expand_simple_operations (c1), &varc1, offc1);
606 /* We are only interested in comparisons of expressions based on VARX and
607 VARY. TODO -- we might also be able to derive some bounds from
608 expressions containing just one of the variables. */
610 if (operand_equal_p (varx, varc1, 0))
612 std::swap (varc0, varc1);
613 mpz_swap (offc0, offc1);
614 cmp = swap_tree_comparison (cmp);
617 if (!operand_equal_p (varx, varc0, 0)
618 || !operand_equal_p (vary, varc1, 0))
619 goto end;
621 mpz_init_set (loffx, offx);
622 mpz_init_set (loffy, offy);
624 if (cmp == GT_EXPR || cmp == GE_EXPR)
626 std::swap (varx, vary);
627 mpz_swap (offc0, offc1);
628 mpz_swap (loffx, loffy);
629 cmp = swap_tree_comparison (cmp);
630 lbound = true;
633 /* If there is no overflow, the condition implies that
635 (VARX + OFFX) cmp (VARY + OFFY) + (OFFX - OFFY + OFFC1 - OFFC0).
637 The overflows and underflows may complicate things a bit; each
638 overflow decreases the appropriate offset by M, and underflow
639 increases it by M. The above inequality would not necessarily be
640 true if
642 -- VARX + OFFX underflows and VARX + OFFC0 does not, or
643 VARX + OFFC0 overflows, but VARX + OFFX does not.
644 This may only happen if OFFX < OFFC0.
645 -- VARY + OFFY overflows and VARY + OFFC1 does not, or
646 VARY + OFFC1 underflows and VARY + OFFY does not.
647 This may only happen if OFFY > OFFC1. */
649 if (no_wrap)
651 x_ok = true;
652 y_ok = true;
654 else
656 x_ok = (integer_zerop (varx)
657 || mpz_cmp (loffx, offc0) >= 0);
658 y_ok = (integer_zerop (vary)
659 || mpz_cmp (loffy, offc1) <= 0);
662 if (x_ok && y_ok)
664 mpz_init (bnd);
665 mpz_sub (bnd, loffx, loffy);
666 mpz_add (bnd, bnd, offc1);
667 mpz_sub (bnd, bnd, offc0);
669 if (cmp == LT_EXPR)
670 mpz_sub_ui (bnd, bnd, 1);
672 if (lbound)
674 mpz_neg (bnd, bnd);
675 if (mpz_cmp (bnds->below, bnd) < 0)
676 mpz_set (bnds->below, bnd);
678 else
680 if (mpz_cmp (bnd, bnds->up) < 0)
681 mpz_set (bnds->up, bnd);
683 mpz_clear (bnd);
686 mpz_clear (loffx);
687 mpz_clear (loffy);
688 end:
689 mpz_clear (offc0);
690 mpz_clear (offc1);
693 /* Stores the bounds on the value of the expression X - Y in LOOP to BNDS.
694 The subtraction is considered to be performed in arbitrary precision,
695 without overflows.
697 We do not attempt to be too clever regarding the value ranges of X and
698 Y; most of the time, they are just integers or ssa names offsetted by
699 integer. However, we try to use the information contained in the
700 comparisons before the loop (usually created by loop header copying). */
702 static void
703 bound_difference (struct loop *loop, tree x, tree y, bounds *bnds)
705 tree type = TREE_TYPE (x);
706 tree varx, vary;
707 mpz_t offx, offy;
708 mpz_t minx, maxx, miny, maxy;
709 int cnt = 0;
710 edge e;
711 basic_block bb;
712 tree c0, c1;
713 gimple *cond;
714 enum tree_code cmp;
716 /* Get rid of unnecessary casts, but preserve the value of
717 the expressions. */
718 STRIP_SIGN_NOPS (x);
719 STRIP_SIGN_NOPS (y);
721 mpz_init (bnds->below);
722 mpz_init (bnds->up);
723 mpz_init (offx);
724 mpz_init (offy);
725 split_to_var_and_offset (x, &varx, offx);
726 split_to_var_and_offset (y, &vary, offy);
728 if (!integer_zerop (varx)
729 && operand_equal_p (varx, vary, 0))
731 /* Special case VARX == VARY -- we just need to compare the
732 offsets. The matters are a bit more complicated in the
733 case addition of offsets may wrap. */
734 bound_difference_of_offsetted_base (type, offx, offy, bnds);
736 else
738 /* Otherwise, use the value ranges to determine the initial
739 estimates on below and up. */
740 mpz_init (minx);
741 mpz_init (maxx);
742 mpz_init (miny);
743 mpz_init (maxy);
744 determine_value_range (loop, type, varx, offx, minx, maxx);
745 determine_value_range (loop, type, vary, offy, miny, maxy);
747 mpz_sub (bnds->below, minx, maxy);
748 mpz_sub (bnds->up, maxx, miny);
749 mpz_clear (minx);
750 mpz_clear (maxx);
751 mpz_clear (miny);
752 mpz_clear (maxy);
755 /* If both X and Y are constants, we cannot get any more precise. */
756 if (integer_zerop (varx) && integer_zerop (vary))
757 goto end;
759 /* Now walk the dominators of the loop header and use the entry
760 guards to refine the estimates. */
761 for (bb = loop->header;
762 bb != ENTRY_BLOCK_PTR_FOR_FN (cfun) && cnt < MAX_DOMINATORS_TO_WALK;
763 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
765 if (!single_pred_p (bb))
766 continue;
767 e = single_pred_edge (bb);
769 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
770 continue;
772 cond = last_stmt (e->src);
773 c0 = gimple_cond_lhs (cond);
774 cmp = gimple_cond_code (cond);
775 c1 = gimple_cond_rhs (cond);
777 if (e->flags & EDGE_FALSE_VALUE)
778 cmp = invert_tree_comparison (cmp, false);
780 refine_bounds_using_guard (type, varx, offx, vary, offy,
781 c0, cmp, c1, bnds);
782 ++cnt;
785 end:
786 mpz_clear (offx);
787 mpz_clear (offy);
790 /* Update the bounds in BNDS that restrict the value of X to the bounds
791 that restrict the value of X + DELTA. X can be obtained as a
792 difference of two values in TYPE. */
794 static void
795 bounds_add (bounds *bnds, const widest_int &delta, tree type)
797 mpz_t mdelta, max;
799 mpz_init (mdelta);
800 wi::to_mpz (delta, mdelta, SIGNED);
802 mpz_init (max);
803 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), max, UNSIGNED);
805 mpz_add (bnds->up, bnds->up, mdelta);
806 mpz_add (bnds->below, bnds->below, mdelta);
808 if (mpz_cmp (bnds->up, max) > 0)
809 mpz_set (bnds->up, max);
811 mpz_neg (max, max);
812 if (mpz_cmp (bnds->below, max) < 0)
813 mpz_set (bnds->below, max);
815 mpz_clear (mdelta);
816 mpz_clear (max);
819 /* Update the bounds in BNDS that restrict the value of X to the bounds
820 that restrict the value of -X. */
822 static void
823 bounds_negate (bounds *bnds)
825 mpz_t tmp;
827 mpz_init_set (tmp, bnds->up);
828 mpz_neg (bnds->up, bnds->below);
829 mpz_neg (bnds->below, tmp);
830 mpz_clear (tmp);
833 /* Returns inverse of X modulo 2^s, where MASK = 2^s-1. */
835 static tree
836 inverse (tree x, tree mask)
838 tree type = TREE_TYPE (x);
839 tree rslt;
840 unsigned ctr = tree_floor_log2 (mask);
842 if (TYPE_PRECISION (type) <= HOST_BITS_PER_WIDE_INT)
844 unsigned HOST_WIDE_INT ix;
845 unsigned HOST_WIDE_INT imask;
846 unsigned HOST_WIDE_INT irslt = 1;
848 gcc_assert (cst_and_fits_in_hwi (x));
849 gcc_assert (cst_and_fits_in_hwi (mask));
851 ix = int_cst_value (x);
852 imask = int_cst_value (mask);
854 for (; ctr; ctr--)
856 irslt *= ix;
857 ix *= ix;
859 irslt &= imask;
861 rslt = build_int_cst_type (type, irslt);
863 else
865 rslt = build_int_cst (type, 1);
866 for (; ctr; ctr--)
868 rslt = int_const_binop (MULT_EXPR, rslt, x);
869 x = int_const_binop (MULT_EXPR, x, x);
871 rslt = int_const_binop (BIT_AND_EXPR, rslt, mask);
874 return rslt;
877 /* Derives the upper bound BND on the number of executions of loop with exit
878 condition S * i <> C. If NO_OVERFLOW is true, then the control variable of
879 the loop does not overflow. EXIT_MUST_BE_TAKEN is true if we are guaranteed
880 that the loop ends through this exit, i.e., the induction variable ever
881 reaches the value of C.
883 The value C is equal to final - base, where final and base are the final and
884 initial value of the actual induction variable in the analysed loop. BNDS
885 bounds the value of this difference when computed in signed type with
886 unbounded range, while the computation of C is performed in an unsigned
887 type with the range matching the range of the type of the induction variable.
888 In particular, BNDS.up contains an upper bound on C in the following cases:
889 -- if the iv must reach its final value without overflow, i.e., if
890 NO_OVERFLOW && EXIT_MUST_BE_TAKEN is true, or
891 -- if final >= base, which we know to hold when BNDS.below >= 0. */
893 static void
894 number_of_iterations_ne_max (mpz_t bnd, bool no_overflow, tree c, tree s,
895 bounds *bnds, bool exit_must_be_taken)
897 widest_int max;
898 mpz_t d;
899 tree type = TREE_TYPE (c);
900 bool bnds_u_valid = ((no_overflow && exit_must_be_taken)
901 || mpz_sgn (bnds->below) >= 0);
903 if (integer_onep (s)
904 || (TREE_CODE (c) == INTEGER_CST
905 && TREE_CODE (s) == INTEGER_CST
906 && wi::mod_trunc (wi::to_wide (c), wi::to_wide (s),
907 TYPE_SIGN (type)) == 0)
908 || (TYPE_OVERFLOW_UNDEFINED (type)
909 && multiple_of_p (type, c, s)))
911 /* If C is an exact multiple of S, then its value will be reached before
912 the induction variable overflows (unless the loop is exited in some
913 other way before). Note that the actual induction variable in the
914 loop (which ranges from base to final instead of from 0 to C) may
915 overflow, in which case BNDS.up will not be giving a correct upper
916 bound on C; thus, BNDS_U_VALID had to be computed in advance. */
917 no_overflow = true;
918 exit_must_be_taken = true;
921 /* If the induction variable can overflow, the number of iterations is at
922 most the period of the control variable (or infinite, but in that case
923 the whole # of iterations analysis will fail). */
924 if (!no_overflow)
926 max = wi::mask <widest_int> (TYPE_PRECISION (type)
927 - wi::ctz (wi::to_wide (s)), false);
928 wi::to_mpz (max, bnd, UNSIGNED);
929 return;
932 /* Now we know that the induction variable does not overflow, so the loop
933 iterates at most (range of type / S) times. */
934 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), bnd, UNSIGNED);
936 /* If the induction variable is guaranteed to reach the value of C before
937 overflow, ... */
938 if (exit_must_be_taken)
940 /* ... then we can strengthen this to C / S, and possibly we can use
941 the upper bound on C given by BNDS. */
942 if (TREE_CODE (c) == INTEGER_CST)
943 wi::to_mpz (wi::to_wide (c), bnd, UNSIGNED);
944 else if (bnds_u_valid)
945 mpz_set (bnd, bnds->up);
948 mpz_init (d);
949 wi::to_mpz (wi::to_wide (s), d, UNSIGNED);
950 mpz_fdiv_q (bnd, bnd, d);
951 mpz_clear (d);
954 /* Determines number of iterations of loop whose ending condition
955 is IV <> FINAL. TYPE is the type of the iv. The number of
956 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
957 we know that the exit must be taken eventually, i.e., that the IV
958 ever reaches the value FINAL (we derived this earlier, and possibly set
959 NITER->assumptions to make sure this is the case). BNDS contains the
960 bounds on the difference FINAL - IV->base. */
962 static bool
963 number_of_iterations_ne (struct loop *loop, tree type, affine_iv *iv,
964 tree final, struct tree_niter_desc *niter,
965 bool exit_must_be_taken, bounds *bnds)
967 tree niter_type = unsigned_type_for (type);
968 tree s, c, d, bits, assumption, tmp, bound;
969 mpz_t max;
971 niter->control = *iv;
972 niter->bound = final;
973 niter->cmp = NE_EXPR;
975 /* Rearrange the terms so that we get inequality S * i <> C, with S
976 positive. Also cast everything to the unsigned type. If IV does
977 not overflow, BNDS bounds the value of C. Also, this is the
978 case if the computation |FINAL - IV->base| does not overflow, i.e.,
979 if BNDS->below in the result is nonnegative. */
980 if (tree_int_cst_sign_bit (iv->step))
982 s = fold_convert (niter_type,
983 fold_build1 (NEGATE_EXPR, type, iv->step));
984 c = fold_build2 (MINUS_EXPR, niter_type,
985 fold_convert (niter_type, iv->base),
986 fold_convert (niter_type, final));
987 bounds_negate (bnds);
989 else
991 s = fold_convert (niter_type, iv->step);
992 c = fold_build2 (MINUS_EXPR, niter_type,
993 fold_convert (niter_type, final),
994 fold_convert (niter_type, iv->base));
997 mpz_init (max);
998 number_of_iterations_ne_max (max, iv->no_overflow, c, s, bnds,
999 exit_must_be_taken);
1000 niter->max = widest_int::from (wi::from_mpz (niter_type, max, false),
1001 TYPE_SIGN (niter_type));
1002 mpz_clear (max);
1004 /* Compute no-overflow information for the control iv. This can be
1005 proven when below two conditions are satisfied:
1007 1) IV evaluates toward FINAL at beginning, i.e:
1008 base <= FINAL ; step > 0
1009 base >= FINAL ; step < 0
1011 2) |FINAL - base| is an exact multiple of step.
1013 Unfortunately, it's hard to prove above conditions after pass loop-ch
1014 because loop with exit condition (IV != FINAL) usually will be guarded
1015 by initial-condition (IV.base - IV.step != FINAL). In this case, we
1016 can alternatively try to prove below conditions:
1018 1') IV evaluates toward FINAL at beginning, i.e:
1019 new_base = base - step < FINAL ; step > 0
1020 && base - step doesn't underflow
1021 new_base = base - step > FINAL ; step < 0
1022 && base - step doesn't overflow
1024 2') |FINAL - new_base| is an exact multiple of step.
1026 Please refer to PR34114 as an example of loop-ch's impact, also refer
1027 to PR72817 as an example why condition 2') is necessary.
1029 Note, for NE_EXPR, base equals to FINAL is a special case, in
1030 which the loop exits immediately, and the iv does not overflow. */
1031 if (!niter->control.no_overflow
1032 && (integer_onep (s) || multiple_of_p (type, c, s)))
1034 tree t, cond, new_c, relaxed_cond = boolean_false_node;
1036 if (tree_int_cst_sign_bit (iv->step))
1038 cond = fold_build2 (GE_EXPR, boolean_type_node, iv->base, final);
1039 if (TREE_CODE (type) == INTEGER_TYPE)
1041 /* Only when base - step doesn't overflow. */
1042 t = TYPE_MAX_VALUE (type);
1043 t = fold_build2 (PLUS_EXPR, type, t, iv->step);
1044 t = fold_build2 (GE_EXPR, boolean_type_node, t, iv->base);
1045 if (integer_nonzerop (t))
1047 t = fold_build2 (MINUS_EXPR, type, iv->base, iv->step);
1048 new_c = fold_build2 (MINUS_EXPR, niter_type,
1049 fold_convert (niter_type, t),
1050 fold_convert (niter_type, final));
1051 if (multiple_of_p (type, new_c, s))
1052 relaxed_cond = fold_build2 (GT_EXPR, boolean_type_node,
1053 t, final);
1057 else
1059 cond = fold_build2 (LE_EXPR, boolean_type_node, iv->base, final);
1060 if (TREE_CODE (type) == INTEGER_TYPE)
1062 /* Only when base - step doesn't underflow. */
1063 t = TYPE_MIN_VALUE (type);
1064 t = fold_build2 (PLUS_EXPR, type, t, iv->step);
1065 t = fold_build2 (LE_EXPR, boolean_type_node, t, iv->base);
1066 if (integer_nonzerop (t))
1068 t = fold_build2 (MINUS_EXPR, type, iv->base, iv->step);
1069 new_c = fold_build2 (MINUS_EXPR, niter_type,
1070 fold_convert (niter_type, final),
1071 fold_convert (niter_type, t));
1072 if (multiple_of_p (type, new_c, s))
1073 relaxed_cond = fold_build2 (LT_EXPR, boolean_type_node,
1074 t, final);
1079 t = simplify_using_initial_conditions (loop, cond);
1080 if (!t || !integer_onep (t))
1081 t = simplify_using_initial_conditions (loop, relaxed_cond);
1083 if (t && integer_onep (t))
1084 niter->control.no_overflow = true;
1087 /* First the trivial cases -- when the step is 1. */
1088 if (integer_onep (s))
1090 niter->niter = c;
1091 return true;
1093 if (niter->control.no_overflow && multiple_of_p (type, c, s))
1095 niter->niter = fold_build2 (FLOOR_DIV_EXPR, niter_type, c, s);
1096 return true;
1099 /* Let nsd (step, size of mode) = d. If d does not divide c, the loop
1100 is infinite. Otherwise, the number of iterations is
1101 (inverse(s/d) * (c/d)) mod (size of mode/d). */
1102 bits = num_ending_zeros (s);
1103 bound = build_low_bits_mask (niter_type,
1104 (TYPE_PRECISION (niter_type)
1105 - tree_to_uhwi (bits)));
1107 d = fold_binary_to_constant (LSHIFT_EXPR, niter_type,
1108 build_int_cst (niter_type, 1), bits);
1109 s = fold_binary_to_constant (RSHIFT_EXPR, niter_type, s, bits);
1111 if (!exit_must_be_taken)
1113 /* If we cannot assume that the exit is taken eventually, record the
1114 assumptions for divisibility of c. */
1115 assumption = fold_build2 (FLOOR_MOD_EXPR, niter_type, c, d);
1116 assumption = fold_build2 (EQ_EXPR, boolean_type_node,
1117 assumption, build_int_cst (niter_type, 0));
1118 if (!integer_nonzerop (assumption))
1119 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1120 niter->assumptions, assumption);
1123 c = fold_build2 (EXACT_DIV_EXPR, niter_type, c, d);
1124 tmp = fold_build2 (MULT_EXPR, niter_type, c, inverse (s, bound));
1125 niter->niter = fold_build2 (BIT_AND_EXPR, niter_type, tmp, bound);
1126 return true;
1129 /* Checks whether we can determine the final value of the control variable
1130 of the loop with ending condition IV0 < IV1 (computed in TYPE).
1131 DELTA is the difference IV1->base - IV0->base, STEP is the absolute value
1132 of the step. The assumptions necessary to ensure that the computation
1133 of the final value does not overflow are recorded in NITER. If we
1134 find the final value, we adjust DELTA and return TRUE. Otherwise
1135 we return false. BNDS bounds the value of IV1->base - IV0->base,
1136 and will be updated by the same amount as DELTA. EXIT_MUST_BE_TAKEN is
1137 true if we know that the exit must be taken eventually. */
1139 static bool
1140 number_of_iterations_lt_to_ne (tree type, affine_iv *iv0, affine_iv *iv1,
1141 struct tree_niter_desc *niter,
1142 tree *delta, tree step,
1143 bool exit_must_be_taken, bounds *bnds)
1145 tree niter_type = TREE_TYPE (step);
1146 tree mod = fold_build2 (FLOOR_MOD_EXPR, niter_type, *delta, step);
1147 tree tmod;
1148 mpz_t mmod;
1149 tree assumption = boolean_true_node, bound, noloop;
1150 bool ret = false, fv_comp_no_overflow;
1151 tree type1 = type;
1152 if (POINTER_TYPE_P (type))
1153 type1 = sizetype;
1155 if (TREE_CODE (mod) != INTEGER_CST)
1156 return false;
1157 if (integer_nonzerop (mod))
1158 mod = fold_build2 (MINUS_EXPR, niter_type, step, mod);
1159 tmod = fold_convert (type1, mod);
1161 mpz_init (mmod);
1162 wi::to_mpz (wi::to_wide (mod), mmod, UNSIGNED);
1163 mpz_neg (mmod, mmod);
1165 /* If the induction variable does not overflow and the exit is taken,
1166 then the computation of the final value does not overflow. This is
1167 also obviously the case if the new final value is equal to the
1168 current one. Finally, we postulate this for pointer type variables,
1169 as the code cannot rely on the object to that the pointer points being
1170 placed at the end of the address space (and more pragmatically,
1171 TYPE_{MIN,MAX}_VALUE is not defined for pointers). */
1172 if (integer_zerop (mod) || POINTER_TYPE_P (type))
1173 fv_comp_no_overflow = true;
1174 else if (!exit_must_be_taken)
1175 fv_comp_no_overflow = false;
1176 else
1177 fv_comp_no_overflow =
1178 (iv0->no_overflow && integer_nonzerop (iv0->step))
1179 || (iv1->no_overflow && integer_nonzerop (iv1->step));
1181 if (integer_nonzerop (iv0->step))
1183 /* The final value of the iv is iv1->base + MOD, assuming that this
1184 computation does not overflow, and that
1185 iv0->base <= iv1->base + MOD. */
1186 if (!fv_comp_no_overflow)
1188 bound = fold_build2 (MINUS_EXPR, type1,
1189 TYPE_MAX_VALUE (type1), tmod);
1190 assumption = fold_build2 (LE_EXPR, boolean_type_node,
1191 iv1->base, bound);
1192 if (integer_zerop (assumption))
1193 goto end;
1195 if (mpz_cmp (mmod, bnds->below) < 0)
1196 noloop = boolean_false_node;
1197 else if (POINTER_TYPE_P (type))
1198 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1199 iv0->base,
1200 fold_build_pointer_plus (iv1->base, tmod));
1201 else
1202 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1203 iv0->base,
1204 fold_build2 (PLUS_EXPR, type1,
1205 iv1->base, tmod));
1207 else
1209 /* The final value of the iv is iv0->base - MOD, assuming that this
1210 computation does not overflow, and that
1211 iv0->base - MOD <= iv1->base. */
1212 if (!fv_comp_no_overflow)
1214 bound = fold_build2 (PLUS_EXPR, type1,
1215 TYPE_MIN_VALUE (type1), tmod);
1216 assumption = fold_build2 (GE_EXPR, boolean_type_node,
1217 iv0->base, bound);
1218 if (integer_zerop (assumption))
1219 goto end;
1221 if (mpz_cmp (mmod, bnds->below) < 0)
1222 noloop = boolean_false_node;
1223 else if (POINTER_TYPE_P (type))
1224 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1225 fold_build_pointer_plus (iv0->base,
1226 fold_build1 (NEGATE_EXPR,
1227 type1, tmod)),
1228 iv1->base);
1229 else
1230 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1231 fold_build2 (MINUS_EXPR, type1,
1232 iv0->base, tmod),
1233 iv1->base);
1236 if (!integer_nonzerop (assumption))
1237 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1238 niter->assumptions,
1239 assumption);
1240 if (!integer_zerop (noloop))
1241 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
1242 niter->may_be_zero,
1243 noloop);
1244 bounds_add (bnds, wi::to_widest (mod), type);
1245 *delta = fold_build2 (PLUS_EXPR, niter_type, *delta, mod);
1247 ret = true;
1248 end:
1249 mpz_clear (mmod);
1250 return ret;
1253 /* Add assertions to NITER that ensure that the control variable of the loop
1254 with ending condition IV0 < IV1 does not overflow. Types of IV0 and IV1
1255 are TYPE. Returns false if we can prove that there is an overflow, true
1256 otherwise. STEP is the absolute value of the step. */
1258 static bool
1259 assert_no_overflow_lt (tree type, affine_iv *iv0, affine_iv *iv1,
1260 struct tree_niter_desc *niter, tree step)
1262 tree bound, d, assumption, diff;
1263 tree niter_type = TREE_TYPE (step);
1265 if (integer_nonzerop (iv0->step))
1267 /* for (i = iv0->base; i < iv1->base; i += iv0->step) */
1268 if (iv0->no_overflow)
1269 return true;
1271 /* If iv0->base is a constant, we can determine the last value before
1272 overflow precisely; otherwise we conservatively assume
1273 MAX - STEP + 1. */
1275 if (TREE_CODE (iv0->base) == INTEGER_CST)
1277 d = fold_build2 (MINUS_EXPR, niter_type,
1278 fold_convert (niter_type, TYPE_MAX_VALUE (type)),
1279 fold_convert (niter_type, iv0->base));
1280 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
1282 else
1283 diff = fold_build2 (MINUS_EXPR, niter_type, step,
1284 build_int_cst (niter_type, 1));
1285 bound = fold_build2 (MINUS_EXPR, type,
1286 TYPE_MAX_VALUE (type), fold_convert (type, diff));
1287 assumption = fold_build2 (LE_EXPR, boolean_type_node,
1288 iv1->base, bound);
1290 else
1292 /* for (i = iv1->base; i > iv0->base; i += iv1->step) */
1293 if (iv1->no_overflow)
1294 return true;
1296 if (TREE_CODE (iv1->base) == INTEGER_CST)
1298 d = fold_build2 (MINUS_EXPR, niter_type,
1299 fold_convert (niter_type, iv1->base),
1300 fold_convert (niter_type, TYPE_MIN_VALUE (type)));
1301 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
1303 else
1304 diff = fold_build2 (MINUS_EXPR, niter_type, step,
1305 build_int_cst (niter_type, 1));
1306 bound = fold_build2 (PLUS_EXPR, type,
1307 TYPE_MIN_VALUE (type), fold_convert (type, diff));
1308 assumption = fold_build2 (GE_EXPR, boolean_type_node,
1309 iv0->base, bound);
1312 if (integer_zerop (assumption))
1313 return false;
1314 if (!integer_nonzerop (assumption))
1315 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1316 niter->assumptions, assumption);
1318 iv0->no_overflow = true;
1319 iv1->no_overflow = true;
1320 return true;
1323 /* Add an assumption to NITER that a loop whose ending condition
1324 is IV0 < IV1 rolls. TYPE is the type of the control iv. BNDS
1325 bounds the value of IV1->base - IV0->base. */
1327 static void
1328 assert_loop_rolls_lt (tree type, affine_iv *iv0, affine_iv *iv1,
1329 struct tree_niter_desc *niter, bounds *bnds)
1331 tree assumption = boolean_true_node, bound, diff;
1332 tree mbz, mbzl, mbzr, type1;
1333 bool rolls_p, no_overflow_p;
1334 widest_int dstep;
1335 mpz_t mstep, max;
1337 /* We are going to compute the number of iterations as
1338 (iv1->base - iv0->base + step - 1) / step, computed in the unsigned
1339 variant of TYPE. This formula only works if
1341 -step + 1 <= (iv1->base - iv0->base) <= MAX - step + 1
1343 (where MAX is the maximum value of the unsigned variant of TYPE, and
1344 the computations in this formula are performed in full precision,
1345 i.e., without overflows).
1347 Usually, for loops with exit condition iv0->base + step * i < iv1->base,
1348 we have a condition of the form iv0->base - step < iv1->base before the loop,
1349 and for loops iv0->base < iv1->base - step * i the condition
1350 iv0->base < iv1->base + step, due to loop header copying, which enable us
1351 to prove the lower bound.
1353 The upper bound is more complicated. Unless the expressions for initial
1354 and final value themselves contain enough information, we usually cannot
1355 derive it from the context. */
1357 /* First check whether the answer does not follow from the bounds we gathered
1358 before. */
1359 if (integer_nonzerop (iv0->step))
1360 dstep = wi::to_widest (iv0->step);
1361 else
1363 dstep = wi::sext (wi::to_widest (iv1->step), TYPE_PRECISION (type));
1364 dstep = -dstep;
1367 mpz_init (mstep);
1368 wi::to_mpz (dstep, mstep, UNSIGNED);
1369 mpz_neg (mstep, mstep);
1370 mpz_add_ui (mstep, mstep, 1);
1372 rolls_p = mpz_cmp (mstep, bnds->below) <= 0;
1374 mpz_init (max);
1375 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), max, UNSIGNED);
1376 mpz_add (max, max, mstep);
1377 no_overflow_p = (mpz_cmp (bnds->up, max) <= 0
1378 /* For pointers, only values lying inside a single object
1379 can be compared or manipulated by pointer arithmetics.
1380 Gcc in general does not allow or handle objects larger
1381 than half of the address space, hence the upper bound
1382 is satisfied for pointers. */
1383 || POINTER_TYPE_P (type));
1384 mpz_clear (mstep);
1385 mpz_clear (max);
1387 if (rolls_p && no_overflow_p)
1388 return;
1390 type1 = type;
1391 if (POINTER_TYPE_P (type))
1392 type1 = sizetype;
1394 /* Now the hard part; we must formulate the assumption(s) as expressions, and
1395 we must be careful not to introduce overflow. */
1397 if (integer_nonzerop (iv0->step))
1399 diff = fold_build2 (MINUS_EXPR, type1,
1400 iv0->step, build_int_cst (type1, 1));
1402 /* We need to know that iv0->base >= MIN + iv0->step - 1. Since
1403 0 address never belongs to any object, we can assume this for
1404 pointers. */
1405 if (!POINTER_TYPE_P (type))
1407 bound = fold_build2 (PLUS_EXPR, type1,
1408 TYPE_MIN_VALUE (type), diff);
1409 assumption = fold_build2 (GE_EXPR, boolean_type_node,
1410 iv0->base, bound);
1413 /* And then we can compute iv0->base - diff, and compare it with
1414 iv1->base. */
1415 mbzl = fold_build2 (MINUS_EXPR, type1,
1416 fold_convert (type1, iv0->base), diff);
1417 mbzr = fold_convert (type1, iv1->base);
1419 else
1421 diff = fold_build2 (PLUS_EXPR, type1,
1422 iv1->step, build_int_cst (type1, 1));
1424 if (!POINTER_TYPE_P (type))
1426 bound = fold_build2 (PLUS_EXPR, type1,
1427 TYPE_MAX_VALUE (type), diff);
1428 assumption = fold_build2 (LE_EXPR, boolean_type_node,
1429 iv1->base, bound);
1432 mbzl = fold_convert (type1, iv0->base);
1433 mbzr = fold_build2 (MINUS_EXPR, type1,
1434 fold_convert (type1, iv1->base), diff);
1437 if (!integer_nonzerop (assumption))
1438 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1439 niter->assumptions, assumption);
1440 if (!rolls_p)
1442 mbz = fold_build2 (GT_EXPR, boolean_type_node, mbzl, mbzr);
1443 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
1444 niter->may_be_zero, mbz);
1448 /* Determines number of iterations of loop whose ending condition
1449 is IV0 < IV1. TYPE is the type of the iv. The number of
1450 iterations is stored to NITER. BNDS bounds the difference
1451 IV1->base - IV0->base. EXIT_MUST_BE_TAKEN is true if we know
1452 that the exit must be taken eventually. */
1454 static bool
1455 number_of_iterations_lt (struct loop *loop, tree type, affine_iv *iv0,
1456 affine_iv *iv1, struct tree_niter_desc *niter,
1457 bool exit_must_be_taken, bounds *bnds)
1459 tree niter_type = unsigned_type_for (type);
1460 tree delta, step, s;
1461 mpz_t mstep, tmp;
1463 if (integer_nonzerop (iv0->step))
1465 niter->control = *iv0;
1466 niter->cmp = LT_EXPR;
1467 niter->bound = iv1->base;
1469 else
1471 niter->control = *iv1;
1472 niter->cmp = GT_EXPR;
1473 niter->bound = iv0->base;
1476 delta = fold_build2 (MINUS_EXPR, niter_type,
1477 fold_convert (niter_type, iv1->base),
1478 fold_convert (niter_type, iv0->base));
1480 /* First handle the special case that the step is +-1. */
1481 if ((integer_onep (iv0->step) && integer_zerop (iv1->step))
1482 || (integer_all_onesp (iv1->step) && integer_zerop (iv0->step)))
1484 /* for (i = iv0->base; i < iv1->base; i++)
1488 for (i = iv1->base; i > iv0->base; i--).
1490 In both cases # of iterations is iv1->base - iv0->base, assuming that
1491 iv1->base >= iv0->base.
1493 First try to derive a lower bound on the value of
1494 iv1->base - iv0->base, computed in full precision. If the difference
1495 is nonnegative, we are done, otherwise we must record the
1496 condition. */
1498 if (mpz_sgn (bnds->below) < 0)
1499 niter->may_be_zero = fold_build2 (LT_EXPR, boolean_type_node,
1500 iv1->base, iv0->base);
1501 niter->niter = delta;
1502 niter->max = widest_int::from (wi::from_mpz (niter_type, bnds->up, false),
1503 TYPE_SIGN (niter_type));
1504 niter->control.no_overflow = true;
1505 return true;
1508 if (integer_nonzerop (iv0->step))
1509 step = fold_convert (niter_type, iv0->step);
1510 else
1511 step = fold_convert (niter_type,
1512 fold_build1 (NEGATE_EXPR, type, iv1->step));
1514 /* If we can determine the final value of the control iv exactly, we can
1515 transform the condition to != comparison. In particular, this will be
1516 the case if DELTA is constant. */
1517 if (number_of_iterations_lt_to_ne (type, iv0, iv1, niter, &delta, step,
1518 exit_must_be_taken, bnds))
1520 affine_iv zps;
1522 zps.base = build_int_cst (niter_type, 0);
1523 zps.step = step;
1524 /* number_of_iterations_lt_to_ne will add assumptions that ensure that
1525 zps does not overflow. */
1526 zps.no_overflow = true;
1528 return number_of_iterations_ne (loop, type, &zps,
1529 delta, niter, true, bnds);
1532 /* Make sure that the control iv does not overflow. */
1533 if (!assert_no_overflow_lt (type, iv0, iv1, niter, step))
1534 return false;
1536 /* We determine the number of iterations as (delta + step - 1) / step. For
1537 this to work, we must know that iv1->base >= iv0->base - step + 1,
1538 otherwise the loop does not roll. */
1539 assert_loop_rolls_lt (type, iv0, iv1, niter, bnds);
1541 s = fold_build2 (MINUS_EXPR, niter_type,
1542 step, build_int_cst (niter_type, 1));
1543 delta = fold_build2 (PLUS_EXPR, niter_type, delta, s);
1544 niter->niter = fold_build2 (FLOOR_DIV_EXPR, niter_type, delta, step);
1546 mpz_init (mstep);
1547 mpz_init (tmp);
1548 wi::to_mpz (wi::to_wide (step), mstep, UNSIGNED);
1549 mpz_add (tmp, bnds->up, mstep);
1550 mpz_sub_ui (tmp, tmp, 1);
1551 mpz_fdiv_q (tmp, tmp, mstep);
1552 niter->max = widest_int::from (wi::from_mpz (niter_type, tmp, false),
1553 TYPE_SIGN (niter_type));
1554 mpz_clear (mstep);
1555 mpz_clear (tmp);
1557 return true;
1560 /* Determines number of iterations of loop whose ending condition
1561 is IV0 <= IV1. TYPE is the type of the iv. The number of
1562 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
1563 we know that this condition must eventually become false (we derived this
1564 earlier, and possibly set NITER->assumptions to make sure this
1565 is the case). BNDS bounds the difference IV1->base - IV0->base. */
1567 static bool
1568 number_of_iterations_le (struct loop *loop, tree type, affine_iv *iv0,
1569 affine_iv *iv1, struct tree_niter_desc *niter,
1570 bool exit_must_be_taken, bounds *bnds)
1572 tree assumption;
1573 tree type1 = type;
1574 if (POINTER_TYPE_P (type))
1575 type1 = sizetype;
1577 /* Say that IV0 is the control variable. Then IV0 <= IV1 iff
1578 IV0 < IV1 + 1, assuming that IV1 is not equal to the greatest
1579 value of the type. This we must know anyway, since if it is
1580 equal to this value, the loop rolls forever. We do not check
1581 this condition for pointer type ivs, as the code cannot rely on
1582 the object to that the pointer points being placed at the end of
1583 the address space (and more pragmatically, TYPE_{MIN,MAX}_VALUE is
1584 not defined for pointers). */
1586 if (!exit_must_be_taken && !POINTER_TYPE_P (type))
1588 if (integer_nonzerop (iv0->step))
1589 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1590 iv1->base, TYPE_MAX_VALUE (type));
1591 else
1592 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1593 iv0->base, TYPE_MIN_VALUE (type));
1595 if (integer_zerop (assumption))
1596 return false;
1597 if (!integer_nonzerop (assumption))
1598 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1599 niter->assumptions, assumption);
1602 if (integer_nonzerop (iv0->step))
1604 if (POINTER_TYPE_P (type))
1605 iv1->base = fold_build_pointer_plus_hwi (iv1->base, 1);
1606 else
1607 iv1->base = fold_build2 (PLUS_EXPR, type1, iv1->base,
1608 build_int_cst (type1, 1));
1610 else if (POINTER_TYPE_P (type))
1611 iv0->base = fold_build_pointer_plus_hwi (iv0->base, -1);
1612 else
1613 iv0->base = fold_build2 (MINUS_EXPR, type1,
1614 iv0->base, build_int_cst (type1, 1));
1616 bounds_add (bnds, 1, type1);
1618 return number_of_iterations_lt (loop, type, iv0, iv1, niter, exit_must_be_taken,
1619 bnds);
1622 /* Dumps description of affine induction variable IV to FILE. */
1624 static void
1625 dump_affine_iv (FILE *file, affine_iv *iv)
1627 if (!integer_zerop (iv->step))
1628 fprintf (file, "[");
1630 print_generic_expr (dump_file, iv->base, TDF_SLIM);
1632 if (!integer_zerop (iv->step))
1634 fprintf (file, ", + , ");
1635 print_generic_expr (dump_file, iv->step, TDF_SLIM);
1636 fprintf (file, "]%s", iv->no_overflow ? "(no_overflow)" : "");
1640 /* Determine the number of iterations according to condition (for staying
1641 inside loop) which compares two induction variables using comparison
1642 operator CODE. The induction variable on left side of the comparison
1643 is IV0, the right-hand side is IV1. Both induction variables must have
1644 type TYPE, which must be an integer or pointer type. The steps of the
1645 ivs must be constants (or NULL_TREE, which is interpreted as constant zero).
1647 LOOP is the loop whose number of iterations we are determining.
1649 ONLY_EXIT is true if we are sure this is the only way the loop could be
1650 exited (including possibly non-returning function calls, exceptions, etc.)
1651 -- in this case we can use the information whether the control induction
1652 variables can overflow or not in a more efficient way.
1654 if EVERY_ITERATION is true, we know the test is executed on every iteration.
1656 The results (number of iterations and assumptions as described in
1657 comments at struct tree_niter_desc in tree-ssa-loop.h) are stored to NITER.
1658 Returns false if it fails to determine number of iterations, true if it
1659 was determined (possibly with some assumptions). */
1661 static bool
1662 number_of_iterations_cond (struct loop *loop,
1663 tree type, affine_iv *iv0, enum tree_code code,
1664 affine_iv *iv1, struct tree_niter_desc *niter,
1665 bool only_exit, bool every_iteration)
1667 bool exit_must_be_taken = false, ret;
1668 bounds bnds;
1670 /* If the test is not executed every iteration, wrapping may make the test
1671 to pass again.
1672 TODO: the overflow case can be still used as unreliable estimate of upper
1673 bound. But we have no API to pass it down to number of iterations code
1674 and, at present, it will not use it anyway. */
1675 if (!every_iteration
1676 && (!iv0->no_overflow || !iv1->no_overflow
1677 || code == NE_EXPR || code == EQ_EXPR))
1678 return false;
1680 /* The meaning of these assumptions is this:
1681 if !assumptions
1682 then the rest of information does not have to be valid
1683 if may_be_zero then the loop does not roll, even if
1684 niter != 0. */
1685 niter->assumptions = boolean_true_node;
1686 niter->may_be_zero = boolean_false_node;
1687 niter->niter = NULL_TREE;
1688 niter->max = 0;
1689 niter->bound = NULL_TREE;
1690 niter->cmp = ERROR_MARK;
1692 /* Make < comparison from > ones, and for NE_EXPR comparisons, ensure that
1693 the control variable is on lhs. */
1694 if (code == GE_EXPR || code == GT_EXPR
1695 || (code == NE_EXPR && integer_zerop (iv0->step)))
1697 std::swap (iv0, iv1);
1698 code = swap_tree_comparison (code);
1701 if (POINTER_TYPE_P (type))
1703 /* Comparison of pointers is undefined unless both iv0 and iv1 point
1704 to the same object. If they do, the control variable cannot wrap
1705 (as wrap around the bounds of memory will never return a pointer
1706 that would be guaranteed to point to the same object, even if we
1707 avoid undefined behavior by casting to size_t and back). */
1708 iv0->no_overflow = true;
1709 iv1->no_overflow = true;
1712 /* If the control induction variable does not overflow and the only exit
1713 from the loop is the one that we analyze, we know it must be taken
1714 eventually. */
1715 if (only_exit)
1717 if (!integer_zerop (iv0->step) && iv0->no_overflow)
1718 exit_must_be_taken = true;
1719 else if (!integer_zerop (iv1->step) && iv1->no_overflow)
1720 exit_must_be_taken = true;
1723 /* We can handle cases which neither of the sides of the comparison is
1724 invariant:
1726 {iv0.base, iv0.step} cmp_code {iv1.base, iv1.step}
1727 as if:
1728 {iv0.base, iv0.step - iv1.step} cmp_code {iv1.base, 0}
1730 provided that either below condition is satisfied:
1732 a) the test is NE_EXPR;
1733 b) iv0.step - iv1.step is integer and iv0/iv1 don't overflow.
1735 This rarely occurs in practice, but it is simple enough to manage. */
1736 if (!integer_zerop (iv0->step) && !integer_zerop (iv1->step))
1738 tree step_type = POINTER_TYPE_P (type) ? sizetype : type;
1739 tree step = fold_binary_to_constant (MINUS_EXPR, step_type,
1740 iv0->step, iv1->step);
1742 /* No need to check sign of the new step since below code takes care
1743 of this well. */
1744 if (code != NE_EXPR
1745 && (TREE_CODE (step) != INTEGER_CST
1746 || !iv0->no_overflow || !iv1->no_overflow))
1747 return false;
1749 iv0->step = step;
1750 if (!POINTER_TYPE_P (type))
1751 iv0->no_overflow = false;
1753 iv1->step = build_int_cst (step_type, 0);
1754 iv1->no_overflow = true;
1757 /* If the result of the comparison is a constant, the loop is weird. More
1758 precise handling would be possible, but the situation is not common enough
1759 to waste time on it. */
1760 if (integer_zerop (iv0->step) && integer_zerop (iv1->step))
1761 return false;
1763 /* Ignore loops of while (i-- < 10) type. */
1764 if (code != NE_EXPR)
1766 if (iv0->step && tree_int_cst_sign_bit (iv0->step))
1767 return false;
1769 if (!integer_zerop (iv1->step) && !tree_int_cst_sign_bit (iv1->step))
1770 return false;
1773 /* If the loop exits immediately, there is nothing to do. */
1774 tree tem = fold_binary (code, boolean_type_node, iv0->base, iv1->base);
1775 if (tem && integer_zerop (tem))
1777 niter->niter = build_int_cst (unsigned_type_for (type), 0);
1778 niter->max = 0;
1779 return true;
1782 /* OK, now we know we have a senseful loop. Handle several cases, depending
1783 on what comparison operator is used. */
1784 bound_difference (loop, iv1->base, iv0->base, &bnds);
1786 if (dump_file && (dump_flags & TDF_DETAILS))
1788 fprintf (dump_file,
1789 "Analyzing # of iterations of loop %d\n", loop->num);
1791 fprintf (dump_file, " exit condition ");
1792 dump_affine_iv (dump_file, iv0);
1793 fprintf (dump_file, " %s ",
1794 code == NE_EXPR ? "!="
1795 : code == LT_EXPR ? "<"
1796 : "<=");
1797 dump_affine_iv (dump_file, iv1);
1798 fprintf (dump_file, "\n");
1800 fprintf (dump_file, " bounds on difference of bases: ");
1801 mpz_out_str (dump_file, 10, bnds.below);
1802 fprintf (dump_file, " ... ");
1803 mpz_out_str (dump_file, 10, bnds.up);
1804 fprintf (dump_file, "\n");
1807 switch (code)
1809 case NE_EXPR:
1810 gcc_assert (integer_zerop (iv1->step));
1811 ret = number_of_iterations_ne (loop, type, iv0, iv1->base, niter,
1812 exit_must_be_taken, &bnds);
1813 break;
1815 case LT_EXPR:
1816 ret = number_of_iterations_lt (loop, type, iv0, iv1, niter,
1817 exit_must_be_taken, &bnds);
1818 break;
1820 case LE_EXPR:
1821 ret = number_of_iterations_le (loop, type, iv0, iv1, niter,
1822 exit_must_be_taken, &bnds);
1823 break;
1825 default:
1826 gcc_unreachable ();
1829 mpz_clear (bnds.up);
1830 mpz_clear (bnds.below);
1832 if (dump_file && (dump_flags & TDF_DETAILS))
1834 if (ret)
1836 fprintf (dump_file, " result:\n");
1837 if (!integer_nonzerop (niter->assumptions))
1839 fprintf (dump_file, " under assumptions ");
1840 print_generic_expr (dump_file, niter->assumptions, TDF_SLIM);
1841 fprintf (dump_file, "\n");
1844 if (!integer_zerop (niter->may_be_zero))
1846 fprintf (dump_file, " zero if ");
1847 print_generic_expr (dump_file, niter->may_be_zero, TDF_SLIM);
1848 fprintf (dump_file, "\n");
1851 fprintf (dump_file, " # of iterations ");
1852 print_generic_expr (dump_file, niter->niter, TDF_SLIM);
1853 fprintf (dump_file, ", bounded by ");
1854 print_decu (niter->max, dump_file);
1855 fprintf (dump_file, "\n");
1857 else
1858 fprintf (dump_file, " failed\n\n");
1860 return ret;
1863 /* Substitute NEW for OLD in EXPR and fold the result. */
1865 static tree
1866 simplify_replace_tree (tree expr, tree old, tree new_tree)
1868 unsigned i, n;
1869 tree ret = NULL_TREE, e, se;
1871 if (!expr)
1872 return NULL_TREE;
1874 /* Do not bother to replace constants. */
1875 if (CONSTANT_CLASS_P (old))
1876 return expr;
1878 if (expr == old
1879 || operand_equal_p (expr, old, 0))
1880 return unshare_expr (new_tree);
1882 if (!EXPR_P (expr))
1883 return expr;
1885 n = TREE_OPERAND_LENGTH (expr);
1886 for (i = 0; i < n; i++)
1888 e = TREE_OPERAND (expr, i);
1889 se = simplify_replace_tree (e, old, new_tree);
1890 if (e == se)
1891 continue;
1893 if (!ret)
1894 ret = copy_node (expr);
1896 TREE_OPERAND (ret, i) = se;
1899 return (ret ? fold (ret) : expr);
1902 /* Expand definitions of ssa names in EXPR as long as they are simple
1903 enough, and return the new expression. If STOP is specified, stop
1904 expanding if EXPR equals to it. */
1906 tree
1907 expand_simple_operations (tree expr, tree stop)
1909 unsigned i, n;
1910 tree ret = NULL_TREE, e, ee, e1;
1911 enum tree_code code;
1912 gimple *stmt;
1914 if (expr == NULL_TREE)
1915 return expr;
1917 if (is_gimple_min_invariant (expr))
1918 return expr;
1920 code = TREE_CODE (expr);
1921 if (IS_EXPR_CODE_CLASS (TREE_CODE_CLASS (code)))
1923 n = TREE_OPERAND_LENGTH (expr);
1924 for (i = 0; i < n; i++)
1926 e = TREE_OPERAND (expr, i);
1927 ee = expand_simple_operations (e, stop);
1928 if (e == ee)
1929 continue;
1931 if (!ret)
1932 ret = copy_node (expr);
1934 TREE_OPERAND (ret, i) = ee;
1937 if (!ret)
1938 return expr;
1940 fold_defer_overflow_warnings ();
1941 ret = fold (ret);
1942 fold_undefer_and_ignore_overflow_warnings ();
1943 return ret;
1946 /* Stop if it's not ssa name or the one we don't want to expand. */
1947 if (TREE_CODE (expr) != SSA_NAME || expr == stop)
1948 return expr;
1950 stmt = SSA_NAME_DEF_STMT (expr);
1951 if (gimple_code (stmt) == GIMPLE_PHI)
1953 basic_block src, dest;
1955 if (gimple_phi_num_args (stmt) != 1)
1956 return expr;
1957 e = PHI_ARG_DEF (stmt, 0);
1959 /* Avoid propagating through loop exit phi nodes, which
1960 could break loop-closed SSA form restrictions. */
1961 dest = gimple_bb (stmt);
1962 src = single_pred (dest);
1963 if (TREE_CODE (e) == SSA_NAME
1964 && src->loop_father != dest->loop_father)
1965 return expr;
1967 return expand_simple_operations (e, stop);
1969 if (gimple_code (stmt) != GIMPLE_ASSIGN)
1970 return expr;
1972 /* Avoid expanding to expressions that contain SSA names that need
1973 to take part in abnormal coalescing. */
1974 ssa_op_iter iter;
1975 FOR_EACH_SSA_TREE_OPERAND (e, stmt, iter, SSA_OP_USE)
1976 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (e))
1977 return expr;
1979 e = gimple_assign_rhs1 (stmt);
1980 code = gimple_assign_rhs_code (stmt);
1981 if (get_gimple_rhs_class (code) == GIMPLE_SINGLE_RHS)
1983 if (is_gimple_min_invariant (e))
1984 return e;
1986 if (code == SSA_NAME)
1987 return expand_simple_operations (e, stop);
1988 else if (code == ADDR_EXPR)
1990 HOST_WIDE_INT offset;
1991 tree base = get_addr_base_and_unit_offset (TREE_OPERAND (e, 0),
1992 &offset);
1993 if (base
1994 && TREE_CODE (base) == MEM_REF)
1996 ee = expand_simple_operations (TREE_OPERAND (base, 0), stop);
1997 return fold_build2 (POINTER_PLUS_EXPR, TREE_TYPE (expr), ee,
1998 wide_int_to_tree (sizetype,
1999 mem_ref_offset (base)
2000 + offset));
2004 return expr;
2007 switch (code)
2009 CASE_CONVERT:
2010 /* Casts are simple. */
2011 ee = expand_simple_operations (e, stop);
2012 return fold_build1 (code, TREE_TYPE (expr), ee);
2014 case PLUS_EXPR:
2015 case MINUS_EXPR:
2016 if (ANY_INTEGRAL_TYPE_P (TREE_TYPE (expr))
2017 && TYPE_OVERFLOW_TRAPS (TREE_TYPE (expr)))
2018 return expr;
2019 /* Fallthru. */
2020 case POINTER_PLUS_EXPR:
2021 /* And increments and decrements by a constant are simple. */
2022 e1 = gimple_assign_rhs2 (stmt);
2023 if (!is_gimple_min_invariant (e1))
2024 return expr;
2026 ee = expand_simple_operations (e, stop);
2027 return fold_build2 (code, TREE_TYPE (expr), ee, e1);
2029 default:
2030 return expr;
2034 /* Tries to simplify EXPR using the condition COND. Returns the simplified
2035 expression (or EXPR unchanged, if no simplification was possible). */
2037 static tree
2038 tree_simplify_using_condition_1 (tree cond, tree expr)
2040 bool changed;
2041 tree e, e0, e1, e2, notcond;
2042 enum tree_code code = TREE_CODE (expr);
2044 if (code == INTEGER_CST)
2045 return expr;
2047 if (code == TRUTH_OR_EXPR
2048 || code == TRUTH_AND_EXPR
2049 || code == COND_EXPR)
2051 changed = false;
2053 e0 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 0));
2054 if (TREE_OPERAND (expr, 0) != e0)
2055 changed = true;
2057 e1 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 1));
2058 if (TREE_OPERAND (expr, 1) != e1)
2059 changed = true;
2061 if (code == COND_EXPR)
2063 e2 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 2));
2064 if (TREE_OPERAND (expr, 2) != e2)
2065 changed = true;
2067 else
2068 e2 = NULL_TREE;
2070 if (changed)
2072 if (code == COND_EXPR)
2073 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
2074 else
2075 expr = fold_build2 (code, boolean_type_node, e0, e1);
2078 return expr;
2081 /* In case COND is equality, we may be able to simplify EXPR by copy/constant
2082 propagation, and vice versa. Fold does not handle this, since it is
2083 considered too expensive. */
2084 if (TREE_CODE (cond) == EQ_EXPR)
2086 e0 = TREE_OPERAND (cond, 0);
2087 e1 = TREE_OPERAND (cond, 1);
2089 /* We know that e0 == e1. Check whether we cannot simplify expr
2090 using this fact. */
2091 e = simplify_replace_tree (expr, e0, e1);
2092 if (integer_zerop (e) || integer_nonzerop (e))
2093 return e;
2095 e = simplify_replace_tree (expr, e1, e0);
2096 if (integer_zerop (e) || integer_nonzerop (e))
2097 return e;
2099 if (TREE_CODE (expr) == EQ_EXPR)
2101 e0 = TREE_OPERAND (expr, 0);
2102 e1 = TREE_OPERAND (expr, 1);
2104 /* If e0 == e1 (EXPR) implies !COND, then EXPR cannot be true. */
2105 e = simplify_replace_tree (cond, e0, e1);
2106 if (integer_zerop (e))
2107 return e;
2108 e = simplify_replace_tree (cond, e1, e0);
2109 if (integer_zerop (e))
2110 return e;
2112 if (TREE_CODE (expr) == NE_EXPR)
2114 e0 = TREE_OPERAND (expr, 0);
2115 e1 = TREE_OPERAND (expr, 1);
2117 /* If e0 == e1 (!EXPR) implies !COND, then EXPR must be true. */
2118 e = simplify_replace_tree (cond, e0, e1);
2119 if (integer_zerop (e))
2120 return boolean_true_node;
2121 e = simplify_replace_tree (cond, e1, e0);
2122 if (integer_zerop (e))
2123 return boolean_true_node;
2126 /* Check whether COND ==> EXPR. */
2127 notcond = invert_truthvalue (cond);
2128 e = fold_binary (TRUTH_OR_EXPR, boolean_type_node, notcond, expr);
2129 if (e && integer_nonzerop (e))
2130 return e;
2132 /* Check whether COND ==> not EXPR. */
2133 e = fold_binary (TRUTH_AND_EXPR, boolean_type_node, cond, expr);
2134 if (e && integer_zerop (e))
2135 return e;
2137 return expr;
2140 /* Tries to simplify EXPR using the condition COND. Returns the simplified
2141 expression (or EXPR unchanged, if no simplification was possible).
2142 Wrapper around tree_simplify_using_condition_1 that ensures that chains
2143 of simple operations in definitions of ssa names in COND are expanded,
2144 so that things like casts or incrementing the value of the bound before
2145 the loop do not cause us to fail. */
2147 static tree
2148 tree_simplify_using_condition (tree cond, tree expr)
2150 cond = expand_simple_operations (cond);
2152 return tree_simplify_using_condition_1 (cond, expr);
2155 /* Tries to simplify EXPR using the conditions on entry to LOOP.
2156 Returns the simplified expression (or EXPR unchanged, if no
2157 simplification was possible). */
2159 tree
2160 simplify_using_initial_conditions (struct loop *loop, tree expr)
2162 edge e;
2163 basic_block bb;
2164 gimple *stmt;
2165 tree cond, expanded, backup;
2166 int cnt = 0;
2168 if (TREE_CODE (expr) == INTEGER_CST)
2169 return expr;
2171 backup = expanded = expand_simple_operations (expr);
2173 /* Limit walking the dominators to avoid quadraticness in
2174 the number of BBs times the number of loops in degenerate
2175 cases. */
2176 for (bb = loop->header;
2177 bb != ENTRY_BLOCK_PTR_FOR_FN (cfun) && cnt < MAX_DOMINATORS_TO_WALK;
2178 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
2180 if (!single_pred_p (bb))
2181 continue;
2182 e = single_pred_edge (bb);
2184 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
2185 continue;
2187 stmt = last_stmt (e->src);
2188 cond = fold_build2 (gimple_cond_code (stmt),
2189 boolean_type_node,
2190 gimple_cond_lhs (stmt),
2191 gimple_cond_rhs (stmt));
2192 if (e->flags & EDGE_FALSE_VALUE)
2193 cond = invert_truthvalue (cond);
2194 expanded = tree_simplify_using_condition (cond, expanded);
2195 /* Break if EXPR is simplified to const values. */
2196 if (expanded
2197 && (integer_zerop (expanded) || integer_nonzerop (expanded)))
2198 return expanded;
2200 ++cnt;
2203 /* Return the original expression if no simplification is done. */
2204 return operand_equal_p (backup, expanded, 0) ? expr : expanded;
2207 /* Tries to simplify EXPR using the evolutions of the loop invariants
2208 in the superloops of LOOP. Returns the simplified expression
2209 (or EXPR unchanged, if no simplification was possible). */
2211 static tree
2212 simplify_using_outer_evolutions (struct loop *loop, tree expr)
2214 enum tree_code code = TREE_CODE (expr);
2215 bool changed;
2216 tree e, e0, e1, e2;
2218 if (is_gimple_min_invariant (expr))
2219 return expr;
2221 if (code == TRUTH_OR_EXPR
2222 || code == TRUTH_AND_EXPR
2223 || code == COND_EXPR)
2225 changed = false;
2227 e0 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 0));
2228 if (TREE_OPERAND (expr, 0) != e0)
2229 changed = true;
2231 e1 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 1));
2232 if (TREE_OPERAND (expr, 1) != e1)
2233 changed = true;
2235 if (code == COND_EXPR)
2237 e2 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 2));
2238 if (TREE_OPERAND (expr, 2) != e2)
2239 changed = true;
2241 else
2242 e2 = NULL_TREE;
2244 if (changed)
2246 if (code == COND_EXPR)
2247 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
2248 else
2249 expr = fold_build2 (code, boolean_type_node, e0, e1);
2252 return expr;
2255 e = instantiate_parameters (loop, expr);
2256 if (is_gimple_min_invariant (e))
2257 return e;
2259 return expr;
2262 /* Returns true if EXIT is the only possible exit from LOOP. */
2264 bool
2265 loop_only_exit_p (const struct loop *loop, const_edge exit)
2267 basic_block *body;
2268 gimple_stmt_iterator bsi;
2269 unsigned i;
2271 if (exit != single_exit (loop))
2272 return false;
2274 body = get_loop_body (loop);
2275 for (i = 0; i < loop->num_nodes; i++)
2277 for (bsi = gsi_start_bb (body[i]); !gsi_end_p (bsi); gsi_next (&bsi))
2278 if (stmt_can_terminate_bb_p (gsi_stmt (bsi)))
2280 free (body);
2281 return true;
2285 free (body);
2286 return true;
2289 /* Stores description of number of iterations of LOOP derived from
2290 EXIT (an exit edge of the LOOP) in NITER. Returns true if some useful
2291 information could be derived (and fields of NITER have meaning described
2292 in comments at struct tree_niter_desc declaration), false otherwise.
2293 When EVERY_ITERATION is true, only tests that are known to be executed
2294 every iteration are considered (i.e. only test that alone bounds the loop).
2295 If AT_STMT is not NULL, this function stores LOOP's condition statement in
2296 it when returning true. */
2298 bool
2299 number_of_iterations_exit_assumptions (struct loop *loop, edge exit,
2300 struct tree_niter_desc *niter,
2301 gcond **at_stmt, bool every_iteration)
2303 gimple *last;
2304 gcond *stmt;
2305 tree type;
2306 tree op0, op1;
2307 enum tree_code code;
2308 affine_iv iv0, iv1;
2309 bool safe;
2311 /* Nothing to analyze if the loop is known to be infinite. */
2312 if (loop_constraint_set_p (loop, LOOP_C_INFINITE))
2313 return false;
2315 safe = dominated_by_p (CDI_DOMINATORS, loop->latch, exit->src);
2317 if (every_iteration && !safe)
2318 return false;
2320 niter->assumptions = boolean_false_node;
2321 niter->control.base = NULL_TREE;
2322 niter->control.step = NULL_TREE;
2323 niter->control.no_overflow = false;
2324 last = last_stmt (exit->src);
2325 if (!last)
2326 return false;
2327 stmt = dyn_cast <gcond *> (last);
2328 if (!stmt)
2329 return false;
2331 /* We want the condition for staying inside loop. */
2332 code = gimple_cond_code (stmt);
2333 if (exit->flags & EDGE_TRUE_VALUE)
2334 code = invert_tree_comparison (code, false);
2336 switch (code)
2338 case GT_EXPR:
2339 case GE_EXPR:
2340 case LT_EXPR:
2341 case LE_EXPR:
2342 case NE_EXPR:
2343 break;
2345 default:
2346 return false;
2349 op0 = gimple_cond_lhs (stmt);
2350 op1 = gimple_cond_rhs (stmt);
2351 type = TREE_TYPE (op0);
2353 if (TREE_CODE (type) != INTEGER_TYPE
2354 && !POINTER_TYPE_P (type))
2355 return false;
2357 tree iv0_niters = NULL_TREE;
2358 if (!simple_iv_with_niters (loop, loop_containing_stmt (stmt),
2359 op0, &iv0, &iv0_niters, false))
2360 return false;
2361 tree iv1_niters = NULL_TREE;
2362 if (!simple_iv_with_niters (loop, loop_containing_stmt (stmt),
2363 op1, &iv1, &iv1_niters, false))
2364 return false;
2365 /* Give up on complicated case. */
2366 if (iv0_niters && iv1_niters)
2367 return false;
2369 /* We don't want to see undefined signed overflow warnings while
2370 computing the number of iterations. */
2371 fold_defer_overflow_warnings ();
2373 iv0.base = expand_simple_operations (iv0.base);
2374 iv1.base = expand_simple_operations (iv1.base);
2375 if (!number_of_iterations_cond (loop, type, &iv0, code, &iv1, niter,
2376 loop_only_exit_p (loop, exit), safe))
2378 fold_undefer_and_ignore_overflow_warnings ();
2379 return false;
2382 /* Incorporate additional assumption implied by control iv. */
2383 tree iv_niters = iv0_niters ? iv0_niters : iv1_niters;
2384 if (iv_niters)
2386 tree assumption = fold_build2 (LE_EXPR, boolean_type_node, niter->niter,
2387 fold_convert (TREE_TYPE (niter->niter),
2388 iv_niters));
2390 if (!integer_nonzerop (assumption))
2391 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
2392 niter->assumptions, assumption);
2394 /* Refine upper bound if possible. */
2395 if (TREE_CODE (iv_niters) == INTEGER_CST
2396 && niter->max > wi::to_widest (iv_niters))
2397 niter->max = wi::to_widest (iv_niters);
2400 /* There is no assumptions if the loop is known to be finite. */
2401 if (!integer_zerop (niter->assumptions)
2402 && loop_constraint_set_p (loop, LOOP_C_FINITE))
2403 niter->assumptions = boolean_true_node;
2405 if (optimize >= 3)
2407 niter->assumptions = simplify_using_outer_evolutions (loop,
2408 niter->assumptions);
2409 niter->may_be_zero = simplify_using_outer_evolutions (loop,
2410 niter->may_be_zero);
2411 niter->niter = simplify_using_outer_evolutions (loop, niter->niter);
2414 niter->assumptions
2415 = simplify_using_initial_conditions (loop,
2416 niter->assumptions);
2417 niter->may_be_zero
2418 = simplify_using_initial_conditions (loop,
2419 niter->may_be_zero);
2421 fold_undefer_and_ignore_overflow_warnings ();
2423 /* If NITER has simplified into a constant, update MAX. */
2424 if (TREE_CODE (niter->niter) == INTEGER_CST)
2425 niter->max = wi::to_widest (niter->niter);
2427 if (at_stmt)
2428 *at_stmt = stmt;
2430 return (!integer_zerop (niter->assumptions));
2433 /* Like number_of_iterations_exit_assumptions, but return TRUE only if
2434 the niter information holds unconditionally. */
2436 bool
2437 number_of_iterations_exit (struct loop *loop, edge exit,
2438 struct tree_niter_desc *niter,
2439 bool warn, bool every_iteration)
2441 gcond *stmt;
2442 if (!number_of_iterations_exit_assumptions (loop, exit, niter,
2443 &stmt, every_iteration))
2444 return false;
2446 if (integer_nonzerop (niter->assumptions))
2447 return true;
2449 if (warn)
2450 dump_printf_loc (MSG_MISSED_OPTIMIZATION, gimple_location_safe (stmt),
2451 "missed loop optimization: niters analysis ends up "
2452 "with assumptions.\n");
2454 return false;
2457 /* Try to determine the number of iterations of LOOP. If we succeed,
2458 expression giving number of iterations is returned and *EXIT is
2459 set to the edge from that the information is obtained. Otherwise
2460 chrec_dont_know is returned. */
2462 tree
2463 find_loop_niter (struct loop *loop, edge *exit)
2465 unsigned i;
2466 vec<edge> exits = get_loop_exit_edges (loop);
2467 edge ex;
2468 tree niter = NULL_TREE, aniter;
2469 struct tree_niter_desc desc;
2471 *exit = NULL;
2472 FOR_EACH_VEC_ELT (exits, i, ex)
2474 if (!number_of_iterations_exit (loop, ex, &desc, false))
2475 continue;
2477 if (integer_nonzerop (desc.may_be_zero))
2479 /* We exit in the first iteration through this exit.
2480 We won't find anything better. */
2481 niter = build_int_cst (unsigned_type_node, 0);
2482 *exit = ex;
2483 break;
2486 if (!integer_zerop (desc.may_be_zero))
2487 continue;
2489 aniter = desc.niter;
2491 if (!niter)
2493 /* Nothing recorded yet. */
2494 niter = aniter;
2495 *exit = ex;
2496 continue;
2499 /* Prefer constants, the lower the better. */
2500 if (TREE_CODE (aniter) != INTEGER_CST)
2501 continue;
2503 if (TREE_CODE (niter) != INTEGER_CST)
2505 niter = aniter;
2506 *exit = ex;
2507 continue;
2510 if (tree_int_cst_lt (aniter, niter))
2512 niter = aniter;
2513 *exit = ex;
2514 continue;
2517 exits.release ();
2519 return niter ? niter : chrec_dont_know;
2522 /* Return true if loop is known to have bounded number of iterations. */
2524 bool
2525 finite_loop_p (struct loop *loop)
2527 widest_int nit;
2528 int flags;
2530 flags = flags_from_decl_or_type (current_function_decl);
2531 if ((flags & (ECF_CONST|ECF_PURE)) && !(flags & ECF_LOOPING_CONST_OR_PURE))
2533 if (dump_file && (dump_flags & TDF_DETAILS))
2534 fprintf (dump_file, "Found loop %i to be finite: it is within pure or const function.\n",
2535 loop->num);
2536 return true;
2539 if (loop->any_upper_bound
2540 || max_loop_iterations (loop, &nit))
2542 if (dump_file && (dump_flags & TDF_DETAILS))
2543 fprintf (dump_file, "Found loop %i to be finite: upper bound found.\n",
2544 loop->num);
2545 return true;
2547 return false;
2552 Analysis of a number of iterations of a loop by a brute-force evaluation.
2556 /* Bound on the number of iterations we try to evaluate. */
2558 #define MAX_ITERATIONS_TO_TRACK \
2559 ((unsigned) PARAM_VALUE (PARAM_MAX_ITERATIONS_TO_TRACK))
2561 /* Returns the loop phi node of LOOP such that ssa name X is derived from its
2562 result by a chain of operations such that all but exactly one of their
2563 operands are constants. */
2565 static gphi *
2566 chain_of_csts_start (struct loop *loop, tree x)
2568 gimple *stmt = SSA_NAME_DEF_STMT (x);
2569 tree use;
2570 basic_block bb = gimple_bb (stmt);
2571 enum tree_code code;
2573 if (!bb
2574 || !flow_bb_inside_loop_p (loop, bb))
2575 return NULL;
2577 if (gimple_code (stmt) == GIMPLE_PHI)
2579 if (bb == loop->header)
2580 return as_a <gphi *> (stmt);
2582 return NULL;
2585 if (gimple_code (stmt) != GIMPLE_ASSIGN
2586 || gimple_assign_rhs_class (stmt) == GIMPLE_TERNARY_RHS)
2587 return NULL;
2589 code = gimple_assign_rhs_code (stmt);
2590 if (gimple_references_memory_p (stmt)
2591 || TREE_CODE_CLASS (code) == tcc_reference
2592 || (code == ADDR_EXPR
2593 && !is_gimple_min_invariant (gimple_assign_rhs1 (stmt))))
2594 return NULL;
2596 use = SINGLE_SSA_TREE_OPERAND (stmt, SSA_OP_USE);
2597 if (use == NULL_TREE)
2598 return NULL;
2600 return chain_of_csts_start (loop, use);
2603 /* Determines whether the expression X is derived from a result of a phi node
2604 in header of LOOP such that
2606 * the derivation of X consists only from operations with constants
2607 * the initial value of the phi node is constant
2608 * the value of the phi node in the next iteration can be derived from the
2609 value in the current iteration by a chain of operations with constants,
2610 or is also a constant
2612 If such phi node exists, it is returned, otherwise NULL is returned. */
2614 static gphi *
2615 get_base_for (struct loop *loop, tree x)
2617 gphi *phi;
2618 tree init, next;
2620 if (is_gimple_min_invariant (x))
2621 return NULL;
2623 phi = chain_of_csts_start (loop, x);
2624 if (!phi)
2625 return NULL;
2627 init = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2628 next = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2630 if (!is_gimple_min_invariant (init))
2631 return NULL;
2633 if (TREE_CODE (next) == SSA_NAME
2634 && chain_of_csts_start (loop, next) != phi)
2635 return NULL;
2637 return phi;
2640 /* Given an expression X, then
2642 * if X is NULL_TREE, we return the constant BASE.
2643 * if X is a constant, we return the constant X.
2644 * otherwise X is a SSA name, whose value in the considered loop is derived
2645 by a chain of operations with constant from a result of a phi node in
2646 the header of the loop. Then we return value of X when the value of the
2647 result of this phi node is given by the constant BASE. */
2649 static tree
2650 get_val_for (tree x, tree base)
2652 gimple *stmt;
2654 gcc_checking_assert (is_gimple_min_invariant (base));
2656 if (!x)
2657 return base;
2658 else if (is_gimple_min_invariant (x))
2659 return x;
2661 stmt = SSA_NAME_DEF_STMT (x);
2662 if (gimple_code (stmt) == GIMPLE_PHI)
2663 return base;
2665 gcc_checking_assert (is_gimple_assign (stmt));
2667 /* STMT must be either an assignment of a single SSA name or an
2668 expression involving an SSA name and a constant. Try to fold that
2669 expression using the value for the SSA name. */
2670 if (gimple_assign_ssa_name_copy_p (stmt))
2671 return get_val_for (gimple_assign_rhs1 (stmt), base);
2672 else if (gimple_assign_rhs_class (stmt) == GIMPLE_UNARY_RHS
2673 && TREE_CODE (gimple_assign_rhs1 (stmt)) == SSA_NAME)
2674 return fold_build1 (gimple_assign_rhs_code (stmt),
2675 gimple_expr_type (stmt),
2676 get_val_for (gimple_assign_rhs1 (stmt), base));
2677 else if (gimple_assign_rhs_class (stmt) == GIMPLE_BINARY_RHS)
2679 tree rhs1 = gimple_assign_rhs1 (stmt);
2680 tree rhs2 = gimple_assign_rhs2 (stmt);
2681 if (TREE_CODE (rhs1) == SSA_NAME)
2682 rhs1 = get_val_for (rhs1, base);
2683 else if (TREE_CODE (rhs2) == SSA_NAME)
2684 rhs2 = get_val_for (rhs2, base);
2685 else
2686 gcc_unreachable ();
2687 return fold_build2 (gimple_assign_rhs_code (stmt),
2688 gimple_expr_type (stmt), rhs1, rhs2);
2690 else
2691 gcc_unreachable ();
2695 /* Tries to count the number of iterations of LOOP till it exits by EXIT
2696 by brute force -- i.e. by determining the value of the operands of the
2697 condition at EXIT in first few iterations of the loop (assuming that
2698 these values are constant) and determining the first one in that the
2699 condition is not satisfied. Returns the constant giving the number
2700 of the iterations of LOOP if successful, chrec_dont_know otherwise. */
2702 tree
2703 loop_niter_by_eval (struct loop *loop, edge exit)
2705 tree acnd;
2706 tree op[2], val[2], next[2], aval[2];
2707 gphi *phi;
2708 gimple *cond;
2709 unsigned i, j;
2710 enum tree_code cmp;
2712 cond = last_stmt (exit->src);
2713 if (!cond || gimple_code (cond) != GIMPLE_COND)
2714 return chrec_dont_know;
2716 cmp = gimple_cond_code (cond);
2717 if (exit->flags & EDGE_TRUE_VALUE)
2718 cmp = invert_tree_comparison (cmp, false);
2720 switch (cmp)
2722 case EQ_EXPR:
2723 case NE_EXPR:
2724 case GT_EXPR:
2725 case GE_EXPR:
2726 case LT_EXPR:
2727 case LE_EXPR:
2728 op[0] = gimple_cond_lhs (cond);
2729 op[1] = gimple_cond_rhs (cond);
2730 break;
2732 default:
2733 return chrec_dont_know;
2736 for (j = 0; j < 2; j++)
2738 if (is_gimple_min_invariant (op[j]))
2740 val[j] = op[j];
2741 next[j] = NULL_TREE;
2742 op[j] = NULL_TREE;
2744 else
2746 phi = get_base_for (loop, op[j]);
2747 if (!phi)
2748 return chrec_dont_know;
2749 val[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2750 next[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2754 /* Don't issue signed overflow warnings. */
2755 fold_defer_overflow_warnings ();
2757 for (i = 0; i < MAX_ITERATIONS_TO_TRACK; i++)
2759 for (j = 0; j < 2; j++)
2760 aval[j] = get_val_for (op[j], val[j]);
2762 acnd = fold_binary (cmp, boolean_type_node, aval[0], aval[1]);
2763 if (acnd && integer_zerop (acnd))
2765 fold_undefer_and_ignore_overflow_warnings ();
2766 if (dump_file && (dump_flags & TDF_DETAILS))
2767 fprintf (dump_file,
2768 "Proved that loop %d iterates %d times using brute force.\n",
2769 loop->num, i);
2770 return build_int_cst (unsigned_type_node, i);
2773 for (j = 0; j < 2; j++)
2775 aval[j] = val[j];
2776 val[j] = get_val_for (next[j], val[j]);
2777 if (!is_gimple_min_invariant (val[j]))
2779 fold_undefer_and_ignore_overflow_warnings ();
2780 return chrec_dont_know;
2784 /* If the next iteration would use the same base values
2785 as the current one, there is no point looping further,
2786 all following iterations will be the same as this one. */
2787 if (val[0] == aval[0] && val[1] == aval[1])
2788 break;
2791 fold_undefer_and_ignore_overflow_warnings ();
2793 return chrec_dont_know;
2796 /* Finds the exit of the LOOP by that the loop exits after a constant
2797 number of iterations and stores the exit edge to *EXIT. The constant
2798 giving the number of iterations of LOOP is returned. The number of
2799 iterations is determined using loop_niter_by_eval (i.e. by brute force
2800 evaluation). If we are unable to find the exit for that loop_niter_by_eval
2801 determines the number of iterations, chrec_dont_know is returned. */
2803 tree
2804 find_loop_niter_by_eval (struct loop *loop, edge *exit)
2806 unsigned i;
2807 vec<edge> exits = get_loop_exit_edges (loop);
2808 edge ex;
2809 tree niter = NULL_TREE, aniter;
2811 *exit = NULL;
2813 /* Loops with multiple exits are expensive to handle and less important. */
2814 if (!flag_expensive_optimizations
2815 && exits.length () > 1)
2817 exits.release ();
2818 return chrec_dont_know;
2821 FOR_EACH_VEC_ELT (exits, i, ex)
2823 if (!just_once_each_iteration_p (loop, ex->src))
2824 continue;
2826 aniter = loop_niter_by_eval (loop, ex);
2827 if (chrec_contains_undetermined (aniter))
2828 continue;
2830 if (niter
2831 && !tree_int_cst_lt (aniter, niter))
2832 continue;
2834 niter = aniter;
2835 *exit = ex;
2837 exits.release ();
2839 return niter ? niter : chrec_dont_know;
2844 Analysis of upper bounds on number of iterations of a loop.
2848 static widest_int derive_constant_upper_bound_ops (tree, tree,
2849 enum tree_code, tree);
2851 /* Returns a constant upper bound on the value of the right-hand side of
2852 an assignment statement STMT. */
2854 static widest_int
2855 derive_constant_upper_bound_assign (gimple *stmt)
2857 enum tree_code code = gimple_assign_rhs_code (stmt);
2858 tree op0 = gimple_assign_rhs1 (stmt);
2859 tree op1 = gimple_assign_rhs2 (stmt);
2861 return derive_constant_upper_bound_ops (TREE_TYPE (gimple_assign_lhs (stmt)),
2862 op0, code, op1);
2865 /* Returns a constant upper bound on the value of expression VAL. VAL
2866 is considered to be unsigned. If its type is signed, its value must
2867 be nonnegative. */
2869 static widest_int
2870 derive_constant_upper_bound (tree val)
2872 enum tree_code code;
2873 tree op0, op1, op2;
2875 extract_ops_from_tree (val, &code, &op0, &op1, &op2);
2876 return derive_constant_upper_bound_ops (TREE_TYPE (val), op0, code, op1);
2879 /* Returns a constant upper bound on the value of expression OP0 CODE OP1,
2880 whose type is TYPE. The expression is considered to be unsigned. If
2881 its type is signed, its value must be nonnegative. */
2883 static widest_int
2884 derive_constant_upper_bound_ops (tree type, tree op0,
2885 enum tree_code code, tree op1)
2887 tree subtype, maxt;
2888 widest_int bnd, max, cst;
2889 gimple *stmt;
2891 if (INTEGRAL_TYPE_P (type))
2892 maxt = TYPE_MAX_VALUE (type);
2893 else
2894 maxt = upper_bound_in_type (type, type);
2896 max = wi::to_widest (maxt);
2898 switch (code)
2900 case INTEGER_CST:
2901 return wi::to_widest (op0);
2903 CASE_CONVERT:
2904 subtype = TREE_TYPE (op0);
2905 if (!TYPE_UNSIGNED (subtype)
2906 /* If TYPE is also signed, the fact that VAL is nonnegative implies
2907 that OP0 is nonnegative. */
2908 && TYPE_UNSIGNED (type)
2909 && !tree_expr_nonnegative_p (op0))
2911 /* If we cannot prove that the casted expression is nonnegative,
2912 we cannot establish more useful upper bound than the precision
2913 of the type gives us. */
2914 return max;
2917 /* We now know that op0 is an nonnegative value. Try deriving an upper
2918 bound for it. */
2919 bnd = derive_constant_upper_bound (op0);
2921 /* If the bound does not fit in TYPE, max. value of TYPE could be
2922 attained. */
2923 if (wi::ltu_p (max, bnd))
2924 return max;
2926 return bnd;
2928 case PLUS_EXPR:
2929 case POINTER_PLUS_EXPR:
2930 case MINUS_EXPR:
2931 if (TREE_CODE (op1) != INTEGER_CST
2932 || !tree_expr_nonnegative_p (op0))
2933 return max;
2935 /* Canonicalize to OP0 - CST. Consider CST to be signed, in order to
2936 choose the most logical way how to treat this constant regardless
2937 of the signedness of the type. */
2938 cst = wi::sext (wi::to_widest (op1), TYPE_PRECISION (type));
2939 if (code != MINUS_EXPR)
2940 cst = -cst;
2942 bnd = derive_constant_upper_bound (op0);
2944 if (wi::neg_p (cst))
2946 cst = -cst;
2947 /* Avoid CST == 0x80000... */
2948 if (wi::neg_p (cst))
2949 return max;
2951 /* OP0 + CST. We need to check that
2952 BND <= MAX (type) - CST. */
2954 widest_int mmax = max - cst;
2955 if (wi::leu_p (bnd, mmax))
2956 return max;
2958 return bnd + cst;
2960 else
2962 /* OP0 - CST, where CST >= 0.
2964 If TYPE is signed, we have already verified that OP0 >= 0, and we
2965 know that the result is nonnegative. This implies that
2966 VAL <= BND - CST.
2968 If TYPE is unsigned, we must additionally know that OP0 >= CST,
2969 otherwise the operation underflows.
2972 /* This should only happen if the type is unsigned; however, for
2973 buggy programs that use overflowing signed arithmetics even with
2974 -fno-wrapv, this condition may also be true for signed values. */
2975 if (wi::ltu_p (bnd, cst))
2976 return max;
2978 if (TYPE_UNSIGNED (type))
2980 tree tem = fold_binary (GE_EXPR, boolean_type_node, op0,
2981 wide_int_to_tree (type, cst));
2982 if (!tem || integer_nonzerop (tem))
2983 return max;
2986 bnd -= cst;
2989 return bnd;
2991 case FLOOR_DIV_EXPR:
2992 case EXACT_DIV_EXPR:
2993 if (TREE_CODE (op1) != INTEGER_CST
2994 || tree_int_cst_sign_bit (op1))
2995 return max;
2997 bnd = derive_constant_upper_bound (op0);
2998 return wi::udiv_floor (bnd, wi::to_widest (op1));
3000 case BIT_AND_EXPR:
3001 if (TREE_CODE (op1) != INTEGER_CST
3002 || tree_int_cst_sign_bit (op1))
3003 return max;
3004 return wi::to_widest (op1);
3006 case SSA_NAME:
3007 stmt = SSA_NAME_DEF_STMT (op0);
3008 if (gimple_code (stmt) != GIMPLE_ASSIGN
3009 || gimple_assign_lhs (stmt) != op0)
3010 return max;
3011 return derive_constant_upper_bound_assign (stmt);
3013 default:
3014 return max;
3018 /* Emit a -Waggressive-loop-optimizations warning if needed. */
3020 static void
3021 do_warn_aggressive_loop_optimizations (struct loop *loop,
3022 widest_int i_bound, gimple *stmt)
3024 /* Don't warn if the loop doesn't have known constant bound. */
3025 if (!loop->nb_iterations
3026 || TREE_CODE (loop->nb_iterations) != INTEGER_CST
3027 || !warn_aggressive_loop_optimizations
3028 /* To avoid warning multiple times for the same loop,
3029 only start warning when we preserve loops. */
3030 || (cfun->curr_properties & PROP_loops) == 0
3031 /* Only warn once per loop. */
3032 || loop->warned_aggressive_loop_optimizations
3033 /* Only warn if undefined behavior gives us lower estimate than the
3034 known constant bound. */
3035 || wi::cmpu (i_bound, wi::to_widest (loop->nb_iterations)) >= 0
3036 /* And undefined behavior happens unconditionally. */
3037 || !dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (stmt)))
3038 return;
3040 edge e = single_exit (loop);
3041 if (e == NULL)
3042 return;
3044 gimple *estmt = last_stmt (e->src);
3045 char buf[WIDE_INT_PRINT_BUFFER_SIZE];
3046 print_dec (i_bound, buf, TYPE_UNSIGNED (TREE_TYPE (loop->nb_iterations))
3047 ? UNSIGNED : SIGNED);
3048 if (warning_at (gimple_location (stmt), OPT_Waggressive_loop_optimizations,
3049 "iteration %s invokes undefined behavior", buf))
3050 inform (gimple_location (estmt), "within this loop");
3051 loop->warned_aggressive_loop_optimizations = true;
3054 /* Records that AT_STMT is executed at most BOUND + 1 times in LOOP. IS_EXIT
3055 is true if the loop is exited immediately after STMT, and this exit
3056 is taken at last when the STMT is executed BOUND + 1 times.
3057 REALISTIC is true if BOUND is expected to be close to the real number
3058 of iterations. UPPER is true if we are sure the loop iterates at most
3059 BOUND times. I_BOUND is a widest_int upper estimate on BOUND. */
3061 static void
3062 record_estimate (struct loop *loop, tree bound, const widest_int &i_bound,
3063 gimple *at_stmt, bool is_exit, bool realistic, bool upper)
3065 widest_int delta;
3067 if (dump_file && (dump_flags & TDF_DETAILS))
3069 fprintf (dump_file, "Statement %s", is_exit ? "(exit)" : "");
3070 print_gimple_stmt (dump_file, at_stmt, 0, TDF_SLIM);
3071 fprintf (dump_file, " is %sexecuted at most ",
3072 upper ? "" : "probably ");
3073 print_generic_expr (dump_file, bound, TDF_SLIM);
3074 fprintf (dump_file, " (bounded by ");
3075 print_decu (i_bound, dump_file);
3076 fprintf (dump_file, ") + 1 times in loop %d.\n", loop->num);
3079 /* If the I_BOUND is just an estimate of BOUND, it rarely is close to the
3080 real number of iterations. */
3081 if (TREE_CODE (bound) != INTEGER_CST)
3082 realistic = false;
3083 else
3084 gcc_checking_assert (i_bound == wi::to_widest (bound));
3086 /* If we have a guaranteed upper bound, record it in the appropriate
3087 list, unless this is an !is_exit bound (i.e. undefined behavior in
3088 at_stmt) in a loop with known constant number of iterations. */
3089 if (upper
3090 && (is_exit
3091 || loop->nb_iterations == NULL_TREE
3092 || TREE_CODE (loop->nb_iterations) != INTEGER_CST))
3094 struct nb_iter_bound *elt = ggc_alloc<nb_iter_bound> ();
3096 elt->bound = i_bound;
3097 elt->stmt = at_stmt;
3098 elt->is_exit = is_exit;
3099 elt->next = loop->bounds;
3100 loop->bounds = elt;
3103 /* If statement is executed on every path to the loop latch, we can directly
3104 infer the upper bound on the # of iterations of the loop. */
3105 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (at_stmt)))
3106 upper = false;
3108 /* Update the number of iteration estimates according to the bound.
3109 If at_stmt is an exit then the loop latch is executed at most BOUND times,
3110 otherwise it can be executed BOUND + 1 times. We will lower the estimate
3111 later if such statement must be executed on last iteration */
3112 if (is_exit)
3113 delta = 0;
3114 else
3115 delta = 1;
3116 widest_int new_i_bound = i_bound + delta;
3118 /* If an overflow occurred, ignore the result. */
3119 if (wi::ltu_p (new_i_bound, delta))
3120 return;
3122 if (upper && !is_exit)
3123 do_warn_aggressive_loop_optimizations (loop, new_i_bound, at_stmt);
3124 record_niter_bound (loop, new_i_bound, realistic, upper);
3127 /* Records the control iv analyzed in NITER for LOOP if the iv is valid
3128 and doesn't overflow. */
3130 static void
3131 record_control_iv (struct loop *loop, struct tree_niter_desc *niter)
3133 struct control_iv *iv;
3135 if (!niter->control.base || !niter->control.step)
3136 return;
3138 if (!integer_onep (niter->assumptions) || !niter->control.no_overflow)
3139 return;
3141 iv = ggc_alloc<control_iv> ();
3142 iv->base = niter->control.base;
3143 iv->step = niter->control.step;
3144 iv->next = loop->control_ivs;
3145 loop->control_ivs = iv;
3147 return;
3150 /* This function returns TRUE if below conditions are satisfied:
3151 1) VAR is SSA variable.
3152 2) VAR is an IV:{base, step} in its defining loop.
3153 3) IV doesn't overflow.
3154 4) Both base and step are integer constants.
3155 5) Base is the MIN/MAX value depends on IS_MIN.
3156 Store value of base to INIT correspondingly. */
3158 static bool
3159 get_cst_init_from_scev (tree var, wide_int *init, bool is_min)
3161 if (TREE_CODE (var) != SSA_NAME)
3162 return false;
3164 gimple *def_stmt = SSA_NAME_DEF_STMT (var);
3165 struct loop *loop = loop_containing_stmt (def_stmt);
3167 if (loop == NULL)
3168 return false;
3170 affine_iv iv;
3171 if (!simple_iv (loop, loop, var, &iv, false))
3172 return false;
3174 if (!iv.no_overflow)
3175 return false;
3177 if (TREE_CODE (iv.base) != INTEGER_CST || TREE_CODE (iv.step) != INTEGER_CST)
3178 return false;
3180 if (is_min == tree_int_cst_sign_bit (iv.step))
3181 return false;
3183 *init = wi::to_wide (iv.base);
3184 return true;
3187 /* Record the estimate on number of iterations of LOOP based on the fact that
3188 the induction variable BASE + STEP * i evaluated in STMT does not wrap and
3189 its values belong to the range <LOW, HIGH>. REALISTIC is true if the
3190 estimated number of iterations is expected to be close to the real one.
3191 UPPER is true if we are sure the induction variable does not wrap. */
3193 static void
3194 record_nonwrapping_iv (struct loop *loop, tree base, tree step, gimple *stmt,
3195 tree low, tree high, bool realistic, bool upper)
3197 tree niter_bound, extreme, delta;
3198 tree type = TREE_TYPE (base), unsigned_type;
3199 tree orig_base = base;
3201 if (TREE_CODE (step) != INTEGER_CST || integer_zerop (step))
3202 return;
3204 if (dump_file && (dump_flags & TDF_DETAILS))
3206 fprintf (dump_file, "Induction variable (");
3207 print_generic_expr (dump_file, TREE_TYPE (base), TDF_SLIM);
3208 fprintf (dump_file, ") ");
3209 print_generic_expr (dump_file, base, TDF_SLIM);
3210 fprintf (dump_file, " + ");
3211 print_generic_expr (dump_file, step, TDF_SLIM);
3212 fprintf (dump_file, " * iteration does not wrap in statement ");
3213 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
3214 fprintf (dump_file, " in loop %d.\n", loop->num);
3217 unsigned_type = unsigned_type_for (type);
3218 base = fold_convert (unsigned_type, base);
3219 step = fold_convert (unsigned_type, step);
3221 if (tree_int_cst_sign_bit (step))
3223 wide_int min, max;
3224 extreme = fold_convert (unsigned_type, low);
3225 if (TREE_CODE (orig_base) == SSA_NAME
3226 && TREE_CODE (high) == INTEGER_CST
3227 && INTEGRAL_TYPE_P (TREE_TYPE (orig_base))
3228 && (get_range_info (orig_base, &min, &max) == VR_RANGE
3229 || get_cst_init_from_scev (orig_base, &max, false))
3230 && wi::gts_p (wi::to_wide (high), max))
3231 base = wide_int_to_tree (unsigned_type, max);
3232 else if (TREE_CODE (base) != INTEGER_CST
3233 && dominated_by_p (CDI_DOMINATORS,
3234 loop->latch, gimple_bb (stmt)))
3235 base = fold_convert (unsigned_type, high);
3236 delta = fold_build2 (MINUS_EXPR, unsigned_type, base, extreme);
3237 step = fold_build1 (NEGATE_EXPR, unsigned_type, step);
3239 else
3241 wide_int min, max;
3242 extreme = fold_convert (unsigned_type, high);
3243 if (TREE_CODE (orig_base) == SSA_NAME
3244 && TREE_CODE (low) == INTEGER_CST
3245 && INTEGRAL_TYPE_P (TREE_TYPE (orig_base))
3246 && (get_range_info (orig_base, &min, &max) == VR_RANGE
3247 || get_cst_init_from_scev (orig_base, &min, true))
3248 && wi::gts_p (min, wi::to_wide (low)))
3249 base = wide_int_to_tree (unsigned_type, min);
3250 else if (TREE_CODE (base) != INTEGER_CST
3251 && dominated_by_p (CDI_DOMINATORS,
3252 loop->latch, gimple_bb (stmt)))
3253 base = fold_convert (unsigned_type, low);
3254 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, base);
3257 /* STMT is executed at most NITER_BOUND + 1 times, since otherwise the value
3258 would get out of the range. */
3259 niter_bound = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step);
3260 widest_int max = derive_constant_upper_bound (niter_bound);
3261 record_estimate (loop, niter_bound, max, stmt, false, realistic, upper);
3264 /* Determine information about number of iterations a LOOP from the index
3265 IDX of a data reference accessed in STMT. RELIABLE is true if STMT is
3266 guaranteed to be executed in every iteration of LOOP. Callback for
3267 for_each_index. */
3269 struct ilb_data
3271 struct loop *loop;
3272 gimple *stmt;
3275 static bool
3276 idx_infer_loop_bounds (tree base, tree *idx, void *dta)
3278 struct ilb_data *data = (struct ilb_data *) dta;
3279 tree ev, init, step;
3280 tree low, high, type, next;
3281 bool sign, upper = true, at_end = false;
3282 struct loop *loop = data->loop;
3284 if (TREE_CODE (base) != ARRAY_REF)
3285 return true;
3287 /* For arrays at the end of the structure, we are not guaranteed that they
3288 do not really extend over their declared size. However, for arrays of
3289 size greater than one, this is unlikely to be intended. */
3290 if (array_at_struct_end_p (base))
3292 at_end = true;
3293 upper = false;
3296 struct loop *dloop = loop_containing_stmt (data->stmt);
3297 if (!dloop)
3298 return true;
3300 ev = analyze_scalar_evolution (dloop, *idx);
3301 ev = instantiate_parameters (loop, ev);
3302 init = initial_condition (ev);
3303 step = evolution_part_in_loop_num (ev, loop->num);
3305 if (!init
3306 || !step
3307 || TREE_CODE (step) != INTEGER_CST
3308 || integer_zerop (step)
3309 || tree_contains_chrecs (init, NULL)
3310 || chrec_contains_symbols_defined_in_loop (init, loop->num))
3311 return true;
3313 low = array_ref_low_bound (base);
3314 high = array_ref_up_bound (base);
3316 /* The case of nonconstant bounds could be handled, but it would be
3317 complicated. */
3318 if (TREE_CODE (low) != INTEGER_CST
3319 || !high
3320 || TREE_CODE (high) != INTEGER_CST)
3321 return true;
3322 sign = tree_int_cst_sign_bit (step);
3323 type = TREE_TYPE (step);
3325 /* The array of length 1 at the end of a structure most likely extends
3326 beyond its bounds. */
3327 if (at_end
3328 && operand_equal_p (low, high, 0))
3329 return true;
3331 /* In case the relevant bound of the array does not fit in type, or
3332 it does, but bound + step (in type) still belongs into the range of the
3333 array, the index may wrap and still stay within the range of the array
3334 (consider e.g. if the array is indexed by the full range of
3335 unsigned char).
3337 To make things simpler, we require both bounds to fit into type, although
3338 there are cases where this would not be strictly necessary. */
3339 if (!int_fits_type_p (high, type)
3340 || !int_fits_type_p (low, type))
3341 return true;
3342 low = fold_convert (type, low);
3343 high = fold_convert (type, high);
3345 if (sign)
3346 next = fold_binary (PLUS_EXPR, type, low, step);
3347 else
3348 next = fold_binary (PLUS_EXPR, type, high, step);
3350 if (tree_int_cst_compare (low, next) <= 0
3351 && tree_int_cst_compare (next, high) <= 0)
3352 return true;
3354 /* If access is not executed on every iteration, we must ensure that overlow
3355 may not make the access valid later. */
3356 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (data->stmt))
3357 && scev_probably_wraps_p (NULL_TREE,
3358 initial_condition_in_loop_num (ev, loop->num),
3359 step, data->stmt, loop, true))
3360 upper = false;
3362 record_nonwrapping_iv (loop, init, step, data->stmt, low, high, false, upper);
3363 return true;
3366 /* Determine information about number of iterations a LOOP from the bounds
3367 of arrays in the data reference REF accessed in STMT. RELIABLE is true if
3368 STMT is guaranteed to be executed in every iteration of LOOP.*/
3370 static void
3371 infer_loop_bounds_from_ref (struct loop *loop, gimple *stmt, tree ref)
3373 struct ilb_data data;
3375 data.loop = loop;
3376 data.stmt = stmt;
3377 for_each_index (&ref, idx_infer_loop_bounds, &data);
3380 /* Determine information about number of iterations of a LOOP from the way
3381 arrays are used in STMT. RELIABLE is true if STMT is guaranteed to be
3382 executed in every iteration of LOOP. */
3384 static void
3385 infer_loop_bounds_from_array (struct loop *loop, gimple *stmt)
3387 if (is_gimple_assign (stmt))
3389 tree op0 = gimple_assign_lhs (stmt);
3390 tree op1 = gimple_assign_rhs1 (stmt);
3392 /* For each memory access, analyze its access function
3393 and record a bound on the loop iteration domain. */
3394 if (REFERENCE_CLASS_P (op0))
3395 infer_loop_bounds_from_ref (loop, stmt, op0);
3397 if (REFERENCE_CLASS_P (op1))
3398 infer_loop_bounds_from_ref (loop, stmt, op1);
3400 else if (is_gimple_call (stmt))
3402 tree arg, lhs;
3403 unsigned i, n = gimple_call_num_args (stmt);
3405 lhs = gimple_call_lhs (stmt);
3406 if (lhs && REFERENCE_CLASS_P (lhs))
3407 infer_loop_bounds_from_ref (loop, stmt, lhs);
3409 for (i = 0; i < n; i++)
3411 arg = gimple_call_arg (stmt, i);
3412 if (REFERENCE_CLASS_P (arg))
3413 infer_loop_bounds_from_ref (loop, stmt, arg);
3418 /* Determine information about number of iterations of a LOOP from the fact
3419 that pointer arithmetics in STMT does not overflow. */
3421 static void
3422 infer_loop_bounds_from_pointer_arith (struct loop *loop, gimple *stmt)
3424 tree def, base, step, scev, type, low, high;
3425 tree var, ptr;
3427 if (!is_gimple_assign (stmt)
3428 || gimple_assign_rhs_code (stmt) != POINTER_PLUS_EXPR)
3429 return;
3431 def = gimple_assign_lhs (stmt);
3432 if (TREE_CODE (def) != SSA_NAME)
3433 return;
3435 type = TREE_TYPE (def);
3436 if (!nowrap_type_p (type))
3437 return;
3439 ptr = gimple_assign_rhs1 (stmt);
3440 if (!expr_invariant_in_loop_p (loop, ptr))
3441 return;
3443 var = gimple_assign_rhs2 (stmt);
3444 if (TYPE_PRECISION (type) != TYPE_PRECISION (TREE_TYPE (var)))
3445 return;
3447 struct loop *uloop = loop_containing_stmt (stmt);
3448 scev = instantiate_parameters (loop, analyze_scalar_evolution (uloop, def));
3449 if (chrec_contains_undetermined (scev))
3450 return;
3452 base = initial_condition_in_loop_num (scev, loop->num);
3453 step = evolution_part_in_loop_num (scev, loop->num);
3455 if (!base || !step
3456 || TREE_CODE (step) != INTEGER_CST
3457 || tree_contains_chrecs (base, NULL)
3458 || chrec_contains_symbols_defined_in_loop (base, loop->num))
3459 return;
3461 low = lower_bound_in_type (type, type);
3462 high = upper_bound_in_type (type, type);
3464 /* In C, pointer arithmetic p + 1 cannot use a NULL pointer, and p - 1 cannot
3465 produce a NULL pointer. The contrary would mean NULL points to an object,
3466 while NULL is supposed to compare unequal with the address of all objects.
3467 Furthermore, p + 1 cannot produce a NULL pointer and p - 1 cannot use a
3468 NULL pointer since that would mean wrapping, which we assume here not to
3469 happen. So, we can exclude NULL from the valid range of pointer
3470 arithmetic. */
3471 if (flag_delete_null_pointer_checks && int_cst_value (low) == 0)
3472 low = build_int_cstu (TREE_TYPE (low), TYPE_ALIGN_UNIT (TREE_TYPE (type)));
3474 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
3477 /* Determine information about number of iterations of a LOOP from the fact
3478 that signed arithmetics in STMT does not overflow. */
3480 static void
3481 infer_loop_bounds_from_signedness (struct loop *loop, gimple *stmt)
3483 tree def, base, step, scev, type, low, high;
3485 if (gimple_code (stmt) != GIMPLE_ASSIGN)
3486 return;
3488 def = gimple_assign_lhs (stmt);
3490 if (TREE_CODE (def) != SSA_NAME)
3491 return;
3493 type = TREE_TYPE (def);
3494 if (!INTEGRAL_TYPE_P (type)
3495 || !TYPE_OVERFLOW_UNDEFINED (type))
3496 return;
3498 scev = instantiate_parameters (loop, analyze_scalar_evolution (loop, def));
3499 if (chrec_contains_undetermined (scev))
3500 return;
3502 base = initial_condition_in_loop_num (scev, loop->num);
3503 step = evolution_part_in_loop_num (scev, loop->num);
3505 if (!base || !step
3506 || TREE_CODE (step) != INTEGER_CST
3507 || tree_contains_chrecs (base, NULL)
3508 || chrec_contains_symbols_defined_in_loop (base, loop->num))
3509 return;
3511 low = lower_bound_in_type (type, type);
3512 high = upper_bound_in_type (type, type);
3514 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
3517 /* The following analyzers are extracting informations on the bounds
3518 of LOOP from the following undefined behaviors:
3520 - data references should not access elements over the statically
3521 allocated size,
3523 - signed variables should not overflow when flag_wrapv is not set.
3526 static void
3527 infer_loop_bounds_from_undefined (struct loop *loop)
3529 unsigned i;
3530 basic_block *bbs;
3531 gimple_stmt_iterator bsi;
3532 basic_block bb;
3533 bool reliable;
3535 bbs = get_loop_body (loop);
3537 for (i = 0; i < loop->num_nodes; i++)
3539 bb = bbs[i];
3541 /* If BB is not executed in each iteration of the loop, we cannot
3542 use the operations in it to infer reliable upper bound on the
3543 # of iterations of the loop. However, we can use it as a guess.
3544 Reliable guesses come only from array bounds. */
3545 reliable = dominated_by_p (CDI_DOMINATORS, loop->latch, bb);
3547 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
3549 gimple *stmt = gsi_stmt (bsi);
3551 infer_loop_bounds_from_array (loop, stmt);
3553 if (reliable)
3555 infer_loop_bounds_from_signedness (loop, stmt);
3556 infer_loop_bounds_from_pointer_arith (loop, stmt);
3562 free (bbs);
3565 /* Compare wide ints, callback for qsort. */
3567 static int
3568 wide_int_cmp (const void *p1, const void *p2)
3570 const widest_int *d1 = (const widest_int *) p1;
3571 const widest_int *d2 = (const widest_int *) p2;
3572 return wi::cmpu (*d1, *d2);
3575 /* Return index of BOUND in BOUNDS array sorted in increasing order.
3576 Lookup by binary search. */
3578 static int
3579 bound_index (vec<widest_int> bounds, const widest_int &bound)
3581 unsigned int end = bounds.length ();
3582 unsigned int begin = 0;
3584 /* Find a matching index by means of a binary search. */
3585 while (begin != end)
3587 unsigned int middle = (begin + end) / 2;
3588 widest_int index = bounds[middle];
3590 if (index == bound)
3591 return middle;
3592 else if (wi::ltu_p (index, bound))
3593 begin = middle + 1;
3594 else
3595 end = middle;
3597 gcc_unreachable ();
3600 /* We recorded loop bounds only for statements dominating loop latch (and thus
3601 executed each loop iteration). If there are any bounds on statements not
3602 dominating the loop latch we can improve the estimate by walking the loop
3603 body and seeing if every path from loop header to loop latch contains
3604 some bounded statement. */
3606 static void
3607 discover_iteration_bound_by_body_walk (struct loop *loop)
3609 struct nb_iter_bound *elt;
3610 auto_vec<widest_int> bounds;
3611 vec<vec<basic_block> > queues = vNULL;
3612 vec<basic_block> queue = vNULL;
3613 ptrdiff_t queue_index;
3614 ptrdiff_t latch_index = 0;
3616 /* Discover what bounds may interest us. */
3617 for (elt = loop->bounds; elt; elt = elt->next)
3619 widest_int bound = elt->bound;
3621 /* Exit terminates loop at given iteration, while non-exits produce undefined
3622 effect on the next iteration. */
3623 if (!elt->is_exit)
3625 bound += 1;
3626 /* If an overflow occurred, ignore the result. */
3627 if (bound == 0)
3628 continue;
3631 if (!loop->any_upper_bound
3632 || wi::ltu_p (bound, loop->nb_iterations_upper_bound))
3633 bounds.safe_push (bound);
3636 /* Exit early if there is nothing to do. */
3637 if (!bounds.exists ())
3638 return;
3640 if (dump_file && (dump_flags & TDF_DETAILS))
3641 fprintf (dump_file, " Trying to walk loop body to reduce the bound.\n");
3643 /* Sort the bounds in decreasing order. */
3644 bounds.qsort (wide_int_cmp);
3646 /* For every basic block record the lowest bound that is guaranteed to
3647 terminate the loop. */
3649 hash_map<basic_block, ptrdiff_t> bb_bounds;
3650 for (elt = loop->bounds; elt; elt = elt->next)
3652 widest_int bound = elt->bound;
3653 if (!elt->is_exit)
3655 bound += 1;
3656 /* If an overflow occurred, ignore the result. */
3657 if (bound == 0)
3658 continue;
3661 if (!loop->any_upper_bound
3662 || wi::ltu_p (bound, loop->nb_iterations_upper_bound))
3664 ptrdiff_t index = bound_index (bounds, bound);
3665 ptrdiff_t *entry = bb_bounds.get (gimple_bb (elt->stmt));
3666 if (!entry)
3667 bb_bounds.put (gimple_bb (elt->stmt), index);
3668 else if ((ptrdiff_t)*entry > index)
3669 *entry = index;
3673 hash_map<basic_block, ptrdiff_t> block_priority;
3675 /* Perform shortest path discovery loop->header ... loop->latch.
3677 The "distance" is given by the smallest loop bound of basic block
3678 present in the path and we look for path with largest smallest bound
3679 on it.
3681 To avoid the need for fibonacci heap on double ints we simply compress
3682 double ints into indexes to BOUNDS array and then represent the queue
3683 as arrays of queues for every index.
3684 Index of BOUNDS.length() means that the execution of given BB has
3685 no bounds determined.
3687 VISITED is a pointer map translating basic block into smallest index
3688 it was inserted into the priority queue with. */
3689 latch_index = -1;
3691 /* Start walk in loop header with index set to infinite bound. */
3692 queue_index = bounds.length ();
3693 queues.safe_grow_cleared (queue_index + 1);
3694 queue.safe_push (loop->header);
3695 queues[queue_index] = queue;
3696 block_priority.put (loop->header, queue_index);
3698 for (; queue_index >= 0; queue_index--)
3700 if (latch_index < queue_index)
3702 while (queues[queue_index].length ())
3704 basic_block bb;
3705 ptrdiff_t bound_index = queue_index;
3706 edge e;
3707 edge_iterator ei;
3709 queue = queues[queue_index];
3710 bb = queue.pop ();
3712 /* OK, we later inserted the BB with lower priority, skip it. */
3713 if (*block_priority.get (bb) > queue_index)
3714 continue;
3716 /* See if we can improve the bound. */
3717 ptrdiff_t *entry = bb_bounds.get (bb);
3718 if (entry && *entry < bound_index)
3719 bound_index = *entry;
3721 /* Insert succesors into the queue, watch for latch edge
3722 and record greatest index we saw. */
3723 FOR_EACH_EDGE (e, ei, bb->succs)
3725 bool insert = false;
3727 if (loop_exit_edge_p (loop, e))
3728 continue;
3730 if (e == loop_latch_edge (loop)
3731 && latch_index < bound_index)
3732 latch_index = bound_index;
3733 else if (!(entry = block_priority.get (e->dest)))
3735 insert = true;
3736 block_priority.put (e->dest, bound_index);
3738 else if (*entry < bound_index)
3740 insert = true;
3741 *entry = bound_index;
3744 if (insert)
3745 queues[bound_index].safe_push (e->dest);
3749 queues[queue_index].release ();
3752 gcc_assert (latch_index >= 0);
3753 if ((unsigned)latch_index < bounds.length ())
3755 if (dump_file && (dump_flags & TDF_DETAILS))
3757 fprintf (dump_file, "Found better loop bound ");
3758 print_decu (bounds[latch_index], dump_file);
3759 fprintf (dump_file, "\n");
3761 record_niter_bound (loop, bounds[latch_index], false, true);
3764 queues.release ();
3767 /* See if every path cross the loop goes through a statement that is known
3768 to not execute at the last iteration. In that case we can decrese iteration
3769 count by 1. */
3771 static void
3772 maybe_lower_iteration_bound (struct loop *loop)
3774 hash_set<gimple *> *not_executed_last_iteration = NULL;
3775 struct nb_iter_bound *elt;
3776 bool found_exit = false;
3777 auto_vec<basic_block> queue;
3778 bitmap visited;
3780 /* Collect all statements with interesting (i.e. lower than
3781 nb_iterations_upper_bound) bound on them.
3783 TODO: Due to the way record_estimate choose estimates to store, the bounds
3784 will be always nb_iterations_upper_bound-1. We can change this to record
3785 also statements not dominating the loop latch and update the walk bellow
3786 to the shortest path algorithm. */
3787 for (elt = loop->bounds; elt; elt = elt->next)
3789 if (!elt->is_exit
3790 && wi::ltu_p (elt->bound, loop->nb_iterations_upper_bound))
3792 if (!not_executed_last_iteration)
3793 not_executed_last_iteration = new hash_set<gimple *>;
3794 not_executed_last_iteration->add (elt->stmt);
3797 if (!not_executed_last_iteration)
3798 return;
3800 /* Start DFS walk in the loop header and see if we can reach the
3801 loop latch or any of the exits (including statements with side
3802 effects that may terminate the loop otherwise) without visiting
3803 any of the statements known to have undefined effect on the last
3804 iteration. */
3805 queue.safe_push (loop->header);
3806 visited = BITMAP_ALLOC (NULL);
3807 bitmap_set_bit (visited, loop->header->index);
3808 found_exit = false;
3812 basic_block bb = queue.pop ();
3813 gimple_stmt_iterator gsi;
3814 bool stmt_found = false;
3816 /* Loop for possible exits and statements bounding the execution. */
3817 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
3819 gimple *stmt = gsi_stmt (gsi);
3820 if (not_executed_last_iteration->contains (stmt))
3822 stmt_found = true;
3823 break;
3825 if (gimple_has_side_effects (stmt))
3827 found_exit = true;
3828 break;
3831 if (found_exit)
3832 break;
3834 /* If no bounding statement is found, continue the walk. */
3835 if (!stmt_found)
3837 edge e;
3838 edge_iterator ei;
3840 FOR_EACH_EDGE (e, ei, bb->succs)
3842 if (loop_exit_edge_p (loop, e)
3843 || e == loop_latch_edge (loop))
3845 found_exit = true;
3846 break;
3848 if (bitmap_set_bit (visited, e->dest->index))
3849 queue.safe_push (e->dest);
3853 while (queue.length () && !found_exit);
3855 /* If every path through the loop reach bounding statement before exit,
3856 then we know the last iteration of the loop will have undefined effect
3857 and we can decrease number of iterations. */
3859 if (!found_exit)
3861 if (dump_file && (dump_flags & TDF_DETAILS))
3862 fprintf (dump_file, "Reducing loop iteration estimate by 1; "
3863 "undefined statement must be executed at the last iteration.\n");
3864 record_niter_bound (loop, loop->nb_iterations_upper_bound - 1,
3865 false, true);
3868 BITMAP_FREE (visited);
3869 delete not_executed_last_iteration;
3872 /* Records estimates on numbers of iterations of LOOP. If USE_UNDEFINED_P
3873 is true also use estimates derived from undefined behavior. */
3875 void
3876 estimate_numbers_of_iterations (struct loop *loop)
3878 vec<edge> exits;
3879 tree niter, type;
3880 unsigned i;
3881 struct tree_niter_desc niter_desc;
3882 edge ex;
3883 widest_int bound;
3884 edge likely_exit;
3886 /* Give up if we already have tried to compute an estimation. */
3887 if (loop->estimate_state != EST_NOT_COMPUTED)
3888 return;
3890 loop->estimate_state = EST_AVAILABLE;
3892 /* If we have a measured profile, use it to estimate the number of
3893 iterations. Normally this is recorded by branch_prob right after
3894 reading the profile. In case we however found a new loop, record the
3895 information here.
3897 Explicitly check for profile status so we do not report
3898 wrong prediction hitrates for guessed loop iterations heuristics.
3899 Do not recompute already recorded bounds - we ought to be better on
3900 updating iteration bounds than updating profile in general and thus
3901 recomputing iteration bounds later in the compilation process will just
3902 introduce random roundoff errors. */
3903 if (!loop->any_estimate
3904 && loop->header->count.reliable_p ())
3906 gcov_type nit = expected_loop_iterations_unbounded (loop);
3907 bound = gcov_type_to_wide_int (nit);
3908 record_niter_bound (loop, bound, true, false);
3911 /* Ensure that loop->nb_iterations is computed if possible. If it turns out
3912 to be constant, we avoid undefined behavior implied bounds and instead
3913 diagnose those loops with -Waggressive-loop-optimizations. */
3914 number_of_latch_executions (loop);
3916 exits = get_loop_exit_edges (loop);
3917 likely_exit = single_likely_exit (loop);
3918 FOR_EACH_VEC_ELT (exits, i, ex)
3920 if (!number_of_iterations_exit (loop, ex, &niter_desc, false, false))
3921 continue;
3923 niter = niter_desc.niter;
3924 type = TREE_TYPE (niter);
3925 if (TREE_CODE (niter_desc.may_be_zero) != INTEGER_CST)
3926 niter = build3 (COND_EXPR, type, niter_desc.may_be_zero,
3927 build_int_cst (type, 0),
3928 niter);
3929 record_estimate (loop, niter, niter_desc.max,
3930 last_stmt (ex->src),
3931 true, ex == likely_exit, true);
3932 record_control_iv (loop, &niter_desc);
3934 exits.release ();
3936 if (flag_aggressive_loop_optimizations)
3937 infer_loop_bounds_from_undefined (loop);
3939 discover_iteration_bound_by_body_walk (loop);
3941 maybe_lower_iteration_bound (loop);
3943 /* If we know the exact number of iterations of this loop, try to
3944 not break code with undefined behavior by not recording smaller
3945 maximum number of iterations. */
3946 if (loop->nb_iterations
3947 && TREE_CODE (loop->nb_iterations) == INTEGER_CST)
3949 loop->any_upper_bound = true;
3950 loop->nb_iterations_upper_bound = wi::to_widest (loop->nb_iterations);
3954 /* Sets NIT to the estimated number of executions of the latch of the
3955 LOOP. If CONSERVATIVE is true, we must be sure that NIT is at least as
3956 large as the number of iterations. If we have no reliable estimate,
3957 the function returns false, otherwise returns true. */
3959 bool
3960 estimated_loop_iterations (struct loop *loop, widest_int *nit)
3962 /* When SCEV information is available, try to update loop iterations
3963 estimate. Otherwise just return whatever we recorded earlier. */
3964 if (scev_initialized_p ())
3965 estimate_numbers_of_iterations (loop);
3967 return (get_estimated_loop_iterations (loop, nit));
3970 /* Similar to estimated_loop_iterations, but returns the estimate only
3971 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
3972 on the number of iterations of LOOP could not be derived, returns -1. */
3974 HOST_WIDE_INT
3975 estimated_loop_iterations_int (struct loop *loop)
3977 widest_int nit;
3978 HOST_WIDE_INT hwi_nit;
3980 if (!estimated_loop_iterations (loop, &nit))
3981 return -1;
3983 if (!wi::fits_shwi_p (nit))
3984 return -1;
3985 hwi_nit = nit.to_shwi ();
3987 return hwi_nit < 0 ? -1 : hwi_nit;
3991 /* Sets NIT to an upper bound for the maximum number of executions of the
3992 latch of the LOOP. If we have no reliable estimate, the function returns
3993 false, otherwise returns true. */
3995 bool
3996 max_loop_iterations (struct loop *loop, widest_int *nit)
3998 /* When SCEV information is available, try to update loop iterations
3999 estimate. Otherwise just return whatever we recorded earlier. */
4000 if (scev_initialized_p ())
4001 estimate_numbers_of_iterations (loop);
4003 return get_max_loop_iterations (loop, nit);
4006 /* Similar to max_loop_iterations, but returns the estimate only
4007 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
4008 on the number of iterations of LOOP could not be derived, returns -1. */
4010 HOST_WIDE_INT
4011 max_loop_iterations_int (struct loop *loop)
4013 widest_int nit;
4014 HOST_WIDE_INT hwi_nit;
4016 if (!max_loop_iterations (loop, &nit))
4017 return -1;
4019 if (!wi::fits_shwi_p (nit))
4020 return -1;
4021 hwi_nit = nit.to_shwi ();
4023 return hwi_nit < 0 ? -1 : hwi_nit;
4026 /* Sets NIT to an likely upper bound for the maximum number of executions of the
4027 latch of the LOOP. If we have no reliable estimate, the function returns
4028 false, otherwise returns true. */
4030 bool
4031 likely_max_loop_iterations (struct loop *loop, widest_int *nit)
4033 /* When SCEV information is available, try to update loop iterations
4034 estimate. Otherwise just return whatever we recorded earlier. */
4035 if (scev_initialized_p ())
4036 estimate_numbers_of_iterations (loop);
4038 return get_likely_max_loop_iterations (loop, nit);
4041 /* Similar to max_loop_iterations, but returns the estimate only
4042 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
4043 on the number of iterations of LOOP could not be derived, returns -1. */
4045 HOST_WIDE_INT
4046 likely_max_loop_iterations_int (struct loop *loop)
4048 widest_int nit;
4049 HOST_WIDE_INT hwi_nit;
4051 if (!likely_max_loop_iterations (loop, &nit))
4052 return -1;
4054 if (!wi::fits_shwi_p (nit))
4055 return -1;
4056 hwi_nit = nit.to_shwi ();
4058 return hwi_nit < 0 ? -1 : hwi_nit;
4061 /* Returns an estimate for the number of executions of statements
4062 in the LOOP. For statements before the loop exit, this exceeds
4063 the number of execution of the latch by one. */
4065 HOST_WIDE_INT
4066 estimated_stmt_executions_int (struct loop *loop)
4068 HOST_WIDE_INT nit = estimated_loop_iterations_int (loop);
4069 HOST_WIDE_INT snit;
4071 if (nit == -1)
4072 return -1;
4074 snit = (HOST_WIDE_INT) ((unsigned HOST_WIDE_INT) nit + 1);
4076 /* If the computation overflows, return -1. */
4077 return snit < 0 ? -1 : snit;
4080 /* Sets NIT to the maximum number of executions of the latch of the
4081 LOOP, plus one. If we have no reliable estimate, the function returns
4082 false, otherwise returns true. */
4084 bool
4085 max_stmt_executions (struct loop *loop, widest_int *nit)
4087 widest_int nit_minus_one;
4089 if (!max_loop_iterations (loop, nit))
4090 return false;
4092 nit_minus_one = *nit;
4094 *nit += 1;
4096 return wi::gtu_p (*nit, nit_minus_one);
4099 /* Sets NIT to the estimated maximum number of executions of the latch of the
4100 LOOP, plus one. If we have no likely estimate, the function returns
4101 false, otherwise returns true. */
4103 bool
4104 likely_max_stmt_executions (struct loop *loop, widest_int *nit)
4106 widest_int nit_minus_one;
4108 if (!likely_max_loop_iterations (loop, nit))
4109 return false;
4111 nit_minus_one = *nit;
4113 *nit += 1;
4115 return wi::gtu_p (*nit, nit_minus_one);
4118 /* Sets NIT to the estimated number of executions of the latch of the
4119 LOOP, plus one. If we have no reliable estimate, the function returns
4120 false, otherwise returns true. */
4122 bool
4123 estimated_stmt_executions (struct loop *loop, widest_int *nit)
4125 widest_int nit_minus_one;
4127 if (!estimated_loop_iterations (loop, nit))
4128 return false;
4130 nit_minus_one = *nit;
4132 *nit += 1;
4134 return wi::gtu_p (*nit, nit_minus_one);
4137 /* Records estimates on numbers of iterations of loops. */
4139 void
4140 estimate_numbers_of_iterations (function *fn)
4142 struct loop *loop;
4144 /* We don't want to issue signed overflow warnings while getting
4145 loop iteration estimates. */
4146 fold_defer_overflow_warnings ();
4148 FOR_EACH_LOOP_FN (fn, loop, 0)
4149 estimate_numbers_of_iterations (loop);
4151 fold_undefer_and_ignore_overflow_warnings ();
4154 /* Returns true if statement S1 dominates statement S2. */
4156 bool
4157 stmt_dominates_stmt_p (gimple *s1, gimple *s2)
4159 basic_block bb1 = gimple_bb (s1), bb2 = gimple_bb (s2);
4161 if (!bb1
4162 || s1 == s2)
4163 return true;
4165 if (bb1 == bb2)
4167 gimple_stmt_iterator bsi;
4169 if (gimple_code (s2) == GIMPLE_PHI)
4170 return false;
4172 if (gimple_code (s1) == GIMPLE_PHI)
4173 return true;
4175 for (bsi = gsi_start_bb (bb1); gsi_stmt (bsi) != s2; gsi_next (&bsi))
4176 if (gsi_stmt (bsi) == s1)
4177 return true;
4179 return false;
4182 return dominated_by_p (CDI_DOMINATORS, bb2, bb1);
4185 /* Returns true when we can prove that the number of executions of
4186 STMT in the loop is at most NITER, according to the bound on
4187 the number of executions of the statement NITER_BOUND->stmt recorded in
4188 NITER_BOUND and fact that NITER_BOUND->stmt dominate STMT.
4190 ??? This code can become quite a CPU hog - we can have many bounds,
4191 and large basic block forcing stmt_dominates_stmt_p to be queried
4192 many times on a large basic blocks, so the whole thing is O(n^2)
4193 for scev_probably_wraps_p invocation (that can be done n times).
4195 It would make more sense (and give better answers) to remember BB
4196 bounds computed by discover_iteration_bound_by_body_walk. */
4198 static bool
4199 n_of_executions_at_most (gimple *stmt,
4200 struct nb_iter_bound *niter_bound,
4201 tree niter)
4203 widest_int bound = niter_bound->bound;
4204 tree nit_type = TREE_TYPE (niter), e;
4205 enum tree_code cmp;
4207 gcc_assert (TYPE_UNSIGNED (nit_type));
4209 /* If the bound does not even fit into NIT_TYPE, it cannot tell us that
4210 the number of iterations is small. */
4211 if (!wi::fits_to_tree_p (bound, nit_type))
4212 return false;
4214 /* We know that NITER_BOUND->stmt is executed at most NITER_BOUND->bound + 1
4215 times. This means that:
4217 -- if NITER_BOUND->is_exit is true, then everything after
4218 it at most NITER_BOUND->bound times.
4220 -- If NITER_BOUND->is_exit is false, then if we can prove that when STMT
4221 is executed, then NITER_BOUND->stmt is executed as well in the same
4222 iteration then STMT is executed at most NITER_BOUND->bound + 1 times.
4224 If we can determine that NITER_BOUND->stmt is always executed
4225 after STMT, then STMT is executed at most NITER_BOUND->bound + 2 times.
4226 We conclude that if both statements belong to the same
4227 basic block and STMT is before NITER_BOUND->stmt and there are no
4228 statements with side effects in between. */
4230 if (niter_bound->is_exit)
4232 if (stmt == niter_bound->stmt
4233 || !stmt_dominates_stmt_p (niter_bound->stmt, stmt))
4234 return false;
4235 cmp = GE_EXPR;
4237 else
4239 if (!stmt_dominates_stmt_p (niter_bound->stmt, stmt))
4241 gimple_stmt_iterator bsi;
4242 if (gimple_bb (stmt) != gimple_bb (niter_bound->stmt)
4243 || gimple_code (stmt) == GIMPLE_PHI
4244 || gimple_code (niter_bound->stmt) == GIMPLE_PHI)
4245 return false;
4247 /* By stmt_dominates_stmt_p we already know that STMT appears
4248 before NITER_BOUND->STMT. Still need to test that the loop
4249 can not be terinated by a side effect in between. */
4250 for (bsi = gsi_for_stmt (stmt); gsi_stmt (bsi) != niter_bound->stmt;
4251 gsi_next (&bsi))
4252 if (gimple_has_side_effects (gsi_stmt (bsi)))
4253 return false;
4254 bound += 1;
4255 if (bound == 0
4256 || !wi::fits_to_tree_p (bound, nit_type))
4257 return false;
4259 cmp = GT_EXPR;
4262 e = fold_binary (cmp, boolean_type_node,
4263 niter, wide_int_to_tree (nit_type, bound));
4264 return e && integer_nonzerop (e);
4267 /* Returns true if the arithmetics in TYPE can be assumed not to wrap. */
4269 bool
4270 nowrap_type_p (tree type)
4272 if (ANY_INTEGRAL_TYPE_P (type)
4273 && TYPE_OVERFLOW_UNDEFINED (type))
4274 return true;
4276 if (POINTER_TYPE_P (type))
4277 return true;
4279 return false;
4282 /* Return true if we can prove LOOP is exited before evolution of induction
4283 variable {BASE, STEP} overflows with respect to its type bound. */
4285 static bool
4286 loop_exits_before_overflow (tree base, tree step,
4287 gimple *at_stmt, struct loop *loop)
4289 widest_int niter;
4290 struct control_iv *civ;
4291 struct nb_iter_bound *bound;
4292 tree e, delta, step_abs, unsigned_base;
4293 tree type = TREE_TYPE (step);
4294 tree unsigned_type, valid_niter;
4296 /* Don't issue signed overflow warnings. */
4297 fold_defer_overflow_warnings ();
4299 /* Compute the number of iterations before we reach the bound of the
4300 type, and verify that the loop is exited before this occurs. */
4301 unsigned_type = unsigned_type_for (type);
4302 unsigned_base = fold_convert (unsigned_type, base);
4304 if (tree_int_cst_sign_bit (step))
4306 tree extreme = fold_convert (unsigned_type,
4307 lower_bound_in_type (type, type));
4308 delta = fold_build2 (MINUS_EXPR, unsigned_type, unsigned_base, extreme);
4309 step_abs = fold_build1 (NEGATE_EXPR, unsigned_type,
4310 fold_convert (unsigned_type, step));
4312 else
4314 tree extreme = fold_convert (unsigned_type,
4315 upper_bound_in_type (type, type));
4316 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, unsigned_base);
4317 step_abs = fold_convert (unsigned_type, step);
4320 valid_niter = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step_abs);
4322 estimate_numbers_of_iterations (loop);
4324 if (max_loop_iterations (loop, &niter)
4325 && wi::fits_to_tree_p (niter, TREE_TYPE (valid_niter))
4326 && (e = fold_binary (GT_EXPR, boolean_type_node, valid_niter,
4327 wide_int_to_tree (TREE_TYPE (valid_niter),
4328 niter))) != NULL
4329 && integer_nonzerop (e))
4331 fold_undefer_and_ignore_overflow_warnings ();
4332 return true;
4334 if (at_stmt)
4335 for (bound = loop->bounds; bound; bound = bound->next)
4337 if (n_of_executions_at_most (at_stmt, bound, valid_niter))
4339 fold_undefer_and_ignore_overflow_warnings ();
4340 return true;
4343 fold_undefer_and_ignore_overflow_warnings ();
4345 /* Try to prove loop is exited before {base, step} overflows with the
4346 help of analyzed loop control IV. This is done only for IVs with
4347 constant step because otherwise we don't have the information. */
4348 if (TREE_CODE (step) == INTEGER_CST)
4350 for (civ = loop->control_ivs; civ; civ = civ->next)
4352 enum tree_code code;
4353 tree civ_type = TREE_TYPE (civ->step);
4355 /* Have to consider type difference because operand_equal_p ignores
4356 that for constants. */
4357 if (TYPE_UNSIGNED (type) != TYPE_UNSIGNED (civ_type)
4358 || element_precision (type) != element_precision (civ_type))
4359 continue;
4361 /* Only consider control IV with same step. */
4362 if (!operand_equal_p (step, civ->step, 0))
4363 continue;
4365 /* Done proving if this is a no-overflow control IV. */
4366 if (operand_equal_p (base, civ->base, 0))
4367 return true;
4369 /* Control IV is recorded after expanding simple operations,
4370 Here we expand base and compare it too. */
4371 tree expanded_base = expand_simple_operations (base);
4372 if (operand_equal_p (expanded_base, civ->base, 0))
4373 return true;
4375 /* If this is a before stepping control IV, in other words, we have
4377 {civ_base, step} = {base + step, step}
4379 Because civ {base + step, step} doesn't overflow during loop
4380 iterations, {base, step} will not overflow if we can prove the
4381 operation "base + step" does not overflow. Specifically, we try
4382 to prove below conditions are satisfied:
4384 base <= UPPER_BOUND (type) - step ;;step > 0
4385 base >= LOWER_BOUND (type) - step ;;step < 0
4387 by proving the reverse conditions are false using loop's initial
4388 condition. */
4389 if (POINTER_TYPE_P (TREE_TYPE (base)))
4390 code = POINTER_PLUS_EXPR;
4391 else
4392 code = PLUS_EXPR;
4394 tree stepped = fold_build2 (code, TREE_TYPE (base), base, step);
4395 tree expanded_stepped = fold_build2 (code, TREE_TYPE (base),
4396 expanded_base, step);
4397 if (operand_equal_p (stepped, civ->base, 0)
4398 || operand_equal_p (expanded_stepped, civ->base, 0))
4400 tree extreme;
4402 if (tree_int_cst_sign_bit (step))
4404 code = LT_EXPR;
4405 extreme = lower_bound_in_type (type, type);
4407 else
4409 code = GT_EXPR;
4410 extreme = upper_bound_in_type (type, type);
4412 extreme = fold_build2 (MINUS_EXPR, type, extreme, step);
4413 e = fold_build2 (code, boolean_type_node, base, extreme);
4414 e = simplify_using_initial_conditions (loop, e);
4415 if (integer_zerop (e))
4416 return true;
4421 return false;
4424 /* VAR is scev variable whose evolution part is constant STEP, this function
4425 proves that VAR can't overflow by using value range info. If VAR's value
4426 range is [MIN, MAX], it can be proven by:
4427 MAX + step doesn't overflow ; if step > 0
4429 MIN + step doesn't underflow ; if step < 0.
4431 We can only do this if var is computed in every loop iteration, i.e, var's
4432 definition has to dominate loop latch. Consider below example:
4435 unsigned int i;
4437 <bb 3>:
4439 <bb 4>:
4440 # RANGE [0, 4294967294] NONZERO 65535
4441 # i_21 = PHI <0(3), i_18(9)>
4442 if (i_21 != 0)
4443 goto <bb 6>;
4444 else
4445 goto <bb 8>;
4447 <bb 6>:
4448 # RANGE [0, 65533] NONZERO 65535
4449 _6 = i_21 + 4294967295;
4450 # RANGE [0, 65533] NONZERO 65535
4451 _7 = (long unsigned int) _6;
4452 # RANGE [0, 524264] NONZERO 524280
4453 _8 = _7 * 8;
4454 # PT = nonlocal escaped
4455 _9 = a_14 + _8;
4456 *_9 = 0;
4458 <bb 8>:
4459 # RANGE [1, 65535] NONZERO 65535
4460 i_18 = i_21 + 1;
4461 if (i_18 >= 65535)
4462 goto <bb 10>;
4463 else
4464 goto <bb 9>;
4466 <bb 9>:
4467 goto <bb 4>;
4469 <bb 10>:
4470 return;
4473 VAR _6 doesn't overflow only with pre-condition (i_21 != 0), here we
4474 can't use _6 to prove no-overlfow for _7. In fact, var _7 takes value
4475 sequence (4294967295, 0, 1, ..., 65533) in loop life time, rather than
4476 (4294967295, 4294967296, ...). */
4478 static bool
4479 scev_var_range_cant_overflow (tree var, tree step, struct loop *loop)
4481 tree type;
4482 wide_int minv, maxv, diff, step_wi;
4483 enum value_range_type rtype;
4485 if (TREE_CODE (step) != INTEGER_CST || !INTEGRAL_TYPE_P (TREE_TYPE (var)))
4486 return false;
4488 /* Check if VAR evaluates in every loop iteration. It's not the case
4489 if VAR is default definition or does not dominate loop's latch. */
4490 basic_block def_bb = gimple_bb (SSA_NAME_DEF_STMT (var));
4491 if (!def_bb || !dominated_by_p (CDI_DOMINATORS, loop->latch, def_bb))
4492 return false;
4494 rtype = get_range_info (var, &minv, &maxv);
4495 if (rtype != VR_RANGE)
4496 return false;
4498 /* VAR is a scev whose evolution part is STEP and value range info
4499 is [MIN, MAX], we can prove its no-overflowness by conditions:
4501 type_MAX - MAX >= step ; if step > 0
4502 MIN - type_MIN >= |step| ; if step < 0.
4504 Or VAR must take value outside of value range, which is not true. */
4505 step_wi = wi::to_wide (step);
4506 type = TREE_TYPE (var);
4507 if (tree_int_cst_sign_bit (step))
4509 diff = minv - wi::to_wide (lower_bound_in_type (type, type));
4510 step_wi = - step_wi;
4512 else
4513 diff = wi::to_wide (upper_bound_in_type (type, type)) - maxv;
4515 return (wi::geu_p (diff, step_wi));
4518 /* Return false only when the induction variable BASE + STEP * I is
4519 known to not overflow: i.e. when the number of iterations is small
4520 enough with respect to the step and initial condition in order to
4521 keep the evolution confined in TYPEs bounds. Return true when the
4522 iv is known to overflow or when the property is not computable.
4524 USE_OVERFLOW_SEMANTICS is true if this function should assume that
4525 the rules for overflow of the given language apply (e.g., that signed
4526 arithmetics in C does not overflow).
4528 If VAR is a ssa variable, this function also returns false if VAR can
4529 be proven not overflow with value range info. */
4531 bool
4532 scev_probably_wraps_p (tree var, tree base, tree step,
4533 gimple *at_stmt, struct loop *loop,
4534 bool use_overflow_semantics)
4536 /* FIXME: We really need something like
4537 http://gcc.gnu.org/ml/gcc-patches/2005-06/msg02025.html.
4539 We used to test for the following situation that frequently appears
4540 during address arithmetics:
4542 D.1621_13 = (long unsigned intD.4) D.1620_12;
4543 D.1622_14 = D.1621_13 * 8;
4544 D.1623_15 = (doubleD.29 *) D.1622_14;
4546 And derived that the sequence corresponding to D_14
4547 can be proved to not wrap because it is used for computing a
4548 memory access; however, this is not really the case -- for example,
4549 if D_12 = (unsigned char) [254,+,1], then D_14 has values
4550 2032, 2040, 0, 8, ..., but the code is still legal. */
4552 if (chrec_contains_undetermined (base)
4553 || chrec_contains_undetermined (step))
4554 return true;
4556 if (integer_zerop (step))
4557 return false;
4559 /* If we can use the fact that signed and pointer arithmetics does not
4560 wrap, we are done. */
4561 if (use_overflow_semantics && nowrap_type_p (TREE_TYPE (base)))
4562 return false;
4564 /* To be able to use estimates on number of iterations of the loop,
4565 we must have an upper bound on the absolute value of the step. */
4566 if (TREE_CODE (step) != INTEGER_CST)
4567 return true;
4569 /* Check if var can be proven not overflow with value range info. */
4570 if (var && TREE_CODE (var) == SSA_NAME
4571 && scev_var_range_cant_overflow (var, step, loop))
4572 return false;
4574 if (loop_exits_before_overflow (base, step, at_stmt, loop))
4575 return false;
4577 /* At this point we still don't have a proof that the iv does not
4578 overflow: give up. */
4579 return true;
4582 /* Frees the information on upper bounds on numbers of iterations of LOOP. */
4584 void
4585 free_numbers_of_iterations_estimates (struct loop *loop)
4587 struct control_iv *civ;
4588 struct nb_iter_bound *bound;
4590 loop->nb_iterations = NULL;
4591 loop->estimate_state = EST_NOT_COMPUTED;
4592 for (bound = loop->bounds; bound;)
4594 struct nb_iter_bound *next = bound->next;
4595 ggc_free (bound);
4596 bound = next;
4598 loop->bounds = NULL;
4600 for (civ = loop->control_ivs; civ;)
4602 struct control_iv *next = civ->next;
4603 ggc_free (civ);
4604 civ = next;
4606 loop->control_ivs = NULL;
4609 /* Frees the information on upper bounds on numbers of iterations of loops. */
4611 void
4612 free_numbers_of_iterations_estimates (function *fn)
4614 struct loop *loop;
4616 FOR_EACH_LOOP_FN (fn, loop, 0)
4617 free_numbers_of_iterations_estimates (loop);
4620 /* Substitute value VAL for ssa name NAME inside expressions held
4621 at LOOP. */
4623 void
4624 substitute_in_loop_info (struct loop *loop, tree name, tree val)
4626 loop->nb_iterations = simplify_replace_tree (loop->nb_iterations, name, val);