2010-07-27 Paolo Carlini <paolo.carlini@oracle.com>
[official-gcc/alias-decl.git] / gcc / tree-ssa-loop-niter.c
blob6ec0575990d31e1561bffe0d1f13b327ee836eb5
1 /* Functions to determine/estimate number of iterations of a loop.
2 Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option) any
10 later version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #include "config.h"
22 #include "system.h"
23 #include "coretypes.h"
24 #include "tm.h"
25 #include "tree.h"
26 #include "tm_p.h"
27 #include "basic-block.h"
28 #include "output.h"
29 #include "tree-pretty-print.h"
30 #include "gimple-pretty-print.h"
31 #include "intl.h"
32 #include "tree-flow.h"
33 #include "tree-dump.h"
34 #include "cfgloop.h"
35 #include "tree-pass.h"
36 #include "ggc.h"
37 #include "tree-chrec.h"
38 #include "tree-scalar-evolution.h"
39 #include "tree-data-ref.h"
40 #include "params.h"
41 #include "flags.h"
42 #include "diagnostic-core.h"
43 #include "toplev.h"
44 #include "tree-inline.h"
45 #include "gmp.h"
47 #define SWAP(X, Y) do { affine_iv *tmp = (X); (X) = (Y); (Y) = tmp; } while (0)
49 /* The maximum number of dominator BBs we search for conditions
50 of loop header copies we use for simplifying a conditional
51 expression. */
52 #define MAX_DOMINATORS_TO_WALK 8
56 Analysis of number of iterations of an affine exit test.
60 /* Bounds on some value, BELOW <= X <= UP. */
62 typedef struct
64 mpz_t below, up;
65 } bounds;
68 /* Splits expression EXPR to a variable part VAR and constant OFFSET. */
70 static void
71 split_to_var_and_offset (tree expr, tree *var, mpz_t offset)
73 tree type = TREE_TYPE (expr);
74 tree op0, op1;
75 double_int off;
76 bool negate = false;
78 *var = expr;
79 mpz_set_ui (offset, 0);
81 switch (TREE_CODE (expr))
83 case MINUS_EXPR:
84 negate = true;
85 /* Fallthru. */
87 case PLUS_EXPR:
88 case POINTER_PLUS_EXPR:
89 op0 = TREE_OPERAND (expr, 0);
90 op1 = TREE_OPERAND (expr, 1);
92 if (TREE_CODE (op1) != INTEGER_CST)
93 break;
95 *var = op0;
96 /* Always sign extend the offset. */
97 off = tree_to_double_int (op1);
98 if (negate)
99 off = double_int_neg (off);
100 off = double_int_sext (off, TYPE_PRECISION (type));
101 mpz_set_double_int (offset, off, false);
102 break;
104 case INTEGER_CST:
105 *var = build_int_cst_type (type, 0);
106 off = tree_to_double_int (expr);
107 mpz_set_double_int (offset, off, TYPE_UNSIGNED (type));
108 break;
110 default:
111 break;
115 /* Stores estimate on the minimum/maximum value of the expression VAR + OFF
116 in TYPE to MIN and MAX. */
118 static void
119 determine_value_range (tree type, tree var, mpz_t off,
120 mpz_t min, mpz_t max)
122 /* If the expression is a constant, we know its value exactly. */
123 if (integer_zerop (var))
125 mpz_set (min, off);
126 mpz_set (max, off);
127 return;
130 /* If the computation may wrap, we know nothing about the value, except for
131 the range of the type. */
132 get_type_static_bounds (type, min, max);
133 if (!nowrap_type_p (type))
134 return;
136 /* Since the addition of OFF does not wrap, if OFF is positive, then we may
137 add it to MIN, otherwise to MAX. */
138 if (mpz_sgn (off) < 0)
139 mpz_add (max, max, off);
140 else
141 mpz_add (min, min, off);
144 /* Stores the bounds on the difference of the values of the expressions
145 (var + X) and (var + Y), computed in TYPE, to BNDS. */
147 static void
148 bound_difference_of_offsetted_base (tree type, mpz_t x, mpz_t y,
149 bounds *bnds)
151 int rel = mpz_cmp (x, y);
152 bool may_wrap = !nowrap_type_p (type);
153 mpz_t m;
155 /* If X == Y, then the expressions are always equal.
156 If X > Y, there are the following possibilities:
157 a) neither of var + X and var + Y overflow or underflow, or both of
158 them do. Then their difference is X - Y.
159 b) var + X overflows, and var + Y does not. Then the values of the
160 expressions are var + X - M and var + Y, where M is the range of
161 the type, and their difference is X - Y - M.
162 c) var + Y underflows and var + X does not. Their difference again
163 is M - X + Y.
164 Therefore, if the arithmetics in type does not overflow, then the
165 bounds are (X - Y, X - Y), otherwise they are (X - Y - M, X - Y)
166 Similarly, if X < Y, the bounds are either (X - Y, X - Y) or
167 (X - Y, X - Y + M). */
169 if (rel == 0)
171 mpz_set_ui (bnds->below, 0);
172 mpz_set_ui (bnds->up, 0);
173 return;
176 mpz_init (m);
177 mpz_set_double_int (m, double_int_mask (TYPE_PRECISION (type)), true);
178 mpz_add_ui (m, m, 1);
179 mpz_sub (bnds->up, x, y);
180 mpz_set (bnds->below, bnds->up);
182 if (may_wrap)
184 if (rel > 0)
185 mpz_sub (bnds->below, bnds->below, m);
186 else
187 mpz_add (bnds->up, bnds->up, m);
190 mpz_clear (m);
193 /* From condition C0 CMP C1 derives information regarding the
194 difference of values of VARX + OFFX and VARY + OFFY, computed in TYPE,
195 and stores it to BNDS. */
197 static void
198 refine_bounds_using_guard (tree type, tree varx, mpz_t offx,
199 tree vary, mpz_t offy,
200 tree c0, enum tree_code cmp, tree c1,
201 bounds *bnds)
203 tree varc0, varc1, tmp, ctype;
204 mpz_t offc0, offc1, loffx, loffy, bnd;
205 bool lbound = false;
206 bool no_wrap = nowrap_type_p (type);
207 bool x_ok, y_ok;
209 switch (cmp)
211 case LT_EXPR:
212 case LE_EXPR:
213 case GT_EXPR:
214 case GE_EXPR:
215 STRIP_SIGN_NOPS (c0);
216 STRIP_SIGN_NOPS (c1);
217 ctype = TREE_TYPE (c0);
218 if (!useless_type_conversion_p (ctype, type))
219 return;
221 break;
223 case EQ_EXPR:
224 /* We could derive quite precise information from EQ_EXPR, however, such
225 a guard is unlikely to appear, so we do not bother with handling
226 it. */
227 return;
229 case NE_EXPR:
230 /* NE_EXPR comparisons do not contain much of useful information, except for
231 special case of comparing with the bounds of the type. */
232 if (TREE_CODE (c1) != INTEGER_CST
233 || !INTEGRAL_TYPE_P (type))
234 return;
236 /* Ensure that the condition speaks about an expression in the same type
237 as X and Y. */
238 ctype = TREE_TYPE (c0);
239 if (TYPE_PRECISION (ctype) != TYPE_PRECISION (type))
240 return;
241 c0 = fold_convert (type, c0);
242 c1 = fold_convert (type, c1);
244 if (TYPE_MIN_VALUE (type)
245 && operand_equal_p (c1, TYPE_MIN_VALUE (type), 0))
247 cmp = GT_EXPR;
248 break;
250 if (TYPE_MAX_VALUE (type)
251 && operand_equal_p (c1, TYPE_MAX_VALUE (type), 0))
253 cmp = LT_EXPR;
254 break;
257 return;
258 default:
259 return;
262 mpz_init (offc0);
263 mpz_init (offc1);
264 split_to_var_and_offset (expand_simple_operations (c0), &varc0, offc0);
265 split_to_var_and_offset (expand_simple_operations (c1), &varc1, offc1);
267 /* We are only interested in comparisons of expressions based on VARX and
268 VARY. TODO -- we might also be able to derive some bounds from
269 expressions containing just one of the variables. */
271 if (operand_equal_p (varx, varc1, 0))
273 tmp = varc0; varc0 = varc1; varc1 = tmp;
274 mpz_swap (offc0, offc1);
275 cmp = swap_tree_comparison (cmp);
278 if (!operand_equal_p (varx, varc0, 0)
279 || !operand_equal_p (vary, varc1, 0))
280 goto end;
282 mpz_init_set (loffx, offx);
283 mpz_init_set (loffy, offy);
285 if (cmp == GT_EXPR || cmp == GE_EXPR)
287 tmp = varx; varx = vary; vary = tmp;
288 mpz_swap (offc0, offc1);
289 mpz_swap (loffx, loffy);
290 cmp = swap_tree_comparison (cmp);
291 lbound = true;
294 /* If there is no overflow, the condition implies that
296 (VARX + OFFX) cmp (VARY + OFFY) + (OFFX - OFFY + OFFC1 - OFFC0).
298 The overflows and underflows may complicate things a bit; each
299 overflow decreases the appropriate offset by M, and underflow
300 increases it by M. The above inequality would not necessarily be
301 true if
303 -- VARX + OFFX underflows and VARX + OFFC0 does not, or
304 VARX + OFFC0 overflows, but VARX + OFFX does not.
305 This may only happen if OFFX < OFFC0.
306 -- VARY + OFFY overflows and VARY + OFFC1 does not, or
307 VARY + OFFC1 underflows and VARY + OFFY does not.
308 This may only happen if OFFY > OFFC1. */
310 if (no_wrap)
312 x_ok = true;
313 y_ok = true;
315 else
317 x_ok = (integer_zerop (varx)
318 || mpz_cmp (loffx, offc0) >= 0);
319 y_ok = (integer_zerop (vary)
320 || mpz_cmp (loffy, offc1) <= 0);
323 if (x_ok && y_ok)
325 mpz_init (bnd);
326 mpz_sub (bnd, loffx, loffy);
327 mpz_add (bnd, bnd, offc1);
328 mpz_sub (bnd, bnd, offc0);
330 if (cmp == LT_EXPR)
331 mpz_sub_ui (bnd, bnd, 1);
333 if (lbound)
335 mpz_neg (bnd, bnd);
336 if (mpz_cmp (bnds->below, bnd) < 0)
337 mpz_set (bnds->below, bnd);
339 else
341 if (mpz_cmp (bnd, bnds->up) < 0)
342 mpz_set (bnds->up, bnd);
344 mpz_clear (bnd);
347 mpz_clear (loffx);
348 mpz_clear (loffy);
349 end:
350 mpz_clear (offc0);
351 mpz_clear (offc1);
354 /* Stores the bounds on the value of the expression X - Y in LOOP to BNDS.
355 The subtraction is considered to be performed in arbitrary precision,
356 without overflows.
358 We do not attempt to be too clever regarding the value ranges of X and
359 Y; most of the time, they are just integers or ssa names offsetted by
360 integer. However, we try to use the information contained in the
361 comparisons before the loop (usually created by loop header copying). */
363 static void
364 bound_difference (struct loop *loop, tree x, tree y, bounds *bnds)
366 tree type = TREE_TYPE (x);
367 tree varx, vary;
368 mpz_t offx, offy;
369 mpz_t minx, maxx, miny, maxy;
370 int cnt = 0;
371 edge e;
372 basic_block bb;
373 tree c0, c1;
374 gimple cond;
375 enum tree_code cmp;
377 /* Get rid of unnecessary casts, but preserve the value of
378 the expressions. */
379 STRIP_SIGN_NOPS (x);
380 STRIP_SIGN_NOPS (y);
382 mpz_init (bnds->below);
383 mpz_init (bnds->up);
384 mpz_init (offx);
385 mpz_init (offy);
386 split_to_var_and_offset (x, &varx, offx);
387 split_to_var_and_offset (y, &vary, offy);
389 if (!integer_zerop (varx)
390 && operand_equal_p (varx, vary, 0))
392 /* Special case VARX == VARY -- we just need to compare the
393 offsets. The matters are a bit more complicated in the
394 case addition of offsets may wrap. */
395 bound_difference_of_offsetted_base (type, offx, offy, bnds);
397 else
399 /* Otherwise, use the value ranges to determine the initial
400 estimates on below and up. */
401 mpz_init (minx);
402 mpz_init (maxx);
403 mpz_init (miny);
404 mpz_init (maxy);
405 determine_value_range (type, varx, offx, minx, maxx);
406 determine_value_range (type, vary, offy, miny, maxy);
408 mpz_sub (bnds->below, minx, maxy);
409 mpz_sub (bnds->up, maxx, miny);
410 mpz_clear (minx);
411 mpz_clear (maxx);
412 mpz_clear (miny);
413 mpz_clear (maxy);
416 /* If both X and Y are constants, we cannot get any more precise. */
417 if (integer_zerop (varx) && integer_zerop (vary))
418 goto end;
420 /* Now walk the dominators of the loop header and use the entry
421 guards to refine the estimates. */
422 for (bb = loop->header;
423 bb != ENTRY_BLOCK_PTR && cnt < MAX_DOMINATORS_TO_WALK;
424 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
426 if (!single_pred_p (bb))
427 continue;
428 e = single_pred_edge (bb);
430 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
431 continue;
433 cond = last_stmt (e->src);
434 c0 = gimple_cond_lhs (cond);
435 cmp = gimple_cond_code (cond);
436 c1 = gimple_cond_rhs (cond);
438 if (e->flags & EDGE_FALSE_VALUE)
439 cmp = invert_tree_comparison (cmp, false);
441 refine_bounds_using_guard (type, varx, offx, vary, offy,
442 c0, cmp, c1, bnds);
443 ++cnt;
446 end:
447 mpz_clear (offx);
448 mpz_clear (offy);
451 /* Update the bounds in BNDS that restrict the value of X to the bounds
452 that restrict the value of X + DELTA. X can be obtained as a
453 difference of two values in TYPE. */
455 static void
456 bounds_add (bounds *bnds, double_int delta, tree type)
458 mpz_t mdelta, max;
460 mpz_init (mdelta);
461 mpz_set_double_int (mdelta, delta, false);
463 mpz_init (max);
464 mpz_set_double_int (max, double_int_mask (TYPE_PRECISION (type)), true);
466 mpz_add (bnds->up, bnds->up, mdelta);
467 mpz_add (bnds->below, bnds->below, mdelta);
469 if (mpz_cmp (bnds->up, max) > 0)
470 mpz_set (bnds->up, max);
472 mpz_neg (max, max);
473 if (mpz_cmp (bnds->below, max) < 0)
474 mpz_set (bnds->below, max);
476 mpz_clear (mdelta);
477 mpz_clear (max);
480 /* Update the bounds in BNDS that restrict the value of X to the bounds
481 that restrict the value of -X. */
483 static void
484 bounds_negate (bounds *bnds)
486 mpz_t tmp;
488 mpz_init_set (tmp, bnds->up);
489 mpz_neg (bnds->up, bnds->below);
490 mpz_neg (bnds->below, tmp);
491 mpz_clear (tmp);
494 /* Returns inverse of X modulo 2^s, where MASK = 2^s-1. */
496 static tree
497 inverse (tree x, tree mask)
499 tree type = TREE_TYPE (x);
500 tree rslt;
501 unsigned ctr = tree_floor_log2 (mask);
503 if (TYPE_PRECISION (type) <= HOST_BITS_PER_WIDE_INT)
505 unsigned HOST_WIDE_INT ix;
506 unsigned HOST_WIDE_INT imask;
507 unsigned HOST_WIDE_INT irslt = 1;
509 gcc_assert (cst_and_fits_in_hwi (x));
510 gcc_assert (cst_and_fits_in_hwi (mask));
512 ix = int_cst_value (x);
513 imask = int_cst_value (mask);
515 for (; ctr; ctr--)
517 irslt *= ix;
518 ix *= ix;
520 irslt &= imask;
522 rslt = build_int_cst_type (type, irslt);
524 else
526 rslt = build_int_cst (type, 1);
527 for (; ctr; ctr--)
529 rslt = int_const_binop (MULT_EXPR, rslt, x, 0);
530 x = int_const_binop (MULT_EXPR, x, x, 0);
532 rslt = int_const_binop (BIT_AND_EXPR, rslt, mask, 0);
535 return rslt;
538 /* Derives the upper bound BND on the number of executions of loop with exit
539 condition S * i <> C, assuming that this exit is taken. If
540 NO_OVERFLOW is true, then the control variable of the loop does not
541 overflow. If NO_OVERFLOW is true or BNDS.below >= 0, then BNDS.up
542 contains the upper bound on the value of C. */
544 static void
545 number_of_iterations_ne_max (mpz_t bnd, bool no_overflow, tree c, tree s,
546 bounds *bnds)
548 double_int max;
549 mpz_t d;
551 /* If the control variable does not overflow, the number of iterations is
552 at most c / s. Otherwise it is at most the period of the control
553 variable. */
554 if (!no_overflow && !multiple_of_p (TREE_TYPE (c), c, s))
556 max = double_int_mask (TYPE_PRECISION (TREE_TYPE (c))
557 - tree_low_cst (num_ending_zeros (s), 1));
558 mpz_set_double_int (bnd, max, true);
559 return;
562 /* Determine the upper bound on C. */
563 if (no_overflow || mpz_sgn (bnds->below) >= 0)
564 mpz_set (bnd, bnds->up);
565 else if (TREE_CODE (c) == INTEGER_CST)
566 mpz_set_double_int (bnd, tree_to_double_int (c), true);
567 else
568 mpz_set_double_int (bnd, double_int_mask (TYPE_PRECISION (TREE_TYPE (c))),
569 true);
571 mpz_init (d);
572 mpz_set_double_int (d, tree_to_double_int (s), true);
573 mpz_fdiv_q (bnd, bnd, d);
574 mpz_clear (d);
577 /* Determines number of iterations of loop whose ending condition
578 is IV <> FINAL. TYPE is the type of the iv. The number of
579 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
580 we know that the exit must be taken eventually, i.e., that the IV
581 ever reaches the value FINAL (we derived this earlier, and possibly set
582 NITER->assumptions to make sure this is the case). BNDS contains the
583 bounds on the difference FINAL - IV->base. */
585 static bool
586 number_of_iterations_ne (tree type, affine_iv *iv, tree final,
587 struct tree_niter_desc *niter, bool exit_must_be_taken,
588 bounds *bnds)
590 tree niter_type = unsigned_type_for (type);
591 tree s, c, d, bits, assumption, tmp, bound;
592 mpz_t max;
594 niter->control = *iv;
595 niter->bound = final;
596 niter->cmp = NE_EXPR;
598 /* Rearrange the terms so that we get inequality S * i <> C, with S
599 positive. Also cast everything to the unsigned type. If IV does
600 not overflow, BNDS bounds the value of C. Also, this is the
601 case if the computation |FINAL - IV->base| does not overflow, i.e.,
602 if BNDS->below in the result is nonnegative. */
603 if (tree_int_cst_sign_bit (iv->step))
605 s = fold_convert (niter_type,
606 fold_build1 (NEGATE_EXPR, type, iv->step));
607 c = fold_build2 (MINUS_EXPR, niter_type,
608 fold_convert (niter_type, iv->base),
609 fold_convert (niter_type, final));
610 bounds_negate (bnds);
612 else
614 s = fold_convert (niter_type, iv->step);
615 c = fold_build2 (MINUS_EXPR, niter_type,
616 fold_convert (niter_type, final),
617 fold_convert (niter_type, iv->base));
620 mpz_init (max);
621 number_of_iterations_ne_max (max, iv->no_overflow, c, s, bnds);
622 niter->max = mpz_get_double_int (niter_type, max, false);
623 mpz_clear (max);
625 /* First the trivial cases -- when the step is 1. */
626 if (integer_onep (s))
628 niter->niter = c;
629 return true;
632 /* Let nsd (step, size of mode) = d. If d does not divide c, the loop
633 is infinite. Otherwise, the number of iterations is
634 (inverse(s/d) * (c/d)) mod (size of mode/d). */
635 bits = num_ending_zeros (s);
636 bound = build_low_bits_mask (niter_type,
637 (TYPE_PRECISION (niter_type)
638 - tree_low_cst (bits, 1)));
640 d = fold_binary_to_constant (LSHIFT_EXPR, niter_type,
641 build_int_cst (niter_type, 1), bits);
642 s = fold_binary_to_constant (RSHIFT_EXPR, niter_type, s, bits);
644 if (!exit_must_be_taken)
646 /* If we cannot assume that the exit is taken eventually, record the
647 assumptions for divisibility of c. */
648 assumption = fold_build2 (FLOOR_MOD_EXPR, niter_type, c, d);
649 assumption = fold_build2 (EQ_EXPR, boolean_type_node,
650 assumption, build_int_cst (niter_type, 0));
651 if (!integer_nonzerop (assumption))
652 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
653 niter->assumptions, assumption);
656 c = fold_build2 (EXACT_DIV_EXPR, niter_type, c, d);
657 tmp = fold_build2 (MULT_EXPR, niter_type, c, inverse (s, bound));
658 niter->niter = fold_build2 (BIT_AND_EXPR, niter_type, tmp, bound);
659 return true;
662 /* Checks whether we can determine the final value of the control variable
663 of the loop with ending condition IV0 < IV1 (computed in TYPE).
664 DELTA is the difference IV1->base - IV0->base, STEP is the absolute value
665 of the step. The assumptions necessary to ensure that the computation
666 of the final value does not overflow are recorded in NITER. If we
667 find the final value, we adjust DELTA and return TRUE. Otherwise
668 we return false. BNDS bounds the value of IV1->base - IV0->base,
669 and will be updated by the same amount as DELTA. EXIT_MUST_BE_TAKEN is
670 true if we know that the exit must be taken eventually. */
672 static bool
673 number_of_iterations_lt_to_ne (tree type, affine_iv *iv0, affine_iv *iv1,
674 struct tree_niter_desc *niter,
675 tree *delta, tree step,
676 bool exit_must_be_taken, bounds *bnds)
678 tree niter_type = TREE_TYPE (step);
679 tree mod = fold_build2 (FLOOR_MOD_EXPR, niter_type, *delta, step);
680 tree tmod;
681 mpz_t mmod;
682 tree assumption = boolean_true_node, bound, noloop;
683 bool ret = false, fv_comp_no_overflow;
684 tree type1 = type;
685 if (POINTER_TYPE_P (type))
686 type1 = sizetype;
688 if (TREE_CODE (mod) != INTEGER_CST)
689 return false;
690 if (integer_nonzerop (mod))
691 mod = fold_build2 (MINUS_EXPR, niter_type, step, mod);
692 tmod = fold_convert (type1, mod);
694 mpz_init (mmod);
695 mpz_set_double_int (mmod, tree_to_double_int (mod), true);
696 mpz_neg (mmod, mmod);
698 /* If the induction variable does not overflow and the exit is taken,
699 then the computation of the final value does not overflow. This is
700 also obviously the case if the new final value is equal to the
701 current one. Finally, we postulate this for pointer type variables,
702 as the code cannot rely on the object to that the pointer points being
703 placed at the end of the address space (and more pragmatically,
704 TYPE_{MIN,MAX}_VALUE is not defined for pointers). */
705 if (integer_zerop (mod) || POINTER_TYPE_P (type))
706 fv_comp_no_overflow = true;
707 else if (!exit_must_be_taken)
708 fv_comp_no_overflow = false;
709 else
710 fv_comp_no_overflow =
711 (iv0->no_overflow && integer_nonzerop (iv0->step))
712 || (iv1->no_overflow && integer_nonzerop (iv1->step));
714 if (integer_nonzerop (iv0->step))
716 /* The final value of the iv is iv1->base + MOD, assuming that this
717 computation does not overflow, and that
718 iv0->base <= iv1->base + MOD. */
719 if (!fv_comp_no_overflow)
721 bound = fold_build2 (MINUS_EXPR, type1,
722 TYPE_MAX_VALUE (type1), tmod);
723 assumption = fold_build2 (LE_EXPR, boolean_type_node,
724 iv1->base, bound);
725 if (integer_zerop (assumption))
726 goto end;
728 if (mpz_cmp (mmod, bnds->below) < 0)
729 noloop = boolean_false_node;
730 else if (POINTER_TYPE_P (type))
731 noloop = fold_build2 (GT_EXPR, boolean_type_node,
732 iv0->base,
733 fold_build2 (POINTER_PLUS_EXPR, type,
734 iv1->base, tmod));
735 else
736 noloop = fold_build2 (GT_EXPR, boolean_type_node,
737 iv0->base,
738 fold_build2 (PLUS_EXPR, type1,
739 iv1->base, tmod));
741 else
743 /* The final value of the iv is iv0->base - MOD, assuming that this
744 computation does not overflow, and that
745 iv0->base - MOD <= iv1->base. */
746 if (!fv_comp_no_overflow)
748 bound = fold_build2 (PLUS_EXPR, type1,
749 TYPE_MIN_VALUE (type1), tmod);
750 assumption = fold_build2 (GE_EXPR, boolean_type_node,
751 iv0->base, bound);
752 if (integer_zerop (assumption))
753 goto end;
755 if (mpz_cmp (mmod, bnds->below) < 0)
756 noloop = boolean_false_node;
757 else if (POINTER_TYPE_P (type))
758 noloop = fold_build2 (GT_EXPR, boolean_type_node,
759 fold_build2 (POINTER_PLUS_EXPR, type,
760 iv0->base,
761 fold_build1 (NEGATE_EXPR,
762 type1, tmod)),
763 iv1->base);
764 else
765 noloop = fold_build2 (GT_EXPR, boolean_type_node,
766 fold_build2 (MINUS_EXPR, type1,
767 iv0->base, tmod),
768 iv1->base);
771 if (!integer_nonzerop (assumption))
772 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
773 niter->assumptions,
774 assumption);
775 if (!integer_zerop (noloop))
776 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
777 niter->may_be_zero,
778 noloop);
779 bounds_add (bnds, tree_to_double_int (mod), type);
780 *delta = fold_build2 (PLUS_EXPR, niter_type, *delta, mod);
782 ret = true;
783 end:
784 mpz_clear (mmod);
785 return ret;
788 /* Add assertions to NITER that ensure that the control variable of the loop
789 with ending condition IV0 < IV1 does not overflow. Types of IV0 and IV1
790 are TYPE. Returns false if we can prove that there is an overflow, true
791 otherwise. STEP is the absolute value of the step. */
793 static bool
794 assert_no_overflow_lt (tree type, affine_iv *iv0, affine_iv *iv1,
795 struct tree_niter_desc *niter, tree step)
797 tree bound, d, assumption, diff;
798 tree niter_type = TREE_TYPE (step);
800 if (integer_nonzerop (iv0->step))
802 /* for (i = iv0->base; i < iv1->base; i += iv0->step) */
803 if (iv0->no_overflow)
804 return true;
806 /* If iv0->base is a constant, we can determine the last value before
807 overflow precisely; otherwise we conservatively assume
808 MAX - STEP + 1. */
810 if (TREE_CODE (iv0->base) == INTEGER_CST)
812 d = fold_build2 (MINUS_EXPR, niter_type,
813 fold_convert (niter_type, TYPE_MAX_VALUE (type)),
814 fold_convert (niter_type, iv0->base));
815 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
817 else
818 diff = fold_build2 (MINUS_EXPR, niter_type, step,
819 build_int_cst (niter_type, 1));
820 bound = fold_build2 (MINUS_EXPR, type,
821 TYPE_MAX_VALUE (type), fold_convert (type, diff));
822 assumption = fold_build2 (LE_EXPR, boolean_type_node,
823 iv1->base, bound);
825 else
827 /* for (i = iv1->base; i > iv0->base; i += iv1->step) */
828 if (iv1->no_overflow)
829 return true;
831 if (TREE_CODE (iv1->base) == INTEGER_CST)
833 d = fold_build2 (MINUS_EXPR, niter_type,
834 fold_convert (niter_type, iv1->base),
835 fold_convert (niter_type, TYPE_MIN_VALUE (type)));
836 diff = fold_build2 (FLOOR_MOD_EXPR, niter_type, d, step);
838 else
839 diff = fold_build2 (MINUS_EXPR, niter_type, step,
840 build_int_cst (niter_type, 1));
841 bound = fold_build2 (PLUS_EXPR, type,
842 TYPE_MIN_VALUE (type), fold_convert (type, diff));
843 assumption = fold_build2 (GE_EXPR, boolean_type_node,
844 iv0->base, bound);
847 if (integer_zerop (assumption))
848 return false;
849 if (!integer_nonzerop (assumption))
850 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
851 niter->assumptions, assumption);
853 iv0->no_overflow = true;
854 iv1->no_overflow = true;
855 return true;
858 /* Add an assumption to NITER that a loop whose ending condition
859 is IV0 < IV1 rolls. TYPE is the type of the control iv. BNDS
860 bounds the value of IV1->base - IV0->base. */
862 static void
863 assert_loop_rolls_lt (tree type, affine_iv *iv0, affine_iv *iv1,
864 struct tree_niter_desc *niter, bounds *bnds)
866 tree assumption = boolean_true_node, bound, diff;
867 tree mbz, mbzl, mbzr, type1;
868 bool rolls_p, no_overflow_p;
869 double_int dstep;
870 mpz_t mstep, max;
872 /* We are going to compute the number of iterations as
873 (iv1->base - iv0->base + step - 1) / step, computed in the unsigned
874 variant of TYPE. This formula only works if
876 -step + 1 <= (iv1->base - iv0->base) <= MAX - step + 1
878 (where MAX is the maximum value of the unsigned variant of TYPE, and
879 the computations in this formula are performed in full precision,
880 i.e., without overflows).
882 Usually, for loops with exit condition iv0->base + step * i < iv1->base,
883 we have a condition of the form iv0->base - step < iv1->base before the loop,
884 and for loops iv0->base < iv1->base - step * i the condition
885 iv0->base < iv1->base + step, due to loop header copying, which enable us
886 to prove the lower bound.
888 The upper bound is more complicated. Unless the expressions for initial
889 and final value themselves contain enough information, we usually cannot
890 derive it from the context. */
892 /* First check whether the answer does not follow from the bounds we gathered
893 before. */
894 if (integer_nonzerop (iv0->step))
895 dstep = tree_to_double_int (iv0->step);
896 else
898 dstep = double_int_sext (tree_to_double_int (iv1->step),
899 TYPE_PRECISION (type));
900 dstep = double_int_neg (dstep);
903 mpz_init (mstep);
904 mpz_set_double_int (mstep, dstep, true);
905 mpz_neg (mstep, mstep);
906 mpz_add_ui (mstep, mstep, 1);
908 rolls_p = mpz_cmp (mstep, bnds->below) <= 0;
910 mpz_init (max);
911 mpz_set_double_int (max, double_int_mask (TYPE_PRECISION (type)), true);
912 mpz_add (max, max, mstep);
913 no_overflow_p = (mpz_cmp (bnds->up, max) <= 0
914 /* For pointers, only values lying inside a single object
915 can be compared or manipulated by pointer arithmetics.
916 Gcc in general does not allow or handle objects larger
917 than half of the address space, hence the upper bound
918 is satisfied for pointers. */
919 || POINTER_TYPE_P (type));
920 mpz_clear (mstep);
921 mpz_clear (max);
923 if (rolls_p && no_overflow_p)
924 return;
926 type1 = type;
927 if (POINTER_TYPE_P (type))
928 type1 = sizetype;
930 /* Now the hard part; we must formulate the assumption(s) as expressions, and
931 we must be careful not to introduce overflow. */
933 if (integer_nonzerop (iv0->step))
935 diff = fold_build2 (MINUS_EXPR, type1,
936 iv0->step, build_int_cst (type1, 1));
938 /* We need to know that iv0->base >= MIN + iv0->step - 1. Since
939 0 address never belongs to any object, we can assume this for
940 pointers. */
941 if (!POINTER_TYPE_P (type))
943 bound = fold_build2 (PLUS_EXPR, type1,
944 TYPE_MIN_VALUE (type), diff);
945 assumption = fold_build2 (GE_EXPR, boolean_type_node,
946 iv0->base, bound);
949 /* And then we can compute iv0->base - diff, and compare it with
950 iv1->base. */
951 mbzl = fold_build2 (MINUS_EXPR, type1,
952 fold_convert (type1, iv0->base), diff);
953 mbzr = fold_convert (type1, iv1->base);
955 else
957 diff = fold_build2 (PLUS_EXPR, type1,
958 iv1->step, build_int_cst (type1, 1));
960 if (!POINTER_TYPE_P (type))
962 bound = fold_build2 (PLUS_EXPR, type1,
963 TYPE_MAX_VALUE (type), diff);
964 assumption = fold_build2 (LE_EXPR, boolean_type_node,
965 iv1->base, bound);
968 mbzl = fold_convert (type1, iv0->base);
969 mbzr = fold_build2 (MINUS_EXPR, type1,
970 fold_convert (type1, iv1->base), diff);
973 if (!integer_nonzerop (assumption))
974 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
975 niter->assumptions, assumption);
976 if (!rolls_p)
978 mbz = fold_build2 (GT_EXPR, boolean_type_node, mbzl, mbzr);
979 niter->may_be_zero = fold_build2 (TRUTH_OR_EXPR, boolean_type_node,
980 niter->may_be_zero, mbz);
984 /* Determines number of iterations of loop whose ending condition
985 is IV0 < IV1. TYPE is the type of the iv. The number of
986 iterations is stored to NITER. BNDS bounds the difference
987 IV1->base - IV0->base. EXIT_MUST_BE_TAKEN is true if we know
988 that the exit must be taken eventually. */
990 static bool
991 number_of_iterations_lt (tree type, affine_iv *iv0, affine_iv *iv1,
992 struct tree_niter_desc *niter,
993 bool exit_must_be_taken, bounds *bnds)
995 tree niter_type = unsigned_type_for (type);
996 tree delta, step, s;
997 mpz_t mstep, tmp;
999 if (integer_nonzerop (iv0->step))
1001 niter->control = *iv0;
1002 niter->cmp = LT_EXPR;
1003 niter->bound = iv1->base;
1005 else
1007 niter->control = *iv1;
1008 niter->cmp = GT_EXPR;
1009 niter->bound = iv0->base;
1012 delta = fold_build2 (MINUS_EXPR, niter_type,
1013 fold_convert (niter_type, iv1->base),
1014 fold_convert (niter_type, iv0->base));
1016 /* First handle the special case that the step is +-1. */
1017 if ((integer_onep (iv0->step) && integer_zerop (iv1->step))
1018 || (integer_all_onesp (iv1->step) && integer_zerop (iv0->step)))
1020 /* for (i = iv0->base; i < iv1->base; i++)
1024 for (i = iv1->base; i > iv0->base; i--).
1026 In both cases # of iterations is iv1->base - iv0->base, assuming that
1027 iv1->base >= iv0->base.
1029 First try to derive a lower bound on the value of
1030 iv1->base - iv0->base, computed in full precision. If the difference
1031 is nonnegative, we are done, otherwise we must record the
1032 condition. */
1034 if (mpz_sgn (bnds->below) < 0)
1035 niter->may_be_zero = fold_build2 (LT_EXPR, boolean_type_node,
1036 iv1->base, iv0->base);
1037 niter->niter = delta;
1038 niter->max = mpz_get_double_int (niter_type, bnds->up, false);
1039 return true;
1042 if (integer_nonzerop (iv0->step))
1043 step = fold_convert (niter_type, iv0->step);
1044 else
1045 step = fold_convert (niter_type,
1046 fold_build1 (NEGATE_EXPR, type, iv1->step));
1048 /* If we can determine the final value of the control iv exactly, we can
1049 transform the condition to != comparison. In particular, this will be
1050 the case if DELTA is constant. */
1051 if (number_of_iterations_lt_to_ne (type, iv0, iv1, niter, &delta, step,
1052 exit_must_be_taken, bnds))
1054 affine_iv zps;
1056 zps.base = build_int_cst (niter_type, 0);
1057 zps.step = step;
1058 /* number_of_iterations_lt_to_ne will add assumptions that ensure that
1059 zps does not overflow. */
1060 zps.no_overflow = true;
1062 return number_of_iterations_ne (type, &zps, delta, niter, true, bnds);
1065 /* Make sure that the control iv does not overflow. */
1066 if (!assert_no_overflow_lt (type, iv0, iv1, niter, step))
1067 return false;
1069 /* We determine the number of iterations as (delta + step - 1) / step. For
1070 this to work, we must know that iv1->base >= iv0->base - step + 1,
1071 otherwise the loop does not roll. */
1072 assert_loop_rolls_lt (type, iv0, iv1, niter, bnds);
1074 s = fold_build2 (MINUS_EXPR, niter_type,
1075 step, build_int_cst (niter_type, 1));
1076 delta = fold_build2 (PLUS_EXPR, niter_type, delta, s);
1077 niter->niter = fold_build2 (FLOOR_DIV_EXPR, niter_type, delta, step);
1079 mpz_init (mstep);
1080 mpz_init (tmp);
1081 mpz_set_double_int (mstep, tree_to_double_int (step), true);
1082 mpz_add (tmp, bnds->up, mstep);
1083 mpz_sub_ui (tmp, tmp, 1);
1084 mpz_fdiv_q (tmp, tmp, mstep);
1085 niter->max = mpz_get_double_int (niter_type, tmp, false);
1086 mpz_clear (mstep);
1087 mpz_clear (tmp);
1089 return true;
1092 /* Determines number of iterations of loop whose ending condition
1093 is IV0 <= IV1. TYPE is the type of the iv. The number of
1094 iterations is stored to NITER. EXIT_MUST_BE_TAKEN is true if
1095 we know that this condition must eventually become false (we derived this
1096 earlier, and possibly set NITER->assumptions to make sure this
1097 is the case). BNDS bounds the difference IV1->base - IV0->base. */
1099 static bool
1100 number_of_iterations_le (tree type, affine_iv *iv0, affine_iv *iv1,
1101 struct tree_niter_desc *niter, bool exit_must_be_taken,
1102 bounds *bnds)
1104 tree assumption;
1105 tree type1 = type;
1106 if (POINTER_TYPE_P (type))
1107 type1 = sizetype;
1109 /* Say that IV0 is the control variable. Then IV0 <= IV1 iff
1110 IV0 < IV1 + 1, assuming that IV1 is not equal to the greatest
1111 value of the type. This we must know anyway, since if it is
1112 equal to this value, the loop rolls forever. We do not check
1113 this condition for pointer type ivs, as the code cannot rely on
1114 the object to that the pointer points being placed at the end of
1115 the address space (and more pragmatically, TYPE_{MIN,MAX}_VALUE is
1116 not defined for pointers). */
1118 if (!exit_must_be_taken && !POINTER_TYPE_P (type))
1120 if (integer_nonzerop (iv0->step))
1121 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1122 iv1->base, TYPE_MAX_VALUE (type));
1123 else
1124 assumption = fold_build2 (NE_EXPR, boolean_type_node,
1125 iv0->base, TYPE_MIN_VALUE (type));
1127 if (integer_zerop (assumption))
1128 return false;
1129 if (!integer_nonzerop (assumption))
1130 niter->assumptions = fold_build2 (TRUTH_AND_EXPR, boolean_type_node,
1131 niter->assumptions, assumption);
1134 if (integer_nonzerop (iv0->step))
1136 if (POINTER_TYPE_P (type))
1137 iv1->base = fold_build2 (POINTER_PLUS_EXPR, type, iv1->base,
1138 build_int_cst (type1, 1));
1139 else
1140 iv1->base = fold_build2 (PLUS_EXPR, type1, iv1->base,
1141 build_int_cst (type1, 1));
1143 else if (POINTER_TYPE_P (type))
1144 iv0->base = fold_build2 (POINTER_PLUS_EXPR, type, iv0->base,
1145 fold_build1 (NEGATE_EXPR, type1,
1146 build_int_cst (type1, 1)));
1147 else
1148 iv0->base = fold_build2 (MINUS_EXPR, type1,
1149 iv0->base, build_int_cst (type1, 1));
1151 bounds_add (bnds, double_int_one, type1);
1153 return number_of_iterations_lt (type, iv0, iv1, niter, exit_must_be_taken,
1154 bnds);
1157 /* Dumps description of affine induction variable IV to FILE. */
1159 static void
1160 dump_affine_iv (FILE *file, affine_iv *iv)
1162 if (!integer_zerop (iv->step))
1163 fprintf (file, "[");
1165 print_generic_expr (dump_file, iv->base, TDF_SLIM);
1167 if (!integer_zerop (iv->step))
1169 fprintf (file, ", + , ");
1170 print_generic_expr (dump_file, iv->step, TDF_SLIM);
1171 fprintf (file, "]%s", iv->no_overflow ? "(no_overflow)" : "");
1175 /* Determine the number of iterations according to condition (for staying
1176 inside loop) which compares two induction variables using comparison
1177 operator CODE. The induction variable on left side of the comparison
1178 is IV0, the right-hand side is IV1. Both induction variables must have
1179 type TYPE, which must be an integer or pointer type. The steps of the
1180 ivs must be constants (or NULL_TREE, which is interpreted as constant zero).
1182 LOOP is the loop whose number of iterations we are determining.
1184 ONLY_EXIT is true if we are sure this is the only way the loop could be
1185 exited (including possibly non-returning function calls, exceptions, etc.)
1186 -- in this case we can use the information whether the control induction
1187 variables can overflow or not in a more efficient way.
1189 The results (number of iterations and assumptions as described in
1190 comments at struct tree_niter_desc in tree-flow.h) are stored to NITER.
1191 Returns false if it fails to determine number of iterations, true if it
1192 was determined (possibly with some assumptions). */
1194 static bool
1195 number_of_iterations_cond (struct loop *loop,
1196 tree type, affine_iv *iv0, enum tree_code code,
1197 affine_iv *iv1, struct tree_niter_desc *niter,
1198 bool only_exit)
1200 bool exit_must_be_taken = false, ret;
1201 bounds bnds;
1203 /* The meaning of these assumptions is this:
1204 if !assumptions
1205 then the rest of information does not have to be valid
1206 if may_be_zero then the loop does not roll, even if
1207 niter != 0. */
1208 niter->assumptions = boolean_true_node;
1209 niter->may_be_zero = boolean_false_node;
1210 niter->niter = NULL_TREE;
1211 niter->max = double_int_zero;
1213 niter->bound = NULL_TREE;
1214 niter->cmp = ERROR_MARK;
1216 /* Make < comparison from > ones, and for NE_EXPR comparisons, ensure that
1217 the control variable is on lhs. */
1218 if (code == GE_EXPR || code == GT_EXPR
1219 || (code == NE_EXPR && integer_zerop (iv0->step)))
1221 SWAP (iv0, iv1);
1222 code = swap_tree_comparison (code);
1225 if (POINTER_TYPE_P (type))
1227 /* Comparison of pointers is undefined unless both iv0 and iv1 point
1228 to the same object. If they do, the control variable cannot wrap
1229 (as wrap around the bounds of memory will never return a pointer
1230 that would be guaranteed to point to the same object, even if we
1231 avoid undefined behavior by casting to size_t and back). */
1232 iv0->no_overflow = true;
1233 iv1->no_overflow = true;
1236 /* If the control induction variable does not overflow and the only exit
1237 from the loop is the one that we analyze, we know it must be taken
1238 eventually. */
1239 if (only_exit)
1241 if (!integer_zerop (iv0->step) && iv0->no_overflow)
1242 exit_must_be_taken = true;
1243 else if (!integer_zerop (iv1->step) && iv1->no_overflow)
1244 exit_must_be_taken = true;
1247 /* We can handle the case when neither of the sides of the comparison is
1248 invariant, provided that the test is NE_EXPR. This rarely occurs in
1249 practice, but it is simple enough to manage. */
1250 if (!integer_zerop (iv0->step) && !integer_zerop (iv1->step))
1252 if (code != NE_EXPR)
1253 return false;
1255 iv0->step = fold_binary_to_constant (MINUS_EXPR, type,
1256 iv0->step, iv1->step);
1257 iv0->no_overflow = false;
1258 iv1->step = build_int_cst (type, 0);
1259 iv1->no_overflow = true;
1262 /* If the result of the comparison is a constant, the loop is weird. More
1263 precise handling would be possible, but the situation is not common enough
1264 to waste time on it. */
1265 if (integer_zerop (iv0->step) && integer_zerop (iv1->step))
1266 return false;
1268 /* Ignore loops of while (i-- < 10) type. */
1269 if (code != NE_EXPR)
1271 if (iv0->step && tree_int_cst_sign_bit (iv0->step))
1272 return false;
1274 if (!integer_zerop (iv1->step) && !tree_int_cst_sign_bit (iv1->step))
1275 return false;
1278 /* If the loop exits immediately, there is nothing to do. */
1279 if (integer_zerop (fold_build2 (code, boolean_type_node, iv0->base, iv1->base)))
1281 niter->niter = build_int_cst (unsigned_type_for (type), 0);
1282 niter->max = double_int_zero;
1283 return true;
1286 /* OK, now we know we have a senseful loop. Handle several cases, depending
1287 on what comparison operator is used. */
1288 bound_difference (loop, iv1->base, iv0->base, &bnds);
1290 if (dump_file && (dump_flags & TDF_DETAILS))
1292 fprintf (dump_file,
1293 "Analyzing # of iterations of loop %d\n", loop->num);
1295 fprintf (dump_file, " exit condition ");
1296 dump_affine_iv (dump_file, iv0);
1297 fprintf (dump_file, " %s ",
1298 code == NE_EXPR ? "!="
1299 : code == LT_EXPR ? "<"
1300 : "<=");
1301 dump_affine_iv (dump_file, iv1);
1302 fprintf (dump_file, "\n");
1304 fprintf (dump_file, " bounds on difference of bases: ");
1305 mpz_out_str (dump_file, 10, bnds.below);
1306 fprintf (dump_file, " ... ");
1307 mpz_out_str (dump_file, 10, bnds.up);
1308 fprintf (dump_file, "\n");
1311 switch (code)
1313 case NE_EXPR:
1314 gcc_assert (integer_zerop (iv1->step));
1315 ret = number_of_iterations_ne (type, iv0, iv1->base, niter,
1316 exit_must_be_taken, &bnds);
1317 break;
1319 case LT_EXPR:
1320 ret = number_of_iterations_lt (type, iv0, iv1, niter, exit_must_be_taken,
1321 &bnds);
1322 break;
1324 case LE_EXPR:
1325 ret = number_of_iterations_le (type, iv0, iv1, niter, exit_must_be_taken,
1326 &bnds);
1327 break;
1329 default:
1330 gcc_unreachable ();
1333 mpz_clear (bnds.up);
1334 mpz_clear (bnds.below);
1336 if (dump_file && (dump_flags & TDF_DETAILS))
1338 if (ret)
1340 fprintf (dump_file, " result:\n");
1341 if (!integer_nonzerop (niter->assumptions))
1343 fprintf (dump_file, " under assumptions ");
1344 print_generic_expr (dump_file, niter->assumptions, TDF_SLIM);
1345 fprintf (dump_file, "\n");
1348 if (!integer_zerop (niter->may_be_zero))
1350 fprintf (dump_file, " zero if ");
1351 print_generic_expr (dump_file, niter->may_be_zero, TDF_SLIM);
1352 fprintf (dump_file, "\n");
1355 fprintf (dump_file, " # of iterations ");
1356 print_generic_expr (dump_file, niter->niter, TDF_SLIM);
1357 fprintf (dump_file, ", bounded by ");
1358 dump_double_int (dump_file, niter->max, true);
1359 fprintf (dump_file, "\n");
1361 else
1362 fprintf (dump_file, " failed\n\n");
1364 return ret;
1367 /* Substitute NEW for OLD in EXPR and fold the result. */
1369 static tree
1370 simplify_replace_tree (tree expr, tree old, tree new_tree)
1372 unsigned i, n;
1373 tree ret = NULL_TREE, e, se;
1375 if (!expr)
1376 return NULL_TREE;
1378 /* Do not bother to replace constants. */
1379 if (CONSTANT_CLASS_P (old))
1380 return expr;
1382 if (expr == old
1383 || operand_equal_p (expr, old, 0))
1384 return unshare_expr (new_tree);
1386 if (!EXPR_P (expr))
1387 return expr;
1389 n = TREE_OPERAND_LENGTH (expr);
1390 for (i = 0; i < n; i++)
1392 e = TREE_OPERAND (expr, i);
1393 se = simplify_replace_tree (e, old, new_tree);
1394 if (e == se)
1395 continue;
1397 if (!ret)
1398 ret = copy_node (expr);
1400 TREE_OPERAND (ret, i) = se;
1403 return (ret ? fold (ret) : expr);
1406 /* Expand definitions of ssa names in EXPR as long as they are simple
1407 enough, and return the new expression. */
1409 tree
1410 expand_simple_operations (tree expr)
1412 unsigned i, n;
1413 tree ret = NULL_TREE, e, ee, e1;
1414 enum tree_code code;
1415 gimple stmt;
1417 if (expr == NULL_TREE)
1418 return expr;
1420 if (is_gimple_min_invariant (expr))
1421 return expr;
1423 code = TREE_CODE (expr);
1424 if (IS_EXPR_CODE_CLASS (TREE_CODE_CLASS (code)))
1426 n = TREE_OPERAND_LENGTH (expr);
1427 for (i = 0; i < n; i++)
1429 e = TREE_OPERAND (expr, i);
1430 ee = expand_simple_operations (e);
1431 if (e == ee)
1432 continue;
1434 if (!ret)
1435 ret = copy_node (expr);
1437 TREE_OPERAND (ret, i) = ee;
1440 if (!ret)
1441 return expr;
1443 fold_defer_overflow_warnings ();
1444 ret = fold (ret);
1445 fold_undefer_and_ignore_overflow_warnings ();
1446 return ret;
1449 if (TREE_CODE (expr) != SSA_NAME)
1450 return expr;
1452 stmt = SSA_NAME_DEF_STMT (expr);
1453 if (gimple_code (stmt) == GIMPLE_PHI)
1455 basic_block src, dest;
1457 if (gimple_phi_num_args (stmt) != 1)
1458 return expr;
1459 e = PHI_ARG_DEF (stmt, 0);
1461 /* Avoid propagating through loop exit phi nodes, which
1462 could break loop-closed SSA form restrictions. */
1463 dest = gimple_bb (stmt);
1464 src = single_pred (dest);
1465 if (TREE_CODE (e) == SSA_NAME
1466 && src->loop_father != dest->loop_father)
1467 return expr;
1469 return expand_simple_operations (e);
1471 if (gimple_code (stmt) != GIMPLE_ASSIGN)
1472 return expr;
1474 e = gimple_assign_rhs1 (stmt);
1475 code = gimple_assign_rhs_code (stmt);
1476 if (get_gimple_rhs_class (code) == GIMPLE_SINGLE_RHS)
1478 if (is_gimple_min_invariant (e))
1479 return e;
1481 if (code == SSA_NAME)
1482 return expand_simple_operations (e);
1484 return expr;
1487 switch (code)
1489 CASE_CONVERT:
1490 /* Casts are simple. */
1491 ee = expand_simple_operations (e);
1492 return fold_build1 (code, TREE_TYPE (expr), ee);
1494 case PLUS_EXPR:
1495 case MINUS_EXPR:
1496 case POINTER_PLUS_EXPR:
1497 /* And increments and decrements by a constant are simple. */
1498 e1 = gimple_assign_rhs2 (stmt);
1499 if (!is_gimple_min_invariant (e1))
1500 return expr;
1502 ee = expand_simple_operations (e);
1503 return fold_build2 (code, TREE_TYPE (expr), ee, e1);
1505 default:
1506 return expr;
1510 /* Tries to simplify EXPR using the condition COND. Returns the simplified
1511 expression (or EXPR unchanged, if no simplification was possible). */
1513 static tree
1514 tree_simplify_using_condition_1 (tree cond, tree expr)
1516 bool changed;
1517 tree e, te, e0, e1, e2, notcond;
1518 enum tree_code code = TREE_CODE (expr);
1520 if (code == INTEGER_CST)
1521 return expr;
1523 if (code == TRUTH_OR_EXPR
1524 || code == TRUTH_AND_EXPR
1525 || code == COND_EXPR)
1527 changed = false;
1529 e0 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 0));
1530 if (TREE_OPERAND (expr, 0) != e0)
1531 changed = true;
1533 e1 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 1));
1534 if (TREE_OPERAND (expr, 1) != e1)
1535 changed = true;
1537 if (code == COND_EXPR)
1539 e2 = tree_simplify_using_condition_1 (cond, TREE_OPERAND (expr, 2));
1540 if (TREE_OPERAND (expr, 2) != e2)
1541 changed = true;
1543 else
1544 e2 = NULL_TREE;
1546 if (changed)
1548 if (code == COND_EXPR)
1549 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
1550 else
1551 expr = fold_build2 (code, boolean_type_node, e0, e1);
1554 return expr;
1557 /* In case COND is equality, we may be able to simplify EXPR by copy/constant
1558 propagation, and vice versa. Fold does not handle this, since it is
1559 considered too expensive. */
1560 if (TREE_CODE (cond) == EQ_EXPR)
1562 e0 = TREE_OPERAND (cond, 0);
1563 e1 = TREE_OPERAND (cond, 1);
1565 /* We know that e0 == e1. Check whether we cannot simplify expr
1566 using this fact. */
1567 e = simplify_replace_tree (expr, e0, e1);
1568 if (integer_zerop (e) || integer_nonzerop (e))
1569 return e;
1571 e = simplify_replace_tree (expr, e1, e0);
1572 if (integer_zerop (e) || integer_nonzerop (e))
1573 return e;
1575 if (TREE_CODE (expr) == EQ_EXPR)
1577 e0 = TREE_OPERAND (expr, 0);
1578 e1 = TREE_OPERAND (expr, 1);
1580 /* If e0 == e1 (EXPR) implies !COND, then EXPR cannot be true. */
1581 e = simplify_replace_tree (cond, e0, e1);
1582 if (integer_zerop (e))
1583 return e;
1584 e = simplify_replace_tree (cond, e1, e0);
1585 if (integer_zerop (e))
1586 return e;
1588 if (TREE_CODE (expr) == NE_EXPR)
1590 e0 = TREE_OPERAND (expr, 0);
1591 e1 = TREE_OPERAND (expr, 1);
1593 /* If e0 == e1 (!EXPR) implies !COND, then EXPR must be true. */
1594 e = simplify_replace_tree (cond, e0, e1);
1595 if (integer_zerop (e))
1596 return boolean_true_node;
1597 e = simplify_replace_tree (cond, e1, e0);
1598 if (integer_zerop (e))
1599 return boolean_true_node;
1602 te = expand_simple_operations (expr);
1604 /* Check whether COND ==> EXPR. */
1605 notcond = invert_truthvalue (cond);
1606 e = fold_binary (TRUTH_OR_EXPR, boolean_type_node, notcond, te);
1607 if (e && integer_nonzerop (e))
1608 return e;
1610 /* Check whether COND ==> not EXPR. */
1611 e = fold_binary (TRUTH_AND_EXPR, boolean_type_node, cond, te);
1612 if (e && integer_zerop (e))
1613 return e;
1615 return expr;
1618 /* Tries to simplify EXPR using the condition COND. Returns the simplified
1619 expression (or EXPR unchanged, if no simplification was possible).
1620 Wrapper around tree_simplify_using_condition_1 that ensures that chains
1621 of simple operations in definitions of ssa names in COND are expanded,
1622 so that things like casts or incrementing the value of the bound before
1623 the loop do not cause us to fail. */
1625 static tree
1626 tree_simplify_using_condition (tree cond, tree expr)
1628 cond = expand_simple_operations (cond);
1630 return tree_simplify_using_condition_1 (cond, expr);
1633 /* Tries to simplify EXPR using the conditions on entry to LOOP.
1634 Returns the simplified expression (or EXPR unchanged, if no
1635 simplification was possible).*/
1637 static tree
1638 simplify_using_initial_conditions (struct loop *loop, tree expr)
1640 edge e;
1641 basic_block bb;
1642 gimple stmt;
1643 tree cond;
1644 int cnt = 0;
1646 if (TREE_CODE (expr) == INTEGER_CST)
1647 return expr;
1649 /* Limit walking the dominators to avoid quadraticness in
1650 the number of BBs times the number of loops in degenerate
1651 cases. */
1652 for (bb = loop->header;
1653 bb != ENTRY_BLOCK_PTR && cnt < MAX_DOMINATORS_TO_WALK;
1654 bb = get_immediate_dominator (CDI_DOMINATORS, bb))
1656 if (!single_pred_p (bb))
1657 continue;
1658 e = single_pred_edge (bb);
1660 if (!(e->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
1661 continue;
1663 stmt = last_stmt (e->src);
1664 cond = fold_build2 (gimple_cond_code (stmt),
1665 boolean_type_node,
1666 gimple_cond_lhs (stmt),
1667 gimple_cond_rhs (stmt));
1668 if (e->flags & EDGE_FALSE_VALUE)
1669 cond = invert_truthvalue (cond);
1670 expr = tree_simplify_using_condition (cond, expr);
1671 ++cnt;
1674 return expr;
1677 /* Tries to simplify EXPR using the evolutions of the loop invariants
1678 in the superloops of LOOP. Returns the simplified expression
1679 (or EXPR unchanged, if no simplification was possible). */
1681 static tree
1682 simplify_using_outer_evolutions (struct loop *loop, tree expr)
1684 enum tree_code code = TREE_CODE (expr);
1685 bool changed;
1686 tree e, e0, e1, e2;
1688 if (is_gimple_min_invariant (expr))
1689 return expr;
1691 if (code == TRUTH_OR_EXPR
1692 || code == TRUTH_AND_EXPR
1693 || code == COND_EXPR)
1695 changed = false;
1697 e0 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 0));
1698 if (TREE_OPERAND (expr, 0) != e0)
1699 changed = true;
1701 e1 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 1));
1702 if (TREE_OPERAND (expr, 1) != e1)
1703 changed = true;
1705 if (code == COND_EXPR)
1707 e2 = simplify_using_outer_evolutions (loop, TREE_OPERAND (expr, 2));
1708 if (TREE_OPERAND (expr, 2) != e2)
1709 changed = true;
1711 else
1712 e2 = NULL_TREE;
1714 if (changed)
1716 if (code == COND_EXPR)
1717 expr = fold_build3 (code, boolean_type_node, e0, e1, e2);
1718 else
1719 expr = fold_build2 (code, boolean_type_node, e0, e1);
1722 return expr;
1725 e = instantiate_parameters (loop, expr);
1726 if (is_gimple_min_invariant (e))
1727 return e;
1729 return expr;
1732 /* Returns true if EXIT is the only possible exit from LOOP. */
1734 bool
1735 loop_only_exit_p (const struct loop *loop, const_edge exit)
1737 basic_block *body;
1738 gimple_stmt_iterator bsi;
1739 unsigned i;
1740 gimple call;
1742 if (exit != single_exit (loop))
1743 return false;
1745 body = get_loop_body (loop);
1746 for (i = 0; i < loop->num_nodes; i++)
1748 for (bsi = gsi_start_bb (body[i]); !gsi_end_p (bsi); gsi_next (&bsi))
1750 call = gsi_stmt (bsi);
1751 if (gimple_code (call) != GIMPLE_CALL)
1752 continue;
1754 if (gimple_has_side_effects (call))
1756 free (body);
1757 return false;
1762 free (body);
1763 return true;
1766 /* Stores description of number of iterations of LOOP derived from
1767 EXIT (an exit edge of the LOOP) in NITER. Returns true if some
1768 useful information could be derived (and fields of NITER has
1769 meaning described in comments at struct tree_niter_desc
1770 declaration), false otherwise. If WARN is true and
1771 -Wunsafe-loop-optimizations was given, warn if the optimizer is going to use
1772 potentially unsafe assumptions. */
1774 bool
1775 number_of_iterations_exit (struct loop *loop, edge exit,
1776 struct tree_niter_desc *niter,
1777 bool warn)
1779 gimple stmt;
1780 tree type;
1781 tree op0, op1;
1782 enum tree_code code;
1783 affine_iv iv0, iv1;
1785 if (!dominated_by_p (CDI_DOMINATORS, loop->latch, exit->src))
1786 return false;
1788 niter->assumptions = boolean_false_node;
1789 stmt = last_stmt (exit->src);
1790 if (!stmt || gimple_code (stmt) != GIMPLE_COND)
1791 return false;
1793 /* We want the condition for staying inside loop. */
1794 code = gimple_cond_code (stmt);
1795 if (exit->flags & EDGE_TRUE_VALUE)
1796 code = invert_tree_comparison (code, false);
1798 switch (code)
1800 case GT_EXPR:
1801 case GE_EXPR:
1802 case NE_EXPR:
1803 case LT_EXPR:
1804 case LE_EXPR:
1805 break;
1807 default:
1808 return false;
1811 op0 = gimple_cond_lhs (stmt);
1812 op1 = gimple_cond_rhs (stmt);
1813 type = TREE_TYPE (op0);
1815 if (TREE_CODE (type) != INTEGER_TYPE
1816 && !POINTER_TYPE_P (type))
1817 return false;
1819 if (!simple_iv (loop, loop_containing_stmt (stmt), op0, &iv0, false))
1820 return false;
1821 if (!simple_iv (loop, loop_containing_stmt (stmt), op1, &iv1, false))
1822 return false;
1824 /* We don't want to see undefined signed overflow warnings while
1825 computing the number of iterations. */
1826 fold_defer_overflow_warnings ();
1828 iv0.base = expand_simple_operations (iv0.base);
1829 iv1.base = expand_simple_operations (iv1.base);
1830 if (!number_of_iterations_cond (loop, type, &iv0, code, &iv1, niter,
1831 loop_only_exit_p (loop, exit)))
1833 fold_undefer_and_ignore_overflow_warnings ();
1834 return false;
1837 if (optimize >= 3)
1839 niter->assumptions = simplify_using_outer_evolutions (loop,
1840 niter->assumptions);
1841 niter->may_be_zero = simplify_using_outer_evolutions (loop,
1842 niter->may_be_zero);
1843 niter->niter = simplify_using_outer_evolutions (loop, niter->niter);
1846 niter->assumptions
1847 = simplify_using_initial_conditions (loop,
1848 niter->assumptions);
1849 niter->may_be_zero
1850 = simplify_using_initial_conditions (loop,
1851 niter->may_be_zero);
1853 fold_undefer_and_ignore_overflow_warnings ();
1855 if (integer_onep (niter->assumptions))
1856 return true;
1858 /* With -funsafe-loop-optimizations we assume that nothing bad can happen.
1859 But if we can prove that there is overflow or some other source of weird
1860 behavior, ignore the loop even with -funsafe-loop-optimizations. */
1861 if (integer_zerop (niter->assumptions))
1862 return false;
1864 if (flag_unsafe_loop_optimizations)
1865 niter->assumptions = boolean_true_node;
1867 if (warn)
1869 const char *wording;
1870 location_t loc = gimple_location (stmt);
1872 /* We can provide a more specific warning if one of the operator is
1873 constant and the other advances by +1 or -1. */
1874 if (!integer_zerop (iv1.step)
1875 ? (integer_zerop (iv0.step)
1876 && (integer_onep (iv1.step) || integer_all_onesp (iv1.step)))
1877 : (integer_onep (iv0.step) || integer_all_onesp (iv0.step)))
1878 wording =
1879 flag_unsafe_loop_optimizations
1880 ? N_("assuming that the loop is not infinite")
1881 : N_("cannot optimize possibly infinite loops");
1882 else
1883 wording =
1884 flag_unsafe_loop_optimizations
1885 ? N_("assuming that the loop counter does not overflow")
1886 : N_("cannot optimize loop, the loop counter may overflow");
1888 warning_at ((LOCATION_LINE (loc) > 0) ? loc : input_location,
1889 OPT_Wunsafe_loop_optimizations, "%s", gettext (wording));
1892 return flag_unsafe_loop_optimizations;
1895 /* Try to determine the number of iterations of LOOP. If we succeed,
1896 expression giving number of iterations is returned and *EXIT is
1897 set to the edge from that the information is obtained. Otherwise
1898 chrec_dont_know is returned. */
1900 tree
1901 find_loop_niter (struct loop *loop, edge *exit)
1903 unsigned i;
1904 VEC (edge, heap) *exits = get_loop_exit_edges (loop);
1905 edge ex;
1906 tree niter = NULL_TREE, aniter;
1907 struct tree_niter_desc desc;
1909 *exit = NULL;
1910 for (i = 0; VEC_iterate (edge, exits, i, ex); i++)
1912 if (!just_once_each_iteration_p (loop, ex->src))
1913 continue;
1915 if (!number_of_iterations_exit (loop, ex, &desc, false))
1916 continue;
1918 if (integer_nonzerop (desc.may_be_zero))
1920 /* We exit in the first iteration through this exit.
1921 We won't find anything better. */
1922 niter = build_int_cst (unsigned_type_node, 0);
1923 *exit = ex;
1924 break;
1927 if (!integer_zerop (desc.may_be_zero))
1928 continue;
1930 aniter = desc.niter;
1932 if (!niter)
1934 /* Nothing recorded yet. */
1935 niter = aniter;
1936 *exit = ex;
1937 continue;
1940 /* Prefer constants, the lower the better. */
1941 if (TREE_CODE (aniter) != INTEGER_CST)
1942 continue;
1944 if (TREE_CODE (niter) != INTEGER_CST)
1946 niter = aniter;
1947 *exit = ex;
1948 continue;
1951 if (tree_int_cst_lt (aniter, niter))
1953 niter = aniter;
1954 *exit = ex;
1955 continue;
1958 VEC_free (edge, heap, exits);
1960 return niter ? niter : chrec_dont_know;
1963 /* Return true if loop is known to have bounded number of iterations. */
1965 bool
1966 finite_loop_p (struct loop *loop)
1968 unsigned i;
1969 VEC (edge, heap) *exits;
1970 edge ex;
1971 struct tree_niter_desc desc;
1972 bool finite = false;
1974 if (flag_unsafe_loop_optimizations)
1975 return true;
1976 if ((TREE_READONLY (current_function_decl)
1977 || DECL_PURE_P (current_function_decl))
1978 && !DECL_LOOPING_CONST_OR_PURE_P (current_function_decl))
1980 if (dump_file && (dump_flags & TDF_DETAILS))
1981 fprintf (dump_file, "Found loop %i to be finite: it is within pure or const function.\n",
1982 loop->num);
1983 return true;
1986 exits = get_loop_exit_edges (loop);
1987 for (i = 0; VEC_iterate (edge, exits, i, ex); i++)
1989 if (!just_once_each_iteration_p (loop, ex->src))
1990 continue;
1992 if (number_of_iterations_exit (loop, ex, &desc, false))
1994 if (dump_file && (dump_flags & TDF_DETAILS))
1996 fprintf (dump_file, "Found loop %i to be finite: iterating ", loop->num);
1997 print_generic_expr (dump_file, desc.niter, TDF_SLIM);
1998 fprintf (dump_file, " times\n");
2000 finite = true;
2001 break;
2004 VEC_free (edge, heap, exits);
2005 return finite;
2010 Analysis of a number of iterations of a loop by a brute-force evaluation.
2014 /* Bound on the number of iterations we try to evaluate. */
2016 #define MAX_ITERATIONS_TO_TRACK \
2017 ((unsigned) PARAM_VALUE (PARAM_MAX_ITERATIONS_TO_TRACK))
2019 /* Returns the loop phi node of LOOP such that ssa name X is derived from its
2020 result by a chain of operations such that all but exactly one of their
2021 operands are constants. */
2023 static gimple
2024 chain_of_csts_start (struct loop *loop, tree x)
2026 gimple stmt = SSA_NAME_DEF_STMT (x);
2027 tree use;
2028 basic_block bb = gimple_bb (stmt);
2029 enum tree_code code;
2031 if (!bb
2032 || !flow_bb_inside_loop_p (loop, bb))
2033 return NULL;
2035 if (gimple_code (stmt) == GIMPLE_PHI)
2037 if (bb == loop->header)
2038 return stmt;
2040 return NULL;
2043 if (gimple_code (stmt) != GIMPLE_ASSIGN)
2044 return NULL;
2046 code = gimple_assign_rhs_code (stmt);
2047 if (gimple_references_memory_p (stmt)
2048 || TREE_CODE_CLASS (code) == tcc_reference
2049 || (code == ADDR_EXPR
2050 && !is_gimple_min_invariant (gimple_assign_rhs1 (stmt))))
2051 return NULL;
2053 use = SINGLE_SSA_TREE_OPERAND (stmt, SSA_OP_USE);
2054 if (use == NULL_TREE)
2055 return NULL;
2057 return chain_of_csts_start (loop, use);
2060 /* Determines whether the expression X is derived from a result of a phi node
2061 in header of LOOP such that
2063 * the derivation of X consists only from operations with constants
2064 * the initial value of the phi node is constant
2065 * the value of the phi node in the next iteration can be derived from the
2066 value in the current iteration by a chain of operations with constants.
2068 If such phi node exists, it is returned, otherwise NULL is returned. */
2070 static gimple
2071 get_base_for (struct loop *loop, tree x)
2073 gimple phi;
2074 tree init, next;
2076 if (is_gimple_min_invariant (x))
2077 return NULL;
2079 phi = chain_of_csts_start (loop, x);
2080 if (!phi)
2081 return NULL;
2083 init = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2084 next = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2086 if (TREE_CODE (next) != SSA_NAME)
2087 return NULL;
2089 if (!is_gimple_min_invariant (init))
2090 return NULL;
2092 if (chain_of_csts_start (loop, next) != phi)
2093 return NULL;
2095 return phi;
2098 /* Given an expression X, then
2100 * if X is NULL_TREE, we return the constant BASE.
2101 * otherwise X is a SSA name, whose value in the considered loop is derived
2102 by a chain of operations with constant from a result of a phi node in
2103 the header of the loop. Then we return value of X when the value of the
2104 result of this phi node is given by the constant BASE. */
2106 static tree
2107 get_val_for (tree x, tree base)
2109 gimple stmt;
2111 gcc_assert (is_gimple_min_invariant (base));
2113 if (!x)
2114 return base;
2116 stmt = SSA_NAME_DEF_STMT (x);
2117 if (gimple_code (stmt) == GIMPLE_PHI)
2118 return base;
2120 gcc_assert (is_gimple_assign (stmt));
2122 /* STMT must be either an assignment of a single SSA name or an
2123 expression involving an SSA name and a constant. Try to fold that
2124 expression using the value for the SSA name. */
2125 if (gimple_assign_ssa_name_copy_p (stmt))
2126 return get_val_for (gimple_assign_rhs1 (stmt), base);
2127 else if (gimple_assign_rhs_class (stmt) == GIMPLE_UNARY_RHS
2128 && TREE_CODE (gimple_assign_rhs1 (stmt)) == SSA_NAME)
2130 return fold_build1 (gimple_assign_rhs_code (stmt),
2131 gimple_expr_type (stmt),
2132 get_val_for (gimple_assign_rhs1 (stmt), base));
2134 else if (gimple_assign_rhs_class (stmt) == GIMPLE_BINARY_RHS)
2136 tree rhs1 = gimple_assign_rhs1 (stmt);
2137 tree rhs2 = gimple_assign_rhs2 (stmt);
2138 if (TREE_CODE (rhs1) == SSA_NAME)
2139 rhs1 = get_val_for (rhs1, base);
2140 else if (TREE_CODE (rhs2) == SSA_NAME)
2141 rhs2 = get_val_for (rhs2, base);
2142 else
2143 gcc_unreachable ();
2144 return fold_build2 (gimple_assign_rhs_code (stmt),
2145 gimple_expr_type (stmt), rhs1, rhs2);
2147 else
2148 gcc_unreachable ();
2152 /* Tries to count the number of iterations of LOOP till it exits by EXIT
2153 by brute force -- i.e. by determining the value of the operands of the
2154 condition at EXIT in first few iterations of the loop (assuming that
2155 these values are constant) and determining the first one in that the
2156 condition is not satisfied. Returns the constant giving the number
2157 of the iterations of LOOP if successful, chrec_dont_know otherwise. */
2159 tree
2160 loop_niter_by_eval (struct loop *loop, edge exit)
2162 tree acnd;
2163 tree op[2], val[2], next[2], aval[2];
2164 gimple phi, cond;
2165 unsigned i, j;
2166 enum tree_code cmp;
2168 cond = last_stmt (exit->src);
2169 if (!cond || gimple_code (cond) != GIMPLE_COND)
2170 return chrec_dont_know;
2172 cmp = gimple_cond_code (cond);
2173 if (exit->flags & EDGE_TRUE_VALUE)
2174 cmp = invert_tree_comparison (cmp, false);
2176 switch (cmp)
2178 case EQ_EXPR:
2179 case NE_EXPR:
2180 case GT_EXPR:
2181 case GE_EXPR:
2182 case LT_EXPR:
2183 case LE_EXPR:
2184 op[0] = gimple_cond_lhs (cond);
2185 op[1] = gimple_cond_rhs (cond);
2186 break;
2188 default:
2189 return chrec_dont_know;
2192 for (j = 0; j < 2; j++)
2194 if (is_gimple_min_invariant (op[j]))
2196 val[j] = op[j];
2197 next[j] = NULL_TREE;
2198 op[j] = NULL_TREE;
2200 else
2202 phi = get_base_for (loop, op[j]);
2203 if (!phi)
2204 return chrec_dont_know;
2205 val[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_preheader_edge (loop));
2206 next[j] = PHI_ARG_DEF_FROM_EDGE (phi, loop_latch_edge (loop));
2210 /* Don't issue signed overflow warnings. */
2211 fold_defer_overflow_warnings ();
2213 for (i = 0; i < MAX_ITERATIONS_TO_TRACK; i++)
2215 for (j = 0; j < 2; j++)
2216 aval[j] = get_val_for (op[j], val[j]);
2218 acnd = fold_binary (cmp, boolean_type_node, aval[0], aval[1]);
2219 if (acnd && integer_zerop (acnd))
2221 fold_undefer_and_ignore_overflow_warnings ();
2222 if (dump_file && (dump_flags & TDF_DETAILS))
2223 fprintf (dump_file,
2224 "Proved that loop %d iterates %d times using brute force.\n",
2225 loop->num, i);
2226 return build_int_cst (unsigned_type_node, i);
2229 for (j = 0; j < 2; j++)
2231 val[j] = get_val_for (next[j], val[j]);
2232 if (!is_gimple_min_invariant (val[j]))
2234 fold_undefer_and_ignore_overflow_warnings ();
2235 return chrec_dont_know;
2240 fold_undefer_and_ignore_overflow_warnings ();
2242 return chrec_dont_know;
2245 /* Finds the exit of the LOOP by that the loop exits after a constant
2246 number of iterations and stores the exit edge to *EXIT. The constant
2247 giving the number of iterations of LOOP is returned. The number of
2248 iterations is determined using loop_niter_by_eval (i.e. by brute force
2249 evaluation). If we are unable to find the exit for that loop_niter_by_eval
2250 determines the number of iterations, chrec_dont_know is returned. */
2252 tree
2253 find_loop_niter_by_eval (struct loop *loop, edge *exit)
2255 unsigned i;
2256 VEC (edge, heap) *exits = get_loop_exit_edges (loop);
2257 edge ex;
2258 tree niter = NULL_TREE, aniter;
2260 *exit = NULL;
2262 /* Loops with multiple exits are expensive to handle and less important. */
2263 if (!flag_expensive_optimizations
2264 && VEC_length (edge, exits) > 1)
2265 return chrec_dont_know;
2267 for (i = 0; VEC_iterate (edge, exits, i, ex); i++)
2269 if (!just_once_each_iteration_p (loop, ex->src))
2270 continue;
2272 aniter = loop_niter_by_eval (loop, ex);
2273 if (chrec_contains_undetermined (aniter))
2274 continue;
2276 if (niter
2277 && !tree_int_cst_lt (aniter, niter))
2278 continue;
2280 niter = aniter;
2281 *exit = ex;
2283 VEC_free (edge, heap, exits);
2285 return niter ? niter : chrec_dont_know;
2290 Analysis of upper bounds on number of iterations of a loop.
2294 static double_int derive_constant_upper_bound_ops (tree, tree,
2295 enum tree_code, tree);
2297 /* Returns a constant upper bound on the value of the right-hand side of
2298 an assignment statement STMT. */
2300 static double_int
2301 derive_constant_upper_bound_assign (gimple stmt)
2303 enum tree_code code = gimple_assign_rhs_code (stmt);
2304 tree op0 = gimple_assign_rhs1 (stmt);
2305 tree op1 = gimple_assign_rhs2 (stmt);
2307 return derive_constant_upper_bound_ops (TREE_TYPE (gimple_assign_lhs (stmt)),
2308 op0, code, op1);
2311 /* Returns a constant upper bound on the value of expression VAL. VAL
2312 is considered to be unsigned. If its type is signed, its value must
2313 be nonnegative. */
2315 static double_int
2316 derive_constant_upper_bound (tree val)
2318 enum tree_code code;
2319 tree op0, op1;
2321 extract_ops_from_tree (val, &code, &op0, &op1);
2322 return derive_constant_upper_bound_ops (TREE_TYPE (val), op0, code, op1);
2325 /* Returns a constant upper bound on the value of expression OP0 CODE OP1,
2326 whose type is TYPE. The expression is considered to be unsigned. If
2327 its type is signed, its value must be nonnegative. */
2329 static double_int
2330 derive_constant_upper_bound_ops (tree type, tree op0,
2331 enum tree_code code, tree op1)
2333 tree subtype, maxt;
2334 double_int bnd, max, mmax, cst;
2335 gimple stmt;
2337 if (INTEGRAL_TYPE_P (type))
2338 maxt = TYPE_MAX_VALUE (type);
2339 else
2340 maxt = upper_bound_in_type (type, type);
2342 max = tree_to_double_int (maxt);
2344 switch (code)
2346 case INTEGER_CST:
2347 return tree_to_double_int (op0);
2349 CASE_CONVERT:
2350 subtype = TREE_TYPE (op0);
2351 if (!TYPE_UNSIGNED (subtype)
2352 /* If TYPE is also signed, the fact that VAL is nonnegative implies
2353 that OP0 is nonnegative. */
2354 && TYPE_UNSIGNED (type)
2355 && !tree_expr_nonnegative_p (op0))
2357 /* If we cannot prove that the casted expression is nonnegative,
2358 we cannot establish more useful upper bound than the precision
2359 of the type gives us. */
2360 return max;
2363 /* We now know that op0 is an nonnegative value. Try deriving an upper
2364 bound for it. */
2365 bnd = derive_constant_upper_bound (op0);
2367 /* If the bound does not fit in TYPE, max. value of TYPE could be
2368 attained. */
2369 if (double_int_ucmp (max, bnd) < 0)
2370 return max;
2372 return bnd;
2374 case PLUS_EXPR:
2375 case POINTER_PLUS_EXPR:
2376 case MINUS_EXPR:
2377 if (TREE_CODE (op1) != INTEGER_CST
2378 || !tree_expr_nonnegative_p (op0))
2379 return max;
2381 /* Canonicalize to OP0 - CST. Consider CST to be signed, in order to
2382 choose the most logical way how to treat this constant regardless
2383 of the signedness of the type. */
2384 cst = tree_to_double_int (op1);
2385 cst = double_int_sext (cst, TYPE_PRECISION (type));
2386 if (code != MINUS_EXPR)
2387 cst = double_int_neg (cst);
2389 bnd = derive_constant_upper_bound (op0);
2391 if (double_int_negative_p (cst))
2393 cst = double_int_neg (cst);
2394 /* Avoid CST == 0x80000... */
2395 if (double_int_negative_p (cst))
2396 return max;;
2398 /* OP0 + CST. We need to check that
2399 BND <= MAX (type) - CST. */
2401 mmax = double_int_sub (max, cst);
2402 if (double_int_ucmp (bnd, mmax) > 0)
2403 return max;
2405 return double_int_add (bnd, cst);
2407 else
2409 /* OP0 - CST, where CST >= 0.
2411 If TYPE is signed, we have already verified that OP0 >= 0, and we
2412 know that the result is nonnegative. This implies that
2413 VAL <= BND - CST.
2415 If TYPE is unsigned, we must additionally know that OP0 >= CST,
2416 otherwise the operation underflows.
2419 /* This should only happen if the type is unsigned; however, for
2420 buggy programs that use overflowing signed arithmetics even with
2421 -fno-wrapv, this condition may also be true for signed values. */
2422 if (double_int_ucmp (bnd, cst) < 0)
2423 return max;
2425 if (TYPE_UNSIGNED (type))
2427 tree tem = fold_binary (GE_EXPR, boolean_type_node, op0,
2428 double_int_to_tree (type, cst));
2429 if (!tem || integer_nonzerop (tem))
2430 return max;
2433 bnd = double_int_sub (bnd, cst);
2436 return bnd;
2438 case FLOOR_DIV_EXPR:
2439 case EXACT_DIV_EXPR:
2440 if (TREE_CODE (op1) != INTEGER_CST
2441 || tree_int_cst_sign_bit (op1))
2442 return max;
2444 bnd = derive_constant_upper_bound (op0);
2445 return double_int_udiv (bnd, tree_to_double_int (op1), FLOOR_DIV_EXPR);
2447 case BIT_AND_EXPR:
2448 if (TREE_CODE (op1) != INTEGER_CST
2449 || tree_int_cst_sign_bit (op1))
2450 return max;
2451 return tree_to_double_int (op1);
2453 case SSA_NAME:
2454 stmt = SSA_NAME_DEF_STMT (op0);
2455 if (gimple_code (stmt) != GIMPLE_ASSIGN
2456 || gimple_assign_lhs (stmt) != op0)
2457 return max;
2458 return derive_constant_upper_bound_assign (stmt);
2460 default:
2461 return max;
2465 /* Records that every statement in LOOP is executed I_BOUND times.
2466 REALISTIC is true if I_BOUND is expected to be close to the real number
2467 of iterations. UPPER is true if we are sure the loop iterates at most
2468 I_BOUND times. */
2470 static void
2471 record_niter_bound (struct loop *loop, double_int i_bound, bool realistic,
2472 bool upper)
2474 /* Update the bounds only when there is no previous estimation, or when the current
2475 estimation is smaller. */
2476 if (upper
2477 && (!loop->any_upper_bound
2478 || double_int_ucmp (i_bound, loop->nb_iterations_upper_bound) < 0))
2480 loop->any_upper_bound = true;
2481 loop->nb_iterations_upper_bound = i_bound;
2483 if (realistic
2484 && (!loop->any_estimate
2485 || double_int_ucmp (i_bound, loop->nb_iterations_estimate) < 0))
2487 loop->any_estimate = true;
2488 loop->nb_iterations_estimate = i_bound;
2492 /* Records that AT_STMT is executed at most BOUND + 1 times in LOOP. IS_EXIT
2493 is true if the loop is exited immediately after STMT, and this exit
2494 is taken at last when the STMT is executed BOUND + 1 times.
2495 REALISTIC is true if BOUND is expected to be close to the real number
2496 of iterations. UPPER is true if we are sure the loop iterates at most
2497 BOUND times. I_BOUND is an unsigned double_int upper estimate on BOUND. */
2499 static void
2500 record_estimate (struct loop *loop, tree bound, double_int i_bound,
2501 gimple at_stmt, bool is_exit, bool realistic, bool upper)
2503 double_int delta;
2504 edge exit;
2506 if (dump_file && (dump_flags & TDF_DETAILS))
2508 fprintf (dump_file, "Statement %s", is_exit ? "(exit)" : "");
2509 print_gimple_stmt (dump_file, at_stmt, 0, TDF_SLIM);
2510 fprintf (dump_file, " is %sexecuted at most ",
2511 upper ? "" : "probably ");
2512 print_generic_expr (dump_file, bound, TDF_SLIM);
2513 fprintf (dump_file, " (bounded by ");
2514 dump_double_int (dump_file, i_bound, true);
2515 fprintf (dump_file, ") + 1 times in loop %d.\n", loop->num);
2518 /* If the I_BOUND is just an estimate of BOUND, it rarely is close to the
2519 real number of iterations. */
2520 if (TREE_CODE (bound) != INTEGER_CST)
2521 realistic = false;
2522 if (!upper && !realistic)
2523 return;
2525 /* If we have a guaranteed upper bound, record it in the appropriate
2526 list. */
2527 if (upper)
2529 struct nb_iter_bound *elt = ggc_alloc_nb_iter_bound ();
2531 elt->bound = i_bound;
2532 elt->stmt = at_stmt;
2533 elt->is_exit = is_exit;
2534 elt->next = loop->bounds;
2535 loop->bounds = elt;
2538 /* Update the number of iteration estimates according to the bound.
2539 If at_stmt is an exit, then every statement in the loop is
2540 executed at most BOUND + 1 times. If it is not an exit, then
2541 some of the statements before it could be executed BOUND + 2
2542 times, if an exit of LOOP is before stmt. */
2543 exit = single_exit (loop);
2544 if (is_exit
2545 || (exit != NULL
2546 && dominated_by_p (CDI_DOMINATORS,
2547 exit->src, gimple_bb (at_stmt))))
2548 delta = double_int_one;
2549 else
2550 delta = double_int_two;
2551 i_bound = double_int_add (i_bound, delta);
2553 /* If an overflow occurred, ignore the result. */
2554 if (double_int_ucmp (i_bound, delta) < 0)
2555 return;
2557 record_niter_bound (loop, i_bound, realistic, upper);
2560 /* Record the estimate on number of iterations of LOOP based on the fact that
2561 the induction variable BASE + STEP * i evaluated in STMT does not wrap and
2562 its values belong to the range <LOW, HIGH>. REALISTIC is true if the
2563 estimated number of iterations is expected to be close to the real one.
2564 UPPER is true if we are sure the induction variable does not wrap. */
2566 static void
2567 record_nonwrapping_iv (struct loop *loop, tree base, tree step, gimple stmt,
2568 tree low, tree high, bool realistic, bool upper)
2570 tree niter_bound, extreme, delta;
2571 tree type = TREE_TYPE (base), unsigned_type;
2572 double_int max;
2574 if (TREE_CODE (step) != INTEGER_CST || integer_zerop (step))
2575 return;
2577 if (dump_file && (dump_flags & TDF_DETAILS))
2579 fprintf (dump_file, "Induction variable (");
2580 print_generic_expr (dump_file, TREE_TYPE (base), TDF_SLIM);
2581 fprintf (dump_file, ") ");
2582 print_generic_expr (dump_file, base, TDF_SLIM);
2583 fprintf (dump_file, " + ");
2584 print_generic_expr (dump_file, step, TDF_SLIM);
2585 fprintf (dump_file, " * iteration does not wrap in statement ");
2586 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
2587 fprintf (dump_file, " in loop %d.\n", loop->num);
2590 unsigned_type = unsigned_type_for (type);
2591 base = fold_convert (unsigned_type, base);
2592 step = fold_convert (unsigned_type, step);
2594 if (tree_int_cst_sign_bit (step))
2596 extreme = fold_convert (unsigned_type, low);
2597 if (TREE_CODE (base) != INTEGER_CST)
2598 base = fold_convert (unsigned_type, high);
2599 delta = fold_build2 (MINUS_EXPR, unsigned_type, base, extreme);
2600 step = fold_build1 (NEGATE_EXPR, unsigned_type, step);
2602 else
2604 extreme = fold_convert (unsigned_type, high);
2605 if (TREE_CODE (base) != INTEGER_CST)
2606 base = fold_convert (unsigned_type, low);
2607 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, base);
2610 /* STMT is executed at most NITER_BOUND + 1 times, since otherwise the value
2611 would get out of the range. */
2612 niter_bound = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step);
2613 max = derive_constant_upper_bound (niter_bound);
2614 record_estimate (loop, niter_bound, max, stmt, false, realistic, upper);
2617 /* Returns true if REF is a reference to an array at the end of a dynamically
2618 allocated structure. If this is the case, the array may be allocated larger
2619 than its upper bound implies. */
2621 bool
2622 array_at_struct_end_p (tree ref)
2624 tree base = get_base_address (ref);
2625 tree parent, field;
2627 /* Unless the reference is through a pointer, the size of the array matches
2628 its declaration. */
2629 if (!base || (!INDIRECT_REF_P (base) && TREE_CODE (base) != MEM_REF))
2630 return false;
2632 for (;handled_component_p (ref); ref = parent)
2634 parent = TREE_OPERAND (ref, 0);
2636 if (TREE_CODE (ref) == COMPONENT_REF)
2638 /* All fields of a union are at its end. */
2639 if (TREE_CODE (TREE_TYPE (parent)) == UNION_TYPE)
2640 continue;
2642 /* Unless the field is at the end of the struct, we are done. */
2643 field = TREE_OPERAND (ref, 1);
2644 if (DECL_CHAIN (field))
2645 return false;
2648 /* The other options are ARRAY_REF, ARRAY_RANGE_REF, VIEW_CONVERT_EXPR.
2649 In all these cases, we might be accessing the last element, and
2650 although in practice this will probably never happen, it is legal for
2651 the indices of this last element to exceed the bounds of the array.
2652 Therefore, continue checking. */
2655 return true;
2658 /* Determine information about number of iterations a LOOP from the index
2659 IDX of a data reference accessed in STMT. RELIABLE is true if STMT is
2660 guaranteed to be executed in every iteration of LOOP. Callback for
2661 for_each_index. */
2663 struct ilb_data
2665 struct loop *loop;
2666 gimple stmt;
2667 bool reliable;
2670 static bool
2671 idx_infer_loop_bounds (tree base, tree *idx, void *dta)
2673 struct ilb_data *data = (struct ilb_data *) dta;
2674 tree ev, init, step;
2675 tree low, high, type, next;
2676 bool sign, upper = data->reliable, at_end = false;
2677 struct loop *loop = data->loop;
2679 if (TREE_CODE (base) != ARRAY_REF)
2680 return true;
2682 /* For arrays at the end of the structure, we are not guaranteed that they
2683 do not really extend over their declared size. However, for arrays of
2684 size greater than one, this is unlikely to be intended. */
2685 if (array_at_struct_end_p (base))
2687 at_end = true;
2688 upper = false;
2691 ev = instantiate_parameters (loop, analyze_scalar_evolution (loop, *idx));
2692 init = initial_condition (ev);
2693 step = evolution_part_in_loop_num (ev, loop->num);
2695 if (!init
2696 || !step
2697 || TREE_CODE (step) != INTEGER_CST
2698 || integer_zerop (step)
2699 || tree_contains_chrecs (init, NULL)
2700 || chrec_contains_symbols_defined_in_loop (init, loop->num))
2701 return true;
2703 low = array_ref_low_bound (base);
2704 high = array_ref_up_bound (base);
2706 /* The case of nonconstant bounds could be handled, but it would be
2707 complicated. */
2708 if (TREE_CODE (low) != INTEGER_CST
2709 || !high
2710 || TREE_CODE (high) != INTEGER_CST)
2711 return true;
2712 sign = tree_int_cst_sign_bit (step);
2713 type = TREE_TYPE (step);
2715 /* The array of length 1 at the end of a structure most likely extends
2716 beyond its bounds. */
2717 if (at_end
2718 && operand_equal_p (low, high, 0))
2719 return true;
2721 /* In case the relevant bound of the array does not fit in type, or
2722 it does, but bound + step (in type) still belongs into the range of the
2723 array, the index may wrap and still stay within the range of the array
2724 (consider e.g. if the array is indexed by the full range of
2725 unsigned char).
2727 To make things simpler, we require both bounds to fit into type, although
2728 there are cases where this would not be strictly necessary. */
2729 if (!int_fits_type_p (high, type)
2730 || !int_fits_type_p (low, type))
2731 return true;
2732 low = fold_convert (type, low);
2733 high = fold_convert (type, high);
2735 if (sign)
2736 next = fold_binary (PLUS_EXPR, type, low, step);
2737 else
2738 next = fold_binary (PLUS_EXPR, type, high, step);
2740 if (tree_int_cst_compare (low, next) <= 0
2741 && tree_int_cst_compare (next, high) <= 0)
2742 return true;
2744 record_nonwrapping_iv (loop, init, step, data->stmt, low, high, true, upper);
2745 return true;
2748 /* Determine information about number of iterations a LOOP from the bounds
2749 of arrays in the data reference REF accessed in STMT. RELIABLE is true if
2750 STMT is guaranteed to be executed in every iteration of LOOP.*/
2752 static void
2753 infer_loop_bounds_from_ref (struct loop *loop, gimple stmt, tree ref,
2754 bool reliable)
2756 struct ilb_data data;
2758 data.loop = loop;
2759 data.stmt = stmt;
2760 data.reliable = reliable;
2761 for_each_index (&ref, idx_infer_loop_bounds, &data);
2764 /* Determine information about number of iterations of a LOOP from the way
2765 arrays are used in STMT. RELIABLE is true if STMT is guaranteed to be
2766 executed in every iteration of LOOP. */
2768 static void
2769 infer_loop_bounds_from_array (struct loop *loop, gimple stmt, bool reliable)
2771 if (is_gimple_assign (stmt))
2773 tree op0 = gimple_assign_lhs (stmt);
2774 tree op1 = gimple_assign_rhs1 (stmt);
2776 /* For each memory access, analyze its access function
2777 and record a bound on the loop iteration domain. */
2778 if (REFERENCE_CLASS_P (op0))
2779 infer_loop_bounds_from_ref (loop, stmt, op0, reliable);
2781 if (REFERENCE_CLASS_P (op1))
2782 infer_loop_bounds_from_ref (loop, stmt, op1, reliable);
2784 else if (is_gimple_call (stmt))
2786 tree arg, lhs;
2787 unsigned i, n = gimple_call_num_args (stmt);
2789 lhs = gimple_call_lhs (stmt);
2790 if (lhs && REFERENCE_CLASS_P (lhs))
2791 infer_loop_bounds_from_ref (loop, stmt, lhs, reliable);
2793 for (i = 0; i < n; i++)
2795 arg = gimple_call_arg (stmt, i);
2796 if (REFERENCE_CLASS_P (arg))
2797 infer_loop_bounds_from_ref (loop, stmt, arg, reliable);
2802 /* Determine information about number of iterations of a LOOP from the fact
2803 that signed arithmetics in STMT does not overflow. */
2805 static void
2806 infer_loop_bounds_from_signedness (struct loop *loop, gimple stmt)
2808 tree def, base, step, scev, type, low, high;
2810 if (gimple_code (stmt) != GIMPLE_ASSIGN)
2811 return;
2813 def = gimple_assign_lhs (stmt);
2815 if (TREE_CODE (def) != SSA_NAME)
2816 return;
2818 type = TREE_TYPE (def);
2819 if (!INTEGRAL_TYPE_P (type)
2820 || !TYPE_OVERFLOW_UNDEFINED (type))
2821 return;
2823 scev = instantiate_parameters (loop, analyze_scalar_evolution (loop, def));
2824 if (chrec_contains_undetermined (scev))
2825 return;
2827 base = initial_condition_in_loop_num (scev, loop->num);
2828 step = evolution_part_in_loop_num (scev, loop->num);
2830 if (!base || !step
2831 || TREE_CODE (step) != INTEGER_CST
2832 || tree_contains_chrecs (base, NULL)
2833 || chrec_contains_symbols_defined_in_loop (base, loop->num))
2834 return;
2836 low = lower_bound_in_type (type, type);
2837 high = upper_bound_in_type (type, type);
2839 record_nonwrapping_iv (loop, base, step, stmt, low, high, false, true);
2842 /* The following analyzers are extracting informations on the bounds
2843 of LOOP from the following undefined behaviors:
2845 - data references should not access elements over the statically
2846 allocated size,
2848 - signed variables should not overflow when flag_wrapv is not set.
2851 static void
2852 infer_loop_bounds_from_undefined (struct loop *loop)
2854 unsigned i;
2855 basic_block *bbs;
2856 gimple_stmt_iterator bsi;
2857 basic_block bb;
2858 bool reliable;
2860 bbs = get_loop_body (loop);
2862 for (i = 0; i < loop->num_nodes; i++)
2864 bb = bbs[i];
2866 /* If BB is not executed in each iteration of the loop, we cannot
2867 use the operations in it to infer reliable upper bound on the
2868 # of iterations of the loop. However, we can use it as a guess. */
2869 reliable = dominated_by_p (CDI_DOMINATORS, loop->latch, bb);
2871 for (bsi = gsi_start_bb (bb); !gsi_end_p (bsi); gsi_next (&bsi))
2873 gimple stmt = gsi_stmt (bsi);
2875 infer_loop_bounds_from_array (loop, stmt, reliable);
2877 if (reliable)
2878 infer_loop_bounds_from_signedness (loop, stmt);
2883 free (bbs);
2886 /* Converts VAL to double_int. */
2888 static double_int
2889 gcov_type_to_double_int (gcov_type val)
2891 double_int ret;
2893 ret.low = (unsigned HOST_WIDE_INT) val;
2894 /* If HOST_BITS_PER_WIDE_INT == HOST_BITS_PER_WIDEST_INT, avoid shifting by
2895 the size of type. */
2896 val >>= HOST_BITS_PER_WIDE_INT - 1;
2897 val >>= 1;
2898 ret.high = (unsigned HOST_WIDE_INT) val;
2900 return ret;
2903 /* Records estimates on numbers of iterations of LOOP. */
2905 void
2906 estimate_numbers_of_iterations_loop (struct loop *loop)
2908 VEC (edge, heap) *exits;
2909 tree niter, type;
2910 unsigned i;
2911 struct tree_niter_desc niter_desc;
2912 edge ex;
2913 double_int bound;
2915 /* Give up if we already have tried to compute an estimation. */
2916 if (loop->estimate_state != EST_NOT_COMPUTED)
2917 return;
2918 loop->estimate_state = EST_AVAILABLE;
2919 loop->any_upper_bound = false;
2920 loop->any_estimate = false;
2922 exits = get_loop_exit_edges (loop);
2923 for (i = 0; VEC_iterate (edge, exits, i, ex); i++)
2925 if (!number_of_iterations_exit (loop, ex, &niter_desc, false))
2926 continue;
2928 niter = niter_desc.niter;
2929 type = TREE_TYPE (niter);
2930 if (TREE_CODE (niter_desc.may_be_zero) != INTEGER_CST)
2931 niter = build3 (COND_EXPR, type, niter_desc.may_be_zero,
2932 build_int_cst (type, 0),
2933 niter);
2934 record_estimate (loop, niter, niter_desc.max,
2935 last_stmt (ex->src),
2936 true, true, true);
2938 VEC_free (edge, heap, exits);
2940 infer_loop_bounds_from_undefined (loop);
2942 /* If we have a measured profile, use it to estimate the number of
2943 iterations. */
2944 if (loop->header->count != 0)
2946 gcov_type nit = expected_loop_iterations_unbounded (loop) + 1;
2947 bound = gcov_type_to_double_int (nit);
2948 record_niter_bound (loop, bound, true, false);
2951 /* If an upper bound is smaller than the realistic estimate of the
2952 number of iterations, use the upper bound instead. */
2953 if (loop->any_upper_bound
2954 && loop->any_estimate
2955 && double_int_ucmp (loop->nb_iterations_upper_bound,
2956 loop->nb_iterations_estimate) < 0)
2957 loop->nb_iterations_estimate = loop->nb_iterations_upper_bound;
2960 /* Records estimates on numbers of iterations of loops. */
2962 void
2963 estimate_numbers_of_iterations (void)
2965 loop_iterator li;
2966 struct loop *loop;
2968 /* We don't want to issue signed overflow warnings while getting
2969 loop iteration estimates. */
2970 fold_defer_overflow_warnings ();
2972 FOR_EACH_LOOP (li, loop, 0)
2974 estimate_numbers_of_iterations_loop (loop);
2977 fold_undefer_and_ignore_overflow_warnings ();
2980 /* Returns true if statement S1 dominates statement S2. */
2982 bool
2983 stmt_dominates_stmt_p (gimple s1, gimple s2)
2985 basic_block bb1 = gimple_bb (s1), bb2 = gimple_bb (s2);
2987 if (!bb1
2988 || s1 == s2)
2989 return true;
2991 if (bb1 == bb2)
2993 gimple_stmt_iterator bsi;
2995 if (gimple_code (s2) == GIMPLE_PHI)
2996 return false;
2998 if (gimple_code (s1) == GIMPLE_PHI)
2999 return true;
3001 for (bsi = gsi_start_bb (bb1); gsi_stmt (bsi) != s2; gsi_next (&bsi))
3002 if (gsi_stmt (bsi) == s1)
3003 return true;
3005 return false;
3008 return dominated_by_p (CDI_DOMINATORS, bb2, bb1);
3011 /* Returns true when we can prove that the number of executions of
3012 STMT in the loop is at most NITER, according to the bound on
3013 the number of executions of the statement NITER_BOUND->stmt recorded in
3014 NITER_BOUND. If STMT is NULL, we must prove this bound for all
3015 statements in the loop. */
3017 static bool
3018 n_of_executions_at_most (gimple stmt,
3019 struct nb_iter_bound *niter_bound,
3020 tree niter)
3022 double_int bound = niter_bound->bound;
3023 tree nit_type = TREE_TYPE (niter), e;
3024 enum tree_code cmp;
3026 gcc_assert (TYPE_UNSIGNED (nit_type));
3028 /* If the bound does not even fit into NIT_TYPE, it cannot tell us that
3029 the number of iterations is small. */
3030 if (!double_int_fits_to_tree_p (nit_type, bound))
3031 return false;
3033 /* We know that NITER_BOUND->stmt is executed at most NITER_BOUND->bound + 1
3034 times. This means that:
3036 -- if NITER_BOUND->is_exit is true, then everything before
3037 NITER_BOUND->stmt is executed at most NITER_BOUND->bound + 1
3038 times, and everything after it at most NITER_BOUND->bound times.
3040 -- If NITER_BOUND->is_exit is false, then if we can prove that when STMT
3041 is executed, then NITER_BOUND->stmt is executed as well in the same
3042 iteration (we conclude that if both statements belong to the same
3043 basic block, or if STMT is after NITER_BOUND->stmt), then STMT
3044 is executed at most NITER_BOUND->bound + 1 times. Otherwise STMT is
3045 executed at most NITER_BOUND->bound + 2 times. */
3047 if (niter_bound->is_exit)
3049 if (stmt
3050 && stmt != niter_bound->stmt
3051 && stmt_dominates_stmt_p (niter_bound->stmt, stmt))
3052 cmp = GE_EXPR;
3053 else
3054 cmp = GT_EXPR;
3056 else
3058 if (!stmt
3059 || (gimple_bb (stmt) != gimple_bb (niter_bound->stmt)
3060 && !stmt_dominates_stmt_p (niter_bound->stmt, stmt)))
3062 bound = double_int_add (bound, double_int_one);
3063 if (double_int_zero_p (bound)
3064 || !double_int_fits_to_tree_p (nit_type, bound))
3065 return false;
3067 cmp = GT_EXPR;
3070 e = fold_binary (cmp, boolean_type_node,
3071 niter, double_int_to_tree (nit_type, bound));
3072 return e && integer_nonzerop (e);
3075 /* Returns true if the arithmetics in TYPE can be assumed not to wrap. */
3077 bool
3078 nowrap_type_p (tree type)
3080 if (INTEGRAL_TYPE_P (type)
3081 && TYPE_OVERFLOW_UNDEFINED (type))
3082 return true;
3084 if (POINTER_TYPE_P (type))
3085 return true;
3087 return false;
3090 /* Return false only when the induction variable BASE + STEP * I is
3091 known to not overflow: i.e. when the number of iterations is small
3092 enough with respect to the step and initial condition in order to
3093 keep the evolution confined in TYPEs bounds. Return true when the
3094 iv is known to overflow or when the property is not computable.
3096 USE_OVERFLOW_SEMANTICS is true if this function should assume that
3097 the rules for overflow of the given language apply (e.g., that signed
3098 arithmetics in C does not overflow). */
3100 bool
3101 scev_probably_wraps_p (tree base, tree step,
3102 gimple at_stmt, struct loop *loop,
3103 bool use_overflow_semantics)
3105 struct nb_iter_bound *bound;
3106 tree delta, step_abs;
3107 tree unsigned_type, valid_niter;
3108 tree type = TREE_TYPE (step);
3110 /* FIXME: We really need something like
3111 http://gcc.gnu.org/ml/gcc-patches/2005-06/msg02025.html.
3113 We used to test for the following situation that frequently appears
3114 during address arithmetics:
3116 D.1621_13 = (long unsigned intD.4) D.1620_12;
3117 D.1622_14 = D.1621_13 * 8;
3118 D.1623_15 = (doubleD.29 *) D.1622_14;
3120 And derived that the sequence corresponding to D_14
3121 can be proved to not wrap because it is used for computing a
3122 memory access; however, this is not really the case -- for example,
3123 if D_12 = (unsigned char) [254,+,1], then D_14 has values
3124 2032, 2040, 0, 8, ..., but the code is still legal. */
3126 if (chrec_contains_undetermined (base)
3127 || chrec_contains_undetermined (step))
3128 return true;
3130 if (integer_zerop (step))
3131 return false;
3133 /* If we can use the fact that signed and pointer arithmetics does not
3134 wrap, we are done. */
3135 if (use_overflow_semantics && nowrap_type_p (TREE_TYPE (base)))
3136 return false;
3138 /* To be able to use estimates on number of iterations of the loop,
3139 we must have an upper bound on the absolute value of the step. */
3140 if (TREE_CODE (step) != INTEGER_CST)
3141 return true;
3143 /* Don't issue signed overflow warnings. */
3144 fold_defer_overflow_warnings ();
3146 /* Otherwise, compute the number of iterations before we reach the
3147 bound of the type, and verify that the loop is exited before this
3148 occurs. */
3149 unsigned_type = unsigned_type_for (type);
3150 base = fold_convert (unsigned_type, base);
3152 if (tree_int_cst_sign_bit (step))
3154 tree extreme = fold_convert (unsigned_type,
3155 lower_bound_in_type (type, type));
3156 delta = fold_build2 (MINUS_EXPR, unsigned_type, base, extreme);
3157 step_abs = fold_build1 (NEGATE_EXPR, unsigned_type,
3158 fold_convert (unsigned_type, step));
3160 else
3162 tree extreme = fold_convert (unsigned_type,
3163 upper_bound_in_type (type, type));
3164 delta = fold_build2 (MINUS_EXPR, unsigned_type, extreme, base);
3165 step_abs = fold_convert (unsigned_type, step);
3168 valid_niter = fold_build2 (FLOOR_DIV_EXPR, unsigned_type, delta, step_abs);
3170 estimate_numbers_of_iterations_loop (loop);
3171 for (bound = loop->bounds; bound; bound = bound->next)
3173 if (n_of_executions_at_most (at_stmt, bound, valid_niter))
3175 fold_undefer_and_ignore_overflow_warnings ();
3176 return false;
3180 fold_undefer_and_ignore_overflow_warnings ();
3182 /* At this point we still don't have a proof that the iv does not
3183 overflow: give up. */
3184 return true;
3187 /* Frees the information on upper bounds on numbers of iterations of LOOP. */
3189 void
3190 free_numbers_of_iterations_estimates_loop (struct loop *loop)
3192 struct nb_iter_bound *bound, *next;
3194 loop->nb_iterations = NULL;
3195 loop->estimate_state = EST_NOT_COMPUTED;
3196 for (bound = loop->bounds; bound; bound = next)
3198 next = bound->next;
3199 ggc_free (bound);
3202 loop->bounds = NULL;
3205 /* Frees the information on upper bounds on numbers of iterations of loops. */
3207 void
3208 free_numbers_of_iterations_estimates (void)
3210 loop_iterator li;
3211 struct loop *loop;
3213 FOR_EACH_LOOP (li, loop, 0)
3215 free_numbers_of_iterations_estimates_loop (loop);
3219 /* Substitute value VAL for ssa name NAME inside expressions held
3220 at LOOP. */
3222 void
3223 substitute_in_loop_info (struct loop *loop, tree name, tree val)
3225 loop->nb_iterations = simplify_replace_tree (loop->nb_iterations, name, val);