* config/sparc/sparc.c (sparc_option_override): Set MASK_FSMULD flag
[official-gcc.git] / gcc / tree-ssa-loop-niter.c
blobe0107c28dfbf7c5e3e0a6c508fa97e2f61d0a78a
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"
47 /* The maximum number of dominator BBs we search for conditions
48 of loop header copies we use for simplifying a conditional
49 expression. */
50 #define MAX_DOMINATORS_TO_WALK 8
54 Analysis of number of iterations of an affine exit test.
58 /* Bounds on some value, BELOW <= X <= UP. */
60 struct bounds
62 mpz_t below, up;
66 /* Splits expression EXPR to a variable part VAR and constant OFFSET. */
68 static void
69 split_to_var_and_offset (tree expr, tree *var, mpz_t offset)
71 tree type = TREE_TYPE (expr);
72 tree op0, op1;
73 bool negate = false;
75 *var = expr;
76 mpz_set_ui (offset, 0);
78 switch (TREE_CODE (expr))
80 case MINUS_EXPR:
81 negate = true;
82 /* Fallthru. */
84 case PLUS_EXPR:
85 case POINTER_PLUS_EXPR:
86 op0 = TREE_OPERAND (expr, 0);
87 op1 = TREE_OPERAND (expr, 1);
89 if (TREE_CODE (op1) != INTEGER_CST)
90 break;
92 *var = op0;
93 /* Always sign extend the offset. */
94 wi::to_mpz (op1, offset, SIGNED);
95 if (negate)
96 mpz_neg (offset, offset);
97 break;
99 case INTEGER_CST:
100 *var = build_int_cst_type (type, 0);
101 wi::to_mpz (expr, offset, TYPE_SIGN (type));
102 break;
104 default:
105 break;
109 /* From condition C0 CMP C1 derives information regarding the value range
110 of VAR, which is of TYPE. Results are stored in to BELOW and UP. */
112 static void
113 refine_value_range_using_guard (tree type, tree var,
114 tree c0, enum tree_code cmp, tree c1,
115 mpz_t below, mpz_t up)
117 tree varc0, varc1, ctype;
118 mpz_t offc0, offc1;
119 mpz_t mint, maxt, minc1, maxc1;
120 wide_int minv, maxv;
121 bool no_wrap = nowrap_type_p (type);
122 bool c0_ok, c1_ok;
123 signop sgn = TYPE_SIGN (type);
125 switch (cmp)
127 case LT_EXPR:
128 case LE_EXPR:
129 case GT_EXPR:
130 case GE_EXPR:
131 STRIP_SIGN_NOPS (c0);
132 STRIP_SIGN_NOPS (c1);
133 ctype = TREE_TYPE (c0);
134 if (!useless_type_conversion_p (ctype, type))
135 return;
137 break;
139 case EQ_EXPR:
140 /* We could derive quite precise information from EQ_EXPR, however,
141 such a guard is unlikely to appear, so we do not bother with
142 handling it. */
143 return;
145 case NE_EXPR:
146 /* NE_EXPR comparisons do not contain much of useful information,
147 except for cases of comparing with bounds. */
148 if (TREE_CODE (c1) != INTEGER_CST
149 || !INTEGRAL_TYPE_P (type))
150 return;
152 /* Ensure that the condition speaks about an expression in the same
153 type as X and Y. */
154 ctype = TREE_TYPE (c0);
155 if (TYPE_PRECISION (ctype) != TYPE_PRECISION (type))
156 return;
157 c0 = fold_convert (type, c0);
158 c1 = fold_convert (type, c1);
160 if (operand_equal_p (var, c0, 0))
162 mpz_t valc1;
164 /* Case of comparing VAR with its below/up bounds. */
165 mpz_init (valc1);
166 wi::to_mpz (c1, valc1, TYPE_SIGN (type));
167 if (mpz_cmp (valc1, below) == 0)
168 cmp = GT_EXPR;
169 if (mpz_cmp (valc1, up) == 0)
170 cmp = LT_EXPR;
172 mpz_clear (valc1);
174 else
176 /* Case of comparing with the bounds of the type. */
177 wide_int min = wi::min_value (type);
178 wide_int max = wi::max_value (type);
180 if (wi::eq_p (c1, min))
181 cmp = GT_EXPR;
182 if (wi::eq_p (c1, max))
183 cmp = LT_EXPR;
186 /* Quick return if no useful information. */
187 if (cmp == NE_EXPR)
188 return;
190 break;
192 default:
193 return;
196 mpz_init (offc0);
197 mpz_init (offc1);
198 split_to_var_and_offset (expand_simple_operations (c0), &varc0, offc0);
199 split_to_var_and_offset (expand_simple_operations (c1), &varc1, offc1);
201 /* We are only interested in comparisons of expressions based on VAR. */
202 if (operand_equal_p (var, varc1, 0))
204 std::swap (varc0, varc1);
205 mpz_swap (offc0, offc1);
206 cmp = swap_tree_comparison (cmp);
208 else if (!operand_equal_p (var, varc0, 0))
210 mpz_clear (offc0);
211 mpz_clear (offc1);
212 return;
215 mpz_init (mint);
216 mpz_init (maxt);
217 get_type_static_bounds (type, mint, maxt);
218 mpz_init (minc1);
219 mpz_init (maxc1);
220 /* Setup range information for varc1. */
221 if (integer_zerop (varc1))
223 wi::to_mpz (integer_zero_node, minc1, TYPE_SIGN (type));
224 wi::to_mpz (integer_zero_node, maxc1, TYPE_SIGN (type));
226 else if (TREE_CODE (varc1) == SSA_NAME
227 && INTEGRAL_TYPE_P (type)
228 && get_range_info (varc1, &minv, &maxv) == VR_RANGE)
230 gcc_assert (wi::le_p (minv, maxv, sgn));
231 wi::to_mpz (minv, minc1, sgn);
232 wi::to_mpz (maxv, maxc1, sgn);
234 else
236 mpz_set (minc1, mint);
237 mpz_set (maxc1, maxt);
240 /* Compute valid range information for varc1 + offc1. Note nothing
241 useful can be derived if it overflows or underflows. Overflow or
242 underflow could happen when:
244 offc1 > 0 && varc1 + offc1 > MAX_VAL (type)
245 offc1 < 0 && varc1 + offc1 < MIN_VAL (type). */
246 mpz_add (minc1, minc1, offc1);
247 mpz_add (maxc1, maxc1, offc1);
248 c1_ok = (no_wrap
249 || mpz_sgn (offc1) == 0
250 || (mpz_sgn (offc1) < 0 && mpz_cmp (minc1, mint) >= 0)
251 || (mpz_sgn (offc1) > 0 && mpz_cmp (maxc1, maxt) <= 0));
252 if (!c1_ok)
253 goto end;
255 if (mpz_cmp (minc1, mint) < 0)
256 mpz_set (minc1, mint);
257 if (mpz_cmp (maxc1, maxt) > 0)
258 mpz_set (maxc1, maxt);
260 if (cmp == LT_EXPR)
262 cmp = LE_EXPR;
263 mpz_sub_ui (maxc1, maxc1, 1);
265 if (cmp == GT_EXPR)
267 cmp = GE_EXPR;
268 mpz_add_ui (minc1, minc1, 1);
271 /* Compute range information for varc0. If there is no overflow,
272 the condition implied that
274 (varc0) cmp (varc1 + offc1 - offc0)
276 We can possibly improve the upper bound of varc0 if cmp is LE_EXPR,
277 or the below bound if cmp is GE_EXPR.
279 To prove there is no overflow/underflow, we need to check below
280 four cases:
281 1) cmp == LE_EXPR && offc0 > 0
283 (varc0 + offc0) doesn't overflow
284 && (varc1 + offc1 - offc0) doesn't underflow
286 2) cmp == LE_EXPR && offc0 < 0
288 (varc0 + offc0) doesn't underflow
289 && (varc1 + offc1 - offc0) doesn't overfloe
291 In this case, (varc0 + offc0) will never underflow if we can
292 prove (varc1 + offc1 - offc0) doesn't overflow.
294 3) cmp == GE_EXPR && offc0 < 0
296 (varc0 + offc0) doesn't underflow
297 && (varc1 + offc1 - offc0) doesn't overflow
299 4) cmp == GE_EXPR && offc0 > 0
301 (varc0 + offc0) doesn't overflow
302 && (varc1 + offc1 - offc0) doesn't underflow
304 In this case, (varc0 + offc0) will never overflow if we can
305 prove (varc1 + offc1 - offc0) doesn't underflow.
307 Note we only handle case 2 and 4 in below code. */
309 mpz_sub (minc1, minc1, offc0);
310 mpz_sub (maxc1, maxc1, offc0);
311 c0_ok = (no_wrap
312 || mpz_sgn (offc0) == 0
313 || (cmp == LE_EXPR
314 && mpz_sgn (offc0) < 0 && mpz_cmp (maxc1, maxt) <= 0)
315 || (cmp == GE_EXPR
316 && mpz_sgn (offc0) > 0 && mpz_cmp (minc1, mint) >= 0));
317 if (!c0_ok)
318 goto end;
320 if (cmp == LE_EXPR)
322 if (mpz_cmp (up, maxc1) > 0)
323 mpz_set (up, maxc1);
325 else
327 if (mpz_cmp (below, minc1) < 0)
328 mpz_set (below, minc1);
331 end:
332 mpz_clear (mint);
333 mpz_clear (maxt);
334 mpz_clear (minc1);
335 mpz_clear (maxc1);
336 mpz_clear (offc0);
337 mpz_clear (offc1);
340 /* Stores estimate on the minimum/maximum value of the expression VAR + OFF
341 in TYPE to MIN and MAX. */
343 static void
344 determine_value_range (struct loop *loop, tree type, tree var, mpz_t off,
345 mpz_t min, mpz_t max)
347 int cnt = 0;
348 mpz_t minm, maxm;
349 basic_block bb;
350 wide_int minv, maxv;
351 enum value_range_type rtype = VR_VARYING;
353 /* If the expression is a constant, we know its value exactly. */
354 if (integer_zerop (var))
356 mpz_set (min, off);
357 mpz_set (max, off);
358 return;
361 get_type_static_bounds (type, min, max);
363 /* See if we have some range info from VRP. */
364 if (TREE_CODE (var) == SSA_NAME && INTEGRAL_TYPE_P (type))
366 edge e = loop_preheader_edge (loop);
367 signop sgn = TYPE_SIGN (type);
368 gphi_iterator gsi;
370 /* Either for VAR itself... */
371 rtype = get_range_info (var, &minv, &maxv);
372 /* Or for PHI results in loop->header where VAR is used as
373 PHI argument from the loop preheader edge. */
374 for (gsi = gsi_start_phis (loop->header); !gsi_end_p (gsi); gsi_next (&gsi))
376 gphi *phi = gsi.phi ();
377 wide_int minc, maxc;
378 if (PHI_ARG_DEF_FROM_EDGE (phi, e) == var
379 && (get_range_info (gimple_phi_result (phi), &minc, &maxc)
380 == VR_RANGE))
382 if (rtype != VR_RANGE)
384 rtype = VR_RANGE;
385 minv = minc;
386 maxv = maxc;
388 else
390 minv = wi::max (minv, minc, sgn);
391 maxv = wi::min (maxv, maxc, sgn);
392 /* If the PHI result range are inconsistent with
393 the VAR range, give up on looking at the PHI
394 results. This can happen if VR_UNDEFINED is
395 involved. */
396 if (wi::gt_p (minv, maxv, sgn))
398 rtype = get_range_info (var, &minv, &maxv);
399 break;
404 mpz_init (minm);
405 mpz_init (maxm);
406 if (rtype != VR_RANGE)
408 mpz_set (minm, min);
409 mpz_set (maxm, max);
411 else
413 gcc_assert (wi::le_p (minv, maxv, sgn));
414 wi::to_mpz (minv, minm, sgn);
415 wi::to_mpz (maxv, maxm, sgn);
417 /* Now walk the dominators of the loop header and use the entry
418 guards to refine the estimates. */
419 for (bb = loop->header;
420 bb != ENTRY_BLOCK_PTR_FOR_FN (cfun) && cnt < MAX_DOMINATORS_TO_WALK;
421 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
423 edge e;
424 tree c0, c1;
425 gimple *cond;
426 enum tree_code cmp;
428 if (!single_pred_p (bb))
429 continue;
430 e = single_pred_edge (bb);
432 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
433 continue;
435 cond = last_stmt (e->src);
436 c0 = gimple_cond_lhs (cond);
437 cmp = gimple_cond_code (cond);
438 c1 = gimple_cond_rhs (cond);
440 if (e->flags & EDGE_FALSE_VALUE)
441 cmp = invert_tree_comparison (cmp, false);
443 refine_value_range_using_guard (type, var, c0, cmp, c1, minm, maxm);
444 ++cnt;
447 mpz_add (minm, minm, off);
448 mpz_add (maxm, maxm, off);
449 /* If the computation may not wrap or off is zero, then this
450 is always fine. If off is negative and minv + off isn't
451 smaller than type's minimum, or off is positive and
452 maxv + off isn't bigger than type's maximum, use the more
453 precise range too. */
454 if (nowrap_type_p (type)
455 || mpz_sgn (off) == 0
456 || (mpz_sgn (off) < 0 && mpz_cmp (minm, min) >= 0)
457 || (mpz_sgn (off) > 0 && mpz_cmp (maxm, max) <= 0))
459 mpz_set (min, minm);
460 mpz_set (max, maxm);
461 mpz_clear (minm);
462 mpz_clear (maxm);
463 return;
465 mpz_clear (minm);
466 mpz_clear (maxm);
469 /* If the computation may wrap, we know nothing about the value, except for
470 the range of the type. */
471 if (!nowrap_type_p (type))
472 return;
474 /* Since the addition of OFF does not wrap, if OFF is positive, then we may
475 add it to MIN, otherwise to MAX. */
476 if (mpz_sgn (off) < 0)
477 mpz_add (max, max, off);
478 else
479 mpz_add (min, min, off);
482 /* Stores the bounds on the difference of the values of the expressions
483 (var + X) and (var + Y), computed in TYPE, to BNDS. */
485 static void
486 bound_difference_of_offsetted_base (tree type, mpz_t x, mpz_t y,
487 bounds *bnds)
489 int rel = mpz_cmp (x, y);
490 bool may_wrap = !nowrap_type_p (type);
491 mpz_t m;
493 /* If X == Y, then the expressions are always equal.
494 If X > Y, there are the following possibilities:
495 a) neither of var + X and var + Y overflow or underflow, or both of
496 them do. Then their difference is X - Y.
497 b) var + X overflows, and var + Y does not. Then the values of the
498 expressions are var + X - M and var + Y, where M is the range of
499 the type, and their difference is X - Y - M.
500 c) var + Y underflows and var + X does not. Their difference again
501 is M - X + Y.
502 Therefore, if the arithmetics in type does not overflow, then the
503 bounds are (X - Y, X - Y), otherwise they are (X - Y - M, X - Y)
504 Similarly, if X < Y, the bounds are either (X - Y, X - Y) or
505 (X - Y, X - Y + M). */
507 if (rel == 0)
509 mpz_set_ui (bnds->below, 0);
510 mpz_set_ui (bnds->up, 0);
511 return;
514 mpz_init (m);
515 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), m, UNSIGNED);
516 mpz_add_ui (m, m, 1);
517 mpz_sub (bnds->up, x, y);
518 mpz_set (bnds->below, bnds->up);
520 if (may_wrap)
522 if (rel > 0)
523 mpz_sub (bnds->below, bnds->below, m);
524 else
525 mpz_add (bnds->up, bnds->up, m);
528 mpz_clear (m);
531 /* From condition C0 CMP C1 derives information regarding the
532 difference of values of VARX + OFFX and VARY + OFFY, computed in TYPE,
533 and stores it to BNDS. */
535 static void
536 refine_bounds_using_guard (tree type, tree varx, mpz_t offx,
537 tree vary, mpz_t offy,
538 tree c0, enum tree_code cmp, tree c1,
539 bounds *bnds)
541 tree varc0, varc1, ctype;
542 mpz_t offc0, offc1, loffx, loffy, bnd;
543 bool lbound = false;
544 bool no_wrap = nowrap_type_p (type);
545 bool x_ok, y_ok;
547 switch (cmp)
549 case LT_EXPR:
550 case LE_EXPR:
551 case GT_EXPR:
552 case GE_EXPR:
553 STRIP_SIGN_NOPS (c0);
554 STRIP_SIGN_NOPS (c1);
555 ctype = TREE_TYPE (c0);
556 if (!useless_type_conversion_p (ctype, type))
557 return;
559 break;
561 case EQ_EXPR:
562 /* We could derive quite precise information from EQ_EXPR, however, such
563 a guard is unlikely to appear, so we do not bother with handling
564 it. */
565 return;
567 case NE_EXPR:
568 /* NE_EXPR comparisons do not contain much of useful information, except for
569 special case of comparing with the bounds of the type. */
570 if (TREE_CODE (c1) != INTEGER_CST
571 || !INTEGRAL_TYPE_P (type))
572 return;
574 /* Ensure that the condition speaks about an expression in the same type
575 as X and Y. */
576 ctype = TREE_TYPE (c0);
577 if (TYPE_PRECISION (ctype) != TYPE_PRECISION (type))
578 return;
579 c0 = fold_convert (type, c0);
580 c1 = fold_convert (type, c1);
582 if (TYPE_MIN_VALUE (type)
583 && operand_equal_p (c1, TYPE_MIN_VALUE (type), 0))
585 cmp = GT_EXPR;
586 break;
588 if (TYPE_MAX_VALUE (type)
589 && operand_equal_p (c1, TYPE_MAX_VALUE (type), 0))
591 cmp = LT_EXPR;
592 break;
595 return;
596 default:
597 return;
600 mpz_init (offc0);
601 mpz_init (offc1);
602 split_to_var_and_offset (expand_simple_operations (c0), &varc0, offc0);
603 split_to_var_and_offset (expand_simple_operations (c1), &varc1, offc1);
605 /* We are only interested in comparisons of expressions based on VARX and
606 VARY. TODO -- we might also be able to derive some bounds from
607 expressions containing just one of the variables. */
609 if (operand_equal_p (varx, varc1, 0))
611 std::swap (varc0, varc1);
612 mpz_swap (offc0, offc1);
613 cmp = swap_tree_comparison (cmp);
616 if (!operand_equal_p (varx, varc0, 0)
617 || !operand_equal_p (vary, varc1, 0))
618 goto end;
620 mpz_init_set (loffx, offx);
621 mpz_init_set (loffy, offy);
623 if (cmp == GT_EXPR || cmp == GE_EXPR)
625 std::swap (varx, vary);
626 mpz_swap (offc0, offc1);
627 mpz_swap (loffx, loffy);
628 cmp = swap_tree_comparison (cmp);
629 lbound = true;
632 /* If there is no overflow, the condition implies that
634 (VARX + OFFX) cmp (VARY + OFFY) + (OFFX - OFFY + OFFC1 - OFFC0).
636 The overflows and underflows may complicate things a bit; each
637 overflow decreases the appropriate offset by M, and underflow
638 increases it by M. The above inequality would not necessarily be
639 true if
641 -- VARX + OFFX underflows and VARX + OFFC0 does not, or
642 VARX + OFFC0 overflows, but VARX + OFFX does not.
643 This may only happen if OFFX < OFFC0.
644 -- VARY + OFFY overflows and VARY + OFFC1 does not, or
645 VARY + OFFC1 underflows and VARY + OFFY does not.
646 This may only happen if OFFY > OFFC1. */
648 if (no_wrap)
650 x_ok = true;
651 y_ok = true;
653 else
655 x_ok = (integer_zerop (varx)
656 || mpz_cmp (loffx, offc0) >= 0);
657 y_ok = (integer_zerop (vary)
658 || mpz_cmp (loffy, offc1) <= 0);
661 if (x_ok && y_ok)
663 mpz_init (bnd);
664 mpz_sub (bnd, loffx, loffy);
665 mpz_add (bnd, bnd, offc1);
666 mpz_sub (bnd, bnd, offc0);
668 if (cmp == LT_EXPR)
669 mpz_sub_ui (bnd, bnd, 1);
671 if (lbound)
673 mpz_neg (bnd, bnd);
674 if (mpz_cmp (bnds->below, bnd) < 0)
675 mpz_set (bnds->below, bnd);
677 else
679 if (mpz_cmp (bnd, bnds->up) < 0)
680 mpz_set (bnds->up, bnd);
682 mpz_clear (bnd);
685 mpz_clear (loffx);
686 mpz_clear (loffy);
687 end:
688 mpz_clear (offc0);
689 mpz_clear (offc1);
692 /* Stores the bounds on the value of the expression X - Y in LOOP to BNDS.
693 The subtraction is considered to be performed in arbitrary precision,
694 without overflows.
696 We do not attempt to be too clever regarding the value ranges of X and
697 Y; most of the time, they are just integers or ssa names offsetted by
698 integer. However, we try to use the information contained in the
699 comparisons before the loop (usually created by loop header copying). */
701 static void
702 bound_difference (struct loop *loop, tree x, tree y, bounds *bnds)
704 tree type = TREE_TYPE (x);
705 tree varx, vary;
706 mpz_t offx, offy;
707 mpz_t minx, maxx, miny, maxy;
708 int cnt = 0;
709 edge e;
710 basic_block bb;
711 tree c0, c1;
712 gimple *cond;
713 enum tree_code cmp;
715 /* Get rid of unnecessary casts, but preserve the value of
716 the expressions. */
717 STRIP_SIGN_NOPS (x);
718 STRIP_SIGN_NOPS (y);
720 mpz_init (bnds->below);
721 mpz_init (bnds->up);
722 mpz_init (offx);
723 mpz_init (offy);
724 split_to_var_and_offset (x, &varx, offx);
725 split_to_var_and_offset (y, &vary, offy);
727 if (!integer_zerop (varx)
728 && operand_equal_p (varx, vary, 0))
730 /* Special case VARX == VARY -- we just need to compare the
731 offsets. The matters are a bit more complicated in the
732 case addition of offsets may wrap. */
733 bound_difference_of_offsetted_base (type, offx, offy, bnds);
735 else
737 /* Otherwise, use the value ranges to determine the initial
738 estimates on below and up. */
739 mpz_init (minx);
740 mpz_init (maxx);
741 mpz_init (miny);
742 mpz_init (maxy);
743 determine_value_range (loop, type, varx, offx, minx, maxx);
744 determine_value_range (loop, type, vary, offy, miny, maxy);
746 mpz_sub (bnds->below, minx, maxy);
747 mpz_sub (bnds->up, maxx, miny);
748 mpz_clear (minx);
749 mpz_clear (maxx);
750 mpz_clear (miny);
751 mpz_clear (maxy);
754 /* If both X and Y are constants, we cannot get any more precise. */
755 if (integer_zerop (varx) && integer_zerop (vary))
756 goto end;
758 /* Now walk the dominators of the loop header and use the entry
759 guards to refine the estimates. */
760 for (bb = loop->header;
761 bb != ENTRY_BLOCK_PTR_FOR_FN (cfun) && cnt < MAX_DOMINATORS_TO_WALK;
762 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
764 if (!single_pred_p (bb))
765 continue;
766 e = single_pred_edge (bb);
768 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
769 continue;
771 cond = last_stmt (e->src);
772 c0 = gimple_cond_lhs (cond);
773 cmp = gimple_cond_code (cond);
774 c1 = gimple_cond_rhs (cond);
776 if (e->flags & EDGE_FALSE_VALUE)
777 cmp = invert_tree_comparison (cmp, false);
779 refine_bounds_using_guard (type, varx, offx, vary, offy,
780 c0, cmp, c1, bnds);
781 ++cnt;
784 end:
785 mpz_clear (offx);
786 mpz_clear (offy);
789 /* Update the bounds in BNDS that restrict the value of X to the bounds
790 that restrict the value of X + DELTA. X can be obtained as a
791 difference of two values in TYPE. */
793 static void
794 bounds_add (bounds *bnds, const widest_int &delta, tree type)
796 mpz_t mdelta, max;
798 mpz_init (mdelta);
799 wi::to_mpz (delta, mdelta, SIGNED);
801 mpz_init (max);
802 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), max, UNSIGNED);
804 mpz_add (bnds->up, bnds->up, mdelta);
805 mpz_add (bnds->below, bnds->below, mdelta);
807 if (mpz_cmp (bnds->up, max) > 0)
808 mpz_set (bnds->up, max);
810 mpz_neg (max, max);
811 if (mpz_cmp (bnds->below, max) < 0)
812 mpz_set (bnds->below, max);
814 mpz_clear (mdelta);
815 mpz_clear (max);
818 /* Update the bounds in BNDS that restrict the value of X to the bounds
819 that restrict the value of -X. */
821 static void
822 bounds_negate (bounds *bnds)
824 mpz_t tmp;
826 mpz_init_set (tmp, bnds->up);
827 mpz_neg (bnds->up, bnds->below);
828 mpz_neg (bnds->below, tmp);
829 mpz_clear (tmp);
832 /* Returns inverse of X modulo 2^s, where MASK = 2^s-1. */
834 static tree
835 inverse (tree x, tree mask)
837 tree type = TREE_TYPE (x);
838 tree rslt;
839 unsigned ctr = tree_floor_log2 (mask);
841 if (TYPE_PRECISION (type) <= HOST_BITS_PER_WIDE_INT)
843 unsigned HOST_WIDE_INT ix;
844 unsigned HOST_WIDE_INT imask;
845 unsigned HOST_WIDE_INT irslt = 1;
847 gcc_assert (cst_and_fits_in_hwi (x));
848 gcc_assert (cst_and_fits_in_hwi (mask));
850 ix = int_cst_value (x);
851 imask = int_cst_value (mask);
853 for (; ctr; ctr--)
855 irslt *= ix;
856 ix *= ix;
858 irslt &= imask;
860 rslt = build_int_cst_type (type, irslt);
862 else
864 rslt = build_int_cst (type, 1);
865 for (; ctr; ctr--)
867 rslt = int_const_binop (MULT_EXPR, rslt, x);
868 x = int_const_binop (MULT_EXPR, x, x);
870 rslt = int_const_binop (BIT_AND_EXPR, rslt, mask);
873 return rslt;
876 /* Derives the upper bound BND on the number of executions of loop with exit
877 condition S * i <> C. If NO_OVERFLOW is true, then the control variable of
878 the loop does not overflow. EXIT_MUST_BE_TAKEN is true if we are guaranteed
879 that the loop ends through this exit, i.e., the induction variable ever
880 reaches the value of C.
882 The value C is equal to final - base, where final and base are the final and
883 initial value of the actual induction variable in the analysed loop. BNDS
884 bounds the value of this difference when computed in signed type with
885 unbounded range, while the computation of C is performed in an unsigned
886 type with the range matching the range of the type of the induction variable.
887 In particular, BNDS.up contains an upper bound on C in the following cases:
888 -- if the iv must reach its final value without overflow, i.e., if
889 NO_OVERFLOW && EXIT_MUST_BE_TAKEN is true, or
890 -- if final >= base, which we know to hold when BNDS.below >= 0. */
892 static void
893 number_of_iterations_ne_max (mpz_t bnd, bool no_overflow, tree c, tree s,
894 bounds *bnds, bool exit_must_be_taken)
896 widest_int max;
897 mpz_t d;
898 tree type = TREE_TYPE (c);
899 bool bnds_u_valid = ((no_overflow && exit_must_be_taken)
900 || mpz_sgn (bnds->below) >= 0);
902 if (integer_onep (s)
903 || (TREE_CODE (c) == INTEGER_CST
904 && TREE_CODE (s) == INTEGER_CST
905 && wi::mod_trunc (c, s, TYPE_SIGN (type)) == 0)
906 || (TYPE_OVERFLOW_UNDEFINED (type)
907 && multiple_of_p (type, c, s)))
909 /* If C is an exact multiple of S, then its value will be reached before
910 the induction variable overflows (unless the loop is exited in some
911 other way before). Note that the actual induction variable in the
912 loop (which ranges from base to final instead of from 0 to C) may
913 overflow, in which case BNDS.up will not be giving a correct upper
914 bound on C; thus, BNDS_U_VALID had to be computed in advance. */
915 no_overflow = true;
916 exit_must_be_taken = true;
919 /* If the induction variable can overflow, the number of iterations is at
920 most the period of the control variable (or infinite, but in that case
921 the whole # of iterations analysis will fail). */
922 if (!no_overflow)
924 max = wi::mask <widest_int> (TYPE_PRECISION (type) - wi::ctz (s), false);
925 wi::to_mpz (max, bnd, UNSIGNED);
926 return;
929 /* Now we know that the induction variable does not overflow, so the loop
930 iterates at most (range of type / S) times. */
931 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), bnd, UNSIGNED);
933 /* If the induction variable is guaranteed to reach the value of C before
934 overflow, ... */
935 if (exit_must_be_taken)
937 /* ... then we can strengthen this to C / S, and possibly we can use
938 the upper bound on C given by BNDS. */
939 if (TREE_CODE (c) == INTEGER_CST)
940 wi::to_mpz (c, bnd, UNSIGNED);
941 else if (bnds_u_valid)
942 mpz_set (bnd, bnds->up);
945 mpz_init (d);
946 wi::to_mpz (s, d, UNSIGNED);
947 mpz_fdiv_q (bnd, bnd, d);
948 mpz_clear (d);
951 /* Determines number of iterations of loop whose ending condition
952 is IV <> FINAL. TYPE is the type of the iv. The number of
953 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
954 we know that the exit must be taken eventually, i.e., that the IV
955 ever reaches the value FINAL (we derived this earlier, and possibly set
956 NITER->assumptions to make sure this is the case). BNDS contains the
957 bounds on the difference FINAL - IV->base. */
959 static bool
960 number_of_iterations_ne (struct loop *loop, tree type, affine_iv *iv,
961 tree final, struct tree_niter_desc *niter,
962 bool exit_must_be_taken, bounds *bnds)
964 tree niter_type = unsigned_type_for (type);
965 tree s, c, d, bits, assumption, tmp, bound;
966 mpz_t max;
968 niter->control = *iv;
969 niter->bound = final;
970 niter->cmp = NE_EXPR;
972 /* Rearrange the terms so that we get inequality S * i <> C, with S
973 positive. Also cast everything to the unsigned type. If IV does
974 not overflow, BNDS bounds the value of C. Also, this is the
975 case if the computation |FINAL - IV->base| does not overflow, i.e.,
976 if BNDS->below in the result is nonnegative. */
977 if (tree_int_cst_sign_bit (iv->step))
979 s = fold_convert (niter_type,
980 fold_build1 (NEGATE_EXPR, type, iv->step));
981 c = fold_build2 (MINUS_EXPR, niter_type,
982 fold_convert (niter_type, iv->base),
983 fold_convert (niter_type, final));
984 bounds_negate (bnds);
986 else
988 s = fold_convert (niter_type, iv->step);
989 c = fold_build2 (MINUS_EXPR, niter_type,
990 fold_convert (niter_type, final),
991 fold_convert (niter_type, iv->base));
994 mpz_init (max);
995 number_of_iterations_ne_max (max, iv->no_overflow, c, s, bnds,
996 exit_must_be_taken);
997 niter->max = widest_int::from (wi::from_mpz (niter_type, max, false),
998 TYPE_SIGN (niter_type));
999 mpz_clear (max);
1001 /* Compute no-overflow information for the control iv. This can be
1002 proven when below two conditions are satisfied:
1004 1) IV evaluates toward FINAL at beginning, i.e:
1005 base <= FINAL ; step > 0
1006 base >= FINAL ; step < 0
1008 2) |FINAL - base| is an exact multiple of step.
1010 Unfortunately, it's hard to prove above conditions after pass loop-ch
1011 because loop with exit condition (IV != FINAL) usually will be guarded
1012 by initial-condition (IV.base - IV.step != FINAL). In this case, we
1013 can alternatively try to prove below conditions:
1015 1') IV evaluates toward FINAL at beginning, i.e:
1016 new_base = base - step < FINAL ; step > 0
1017 && base - step doesn't underflow
1018 new_base = base - step > FINAL ; step < 0
1019 && base - step doesn't overflow
1021 2') |FINAL - new_base| is an exact multiple of step.
1023 Please refer to PR34114 as an example of loop-ch's impact, also refer
1024 to PR72817 as an example why condition 2') is necessary.
1026 Note, for NE_EXPR, base equals to FINAL is a special case, in
1027 which the loop exits immediately, and the iv does not overflow. */
1028 if (!niter->control.no_overflow
1029 && (integer_onep (s) || multiple_of_p (type, c, s)))
1031 tree t, cond, new_c, relaxed_cond = boolean_false_node;
1033 if (tree_int_cst_sign_bit (iv->step))
1035 cond = fold_build2 (GE_EXPR, boolean_type_node, iv->base, final);
1036 if (TREE_CODE (type) == INTEGER_TYPE)
1038 /* Only when base - step doesn't overflow. */
1039 t = TYPE_MAX_VALUE (type);
1040 t = fold_build2 (PLUS_EXPR, type, t, iv->step);
1041 t = fold_build2 (GE_EXPR, boolean_type_node, t, iv->base);
1042 if (integer_nonzerop (t))
1044 t = fold_build2 (MINUS_EXPR, type, iv->base, iv->step);
1045 new_c = fold_build2 (MINUS_EXPR, niter_type,
1046 fold_convert (niter_type, t),
1047 fold_convert (niter_type, final));
1048 if (multiple_of_p (type, new_c, s))
1049 relaxed_cond = fold_build2 (GT_EXPR, boolean_type_node,
1050 t, final);
1054 else
1056 cond = fold_build2 (LE_EXPR, boolean_type_node, iv->base, final);
1057 if (TREE_CODE (type) == INTEGER_TYPE)
1059 /* Only when base - step doesn't underflow. */
1060 t = TYPE_MIN_VALUE (type);
1061 t = fold_build2 (PLUS_EXPR, type, t, iv->step);
1062 t = fold_build2 (LE_EXPR, boolean_type_node, t, iv->base);
1063 if (integer_nonzerop (t))
1065 t = fold_build2 (MINUS_EXPR, type, iv->base, iv->step);
1066 new_c = fold_build2 (MINUS_EXPR, niter_type,
1067 fold_convert (niter_type, final),
1068 fold_convert (niter_type, t));
1069 if (multiple_of_p (type, new_c, s))
1070 relaxed_cond = fold_build2 (LT_EXPR, boolean_type_node,
1071 t, final);
1076 t = simplify_using_initial_conditions (loop, cond);
1077 if (!t || !integer_onep (t))
1078 t = simplify_using_initial_conditions (loop, relaxed_cond);
1080 if (t && integer_onep (t))
1081 niter->control.no_overflow = true;
1084 /* First the trivial cases -- when the step is 1. */
1085 if (integer_onep (s))
1087 niter->niter = c;
1088 return true;
1090 if (niter->control.no_overflow && multiple_of_p (type, c, s))
1092 niter->niter = fold_build2 (FLOOR_DIV_EXPR, niter_type, c, s);
1093 return true;
1096 /* Let nsd (step, size of mode) = d. If d does not divide c, the loop
1097 is infinite. Otherwise, the number of iterations is
1098 (inverse(s/d) * (c/d)) mod (size of mode/d). */
1099 bits = num_ending_zeros (s);
1100 bound = build_low_bits_mask (niter_type,
1101 (TYPE_PRECISION (niter_type)
1102 - tree_to_uhwi (bits)));
1104 d = fold_binary_to_constant (LSHIFT_EXPR, niter_type,
1105 build_int_cst (niter_type, 1), bits);
1106 s = fold_binary_to_constant (RSHIFT_EXPR, niter_type, s, bits);
1108 if (!exit_must_be_taken)
1110 /* If we cannot assume that the exit is taken eventually, record the
1111 assumptions for divisibility of c. */
1112 assumption = fold_build2 (FLOOR_MOD_EXPR, niter_type, c, d);
1113 assumption = fold_build2 (EQ_EXPR, boolean_type_node,
1114 assumption, build_int_cst (niter_type, 0));
1115 if (!integer_nonzerop (assumption))
1116 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1117 niter->assumptions, assumption);
1120 c = fold_build2 (EXACT_DIV_EXPR, niter_type, c, d);
1121 tmp = fold_build2 (MULT_EXPR, niter_type, c, inverse (s, bound));
1122 niter->niter = fold_build2 (BIT_AND_EXPR, niter_type, tmp, bound);
1123 return true;
1126 /* Checks whether we can determine the final value of the control variable
1127 of the loop with ending condition IV0 < IV1 (computed in TYPE).
1128 DELTA is the difference IV1->base - IV0->base, STEP is the absolute value
1129 of the step. The assumptions necessary to ensure that the computation
1130 of the final value does not overflow are recorded in NITER. If we
1131 find the final value, we adjust DELTA and return TRUE. Otherwise
1132 we return false. BNDS bounds the value of IV1->base - IV0->base,
1133 and will be updated by the same amount as DELTA. EXIT_MUST_BE_TAKEN is
1134 true if we know that the exit must be taken eventually. */
1136 static bool
1137 number_of_iterations_lt_to_ne (tree type, affine_iv *iv0, affine_iv *iv1,
1138 struct tree_niter_desc *niter,
1139 tree *delta, tree step,
1140 bool exit_must_be_taken, bounds *bnds)
1142 tree niter_type = TREE_TYPE (step);
1143 tree mod = fold_build2 (FLOOR_MOD_EXPR, niter_type, *delta, step);
1144 tree tmod;
1145 mpz_t mmod;
1146 tree assumption = boolean_true_node, bound, noloop;
1147 bool ret = false, fv_comp_no_overflow;
1148 tree type1 = type;
1149 if (POINTER_TYPE_P (type))
1150 type1 = sizetype;
1152 if (TREE_CODE (mod) != INTEGER_CST)
1153 return false;
1154 if (integer_nonzerop (mod))
1155 mod = fold_build2 (MINUS_EXPR, niter_type, step, mod);
1156 tmod = fold_convert (type1, mod);
1158 mpz_init (mmod);
1159 wi::to_mpz (mod, mmod, UNSIGNED);
1160 mpz_neg (mmod, mmod);
1162 /* If the induction variable does not overflow and the exit is taken,
1163 then the computation of the final value does not overflow. This is
1164 also obviously the case if the new final value is equal to the
1165 current one. Finally, we postulate this for pointer type variables,
1166 as the code cannot rely on the object to that the pointer points being
1167 placed at the end of the address space (and more pragmatically,
1168 TYPE_{MIN,MAX}_VALUE is not defined for pointers). */
1169 if (integer_zerop (mod) || POINTER_TYPE_P (type))
1170 fv_comp_no_overflow = true;
1171 else if (!exit_must_be_taken)
1172 fv_comp_no_overflow = false;
1173 else
1174 fv_comp_no_overflow =
1175 (iv0->no_overflow && integer_nonzerop (iv0->step))
1176 || (iv1->no_overflow && integer_nonzerop (iv1->step));
1178 if (integer_nonzerop (iv0->step))
1180 /* The final value of the iv is iv1->base + MOD, assuming that this
1181 computation does not overflow, and that
1182 iv0->base <= iv1->base + MOD. */
1183 if (!fv_comp_no_overflow)
1185 bound = fold_build2 (MINUS_EXPR, type1,
1186 TYPE_MAX_VALUE (type1), tmod);
1187 assumption = fold_build2 (LE_EXPR, boolean_type_node,
1188 iv1->base, bound);
1189 if (integer_zerop (assumption))
1190 goto end;
1192 if (mpz_cmp (mmod, bnds->below) < 0)
1193 noloop = boolean_false_node;
1194 else if (POINTER_TYPE_P (type))
1195 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1196 iv0->base,
1197 fold_build_pointer_plus (iv1->base, tmod));
1198 else
1199 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1200 iv0->base,
1201 fold_build2 (PLUS_EXPR, type1,
1202 iv1->base, tmod));
1204 else
1206 /* The final value of the iv is iv0->base - MOD, assuming that this
1207 computation does not overflow, and that
1208 iv0->base - MOD <= iv1->base. */
1209 if (!fv_comp_no_overflow)
1211 bound = fold_build2 (PLUS_EXPR, type1,
1212 TYPE_MIN_VALUE (type1), tmod);
1213 assumption = fold_build2 (GE_EXPR, boolean_type_node,
1214 iv0->base, bound);
1215 if (integer_zerop (assumption))
1216 goto end;
1218 if (mpz_cmp (mmod, bnds->below) < 0)
1219 noloop = boolean_false_node;
1220 else if (POINTER_TYPE_P (type))
1221 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1222 fold_build_pointer_plus (iv0->base,
1223 fold_build1 (NEGATE_EXPR,
1224 type1, tmod)),
1225 iv1->base);
1226 else
1227 noloop = fold_build2 (GT_EXPR, boolean_type_node,
1228 fold_build2 (MINUS_EXPR, type1,
1229 iv0->base, tmod),
1230 iv1->base);
1233 if (!integer_nonzerop (assumption))
1234 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1235 niter->assumptions,
1236 assumption);
1237 if (!integer_zerop (noloop))
1238 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
1239 niter->may_be_zero,
1240 noloop);
1241 bounds_add (bnds, wi::to_widest (mod), type);
1242 *delta = fold_build2 (PLUS_EXPR, niter_type, *delta, mod);
1244 ret = true;
1245 end:
1246 mpz_clear (mmod);
1247 return ret;
1250 /* Add assertions to NITER that ensure that the control variable of the loop
1251 with ending condition IV0 < IV1 does not overflow. Types of IV0 and IV1
1252 are TYPE. Returns false if we can prove that there is an overflow, true
1253 otherwise. STEP is the absolute value of the step. */
1255 static bool
1256 assert_no_overflow_lt (tree type, affine_iv *iv0, affine_iv *iv1,
1257 struct tree_niter_desc *niter, tree step)
1259 tree bound, d, assumption, diff;
1260 tree niter_type = TREE_TYPE (step);
1262 if (integer_nonzerop (iv0->step))
1264 /* for (i = iv0->base; i < iv1->base; i += iv0->step) */
1265 if (iv0->no_overflow)
1266 return true;
1268 /* If iv0->base is a constant, we can determine the last value before
1269 overflow precisely; otherwise we conservatively assume
1270 MAX - STEP + 1. */
1272 if (TREE_CODE (iv0->base) == INTEGER_CST)
1274 d = fold_build2 (MINUS_EXPR, niter_type,
1275 fold_convert (niter_type, TYPE_MAX_VALUE (type)),
1276 fold_convert (niter_type, iv0->base));
1277 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
1279 else
1280 diff = fold_build2 (MINUS_EXPR, niter_type, step,
1281 build_int_cst (niter_type, 1));
1282 bound = fold_build2 (MINUS_EXPR, type,
1283 TYPE_MAX_VALUE (type), fold_convert (type, diff));
1284 assumption = fold_build2 (LE_EXPR, boolean_type_node,
1285 iv1->base, bound);
1287 else
1289 /* for (i = iv1->base; i > iv0->base; i += iv1->step) */
1290 if (iv1->no_overflow)
1291 return true;
1293 if (TREE_CODE (iv1->base) == INTEGER_CST)
1295 d = fold_build2 (MINUS_EXPR, niter_type,
1296 fold_convert (niter_type, iv1->base),
1297 fold_convert (niter_type, TYPE_MIN_VALUE (type)));
1298 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
1300 else
1301 diff = fold_build2 (MINUS_EXPR, niter_type, step,
1302 build_int_cst (niter_type, 1));
1303 bound = fold_build2 (PLUS_EXPR, type,
1304 TYPE_MIN_VALUE (type), fold_convert (type, diff));
1305 assumption = fold_build2 (GE_EXPR, boolean_type_node,
1306 iv0->base, bound);
1309 if (integer_zerop (assumption))
1310 return false;
1311 if (!integer_nonzerop (assumption))
1312 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1313 niter->assumptions, assumption);
1315 iv0->no_overflow = true;
1316 iv1->no_overflow = true;
1317 return true;
1320 /* Add an assumption to NITER that a loop whose ending condition
1321 is IV0 < IV1 rolls. TYPE is the type of the control iv. BNDS
1322 bounds the value of IV1->base - IV0->base. */
1324 static void
1325 assert_loop_rolls_lt (tree type, affine_iv *iv0, affine_iv *iv1,
1326 struct tree_niter_desc *niter, bounds *bnds)
1328 tree assumption = boolean_true_node, bound, diff;
1329 tree mbz, mbzl, mbzr, type1;
1330 bool rolls_p, no_overflow_p;
1331 widest_int dstep;
1332 mpz_t mstep, max;
1334 /* We are going to compute the number of iterations as
1335 (iv1->base - iv0->base + step - 1) / step, computed in the unsigned
1336 variant of TYPE. This formula only works if
1338 -step + 1 <= (iv1->base - iv0->base) <= MAX - step + 1
1340 (where MAX is the maximum value of the unsigned variant of TYPE, and
1341 the computations in this formula are performed in full precision,
1342 i.e., without overflows).
1344 Usually, for loops with exit condition iv0->base + step * i < iv1->base,
1345 we have a condition of the form iv0->base - step < iv1->base before the loop,
1346 and for loops iv0->base < iv1->base - step * i the condition
1347 iv0->base < iv1->base + step, due to loop header copying, which enable us
1348 to prove the lower bound.
1350 The upper bound is more complicated. Unless the expressions for initial
1351 and final value themselves contain enough information, we usually cannot
1352 derive it from the context. */
1354 /* First check whether the answer does not follow from the bounds we gathered
1355 before. */
1356 if (integer_nonzerop (iv0->step))
1357 dstep = wi::to_widest (iv0->step);
1358 else
1360 dstep = wi::sext (wi::to_widest (iv1->step), TYPE_PRECISION (type));
1361 dstep = -dstep;
1364 mpz_init (mstep);
1365 wi::to_mpz (dstep, mstep, UNSIGNED);
1366 mpz_neg (mstep, mstep);
1367 mpz_add_ui (mstep, mstep, 1);
1369 rolls_p = mpz_cmp (mstep, bnds->below) <= 0;
1371 mpz_init (max);
1372 wi::to_mpz (wi::minus_one (TYPE_PRECISION (type)), max, UNSIGNED);
1373 mpz_add (max, max, mstep);
1374 no_overflow_p = (mpz_cmp (bnds->up, max) <= 0
1375 /* For pointers, only values lying inside a single object
1376 can be compared or manipulated by pointer arithmetics.
1377 Gcc in general does not allow or handle objects larger
1378 than half of the address space, hence the upper bound
1379 is satisfied for pointers. */
1380 || POINTER_TYPE_P (type));
1381 mpz_clear (mstep);
1382 mpz_clear (max);
1384 if (rolls_p && no_overflow_p)
1385 return;
1387 type1 = type;
1388 if (POINTER_TYPE_P (type))
1389 type1 = sizetype;
1391 /* Now the hard part; we must formulate the assumption(s) as expressions, and
1392 we must be careful not to introduce overflow. */
1394 if (integer_nonzerop (iv0->step))
1396 diff = fold_build2 (MINUS_EXPR, type1,
1397 iv0->step, build_int_cst (type1, 1));
1399 /* We need to know that iv0->base >= MIN + iv0->step - 1. Since
1400 0 address never belongs to any object, we can assume this for
1401 pointers. */
1402 if (!POINTER_TYPE_P (type))
1404 bound = fold_build2 (PLUS_EXPR, type1,
1405 TYPE_MIN_VALUE (type), diff);
1406 assumption = fold_build2 (GE_EXPR, boolean_type_node,
1407 iv0->base, bound);
1410 /* And then we can compute iv0->base - diff, and compare it with
1411 iv1->base. */
1412 mbzl = fold_build2 (MINUS_EXPR, type1,
1413 fold_convert (type1, iv0->base), diff);
1414 mbzr = fold_convert (type1, iv1->base);
1416 else
1418 diff = fold_build2 (PLUS_EXPR, type1,
1419 iv1->step, build_int_cst (type1, 1));
1421 if (!POINTER_TYPE_P (type))
1423 bound = fold_build2 (PLUS_EXPR, type1,
1424 TYPE_MAX_VALUE (type), diff);
1425 assumption = fold_build2 (LE_EXPR, boolean_type_node,
1426 iv1->base, bound);
1429 mbzl = fold_convert (type1, iv0->base);
1430 mbzr = fold_build2 (MINUS_EXPR, type1,
1431 fold_convert (type1, iv1->base), diff);
1434 if (!integer_nonzerop (assumption))
1435 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1436 niter->assumptions, assumption);
1437 if (!rolls_p)
1439 mbz = fold_build2 (GT_EXPR, boolean_type_node, mbzl, mbzr);
1440 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
1441 niter->may_be_zero, mbz);
1445 /* Determines number of iterations of loop whose ending condition
1446 is IV0 < IV1. TYPE is the type of the iv. The number of
1447 iterations is stored to NITER. BNDS bounds the difference
1448 IV1->base - IV0->base. EXIT_MUST_BE_TAKEN is true if we know
1449 that the exit must be taken eventually. */
1451 static bool
1452 number_of_iterations_lt (struct loop *loop, tree type, affine_iv *iv0,
1453 affine_iv *iv1, struct tree_niter_desc *niter,
1454 bool exit_must_be_taken, bounds *bnds)
1456 tree niter_type = unsigned_type_for (type);
1457 tree delta, step, s;
1458 mpz_t mstep, tmp;
1460 if (integer_nonzerop (iv0->step))
1462 niter->control = *iv0;
1463 niter->cmp = LT_EXPR;
1464 niter->bound = iv1->base;
1466 else
1468 niter->control = *iv1;
1469 niter->cmp = GT_EXPR;
1470 niter->bound = iv0->base;
1473 delta = fold_build2 (MINUS_EXPR, niter_type,
1474 fold_convert (niter_type, iv1->base),
1475 fold_convert (niter_type, iv0->base));
1477 /* First handle the special case that the step is +-1. */
1478 if ((integer_onep (iv0->step) && integer_zerop (iv1->step))
1479 || (integer_all_onesp (iv1->step) && integer_zerop (iv0->step)))
1481 /* for (i = iv0->base; i < iv1->base; i++)
1485 for (i = iv1->base; i > iv0->base; i--).
1487 In both cases # of iterations is iv1->base - iv0->base, assuming that
1488 iv1->base >= iv0->base.
1490 First try to derive a lower bound on the value of
1491 iv1->base - iv0->base, computed in full precision. If the difference
1492 is nonnegative, we are done, otherwise we must record the
1493 condition. */
1495 if (mpz_sgn (bnds->below) < 0)
1496 niter->may_be_zero = fold_build2 (LT_EXPR, boolean_type_node,
1497 iv1->base, iv0->base);
1498 niter->niter = delta;
1499 niter->max = widest_int::from (wi::from_mpz (niter_type, bnds->up, false),
1500 TYPE_SIGN (niter_type));
1501 niter->control.no_overflow = true;
1502 return true;
1505 if (integer_nonzerop (iv0->step))
1506 step = fold_convert (niter_type, iv0->step);
1507 else
1508 step = fold_convert (niter_type,
1509 fold_build1 (NEGATE_EXPR, type, iv1->step));
1511 /* If we can determine the final value of the control iv exactly, we can
1512 transform the condition to != comparison. In particular, this will be
1513 the case if DELTA is constant. */
1514 if (number_of_iterations_lt_to_ne (type, iv0, iv1, niter, &delta, step,
1515 exit_must_be_taken, bnds))
1517 affine_iv zps;
1519 zps.base = build_int_cst (niter_type, 0);
1520 zps.step = step;
1521 /* number_of_iterations_lt_to_ne will add assumptions that ensure that
1522 zps does not overflow. */
1523 zps.no_overflow = true;
1525 return number_of_iterations_ne (loop, type, &zps,
1526 delta, niter, true, bnds);
1529 /* Make sure that the control iv does not overflow. */
1530 if (!assert_no_overflow_lt (type, iv0, iv1, niter, step))
1531 return false;
1533 /* We determine the number of iterations as (delta + step - 1) / step. For
1534 this to work, we must know that iv1->base >= iv0->base - step + 1,
1535 otherwise the loop does not roll. */
1536 assert_loop_rolls_lt (type, iv0, iv1, niter, bnds);
1538 s = fold_build2 (MINUS_EXPR, niter_type,
1539 step, build_int_cst (niter_type, 1));
1540 delta = fold_build2 (PLUS_EXPR, niter_type, delta, s);
1541 niter->niter = fold_build2 (FLOOR_DIV_EXPR, niter_type, delta, step);
1543 mpz_init (mstep);
1544 mpz_init (tmp);
1545 wi::to_mpz (step, mstep, UNSIGNED);
1546 mpz_add (tmp, bnds->up, mstep);
1547 mpz_sub_ui (tmp, tmp, 1);
1548 mpz_fdiv_q (tmp, tmp, mstep);
1549 niter->max = widest_int::from (wi::from_mpz (niter_type, tmp, false),
1550 TYPE_SIGN (niter_type));
1551 mpz_clear (mstep);
1552 mpz_clear (tmp);
1554 return true;
1557 /* Determines number of iterations of loop whose ending condition
1558 is IV0 <= IV1. TYPE is the type of the iv. The number of
1559 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
1560 we know that this condition must eventually become false (we derived this
1561 earlier, and possibly set NITER->assumptions to make sure this
1562 is the case). BNDS bounds the difference IV1->base - IV0->base. */
1564 static bool
1565 number_of_iterations_le (struct loop *loop, tree type, affine_iv *iv0,
1566 affine_iv *iv1, struct tree_niter_desc *niter,
1567 bool exit_must_be_taken, bounds *bnds)
1569 tree assumption;
1570 tree type1 = type;
1571 if (POINTER_TYPE_P (type))
1572 type1 = sizetype;
1574 /* Say that IV0 is the control variable. Then IV0 <= IV1 iff
1575 IV0 < IV1 + 1, assuming that IV1 is not equal to the greatest
1576 value of the type. This we must know anyway, since if it is
1577 equal to this value, the loop rolls forever. We do not check
1578 this condition for pointer type ivs, as the code cannot rely on
1579 the object to that the pointer points being placed at the end of
1580 the address space (and more pragmatically, TYPE_{MIN,MAX}_VALUE is
1581 not defined for pointers). */
1583 if (!exit_must_be_taken && !POINTER_TYPE_P (type))
1585 if (integer_nonzerop (iv0->step))
1586 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1587 iv1->base, TYPE_MAX_VALUE (type));
1588 else
1589 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1590 iv0->base, TYPE_MIN_VALUE (type));
1592 if (integer_zerop (assumption))
1593 return false;
1594 if (!integer_nonzerop (assumption))
1595 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1596 niter->assumptions, assumption);
1599 if (integer_nonzerop (iv0->step))
1601 if (POINTER_TYPE_P (type))
1602 iv1->base = fold_build_pointer_plus_hwi (iv1->base, 1);
1603 else
1604 iv1->base = fold_build2 (PLUS_EXPR, type1, iv1->base,
1605 build_int_cst (type1, 1));
1607 else if (POINTER_TYPE_P (type))
1608 iv0->base = fold_build_pointer_plus_hwi (iv0->base, -1);
1609 else
1610 iv0->base = fold_build2 (MINUS_EXPR, type1,
1611 iv0->base, build_int_cst (type1, 1));
1613 bounds_add (bnds, 1, type1);
1615 return number_of_iterations_lt (loop, type, iv0, iv1, niter, exit_must_be_taken,
1616 bnds);
1619 /* Dumps description of affine induction variable IV to FILE. */
1621 static void
1622 dump_affine_iv (FILE *file, affine_iv *iv)
1624 if (!integer_zerop (iv->step))
1625 fprintf (file, "[");
1627 print_generic_expr (dump_file, iv->base, TDF_SLIM);
1629 if (!integer_zerop (iv->step))
1631 fprintf (file, ", + , ");
1632 print_generic_expr (dump_file, iv->step, TDF_SLIM);
1633 fprintf (file, "]%s", iv->no_overflow ? "(no_overflow)" : "");
1637 /* Determine the number of iterations according to condition (for staying
1638 inside loop) which compares two induction variables using comparison
1639 operator CODE. The induction variable on left side of the comparison
1640 is IV0, the right-hand side is IV1. Both induction variables must have
1641 type TYPE, which must be an integer or pointer type. The steps of the
1642 ivs must be constants (or NULL_TREE, which is interpreted as constant zero).
1644 LOOP is the loop whose number of iterations we are determining.
1646 ONLY_EXIT is true if we are sure this is the only way the loop could be
1647 exited (including possibly non-returning function calls, exceptions, etc.)
1648 -- in this case we can use the information whether the control induction
1649 variables can overflow or not in a more efficient way.
1651 if EVERY_ITERATION is true, we know the test is executed on every iteration.
1653 The results (number of iterations and assumptions as described in
1654 comments at struct tree_niter_desc in tree-ssa-loop.h) are stored to NITER.
1655 Returns false if it fails to determine number of iterations, true if it
1656 was determined (possibly with some assumptions). */
1658 static bool
1659 number_of_iterations_cond (struct loop *loop,
1660 tree type, affine_iv *iv0, enum tree_code code,
1661 affine_iv *iv1, struct tree_niter_desc *niter,
1662 bool only_exit, bool every_iteration)
1664 bool exit_must_be_taken = false, ret;
1665 bounds bnds;
1667 /* If the test is not executed every iteration, wrapping may make the test
1668 to pass again.
1669 TODO: the overflow case can be still used as unreliable estimate of upper
1670 bound. But we have no API to pass it down to number of iterations code
1671 and, at present, it will not use it anyway. */
1672 if (!every_iteration
1673 && (!iv0->no_overflow || !iv1->no_overflow
1674 || code == NE_EXPR || code == EQ_EXPR))
1675 return false;
1677 /* The meaning of these assumptions is this:
1678 if !assumptions
1679 then the rest of information does not have to be valid
1680 if may_be_zero then the loop does not roll, even if
1681 niter != 0. */
1682 niter->assumptions = boolean_true_node;
1683 niter->may_be_zero = boolean_false_node;
1684 niter->niter = NULL_TREE;
1685 niter->max = 0;
1686 niter->bound = NULL_TREE;
1687 niter->cmp = ERROR_MARK;
1689 /* Make < comparison from > ones, and for NE_EXPR comparisons, ensure that
1690 the control variable is on lhs. */
1691 if (code == GE_EXPR || code == GT_EXPR
1692 || (code == NE_EXPR && integer_zerop (iv0->step)))
1694 std::swap (iv0, iv1);
1695 code = swap_tree_comparison (code);
1698 if (POINTER_TYPE_P (type))
1700 /* Comparison of pointers is undefined unless both iv0 and iv1 point
1701 to the same object. If they do, the control variable cannot wrap
1702 (as wrap around the bounds of memory will never return a pointer
1703 that would be guaranteed to point to the same object, even if we
1704 avoid undefined behavior by casting to size_t and back). */
1705 iv0->no_overflow = true;
1706 iv1->no_overflow = true;
1709 /* If the control induction variable does not overflow and the only exit
1710 from the loop is the one that we analyze, we know it must be taken
1711 eventually. */
1712 if (only_exit)
1714 if (!integer_zerop (iv0->step) && iv0->no_overflow)
1715 exit_must_be_taken = true;
1716 else if (!integer_zerop (iv1->step) && iv1->no_overflow)
1717 exit_must_be_taken = true;
1720 /* We can handle cases which neither of the sides of the comparison is
1721 invariant:
1723 {iv0.base, iv0.step} cmp_code {iv1.base, iv1.step}
1724 as if:
1725 {iv0.base, iv0.step - iv1.step} cmp_code {iv1.base, 0}
1727 provided that either below condition is satisfied:
1729 a) the test is NE_EXPR;
1730 b) iv0.step - iv1.step is positive integer.
1732 This rarely occurs in practice, but it is simple enough to manage. */
1733 if (!integer_zerop (iv0->step) && !integer_zerop (iv1->step))
1735 tree step_type = POINTER_TYPE_P (type) ? sizetype : type;
1736 tree step = fold_binary_to_constant (MINUS_EXPR, step_type,
1737 iv0->step, iv1->step);
1739 /* No need to check sign of the new step since below code takes care
1740 of this well. */
1741 if (code != NE_EXPR && TREE_CODE (step) != INTEGER_CST)
1742 return false;
1744 iv0->step = step;
1745 if (!POINTER_TYPE_P (type))
1746 iv0->no_overflow = false;
1748 iv1->step = build_int_cst (step_type, 0);
1749 iv1->no_overflow = true;
1752 /* If the result of the comparison is a constant, the loop is weird. More
1753 precise handling would be possible, but the situation is not common enough
1754 to waste time on it. */
1755 if (integer_zerop (iv0->step) && integer_zerop (iv1->step))
1756 return false;
1758 /* Ignore loops of while (i-- < 10) type. */
1759 if (code != NE_EXPR)
1761 if (iv0->step && tree_int_cst_sign_bit (iv0->step))
1762 return false;
1764 if (!integer_zerop (iv1->step) && !tree_int_cst_sign_bit (iv1->step))
1765 return false;
1768 /* If the loop exits immediately, there is nothing to do. */
1769 tree tem = fold_binary (code, boolean_type_node, iv0->base, iv1->base);
1770 if (tem && integer_zerop (tem))
1772 niter->niter = build_int_cst (unsigned_type_for (type), 0);
1773 niter->max = 0;
1774 return true;
1777 /* OK, now we know we have a senseful loop. Handle several cases, depending
1778 on what comparison operator is used. */
1779 bound_difference (loop, iv1->base, iv0->base, &bnds);
1781 if (dump_file && (dump_flags & TDF_DETAILS))
1783 fprintf (dump_file,
1784 "Analyzing # of iterations of loop %d\n", loop->num);
1786 fprintf (dump_file, " exit condition ");
1787 dump_affine_iv (dump_file, iv0);
1788 fprintf (dump_file, " %s ",
1789 code == NE_EXPR ? "!="
1790 : code == LT_EXPR ? "<"
1791 : "<=");
1792 dump_affine_iv (dump_file, iv1);
1793 fprintf (dump_file, "\n");
1795 fprintf (dump_file, " bounds on difference of bases: ");
1796 mpz_out_str (dump_file, 10, bnds.below);
1797 fprintf (dump_file, " ... ");
1798 mpz_out_str (dump_file, 10, bnds.up);
1799 fprintf (dump_file, "\n");
1802 switch (code)
1804 case NE_EXPR:
1805 gcc_assert (integer_zerop (iv1->step));
1806 ret = number_of_iterations_ne (loop, type, iv0, iv1->base, niter,
1807 exit_must_be_taken, &bnds);
1808 break;
1810 case LT_EXPR:
1811 ret = number_of_iterations_lt (loop, type, iv0, iv1, niter,
1812 exit_must_be_taken, &bnds);
1813 break;
1815 case LE_EXPR:
1816 ret = number_of_iterations_le (loop, type, iv0, iv1, niter,
1817 exit_must_be_taken, &bnds);
1818 break;
1820 default:
1821 gcc_unreachable ();
1824 mpz_clear (bnds.up);
1825 mpz_clear (bnds.below);
1827 if (dump_file && (dump_flags & TDF_DETAILS))
1829 if (ret)
1831 fprintf (dump_file, " result:\n");
1832 if (!integer_nonzerop (niter->assumptions))
1834 fprintf (dump_file, " under assumptions ");
1835 print_generic_expr (dump_file, niter->assumptions, TDF_SLIM);
1836 fprintf (dump_file, "\n");
1839 if (!integer_zerop (niter->may_be_zero))
1841 fprintf (dump_file, " zero if ");
1842 print_generic_expr (dump_file, niter->may_be_zero, TDF_SLIM);
1843 fprintf (dump_file, "\n");
1846 fprintf (dump_file, " # of iterations ");
1847 print_generic_expr (dump_file, niter->niter, TDF_SLIM);
1848 fprintf (dump_file, ", bounded by ");
1849 print_decu (niter->max, dump_file);
1850 fprintf (dump_file, "\n");
1852 else
1853 fprintf (dump_file, " failed\n\n");
1855 return ret;
1858 /* Substitute NEW for OLD in EXPR and fold the result. */
1860 static tree
1861 simplify_replace_tree (tree expr, tree old, tree new_tree)
1863 unsigned i, n;
1864 tree ret = NULL_TREE, e, se;
1866 if (!expr)
1867 return NULL_TREE;
1869 /* Do not bother to replace constants. */
1870 if (CONSTANT_CLASS_P (old))
1871 return expr;
1873 if (expr == old
1874 || operand_equal_p (expr, old, 0))
1875 return unshare_expr (new_tree);
1877 if (!EXPR_P (expr))
1878 return expr;
1880 n = TREE_OPERAND_LENGTH (expr);
1881 for (i = 0; i < n; i++)
1883 e = TREE_OPERAND (expr, i);
1884 se = simplify_replace_tree (e, old, new_tree);
1885 if (e == se)
1886 continue;
1888 if (!ret)
1889 ret = copy_node (expr);
1891 TREE_OPERAND (ret, i) = se;
1894 return (ret ? fold (ret) : expr);
1897 /* Expand definitions of ssa names in EXPR as long as they are simple
1898 enough, and return the new expression. If STOP is specified, stop
1899 expanding if EXPR equals to it. */
1901 tree
1902 expand_simple_operations (tree expr, tree stop)
1904 unsigned i, n;
1905 tree ret = NULL_TREE, e, ee, e1;
1906 enum tree_code code;
1907 gimple *stmt;
1909 if (expr == NULL_TREE)
1910 return expr;
1912 if (is_gimple_min_invariant (expr))
1913 return expr;
1915 code = TREE_CODE (expr);
1916 if (IS_EXPR_CODE_CLASS (TREE_CODE_CLASS (code)))
1918 n = TREE_OPERAND_LENGTH (expr);
1919 for (i = 0; i < n; i++)
1921 e = TREE_OPERAND (expr, i);
1922 ee = expand_simple_operations (e, stop);
1923 if (e == ee)
1924 continue;
1926 if (!ret)
1927 ret = copy_node (expr);
1929 TREE_OPERAND (ret, i) = ee;
1932 if (!ret)
1933 return expr;
1935 fold_defer_overflow_warnings ();
1936 ret = fold (ret);
1937 fold_undefer_and_ignore_overflow_warnings ();
1938 return ret;
1941 /* Stop if it's not ssa name or the one we don't want to expand. */
1942 if (TREE_CODE (expr) != SSA_NAME || expr == stop)
1943 return expr;
1945 stmt = SSA_NAME_DEF_STMT (expr);
1946 if (gimple_code (stmt) == GIMPLE_PHI)
1948 basic_block src, dest;
1950 if (gimple_phi_num_args (stmt) != 1)
1951 return expr;
1952 e = PHI_ARG_DEF (stmt, 0);
1954 /* Avoid propagating through loop exit phi nodes, which
1955 could break loop-closed SSA form restrictions. */
1956 dest = gimple_bb (stmt);
1957 src = single_pred (dest);
1958 if (TREE_CODE (e) == SSA_NAME
1959 && src->loop_father != dest->loop_father)
1960 return expr;
1962 return expand_simple_operations (e, stop);
1964 if (gimple_code (stmt) != GIMPLE_ASSIGN)
1965 return expr;
1967 /* Avoid expanding to expressions that contain SSA names that need
1968 to take part in abnormal coalescing. */
1969 ssa_op_iter iter;
1970 FOR_EACH_SSA_TREE_OPERAND (e, stmt, iter, SSA_OP_USE)
1971 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (e))
1972 return expr;
1974 e = gimple_assign_rhs1 (stmt);
1975 code = gimple_assign_rhs_code (stmt);
1976 if (get_gimple_rhs_class (code) == GIMPLE_SINGLE_RHS)
1978 if (is_gimple_min_invariant (e))
1979 return e;
1981 if (code == SSA_NAME)
1982 return expand_simple_operations (e, stop);
1984 return expr;
1987 switch (code)
1989 CASE_CONVERT:
1990 /* Casts are simple. */
1991 ee = expand_simple_operations (e, stop);
1992 return fold_build1 (code, TREE_TYPE (expr), ee);
1994 case PLUS_EXPR:
1995 case MINUS_EXPR:
1996 if (ANY_INTEGRAL_TYPE_P (TREE_TYPE (expr))
1997 && TYPE_OVERFLOW_TRAPS (TREE_TYPE (expr)))
1998 return expr;
1999 /* Fallthru. */
2000 case POINTER_PLUS_EXPR:
2001 /* And increments and decrements by a constant are simple. */
2002 e1 = gimple_assign_rhs2 (stmt);
2003 if (!is_gimple_min_invariant (e1))
2004 return expr;
2006 ee = expand_simple_operations (e, stop);
2007 return fold_build2 (code, TREE_TYPE (expr), ee, e1);
2009 default:
2010 return expr;
2014 /* Tries to simplify EXPR using the condition COND. Returns the simplified
2015 expression (or EXPR unchanged, if no simplification was possible). */
2017 static tree
2018 tree_simplify_using_condition_1 (tree cond, tree expr)
2020 bool changed;
2021 tree e, e0, e1, e2, notcond;
2022 enum tree_code code = TREE_CODE (expr);
2024 if (code == INTEGER_CST)
2025 return expr;
2027 if (code == TRUTH_OR_EXPR
2028 || code == TRUTH_AND_EXPR
2029 || code == COND_EXPR)
2031 changed = false;
2033 e0 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 0));
2034 if (TREE_OPERAND (expr, 0) != e0)
2035 changed = true;
2037 e1 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 1));
2038 if (TREE_OPERAND (expr, 1) != e1)
2039 changed = true;
2041 if (code == COND_EXPR)
2043 e2 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 2));
2044 if (TREE_OPERAND (expr, 2) != e2)
2045 changed = true;
2047 else
2048 e2 = NULL_TREE;
2050 if (changed)
2052 if (code == COND_EXPR)
2053 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
2054 else
2055 expr = fold_build2 (code, boolean_type_node, e0, e1);
2058 return expr;
2061 /* In case COND is equality, we may be able to simplify EXPR by copy/constant
2062 propagation, and vice versa. Fold does not handle this, since it is
2063 considered too expensive. */
2064 if (TREE_CODE (cond) == EQ_EXPR)
2066 e0 = TREE_OPERAND (cond, 0);
2067 e1 = TREE_OPERAND (cond, 1);
2069 /* We know that e0 == e1. Check whether we cannot simplify expr
2070 using this fact. */
2071 e = simplify_replace_tree (expr, e0, e1);
2072 if (integer_zerop (e) || integer_nonzerop (e))
2073 return e;
2075 e = simplify_replace_tree (expr, e1, e0);
2076 if (integer_zerop (e) || integer_nonzerop (e))
2077 return e;
2079 if (TREE_CODE (expr) == EQ_EXPR)
2081 e0 = TREE_OPERAND (expr, 0);
2082 e1 = TREE_OPERAND (expr, 1);
2084 /* If e0 == e1 (EXPR) implies !COND, then EXPR cannot be true. */
2085 e = simplify_replace_tree (cond, e0, e1);
2086 if (integer_zerop (e))
2087 return e;
2088 e = simplify_replace_tree (cond, e1, e0);
2089 if (integer_zerop (e))
2090 return e;
2092 if (TREE_CODE (expr) == NE_EXPR)
2094 e0 = TREE_OPERAND (expr, 0);
2095 e1 = TREE_OPERAND (expr, 1);
2097 /* If e0 == e1 (!EXPR) implies !COND, then EXPR must be true. */
2098 e = simplify_replace_tree (cond, e0, e1);
2099 if (integer_zerop (e))
2100 return boolean_true_node;
2101 e = simplify_replace_tree (cond, e1, e0);
2102 if (integer_zerop (e))
2103 return boolean_true_node;
2106 /* Check whether COND ==> EXPR. */
2107 notcond = invert_truthvalue (cond);
2108 e = fold_binary (TRUTH_OR_EXPR, boolean_type_node, notcond, expr);
2109 if (e && integer_nonzerop (e))
2110 return e;
2112 /* Check whether COND ==> not EXPR. */
2113 e = fold_binary (TRUTH_AND_EXPR, boolean_type_node, cond, expr);
2114 if (e && integer_zerop (e))
2115 return e;
2117 return expr;
2120 /* Tries to simplify EXPR using the condition COND. Returns the simplified
2121 expression (or EXPR unchanged, if no simplification was possible).
2122 Wrapper around tree_simplify_using_condition_1 that ensures that chains
2123 of simple operations in definitions of ssa names in COND are expanded,
2124 so that things like casts or incrementing the value of the bound before
2125 the loop do not cause us to fail. */
2127 static tree
2128 tree_simplify_using_condition (tree cond, tree expr)
2130 cond = expand_simple_operations (cond);
2132 return tree_simplify_using_condition_1 (cond, expr);
2135 /* Tries to simplify EXPR using the conditions on entry to LOOP.
2136 Returns the simplified expression (or EXPR unchanged, if no
2137 simplification was possible). */
2139 tree
2140 simplify_using_initial_conditions (struct loop *loop, tree expr)
2142 edge e;
2143 basic_block bb;
2144 gimple *stmt;
2145 tree cond, expanded, backup;
2146 int cnt = 0;
2148 if (TREE_CODE (expr) == INTEGER_CST)
2149 return expr;
2151 backup = expanded = expand_simple_operations (expr);
2153 /* Limit walking the dominators to avoid quadraticness in
2154 the number of BBs times the number of loops in degenerate
2155 cases. */
2156 for (bb = loop->header;
2157 bb != ENTRY_BLOCK_PTR_FOR_FN (cfun) && cnt < MAX_DOMINATORS_TO_WALK;
2158 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
2160 if (!single_pred_p (bb))
2161 continue;
2162 e = single_pred_edge (bb);
2164 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
2165 continue;
2167 stmt = last_stmt (e->src);
2168 cond = fold_build2 (gimple_cond_code (stmt),
2169 boolean_type_node,
2170 gimple_cond_lhs (stmt),
2171 gimple_cond_rhs (stmt));
2172 if (e->flags & EDGE_FALSE_VALUE)
2173 cond = invert_truthvalue (cond);
2174 expanded = tree_simplify_using_condition (cond, expanded);
2175 /* Break if EXPR is simplified to const values. */
2176 if (expanded
2177 && (integer_zerop (expanded) || integer_nonzerop (expanded)))
2178 return expanded;
2180 ++cnt;
2183 /* Return the original expression if no simplification is done. */
2184 return operand_equal_p (backup, expanded, 0) ? expr : expanded;
2187 /* Tries to simplify EXPR using the evolutions of the loop invariants
2188 in the superloops of LOOP. Returns the simplified expression
2189 (or EXPR unchanged, if no simplification was possible). */
2191 static tree
2192 simplify_using_outer_evolutions (struct loop *loop, tree expr)
2194 enum tree_code code = TREE_CODE (expr);
2195 bool changed;
2196 tree e, e0, e1, e2;
2198 if (is_gimple_min_invariant (expr))
2199 return expr;
2201 if (code == TRUTH_OR_EXPR
2202 || code == TRUTH_AND_EXPR
2203 || code == COND_EXPR)
2205 changed = false;
2207 e0 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 0));
2208 if (TREE_OPERAND (expr, 0) != e0)
2209 changed = true;
2211 e1 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 1));
2212 if (TREE_OPERAND (expr, 1) != e1)
2213 changed = true;
2215 if (code == COND_EXPR)
2217 e2 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 2));
2218 if (TREE_OPERAND (expr, 2) != e2)
2219 changed = true;
2221 else
2222 e2 = NULL_TREE;
2224 if (changed)
2226 if (code == COND_EXPR)
2227 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
2228 else
2229 expr = fold_build2 (code, boolean_type_node, e0, e1);
2232 return expr;
2235 e = instantiate_parameters (loop, expr);
2236 if (is_gimple_min_invariant (e))
2237 return e;
2239 return expr;
2242 /* Returns true if EXIT is the only possible exit from LOOP. */
2244 bool
2245 loop_only_exit_p (const struct loop *loop, const_edge exit)
2247 basic_block *body;
2248 gimple_stmt_iterator bsi;
2249 unsigned i;
2251 if (exit != single_exit (loop))
2252 return false;
2254 body = get_loop_body (loop);
2255 for (i = 0; i < loop->num_nodes; i++)
2257 for (bsi = gsi_start_bb (body[i]); !gsi_end_p (bsi); gsi_next (&bsi))
2258 if (stmt_can_terminate_bb_p (gsi_stmt (bsi)))
2260 free (body);
2261 return true;
2265 free (body);
2266 return true;
2269 /* Stores description of number of iterations of LOOP derived from
2270 EXIT (an exit edge of the LOOP) in NITER. Returns true if some useful
2271 information could be derived (and fields of NITER have meaning described
2272 in comments at struct tree_niter_desc declaration), false otherwise.
2273 When EVERY_ITERATION is true, only tests that are known to be executed
2274 every iteration are considered (i.e. only test that alone bounds the loop).
2275 If AT_STMT is not NULL, this function stores LOOP's condition statement in
2276 it when returning true. */
2278 bool
2279 number_of_iterations_exit_assumptions (struct loop *loop, edge exit,
2280 struct tree_niter_desc *niter,
2281 gcond **at_stmt, bool every_iteration)
2283 gimple *last;
2284 gcond *stmt;
2285 tree type;
2286 tree op0, op1;
2287 enum tree_code code;
2288 affine_iv iv0, iv1;
2289 bool safe;
2291 /* Nothing to analyze if the loop is known to be infinite. */
2292 if (loop_constraint_set_p (loop, LOOP_C_INFINITE))
2293 return false;
2295 safe = dominated_by_p (CDI_DOMINATORS, loop->latch, exit->src);
2297 if (every_iteration && !safe)
2298 return false;
2300 niter->assumptions = boolean_false_node;
2301 niter->control.base = NULL_TREE;
2302 niter->control.step = NULL_TREE;
2303 niter->control.no_overflow = false;
2304 last = last_stmt (exit->src);
2305 if (!last)
2306 return false;
2307 stmt = dyn_cast <gcond *> (last);
2308 if (!stmt)
2309 return false;
2311 /* We want the condition for staying inside loop. */
2312 code = gimple_cond_code (stmt);
2313 if (exit->flags & EDGE_TRUE_VALUE)
2314 code = invert_tree_comparison (code, false);
2316 switch (code)
2318 case GT_EXPR:
2319 case GE_EXPR:
2320 case LT_EXPR:
2321 case LE_EXPR:
2322 case NE_EXPR:
2323 break;
2325 default:
2326 return false;
2329 op0 = gimple_cond_lhs (stmt);
2330 op1 = gimple_cond_rhs (stmt);
2331 type = TREE_TYPE (op0);
2333 if (TREE_CODE (type) != INTEGER_TYPE
2334 && !POINTER_TYPE_P (type))
2335 return false;
2337 tree iv0_niters = NULL_TREE;
2338 if (!simple_iv_with_niters (loop, loop_containing_stmt (stmt),
2339 op0, &iv0, &iv0_niters, false))
2340 return false;
2341 tree iv1_niters = NULL_TREE;
2342 if (!simple_iv_with_niters (loop, loop_containing_stmt (stmt),
2343 op1, &iv1, &iv1_niters, false))
2344 return false;
2345 /* Give up on complicated case. */
2346 if (iv0_niters && iv1_niters)
2347 return false;
2349 /* We don't want to see undefined signed overflow warnings while
2350 computing the number of iterations. */
2351 fold_defer_overflow_warnings ();
2353 iv0.base = expand_simple_operations (iv0.base);
2354 iv1.base = expand_simple_operations (iv1.base);
2355 if (!number_of_iterations_cond (loop, type, &iv0, code, &iv1, niter,
2356 loop_only_exit_p (loop, exit), safe))
2358 fold_undefer_and_ignore_overflow_warnings ();
2359 return false;
2362 /* Incorporate additional assumption implied by control iv. */
2363 tree iv_niters = iv0_niters ? iv0_niters : iv1_niters;
2364 if (iv_niters)
2366 tree assumption = fold_build2 (LE_EXPR, boolean_type_node, niter->niter,
2367 fold_convert (TREE_TYPE (niter->niter),
2368 iv_niters));
2370 if (!integer_nonzerop (assumption))
2371 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
2372 niter->assumptions, assumption);
2374 /* Refine upper bound if possible. */
2375 if (TREE_CODE (iv_niters) == INTEGER_CST
2376 && niter->max > wi::to_widest (iv_niters))
2377 niter->max = wi::to_widest (iv_niters);
2380 /* There is no assumptions if the loop is known to be finite. */
2381 if (!integer_zerop (niter->assumptions)
2382 && loop_constraint_set_p (loop, LOOP_C_FINITE))
2383 niter->assumptions = boolean_true_node;
2385 if (optimize >= 3)
2387 niter->assumptions = simplify_using_outer_evolutions (loop,
2388 niter->assumptions);
2389 niter->may_be_zero = simplify_using_outer_evolutions (loop,
2390 niter->may_be_zero);
2391 niter->niter = simplify_using_outer_evolutions (loop, niter->niter);
2394 niter->assumptions
2395 = simplify_using_initial_conditions (loop,
2396 niter->assumptions);
2397 niter->may_be_zero
2398 = simplify_using_initial_conditions (loop,
2399 niter->may_be_zero);
2401 fold_undefer_and_ignore_overflow_warnings ();
2403 /* If NITER has simplified into a constant, update MAX. */
2404 if (TREE_CODE (niter->niter) == INTEGER_CST)
2405 niter->max = wi::to_widest (niter->niter);
2407 if (at_stmt)
2408 *at_stmt = stmt;
2410 return (!integer_zerop (niter->assumptions));
2413 /* Like number_of_iterations_exit_assumptions, but return TRUE only if
2414 the niter information holds unconditionally. */
2416 bool
2417 number_of_iterations_exit (struct loop *loop, edge exit,
2418 struct tree_niter_desc *niter,
2419 bool warn, bool every_iteration)
2421 gcond *stmt;
2422 if (!number_of_iterations_exit_assumptions (loop, exit, niter,
2423 &stmt, every_iteration))
2424 return false;
2426 if (integer_nonzerop (niter->assumptions))
2427 return true;
2429 if (warn)
2430 dump_printf_loc (MSG_MISSED_OPTIMIZATION, gimple_location_safe (stmt),
2431 "missed loop optimization: niters analysis ends up "
2432 "with assumptions.\n");
2434 return false;
2437 /* Try to determine the number of iterations of LOOP. If we succeed,
2438 expression giving number of iterations is returned and *EXIT is
2439 set to the edge from that the information is obtained. Otherwise
2440 chrec_dont_know is returned. */
2442 tree
2443 find_loop_niter (struct loop *loop, edge *exit)
2445 unsigned i;
2446 vec<edge> exits = get_loop_exit_edges (loop);
2447 edge ex;
2448 tree niter = NULL_TREE, aniter;
2449 struct tree_niter_desc desc;
2451 *exit = NULL;
2452 FOR_EACH_VEC_ELT (exits, i, ex)
2454 if (!number_of_iterations_exit (loop, ex, &desc, false))
2455 continue;
2457 if (integer_nonzerop (desc.may_be_zero))
2459 /* We exit in the first iteration through this exit.
2460 We won't find anything better. */
2461 niter = build_int_cst (unsigned_type_node, 0);
2462 *exit = ex;
2463 break;
2466 if (!integer_zerop (desc.may_be_zero))
2467 continue;
2469 aniter = desc.niter;
2471 if (!niter)
2473 /* Nothing recorded yet. */
2474 niter = aniter;
2475 *exit = ex;
2476 continue;
2479 /* Prefer constants, the lower the better. */
2480 if (TREE_CODE (aniter) != INTEGER_CST)
2481 continue;
2483 if (TREE_CODE (niter) != INTEGER_CST)
2485 niter = aniter;
2486 *exit = ex;
2487 continue;
2490 if (tree_int_cst_lt (aniter, niter))
2492 niter = aniter;
2493 *exit = ex;
2494 continue;
2497 exits.release ();
2499 return niter ? niter : chrec_dont_know;
2502 /* Return true if loop is known to have bounded number of iterations. */
2504 bool
2505 finite_loop_p (struct loop *loop)
2507 widest_int nit;
2508 int flags;
2510 flags = flags_from_decl_or_type (current_function_decl);
2511 if ((flags & (ECF_CONST|ECF_PURE)) && !(flags & ECF_LOOPING_CONST_OR_PURE))
2513 if (dump_file && (dump_flags & TDF_DETAILS))
2514 fprintf (dump_file, "Found loop %i to be finite: it is within pure or const function.\n",
2515 loop->num);
2516 return true;
2519 if (loop->any_upper_bound
2520 || max_loop_iterations (loop, &nit))
2522 if (dump_file && (dump_flags & TDF_DETAILS))
2523 fprintf (dump_file, "Found loop %i to be finite: upper bound found.\n",
2524 loop->num);
2525 return true;
2527 return false;
2532 Analysis of a number of iterations of a loop by a brute-force evaluation.
2536 /* Bound on the number of iterations we try to evaluate. */
2538 #define MAX_ITERATIONS_TO_TRACK \
2539 ((unsigned) PARAM_VALUE (PARAM_MAX_ITERATIONS_TO_TRACK))
2541 /* Returns the loop phi node of LOOP such that ssa name X is derived from its
2542 result by a chain of operations such that all but exactly one of their
2543 operands are constants. */
2545 static gphi *
2546 chain_of_csts_start (struct loop *loop, tree x)
2548 gimple *stmt = SSA_NAME_DEF_STMT (x);
2549 tree use;
2550 basic_block bb = gimple_bb (stmt);
2551 enum tree_code code;
2553 if (!bb
2554 || !flow_bb_inside_loop_p (loop, bb))
2555 return NULL;
2557 if (gimple_code (stmt) == GIMPLE_PHI)
2559 if (bb == loop->header)
2560 return as_a <gphi *> (stmt);
2562 return NULL;
2565 if (gimple_code (stmt) != GIMPLE_ASSIGN
2566 || gimple_assign_rhs_class (stmt) == GIMPLE_TERNARY_RHS)
2567 return NULL;
2569 code = gimple_assign_rhs_code (stmt);
2570 if (gimple_references_memory_p (stmt)
2571 || TREE_CODE_CLASS (code) == tcc_reference
2572 || (code == ADDR_EXPR
2573 && !is_gimple_min_invariant (gimple_assign_rhs1 (stmt))))
2574 return NULL;
2576 use = SINGLE_SSA_TREE_OPERAND (stmt, SSA_OP_USE);
2577 if (use == NULL_TREE)
2578 return NULL;
2580 return chain_of_csts_start (loop, use);
2583 /* Determines whether the expression X is derived from a result of a phi node
2584 in header of LOOP such that
2586 * the derivation of X consists only from operations with constants
2587 * the initial value of the phi node is constant
2588 * the value of the phi node in the next iteration can be derived from the
2589 value in the current iteration by a chain of operations with constants,
2590 or is also a constant
2592 If such phi node exists, it is returned, otherwise NULL is returned. */
2594 static gphi *
2595 get_base_for (struct loop *loop, tree x)
2597 gphi *phi;
2598 tree init, next;
2600 if (is_gimple_min_invariant (x))
2601 return NULL;
2603 phi = chain_of_csts_start (loop, x);
2604 if (!phi)
2605 return NULL;
2607 init = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2608 next = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2610 if (!is_gimple_min_invariant (init))
2611 return NULL;
2613 if (TREE_CODE (next) == SSA_NAME
2614 && chain_of_csts_start (loop, next) != phi)
2615 return NULL;
2617 return phi;
2620 /* Given an expression X, then
2622 * if X is NULL_TREE, we return the constant BASE.
2623 * if X is a constant, we return the constant X.
2624 * otherwise X is a SSA name, whose value in the considered loop is derived
2625 by a chain of operations with constant from a result of a phi node in
2626 the header of the loop. Then we return value of X when the value of the
2627 result of this phi node is given by the constant BASE. */
2629 static tree
2630 get_val_for (tree x, tree base)
2632 gimple *stmt;
2634 gcc_checking_assert (is_gimple_min_invariant (base));
2636 if (!x)
2637 return base;
2638 else if (is_gimple_min_invariant (x))
2639 return x;
2641 stmt = SSA_NAME_DEF_STMT (x);
2642 if (gimple_code (stmt) == GIMPLE_PHI)
2643 return base;
2645 gcc_checking_assert (is_gimple_assign (stmt));
2647 /* STMT must be either an assignment of a single SSA name or an
2648 expression involving an SSA name and a constant. Try to fold that
2649 expression using the value for the SSA name. */
2650 if (gimple_assign_ssa_name_copy_p (stmt))
2651 return get_val_for (gimple_assign_rhs1 (stmt), base);
2652 else if (gimple_assign_rhs_class (stmt) == GIMPLE_UNARY_RHS
2653 && TREE_CODE (gimple_assign_rhs1 (stmt)) == SSA_NAME)
2654 return fold_build1 (gimple_assign_rhs_code (stmt),
2655 gimple_expr_type (stmt),
2656 get_val_for (gimple_assign_rhs1 (stmt), base));
2657 else if (gimple_assign_rhs_class (stmt) == GIMPLE_BINARY_RHS)
2659 tree rhs1 = gimple_assign_rhs1 (stmt);
2660 tree rhs2 = gimple_assign_rhs2 (stmt);
2661 if (TREE_CODE (rhs1) == SSA_NAME)
2662 rhs1 = get_val_for (rhs1, base);
2663 else if (TREE_CODE (rhs2) == SSA_NAME)
2664 rhs2 = get_val_for (rhs2, base);
2665 else
2666 gcc_unreachable ();
2667 return fold_build2 (gimple_assign_rhs_code (stmt),
2668 gimple_expr_type (stmt), rhs1, rhs2);
2670 else
2671 gcc_unreachable ();
2675 /* Tries to count the number of iterations of LOOP till it exits by EXIT
2676 by brute force -- i.e. by determining the value of the operands of the
2677 condition at EXIT in first few iterations of the loop (assuming that
2678 these values are constant) and determining the first one in that the
2679 condition is not satisfied. Returns the constant giving the number
2680 of the iterations of LOOP if successful, chrec_dont_know otherwise. */
2682 tree
2683 loop_niter_by_eval (struct loop *loop, edge exit)
2685 tree acnd;
2686 tree op[2], val[2], next[2], aval[2];
2687 gphi *phi;
2688 gimple *cond;
2689 unsigned i, j;
2690 enum tree_code cmp;
2692 cond = last_stmt (exit->src);
2693 if (!cond || gimple_code (cond) != GIMPLE_COND)
2694 return chrec_dont_know;
2696 cmp = gimple_cond_code (cond);
2697 if (exit->flags & EDGE_TRUE_VALUE)
2698 cmp = invert_tree_comparison (cmp, false);
2700 switch (cmp)
2702 case EQ_EXPR:
2703 case NE_EXPR:
2704 case GT_EXPR:
2705 case GE_EXPR:
2706 case LT_EXPR:
2707 case LE_EXPR:
2708 op[0] = gimple_cond_lhs (cond);
2709 op[1] = gimple_cond_rhs (cond);
2710 break;
2712 default:
2713 return chrec_dont_know;
2716 for (j = 0; j < 2; j++)
2718 if (is_gimple_min_invariant (op[j]))
2720 val[j] = op[j];
2721 next[j] = NULL_TREE;
2722 op[j] = NULL_TREE;
2724 else
2726 phi = get_base_for (loop, op[j]);
2727 if (!phi)
2728 return chrec_dont_know;
2729 val[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2730 next[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2734 /* Don't issue signed overflow warnings. */
2735 fold_defer_overflow_warnings ();
2737 for (i = 0; i < MAX_ITERATIONS_TO_TRACK; i++)
2739 for (j = 0; j < 2; j++)
2740 aval[j] = get_val_for (op[j], val[j]);
2742 acnd = fold_binary (cmp, boolean_type_node, aval[0], aval[1]);
2743 if (acnd && integer_zerop (acnd))
2745 fold_undefer_and_ignore_overflow_warnings ();
2746 if (dump_file && (dump_flags & TDF_DETAILS))
2747 fprintf (dump_file,
2748 "Proved that loop %d iterates %d times using brute force.\n",
2749 loop->num, i);
2750 return build_int_cst (unsigned_type_node, i);
2753 for (j = 0; j < 2; j++)
2755 aval[j] = val[j];
2756 val[j] = get_val_for (next[j], val[j]);
2757 if (!is_gimple_min_invariant (val[j]))
2759 fold_undefer_and_ignore_overflow_warnings ();
2760 return chrec_dont_know;
2764 /* If the next iteration would use the same base values
2765 as the current one, there is no point looping further,
2766 all following iterations will be the same as this one. */
2767 if (val[0] == aval[0] && val[1] == aval[1])
2768 break;
2771 fold_undefer_and_ignore_overflow_warnings ();
2773 return chrec_dont_know;
2776 /* Finds the exit of the LOOP by that the loop exits after a constant
2777 number of iterations and stores the exit edge to *EXIT. The constant
2778 giving the number of iterations of LOOP is returned. The number of
2779 iterations is determined using loop_niter_by_eval (i.e. by brute force
2780 evaluation). If we are unable to find the exit for that loop_niter_by_eval
2781 determines the number of iterations, chrec_dont_know is returned. */
2783 tree
2784 find_loop_niter_by_eval (struct loop *loop, edge *exit)
2786 unsigned i;
2787 vec<edge> exits = get_loop_exit_edges (loop);
2788 edge ex;
2789 tree niter = NULL_TREE, aniter;
2791 *exit = NULL;
2793 /* Loops with multiple exits are expensive to handle and less important. */
2794 if (!flag_expensive_optimizations
2795 && exits.length () > 1)
2797 exits.release ();
2798 return chrec_dont_know;
2801 FOR_EACH_VEC_ELT (exits, i, ex)
2803 if (!just_once_each_iteration_p (loop, ex->src))
2804 continue;
2806 aniter = loop_niter_by_eval (loop, ex);
2807 if (chrec_contains_undetermined (aniter))
2808 continue;
2810 if (niter
2811 && !tree_int_cst_lt (aniter, niter))
2812 continue;
2814 niter = aniter;
2815 *exit = ex;
2817 exits.release ();
2819 return niter ? niter : chrec_dont_know;
2824 Analysis of upper bounds on number of iterations of a loop.
2828 static widest_int derive_constant_upper_bound_ops (tree, tree,
2829 enum tree_code, tree);
2831 /* Returns a constant upper bound on the value of the right-hand side of
2832 an assignment statement STMT. */
2834 static widest_int
2835 derive_constant_upper_bound_assign (gimple *stmt)
2837 enum tree_code code = gimple_assign_rhs_code (stmt);
2838 tree op0 = gimple_assign_rhs1 (stmt);
2839 tree op1 = gimple_assign_rhs2 (stmt);
2841 return derive_constant_upper_bound_ops (TREE_TYPE (gimple_assign_lhs (stmt)),
2842 op0, code, op1);
2845 /* Returns a constant upper bound on the value of expression VAL. VAL
2846 is considered to be unsigned. If its type is signed, its value must
2847 be nonnegative. */
2849 static widest_int
2850 derive_constant_upper_bound (tree val)
2852 enum tree_code code;
2853 tree op0, op1, op2;
2855 extract_ops_from_tree (val, &code, &op0, &op1, &op2);
2856 return derive_constant_upper_bound_ops (TREE_TYPE (val), op0, code, op1);
2859 /* Returns a constant upper bound on the value of expression OP0 CODE OP1,
2860 whose type is TYPE. The expression is considered to be unsigned. If
2861 its type is signed, its value must be nonnegative. */
2863 static widest_int
2864 derive_constant_upper_bound_ops (tree type, tree op0,
2865 enum tree_code code, tree op1)
2867 tree subtype, maxt;
2868 widest_int bnd, max, cst;
2869 gimple *stmt;
2871 if (INTEGRAL_TYPE_P (type))
2872 maxt = TYPE_MAX_VALUE (type);
2873 else
2874 maxt = upper_bound_in_type (type, type);
2876 max = wi::to_widest (maxt);
2878 switch (code)
2880 case INTEGER_CST:
2881 return wi::to_widest (op0);
2883 CASE_CONVERT:
2884 subtype = TREE_TYPE (op0);
2885 if (!TYPE_UNSIGNED (subtype)
2886 /* If TYPE is also signed, the fact that VAL is nonnegative implies
2887 that OP0 is nonnegative. */
2888 && TYPE_UNSIGNED (type)
2889 && !tree_expr_nonnegative_p (op0))
2891 /* If we cannot prove that the casted expression is nonnegative,
2892 we cannot establish more useful upper bound than the precision
2893 of the type gives us. */
2894 return max;
2897 /* We now know that op0 is an nonnegative value. Try deriving an upper
2898 bound for it. */
2899 bnd = derive_constant_upper_bound (op0);
2901 /* If the bound does not fit in TYPE, max. value of TYPE could be
2902 attained. */
2903 if (wi::ltu_p (max, bnd))
2904 return max;
2906 return bnd;
2908 case PLUS_EXPR:
2909 case POINTER_PLUS_EXPR:
2910 case MINUS_EXPR:
2911 if (TREE_CODE (op1) != INTEGER_CST
2912 || !tree_expr_nonnegative_p (op0))
2913 return max;
2915 /* Canonicalize to OP0 - CST. Consider CST to be signed, in order to
2916 choose the most logical way how to treat this constant regardless
2917 of the signedness of the type. */
2918 cst = wi::sext (wi::to_widest (op1), TYPE_PRECISION (type));
2919 if (code != MINUS_EXPR)
2920 cst = -cst;
2922 bnd = derive_constant_upper_bound (op0);
2924 if (wi::neg_p (cst))
2926 cst = -cst;
2927 /* Avoid CST == 0x80000... */
2928 if (wi::neg_p (cst))
2929 return max;
2931 /* OP0 + CST. We need to check that
2932 BND <= MAX (type) - CST. */
2934 widest_int mmax = max - cst;
2935 if (wi::leu_p (bnd, mmax))
2936 return max;
2938 return bnd + cst;
2940 else
2942 /* OP0 - CST, where CST >= 0.
2944 If TYPE is signed, we have already verified that OP0 >= 0, and we
2945 know that the result is nonnegative. This implies that
2946 VAL <= BND - CST.
2948 If TYPE is unsigned, we must additionally know that OP0 >= CST,
2949 otherwise the operation underflows.
2952 /* This should only happen if the type is unsigned; however, for
2953 buggy programs that use overflowing signed arithmetics even with
2954 -fno-wrapv, this condition may also be true for signed values. */
2955 if (wi::ltu_p (bnd, cst))
2956 return max;
2958 if (TYPE_UNSIGNED (type))
2960 tree tem = fold_binary (GE_EXPR, boolean_type_node, op0,
2961 wide_int_to_tree (type, cst));
2962 if (!tem || integer_nonzerop (tem))
2963 return max;
2966 bnd -= cst;
2969 return bnd;
2971 case FLOOR_DIV_EXPR:
2972 case EXACT_DIV_EXPR:
2973 if (TREE_CODE (op1) != INTEGER_CST
2974 || tree_int_cst_sign_bit (op1))
2975 return max;
2977 bnd = derive_constant_upper_bound (op0);
2978 return wi::udiv_floor (bnd, wi::to_widest (op1));
2980 case BIT_AND_EXPR:
2981 if (TREE_CODE (op1) != INTEGER_CST
2982 || tree_int_cst_sign_bit (op1))
2983 return max;
2984 return wi::to_widest (op1);
2986 case SSA_NAME:
2987 stmt = SSA_NAME_DEF_STMT (op0);
2988 if (gimple_code (stmt) != GIMPLE_ASSIGN
2989 || gimple_assign_lhs (stmt) != op0)
2990 return max;
2991 return derive_constant_upper_bound_assign (stmt);
2993 default:
2994 return max;
2998 /* Emit a -Waggressive-loop-optimizations warning if needed. */
3000 static void
3001 do_warn_aggressive_loop_optimizations (struct loop *loop,
3002 widest_int i_bound, gimple *stmt)
3004 /* Don't warn if the loop doesn't have known constant bound. */
3005 if (!loop->nb_iterations
3006 || TREE_CODE (loop->nb_iterations) != INTEGER_CST
3007 || !warn_aggressive_loop_optimizations
3008 /* To avoid warning multiple times for the same loop,
3009 only start warning when we preserve loops. */
3010 || (cfun->curr_properties & PROP_loops) == 0
3011 /* Only warn once per loop. */
3012 || loop->warned_aggressive_loop_optimizations
3013 /* Only warn if undefined behavior gives us lower estimate than the
3014 known constant bound. */
3015 || wi::cmpu (i_bound, wi::to_widest (loop->nb_iterations)) >= 0
3016 /* And undefined behavior happens unconditionally. */
3017 || !dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (stmt)))
3018 return;
3020 edge e = single_exit (loop);
3021 if (e == NULL)
3022 return;
3024 gimple *estmt = last_stmt (e->src);
3025 char buf[WIDE_INT_PRINT_BUFFER_SIZE];
3026 print_dec (i_bound, buf, TYPE_UNSIGNED (TREE_TYPE (loop->nb_iterations))
3027 ? UNSIGNED : SIGNED);
3028 if (warning_at (gimple_location (stmt), OPT_Waggressive_loop_optimizations,
3029 "iteration %s invokes undefined behavior", buf))
3030 inform (gimple_location (estmt), "within this loop");
3031 loop->warned_aggressive_loop_optimizations = true;
3034 /* Records that AT_STMT is executed at most BOUND + 1 times in LOOP. IS_EXIT
3035 is true if the loop is exited immediately after STMT, and this exit
3036 is taken at last when the STMT is executed BOUND + 1 times.
3037 REALISTIC is true if BOUND is expected to be close to the real number
3038 of iterations. UPPER is true if we are sure the loop iterates at most
3039 BOUND times. I_BOUND is a widest_int upper estimate on BOUND. */
3041 static void
3042 record_estimate (struct loop *loop, tree bound, const widest_int &i_bound,
3043 gimple *at_stmt, bool is_exit, bool realistic, bool upper)
3045 widest_int delta;
3047 if (dump_file && (dump_flags & TDF_DETAILS))
3049 fprintf (dump_file, "Statement %s", is_exit ? "(exit)" : "");
3050 print_gimple_stmt (dump_file, at_stmt, 0, TDF_SLIM);
3051 fprintf (dump_file, " is %sexecuted at most ",
3052 upper ? "" : "probably ");
3053 print_generic_expr (dump_file, bound, TDF_SLIM);
3054 fprintf (dump_file, " (bounded by ");
3055 print_decu (i_bound, dump_file);
3056 fprintf (dump_file, ") + 1 times in loop %d.\n", loop->num);
3059 /* If the I_BOUND is just an estimate of BOUND, it rarely is close to the
3060 real number of iterations. */
3061 if (TREE_CODE (bound) != INTEGER_CST)
3062 realistic = false;
3063 else
3064 gcc_checking_assert (i_bound == wi::to_widest (bound));
3066 /* If we have a guaranteed upper bound, record it in the appropriate
3067 list, unless this is an !is_exit bound (i.e. undefined behavior in
3068 at_stmt) in a loop with known constant number of iterations. */
3069 if (upper
3070 && (is_exit
3071 || loop->nb_iterations == NULL_TREE
3072 || TREE_CODE (loop->nb_iterations) != INTEGER_CST))
3074 struct nb_iter_bound *elt = ggc_alloc<nb_iter_bound> ();
3076 elt->bound = i_bound;
3077 elt->stmt = at_stmt;
3078 elt->is_exit = is_exit;
3079 elt->next = loop->bounds;
3080 loop->bounds = elt;
3083 /* If statement is executed on every path to the loop latch, we can directly
3084 infer the upper bound on the # of iterations of the loop. */
3085 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (at_stmt)))
3086 upper = false;
3088 /* Update the number of iteration estimates according to the bound.
3089 If at_stmt is an exit then the loop latch is executed at most BOUND times,
3090 otherwise it can be executed BOUND + 1 times. We will lower the estimate
3091 later if such statement must be executed on last iteration */
3092 if (is_exit)
3093 delta = 0;
3094 else
3095 delta = 1;
3096 widest_int new_i_bound = i_bound + delta;
3098 /* If an overflow occurred, ignore the result. */
3099 if (wi::ltu_p (new_i_bound, delta))
3100 return;
3102 if (upper && !is_exit)
3103 do_warn_aggressive_loop_optimizations (loop, new_i_bound, at_stmt);
3104 record_niter_bound (loop, new_i_bound, realistic, upper);
3107 /* Records the control iv analyzed in NITER for LOOP if the iv is valid
3108 and doesn't overflow. */
3110 static void
3111 record_control_iv (struct loop *loop, struct tree_niter_desc *niter)
3113 struct control_iv *iv;
3115 if (!niter->control.base || !niter->control.step)
3116 return;
3118 if (!integer_onep (niter->assumptions) || !niter->control.no_overflow)
3119 return;
3121 iv = ggc_alloc<control_iv> ();
3122 iv->base = niter->control.base;
3123 iv->step = niter->control.step;
3124 iv->next = loop->control_ivs;
3125 loop->control_ivs = iv;
3127 return;
3130 /* This function returns TRUE if below conditions are satisfied:
3131 1) VAR is SSA variable.
3132 2) VAR is an IV:{base, step} in its defining loop.
3133 3) IV doesn't overflow.
3134 4) Both base and step are integer constants.
3135 5) Base is the MIN/MAX value depends on IS_MIN.
3136 Store value of base to INIT correspondingly. */
3138 static bool
3139 get_cst_init_from_scev (tree var, wide_int *init, bool is_min)
3141 if (TREE_CODE (var) != SSA_NAME)
3142 return false;
3144 gimple *def_stmt = SSA_NAME_DEF_STMT (var);
3145 struct loop *loop = loop_containing_stmt (def_stmt);
3147 if (loop == NULL)
3148 return false;
3150 affine_iv iv;
3151 if (!simple_iv (loop, loop, var, &iv, false))
3152 return false;
3154 if (!iv.no_overflow)
3155 return false;
3157 if (TREE_CODE (iv.base) != INTEGER_CST || TREE_CODE (iv.step) != INTEGER_CST)
3158 return false;
3160 if (is_min == tree_int_cst_sign_bit (iv.step))
3161 return false;
3163 *init = iv.base;
3164 return true;
3167 /* Record the estimate on number of iterations of LOOP based on the fact that
3168 the induction variable BASE + STEP * i evaluated in STMT does not wrap and
3169 its values belong to the range <LOW, HIGH>. REALISTIC is true if the
3170 estimated number of iterations is expected to be close to the real one.
3171 UPPER is true if we are sure the induction variable does not wrap. */
3173 static void
3174 record_nonwrapping_iv (struct loop *loop, tree base, tree step, gimple *stmt,
3175 tree low, tree high, bool realistic, bool upper)
3177 tree niter_bound, extreme, delta;
3178 tree type = TREE_TYPE (base), unsigned_type;
3179 tree orig_base = base;
3181 if (TREE_CODE (step) != INTEGER_CST || integer_zerop (step))
3182 return;
3184 if (dump_file && (dump_flags & TDF_DETAILS))
3186 fprintf (dump_file, "Induction variable (");
3187 print_generic_expr (dump_file, TREE_TYPE (base), TDF_SLIM);
3188 fprintf (dump_file, ") ");
3189 print_generic_expr (dump_file, base, TDF_SLIM);
3190 fprintf (dump_file, " + ");
3191 print_generic_expr (dump_file, step, TDF_SLIM);
3192 fprintf (dump_file, " * iteration does not wrap in statement ");
3193 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
3194 fprintf (dump_file, " in loop %d.\n", loop->num);
3197 unsigned_type = unsigned_type_for (type);
3198 base = fold_convert (unsigned_type, base);
3199 step = fold_convert (unsigned_type, step);
3201 if (tree_int_cst_sign_bit (step))
3203 wide_int min, max;
3204 extreme = fold_convert (unsigned_type, low);
3205 if (TREE_CODE (orig_base) == SSA_NAME
3206 && TREE_CODE (high) == INTEGER_CST
3207 && INTEGRAL_TYPE_P (TREE_TYPE (orig_base))
3208 && (get_range_info (orig_base, &min, &max) == VR_RANGE
3209 || get_cst_init_from_scev (orig_base, &max, false))
3210 && wi::gts_p (high, max))
3211 base = wide_int_to_tree (unsigned_type, max);
3212 else if (TREE_CODE (base) != INTEGER_CST
3213 && dominated_by_p (CDI_DOMINATORS,
3214 loop->latch, gimple_bb (stmt)))
3215 base = fold_convert (unsigned_type, high);
3216 delta = fold_build2 (MINUS_EXPR, unsigned_type, base, extreme);
3217 step = fold_build1 (NEGATE_EXPR, unsigned_type, step);
3219 else
3221 wide_int min, max;
3222 extreme = fold_convert (unsigned_type, high);
3223 if (TREE_CODE (orig_base) == SSA_NAME
3224 && TREE_CODE (low) == INTEGER_CST
3225 && INTEGRAL_TYPE_P (TREE_TYPE (orig_base))
3226 && (get_range_info (orig_base, &min, &max) == VR_RANGE
3227 || get_cst_init_from_scev (orig_base, &min, true))
3228 && wi::gts_p (min, low))
3229 base = wide_int_to_tree (unsigned_type, min);
3230 else if (TREE_CODE (base) != INTEGER_CST
3231 && dominated_by_p (CDI_DOMINATORS,
3232 loop->latch, gimple_bb (stmt)))
3233 base = fold_convert (unsigned_type, low);
3234 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, base);
3237 /* STMT is executed at most NITER_BOUND + 1 times, since otherwise the value
3238 would get out of the range. */
3239 niter_bound = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step);
3240 widest_int max = derive_constant_upper_bound (niter_bound);
3241 record_estimate (loop, niter_bound, max, stmt, false, realistic, upper);
3244 /* Determine information about number of iterations a LOOP from the index
3245 IDX of a data reference accessed in STMT. RELIABLE is true if STMT is
3246 guaranteed to be executed in every iteration of LOOP. Callback for
3247 for_each_index. */
3249 struct ilb_data
3251 struct loop *loop;
3252 gimple *stmt;
3255 static bool
3256 idx_infer_loop_bounds (tree base, tree *idx, void *dta)
3258 struct ilb_data *data = (struct ilb_data *) dta;
3259 tree ev, init, step;
3260 tree low, high, type, next;
3261 bool sign, upper = true, at_end = false;
3262 struct loop *loop = data->loop;
3264 if (TREE_CODE (base) != ARRAY_REF)
3265 return true;
3267 /* For arrays at the end of the structure, we are not guaranteed that they
3268 do not really extend over their declared size. However, for arrays of
3269 size greater than one, this is unlikely to be intended. */
3270 if (array_at_struct_end_p (base))
3272 at_end = true;
3273 upper = false;
3276 struct loop *dloop = loop_containing_stmt (data->stmt);
3277 if (!dloop)
3278 return true;
3280 ev = analyze_scalar_evolution (dloop, *idx);
3281 ev = instantiate_parameters (loop, ev);
3282 init = initial_condition (ev);
3283 step = evolution_part_in_loop_num (ev, loop->num);
3285 if (!init
3286 || !step
3287 || TREE_CODE (step) != INTEGER_CST
3288 || integer_zerop (step)
3289 || tree_contains_chrecs (init, NULL)
3290 || chrec_contains_symbols_defined_in_loop (init, loop->num))
3291 return true;
3293 low = array_ref_low_bound (base);
3294 high = array_ref_up_bound (base);
3296 /* The case of nonconstant bounds could be handled, but it would be
3297 complicated. */
3298 if (TREE_CODE (low) != INTEGER_CST
3299 || !high
3300 || TREE_CODE (high) != INTEGER_CST)
3301 return true;
3302 sign = tree_int_cst_sign_bit (step);
3303 type = TREE_TYPE (step);
3305 /* The array of length 1 at the end of a structure most likely extends
3306 beyond its bounds. */
3307 if (at_end
3308 && operand_equal_p (low, high, 0))
3309 return true;
3311 /* In case the relevant bound of the array does not fit in type, or
3312 it does, but bound + step (in type) still belongs into the range of the
3313 array, the index may wrap and still stay within the range of the array
3314 (consider e.g. if the array is indexed by the full range of
3315 unsigned char).
3317 To make things simpler, we require both bounds to fit into type, although
3318 there are cases where this would not be strictly necessary. */
3319 if (!int_fits_type_p (high, type)
3320 || !int_fits_type_p (low, type))
3321 return true;
3322 low = fold_convert (type, low);
3323 high = fold_convert (type, high);
3325 if (sign)
3326 next = fold_binary (PLUS_EXPR, type, low, step);
3327 else
3328 next = fold_binary (PLUS_EXPR, type, high, step);
3330 if (tree_int_cst_compare (low, next) <= 0
3331 && tree_int_cst_compare (next, high) <= 0)
3332 return true;
3334 /* If access is not executed on every iteration, we must ensure that overlow
3335 may not make the access valid later. */
3336 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (data->stmt))
3337 && scev_probably_wraps_p (NULL_TREE,
3338 initial_condition_in_loop_num (ev, loop->num),
3339 step, data->stmt, loop, true))
3340 upper = false;
3342 record_nonwrapping_iv (loop, init, step, data->stmt, low, high, false, upper);
3343 return true;
3346 /* Determine information about number of iterations a LOOP from the bounds
3347 of arrays in the data reference REF accessed in STMT. RELIABLE is true if
3348 STMT is guaranteed to be executed in every iteration of LOOP.*/
3350 static void
3351 infer_loop_bounds_from_ref (struct loop *loop, gimple *stmt, tree ref)
3353 struct ilb_data data;
3355 data.loop = loop;
3356 data.stmt = stmt;
3357 for_each_index (&ref, idx_infer_loop_bounds, &data);
3360 /* Determine information about number of iterations of a LOOP from the way
3361 arrays are used in STMT. RELIABLE is true if STMT is guaranteed to be
3362 executed in every iteration of LOOP. */
3364 static void
3365 infer_loop_bounds_from_array (struct loop *loop, gimple *stmt)
3367 if (is_gimple_assign (stmt))
3369 tree op0 = gimple_assign_lhs (stmt);
3370 tree op1 = gimple_assign_rhs1 (stmt);
3372 /* For each memory access, analyze its access function
3373 and record a bound on the loop iteration domain. */
3374 if (REFERENCE_CLASS_P (op0))
3375 infer_loop_bounds_from_ref (loop, stmt, op0);
3377 if (REFERENCE_CLASS_P (op1))
3378 infer_loop_bounds_from_ref (loop, stmt, op1);
3380 else if (is_gimple_call (stmt))
3382 tree arg, lhs;
3383 unsigned i, n = gimple_call_num_args (stmt);
3385 lhs = gimple_call_lhs (stmt);
3386 if (lhs && REFERENCE_CLASS_P (lhs))
3387 infer_loop_bounds_from_ref (loop, stmt, lhs);
3389 for (i = 0; i < n; i++)
3391 arg = gimple_call_arg (stmt, i);
3392 if (REFERENCE_CLASS_P (arg))
3393 infer_loop_bounds_from_ref (loop, stmt, arg);
3398 /* Determine information about number of iterations of a LOOP from the fact
3399 that pointer arithmetics in STMT does not overflow. */
3401 static void
3402 infer_loop_bounds_from_pointer_arith (struct loop *loop, gimple *stmt)
3404 tree def, base, step, scev, type, low, high;
3405 tree var, ptr;
3407 if (!is_gimple_assign (stmt)
3408 || gimple_assign_rhs_code (stmt) != POINTER_PLUS_EXPR)
3409 return;
3411 def = gimple_assign_lhs (stmt);
3412 if (TREE_CODE (def) != SSA_NAME)
3413 return;
3415 type = TREE_TYPE (def);
3416 if (!nowrap_type_p (type))
3417 return;
3419 ptr = gimple_assign_rhs1 (stmt);
3420 if (!expr_invariant_in_loop_p (loop, ptr))
3421 return;
3423 var = gimple_assign_rhs2 (stmt);
3424 if (TYPE_PRECISION (type) != TYPE_PRECISION (TREE_TYPE (var)))
3425 return;
3427 scev = instantiate_parameters (loop, analyze_scalar_evolution (loop, def));
3428 if (chrec_contains_undetermined (scev))
3429 return;
3431 base = initial_condition_in_loop_num (scev, loop->num);
3432 step = evolution_part_in_loop_num (scev, loop->num);
3434 if (!base || !step
3435 || TREE_CODE (step) != INTEGER_CST
3436 || tree_contains_chrecs (base, NULL)
3437 || chrec_contains_symbols_defined_in_loop (base, loop->num))
3438 return;
3440 low = lower_bound_in_type (type, type);
3441 high = upper_bound_in_type (type, type);
3443 /* In C, pointer arithmetic p + 1 cannot use a NULL pointer, and p - 1 cannot
3444 produce a NULL pointer. The contrary would mean NULL points to an object,
3445 while NULL is supposed to compare unequal with the address of all objects.
3446 Furthermore, p + 1 cannot produce a NULL pointer and p - 1 cannot use a
3447 NULL pointer since that would mean wrapping, which we assume here not to
3448 happen. So, we can exclude NULL from the valid range of pointer
3449 arithmetic. */
3450 if (flag_delete_null_pointer_checks && int_cst_value (low) == 0)
3451 low = build_int_cstu (TREE_TYPE (low), TYPE_ALIGN_UNIT (TREE_TYPE (type)));
3453 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
3456 /* Determine information about number of iterations of a LOOP from the fact
3457 that signed arithmetics in STMT does not overflow. */
3459 static void
3460 infer_loop_bounds_from_signedness (struct loop *loop, gimple *stmt)
3462 tree def, base, step, scev, type, low, high;
3464 if (gimple_code (stmt) != GIMPLE_ASSIGN)
3465 return;
3467 def = gimple_assign_lhs (stmt);
3469 if (TREE_CODE (def) != SSA_NAME)
3470 return;
3472 type = TREE_TYPE (def);
3473 if (!INTEGRAL_TYPE_P (type)
3474 || !TYPE_OVERFLOW_UNDEFINED (type))
3475 return;
3477 scev = instantiate_parameters (loop, analyze_scalar_evolution (loop, def));
3478 if (chrec_contains_undetermined (scev))
3479 return;
3481 base = initial_condition_in_loop_num (scev, loop->num);
3482 step = evolution_part_in_loop_num (scev, loop->num);
3484 if (!base || !step
3485 || TREE_CODE (step) != INTEGER_CST
3486 || tree_contains_chrecs (base, NULL)
3487 || chrec_contains_symbols_defined_in_loop (base, loop->num))
3488 return;
3490 low = lower_bound_in_type (type, type);
3491 high = upper_bound_in_type (type, type);
3493 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
3496 /* The following analyzers are extracting informations on the bounds
3497 of LOOP from the following undefined behaviors:
3499 - data references should not access elements over the statically
3500 allocated size,
3502 - signed variables should not overflow when flag_wrapv is not set.
3505 static void
3506 infer_loop_bounds_from_undefined (struct loop *loop)
3508 unsigned i;
3509 basic_block *bbs;
3510 gimple_stmt_iterator bsi;
3511 basic_block bb;
3512 bool reliable;
3514 bbs = get_loop_body (loop);
3516 for (i = 0; i < loop->num_nodes; i++)
3518 bb = bbs[i];
3520 /* If BB is not executed in each iteration of the loop, we cannot
3521 use the operations in it to infer reliable upper bound on the
3522 # of iterations of the loop. However, we can use it as a guess.
3523 Reliable guesses come only from array bounds. */
3524 reliable = dominated_by_p (CDI_DOMINATORS, loop->latch, bb);
3526 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
3528 gimple *stmt = gsi_stmt (bsi);
3530 infer_loop_bounds_from_array (loop, stmt);
3532 if (reliable)
3534 infer_loop_bounds_from_signedness (loop, stmt);
3535 infer_loop_bounds_from_pointer_arith (loop, stmt);
3541 free (bbs);
3544 /* Compare wide ints, callback for qsort. */
3546 static int
3547 wide_int_cmp (const void *p1, const void *p2)
3549 const widest_int *d1 = (const widest_int *) p1;
3550 const widest_int *d2 = (const widest_int *) p2;
3551 return wi::cmpu (*d1, *d2);
3554 /* Return index of BOUND in BOUNDS array sorted in increasing order.
3555 Lookup by binary search. */
3557 static int
3558 bound_index (vec<widest_int> bounds, const widest_int &bound)
3560 unsigned int end = bounds.length ();
3561 unsigned int begin = 0;
3563 /* Find a matching index by means of a binary search. */
3564 while (begin != end)
3566 unsigned int middle = (begin + end) / 2;
3567 widest_int index = bounds[middle];
3569 if (index == bound)
3570 return middle;
3571 else if (wi::ltu_p (index, bound))
3572 begin = middle + 1;
3573 else
3574 end = middle;
3576 gcc_unreachable ();
3579 /* We recorded loop bounds only for statements dominating loop latch (and thus
3580 executed each loop iteration). If there are any bounds on statements not
3581 dominating the loop latch we can improve the estimate by walking the loop
3582 body and seeing if every path from loop header to loop latch contains
3583 some bounded statement. */
3585 static void
3586 discover_iteration_bound_by_body_walk (struct loop *loop)
3588 struct nb_iter_bound *elt;
3589 auto_vec<widest_int> bounds;
3590 vec<vec<basic_block> > queues = vNULL;
3591 vec<basic_block> queue = vNULL;
3592 ptrdiff_t queue_index;
3593 ptrdiff_t latch_index = 0;
3595 /* Discover what bounds may interest us. */
3596 for (elt = loop->bounds; elt; elt = elt->next)
3598 widest_int bound = elt->bound;
3600 /* Exit terminates loop at given iteration, while non-exits produce undefined
3601 effect on the next iteration. */
3602 if (!elt->is_exit)
3604 bound += 1;
3605 /* If an overflow occurred, ignore the result. */
3606 if (bound == 0)
3607 continue;
3610 if (!loop->any_upper_bound
3611 || wi::ltu_p (bound, loop->nb_iterations_upper_bound))
3612 bounds.safe_push (bound);
3615 /* Exit early if there is nothing to do. */
3616 if (!bounds.exists ())
3617 return;
3619 if (dump_file && (dump_flags & TDF_DETAILS))
3620 fprintf (dump_file, " Trying to walk loop body to reduce the bound.\n");
3622 /* Sort the bounds in decreasing order. */
3623 bounds.qsort (wide_int_cmp);
3625 /* For every basic block record the lowest bound that is guaranteed to
3626 terminate the loop. */
3628 hash_map<basic_block, ptrdiff_t> bb_bounds;
3629 for (elt = loop->bounds; elt; elt = elt->next)
3631 widest_int bound = elt->bound;
3632 if (!elt->is_exit)
3634 bound += 1;
3635 /* If an overflow occurred, ignore the result. */
3636 if (bound == 0)
3637 continue;
3640 if (!loop->any_upper_bound
3641 || wi::ltu_p (bound, loop->nb_iterations_upper_bound))
3643 ptrdiff_t index = bound_index (bounds, bound);
3644 ptrdiff_t *entry = bb_bounds.get (gimple_bb (elt->stmt));
3645 if (!entry)
3646 bb_bounds.put (gimple_bb (elt->stmt), index);
3647 else if ((ptrdiff_t)*entry > index)
3648 *entry = index;
3652 hash_map<basic_block, ptrdiff_t> block_priority;
3654 /* Perform shortest path discovery loop->header ... loop->latch.
3656 The "distance" is given by the smallest loop bound of basic block
3657 present in the path and we look for path with largest smallest bound
3658 on it.
3660 To avoid the need for fibonacci heap on double ints we simply compress
3661 double ints into indexes to BOUNDS array and then represent the queue
3662 as arrays of queues for every index.
3663 Index of BOUNDS.length() means that the execution of given BB has
3664 no bounds determined.
3666 VISITED is a pointer map translating basic block into smallest index
3667 it was inserted into the priority queue with. */
3668 latch_index = -1;
3670 /* Start walk in loop header with index set to infinite bound. */
3671 queue_index = bounds.length ();
3672 queues.safe_grow_cleared (queue_index + 1);
3673 queue.safe_push (loop->header);
3674 queues[queue_index] = queue;
3675 block_priority.put (loop->header, queue_index);
3677 for (; queue_index >= 0; queue_index--)
3679 if (latch_index < queue_index)
3681 while (queues[queue_index].length ())
3683 basic_block bb;
3684 ptrdiff_t bound_index = queue_index;
3685 edge e;
3686 edge_iterator ei;
3688 queue = queues[queue_index];
3689 bb = queue.pop ();
3691 /* OK, we later inserted the BB with lower priority, skip it. */
3692 if (*block_priority.get (bb) > queue_index)
3693 continue;
3695 /* See if we can improve the bound. */
3696 ptrdiff_t *entry = bb_bounds.get (bb);
3697 if (entry && *entry < bound_index)
3698 bound_index = *entry;
3700 /* Insert succesors into the queue, watch for latch edge
3701 and record greatest index we saw. */
3702 FOR_EACH_EDGE (e, ei, bb->succs)
3704 bool insert = false;
3706 if (loop_exit_edge_p (loop, e))
3707 continue;
3709 if (e == loop_latch_edge (loop)
3710 && latch_index < bound_index)
3711 latch_index = bound_index;
3712 else if (!(entry = block_priority.get (e->dest)))
3714 insert = true;
3715 block_priority.put (e->dest, bound_index);
3717 else if (*entry < bound_index)
3719 insert = true;
3720 *entry = bound_index;
3723 if (insert)
3724 queues[bound_index].safe_push (e->dest);
3728 queues[queue_index].release ();
3731 gcc_assert (latch_index >= 0);
3732 if ((unsigned)latch_index < bounds.length ())
3734 if (dump_file && (dump_flags & TDF_DETAILS))
3736 fprintf (dump_file, "Found better loop bound ");
3737 print_decu (bounds[latch_index], dump_file);
3738 fprintf (dump_file, "\n");
3740 record_niter_bound (loop, bounds[latch_index], false, true);
3743 queues.release ();
3746 /* See if every path cross the loop goes through a statement that is known
3747 to not execute at the last iteration. In that case we can decrese iteration
3748 count by 1. */
3750 static void
3751 maybe_lower_iteration_bound (struct loop *loop)
3753 hash_set<gimple *> *not_executed_last_iteration = NULL;
3754 struct nb_iter_bound *elt;
3755 bool found_exit = false;
3756 auto_vec<basic_block> queue;
3757 bitmap visited;
3759 /* Collect all statements with interesting (i.e. lower than
3760 nb_iterations_upper_bound) bound on them.
3762 TODO: Due to the way record_estimate choose estimates to store, the bounds
3763 will be always nb_iterations_upper_bound-1. We can change this to record
3764 also statements not dominating the loop latch and update the walk bellow
3765 to the shortest path algorithm. */
3766 for (elt = loop->bounds; elt; elt = elt->next)
3768 if (!elt->is_exit
3769 && wi::ltu_p (elt->bound, loop->nb_iterations_upper_bound))
3771 if (!not_executed_last_iteration)
3772 not_executed_last_iteration = new hash_set<gimple *>;
3773 not_executed_last_iteration->add (elt->stmt);
3776 if (!not_executed_last_iteration)
3777 return;
3779 /* Start DFS walk in the loop header and see if we can reach the
3780 loop latch or any of the exits (including statements with side
3781 effects that may terminate the loop otherwise) without visiting
3782 any of the statements known to have undefined effect on the last
3783 iteration. */
3784 queue.safe_push (loop->header);
3785 visited = BITMAP_ALLOC (NULL);
3786 bitmap_set_bit (visited, loop->header->index);
3787 found_exit = false;
3791 basic_block bb = queue.pop ();
3792 gimple_stmt_iterator gsi;
3793 bool stmt_found = false;
3795 /* Loop for possible exits and statements bounding the execution. */
3796 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
3798 gimple *stmt = gsi_stmt (gsi);
3799 if (not_executed_last_iteration->contains (stmt))
3801 stmt_found = true;
3802 break;
3804 if (gimple_has_side_effects (stmt))
3806 found_exit = true;
3807 break;
3810 if (found_exit)
3811 break;
3813 /* If no bounding statement is found, continue the walk. */
3814 if (!stmt_found)
3816 edge e;
3817 edge_iterator ei;
3819 FOR_EACH_EDGE (e, ei, bb->succs)
3821 if (loop_exit_edge_p (loop, e)
3822 || e == loop_latch_edge (loop))
3824 found_exit = true;
3825 break;
3827 if (bitmap_set_bit (visited, e->dest->index))
3828 queue.safe_push (e->dest);
3832 while (queue.length () && !found_exit);
3834 /* If every path through the loop reach bounding statement before exit,
3835 then we know the last iteration of the loop will have undefined effect
3836 and we can decrease number of iterations. */
3838 if (!found_exit)
3840 if (dump_file && (dump_flags & TDF_DETAILS))
3841 fprintf (dump_file, "Reducing loop iteration estimate by 1; "
3842 "undefined statement must be executed at the last iteration.\n");
3843 record_niter_bound (loop, loop->nb_iterations_upper_bound - 1,
3844 false, true);
3847 BITMAP_FREE (visited);
3848 delete not_executed_last_iteration;
3851 /* Records estimates on numbers of iterations of LOOP. If USE_UNDEFINED_P
3852 is true also use estimates derived from undefined behavior. */
3854 void
3855 estimate_numbers_of_iterations (struct loop *loop)
3857 vec<edge> exits;
3858 tree niter, type;
3859 unsigned i;
3860 struct tree_niter_desc niter_desc;
3861 edge ex;
3862 widest_int bound;
3863 edge likely_exit;
3865 /* Give up if we already have tried to compute an estimation. */
3866 if (loop->estimate_state != EST_NOT_COMPUTED)
3867 return;
3869 loop->estimate_state = EST_AVAILABLE;
3871 /* If we have a measured profile, use it to estimate the number of
3872 iterations. Normally this is recorded by branch_prob right after
3873 reading the profile. In case we however found a new loop, record the
3874 information here.
3876 Explicitly check for profile status so we do not report
3877 wrong prediction hitrates for guessed loop iterations heuristics.
3878 Do not recompute already recorded bounds - we ought to be better on
3879 updating iteration bounds than updating profile in general and thus
3880 recomputing iteration bounds later in the compilation process will just
3881 introduce random roundoff errors. */
3882 if (!loop->any_estimate
3883 && loop->header->count > 0)
3885 gcov_type nit = expected_loop_iterations_unbounded (loop);
3886 bound = gcov_type_to_wide_int (nit);
3887 record_niter_bound (loop, bound, true, false);
3890 /* Ensure that loop->nb_iterations is computed if possible. If it turns out
3891 to be constant, we avoid undefined behavior implied bounds and instead
3892 diagnose those loops with -Waggressive-loop-optimizations. */
3893 number_of_latch_executions (loop);
3895 exits = get_loop_exit_edges (loop);
3896 likely_exit = single_likely_exit (loop);
3897 FOR_EACH_VEC_ELT (exits, i, ex)
3899 if (!number_of_iterations_exit (loop, ex, &niter_desc, false, false))
3900 continue;
3902 niter = niter_desc.niter;
3903 type = TREE_TYPE (niter);
3904 if (TREE_CODE (niter_desc.may_be_zero) != INTEGER_CST)
3905 niter = build3 (COND_EXPR, type, niter_desc.may_be_zero,
3906 build_int_cst (type, 0),
3907 niter);
3908 record_estimate (loop, niter, niter_desc.max,
3909 last_stmt (ex->src),
3910 true, ex == likely_exit, true);
3911 record_control_iv (loop, &niter_desc);
3913 exits.release ();
3915 if (flag_aggressive_loop_optimizations)
3916 infer_loop_bounds_from_undefined (loop);
3918 discover_iteration_bound_by_body_walk (loop);
3920 maybe_lower_iteration_bound (loop);
3922 /* If we know the exact number of iterations of this loop, try to
3923 not break code with undefined behavior by not recording smaller
3924 maximum number of iterations. */
3925 if (loop->nb_iterations
3926 && TREE_CODE (loop->nb_iterations) == INTEGER_CST)
3928 loop->any_upper_bound = true;
3929 loop->nb_iterations_upper_bound = wi::to_widest (loop->nb_iterations);
3933 /* Sets NIT to the estimated number of executions of the latch of the
3934 LOOP. If CONSERVATIVE is true, we must be sure that NIT is at least as
3935 large as the number of iterations. If we have no reliable estimate,
3936 the function returns false, otherwise returns true. */
3938 bool
3939 estimated_loop_iterations (struct loop *loop, widest_int *nit)
3941 /* When SCEV information is available, try to update loop iterations
3942 estimate. Otherwise just return whatever we recorded earlier. */
3943 if (scev_initialized_p ())
3944 estimate_numbers_of_iterations (loop);
3946 return (get_estimated_loop_iterations (loop, nit));
3949 /* Similar to estimated_loop_iterations, but returns the estimate only
3950 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
3951 on the number of iterations of LOOP could not be derived, returns -1. */
3953 HOST_WIDE_INT
3954 estimated_loop_iterations_int (struct loop *loop)
3956 widest_int nit;
3957 HOST_WIDE_INT hwi_nit;
3959 if (!estimated_loop_iterations (loop, &nit))
3960 return -1;
3962 if (!wi::fits_shwi_p (nit))
3963 return -1;
3964 hwi_nit = nit.to_shwi ();
3966 return hwi_nit < 0 ? -1 : hwi_nit;
3970 /* Sets NIT to an upper bound for the maximum number of executions of the
3971 latch of the LOOP. If we have no reliable estimate, the function returns
3972 false, otherwise returns true. */
3974 bool
3975 max_loop_iterations (struct loop *loop, widest_int *nit)
3977 /* When SCEV information is available, try to update loop iterations
3978 estimate. Otherwise just return whatever we recorded earlier. */
3979 if (scev_initialized_p ())
3980 estimate_numbers_of_iterations (loop);
3982 return get_max_loop_iterations (loop, nit);
3985 /* Similar to max_loop_iterations, but returns the estimate only
3986 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
3987 on the number of iterations of LOOP could not be derived, returns -1. */
3989 HOST_WIDE_INT
3990 max_loop_iterations_int (struct loop *loop)
3992 widest_int nit;
3993 HOST_WIDE_INT hwi_nit;
3995 if (!max_loop_iterations (loop, &nit))
3996 return -1;
3998 if (!wi::fits_shwi_p (nit))
3999 return -1;
4000 hwi_nit = nit.to_shwi ();
4002 return hwi_nit < 0 ? -1 : hwi_nit;
4005 /* Sets NIT to an likely upper bound for the maximum number of executions of the
4006 latch of the LOOP. If we have no reliable estimate, the function returns
4007 false, otherwise returns true. */
4009 bool
4010 likely_max_loop_iterations (struct loop *loop, widest_int *nit)
4012 /* When SCEV information is available, try to update loop iterations
4013 estimate. Otherwise just return whatever we recorded earlier. */
4014 if (scev_initialized_p ())
4015 estimate_numbers_of_iterations (loop);
4017 return get_likely_max_loop_iterations (loop, nit);
4020 /* Similar to max_loop_iterations, but returns the estimate only
4021 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
4022 on the number of iterations of LOOP could not be derived, returns -1. */
4024 HOST_WIDE_INT
4025 likely_max_loop_iterations_int (struct loop *loop)
4027 widest_int nit;
4028 HOST_WIDE_INT hwi_nit;
4030 if (!likely_max_loop_iterations (loop, &nit))
4031 return -1;
4033 if (!wi::fits_shwi_p (nit))
4034 return -1;
4035 hwi_nit = nit.to_shwi ();
4037 return hwi_nit < 0 ? -1 : hwi_nit;
4040 /* Returns an estimate for the number of executions of statements
4041 in the LOOP. For statements before the loop exit, this exceeds
4042 the number of execution of the latch by one. */
4044 HOST_WIDE_INT
4045 estimated_stmt_executions_int (struct loop *loop)
4047 HOST_WIDE_INT nit = estimated_loop_iterations_int (loop);
4048 HOST_WIDE_INT snit;
4050 if (nit == -1)
4051 return -1;
4053 snit = (HOST_WIDE_INT) ((unsigned HOST_WIDE_INT) nit + 1);
4055 /* If the computation overflows, return -1. */
4056 return snit < 0 ? -1 : snit;
4059 /* Sets NIT to the maximum number of executions of the latch of the
4060 LOOP, plus one. If we have no reliable estimate, the function returns
4061 false, otherwise returns true. */
4063 bool
4064 max_stmt_executions (struct loop *loop, widest_int *nit)
4066 widest_int nit_minus_one;
4068 if (!max_loop_iterations (loop, nit))
4069 return false;
4071 nit_minus_one = *nit;
4073 *nit += 1;
4075 return wi::gtu_p (*nit, nit_minus_one);
4078 /* Sets NIT to the estimated maximum number of executions of the latch of the
4079 LOOP, plus one. If we have no likely estimate, the function returns
4080 false, otherwise returns true. */
4082 bool
4083 likely_max_stmt_executions (struct loop *loop, widest_int *nit)
4085 widest_int nit_minus_one;
4087 if (!likely_max_loop_iterations (loop, nit))
4088 return false;
4090 nit_minus_one = *nit;
4092 *nit += 1;
4094 return wi::gtu_p (*nit, nit_minus_one);
4097 /* Sets NIT to the estimated number of executions of the latch of the
4098 LOOP, plus one. If we have no reliable estimate, the function returns
4099 false, otherwise returns true. */
4101 bool
4102 estimated_stmt_executions (struct loop *loop, widest_int *nit)
4104 widest_int nit_minus_one;
4106 if (!estimated_loop_iterations (loop, nit))
4107 return false;
4109 nit_minus_one = *nit;
4111 *nit += 1;
4113 return wi::gtu_p (*nit, nit_minus_one);
4116 /* Records estimates on numbers of iterations of loops. */
4118 void
4119 estimate_numbers_of_iterations (function *fn)
4121 struct loop *loop;
4123 /* We don't want to issue signed overflow warnings while getting
4124 loop iteration estimates. */
4125 fold_defer_overflow_warnings ();
4127 FOR_EACH_LOOP_FN (fn, loop, 0)
4128 estimate_numbers_of_iterations (loop);
4130 fold_undefer_and_ignore_overflow_warnings ();
4133 /* Returns true if statement S1 dominates statement S2. */
4135 bool
4136 stmt_dominates_stmt_p (gimple *s1, gimple *s2)
4138 basic_block bb1 = gimple_bb (s1), bb2 = gimple_bb (s2);
4140 if (!bb1
4141 || s1 == s2)
4142 return true;
4144 if (bb1 == bb2)
4146 gimple_stmt_iterator bsi;
4148 if (gimple_code (s2) == GIMPLE_PHI)
4149 return false;
4151 if (gimple_code (s1) == GIMPLE_PHI)
4152 return true;
4154 for (bsi = gsi_start_bb (bb1); gsi_stmt (bsi) != s2; gsi_next (&bsi))
4155 if (gsi_stmt (bsi) == s1)
4156 return true;
4158 return false;
4161 return dominated_by_p (CDI_DOMINATORS, bb2, bb1);
4164 /* Returns true when we can prove that the number of executions of
4165 STMT in the loop is at most NITER, according to the bound on
4166 the number of executions of the statement NITER_BOUND->stmt recorded in
4167 NITER_BOUND and fact that NITER_BOUND->stmt dominate STMT.
4169 ??? This code can become quite a CPU hog - we can have many bounds,
4170 and large basic block forcing stmt_dominates_stmt_p to be queried
4171 many times on a large basic blocks, so the whole thing is O(n^2)
4172 for scev_probably_wraps_p invocation (that can be done n times).
4174 It would make more sense (and give better answers) to remember BB
4175 bounds computed by discover_iteration_bound_by_body_walk. */
4177 static bool
4178 n_of_executions_at_most (gimple *stmt,
4179 struct nb_iter_bound *niter_bound,
4180 tree niter)
4182 widest_int bound = niter_bound->bound;
4183 tree nit_type = TREE_TYPE (niter), e;
4184 enum tree_code cmp;
4186 gcc_assert (TYPE_UNSIGNED (nit_type));
4188 /* If the bound does not even fit into NIT_TYPE, it cannot tell us that
4189 the number of iterations is small. */
4190 if (!wi::fits_to_tree_p (bound, nit_type))
4191 return false;
4193 /* We know that NITER_BOUND->stmt is executed at most NITER_BOUND->bound + 1
4194 times. This means that:
4196 -- if NITER_BOUND->is_exit is true, then everything after
4197 it at most NITER_BOUND->bound times.
4199 -- If NITER_BOUND->is_exit is false, then if we can prove that when STMT
4200 is executed, then NITER_BOUND->stmt is executed as well in the same
4201 iteration then STMT is executed at most NITER_BOUND->bound + 1 times.
4203 If we can determine that NITER_BOUND->stmt is always executed
4204 after STMT, then STMT is executed at most NITER_BOUND->bound + 2 times.
4205 We conclude that if both statements belong to the same
4206 basic block and STMT is before NITER_BOUND->stmt and there are no
4207 statements with side effects in between. */
4209 if (niter_bound->is_exit)
4211 if (stmt == niter_bound->stmt
4212 || !stmt_dominates_stmt_p (niter_bound->stmt, stmt))
4213 return false;
4214 cmp = GE_EXPR;
4216 else
4218 if (!stmt_dominates_stmt_p (niter_bound->stmt, stmt))
4220 gimple_stmt_iterator bsi;
4221 if (gimple_bb (stmt) != gimple_bb (niter_bound->stmt)
4222 || gimple_code (stmt) == GIMPLE_PHI
4223 || gimple_code (niter_bound->stmt) == GIMPLE_PHI)
4224 return false;
4226 /* By stmt_dominates_stmt_p we already know that STMT appears
4227 before NITER_BOUND->STMT. Still need to test that the loop
4228 can not be terinated by a side effect in between. */
4229 for (bsi = gsi_for_stmt (stmt); gsi_stmt (bsi) != niter_bound->stmt;
4230 gsi_next (&bsi))
4231 if (gimple_has_side_effects (gsi_stmt (bsi)))
4232 return false;
4233 bound += 1;
4234 if (bound == 0
4235 || !wi::fits_to_tree_p (bound, nit_type))
4236 return false;
4238 cmp = GT_EXPR;
4241 e = fold_binary (cmp, boolean_type_node,
4242 niter, wide_int_to_tree (nit_type, bound));
4243 return e && integer_nonzerop (e);
4246 /* Returns true if the arithmetics in TYPE can be assumed not to wrap. */
4248 bool
4249 nowrap_type_p (tree type)
4251 if (ANY_INTEGRAL_TYPE_P (type)
4252 && TYPE_OVERFLOW_UNDEFINED (type))
4253 return true;
4255 if (POINTER_TYPE_P (type))
4256 return true;
4258 return false;
4261 /* Return true if we can prove LOOP is exited before evolution of induction
4262 variable {BASE, STEP} overflows with respect to its type bound. */
4264 static bool
4265 loop_exits_before_overflow (tree base, tree step,
4266 gimple *at_stmt, struct loop *loop)
4268 widest_int niter;
4269 struct control_iv *civ;
4270 struct nb_iter_bound *bound;
4271 tree e, delta, step_abs, unsigned_base;
4272 tree type = TREE_TYPE (step);
4273 tree unsigned_type, valid_niter;
4275 /* Don't issue signed overflow warnings. */
4276 fold_defer_overflow_warnings ();
4278 /* Compute the number of iterations before we reach the bound of the
4279 type, and verify that the loop is exited before this occurs. */
4280 unsigned_type = unsigned_type_for (type);
4281 unsigned_base = fold_convert (unsigned_type, base);
4283 if (tree_int_cst_sign_bit (step))
4285 tree extreme = fold_convert (unsigned_type,
4286 lower_bound_in_type (type, type));
4287 delta = fold_build2 (MINUS_EXPR, unsigned_type, unsigned_base, extreme);
4288 step_abs = fold_build1 (NEGATE_EXPR, unsigned_type,
4289 fold_convert (unsigned_type, step));
4291 else
4293 tree extreme = fold_convert (unsigned_type,
4294 upper_bound_in_type (type, type));
4295 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, unsigned_base);
4296 step_abs = fold_convert (unsigned_type, step);
4299 valid_niter = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step_abs);
4301 estimate_numbers_of_iterations (loop);
4303 if (max_loop_iterations (loop, &niter)
4304 && wi::fits_to_tree_p (niter, TREE_TYPE (valid_niter))
4305 && (e = fold_binary (GT_EXPR, boolean_type_node, valid_niter,
4306 wide_int_to_tree (TREE_TYPE (valid_niter),
4307 niter))) != NULL
4308 && integer_nonzerop (e))
4310 fold_undefer_and_ignore_overflow_warnings ();
4311 return true;
4313 if (at_stmt)
4314 for (bound = loop->bounds; bound; bound = bound->next)
4316 if (n_of_executions_at_most (at_stmt, bound, valid_niter))
4318 fold_undefer_and_ignore_overflow_warnings ();
4319 return true;
4322 fold_undefer_and_ignore_overflow_warnings ();
4324 /* Try to prove loop is exited before {base, step} overflows with the
4325 help of analyzed loop control IV. This is done only for IVs with
4326 constant step because otherwise we don't have the information. */
4327 if (TREE_CODE (step) == INTEGER_CST)
4329 for (civ = loop->control_ivs; civ; civ = civ->next)
4331 enum tree_code code;
4332 tree civ_type = TREE_TYPE (civ->step);
4334 /* Have to consider type difference because operand_equal_p ignores
4335 that for constants. */
4336 if (TYPE_UNSIGNED (type) != TYPE_UNSIGNED (civ_type)
4337 || element_precision (type) != element_precision (civ_type))
4338 continue;
4340 /* Only consider control IV with same step. */
4341 if (!operand_equal_p (step, civ->step, 0))
4342 continue;
4344 /* Done proving if this is a no-overflow control IV. */
4345 if (operand_equal_p (base, civ->base, 0))
4346 return true;
4348 /* Control IV is recorded after expanding simple operations,
4349 Here we expand base and compare it too. */
4350 tree expanded_base = expand_simple_operations (base);
4351 if (operand_equal_p (expanded_base, civ->base, 0))
4352 return true;
4354 /* If this is a before stepping control IV, in other words, we have
4356 {civ_base, step} = {base + step, step}
4358 Because civ {base + step, step} doesn't overflow during loop
4359 iterations, {base, step} will not overflow if we can prove the
4360 operation "base + step" does not overflow. Specifically, we try
4361 to prove below conditions are satisfied:
4363 base <= UPPER_BOUND (type) - step ;;step > 0
4364 base >= LOWER_BOUND (type) - step ;;step < 0
4366 by proving the reverse conditions are false using loop's initial
4367 condition. */
4368 if (POINTER_TYPE_P (TREE_TYPE (base)))
4369 code = POINTER_PLUS_EXPR;
4370 else
4371 code = PLUS_EXPR;
4373 tree stepped = fold_build2 (code, TREE_TYPE (base), base, step);
4374 tree expanded_stepped = fold_build2 (code, TREE_TYPE (base),
4375 expanded_base, step);
4376 if (operand_equal_p (stepped, civ->base, 0)
4377 || operand_equal_p (expanded_stepped, civ->base, 0))
4379 tree extreme;
4381 if (tree_int_cst_sign_bit (step))
4383 code = LT_EXPR;
4384 extreme = lower_bound_in_type (type, type);
4386 else
4388 code = GT_EXPR;
4389 extreme = upper_bound_in_type (type, type);
4391 extreme = fold_build2 (MINUS_EXPR, type, extreme, step);
4392 e = fold_build2 (code, boolean_type_node, base, extreme);
4393 e = simplify_using_initial_conditions (loop, e);
4394 if (integer_zerop (e))
4395 return true;
4400 return false;
4403 /* VAR is scev variable whose evolution part is constant STEP, this function
4404 proves that VAR can't overflow by using value range info. If VAR's value
4405 range is [MIN, MAX], it can be proven by:
4406 MAX + step doesn't overflow ; if step > 0
4408 MIN + step doesn't underflow ; if step < 0.
4410 We can only do this if var is computed in every loop iteration, i.e, var's
4411 definition has to dominate loop latch. Consider below example:
4414 unsigned int i;
4416 <bb 3>:
4418 <bb 4>:
4419 # RANGE [0, 4294967294] NONZERO 65535
4420 # i_21 = PHI <0(3), i_18(9)>
4421 if (i_21 != 0)
4422 goto <bb 6>;
4423 else
4424 goto <bb 8>;
4426 <bb 6>:
4427 # RANGE [0, 65533] NONZERO 65535
4428 _6 = i_21 + 4294967295;
4429 # RANGE [0, 65533] NONZERO 65535
4430 _7 = (long unsigned int) _6;
4431 # RANGE [0, 524264] NONZERO 524280
4432 _8 = _7 * 8;
4433 # PT = nonlocal escaped
4434 _9 = a_14 + _8;
4435 *_9 = 0;
4437 <bb 8>:
4438 # RANGE [1, 65535] NONZERO 65535
4439 i_18 = i_21 + 1;
4440 if (i_18 >= 65535)
4441 goto <bb 10>;
4442 else
4443 goto <bb 9>;
4445 <bb 9>:
4446 goto <bb 4>;
4448 <bb 10>:
4449 return;
4452 VAR _6 doesn't overflow only with pre-condition (i_21 != 0), here we
4453 can't use _6 to prove no-overlfow for _7. In fact, var _7 takes value
4454 sequence (4294967295, 0, 1, ..., 65533) in loop life time, rather than
4455 (4294967295, 4294967296, ...). */
4457 static bool
4458 scev_var_range_cant_overflow (tree var, tree step, struct loop *loop)
4460 tree type;
4461 wide_int minv, maxv, diff, step_wi;
4462 enum value_range_type rtype;
4464 if (TREE_CODE (step) != INTEGER_CST || !INTEGRAL_TYPE_P (TREE_TYPE (var)))
4465 return false;
4467 /* Check if VAR evaluates in every loop iteration. It's not the case
4468 if VAR is default definition or does not dominate loop's latch. */
4469 basic_block def_bb = gimple_bb (SSA_NAME_DEF_STMT (var));
4470 if (!def_bb || !dominated_by_p (CDI_DOMINATORS, loop->latch, def_bb))
4471 return false;
4473 rtype = get_range_info (var, &minv, &maxv);
4474 if (rtype != VR_RANGE)
4475 return false;
4477 /* VAR is a scev whose evolution part is STEP and value range info
4478 is [MIN, MAX], we can prove its no-overflowness by conditions:
4480 type_MAX - MAX >= step ; if step > 0
4481 MIN - type_MIN >= |step| ; if step < 0.
4483 Or VAR must take value outside of value range, which is not true. */
4484 step_wi = step;
4485 type = TREE_TYPE (var);
4486 if (tree_int_cst_sign_bit (step))
4488 diff = lower_bound_in_type (type, type);
4489 diff = minv - diff;
4490 step_wi = - step_wi;
4492 else
4494 diff = upper_bound_in_type (type, type);
4495 diff = diff - maxv;
4498 return (wi::geu_p (diff, step_wi));
4501 /* Return false only when the induction variable BASE + STEP * I is
4502 known to not overflow: i.e. when the number of iterations is small
4503 enough with respect to the step and initial condition in order to
4504 keep the evolution confined in TYPEs bounds. Return true when the
4505 iv is known to overflow or when the property is not computable.
4507 USE_OVERFLOW_SEMANTICS is true if this function should assume that
4508 the rules for overflow of the given language apply (e.g., that signed
4509 arithmetics in C does not overflow).
4511 If VAR is a ssa variable, this function also returns false if VAR can
4512 be proven not overflow with value range info. */
4514 bool
4515 scev_probably_wraps_p (tree var, tree base, tree step,
4516 gimple *at_stmt, struct loop *loop,
4517 bool use_overflow_semantics)
4519 /* FIXME: We really need something like
4520 http://gcc.gnu.org/ml/gcc-patches/2005-06/msg02025.html.
4522 We used to test for the following situation that frequently appears
4523 during address arithmetics:
4525 D.1621_13 = (long unsigned intD.4) D.1620_12;
4526 D.1622_14 = D.1621_13 * 8;
4527 D.1623_15 = (doubleD.29 *) D.1622_14;
4529 And derived that the sequence corresponding to D_14
4530 can be proved to not wrap because it is used for computing a
4531 memory access; however, this is not really the case -- for example,
4532 if D_12 = (unsigned char) [254,+,1], then D_14 has values
4533 2032, 2040, 0, 8, ..., but the code is still legal. */
4535 if (chrec_contains_undetermined (base)
4536 || chrec_contains_undetermined (step))
4537 return true;
4539 if (integer_zerop (step))
4540 return false;
4542 /* If we can use the fact that signed and pointer arithmetics does not
4543 wrap, we are done. */
4544 if (use_overflow_semantics && nowrap_type_p (TREE_TYPE (base)))
4545 return false;
4547 /* To be able to use estimates on number of iterations of the loop,
4548 we must have an upper bound on the absolute value of the step. */
4549 if (TREE_CODE (step) != INTEGER_CST)
4550 return true;
4552 /* Check if var can be proven not overflow with value range info. */
4553 if (var && TREE_CODE (var) == SSA_NAME
4554 && scev_var_range_cant_overflow (var, step, loop))
4555 return false;
4557 if (loop_exits_before_overflow (base, step, at_stmt, loop))
4558 return false;
4560 /* At this point we still don't have a proof that the iv does not
4561 overflow: give up. */
4562 return true;
4565 /* Frees the information on upper bounds on numbers of iterations of LOOP. */
4567 void
4568 free_numbers_of_iterations_estimates (struct loop *loop)
4570 struct control_iv *civ;
4571 struct nb_iter_bound *bound;
4573 loop->nb_iterations = NULL;
4574 loop->estimate_state = EST_NOT_COMPUTED;
4575 for (bound = loop->bounds; bound;)
4577 struct nb_iter_bound *next = bound->next;
4578 ggc_free (bound);
4579 bound = next;
4581 loop->bounds = NULL;
4583 for (civ = loop->control_ivs; civ;)
4585 struct control_iv *next = civ->next;
4586 ggc_free (civ);
4587 civ = next;
4589 loop->control_ivs = NULL;
4592 /* Frees the information on upper bounds on numbers of iterations of loops. */
4594 void
4595 free_numbers_of_iterations_estimates (function *fn)
4597 struct loop *loop;
4599 FOR_EACH_LOOP_FN (fn, loop, 0)
4600 free_numbers_of_iterations_estimates (loop);
4603 /* Substitute value VAL for ssa name NAME inside expressions held
4604 at LOOP. */
4606 void
4607 substitute_in_loop_info (struct loop *loop, tree name, tree val)
4609 loop->nb_iterations = simplify_replace_tree (loop->nb_iterations, name, val);