2013-05-03 Richard Biener <rguenther@suse.de>
[official-gcc.git] / gcc / tree-ssa-loop-niter.c
blobbcd4317f39048f0a1d6cee160e70551ad27176f0
1 /* Functions to determine/estimate number of iterations of a loop.
2 Copyright (C) 2004-2013 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 "tm.h"
24 #include "tree.h"
25 #include "tm_p.h"
26 #include "basic-block.h"
27 #include "gimple-pretty-print.h"
28 #include "intl.h"
29 #include "tree-flow.h"
30 #include "dumpfile.h"
31 #include "cfgloop.h"
32 #include "ggc.h"
33 #include "tree-chrec.h"
34 #include "tree-scalar-evolution.h"
35 #include "tree-data-ref.h"
36 #include "params.h"
37 #include "flags.h"
38 #include "diagnostic-core.h"
39 #include "tree-inline.h"
40 #include "tree-pass.h"
42 #define SWAP(X, Y) do { affine_iv *tmp = (X); (X) = (Y); (Y) = tmp; } while (0)
44 /* The maximum number of dominator BBs we search for conditions
45 of loop header copies we use for simplifying a conditional
46 expression. */
47 #define MAX_DOMINATORS_TO_WALK 8
51 Analysis of number of iterations of an affine exit test.
55 /* Bounds on some value, BELOW <= X <= UP. */
57 typedef struct
59 mpz_t below, up;
60 } bounds;
63 /* Splits expression EXPR to a variable part VAR and constant OFFSET. */
65 static void
66 split_to_var_and_offset (tree expr, tree *var, mpz_t offset)
68 tree type = TREE_TYPE (expr);
69 tree op0, op1;
70 double_int off;
71 bool negate = false;
73 *var = expr;
74 mpz_set_ui (offset, 0);
76 switch (TREE_CODE (expr))
78 case MINUS_EXPR:
79 negate = true;
80 /* Fallthru. */
82 case PLUS_EXPR:
83 case POINTER_PLUS_EXPR:
84 op0 = TREE_OPERAND (expr, 0);
85 op1 = TREE_OPERAND (expr, 1);
87 if (TREE_CODE (op1) != INTEGER_CST)
88 break;
90 *var = op0;
91 /* Always sign extend the offset. */
92 off = tree_to_double_int (op1);
93 off = off.sext (TYPE_PRECISION (type));
94 mpz_set_double_int (offset, off, false);
95 if (negate)
96 mpz_neg (offset, offset);
97 break;
99 case INTEGER_CST:
100 *var = build_int_cst_type (type, 0);
101 off = tree_to_double_int (expr);
102 mpz_set_double_int (offset, off, TYPE_UNSIGNED (type));
103 break;
105 default:
106 break;
110 /* Stores estimate on the minimum/maximum value of the expression VAR + OFF
111 in TYPE to MIN and MAX. */
113 static void
114 determine_value_range (tree type, tree var, mpz_t off,
115 mpz_t min, mpz_t max)
117 /* If the expression is a constant, we know its value exactly. */
118 if (integer_zerop (var))
120 mpz_set (min, off);
121 mpz_set (max, off);
122 return;
125 /* If the computation may wrap, we know nothing about the value, except for
126 the range of the type. */
127 get_type_static_bounds (type, min, max);
128 if (!nowrap_type_p (type))
129 return;
131 /* Since the addition of OFF does not wrap, if OFF is positive, then we may
132 add it to MIN, otherwise to MAX. */
133 if (mpz_sgn (off) < 0)
134 mpz_add (max, max, off);
135 else
136 mpz_add (min, min, off);
139 /* Stores the bounds on the difference of the values of the expressions
140 (var + X) and (var + Y), computed in TYPE, to BNDS. */
142 static void
143 bound_difference_of_offsetted_base (tree type, mpz_t x, mpz_t y,
144 bounds *bnds)
146 int rel = mpz_cmp (x, y);
147 bool may_wrap = !nowrap_type_p (type);
148 mpz_t m;
150 /* If X == Y, then the expressions are always equal.
151 If X > Y, there are the following possibilities:
152 a) neither of var + X and var + Y overflow or underflow, or both of
153 them do. Then their difference is X - Y.
154 b) var + X overflows, and var + Y does not. Then the values of the
155 expressions are var + X - M and var + Y, where M is the range of
156 the type, and their difference is X - Y - M.
157 c) var + Y underflows and var + X does not. Their difference again
158 is M - X + Y.
159 Therefore, if the arithmetics in type does not overflow, then the
160 bounds are (X - Y, X - Y), otherwise they are (X - Y - M, X - Y)
161 Similarly, if X < Y, the bounds are either (X - Y, X - Y) or
162 (X - Y, X - Y + M). */
164 if (rel == 0)
166 mpz_set_ui (bnds->below, 0);
167 mpz_set_ui (bnds->up, 0);
168 return;
171 mpz_init (m);
172 mpz_set_double_int (m, double_int::mask (TYPE_PRECISION (type)), true);
173 mpz_add_ui (m, m, 1);
174 mpz_sub (bnds->up, x, y);
175 mpz_set (bnds->below, bnds->up);
177 if (may_wrap)
179 if (rel > 0)
180 mpz_sub (bnds->below, bnds->below, m);
181 else
182 mpz_add (bnds->up, bnds->up, m);
185 mpz_clear (m);
188 /* From condition C0 CMP C1 derives information regarding the
189 difference of values of VARX + OFFX and VARY + OFFY, computed in TYPE,
190 and stores it to BNDS. */
192 static void
193 refine_bounds_using_guard (tree type, tree varx, mpz_t offx,
194 tree vary, mpz_t offy,
195 tree c0, enum tree_code cmp, tree c1,
196 bounds *bnds)
198 tree varc0, varc1, tmp, ctype;
199 mpz_t offc0, offc1, loffx, loffy, bnd;
200 bool lbound = false;
201 bool no_wrap = nowrap_type_p (type);
202 bool x_ok, y_ok;
204 switch (cmp)
206 case LT_EXPR:
207 case LE_EXPR:
208 case GT_EXPR:
209 case GE_EXPR:
210 STRIP_SIGN_NOPS (c0);
211 STRIP_SIGN_NOPS (c1);
212 ctype = TREE_TYPE (c0);
213 if (!useless_type_conversion_p (ctype, type))
214 return;
216 break;
218 case EQ_EXPR:
219 /* We could derive quite precise information from EQ_EXPR, however, such
220 a guard is unlikely to appear, so we do not bother with handling
221 it. */
222 return;
224 case NE_EXPR:
225 /* NE_EXPR comparisons do not contain much of useful information, except for
226 special case of comparing with the bounds of the type. */
227 if (TREE_CODE (c1) != INTEGER_CST
228 || !INTEGRAL_TYPE_P (type))
229 return;
231 /* Ensure that the condition speaks about an expression in the same type
232 as X and Y. */
233 ctype = TREE_TYPE (c0);
234 if (TYPE_PRECISION (ctype) != TYPE_PRECISION (type))
235 return;
236 c0 = fold_convert (type, c0);
237 c1 = fold_convert (type, c1);
239 if (TYPE_MIN_VALUE (type)
240 && operand_equal_p (c1, TYPE_MIN_VALUE (type), 0))
242 cmp = GT_EXPR;
243 break;
245 if (TYPE_MAX_VALUE (type)
246 && operand_equal_p (c1, TYPE_MAX_VALUE (type), 0))
248 cmp = LT_EXPR;
249 break;
252 return;
253 default:
254 return;
257 mpz_init (offc0);
258 mpz_init (offc1);
259 split_to_var_and_offset (expand_simple_operations (c0), &varc0, offc0);
260 split_to_var_and_offset (expand_simple_operations (c1), &varc1, offc1);
262 /* We are only interested in comparisons of expressions based on VARX and
263 VARY. TODO -- we might also be able to derive some bounds from
264 expressions containing just one of the variables. */
266 if (operand_equal_p (varx, varc1, 0))
268 tmp = varc0; varc0 = varc1; varc1 = tmp;
269 mpz_swap (offc0, offc1);
270 cmp = swap_tree_comparison (cmp);
273 if (!operand_equal_p (varx, varc0, 0)
274 || !operand_equal_p (vary, varc1, 0))
275 goto end;
277 mpz_init_set (loffx, offx);
278 mpz_init_set (loffy, offy);
280 if (cmp == GT_EXPR || cmp == GE_EXPR)
282 tmp = varx; varx = vary; vary = tmp;
283 mpz_swap (offc0, offc1);
284 mpz_swap (loffx, loffy);
285 cmp = swap_tree_comparison (cmp);
286 lbound = true;
289 /* If there is no overflow, the condition implies that
291 (VARX + OFFX) cmp (VARY + OFFY) + (OFFX - OFFY + OFFC1 - OFFC0).
293 The overflows and underflows may complicate things a bit; each
294 overflow decreases the appropriate offset by M, and underflow
295 increases it by M. The above inequality would not necessarily be
296 true if
298 -- VARX + OFFX underflows and VARX + OFFC0 does not, or
299 VARX + OFFC0 overflows, but VARX + OFFX does not.
300 This may only happen if OFFX < OFFC0.
301 -- VARY + OFFY overflows and VARY + OFFC1 does not, or
302 VARY + OFFC1 underflows and VARY + OFFY does not.
303 This may only happen if OFFY > OFFC1. */
305 if (no_wrap)
307 x_ok = true;
308 y_ok = true;
310 else
312 x_ok = (integer_zerop (varx)
313 || mpz_cmp (loffx, offc0) >= 0);
314 y_ok = (integer_zerop (vary)
315 || mpz_cmp (loffy, offc1) <= 0);
318 if (x_ok && y_ok)
320 mpz_init (bnd);
321 mpz_sub (bnd, loffx, loffy);
322 mpz_add (bnd, bnd, offc1);
323 mpz_sub (bnd, bnd, offc0);
325 if (cmp == LT_EXPR)
326 mpz_sub_ui (bnd, bnd, 1);
328 if (lbound)
330 mpz_neg (bnd, bnd);
331 if (mpz_cmp (bnds->below, bnd) < 0)
332 mpz_set (bnds->below, bnd);
334 else
336 if (mpz_cmp (bnd, bnds->up) < 0)
337 mpz_set (bnds->up, bnd);
339 mpz_clear (bnd);
342 mpz_clear (loffx);
343 mpz_clear (loffy);
344 end:
345 mpz_clear (offc0);
346 mpz_clear (offc1);
349 /* Stores the bounds on the value of the expression X - Y in LOOP to BNDS.
350 The subtraction is considered to be performed in arbitrary precision,
351 without overflows.
353 We do not attempt to be too clever regarding the value ranges of X and
354 Y; most of the time, they are just integers or ssa names offsetted by
355 integer. However, we try to use the information contained in the
356 comparisons before the loop (usually created by loop header copying). */
358 static void
359 bound_difference (struct loop *loop, tree x, tree y, bounds *bnds)
361 tree type = TREE_TYPE (x);
362 tree varx, vary;
363 mpz_t offx, offy;
364 mpz_t minx, maxx, miny, maxy;
365 int cnt = 0;
366 edge e;
367 basic_block bb;
368 tree c0, c1;
369 gimple cond;
370 enum tree_code cmp;
372 /* Get rid of unnecessary casts, but preserve the value of
373 the expressions. */
374 STRIP_SIGN_NOPS (x);
375 STRIP_SIGN_NOPS (y);
377 mpz_init (bnds->below);
378 mpz_init (bnds->up);
379 mpz_init (offx);
380 mpz_init (offy);
381 split_to_var_and_offset (x, &varx, offx);
382 split_to_var_and_offset (y, &vary, offy);
384 if (!integer_zerop (varx)
385 && operand_equal_p (varx, vary, 0))
387 /* Special case VARX == VARY -- we just need to compare the
388 offsets. The matters are a bit more complicated in the
389 case addition of offsets may wrap. */
390 bound_difference_of_offsetted_base (type, offx, offy, bnds);
392 else
394 /* Otherwise, use the value ranges to determine the initial
395 estimates on below and up. */
396 mpz_init (minx);
397 mpz_init (maxx);
398 mpz_init (miny);
399 mpz_init (maxy);
400 determine_value_range (type, varx, offx, minx, maxx);
401 determine_value_range (type, vary, offy, miny, maxy);
403 mpz_sub (bnds->below, minx, maxy);
404 mpz_sub (bnds->up, maxx, miny);
405 mpz_clear (minx);
406 mpz_clear (maxx);
407 mpz_clear (miny);
408 mpz_clear (maxy);
411 /* If both X and Y are constants, we cannot get any more precise. */
412 if (integer_zerop (varx) && integer_zerop (vary))
413 goto end;
415 /* Now walk the dominators of the loop header and use the entry
416 guards to refine the estimates. */
417 for (bb = loop->header;
418 bb != ENTRY_BLOCK_PTR && cnt < MAX_DOMINATORS_TO_WALK;
419 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
421 if (!single_pred_p (bb))
422 continue;
423 e = single_pred_edge (bb);
425 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
426 continue;
428 cond = last_stmt (e->src);
429 c0 = gimple_cond_lhs (cond);
430 cmp = gimple_cond_code (cond);
431 c1 = gimple_cond_rhs (cond);
433 if (e->flags & EDGE_FALSE_VALUE)
434 cmp = invert_tree_comparison (cmp, false);
436 refine_bounds_using_guard (type, varx, offx, vary, offy,
437 c0, cmp, c1, bnds);
438 ++cnt;
441 end:
442 mpz_clear (offx);
443 mpz_clear (offy);
446 /* Update the bounds in BNDS that restrict the value of X to the bounds
447 that restrict the value of X + DELTA. X can be obtained as a
448 difference of two values in TYPE. */
450 static void
451 bounds_add (bounds *bnds, double_int delta, tree type)
453 mpz_t mdelta, max;
455 mpz_init (mdelta);
456 mpz_set_double_int (mdelta, delta, false);
458 mpz_init (max);
459 mpz_set_double_int (max, double_int::mask (TYPE_PRECISION (type)), true);
461 mpz_add (bnds->up, bnds->up, mdelta);
462 mpz_add (bnds->below, bnds->below, mdelta);
464 if (mpz_cmp (bnds->up, max) > 0)
465 mpz_set (bnds->up, max);
467 mpz_neg (max, max);
468 if (mpz_cmp (bnds->below, max) < 0)
469 mpz_set (bnds->below, max);
471 mpz_clear (mdelta);
472 mpz_clear (max);
475 /* Update the bounds in BNDS that restrict the value of X to the bounds
476 that restrict the value of -X. */
478 static void
479 bounds_negate (bounds *bnds)
481 mpz_t tmp;
483 mpz_init_set (tmp, bnds->up);
484 mpz_neg (bnds->up, bnds->below);
485 mpz_neg (bnds->below, tmp);
486 mpz_clear (tmp);
489 /* Returns inverse of X modulo 2^s, where MASK = 2^s-1. */
491 static tree
492 inverse (tree x, tree mask)
494 tree type = TREE_TYPE (x);
495 tree rslt;
496 unsigned ctr = tree_floor_log2 (mask);
498 if (TYPE_PRECISION (type) <= HOST_BITS_PER_WIDE_INT)
500 unsigned HOST_WIDE_INT ix;
501 unsigned HOST_WIDE_INT imask;
502 unsigned HOST_WIDE_INT irslt = 1;
504 gcc_assert (cst_and_fits_in_hwi (x));
505 gcc_assert (cst_and_fits_in_hwi (mask));
507 ix = int_cst_value (x);
508 imask = int_cst_value (mask);
510 for (; ctr; ctr--)
512 irslt *= ix;
513 ix *= ix;
515 irslt &= imask;
517 rslt = build_int_cst_type (type, irslt);
519 else
521 rslt = build_int_cst (type, 1);
522 for (; ctr; ctr--)
524 rslt = int_const_binop (MULT_EXPR, rslt, x);
525 x = int_const_binop (MULT_EXPR, x, x);
527 rslt = int_const_binop (BIT_AND_EXPR, rslt, mask);
530 return rslt;
533 /* Derives the upper bound BND on the number of executions of loop with exit
534 condition S * i <> C. If NO_OVERFLOW is true, then the control variable of
535 the loop does not overflow. EXIT_MUST_BE_TAKEN is true if we are guaranteed
536 that the loop ends through this exit, i.e., the induction variable ever
537 reaches the value of C.
539 The value C is equal to final - base, where final and base are the final and
540 initial value of the actual induction variable in the analysed loop. BNDS
541 bounds the value of this difference when computed in signed type with
542 unbounded range, while the computation of C is performed in an unsigned
543 type with the range matching the range of the type of the induction variable.
544 In particular, BNDS.up contains an upper bound on C in the following cases:
545 -- if the iv must reach its final value without overflow, i.e., if
546 NO_OVERFLOW && EXIT_MUST_BE_TAKEN is true, or
547 -- if final >= base, which we know to hold when BNDS.below >= 0. */
549 static void
550 number_of_iterations_ne_max (mpz_t bnd, bool no_overflow, tree c, tree s,
551 bounds *bnds, bool exit_must_be_taken)
553 double_int max;
554 mpz_t d;
555 bool bnds_u_valid = ((no_overflow && exit_must_be_taken)
556 || mpz_sgn (bnds->below) >= 0);
558 if (multiple_of_p (TREE_TYPE (c), c, s))
560 /* If C is an exact multiple of S, then its value will be reached before
561 the induction variable overflows (unless the loop is exited in some
562 other way before). Note that the actual induction variable in the
563 loop (which ranges from base to final instead of from 0 to C) may
564 overflow, in which case BNDS.up will not be giving a correct upper
565 bound on C; thus, BNDS_U_VALID had to be computed in advance. */
566 no_overflow = true;
567 exit_must_be_taken = true;
570 /* If the induction variable can overflow, the number of iterations is at
571 most the period of the control variable (or infinite, but in that case
572 the whole # of iterations analysis will fail). */
573 if (!no_overflow)
575 max = double_int::mask (TYPE_PRECISION (TREE_TYPE (c))
576 - tree_low_cst (num_ending_zeros (s), 1));
577 mpz_set_double_int (bnd, max, true);
578 return;
581 /* Now we know that the induction variable does not overflow, so the loop
582 iterates at most (range of type / S) times. */
583 mpz_set_double_int (bnd, double_int::mask (TYPE_PRECISION (TREE_TYPE (c))),
584 true);
586 /* If the induction variable is guaranteed to reach the value of C before
587 overflow, ... */
588 if (exit_must_be_taken)
590 /* ... then we can strengthen this to C / S, and possibly we can use
591 the upper bound on C given by BNDS. */
592 if (TREE_CODE (c) == INTEGER_CST)
593 mpz_set_double_int (bnd, tree_to_double_int (c), true);
594 else if (bnds_u_valid)
595 mpz_set (bnd, bnds->up);
598 mpz_init (d);
599 mpz_set_double_int (d, tree_to_double_int (s), true);
600 mpz_fdiv_q (bnd, bnd, d);
601 mpz_clear (d);
604 /* Determines number of iterations of loop whose ending condition
605 is IV <> FINAL. TYPE is the type of the iv. The number of
606 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
607 we know that the exit must be taken eventually, i.e., that the IV
608 ever reaches the value FINAL (we derived this earlier, and possibly set
609 NITER->assumptions to make sure this is the case). BNDS contains the
610 bounds on the difference FINAL - IV->base. */
612 static bool
613 number_of_iterations_ne (tree type, affine_iv *iv, tree final,
614 struct tree_niter_desc *niter, bool exit_must_be_taken,
615 bounds *bnds)
617 tree niter_type = unsigned_type_for (type);
618 tree s, c, d, bits, assumption, tmp, bound;
619 mpz_t max;
621 niter->control = *iv;
622 niter->bound = final;
623 niter->cmp = NE_EXPR;
625 /* Rearrange the terms so that we get inequality S * i <> C, with S
626 positive. Also cast everything to the unsigned type. If IV does
627 not overflow, BNDS bounds the value of C. Also, this is the
628 case if the computation |FINAL - IV->base| does not overflow, i.e.,
629 if BNDS->below in the result is nonnegative. */
630 if (tree_int_cst_sign_bit (iv->step))
632 s = fold_convert (niter_type,
633 fold_build1 (NEGATE_EXPR, type, iv->step));
634 c = fold_build2 (MINUS_EXPR, niter_type,
635 fold_convert (niter_type, iv->base),
636 fold_convert (niter_type, final));
637 bounds_negate (bnds);
639 else
641 s = fold_convert (niter_type, iv->step);
642 c = fold_build2 (MINUS_EXPR, niter_type,
643 fold_convert (niter_type, final),
644 fold_convert (niter_type, iv->base));
647 mpz_init (max);
648 number_of_iterations_ne_max (max, iv->no_overflow, c, s, bnds,
649 exit_must_be_taken);
650 niter->max = mpz_get_double_int (niter_type, max, false);
651 mpz_clear (max);
653 /* First the trivial cases -- when the step is 1. */
654 if (integer_onep (s))
656 niter->niter = c;
657 return true;
660 /* Let nsd (step, size of mode) = d. If d does not divide c, the loop
661 is infinite. Otherwise, the number of iterations is
662 (inverse(s/d) * (c/d)) mod (size of mode/d). */
663 bits = num_ending_zeros (s);
664 bound = build_low_bits_mask (niter_type,
665 (TYPE_PRECISION (niter_type)
666 - tree_low_cst (bits, 1)));
668 d = fold_binary_to_constant (LSHIFT_EXPR, niter_type,
669 build_int_cst (niter_type, 1), bits);
670 s = fold_binary_to_constant (RSHIFT_EXPR, niter_type, s, bits);
672 if (!exit_must_be_taken)
674 /* If we cannot assume that the exit is taken eventually, record the
675 assumptions for divisibility of c. */
676 assumption = fold_build2 (FLOOR_MOD_EXPR, niter_type, c, d);
677 assumption = fold_build2 (EQ_EXPR, boolean_type_node,
678 assumption, build_int_cst (niter_type, 0));
679 if (!integer_nonzerop (assumption))
680 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
681 niter->assumptions, assumption);
684 c = fold_build2 (EXACT_DIV_EXPR, niter_type, c, d);
685 tmp = fold_build2 (MULT_EXPR, niter_type, c, inverse (s, bound));
686 niter->niter = fold_build2 (BIT_AND_EXPR, niter_type, tmp, bound);
687 return true;
690 /* Checks whether we can determine the final value of the control variable
691 of the loop with ending condition IV0 < IV1 (computed in TYPE).
692 DELTA is the difference IV1->base - IV0->base, STEP is the absolute value
693 of the step. The assumptions necessary to ensure that the computation
694 of the final value does not overflow are recorded in NITER. If we
695 find the final value, we adjust DELTA and return TRUE. Otherwise
696 we return false. BNDS bounds the value of IV1->base - IV0->base,
697 and will be updated by the same amount as DELTA. EXIT_MUST_BE_TAKEN is
698 true if we know that the exit must be taken eventually. */
700 static bool
701 number_of_iterations_lt_to_ne (tree type, affine_iv *iv0, affine_iv *iv1,
702 struct tree_niter_desc *niter,
703 tree *delta, tree step,
704 bool exit_must_be_taken, bounds *bnds)
706 tree niter_type = TREE_TYPE (step);
707 tree mod = fold_build2 (FLOOR_MOD_EXPR, niter_type, *delta, step);
708 tree tmod;
709 mpz_t mmod;
710 tree assumption = boolean_true_node, bound, noloop;
711 bool ret = false, fv_comp_no_overflow;
712 tree type1 = type;
713 if (POINTER_TYPE_P (type))
714 type1 = sizetype;
716 if (TREE_CODE (mod) != INTEGER_CST)
717 return false;
718 if (integer_nonzerop (mod))
719 mod = fold_build2 (MINUS_EXPR, niter_type, step, mod);
720 tmod = fold_convert (type1, mod);
722 mpz_init (mmod);
723 mpz_set_double_int (mmod, tree_to_double_int (mod), true);
724 mpz_neg (mmod, mmod);
726 /* If the induction variable does not overflow and the exit is taken,
727 then the computation of the final value does not overflow. This is
728 also obviously the case if the new final value is equal to the
729 current one. Finally, we postulate this for pointer type variables,
730 as the code cannot rely on the object to that the pointer points being
731 placed at the end of the address space (and more pragmatically,
732 TYPE_{MIN,MAX}_VALUE is not defined for pointers). */
733 if (integer_zerop (mod) || POINTER_TYPE_P (type))
734 fv_comp_no_overflow = true;
735 else if (!exit_must_be_taken)
736 fv_comp_no_overflow = false;
737 else
738 fv_comp_no_overflow =
739 (iv0->no_overflow && integer_nonzerop (iv0->step))
740 || (iv1->no_overflow && integer_nonzerop (iv1->step));
742 if (integer_nonzerop (iv0->step))
744 /* The final value of the iv is iv1->base + MOD, assuming that this
745 computation does not overflow, and that
746 iv0->base <= iv1->base + MOD. */
747 if (!fv_comp_no_overflow)
749 bound = fold_build2 (MINUS_EXPR, type1,
750 TYPE_MAX_VALUE (type1), tmod);
751 assumption = fold_build2 (LE_EXPR, boolean_type_node,
752 iv1->base, bound);
753 if (integer_zerop (assumption))
754 goto end;
756 if (mpz_cmp (mmod, bnds->below) < 0)
757 noloop = boolean_false_node;
758 else if (POINTER_TYPE_P (type))
759 noloop = fold_build2 (GT_EXPR, boolean_type_node,
760 iv0->base,
761 fold_build_pointer_plus (iv1->base, tmod));
762 else
763 noloop = fold_build2 (GT_EXPR, boolean_type_node,
764 iv0->base,
765 fold_build2 (PLUS_EXPR, type1,
766 iv1->base, tmod));
768 else
770 /* The final value of the iv is iv0->base - MOD, assuming that this
771 computation does not overflow, and that
772 iv0->base - MOD <= iv1->base. */
773 if (!fv_comp_no_overflow)
775 bound = fold_build2 (PLUS_EXPR, type1,
776 TYPE_MIN_VALUE (type1), tmod);
777 assumption = fold_build2 (GE_EXPR, boolean_type_node,
778 iv0->base, bound);
779 if (integer_zerop (assumption))
780 goto end;
782 if (mpz_cmp (mmod, bnds->below) < 0)
783 noloop = boolean_false_node;
784 else if (POINTER_TYPE_P (type))
785 noloop = fold_build2 (GT_EXPR, boolean_type_node,
786 fold_build_pointer_plus (iv0->base,
787 fold_build1 (NEGATE_EXPR,
788 type1, tmod)),
789 iv1->base);
790 else
791 noloop = fold_build2 (GT_EXPR, boolean_type_node,
792 fold_build2 (MINUS_EXPR, type1,
793 iv0->base, tmod),
794 iv1->base);
797 if (!integer_nonzerop (assumption))
798 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
799 niter->assumptions,
800 assumption);
801 if (!integer_zerop (noloop))
802 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
803 niter->may_be_zero,
804 noloop);
805 bounds_add (bnds, tree_to_double_int (mod), type);
806 *delta = fold_build2 (PLUS_EXPR, niter_type, *delta, mod);
808 ret = true;
809 end:
810 mpz_clear (mmod);
811 return ret;
814 /* Add assertions to NITER that ensure that the control variable of the loop
815 with ending condition IV0 < IV1 does not overflow. Types of IV0 and IV1
816 are TYPE. Returns false if we can prove that there is an overflow, true
817 otherwise. STEP is the absolute value of the step. */
819 static bool
820 assert_no_overflow_lt (tree type, affine_iv *iv0, affine_iv *iv1,
821 struct tree_niter_desc *niter, tree step)
823 tree bound, d, assumption, diff;
824 tree niter_type = TREE_TYPE (step);
826 if (integer_nonzerop (iv0->step))
828 /* for (i = iv0->base; i < iv1->base; i += iv0->step) */
829 if (iv0->no_overflow)
830 return true;
832 /* If iv0->base is a constant, we can determine the last value before
833 overflow precisely; otherwise we conservatively assume
834 MAX - STEP + 1. */
836 if (TREE_CODE (iv0->base) == INTEGER_CST)
838 d = fold_build2 (MINUS_EXPR, niter_type,
839 fold_convert (niter_type, TYPE_MAX_VALUE (type)),
840 fold_convert (niter_type, iv0->base));
841 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
843 else
844 diff = fold_build2 (MINUS_EXPR, niter_type, step,
845 build_int_cst (niter_type, 1));
846 bound = fold_build2 (MINUS_EXPR, type,
847 TYPE_MAX_VALUE (type), fold_convert (type, diff));
848 assumption = fold_build2 (LE_EXPR, boolean_type_node,
849 iv1->base, bound);
851 else
853 /* for (i = iv1->base; i > iv0->base; i += iv1->step) */
854 if (iv1->no_overflow)
855 return true;
857 if (TREE_CODE (iv1->base) == INTEGER_CST)
859 d = fold_build2 (MINUS_EXPR, niter_type,
860 fold_convert (niter_type, iv1->base),
861 fold_convert (niter_type, TYPE_MIN_VALUE (type)));
862 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
864 else
865 diff = fold_build2 (MINUS_EXPR, niter_type, step,
866 build_int_cst (niter_type, 1));
867 bound = fold_build2 (PLUS_EXPR, type,
868 TYPE_MIN_VALUE (type), fold_convert (type, diff));
869 assumption = fold_build2 (GE_EXPR, boolean_type_node,
870 iv0->base, bound);
873 if (integer_zerop (assumption))
874 return false;
875 if (!integer_nonzerop (assumption))
876 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
877 niter->assumptions, assumption);
879 iv0->no_overflow = true;
880 iv1->no_overflow = true;
881 return true;
884 /* Add an assumption to NITER that a loop whose ending condition
885 is IV0 < IV1 rolls. TYPE is the type of the control iv. BNDS
886 bounds the value of IV1->base - IV0->base. */
888 static void
889 assert_loop_rolls_lt (tree type, affine_iv *iv0, affine_iv *iv1,
890 struct tree_niter_desc *niter, bounds *bnds)
892 tree assumption = boolean_true_node, bound, diff;
893 tree mbz, mbzl, mbzr, type1;
894 bool rolls_p, no_overflow_p;
895 double_int dstep;
896 mpz_t mstep, max;
898 /* We are going to compute the number of iterations as
899 (iv1->base - iv0->base + step - 1) / step, computed in the unsigned
900 variant of TYPE. This formula only works if
902 -step + 1 <= (iv1->base - iv0->base) <= MAX - step + 1
904 (where MAX is the maximum value of the unsigned variant of TYPE, and
905 the computations in this formula are performed in full precision,
906 i.e., without overflows).
908 Usually, for loops with exit condition iv0->base + step * i < iv1->base,
909 we have a condition of the form iv0->base - step < iv1->base before the loop,
910 and for loops iv0->base < iv1->base - step * i the condition
911 iv0->base < iv1->base + step, due to loop header copying, which enable us
912 to prove the lower bound.
914 The upper bound is more complicated. Unless the expressions for initial
915 and final value themselves contain enough information, we usually cannot
916 derive it from the context. */
918 /* First check whether the answer does not follow from the bounds we gathered
919 before. */
920 if (integer_nonzerop (iv0->step))
921 dstep = tree_to_double_int (iv0->step);
922 else
924 dstep = tree_to_double_int (iv1->step).sext (TYPE_PRECISION (type));
925 dstep = -dstep;
928 mpz_init (mstep);
929 mpz_set_double_int (mstep, dstep, true);
930 mpz_neg (mstep, mstep);
931 mpz_add_ui (mstep, mstep, 1);
933 rolls_p = mpz_cmp (mstep, bnds->below) <= 0;
935 mpz_init (max);
936 mpz_set_double_int (max, double_int::mask (TYPE_PRECISION (type)), true);
937 mpz_add (max, max, mstep);
938 no_overflow_p = (mpz_cmp (bnds->up, max) <= 0
939 /* For pointers, only values lying inside a single object
940 can be compared or manipulated by pointer arithmetics.
941 Gcc in general does not allow or handle objects larger
942 than half of the address space, hence the upper bound
943 is satisfied for pointers. */
944 || POINTER_TYPE_P (type));
945 mpz_clear (mstep);
946 mpz_clear (max);
948 if (rolls_p && no_overflow_p)
949 return;
951 type1 = type;
952 if (POINTER_TYPE_P (type))
953 type1 = sizetype;
955 /* Now the hard part; we must formulate the assumption(s) as expressions, and
956 we must be careful not to introduce overflow. */
958 if (integer_nonzerop (iv0->step))
960 diff = fold_build2 (MINUS_EXPR, type1,
961 iv0->step, build_int_cst (type1, 1));
963 /* We need to know that iv0->base >= MIN + iv0->step - 1. Since
964 0 address never belongs to any object, we can assume this for
965 pointers. */
966 if (!POINTER_TYPE_P (type))
968 bound = fold_build2 (PLUS_EXPR, type1,
969 TYPE_MIN_VALUE (type), diff);
970 assumption = fold_build2 (GE_EXPR, boolean_type_node,
971 iv0->base, bound);
974 /* And then we can compute iv0->base - diff, and compare it with
975 iv1->base. */
976 mbzl = fold_build2 (MINUS_EXPR, type1,
977 fold_convert (type1, iv0->base), diff);
978 mbzr = fold_convert (type1, iv1->base);
980 else
982 diff = fold_build2 (PLUS_EXPR, type1,
983 iv1->step, build_int_cst (type1, 1));
985 if (!POINTER_TYPE_P (type))
987 bound = fold_build2 (PLUS_EXPR, type1,
988 TYPE_MAX_VALUE (type), diff);
989 assumption = fold_build2 (LE_EXPR, boolean_type_node,
990 iv1->base, bound);
993 mbzl = fold_convert (type1, iv0->base);
994 mbzr = fold_build2 (MINUS_EXPR, type1,
995 fold_convert (type1, iv1->base), diff);
998 if (!integer_nonzerop (assumption))
999 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1000 niter->assumptions, assumption);
1001 if (!rolls_p)
1003 mbz = fold_build2 (GT_EXPR, boolean_type_node, mbzl, mbzr);
1004 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
1005 niter->may_be_zero, mbz);
1009 /* Determines number of iterations of loop whose ending condition
1010 is IV0 < IV1. TYPE is the type of the iv. The number of
1011 iterations is stored to NITER. BNDS bounds the difference
1012 IV1->base - IV0->base. EXIT_MUST_BE_TAKEN is true if we know
1013 that the exit must be taken eventually. */
1015 static bool
1016 number_of_iterations_lt (tree type, affine_iv *iv0, affine_iv *iv1,
1017 struct tree_niter_desc *niter,
1018 bool exit_must_be_taken, bounds *bnds)
1020 tree niter_type = unsigned_type_for (type);
1021 tree delta, step, s;
1022 mpz_t mstep, tmp;
1024 if (integer_nonzerop (iv0->step))
1026 niter->control = *iv0;
1027 niter->cmp = LT_EXPR;
1028 niter->bound = iv1->base;
1030 else
1032 niter->control = *iv1;
1033 niter->cmp = GT_EXPR;
1034 niter->bound = iv0->base;
1037 delta = fold_build2 (MINUS_EXPR, niter_type,
1038 fold_convert (niter_type, iv1->base),
1039 fold_convert (niter_type, iv0->base));
1041 /* First handle the special case that the step is +-1. */
1042 if ((integer_onep (iv0->step) && integer_zerop (iv1->step))
1043 || (integer_all_onesp (iv1->step) && integer_zerop (iv0->step)))
1045 /* for (i = iv0->base; i < iv1->base; i++)
1049 for (i = iv1->base; i > iv0->base; i--).
1051 In both cases # of iterations is iv1->base - iv0->base, assuming that
1052 iv1->base >= iv0->base.
1054 First try to derive a lower bound on the value of
1055 iv1->base - iv0->base, computed in full precision. If the difference
1056 is nonnegative, we are done, otherwise we must record the
1057 condition. */
1059 if (mpz_sgn (bnds->below) < 0)
1060 niter->may_be_zero = fold_build2 (LT_EXPR, boolean_type_node,
1061 iv1->base, iv0->base);
1062 niter->niter = delta;
1063 niter->max = mpz_get_double_int (niter_type, bnds->up, false);
1064 return true;
1067 if (integer_nonzerop (iv0->step))
1068 step = fold_convert (niter_type, iv0->step);
1069 else
1070 step = fold_convert (niter_type,
1071 fold_build1 (NEGATE_EXPR, type, iv1->step));
1073 /* If we can determine the final value of the control iv exactly, we can
1074 transform the condition to != comparison. In particular, this will be
1075 the case if DELTA is constant. */
1076 if (number_of_iterations_lt_to_ne (type, iv0, iv1, niter, &delta, step,
1077 exit_must_be_taken, bnds))
1079 affine_iv zps;
1081 zps.base = build_int_cst (niter_type, 0);
1082 zps.step = step;
1083 /* number_of_iterations_lt_to_ne will add assumptions that ensure that
1084 zps does not overflow. */
1085 zps.no_overflow = true;
1087 return number_of_iterations_ne (type, &zps, delta, niter, true, bnds);
1090 /* Make sure that the control iv does not overflow. */
1091 if (!assert_no_overflow_lt (type, iv0, iv1, niter, step))
1092 return false;
1094 /* We determine the number of iterations as (delta + step - 1) / step. For
1095 this to work, we must know that iv1->base >= iv0->base - step + 1,
1096 otherwise the loop does not roll. */
1097 assert_loop_rolls_lt (type, iv0, iv1, niter, bnds);
1099 s = fold_build2 (MINUS_EXPR, niter_type,
1100 step, build_int_cst (niter_type, 1));
1101 delta = fold_build2 (PLUS_EXPR, niter_type, delta, s);
1102 niter->niter = fold_build2 (FLOOR_DIV_EXPR, niter_type, delta, step);
1104 mpz_init (mstep);
1105 mpz_init (tmp);
1106 mpz_set_double_int (mstep, tree_to_double_int (step), true);
1107 mpz_add (tmp, bnds->up, mstep);
1108 mpz_sub_ui (tmp, tmp, 1);
1109 mpz_fdiv_q (tmp, tmp, mstep);
1110 niter->max = mpz_get_double_int (niter_type, tmp, false);
1111 mpz_clear (mstep);
1112 mpz_clear (tmp);
1114 return true;
1117 /* Determines number of iterations of loop whose ending condition
1118 is IV0 <= IV1. TYPE is the type of the iv. The number of
1119 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
1120 we know that this condition must eventually become false (we derived this
1121 earlier, and possibly set NITER->assumptions to make sure this
1122 is the case). BNDS bounds the difference IV1->base - IV0->base. */
1124 static bool
1125 number_of_iterations_le (tree type, affine_iv *iv0, affine_iv *iv1,
1126 struct tree_niter_desc *niter, bool exit_must_be_taken,
1127 bounds *bnds)
1129 tree assumption;
1130 tree type1 = type;
1131 if (POINTER_TYPE_P (type))
1132 type1 = sizetype;
1134 /* Say that IV0 is the control variable. Then IV0 <= IV1 iff
1135 IV0 < IV1 + 1, assuming that IV1 is not equal to the greatest
1136 value of the type. This we must know anyway, since if it is
1137 equal to this value, the loop rolls forever. We do not check
1138 this condition for pointer type ivs, as the code cannot rely on
1139 the object to that the pointer points being placed at the end of
1140 the address space (and more pragmatically, TYPE_{MIN,MAX}_VALUE is
1141 not defined for pointers). */
1143 if (!exit_must_be_taken && !POINTER_TYPE_P (type))
1145 if (integer_nonzerop (iv0->step))
1146 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1147 iv1->base, TYPE_MAX_VALUE (type));
1148 else
1149 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1150 iv0->base, TYPE_MIN_VALUE (type));
1152 if (integer_zerop (assumption))
1153 return false;
1154 if (!integer_nonzerop (assumption))
1155 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1156 niter->assumptions, assumption);
1159 if (integer_nonzerop (iv0->step))
1161 if (POINTER_TYPE_P (type))
1162 iv1->base = fold_build_pointer_plus_hwi (iv1->base, 1);
1163 else
1164 iv1->base = fold_build2 (PLUS_EXPR, type1, iv1->base,
1165 build_int_cst (type1, 1));
1167 else if (POINTER_TYPE_P (type))
1168 iv0->base = fold_build_pointer_plus_hwi (iv0->base, -1);
1169 else
1170 iv0->base = fold_build2 (MINUS_EXPR, type1,
1171 iv0->base, build_int_cst (type1, 1));
1173 bounds_add (bnds, double_int_one, type1);
1175 return number_of_iterations_lt (type, iv0, iv1, niter, exit_must_be_taken,
1176 bnds);
1179 /* Dumps description of affine induction variable IV to FILE. */
1181 static void
1182 dump_affine_iv (FILE *file, affine_iv *iv)
1184 if (!integer_zerop (iv->step))
1185 fprintf (file, "[");
1187 print_generic_expr (dump_file, iv->base, TDF_SLIM);
1189 if (!integer_zerop (iv->step))
1191 fprintf (file, ", + , ");
1192 print_generic_expr (dump_file, iv->step, TDF_SLIM);
1193 fprintf (file, "]%s", iv->no_overflow ? "(no_overflow)" : "");
1197 /* Determine the number of iterations according to condition (for staying
1198 inside loop) which compares two induction variables using comparison
1199 operator CODE. The induction variable on left side of the comparison
1200 is IV0, the right-hand side is IV1. Both induction variables must have
1201 type TYPE, which must be an integer or pointer type. The steps of the
1202 ivs must be constants (or NULL_TREE, which is interpreted as constant zero).
1204 LOOP is the loop whose number of iterations we are determining.
1206 ONLY_EXIT is true if we are sure this is the only way the loop could be
1207 exited (including possibly non-returning function calls, exceptions, etc.)
1208 -- in this case we can use the information whether the control induction
1209 variables can overflow or not in a more efficient way.
1211 if EVERY_ITERATION is true, we know the test is executed on every iteration.
1213 The results (number of iterations and assumptions as described in
1214 comments at struct tree_niter_desc in tree-flow.h) are stored to NITER.
1215 Returns false if it fails to determine number of iterations, true if it
1216 was determined (possibly with some assumptions). */
1218 static bool
1219 number_of_iterations_cond (struct loop *loop,
1220 tree type, affine_iv *iv0, enum tree_code code,
1221 affine_iv *iv1, struct tree_niter_desc *niter,
1222 bool only_exit, bool every_iteration)
1224 bool exit_must_be_taken = false, ret;
1225 bounds bnds;
1227 /* If the test is not executed every iteration, wrapping may make the test
1228 to pass again.
1229 TODO: the overflow case can be still used as unreliable estimate of upper
1230 bound. But we have no API to pass it down to number of iterations code
1231 and, at present, it will not use it anyway. */
1232 if (!every_iteration
1233 && (!iv0->no_overflow || !iv1->no_overflow
1234 || code == NE_EXPR || code == EQ_EXPR))
1235 return false;
1237 /* The meaning of these assumptions is this:
1238 if !assumptions
1239 then the rest of information does not have to be valid
1240 if may_be_zero then the loop does not roll, even if
1241 niter != 0. */
1242 niter->assumptions = boolean_true_node;
1243 niter->may_be_zero = boolean_false_node;
1244 niter->niter = NULL_TREE;
1245 niter->max = double_int_zero;
1247 niter->bound = NULL_TREE;
1248 niter->cmp = ERROR_MARK;
1250 /* Make < comparison from > ones, and for NE_EXPR comparisons, ensure that
1251 the control variable is on lhs. */
1252 if (code == GE_EXPR || code == GT_EXPR
1253 || (code == NE_EXPR && integer_zerop (iv0->step)))
1255 SWAP (iv0, iv1);
1256 code = swap_tree_comparison (code);
1259 if (POINTER_TYPE_P (type))
1261 /* Comparison of pointers is undefined unless both iv0 and iv1 point
1262 to the same object. If they do, the control variable cannot wrap
1263 (as wrap around the bounds of memory will never return a pointer
1264 that would be guaranteed to point to the same object, even if we
1265 avoid undefined behavior by casting to size_t and back). */
1266 iv0->no_overflow = true;
1267 iv1->no_overflow = true;
1270 /* If the control induction variable does not overflow and the only exit
1271 from the loop is the one that we analyze, we know it must be taken
1272 eventually. */
1273 if (only_exit)
1275 if (!integer_zerop (iv0->step) && iv0->no_overflow)
1276 exit_must_be_taken = true;
1277 else if (!integer_zerop (iv1->step) && iv1->no_overflow)
1278 exit_must_be_taken = true;
1281 /* We can handle the case when neither of the sides of the comparison is
1282 invariant, provided that the test is NE_EXPR. This rarely occurs in
1283 practice, but it is simple enough to manage. */
1284 if (!integer_zerop (iv0->step) && !integer_zerop (iv1->step))
1286 tree step_type = POINTER_TYPE_P (type) ? sizetype : type;
1287 if (code != NE_EXPR)
1288 return false;
1290 iv0->step = fold_binary_to_constant (MINUS_EXPR, step_type,
1291 iv0->step, iv1->step);
1292 iv0->no_overflow = false;
1293 iv1->step = build_int_cst (step_type, 0);
1294 iv1->no_overflow = true;
1297 /* If the result of the comparison is a constant, the loop is weird. More
1298 precise handling would be possible, but the situation is not common enough
1299 to waste time on it. */
1300 if (integer_zerop (iv0->step) && integer_zerop (iv1->step))
1301 return false;
1303 /* Ignore loops of while (i-- < 10) type. */
1304 if (code != NE_EXPR)
1306 if (iv0->step && tree_int_cst_sign_bit (iv0->step))
1307 return false;
1309 if (!integer_zerop (iv1->step) && !tree_int_cst_sign_bit (iv1->step))
1310 return false;
1313 /* If the loop exits immediately, there is nothing to do. */
1314 if (integer_zerop (fold_build2 (code, boolean_type_node, iv0->base, iv1->base)))
1316 niter->niter = build_int_cst (unsigned_type_for (type), 0);
1317 niter->max = double_int_zero;
1318 return true;
1321 /* OK, now we know we have a senseful loop. Handle several cases, depending
1322 on what comparison operator is used. */
1323 bound_difference (loop, iv1->base, iv0->base, &bnds);
1325 if (dump_file && (dump_flags & TDF_DETAILS))
1327 fprintf (dump_file,
1328 "Analyzing # of iterations of loop %d\n", loop->num);
1330 fprintf (dump_file, " exit condition ");
1331 dump_affine_iv (dump_file, iv0);
1332 fprintf (dump_file, " %s ",
1333 code == NE_EXPR ? "!="
1334 : code == LT_EXPR ? "<"
1335 : "<=");
1336 dump_affine_iv (dump_file, iv1);
1337 fprintf (dump_file, "\n");
1339 fprintf (dump_file, " bounds on difference of bases: ");
1340 mpz_out_str (dump_file, 10, bnds.below);
1341 fprintf (dump_file, " ... ");
1342 mpz_out_str (dump_file, 10, bnds.up);
1343 fprintf (dump_file, "\n");
1346 switch (code)
1348 case NE_EXPR:
1349 gcc_assert (integer_zerop (iv1->step));
1350 ret = number_of_iterations_ne (type, iv0, iv1->base, niter,
1351 exit_must_be_taken, &bnds);
1352 break;
1354 case LT_EXPR:
1355 ret = number_of_iterations_lt (type, iv0, iv1, niter, exit_must_be_taken,
1356 &bnds);
1357 break;
1359 case LE_EXPR:
1360 ret = number_of_iterations_le (type, iv0, iv1, niter, exit_must_be_taken,
1361 &bnds);
1362 break;
1364 default:
1365 gcc_unreachable ();
1368 mpz_clear (bnds.up);
1369 mpz_clear (bnds.below);
1371 if (dump_file && (dump_flags & TDF_DETAILS))
1373 if (ret)
1375 fprintf (dump_file, " result:\n");
1376 if (!integer_nonzerop (niter->assumptions))
1378 fprintf (dump_file, " under assumptions ");
1379 print_generic_expr (dump_file, niter->assumptions, TDF_SLIM);
1380 fprintf (dump_file, "\n");
1383 if (!integer_zerop (niter->may_be_zero))
1385 fprintf (dump_file, " zero if ");
1386 print_generic_expr (dump_file, niter->may_be_zero, TDF_SLIM);
1387 fprintf (dump_file, "\n");
1390 fprintf (dump_file, " # of iterations ");
1391 print_generic_expr (dump_file, niter->niter, TDF_SLIM);
1392 fprintf (dump_file, ", bounded by ");
1393 dump_double_int (dump_file, niter->max, true);
1394 fprintf (dump_file, "\n");
1396 else
1397 fprintf (dump_file, " failed\n\n");
1399 return ret;
1402 /* Substitute NEW for OLD in EXPR and fold the result. */
1404 static tree
1405 simplify_replace_tree (tree expr, tree old, tree new_tree)
1407 unsigned i, n;
1408 tree ret = NULL_TREE, e, se;
1410 if (!expr)
1411 return NULL_TREE;
1413 /* Do not bother to replace constants. */
1414 if (CONSTANT_CLASS_P (old))
1415 return expr;
1417 if (expr == old
1418 || operand_equal_p (expr, old, 0))
1419 return unshare_expr (new_tree);
1421 if (!EXPR_P (expr))
1422 return expr;
1424 n = TREE_OPERAND_LENGTH (expr);
1425 for (i = 0; i < n; i++)
1427 e = TREE_OPERAND (expr, i);
1428 se = simplify_replace_tree (e, old, new_tree);
1429 if (e == se)
1430 continue;
1432 if (!ret)
1433 ret = copy_node (expr);
1435 TREE_OPERAND (ret, i) = se;
1438 return (ret ? fold (ret) : expr);
1441 /* Expand definitions of ssa names in EXPR as long as they are simple
1442 enough, and return the new expression. */
1444 tree
1445 expand_simple_operations (tree expr)
1447 unsigned i, n;
1448 tree ret = NULL_TREE, e, ee, e1;
1449 enum tree_code code;
1450 gimple stmt;
1452 if (expr == NULL_TREE)
1453 return expr;
1455 if (is_gimple_min_invariant (expr))
1456 return expr;
1458 code = TREE_CODE (expr);
1459 if (IS_EXPR_CODE_CLASS (TREE_CODE_CLASS (code)))
1461 n = TREE_OPERAND_LENGTH (expr);
1462 for (i = 0; i < n; i++)
1464 e = TREE_OPERAND (expr, i);
1465 ee = expand_simple_operations (e);
1466 if (e == ee)
1467 continue;
1469 if (!ret)
1470 ret = copy_node (expr);
1472 TREE_OPERAND (ret, i) = ee;
1475 if (!ret)
1476 return expr;
1478 fold_defer_overflow_warnings ();
1479 ret = fold (ret);
1480 fold_undefer_and_ignore_overflow_warnings ();
1481 return ret;
1484 if (TREE_CODE (expr) != SSA_NAME)
1485 return expr;
1487 stmt = SSA_NAME_DEF_STMT (expr);
1488 if (gimple_code (stmt) == GIMPLE_PHI)
1490 basic_block src, dest;
1492 if (gimple_phi_num_args (stmt) != 1)
1493 return expr;
1494 e = PHI_ARG_DEF (stmt, 0);
1496 /* Avoid propagating through loop exit phi nodes, which
1497 could break loop-closed SSA form restrictions. */
1498 dest = gimple_bb (stmt);
1499 src = single_pred (dest);
1500 if (TREE_CODE (e) == SSA_NAME
1501 && src->loop_father != dest->loop_father)
1502 return expr;
1504 return expand_simple_operations (e);
1506 if (gimple_code (stmt) != GIMPLE_ASSIGN)
1507 return expr;
1509 e = gimple_assign_rhs1 (stmt);
1510 code = gimple_assign_rhs_code (stmt);
1511 if (get_gimple_rhs_class (code) == GIMPLE_SINGLE_RHS)
1513 if (is_gimple_min_invariant (e))
1514 return e;
1516 if (code == SSA_NAME)
1517 return expand_simple_operations (e);
1519 return expr;
1522 switch (code)
1524 CASE_CONVERT:
1525 /* Casts are simple. */
1526 ee = expand_simple_operations (e);
1527 return fold_build1 (code, TREE_TYPE (expr), ee);
1529 case PLUS_EXPR:
1530 case MINUS_EXPR:
1531 case POINTER_PLUS_EXPR:
1532 /* And increments and decrements by a constant are simple. */
1533 e1 = gimple_assign_rhs2 (stmt);
1534 if (!is_gimple_min_invariant (e1))
1535 return expr;
1537 ee = expand_simple_operations (e);
1538 return fold_build2 (code, TREE_TYPE (expr), ee, e1);
1540 default:
1541 return expr;
1545 /* Tries to simplify EXPR using the condition COND. Returns the simplified
1546 expression (or EXPR unchanged, if no simplification was possible). */
1548 static tree
1549 tree_simplify_using_condition_1 (tree cond, tree expr)
1551 bool changed;
1552 tree e, te, e0, e1, e2, notcond;
1553 enum tree_code code = TREE_CODE (expr);
1555 if (code == INTEGER_CST)
1556 return expr;
1558 if (code == TRUTH_OR_EXPR
1559 || code == TRUTH_AND_EXPR
1560 || code == COND_EXPR)
1562 changed = false;
1564 e0 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 0));
1565 if (TREE_OPERAND (expr, 0) != e0)
1566 changed = true;
1568 e1 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 1));
1569 if (TREE_OPERAND (expr, 1) != e1)
1570 changed = true;
1572 if (code == COND_EXPR)
1574 e2 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 2));
1575 if (TREE_OPERAND (expr, 2) != e2)
1576 changed = true;
1578 else
1579 e2 = NULL_TREE;
1581 if (changed)
1583 if (code == COND_EXPR)
1584 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
1585 else
1586 expr = fold_build2 (code, boolean_type_node, e0, e1);
1589 return expr;
1592 /* In case COND is equality, we may be able to simplify EXPR by copy/constant
1593 propagation, and vice versa. Fold does not handle this, since it is
1594 considered too expensive. */
1595 if (TREE_CODE (cond) == EQ_EXPR)
1597 e0 = TREE_OPERAND (cond, 0);
1598 e1 = TREE_OPERAND (cond, 1);
1600 /* We know that e0 == e1. Check whether we cannot simplify expr
1601 using this fact. */
1602 e = simplify_replace_tree (expr, e0, e1);
1603 if (integer_zerop (e) || integer_nonzerop (e))
1604 return e;
1606 e = simplify_replace_tree (expr, e1, e0);
1607 if (integer_zerop (e) || integer_nonzerop (e))
1608 return e;
1610 if (TREE_CODE (expr) == EQ_EXPR)
1612 e0 = TREE_OPERAND (expr, 0);
1613 e1 = TREE_OPERAND (expr, 1);
1615 /* If e0 == e1 (EXPR) implies !COND, then EXPR cannot be true. */
1616 e = simplify_replace_tree (cond, e0, e1);
1617 if (integer_zerop (e))
1618 return e;
1619 e = simplify_replace_tree (cond, e1, e0);
1620 if (integer_zerop (e))
1621 return e;
1623 if (TREE_CODE (expr) == NE_EXPR)
1625 e0 = TREE_OPERAND (expr, 0);
1626 e1 = TREE_OPERAND (expr, 1);
1628 /* If e0 == e1 (!EXPR) implies !COND, then EXPR must be true. */
1629 e = simplify_replace_tree (cond, e0, e1);
1630 if (integer_zerop (e))
1631 return boolean_true_node;
1632 e = simplify_replace_tree (cond, e1, e0);
1633 if (integer_zerop (e))
1634 return boolean_true_node;
1637 te = expand_simple_operations (expr);
1639 /* Check whether COND ==> EXPR. */
1640 notcond = invert_truthvalue (cond);
1641 e = fold_binary (TRUTH_OR_EXPR, boolean_type_node, notcond, te);
1642 if (e && integer_nonzerop (e))
1643 return e;
1645 /* Check whether COND ==> not EXPR. */
1646 e = fold_binary (TRUTH_AND_EXPR, boolean_type_node, cond, te);
1647 if (e && integer_zerop (e))
1648 return e;
1650 return expr;
1653 /* Tries to simplify EXPR using the condition COND. Returns the simplified
1654 expression (or EXPR unchanged, if no simplification was possible).
1655 Wrapper around tree_simplify_using_condition_1 that ensures that chains
1656 of simple operations in definitions of ssa names in COND are expanded,
1657 so that things like casts or incrementing the value of the bound before
1658 the loop do not cause us to fail. */
1660 static tree
1661 tree_simplify_using_condition (tree cond, tree expr)
1663 cond = expand_simple_operations (cond);
1665 return tree_simplify_using_condition_1 (cond, expr);
1668 /* Tries to simplify EXPR using the conditions on entry to LOOP.
1669 Returns the simplified expression (or EXPR unchanged, if no
1670 simplification was possible).*/
1672 static tree
1673 simplify_using_initial_conditions (struct loop *loop, tree expr)
1675 edge e;
1676 basic_block bb;
1677 gimple stmt;
1678 tree cond;
1679 int cnt = 0;
1681 if (TREE_CODE (expr) == INTEGER_CST)
1682 return expr;
1684 /* Limit walking the dominators to avoid quadraticness in
1685 the number of BBs times the number of loops in degenerate
1686 cases. */
1687 for (bb = loop->header;
1688 bb != ENTRY_BLOCK_PTR && cnt < MAX_DOMINATORS_TO_WALK;
1689 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
1691 if (!single_pred_p (bb))
1692 continue;
1693 e = single_pred_edge (bb);
1695 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
1696 continue;
1698 stmt = last_stmt (e->src);
1699 cond = fold_build2 (gimple_cond_code (stmt),
1700 boolean_type_node,
1701 gimple_cond_lhs (stmt),
1702 gimple_cond_rhs (stmt));
1703 if (e->flags & EDGE_FALSE_VALUE)
1704 cond = invert_truthvalue (cond);
1705 expr = tree_simplify_using_condition (cond, expr);
1706 ++cnt;
1709 return expr;
1712 /* Tries to simplify EXPR using the evolutions of the loop invariants
1713 in the superloops of LOOP. Returns the simplified expression
1714 (or EXPR unchanged, if no simplification was possible). */
1716 static tree
1717 simplify_using_outer_evolutions (struct loop *loop, tree expr)
1719 enum tree_code code = TREE_CODE (expr);
1720 bool changed;
1721 tree e, e0, e1, e2;
1723 if (is_gimple_min_invariant (expr))
1724 return expr;
1726 if (code == TRUTH_OR_EXPR
1727 || code == TRUTH_AND_EXPR
1728 || code == COND_EXPR)
1730 changed = false;
1732 e0 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 0));
1733 if (TREE_OPERAND (expr, 0) != e0)
1734 changed = true;
1736 e1 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 1));
1737 if (TREE_OPERAND (expr, 1) != e1)
1738 changed = true;
1740 if (code == COND_EXPR)
1742 e2 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 2));
1743 if (TREE_OPERAND (expr, 2) != e2)
1744 changed = true;
1746 else
1747 e2 = NULL_TREE;
1749 if (changed)
1751 if (code == COND_EXPR)
1752 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
1753 else
1754 expr = fold_build2 (code, boolean_type_node, e0, e1);
1757 return expr;
1760 e = instantiate_parameters (loop, expr);
1761 if (is_gimple_min_invariant (e))
1762 return e;
1764 return expr;
1767 /* Returns true if EXIT is the only possible exit from LOOP. */
1769 bool
1770 loop_only_exit_p (const struct loop *loop, const_edge exit)
1772 basic_block *body;
1773 gimple_stmt_iterator bsi;
1774 unsigned i;
1775 gimple call;
1777 if (exit != single_exit (loop))
1778 return false;
1780 body = get_loop_body (loop);
1781 for (i = 0; i < loop->num_nodes; i++)
1783 for (bsi = gsi_start_bb (body[i]); !gsi_end_p (bsi); gsi_next (&bsi))
1785 call = gsi_stmt (bsi);
1786 if (gimple_code (call) != GIMPLE_CALL)
1787 continue;
1789 if (gimple_has_side_effects (call))
1791 free (body);
1792 return false;
1797 free (body);
1798 return true;
1801 /* Stores description of number of iterations of LOOP derived from
1802 EXIT (an exit edge of the LOOP) in NITER. Returns true if some
1803 useful information could be derived (and fields of NITER has
1804 meaning described in comments at struct tree_niter_desc
1805 declaration), false otherwise. If WARN is true and
1806 -Wunsafe-loop-optimizations was given, warn if the optimizer is going to use
1807 potentially unsafe assumptions.
1808 When EVERY_ITERATION is true, only tests that are known to be executed
1809 every iteration are considered (i.e. only test that alone bounds the loop).
1812 bool
1813 number_of_iterations_exit (struct loop *loop, edge exit,
1814 struct tree_niter_desc *niter,
1815 bool warn, bool every_iteration)
1817 gimple stmt;
1818 tree type;
1819 tree op0, op1;
1820 enum tree_code code;
1821 affine_iv iv0, iv1;
1822 bool safe;
1824 safe = dominated_by_p (CDI_DOMINATORS, loop->latch, exit->src);
1826 if (every_iteration && !safe)
1827 return false;
1829 niter->assumptions = boolean_false_node;
1830 stmt = last_stmt (exit->src);
1831 if (!stmt || gimple_code (stmt) != GIMPLE_COND)
1832 return false;
1834 /* We want the condition for staying inside loop. */
1835 code = gimple_cond_code (stmt);
1836 if (exit->flags & EDGE_TRUE_VALUE)
1837 code = invert_tree_comparison (code, false);
1839 switch (code)
1841 case GT_EXPR:
1842 case GE_EXPR:
1843 case LT_EXPR:
1844 case LE_EXPR:
1845 case NE_EXPR:
1846 break;
1848 default:
1849 return false;
1852 op0 = gimple_cond_lhs (stmt);
1853 op1 = gimple_cond_rhs (stmt);
1854 type = TREE_TYPE (op0);
1856 if (TREE_CODE (type) != INTEGER_TYPE
1857 && !POINTER_TYPE_P (type))
1858 return false;
1860 if (!simple_iv (loop, loop_containing_stmt (stmt), op0, &iv0, false))
1861 return false;
1862 if (!simple_iv (loop, loop_containing_stmt (stmt), op1, &iv1, false))
1863 return false;
1865 /* We don't want to see undefined signed overflow warnings while
1866 computing the number of iterations. */
1867 fold_defer_overflow_warnings ();
1869 iv0.base = expand_simple_operations (iv0.base);
1870 iv1.base = expand_simple_operations (iv1.base);
1871 if (!number_of_iterations_cond (loop, type, &iv0, code, &iv1, niter,
1872 loop_only_exit_p (loop, exit), safe))
1874 fold_undefer_and_ignore_overflow_warnings ();
1875 return false;
1878 if (optimize >= 3)
1880 niter->assumptions = simplify_using_outer_evolutions (loop,
1881 niter->assumptions);
1882 niter->may_be_zero = simplify_using_outer_evolutions (loop,
1883 niter->may_be_zero);
1884 niter->niter = simplify_using_outer_evolutions (loop, niter->niter);
1887 niter->assumptions
1888 = simplify_using_initial_conditions (loop,
1889 niter->assumptions);
1890 niter->may_be_zero
1891 = simplify_using_initial_conditions (loop,
1892 niter->may_be_zero);
1894 fold_undefer_and_ignore_overflow_warnings ();
1896 /* If NITER has simplified into a constant, update MAX. */
1897 if (TREE_CODE (niter->niter) == INTEGER_CST)
1898 niter->max = tree_to_double_int (niter->niter);
1900 if (integer_onep (niter->assumptions))
1901 return true;
1903 /* With -funsafe-loop-optimizations we assume that nothing bad can happen.
1904 But if we can prove that there is overflow or some other source of weird
1905 behavior, ignore the loop even with -funsafe-loop-optimizations. */
1906 if (integer_zerop (niter->assumptions) || !single_exit (loop))
1907 return false;
1909 if (flag_unsafe_loop_optimizations)
1910 niter->assumptions = boolean_true_node;
1912 if (warn)
1914 const char *wording;
1915 location_t loc = gimple_location (stmt);
1917 /* We can provide a more specific warning if one of the operator is
1918 constant and the other advances by +1 or -1. */
1919 if (!integer_zerop (iv1.step)
1920 ? (integer_zerop (iv0.step)
1921 && (integer_onep (iv1.step) || integer_all_onesp (iv1.step)))
1922 : (integer_onep (iv0.step) || integer_all_onesp (iv0.step)))
1923 wording =
1924 flag_unsafe_loop_optimizations
1925 ? N_("assuming that the loop is not infinite")
1926 : N_("cannot optimize possibly infinite loops");
1927 else
1928 wording =
1929 flag_unsafe_loop_optimizations
1930 ? N_("assuming that the loop counter does not overflow")
1931 : N_("cannot optimize loop, the loop counter may overflow");
1933 warning_at ((LOCATION_LINE (loc) > 0) ? loc : input_location,
1934 OPT_Wunsafe_loop_optimizations, "%s", gettext (wording));
1937 return flag_unsafe_loop_optimizations;
1940 /* Try to determine the number of iterations of LOOP. If we succeed,
1941 expression giving number of iterations is returned and *EXIT is
1942 set to the edge from that the information is obtained. Otherwise
1943 chrec_dont_know is returned. */
1945 tree
1946 find_loop_niter (struct loop *loop, edge *exit)
1948 unsigned i;
1949 vec<edge> exits = get_loop_exit_edges (loop);
1950 edge ex;
1951 tree niter = NULL_TREE, aniter;
1952 struct tree_niter_desc desc;
1954 *exit = NULL;
1955 FOR_EACH_VEC_ELT (exits, i, ex)
1957 if (!number_of_iterations_exit (loop, ex, &desc, false))
1958 continue;
1960 if (integer_nonzerop (desc.may_be_zero))
1962 /* We exit in the first iteration through this exit.
1963 We won't find anything better. */
1964 niter = build_int_cst (unsigned_type_node, 0);
1965 *exit = ex;
1966 break;
1969 if (!integer_zerop (desc.may_be_zero))
1970 continue;
1972 aniter = desc.niter;
1974 if (!niter)
1976 /* Nothing recorded yet. */
1977 niter = aniter;
1978 *exit = ex;
1979 continue;
1982 /* Prefer constants, the lower the better. */
1983 if (TREE_CODE (aniter) != INTEGER_CST)
1984 continue;
1986 if (TREE_CODE (niter) != INTEGER_CST)
1988 niter = aniter;
1989 *exit = ex;
1990 continue;
1993 if (tree_int_cst_lt (aniter, niter))
1995 niter = aniter;
1996 *exit = ex;
1997 continue;
2000 exits.release ();
2002 return niter ? niter : chrec_dont_know;
2005 /* Return true if loop is known to have bounded number of iterations. */
2007 bool
2008 finite_loop_p (struct loop *loop)
2010 double_int nit;
2011 int flags;
2013 if (flag_unsafe_loop_optimizations)
2014 return true;
2015 flags = flags_from_decl_or_type (current_function_decl);
2016 if ((flags & (ECF_CONST|ECF_PURE)) && !(flags & ECF_LOOPING_CONST_OR_PURE))
2018 if (dump_file && (dump_flags & TDF_DETAILS))
2019 fprintf (dump_file, "Found loop %i to be finite: it is within pure or const function.\n",
2020 loop->num);
2021 return true;
2024 if (loop->any_upper_bound
2025 || max_loop_iterations (loop, &nit))
2027 if (dump_file && (dump_flags & TDF_DETAILS))
2028 fprintf (dump_file, "Found loop %i to be finite: upper bound found.\n",
2029 loop->num);
2030 return true;
2032 return false;
2037 Analysis of a number of iterations of a loop by a brute-force evaluation.
2041 /* Bound on the number of iterations we try to evaluate. */
2043 #define MAX_ITERATIONS_TO_TRACK \
2044 ((unsigned) PARAM_VALUE (PARAM_MAX_ITERATIONS_TO_TRACK))
2046 /* Returns the loop phi node of LOOP such that ssa name X is derived from its
2047 result by a chain of operations such that all but exactly one of their
2048 operands are constants. */
2050 static gimple
2051 chain_of_csts_start (struct loop *loop, tree x)
2053 gimple stmt = SSA_NAME_DEF_STMT (x);
2054 tree use;
2055 basic_block bb = gimple_bb (stmt);
2056 enum tree_code code;
2058 if (!bb
2059 || !flow_bb_inside_loop_p (loop, bb))
2060 return NULL;
2062 if (gimple_code (stmt) == GIMPLE_PHI)
2064 if (bb == loop->header)
2065 return stmt;
2067 return NULL;
2070 if (gimple_code (stmt) != GIMPLE_ASSIGN)
2071 return NULL;
2073 code = gimple_assign_rhs_code (stmt);
2074 if (gimple_references_memory_p (stmt)
2075 || TREE_CODE_CLASS (code) == tcc_reference
2076 || (code == ADDR_EXPR
2077 && !is_gimple_min_invariant (gimple_assign_rhs1 (stmt))))
2078 return NULL;
2080 use = SINGLE_SSA_TREE_OPERAND (stmt, SSA_OP_USE);
2081 if (use == NULL_TREE)
2082 return NULL;
2084 return chain_of_csts_start (loop, use);
2087 /* Determines whether the expression X is derived from a result of a phi node
2088 in header of LOOP such that
2090 * the derivation of X consists only from operations with constants
2091 * the initial value of the phi node is constant
2092 * the value of the phi node in the next iteration can be derived from the
2093 value in the current iteration by a chain of operations with constants.
2095 If such phi node exists, it is returned, otherwise NULL is returned. */
2097 static gimple
2098 get_base_for (struct loop *loop, tree x)
2100 gimple phi;
2101 tree init, next;
2103 if (is_gimple_min_invariant (x))
2104 return NULL;
2106 phi = chain_of_csts_start (loop, x);
2107 if (!phi)
2108 return NULL;
2110 init = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2111 next = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2113 if (TREE_CODE (next) != SSA_NAME)
2114 return NULL;
2116 if (!is_gimple_min_invariant (init))
2117 return NULL;
2119 if (chain_of_csts_start (loop, next) != phi)
2120 return NULL;
2122 return phi;
2125 /* Given an expression X, then
2127 * if X is NULL_TREE, we return the constant BASE.
2128 * otherwise X is a SSA name, whose value in the considered loop is derived
2129 by a chain of operations with constant from a result of a phi node in
2130 the header of the loop. Then we return value of X when the value of the
2131 result of this phi node is given by the constant BASE. */
2133 static tree
2134 get_val_for (tree x, tree base)
2136 gimple stmt;
2138 gcc_assert (is_gimple_min_invariant (base));
2140 if (!x)
2141 return base;
2143 stmt = SSA_NAME_DEF_STMT (x);
2144 if (gimple_code (stmt) == GIMPLE_PHI)
2145 return base;
2147 gcc_assert (is_gimple_assign (stmt));
2149 /* STMT must be either an assignment of a single SSA name or an
2150 expression involving an SSA name and a constant. Try to fold that
2151 expression using the value for the SSA name. */
2152 if (gimple_assign_ssa_name_copy_p (stmt))
2153 return get_val_for (gimple_assign_rhs1 (stmt), base);
2154 else if (gimple_assign_rhs_class (stmt) == GIMPLE_UNARY_RHS
2155 && TREE_CODE (gimple_assign_rhs1 (stmt)) == SSA_NAME)
2157 return fold_build1 (gimple_assign_rhs_code (stmt),
2158 gimple_expr_type (stmt),
2159 get_val_for (gimple_assign_rhs1 (stmt), base));
2161 else if (gimple_assign_rhs_class (stmt) == GIMPLE_BINARY_RHS)
2163 tree rhs1 = gimple_assign_rhs1 (stmt);
2164 tree rhs2 = gimple_assign_rhs2 (stmt);
2165 if (TREE_CODE (rhs1) == SSA_NAME)
2166 rhs1 = get_val_for (rhs1, base);
2167 else if (TREE_CODE (rhs2) == SSA_NAME)
2168 rhs2 = get_val_for (rhs2, base);
2169 else
2170 gcc_unreachable ();
2171 return fold_build2 (gimple_assign_rhs_code (stmt),
2172 gimple_expr_type (stmt), rhs1, rhs2);
2174 else
2175 gcc_unreachable ();
2179 /* Tries to count the number of iterations of LOOP till it exits by EXIT
2180 by brute force -- i.e. by determining the value of the operands of the
2181 condition at EXIT in first few iterations of the loop (assuming that
2182 these values are constant) and determining the first one in that the
2183 condition is not satisfied. Returns the constant giving the number
2184 of the iterations of LOOP if successful, chrec_dont_know otherwise. */
2186 tree
2187 loop_niter_by_eval (struct loop *loop, edge exit)
2189 tree acnd;
2190 tree op[2], val[2], next[2], aval[2];
2191 gimple phi, cond;
2192 unsigned i, j;
2193 enum tree_code cmp;
2195 cond = last_stmt (exit->src);
2196 if (!cond || gimple_code (cond) != GIMPLE_COND)
2197 return chrec_dont_know;
2199 cmp = gimple_cond_code (cond);
2200 if (exit->flags & EDGE_TRUE_VALUE)
2201 cmp = invert_tree_comparison (cmp, false);
2203 switch (cmp)
2205 case EQ_EXPR:
2206 case NE_EXPR:
2207 case GT_EXPR:
2208 case GE_EXPR:
2209 case LT_EXPR:
2210 case LE_EXPR:
2211 op[0] = gimple_cond_lhs (cond);
2212 op[1] = gimple_cond_rhs (cond);
2213 break;
2215 default:
2216 return chrec_dont_know;
2219 for (j = 0; j < 2; j++)
2221 if (is_gimple_min_invariant (op[j]))
2223 val[j] = op[j];
2224 next[j] = NULL_TREE;
2225 op[j] = NULL_TREE;
2227 else
2229 phi = get_base_for (loop, op[j]);
2230 if (!phi)
2231 return chrec_dont_know;
2232 val[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2233 next[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2237 /* Don't issue signed overflow warnings. */
2238 fold_defer_overflow_warnings ();
2240 for (i = 0; i < MAX_ITERATIONS_TO_TRACK; i++)
2242 for (j = 0; j < 2; j++)
2243 aval[j] = get_val_for (op[j], val[j]);
2245 acnd = fold_binary (cmp, boolean_type_node, aval[0], aval[1]);
2246 if (acnd && integer_zerop (acnd))
2248 fold_undefer_and_ignore_overflow_warnings ();
2249 if (dump_file && (dump_flags & TDF_DETAILS))
2250 fprintf (dump_file,
2251 "Proved that loop %d iterates %d times using brute force.\n",
2252 loop->num, i);
2253 return build_int_cst (unsigned_type_node, i);
2256 for (j = 0; j < 2; j++)
2258 val[j] = get_val_for (next[j], val[j]);
2259 if (!is_gimple_min_invariant (val[j]))
2261 fold_undefer_and_ignore_overflow_warnings ();
2262 return chrec_dont_know;
2267 fold_undefer_and_ignore_overflow_warnings ();
2269 return chrec_dont_know;
2272 /* Finds the exit of the LOOP by that the loop exits after a constant
2273 number of iterations and stores the exit edge to *EXIT. The constant
2274 giving the number of iterations of LOOP is returned. The number of
2275 iterations is determined using loop_niter_by_eval (i.e. by brute force
2276 evaluation). If we are unable to find the exit for that loop_niter_by_eval
2277 determines the number of iterations, chrec_dont_know is returned. */
2279 tree
2280 find_loop_niter_by_eval (struct loop *loop, edge *exit)
2282 unsigned i;
2283 vec<edge> exits = get_loop_exit_edges (loop);
2284 edge ex;
2285 tree niter = NULL_TREE, aniter;
2287 *exit = NULL;
2289 /* Loops with multiple exits are expensive to handle and less important. */
2290 if (!flag_expensive_optimizations
2291 && exits.length () > 1)
2293 exits.release ();
2294 return chrec_dont_know;
2297 FOR_EACH_VEC_ELT (exits, i, ex)
2299 if (!just_once_each_iteration_p (loop, ex->src))
2300 continue;
2302 aniter = loop_niter_by_eval (loop, ex);
2303 if (chrec_contains_undetermined (aniter))
2304 continue;
2306 if (niter
2307 && !tree_int_cst_lt (aniter, niter))
2308 continue;
2310 niter = aniter;
2311 *exit = ex;
2313 exits.release ();
2315 return niter ? niter : chrec_dont_know;
2320 Analysis of upper bounds on number of iterations of a loop.
2324 static double_int derive_constant_upper_bound_ops (tree, tree,
2325 enum tree_code, tree);
2327 /* Returns a constant upper bound on the value of the right-hand side of
2328 an assignment statement STMT. */
2330 static double_int
2331 derive_constant_upper_bound_assign (gimple stmt)
2333 enum tree_code code = gimple_assign_rhs_code (stmt);
2334 tree op0 = gimple_assign_rhs1 (stmt);
2335 tree op1 = gimple_assign_rhs2 (stmt);
2337 return derive_constant_upper_bound_ops (TREE_TYPE (gimple_assign_lhs (stmt)),
2338 op0, code, op1);
2341 /* Returns a constant upper bound on the value of expression VAL. VAL
2342 is considered to be unsigned. If its type is signed, its value must
2343 be nonnegative. */
2345 static double_int
2346 derive_constant_upper_bound (tree val)
2348 enum tree_code code;
2349 tree op0, op1;
2351 extract_ops_from_tree (val, &code, &op0, &op1);
2352 return derive_constant_upper_bound_ops (TREE_TYPE (val), op0, code, op1);
2355 /* Returns a constant upper bound on the value of expression OP0 CODE OP1,
2356 whose type is TYPE. The expression is considered to be unsigned. If
2357 its type is signed, its value must be nonnegative. */
2359 static double_int
2360 derive_constant_upper_bound_ops (tree type, tree op0,
2361 enum tree_code code, tree op1)
2363 tree subtype, maxt;
2364 double_int bnd, max, mmax, cst;
2365 gimple stmt;
2367 if (INTEGRAL_TYPE_P (type))
2368 maxt = TYPE_MAX_VALUE (type);
2369 else
2370 maxt = upper_bound_in_type (type, type);
2372 max = tree_to_double_int (maxt);
2374 switch (code)
2376 case INTEGER_CST:
2377 return tree_to_double_int (op0);
2379 CASE_CONVERT:
2380 subtype = TREE_TYPE (op0);
2381 if (!TYPE_UNSIGNED (subtype)
2382 /* If TYPE is also signed, the fact that VAL is nonnegative implies
2383 that OP0 is nonnegative. */
2384 && TYPE_UNSIGNED (type)
2385 && !tree_expr_nonnegative_p (op0))
2387 /* If we cannot prove that the casted expression is nonnegative,
2388 we cannot establish more useful upper bound than the precision
2389 of the type gives us. */
2390 return max;
2393 /* We now know that op0 is an nonnegative value. Try deriving an upper
2394 bound for it. */
2395 bnd = derive_constant_upper_bound (op0);
2397 /* If the bound does not fit in TYPE, max. value of TYPE could be
2398 attained. */
2399 if (max.ult (bnd))
2400 return max;
2402 return bnd;
2404 case PLUS_EXPR:
2405 case POINTER_PLUS_EXPR:
2406 case MINUS_EXPR:
2407 if (TREE_CODE (op1) != INTEGER_CST
2408 || !tree_expr_nonnegative_p (op0))
2409 return max;
2411 /* Canonicalize to OP0 - CST. Consider CST to be signed, in order to
2412 choose the most logical way how to treat this constant regardless
2413 of the signedness of the type. */
2414 cst = tree_to_double_int (op1);
2415 cst = cst.sext (TYPE_PRECISION (type));
2416 if (code != MINUS_EXPR)
2417 cst = -cst;
2419 bnd = derive_constant_upper_bound (op0);
2421 if (cst.is_negative ())
2423 cst = -cst;
2424 /* Avoid CST == 0x80000... */
2425 if (cst.is_negative ())
2426 return max;;
2428 /* OP0 + CST. We need to check that
2429 BND <= MAX (type) - CST. */
2431 mmax -= cst;
2432 if (bnd.ugt (mmax))
2433 return max;
2435 return bnd + cst;
2437 else
2439 /* OP0 - CST, where CST >= 0.
2441 If TYPE is signed, we have already verified that OP0 >= 0, and we
2442 know that the result is nonnegative. This implies that
2443 VAL <= BND - CST.
2445 If TYPE is unsigned, we must additionally know that OP0 >= CST,
2446 otherwise the operation underflows.
2449 /* This should only happen if the type is unsigned; however, for
2450 buggy programs that use overflowing signed arithmetics even with
2451 -fno-wrapv, this condition may also be true for signed values. */
2452 if (bnd.ult (cst))
2453 return max;
2455 if (TYPE_UNSIGNED (type))
2457 tree tem = fold_binary (GE_EXPR, boolean_type_node, op0,
2458 double_int_to_tree (type, cst));
2459 if (!tem || integer_nonzerop (tem))
2460 return max;
2463 bnd -= cst;
2466 return bnd;
2468 case FLOOR_DIV_EXPR:
2469 case EXACT_DIV_EXPR:
2470 if (TREE_CODE (op1) != INTEGER_CST
2471 || tree_int_cst_sign_bit (op1))
2472 return max;
2474 bnd = derive_constant_upper_bound (op0);
2475 return bnd.udiv (tree_to_double_int (op1), FLOOR_DIV_EXPR);
2477 case BIT_AND_EXPR:
2478 if (TREE_CODE (op1) != INTEGER_CST
2479 || tree_int_cst_sign_bit (op1))
2480 return max;
2481 return tree_to_double_int (op1);
2483 case SSA_NAME:
2484 stmt = SSA_NAME_DEF_STMT (op0);
2485 if (gimple_code (stmt) != GIMPLE_ASSIGN
2486 || gimple_assign_lhs (stmt) != op0)
2487 return max;
2488 return derive_constant_upper_bound_assign (stmt);
2490 default:
2491 return max;
2495 /* Records that every statement in LOOP is executed I_BOUND times.
2496 REALISTIC is true if I_BOUND is expected to be close to the real number
2497 of iterations. UPPER is true if we are sure the loop iterates at most
2498 I_BOUND times. */
2500 void
2501 record_niter_bound (struct loop *loop, double_int i_bound, bool realistic,
2502 bool upper)
2504 /* Update the bounds only when there is no previous estimation, or when the
2505 current estimation is smaller. */
2506 if (upper
2507 && (!loop->any_upper_bound
2508 || i_bound.ult (loop->nb_iterations_upper_bound)))
2510 loop->any_upper_bound = true;
2511 loop->nb_iterations_upper_bound = i_bound;
2513 if (realistic
2514 && (!loop->any_estimate
2515 || i_bound.ult (loop->nb_iterations_estimate)))
2517 loop->any_estimate = true;
2518 loop->nb_iterations_estimate = i_bound;
2521 /* If an upper bound is smaller than the realistic estimate of the
2522 number of iterations, use the upper bound instead. */
2523 if (loop->any_upper_bound
2524 && loop->any_estimate
2525 && loop->nb_iterations_upper_bound.ult (loop->nb_iterations_estimate))
2526 loop->nb_iterations_estimate = loop->nb_iterations_upper_bound;
2529 /* Emit a -Waggressive-loop-optimizations warning if needed. */
2531 static void
2532 do_warn_aggressive_loop_optimizations (struct loop *loop,
2533 double_int i_bound, gimple stmt)
2535 /* Don't warn if the loop doesn't have known constant bound. */
2536 if (!loop->nb_iterations
2537 || TREE_CODE (loop->nb_iterations) != INTEGER_CST
2538 || !warn_aggressive_loop_optimizations
2539 /* To avoid warning multiple times for the same loop,
2540 only start warning when we preserve loops. */
2541 || (cfun->curr_properties & PROP_loops) == 0
2542 /* Only warn once per loop. */
2543 || loop->warned_aggressive_loop_optimizations
2544 /* Only warn if undefined behavior gives us lower estimate than the
2545 known constant bound. */
2546 || i_bound.ucmp (tree_to_double_int (loop->nb_iterations)) >= 0
2547 /* And undefined behavior happens unconditionally. */
2548 || !dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (stmt)))
2549 return;
2551 edge e = single_exit (loop);
2552 if (e == NULL)
2553 return;
2555 gimple estmt = last_stmt (e->src);
2556 warning_at (gimple_location (stmt), OPT_Waggressive_loop_optimizations,
2557 "iteration %E invokes undefined behavior",
2558 double_int_to_tree (TREE_TYPE (loop->nb_iterations), i_bound));
2559 inform (gimple_location (estmt), "containing loop");
2560 loop->warned_aggressive_loop_optimizations = true;
2563 /* Records that AT_STMT is executed at most BOUND + 1 times in LOOP. IS_EXIT
2564 is true if the loop is exited immediately after STMT, and this exit
2565 is taken at last when the STMT is executed BOUND + 1 times.
2566 REALISTIC is true if BOUND is expected to be close to the real number
2567 of iterations. UPPER is true if we are sure the loop iterates at most
2568 BOUND times. I_BOUND is an unsigned double_int upper estimate on BOUND. */
2570 static void
2571 record_estimate (struct loop *loop, tree bound, double_int i_bound,
2572 gimple at_stmt, bool is_exit, bool realistic, bool upper)
2574 double_int delta;
2576 if (dump_file && (dump_flags & TDF_DETAILS))
2578 fprintf (dump_file, "Statement %s", is_exit ? "(exit)" : "");
2579 print_gimple_stmt (dump_file, at_stmt, 0, TDF_SLIM);
2580 fprintf (dump_file, " is %sexecuted at most ",
2581 upper ? "" : "probably ");
2582 print_generic_expr (dump_file, bound, TDF_SLIM);
2583 fprintf (dump_file, " (bounded by ");
2584 dump_double_int (dump_file, i_bound, true);
2585 fprintf (dump_file, ") + 1 times in loop %d.\n", loop->num);
2588 /* If the I_BOUND is just an estimate of BOUND, it rarely is close to the
2589 real number of iterations. */
2590 if (TREE_CODE (bound) != INTEGER_CST)
2591 realistic = false;
2592 else
2593 gcc_checking_assert (i_bound == tree_to_double_int (bound));
2594 if (!upper && !realistic)
2595 return;
2597 /* If we have a guaranteed upper bound, record it in the appropriate
2598 list, unless this is an !is_exit bound (i.e. undefined behavior in
2599 at_stmt) in a loop with known constant number of iterations. */
2600 if (upper
2601 && (is_exit
2602 || loop->nb_iterations == NULL_TREE
2603 || TREE_CODE (loop->nb_iterations) != INTEGER_CST))
2605 struct nb_iter_bound *elt = ggc_alloc_nb_iter_bound ();
2607 elt->bound = i_bound;
2608 elt->stmt = at_stmt;
2609 elt->is_exit = is_exit;
2610 elt->next = loop->bounds;
2611 loop->bounds = elt;
2614 /* If statement is executed on every path to the loop latch, we can directly
2615 infer the upper bound on the # of iterations of the loop. */
2616 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (at_stmt)))
2617 return;
2619 /* Update the number of iteration estimates according to the bound.
2620 If at_stmt is an exit then the loop latch is executed at most BOUND times,
2621 otherwise it can be executed BOUND + 1 times. We will lower the estimate
2622 later if such statement must be executed on last iteration */
2623 if (is_exit)
2624 delta = double_int_zero;
2625 else
2626 delta = double_int_one;
2627 i_bound += delta;
2629 /* If an overflow occurred, ignore the result. */
2630 if (i_bound.ult (delta))
2631 return;
2633 if (upper && !is_exit)
2634 do_warn_aggressive_loop_optimizations (loop, i_bound, at_stmt);
2635 record_niter_bound (loop, i_bound, realistic, upper);
2638 /* Record the estimate on number of iterations of LOOP based on the fact that
2639 the induction variable BASE + STEP * i evaluated in STMT does not wrap and
2640 its values belong to the range <LOW, HIGH>. REALISTIC is true if the
2641 estimated number of iterations is expected to be close to the real one.
2642 UPPER is true if we are sure the induction variable does not wrap. */
2644 static void
2645 record_nonwrapping_iv (struct loop *loop, tree base, tree step, gimple stmt,
2646 tree low, tree high, bool realistic, bool upper)
2648 tree niter_bound, extreme, delta;
2649 tree type = TREE_TYPE (base), unsigned_type;
2650 double_int max;
2652 if (TREE_CODE (step) != INTEGER_CST || integer_zerop (step))
2653 return;
2655 if (dump_file && (dump_flags & TDF_DETAILS))
2657 fprintf (dump_file, "Induction variable (");
2658 print_generic_expr (dump_file, TREE_TYPE (base), TDF_SLIM);
2659 fprintf (dump_file, ") ");
2660 print_generic_expr (dump_file, base, TDF_SLIM);
2661 fprintf (dump_file, " + ");
2662 print_generic_expr (dump_file, step, TDF_SLIM);
2663 fprintf (dump_file, " * iteration does not wrap in statement ");
2664 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
2665 fprintf (dump_file, " in loop %d.\n", loop->num);
2668 unsigned_type = unsigned_type_for (type);
2669 base = fold_convert (unsigned_type, base);
2670 step = fold_convert (unsigned_type, step);
2672 if (tree_int_cst_sign_bit (step))
2674 extreme = fold_convert (unsigned_type, low);
2675 if (TREE_CODE (base) != INTEGER_CST)
2676 base = fold_convert (unsigned_type, high);
2677 delta = fold_build2 (MINUS_EXPR, unsigned_type, base, extreme);
2678 step = fold_build1 (NEGATE_EXPR, unsigned_type, step);
2680 else
2682 extreme = fold_convert (unsigned_type, high);
2683 if (TREE_CODE (base) != INTEGER_CST)
2684 base = fold_convert (unsigned_type, low);
2685 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, base);
2688 /* STMT is executed at most NITER_BOUND + 1 times, since otherwise the value
2689 would get out of the range. */
2690 niter_bound = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step);
2691 max = derive_constant_upper_bound (niter_bound);
2692 record_estimate (loop, niter_bound, max, stmt, false, realistic, upper);
2695 /* Determine information about number of iterations a LOOP from the index
2696 IDX of a data reference accessed in STMT. RELIABLE is true if STMT is
2697 guaranteed to be executed in every iteration of LOOP. Callback for
2698 for_each_index. */
2700 struct ilb_data
2702 struct loop *loop;
2703 gimple stmt;
2706 static bool
2707 idx_infer_loop_bounds (tree base, tree *idx, void *dta)
2709 struct ilb_data *data = (struct ilb_data *) dta;
2710 tree ev, init, step;
2711 tree low, high, type, next;
2712 bool sign, upper = true, at_end = false;
2713 struct loop *loop = data->loop;
2714 bool reliable = true;
2716 if (TREE_CODE (base) != ARRAY_REF)
2717 return true;
2719 /* For arrays at the end of the structure, we are not guaranteed that they
2720 do not really extend over their declared size. However, for arrays of
2721 size greater than one, this is unlikely to be intended. */
2722 if (array_at_struct_end_p (base))
2724 at_end = true;
2725 upper = false;
2728 struct loop *dloop = loop_containing_stmt (data->stmt);
2729 if (!dloop)
2730 return true;
2732 ev = analyze_scalar_evolution (dloop, *idx);
2733 ev = instantiate_parameters (loop, ev);
2734 init = initial_condition (ev);
2735 step = evolution_part_in_loop_num (ev, loop->num);
2737 if (!init
2738 || !step
2739 || TREE_CODE (step) != INTEGER_CST
2740 || integer_zerop (step)
2741 || tree_contains_chrecs (init, NULL)
2742 || chrec_contains_symbols_defined_in_loop (init, loop->num))
2743 return true;
2745 low = array_ref_low_bound (base);
2746 high = array_ref_up_bound (base);
2748 /* The case of nonconstant bounds could be handled, but it would be
2749 complicated. */
2750 if (TREE_CODE (low) != INTEGER_CST
2751 || !high
2752 || TREE_CODE (high) != INTEGER_CST)
2753 return true;
2754 sign = tree_int_cst_sign_bit (step);
2755 type = TREE_TYPE (step);
2757 /* The array of length 1 at the end of a structure most likely extends
2758 beyond its bounds. */
2759 if (at_end
2760 && operand_equal_p (low, high, 0))
2761 return true;
2763 /* In case the relevant bound of the array does not fit in type, or
2764 it does, but bound + step (in type) still belongs into the range of the
2765 array, the index may wrap and still stay within the range of the array
2766 (consider e.g. if the array is indexed by the full range of
2767 unsigned char).
2769 To make things simpler, we require both bounds to fit into type, although
2770 there are cases where this would not be strictly necessary. */
2771 if (!int_fits_type_p (high, type)
2772 || !int_fits_type_p (low, type))
2773 return true;
2774 low = fold_convert (type, low);
2775 high = fold_convert (type, high);
2777 if (sign)
2778 next = fold_binary (PLUS_EXPR, type, low, step);
2779 else
2780 next = fold_binary (PLUS_EXPR, type, high, step);
2782 if (tree_int_cst_compare (low, next) <= 0
2783 && tree_int_cst_compare (next, high) <= 0)
2784 return true;
2786 /* If access is not executed on every iteration, we must ensure that overlow may
2787 not make the access valid later. */
2788 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, gimple_bb (data->stmt))
2789 && scev_probably_wraps_p (initial_condition_in_loop_num (ev, loop->num),
2790 step, data->stmt, loop, true))
2791 reliable = false;
2793 record_nonwrapping_iv (loop, init, step, data->stmt, low, high, reliable, upper);
2794 return true;
2797 /* Determine information about number of iterations a LOOP from the bounds
2798 of arrays in the data reference REF accessed in STMT. RELIABLE is true if
2799 STMT is guaranteed to be executed in every iteration of LOOP.*/
2801 static void
2802 infer_loop_bounds_from_ref (struct loop *loop, gimple stmt, tree ref)
2804 struct ilb_data data;
2806 data.loop = loop;
2807 data.stmt = stmt;
2808 for_each_index (&ref, idx_infer_loop_bounds, &data);
2811 /* Determine information about number of iterations of a LOOP from the way
2812 arrays are used in STMT. RELIABLE is true if STMT is guaranteed to be
2813 executed in every iteration of LOOP. */
2815 static void
2816 infer_loop_bounds_from_array (struct loop *loop, gimple stmt)
2818 if (is_gimple_assign (stmt))
2820 tree op0 = gimple_assign_lhs (stmt);
2821 tree op1 = gimple_assign_rhs1 (stmt);
2823 /* For each memory access, analyze its access function
2824 and record a bound on the loop iteration domain. */
2825 if (REFERENCE_CLASS_P (op0))
2826 infer_loop_bounds_from_ref (loop, stmt, op0);
2828 if (REFERENCE_CLASS_P (op1))
2829 infer_loop_bounds_from_ref (loop, stmt, op1);
2831 else if (is_gimple_call (stmt))
2833 tree arg, lhs;
2834 unsigned i, n = gimple_call_num_args (stmt);
2836 lhs = gimple_call_lhs (stmt);
2837 if (lhs && REFERENCE_CLASS_P (lhs))
2838 infer_loop_bounds_from_ref (loop, stmt, lhs);
2840 for (i = 0; i < n; i++)
2842 arg = gimple_call_arg (stmt, i);
2843 if (REFERENCE_CLASS_P (arg))
2844 infer_loop_bounds_from_ref (loop, stmt, arg);
2849 /* Determine information about number of iterations of a LOOP from the fact
2850 that pointer arithmetics in STMT does not overflow. */
2852 static void
2853 infer_loop_bounds_from_pointer_arith (struct loop *loop, gimple stmt)
2855 tree def, base, step, scev, type, low, high;
2856 tree var, ptr;
2858 if (!is_gimple_assign (stmt)
2859 || gimple_assign_rhs_code (stmt) != POINTER_PLUS_EXPR)
2860 return;
2862 def = gimple_assign_lhs (stmt);
2863 if (TREE_CODE (def) != SSA_NAME)
2864 return;
2866 type = TREE_TYPE (def);
2867 if (!nowrap_type_p (type))
2868 return;
2870 ptr = gimple_assign_rhs1 (stmt);
2871 if (!expr_invariant_in_loop_p (loop, ptr))
2872 return;
2874 var = gimple_assign_rhs2 (stmt);
2875 if (TYPE_PRECISION (type) != TYPE_PRECISION (TREE_TYPE (var)))
2876 return;
2878 scev = instantiate_parameters (loop, analyze_scalar_evolution (loop, def));
2879 if (chrec_contains_undetermined (scev))
2880 return;
2882 base = initial_condition_in_loop_num (scev, loop->num);
2883 step = evolution_part_in_loop_num (scev, loop->num);
2885 if (!base || !step
2886 || TREE_CODE (step) != INTEGER_CST
2887 || tree_contains_chrecs (base, NULL)
2888 || chrec_contains_symbols_defined_in_loop (base, loop->num))
2889 return;
2891 low = lower_bound_in_type (type, type);
2892 high = upper_bound_in_type (type, type);
2894 /* In C, pointer arithmetic p + 1 cannot use a NULL pointer, and p - 1 cannot
2895 produce a NULL pointer. The contrary would mean NULL points to an object,
2896 while NULL is supposed to compare unequal with the address of all objects.
2897 Furthermore, p + 1 cannot produce a NULL pointer and p - 1 cannot use a
2898 NULL pointer since that would mean wrapping, which we assume here not to
2899 happen. So, we can exclude NULL from the valid range of pointer
2900 arithmetic. */
2901 if (flag_delete_null_pointer_checks && int_cst_value (low) == 0)
2902 low = build_int_cstu (TREE_TYPE (low), TYPE_ALIGN_UNIT (TREE_TYPE (type)));
2904 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
2907 /* Determine information about number of iterations of a LOOP from the fact
2908 that signed arithmetics in STMT does not overflow. */
2910 static void
2911 infer_loop_bounds_from_signedness (struct loop *loop, gimple stmt)
2913 tree def, base, step, scev, type, low, high;
2915 if (gimple_code (stmt) != GIMPLE_ASSIGN)
2916 return;
2918 def = gimple_assign_lhs (stmt);
2920 if (TREE_CODE (def) != SSA_NAME)
2921 return;
2923 type = TREE_TYPE (def);
2924 if (!INTEGRAL_TYPE_P (type)
2925 || !TYPE_OVERFLOW_UNDEFINED (type))
2926 return;
2928 scev = instantiate_parameters (loop, analyze_scalar_evolution (loop, def));
2929 if (chrec_contains_undetermined (scev))
2930 return;
2932 base = initial_condition_in_loop_num (scev, loop->num);
2933 step = evolution_part_in_loop_num (scev, loop->num);
2935 if (!base || !step
2936 || TREE_CODE (step) != INTEGER_CST
2937 || tree_contains_chrecs (base, NULL)
2938 || chrec_contains_symbols_defined_in_loop (base, loop->num))
2939 return;
2941 low = lower_bound_in_type (type, type);
2942 high = upper_bound_in_type (type, type);
2944 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
2947 /* The following analyzers are extracting informations on the bounds
2948 of LOOP from the following undefined behaviors:
2950 - data references should not access elements over the statically
2951 allocated size,
2953 - signed variables should not overflow when flag_wrapv is not set.
2956 static void
2957 infer_loop_bounds_from_undefined (struct loop *loop)
2959 unsigned i;
2960 basic_block *bbs;
2961 gimple_stmt_iterator bsi;
2962 basic_block bb;
2963 bool reliable;
2965 bbs = get_loop_body (loop);
2967 for (i = 0; i < loop->num_nodes; i++)
2969 bb = bbs[i];
2971 /* If BB is not executed in each iteration of the loop, we cannot
2972 use the operations in it to infer reliable upper bound on the
2973 # of iterations of the loop. However, we can use it as a guess.
2974 Reliable guesses come only from array bounds. */
2975 reliable = dominated_by_p (CDI_DOMINATORS, loop->latch, bb);
2977 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
2979 gimple stmt = gsi_stmt (bsi);
2981 infer_loop_bounds_from_array (loop, stmt);
2983 if (reliable)
2985 infer_loop_bounds_from_signedness (loop, stmt);
2986 infer_loop_bounds_from_pointer_arith (loop, stmt);
2992 free (bbs);
2995 /* Converts VAL to double_int. */
2997 static double_int
2998 gcov_type_to_double_int (gcov_type val)
3000 double_int ret;
3002 ret.low = (unsigned HOST_WIDE_INT) val;
3003 /* If HOST_BITS_PER_WIDE_INT == HOST_BITS_PER_WIDEST_INT, avoid shifting by
3004 the size of type. */
3005 val >>= HOST_BITS_PER_WIDE_INT - 1;
3006 val >>= 1;
3007 ret.high = (unsigned HOST_WIDE_INT) val;
3009 return ret;
3012 /* Compare double ints, callback for qsort. */
3015 double_int_cmp (const void *p1, const void *p2)
3017 const double_int *d1 = (const double_int *)p1;
3018 const double_int *d2 = (const double_int *)p2;
3019 if (*d1 == *d2)
3020 return 0;
3021 if (d1->ult (*d2))
3022 return -1;
3023 return 1;
3026 /* Return index of BOUND in BOUNDS array sorted in increasing order.
3027 Lookup by binary search. */
3030 bound_index (vec<double_int> bounds, double_int bound)
3032 unsigned int end = bounds.length ();
3033 unsigned int begin = 0;
3035 /* Find a matching index by means of a binary search. */
3036 while (begin != end)
3038 unsigned int middle = (begin + end) / 2;
3039 double_int index = bounds[middle];
3041 if (index == bound)
3042 return middle;
3043 else if (index.ult (bound))
3044 begin = middle + 1;
3045 else
3046 end = middle;
3048 gcc_unreachable ();
3051 /* We recorded loop bounds only for statements dominating loop latch (and thus
3052 executed each loop iteration). If there are any bounds on statements not
3053 dominating the loop latch we can improve the estimate by walking the loop
3054 body and seeing if every path from loop header to loop latch contains
3055 some bounded statement. */
3057 static void
3058 discover_iteration_bound_by_body_walk (struct loop *loop)
3060 pointer_map_t *bb_bounds;
3061 struct nb_iter_bound *elt;
3062 vec<double_int> bounds = vNULL;
3063 vec<vec<basic_block> > queues = vNULL;
3064 vec<basic_block> queue = vNULL;
3065 ptrdiff_t queue_index;
3066 ptrdiff_t latch_index = 0;
3067 pointer_map_t *block_priority;
3069 /* Discover what bounds may interest us. */
3070 for (elt = loop->bounds; elt; elt = elt->next)
3072 double_int bound = elt->bound;
3074 /* Exit terminates loop at given iteration, while non-exits produce undefined
3075 effect on the next iteration. */
3076 if (!elt->is_exit)
3078 bound += double_int_one;
3079 /* If an overflow occurred, ignore the result. */
3080 if (bound.is_zero ())
3081 continue;
3084 if (!loop->any_upper_bound
3085 || bound.ult (loop->nb_iterations_upper_bound))
3086 bounds.safe_push (bound);
3089 /* Exit early if there is nothing to do. */
3090 if (!bounds.exists ())
3091 return;
3093 if (dump_file && (dump_flags & TDF_DETAILS))
3094 fprintf (dump_file, " Trying to walk loop body to reduce the bound.\n");
3096 /* Sort the bounds in decreasing order. */
3097 qsort (bounds.address (), bounds.length (),
3098 sizeof (double_int), double_int_cmp);
3100 /* For every basic block record the lowest bound that is guaranteed to
3101 terminate the loop. */
3103 bb_bounds = pointer_map_create ();
3104 for (elt = loop->bounds; elt; elt = elt->next)
3106 double_int bound = elt->bound;
3107 if (!elt->is_exit)
3109 bound += double_int_one;
3110 /* If an overflow occurred, ignore the result. */
3111 if (bound.is_zero ())
3112 continue;
3115 if (!loop->any_upper_bound
3116 || bound.ult (loop->nb_iterations_upper_bound))
3118 ptrdiff_t index = bound_index (bounds, bound);
3119 void **entry = pointer_map_contains (bb_bounds,
3120 gimple_bb (elt->stmt));
3121 if (!entry)
3122 *pointer_map_insert (bb_bounds,
3123 gimple_bb (elt->stmt)) = (void *)index;
3124 else if ((ptrdiff_t)*entry > index)
3125 *entry = (void *)index;
3129 block_priority = pointer_map_create ();
3131 /* Perform shortest path discovery loop->header ... loop->latch.
3133 The "distance" is given by the smallest loop bound of basic block
3134 present in the path and we look for path with largest smallest bound
3135 on it.
3137 To avoid the need for fibonacci heap on double ints we simply compress
3138 double ints into indexes to BOUNDS array and then represent the queue
3139 as arrays of queues for every index.
3140 Index of BOUNDS.length() means that the execution of given BB has
3141 no bounds determined.
3143 VISITED is a pointer map translating basic block into smallest index
3144 it was inserted into the priority queue with. */
3145 latch_index = -1;
3147 /* Start walk in loop header with index set to infinite bound. */
3148 queue_index = bounds.length ();
3149 queues.safe_grow_cleared (queue_index + 1);
3150 queue.safe_push (loop->header);
3151 queues[queue_index] = queue;
3152 *pointer_map_insert (block_priority, loop->header) = (void *)queue_index;
3154 for (; queue_index >= 0; queue_index--)
3156 if (latch_index < queue_index)
3158 while (queues[queue_index].length ())
3160 basic_block bb;
3161 ptrdiff_t bound_index = queue_index;
3162 void **entry;
3163 edge e;
3164 edge_iterator ei;
3166 queue = queues[queue_index];
3167 bb = queue.pop ();
3169 /* OK, we later inserted the BB with lower priority, skip it. */
3170 if ((ptrdiff_t)*pointer_map_contains (block_priority, bb) > queue_index)
3171 continue;
3173 /* See if we can improve the bound. */
3174 entry = pointer_map_contains (bb_bounds, bb);
3175 if (entry && (ptrdiff_t)*entry < bound_index)
3176 bound_index = (ptrdiff_t)*entry;
3178 /* Insert succesors into the queue, watch for latch edge
3179 and record greatest index we saw. */
3180 FOR_EACH_EDGE (e, ei, bb->succs)
3182 bool insert = false;
3183 void **entry;
3185 if (loop_exit_edge_p (loop, e))
3186 continue;
3188 if (e == loop_latch_edge (loop)
3189 && latch_index < bound_index)
3190 latch_index = bound_index;
3191 else if (!(entry = pointer_map_contains (block_priority, e->dest)))
3193 insert = true;
3194 *pointer_map_insert (block_priority, e->dest) = (void *)bound_index;
3196 else if ((ptrdiff_t)*entry < bound_index)
3198 insert = true;
3199 *entry = (void *)bound_index;
3202 if (insert)
3203 queues[bound_index].safe_push (e->dest);
3207 queues[queue_index].release ();
3210 gcc_assert (latch_index >= 0);
3211 if ((unsigned)latch_index < bounds.length ())
3213 if (dump_file && (dump_flags & TDF_DETAILS))
3215 fprintf (dump_file, "Found better loop bound ");
3216 dump_double_int (dump_file, bounds[latch_index], true);
3217 fprintf (dump_file, "\n");
3219 record_niter_bound (loop, bounds[latch_index], false, true);
3222 queues.release ();
3223 bounds.release ();
3224 pointer_map_destroy (bb_bounds);
3225 pointer_map_destroy (block_priority);
3228 /* See if every path cross the loop goes through a statement that is known
3229 to not execute at the last iteration. In that case we can decrese iteration
3230 count by 1. */
3232 static void
3233 maybe_lower_iteration_bound (struct loop *loop)
3235 pointer_set_t *not_executed_last_iteration = NULL;
3236 struct nb_iter_bound *elt;
3237 bool found_exit = false;
3238 vec<basic_block> queue = vNULL;
3239 bitmap visited;
3241 /* Collect all statements with interesting (i.e. lower than
3242 nb_iterations_upper_bound) bound on them.
3244 TODO: Due to the way record_estimate choose estimates to store, the bounds
3245 will be always nb_iterations_upper_bound-1. We can change this to record
3246 also statements not dominating the loop latch and update the walk bellow
3247 to the shortest path algorthm. */
3248 for (elt = loop->bounds; elt; elt = elt->next)
3250 if (!elt->is_exit
3251 && elt->bound.ult (loop->nb_iterations_upper_bound))
3253 if (!not_executed_last_iteration)
3254 not_executed_last_iteration = pointer_set_create ();
3255 pointer_set_insert (not_executed_last_iteration, elt->stmt);
3258 if (!not_executed_last_iteration)
3259 return;
3261 /* Start DFS walk in the loop header and see if we can reach the
3262 loop latch or any of the exits (including statements with side
3263 effects that may terminate the loop otherwise) without visiting
3264 any of the statements known to have undefined effect on the last
3265 iteration. */
3266 queue.safe_push (loop->header);
3267 visited = BITMAP_ALLOC (NULL);
3268 bitmap_set_bit (visited, loop->header->index);
3269 found_exit = false;
3273 basic_block bb = queue.pop ();
3274 gimple_stmt_iterator gsi;
3275 bool stmt_found = false;
3277 /* Loop for possible exits and statements bounding the execution. */
3278 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
3280 gimple stmt = gsi_stmt (gsi);
3281 if (pointer_set_contains (not_executed_last_iteration, stmt))
3283 stmt_found = true;
3284 break;
3286 if (gimple_has_side_effects (stmt))
3288 found_exit = true;
3289 break;
3292 if (found_exit)
3293 break;
3295 /* If no bounding statement is found, continue the walk. */
3296 if (!stmt_found)
3298 edge e;
3299 edge_iterator ei;
3301 FOR_EACH_EDGE (e, ei, bb->succs)
3303 if (loop_exit_edge_p (loop, e)
3304 || e == loop_latch_edge (loop))
3306 found_exit = true;
3307 break;
3309 if (bitmap_set_bit (visited, e->dest->index))
3310 queue.safe_push (e->dest);
3314 while (queue.length () && !found_exit);
3316 /* If every path through the loop reach bounding statement before exit,
3317 then we know the last iteration of the loop will have undefined effect
3318 and we can decrease number of iterations. */
3320 if (!found_exit)
3322 if (dump_file && (dump_flags & TDF_DETAILS))
3323 fprintf (dump_file, "Reducing loop iteration estimate by 1; "
3324 "undefined statement must be executed at the last iteration.\n");
3325 record_niter_bound (loop, loop->nb_iterations_upper_bound - double_int_one,
3326 false, true);
3328 BITMAP_FREE (visited);
3329 queue.release ();
3330 pointer_set_destroy (not_executed_last_iteration);
3333 /* Records estimates on numbers of iterations of LOOP. If USE_UNDEFINED_P
3334 is true also use estimates derived from undefined behavior. */
3336 void
3337 estimate_numbers_of_iterations_loop (struct loop *loop)
3339 vec<edge> exits;
3340 tree niter, type;
3341 unsigned i;
3342 struct tree_niter_desc niter_desc;
3343 edge ex;
3344 double_int bound;
3345 edge likely_exit;
3347 /* Give up if we already have tried to compute an estimation. */
3348 if (loop->estimate_state != EST_NOT_COMPUTED)
3349 return;
3351 loop->estimate_state = EST_AVAILABLE;
3352 /* Force estimate compuation but leave any existing upper bound in place. */
3353 loop->any_estimate = false;
3355 /* Ensure that loop->nb_iterations is computed if possible. If it turns out
3356 to be constant, we avoid undefined behavior implied bounds and instead
3357 diagnose those loops with -Waggressive-loop-optimizations. */
3358 number_of_latch_executions (loop);
3360 exits = get_loop_exit_edges (loop);
3361 likely_exit = single_likely_exit (loop);
3362 FOR_EACH_VEC_ELT (exits, i, ex)
3364 if (!number_of_iterations_exit (loop, ex, &niter_desc, false, false))
3365 continue;
3367 niter = niter_desc.niter;
3368 type = TREE_TYPE (niter);
3369 if (TREE_CODE (niter_desc.may_be_zero) != INTEGER_CST)
3370 niter = build3 (COND_EXPR, type, niter_desc.may_be_zero,
3371 build_int_cst (type, 0),
3372 niter);
3373 record_estimate (loop, niter, niter_desc.max,
3374 last_stmt (ex->src),
3375 true, ex == likely_exit, true);
3377 exits.release ();
3379 if (flag_aggressive_loop_optimizations)
3380 infer_loop_bounds_from_undefined (loop);
3382 discover_iteration_bound_by_body_walk (loop);
3384 maybe_lower_iteration_bound (loop);
3386 /* If we have a measured profile, use it to estimate the number of
3387 iterations. */
3388 if (loop->header->count != 0)
3390 gcov_type nit = expected_loop_iterations_unbounded (loop) + 1;
3391 bound = gcov_type_to_double_int (nit);
3392 record_niter_bound (loop, bound, true, false);
3395 /* If we know the exact number of iterations of this loop, try to
3396 not break code with undefined behavior by not recording smaller
3397 maximum number of iterations. */
3398 if (loop->nb_iterations
3399 && TREE_CODE (loop->nb_iterations) == INTEGER_CST)
3401 loop->any_upper_bound = true;
3402 loop->nb_iterations_upper_bound
3403 = tree_to_double_int (loop->nb_iterations);
3407 /* Sets NIT to the estimated number of executions of the latch of the
3408 LOOP. If CONSERVATIVE is true, we must be sure that NIT is at least as
3409 large as the number of iterations. If we have no reliable estimate,
3410 the function returns false, otherwise returns true. */
3412 bool
3413 estimated_loop_iterations (struct loop *loop, double_int *nit)
3415 /* When SCEV information is available, try to update loop iterations
3416 estimate. Otherwise just return whatever we recorded earlier. */
3417 if (scev_initialized_p ())
3418 estimate_numbers_of_iterations_loop (loop);
3420 /* Even if the bound is not recorded, possibly we can derrive one from
3421 profile. */
3422 if (!loop->any_estimate)
3424 if (loop->header->count)
3426 *nit = gcov_type_to_double_int
3427 (expected_loop_iterations_unbounded (loop) + 1);
3428 return true;
3430 return false;
3433 *nit = loop->nb_iterations_estimate;
3434 return true;
3437 /* Sets NIT to an upper bound for the maximum number of executions of the
3438 latch of the LOOP. If we have no reliable estimate, the function returns
3439 false, otherwise returns true. */
3441 bool
3442 max_loop_iterations (struct loop *loop, double_int *nit)
3444 /* When SCEV information is available, try to update loop iterations
3445 estimate. Otherwise just return whatever we recorded earlier. */
3446 if (scev_initialized_p ())
3447 estimate_numbers_of_iterations_loop (loop);
3448 if (!loop->any_upper_bound)
3449 return false;
3451 *nit = loop->nb_iterations_upper_bound;
3452 return true;
3455 /* Similar to estimated_loop_iterations, but returns the estimate only
3456 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
3457 on the number of iterations of LOOP could not be derived, returns -1. */
3459 HOST_WIDE_INT
3460 estimated_loop_iterations_int (struct loop *loop)
3462 double_int nit;
3463 HOST_WIDE_INT hwi_nit;
3465 if (!estimated_loop_iterations (loop, &nit))
3466 return -1;
3468 if (!nit.fits_shwi ())
3469 return -1;
3470 hwi_nit = nit.to_shwi ();
3472 return hwi_nit < 0 ? -1 : hwi_nit;
3475 /* Similar to max_loop_iterations, but returns the estimate only
3476 if it fits to HOST_WIDE_INT. If this is not the case, or the estimate
3477 on the number of iterations of LOOP could not be derived, returns -1. */
3479 HOST_WIDE_INT
3480 max_loop_iterations_int (struct loop *loop)
3482 double_int nit;
3483 HOST_WIDE_INT hwi_nit;
3485 if (!max_loop_iterations (loop, &nit))
3486 return -1;
3488 if (!nit.fits_shwi ())
3489 return -1;
3490 hwi_nit = nit.to_shwi ();
3492 return hwi_nit < 0 ? -1 : hwi_nit;
3495 /* Returns an upper bound on the number of executions of statements
3496 in the LOOP. For statements before the loop exit, this exceeds
3497 the number of execution of the latch by one. */
3499 HOST_WIDE_INT
3500 max_stmt_executions_int (struct loop *loop)
3502 HOST_WIDE_INT nit = max_loop_iterations_int (loop);
3503 HOST_WIDE_INT snit;
3505 if (nit == -1)
3506 return -1;
3508 snit = (HOST_WIDE_INT) ((unsigned HOST_WIDE_INT) nit + 1);
3510 /* If the computation overflows, return -1. */
3511 return snit < 0 ? -1 : snit;
3514 /* Returns an estimate for the number of executions of statements
3515 in the LOOP. For statements before the loop exit, this exceeds
3516 the number of execution of the latch by one. */
3518 HOST_WIDE_INT
3519 estimated_stmt_executions_int (struct loop *loop)
3521 HOST_WIDE_INT nit = estimated_loop_iterations_int (loop);
3522 HOST_WIDE_INT snit;
3524 if (nit == -1)
3525 return -1;
3527 snit = (HOST_WIDE_INT) ((unsigned HOST_WIDE_INT) nit + 1);
3529 /* If the computation overflows, return -1. */
3530 return snit < 0 ? -1 : snit;
3533 /* Sets NIT to the estimated maximum number of executions of the latch of the
3534 LOOP, plus one. If we have no reliable estimate, the function returns
3535 false, otherwise returns true. */
3537 bool
3538 max_stmt_executions (struct loop *loop, double_int *nit)
3540 double_int nit_minus_one;
3542 if (!max_loop_iterations (loop, nit))
3543 return false;
3545 nit_minus_one = *nit;
3547 *nit += double_int_one;
3549 return (*nit).ugt (nit_minus_one);
3552 /* Sets NIT to the estimated number of executions of the latch of the
3553 LOOP, plus one. If we have no reliable estimate, the function returns
3554 false, otherwise returns true. */
3556 bool
3557 estimated_stmt_executions (struct loop *loop, double_int *nit)
3559 double_int nit_minus_one;
3561 if (!estimated_loop_iterations (loop, nit))
3562 return false;
3564 nit_minus_one = *nit;
3566 *nit += double_int_one;
3568 return (*nit).ugt (nit_minus_one);
3571 /* Records estimates on numbers of iterations of loops. */
3573 void
3574 estimate_numbers_of_iterations (void)
3576 loop_iterator li;
3577 struct loop *loop;
3579 /* We don't want to issue signed overflow warnings while getting
3580 loop iteration estimates. */
3581 fold_defer_overflow_warnings ();
3583 FOR_EACH_LOOP (li, loop, 0)
3585 estimate_numbers_of_iterations_loop (loop);
3588 fold_undefer_and_ignore_overflow_warnings ();
3591 /* Returns true if statement S1 dominates statement S2. */
3593 bool
3594 stmt_dominates_stmt_p (gimple s1, gimple s2)
3596 basic_block bb1 = gimple_bb (s1), bb2 = gimple_bb (s2);
3598 if (!bb1
3599 || s1 == s2)
3600 return true;
3602 if (bb1 == bb2)
3604 gimple_stmt_iterator bsi;
3606 if (gimple_code (s2) == GIMPLE_PHI)
3607 return false;
3609 if (gimple_code (s1) == GIMPLE_PHI)
3610 return true;
3612 for (bsi = gsi_start_bb (bb1); gsi_stmt (bsi) != s2; gsi_next (&bsi))
3613 if (gsi_stmt (bsi) == s1)
3614 return true;
3616 return false;
3619 return dominated_by_p (CDI_DOMINATORS, bb2, bb1);
3622 /* Returns true when we can prove that the number of executions of
3623 STMT in the loop is at most NITER, according to the bound on
3624 the number of executions of the statement NITER_BOUND->stmt recorded in
3625 NITER_BOUND and fact that NITER_BOUND->stmt dominate STMT.
3627 ??? This code can become quite a CPU hog - we can have many bounds,
3628 and large basic block forcing stmt_dominates_stmt_p to be queried
3629 many times on a large basic blocks, so the whole thing is O(n^2)
3630 for scev_probably_wraps_p invocation (that can be done n times).
3632 It would make more sense (and give better answers) to remember BB
3633 bounds computed by discover_iteration_bound_by_body_walk. */
3635 static bool
3636 n_of_executions_at_most (gimple stmt,
3637 struct nb_iter_bound *niter_bound,
3638 tree niter)
3640 double_int bound = niter_bound->bound;
3641 tree nit_type = TREE_TYPE (niter), e;
3642 enum tree_code cmp;
3644 gcc_assert (TYPE_UNSIGNED (nit_type));
3646 /* If the bound does not even fit into NIT_TYPE, it cannot tell us that
3647 the number of iterations is small. */
3648 if (!double_int_fits_to_tree_p (nit_type, bound))
3649 return false;
3651 /* We know that NITER_BOUND->stmt is executed at most NITER_BOUND->bound + 1
3652 times. This means that:
3654 -- if NITER_BOUND->is_exit is true, then everything after
3655 it at most NITER_BOUND->bound times.
3657 -- If NITER_BOUND->is_exit is false, then if we can prove that when STMT
3658 is executed, then NITER_BOUND->stmt is executed as well in the same
3659 iteration then STMT is executed at most NITER_BOUND->bound + 1 times.
3661 If we can determine that NITER_BOUND->stmt is always executed
3662 after STMT, then STMT is executed at most NITER_BOUND->bound + 2 times.
3663 We conclude that if both statements belong to the same
3664 basic block and STMT is before NITER_BOUND->stmt and there are no
3665 statements with side effects in between. */
3667 if (niter_bound->is_exit)
3669 if (stmt == niter_bound->stmt
3670 || !stmt_dominates_stmt_p (niter_bound->stmt, stmt))
3671 return false;
3672 cmp = GE_EXPR;
3674 else
3676 if (!stmt_dominates_stmt_p (niter_bound->stmt, stmt))
3678 gimple_stmt_iterator bsi;
3679 if (gimple_bb (stmt) != gimple_bb (niter_bound->stmt)
3680 || gimple_code (stmt) == GIMPLE_PHI
3681 || gimple_code (niter_bound->stmt) == GIMPLE_PHI)
3682 return false;
3684 /* By stmt_dominates_stmt_p we already know that STMT appears
3685 before NITER_BOUND->STMT. Still need to test that the loop
3686 can not be terinated by a side effect in between. */
3687 for (bsi = gsi_for_stmt (stmt); gsi_stmt (bsi) != niter_bound->stmt;
3688 gsi_next (&bsi))
3689 if (gimple_has_side_effects (gsi_stmt (bsi)))
3690 return false;
3691 bound += double_int_one;
3692 if (bound.is_zero ()
3693 || !double_int_fits_to_tree_p (nit_type, bound))
3694 return false;
3696 cmp = GT_EXPR;
3699 e = fold_binary (cmp, boolean_type_node,
3700 niter, double_int_to_tree (nit_type, bound));
3701 return e && integer_nonzerop (e);
3704 /* Returns true if the arithmetics in TYPE can be assumed not to wrap. */
3706 bool
3707 nowrap_type_p (tree type)
3709 if (INTEGRAL_TYPE_P (type)
3710 && TYPE_OVERFLOW_UNDEFINED (type))
3711 return true;
3713 if (POINTER_TYPE_P (type))
3714 return true;
3716 return false;
3719 /* Return false only when the induction variable BASE + STEP * I is
3720 known to not overflow: i.e. when the number of iterations is small
3721 enough with respect to the step and initial condition in order to
3722 keep the evolution confined in TYPEs bounds. Return true when the
3723 iv is known to overflow or when the property is not computable.
3725 USE_OVERFLOW_SEMANTICS is true if this function should assume that
3726 the rules for overflow of the given language apply (e.g., that signed
3727 arithmetics in C does not overflow). */
3729 bool
3730 scev_probably_wraps_p (tree base, tree step,
3731 gimple at_stmt, struct loop *loop,
3732 bool use_overflow_semantics)
3734 tree delta, step_abs;
3735 tree unsigned_type, valid_niter;
3736 tree type = TREE_TYPE (step);
3737 tree e;
3738 double_int niter;
3739 struct nb_iter_bound *bound;
3741 /* FIXME: We really need something like
3742 http://gcc.gnu.org/ml/gcc-patches/2005-06/msg02025.html.
3744 We used to test for the following situation that frequently appears
3745 during address arithmetics:
3747 D.1621_13 = (long unsigned intD.4) D.1620_12;
3748 D.1622_14 = D.1621_13 * 8;
3749 D.1623_15 = (doubleD.29 *) D.1622_14;
3751 And derived that the sequence corresponding to D_14
3752 can be proved to not wrap because it is used for computing a
3753 memory access; however, this is not really the case -- for example,
3754 if D_12 = (unsigned char) [254,+,1], then D_14 has values
3755 2032, 2040, 0, 8, ..., but the code is still legal. */
3757 if (chrec_contains_undetermined (base)
3758 || chrec_contains_undetermined (step))
3759 return true;
3761 if (integer_zerop (step))
3762 return false;
3764 /* If we can use the fact that signed and pointer arithmetics does not
3765 wrap, we are done. */
3766 if (use_overflow_semantics && nowrap_type_p (TREE_TYPE (base)))
3767 return false;
3769 /* To be able to use estimates on number of iterations of the loop,
3770 we must have an upper bound on the absolute value of the step. */
3771 if (TREE_CODE (step) != INTEGER_CST)
3772 return true;
3774 /* Don't issue signed overflow warnings. */
3775 fold_defer_overflow_warnings ();
3777 /* Otherwise, compute the number of iterations before we reach the
3778 bound of the type, and verify that the loop is exited before this
3779 occurs. */
3780 unsigned_type = unsigned_type_for (type);
3781 base = fold_convert (unsigned_type, base);
3783 if (tree_int_cst_sign_bit (step))
3785 tree extreme = fold_convert (unsigned_type,
3786 lower_bound_in_type (type, type));
3787 delta = fold_build2 (MINUS_EXPR, unsigned_type, base, extreme);
3788 step_abs = fold_build1 (NEGATE_EXPR, unsigned_type,
3789 fold_convert (unsigned_type, step));
3791 else
3793 tree extreme = fold_convert (unsigned_type,
3794 upper_bound_in_type (type, type));
3795 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, base);
3796 step_abs = fold_convert (unsigned_type, step);
3799 valid_niter = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step_abs);
3801 estimate_numbers_of_iterations_loop (loop);
3803 if (max_loop_iterations (loop, &niter)
3804 && double_int_fits_to_tree_p (TREE_TYPE (valid_niter), niter)
3805 && (e = fold_binary (GT_EXPR, boolean_type_node, valid_niter,
3806 double_int_to_tree (TREE_TYPE (valid_niter),
3807 niter))) != NULL
3808 && integer_nonzerop (e))
3810 fold_undefer_and_ignore_overflow_warnings ();
3811 return false;
3813 if (at_stmt)
3814 for (bound = loop->bounds; bound; bound = bound->next)
3816 if (n_of_executions_at_most (at_stmt, bound, valid_niter))
3818 fold_undefer_and_ignore_overflow_warnings ();
3819 return false;
3823 fold_undefer_and_ignore_overflow_warnings ();
3825 /* At this point we still don't have a proof that the iv does not
3826 overflow: give up. */
3827 return true;
3830 /* Frees the information on upper bounds on numbers of iterations of LOOP. */
3832 void
3833 free_numbers_of_iterations_estimates_loop (struct loop *loop)
3835 struct nb_iter_bound *bound, *next;
3837 loop->nb_iterations = NULL;
3838 loop->estimate_state = EST_NOT_COMPUTED;
3839 for (bound = loop->bounds; bound; bound = next)
3841 next = bound->next;
3842 ggc_free (bound);
3845 loop->bounds = NULL;
3848 /* Frees the information on upper bounds on numbers of iterations of loops. */
3850 void
3851 free_numbers_of_iterations_estimates (void)
3853 loop_iterator li;
3854 struct loop *loop;
3856 FOR_EACH_LOOP (li, loop, 0)
3858 free_numbers_of_iterations_estimates_loop (loop);
3862 /* Substitute value VAL for ssa name NAME inside expressions held
3863 at LOOP. */
3865 void
3866 substitute_in_loop_info (struct loop *loop, tree name, tree val)
3868 loop->nb_iterations = simplify_replace_tree (loop->nb_iterations, name, val);