PR middle-end/23971
[official-gcc.git] / gcc / tree-vrp.c
blob4aec9fcc4dd0c9c055aaff24b49a1d5ea8b0b30c
1 /* Support routines for Value Range Propagation (VRP).
2 Copyright (C) 2005 Free Software Foundation, Inc.
3 Contributed by Diego Novillo <dnovillo@redhat.com>.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to
19 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "tm.h"
26 #include "ggc.h"
27 #include "flags.h"
28 #include "tree.h"
29 #include "basic-block.h"
30 #include "tree-flow.h"
31 #include "tree-pass.h"
32 #include "tree-dump.h"
33 #include "timevar.h"
34 #include "diagnostic.h"
35 #include "cfgloop.h"
36 #include "tree-scalar-evolution.h"
37 #include "tree-ssa-propagate.h"
38 #include "tree-chrec.h"
40 /* Set of SSA names found during the dominator traversal of a
41 sub-graph in find_assert_locations. */
42 static sbitmap found_in_subgraph;
44 /* Loop structure of the program. Used to analyze scalar evolutions
45 inside adjust_range_with_scev. */
46 static struct loops *cfg_loops;
48 /* Local functions. */
49 static int compare_values (tree val1, tree val2);
51 /* Location information for ASSERT_EXPRs. Each instance of this
52 structure describes an ASSERT_EXPR for an SSA name. Since a single
53 SSA name may have more than one assertion associated with it, these
54 locations are kept in a linked list attached to the corresponding
55 SSA name. */
56 struct assert_locus_d
58 /* Basic block where the assertion would be inserted. */
59 basic_block bb;
61 /* Some assertions need to be inserted on an edge (e.g., assertions
62 generated by COND_EXPRs). In those cases, BB will be NULL. */
63 edge e;
65 /* Pointer to the statement that generated this assertion. */
66 block_stmt_iterator si;
68 /* Predicate code for the ASSERT_EXPR. Must be COMPARISON_CLASS_P. */
69 enum tree_code comp_code;
71 /* Value being compared against. */
72 tree val;
74 /* Next node in the linked list. */
75 struct assert_locus_d *next;
78 typedef struct assert_locus_d *assert_locus_t;
80 /* If bit I is present, it means that SSA name N_i has a list of
81 assertions that should be inserted in the IL. */
82 static bitmap need_assert_for;
84 /* Array of locations lists where to insert assertions. ASSERTS_FOR[I]
85 holds a list of ASSERT_LOCUS_T nodes that describe where
86 ASSERT_EXPRs for SSA name N_I should be inserted. */
87 static assert_locus_t *asserts_for;
89 /* Set of blocks visited in find_assert_locations. Used to avoid
90 visiting the same block more than once. */
91 static sbitmap blocks_visited;
93 /* Value range array. After propagation, VR_VALUE[I] holds the range
94 of values that SSA name N_I may take. */
95 static value_range_t **vr_value;
98 /* Return true if ARG is marked with the nonnull attribute in the
99 current function signature. */
101 static bool
102 nonnull_arg_p (tree arg)
104 tree t, attrs, fntype;
105 unsigned HOST_WIDE_INT arg_num;
107 gcc_assert (TREE_CODE (arg) == PARM_DECL && POINTER_TYPE_P (TREE_TYPE (arg)));
109 fntype = TREE_TYPE (current_function_decl);
110 attrs = lookup_attribute ("nonnull", TYPE_ATTRIBUTES (fntype));
112 /* If "nonnull" wasn't specified, we know nothing about the argument. */
113 if (attrs == NULL_TREE)
114 return false;
116 /* If "nonnull" applies to all the arguments, then ARG is non-null. */
117 if (TREE_VALUE (attrs) == NULL_TREE)
118 return true;
120 /* Get the position number for ARG in the function signature. */
121 for (arg_num = 1, t = DECL_ARGUMENTS (current_function_decl);
123 t = TREE_CHAIN (t), arg_num++)
125 if (t == arg)
126 break;
129 gcc_assert (t == arg);
131 /* Now see if ARG_NUM is mentioned in the nonnull list. */
132 for (t = TREE_VALUE (attrs); t; t = TREE_CHAIN (t))
134 if (compare_tree_int (TREE_VALUE (t), arg_num) == 0)
135 return true;
138 return false;
142 /* Set value range VR to {T, MIN, MAX, EQUIV}. */
144 static void
145 set_value_range (value_range_t *vr, enum value_range_type t, tree min,
146 tree max, bitmap equiv)
148 #if defined ENABLE_CHECKING
149 /* Check the validity of the range. */
150 if (t == VR_RANGE || t == VR_ANTI_RANGE)
152 int cmp;
154 gcc_assert (min && max);
156 if (INTEGRAL_TYPE_P (TREE_TYPE (min)) && t == VR_ANTI_RANGE)
157 gcc_assert (min != TYPE_MIN_VALUE (TREE_TYPE (min))
158 || max != TYPE_MAX_VALUE (TREE_TYPE (max)));
160 cmp = compare_values (min, max);
161 gcc_assert (cmp == 0 || cmp == -1 || cmp == -2);
164 if (t == VR_UNDEFINED || t == VR_VARYING)
165 gcc_assert (min == NULL_TREE && max == NULL_TREE);
167 if (t == VR_UNDEFINED || t == VR_VARYING)
168 gcc_assert (equiv == NULL || bitmap_empty_p (equiv));
169 #endif
171 vr->type = t;
172 vr->min = min;
173 vr->max = max;
175 /* Since updating the equivalence set involves deep copying the
176 bitmaps, only do it if absolutely necessary. */
177 if (vr->equiv == NULL)
178 vr->equiv = BITMAP_ALLOC (NULL);
180 if (equiv != vr->equiv)
182 if (equiv && !bitmap_empty_p (equiv))
183 bitmap_copy (vr->equiv, equiv);
184 else
185 bitmap_clear (vr->equiv);
190 /* Copy value range FROM into value range TO. */
192 static inline void
193 copy_value_range (value_range_t *to, value_range_t *from)
195 set_value_range (to, from->type, from->min, from->max, from->equiv);
199 /* Set value range VR to a non-NULL range of type TYPE. */
201 static inline void
202 set_value_range_to_nonnull (value_range_t *vr, tree type)
204 tree zero = build_int_cst (type, 0);
205 set_value_range (vr, VR_ANTI_RANGE, zero, zero, vr->equiv);
209 /* Set value range VR to a NULL range of type TYPE. */
211 static inline void
212 set_value_range_to_null (value_range_t *vr, tree type)
214 tree zero = build_int_cst (type, 0);
215 set_value_range (vr, VR_RANGE, zero, zero, vr->equiv);
219 /* Set value range VR to VR_VARYING. */
221 static inline void
222 set_value_range_to_varying (value_range_t *vr)
224 vr->type = VR_VARYING;
225 vr->min = vr->max = NULL_TREE;
226 if (vr->equiv)
227 bitmap_clear (vr->equiv);
231 /* Set value range VR to VR_UNDEFINED. */
233 static inline void
234 set_value_range_to_undefined (value_range_t *vr)
236 vr->type = VR_UNDEFINED;
237 vr->min = vr->max = NULL_TREE;
238 if (vr->equiv)
239 bitmap_clear (vr->equiv);
243 /* Return value range information for VAR. Create an empty range
244 if none existed. */
246 static value_range_t *
247 get_value_range (tree var)
249 value_range_t *vr;
250 tree sym;
251 unsigned ver = SSA_NAME_VERSION (var);
253 vr = vr_value[ver];
254 if (vr)
255 return vr;
257 /* Create a default value range. */
258 vr_value[ver] = vr = xmalloc (sizeof (*vr));
259 memset (vr, 0, sizeof (*vr));
261 /* Allocate an equivalence set. */
262 vr->equiv = BITMAP_ALLOC (NULL);
264 /* If VAR is a default definition, the variable can take any value
265 in VAR's type. */
266 sym = SSA_NAME_VAR (var);
267 if (var == default_def (sym))
269 /* Try to use the "nonnull" attribute to create ~[0, 0]
270 anti-ranges for pointers. Note that this is only valid with
271 default definitions of PARM_DECLs. */
272 if (TREE_CODE (sym) == PARM_DECL
273 && POINTER_TYPE_P (TREE_TYPE (sym))
274 && nonnull_arg_p (sym))
275 set_value_range_to_nonnull (vr, TREE_TYPE (sym));
276 else
277 set_value_range_to_varying (vr);
280 return vr;
284 /* Update the value range and equivalence set for variable VAR to
285 NEW_VR. Return true if NEW_VR is different from VAR's previous
286 value.
288 NOTE: This function assumes that NEW_VR is a temporary value range
289 object created for the sole purpose of updating VAR's range. The
290 storage used by the equivalence set from NEW_VR will be freed by
291 this function. Do not call update_value_range when NEW_VR
292 is the range object associated with another SSA name. */
294 static inline bool
295 update_value_range (tree var, value_range_t *new_vr)
297 value_range_t *old_vr;
298 bool is_new;
300 /* Update the value range, if necessary. */
301 old_vr = get_value_range (var);
302 is_new = old_vr->type != new_vr->type
303 || old_vr->min != new_vr->min
304 || old_vr->max != new_vr->max
305 || (old_vr->equiv == NULL && new_vr->equiv)
306 || (old_vr->equiv && new_vr->equiv == NULL)
307 || (!bitmap_equal_p (old_vr->equiv, new_vr->equiv));
309 if (is_new)
310 set_value_range (old_vr, new_vr->type, new_vr->min, new_vr->max,
311 new_vr->equiv);
313 BITMAP_FREE (new_vr->equiv);
314 new_vr->equiv = NULL;
316 return is_new;
320 /* Add VAR and VAR's equivalence set to EQUIV. */
322 static void
323 add_equivalence (bitmap equiv, tree var)
325 unsigned ver = SSA_NAME_VERSION (var);
326 value_range_t *vr = vr_value[ver];
328 bitmap_set_bit (equiv, ver);
329 if (vr && vr->equiv)
330 bitmap_ior_into (equiv, vr->equiv);
334 /* Return true if VR is ~[0, 0]. */
336 static inline bool
337 range_is_nonnull (value_range_t *vr)
339 return vr->type == VR_ANTI_RANGE
340 && integer_zerop (vr->min)
341 && integer_zerop (vr->max);
345 /* Return true if VR is [0, 0]. */
347 static inline bool
348 range_is_null (value_range_t *vr)
350 return vr->type == VR_RANGE
351 && integer_zerop (vr->min)
352 && integer_zerop (vr->max);
356 /* Return true if value range VR involves at least one symbol. */
358 static inline bool
359 symbolic_range_p (value_range_t *vr)
361 return (!is_gimple_min_invariant (vr->min)
362 || !is_gimple_min_invariant (vr->max));
366 /* Like tree_expr_nonzero_p, but this function uses value ranges
367 obtained so far. */
369 static bool
370 vrp_expr_computes_nonzero (tree expr)
372 if (tree_expr_nonzero_p (expr))
373 return true;
375 /* If we have an expression of the form &X->a, then the expression
376 is nonnull if X is nonnull. */
377 if (TREE_CODE (expr) == ADDR_EXPR)
379 tree base = get_base_address (TREE_OPERAND (expr, 0));
381 if (base != NULL_TREE
382 && TREE_CODE (base) == INDIRECT_REF
383 && TREE_CODE (TREE_OPERAND (base, 0)) == SSA_NAME)
385 value_range_t *vr = get_value_range (TREE_OPERAND (base, 0));
386 if (range_is_nonnull (vr))
387 return true;
391 return false;
395 /* Compare two values VAL1 and VAL2. Return
397 -2 if VAL1 and VAL2 cannot be compared at compile-time,
398 -1 if VAL1 < VAL2,
399 0 if VAL1 == VAL2,
400 +1 if VAL1 > VAL2, and
401 +2 if VAL1 != VAL2
403 This is similar to tree_int_cst_compare but supports pointer values
404 and values that cannot be compared at compile time. */
406 static int
407 compare_values (tree val1, tree val2)
409 if (val1 == val2)
410 return 0;
412 /* Below we rely on the fact that VAL1 and VAL2 are both pointers or
413 both integers. */
414 gcc_assert (POINTER_TYPE_P (TREE_TYPE (val1))
415 == POINTER_TYPE_P (TREE_TYPE (val2)));
417 /* Do some limited symbolic comparisons. */
418 if (!POINTER_TYPE_P (TREE_TYPE (val1)))
420 /* We can determine some comparisons against +INF and -INF even
421 if the other value is an expression. */
422 if (val1 == TYPE_MAX_VALUE (TREE_TYPE (val1))
423 && TREE_CODE (val2) == MINUS_EXPR)
425 /* +INF > NAME - CST. */
426 return 1;
428 else if (val1 == TYPE_MIN_VALUE (TREE_TYPE (val1))
429 && TREE_CODE (val2) == PLUS_EXPR)
431 /* -INF < NAME + CST. */
432 return -1;
434 else if (TREE_CODE (val1) == MINUS_EXPR
435 && val2 == TYPE_MAX_VALUE (TREE_TYPE (val2)))
437 /* NAME - CST < +INF. */
438 return -1;
440 else if (TREE_CODE (val1) == PLUS_EXPR
441 && val2 == TYPE_MIN_VALUE (TREE_TYPE (val2)))
443 /* NAME + CST > -INF. */
444 return 1;
448 if ((TREE_CODE (val1) == SSA_NAME
449 || TREE_CODE (val1) == PLUS_EXPR
450 || TREE_CODE (val1) == MINUS_EXPR)
451 && (TREE_CODE (val2) == SSA_NAME
452 || TREE_CODE (val2) == PLUS_EXPR
453 || TREE_CODE (val2) == MINUS_EXPR))
455 tree n1, c1, n2, c2;
457 /* If VAL1 and VAL2 are of the form 'NAME [+-] CST' or 'NAME',
458 return -1 or +1 accordingly. If VAL1 and VAL2 don't use the
459 same name, return -2. */
460 if (TREE_CODE (val1) == SSA_NAME)
462 n1 = val1;
463 c1 = NULL_TREE;
465 else
467 n1 = TREE_OPERAND (val1, 0);
468 c1 = TREE_OPERAND (val1, 1);
471 if (TREE_CODE (val2) == SSA_NAME)
473 n2 = val2;
474 c2 = NULL_TREE;
476 else
478 n2 = TREE_OPERAND (val2, 0);
479 c2 = TREE_OPERAND (val2, 1);
482 /* Both values must use the same name. */
483 if (n1 != n2)
484 return -2;
486 if (TREE_CODE (val1) == SSA_NAME)
488 if (TREE_CODE (val2) == SSA_NAME)
489 /* NAME == NAME */
490 return 0;
491 else if (TREE_CODE (val2) == PLUS_EXPR)
492 /* NAME < NAME + CST */
493 return -1;
494 else if (TREE_CODE (val2) == MINUS_EXPR)
495 /* NAME > NAME - CST */
496 return 1;
498 else if (TREE_CODE (val1) == PLUS_EXPR)
500 if (TREE_CODE (val2) == SSA_NAME)
501 /* NAME + CST > NAME */
502 return 1;
503 else if (TREE_CODE (val2) == PLUS_EXPR)
504 /* NAME + CST1 > NAME + CST2, if CST1 > CST2 */
505 return compare_values (c1, c2);
506 else if (TREE_CODE (val2) == MINUS_EXPR)
507 /* NAME + CST1 > NAME - CST2 */
508 return 1;
510 else if (TREE_CODE (val1) == MINUS_EXPR)
512 if (TREE_CODE (val2) == SSA_NAME)
513 /* NAME - CST < NAME */
514 return -1;
515 else if (TREE_CODE (val2) == PLUS_EXPR)
516 /* NAME - CST1 < NAME + CST2 */
517 return -1;
518 else if (TREE_CODE (val2) == MINUS_EXPR)
519 /* NAME - CST1 > NAME - CST2, if CST1 < CST2. Notice that
520 C1 and C2 are swapped in the call to compare_values. */
521 return compare_values (c2, c1);
524 gcc_unreachable ();
527 /* We cannot compare non-constants. */
528 if (!is_gimple_min_invariant (val1) || !is_gimple_min_invariant (val2))
529 return -2;
531 /* We cannot compare overflowed values. */
532 if (TREE_OVERFLOW (val1) || TREE_OVERFLOW (val2))
533 return -2;
535 if (!POINTER_TYPE_P (TREE_TYPE (val1)))
536 return tree_int_cst_compare (val1, val2);
537 else
539 tree t;
541 /* First see if VAL1 and VAL2 are not the same. */
542 if (val1 == val2 || operand_equal_p (val1, val2, 0))
543 return 0;
545 /* If VAL1 is a lower address than VAL2, return -1. */
546 t = fold_binary (LT_EXPR, boolean_type_node, val1, val2);
547 if (t == boolean_true_node)
548 return -1;
550 /* If VAL1 is a higher address than VAL2, return +1. */
551 t = fold_binary (GT_EXPR, boolean_type_node, val1, val2);
552 if (t == boolean_true_node)
553 return 1;
555 /* If VAL1 is different than VAL2, return +2. */
556 t = fold_binary (NE_EXPR, boolean_type_node, val1, val2);
557 if (t == boolean_true_node)
558 return 2;
560 return -2;
565 /* Return 1 if VAL is inside value range VR (VR->MIN <= VAL <= VR->MAX),
566 0 if VAL is not inside VR,
567 -2 if we cannot tell either way. */
569 static inline int
570 value_inside_range (tree val, value_range_t *vr)
572 int cmp1, cmp2;
574 cmp1 = compare_values (val, vr->min);
575 if (cmp1 == -2 || cmp1 == 2)
576 return -2;
578 cmp2 = compare_values (val, vr->max);
579 if (cmp2 == -2 || cmp2 == 2)
580 return -2;
582 return (cmp1 == 0 || cmp1 == 1) && (cmp2 == -1 || cmp2 == 0);
586 /* Return true if value ranges VR0 and VR1 have a non-empty
587 intersection. */
589 static inline bool
590 value_ranges_intersect_p (value_range_t *vr0, value_range_t *vr1)
592 return (value_inside_range (vr1->min, vr0) == 1
593 || value_inside_range (vr1->max, vr0) == 1
594 || value_inside_range (vr0->min, vr1) == 1
595 || value_inside_range (vr0->max, vr1) == 1);
599 /* Return true if VR includes the value zero, false otherwise. */
601 static inline bool
602 range_includes_zero_p (value_range_t *vr)
604 tree zero;
606 gcc_assert (vr->type != VR_UNDEFINED
607 && vr->type != VR_VARYING
608 && !symbolic_range_p (vr));
610 zero = build_int_cst (TREE_TYPE (vr->min), 0);
611 return (value_inside_range (zero, vr) == 1);
615 /* Extract value range information from an ASSERT_EXPR EXPR and store
616 it in *VR_P. */
618 static void
619 extract_range_from_assert (value_range_t *vr_p, tree expr)
621 tree var, cond, limit, min, max, type;
622 value_range_t *var_vr, *limit_vr;
623 enum tree_code cond_code;
625 var = ASSERT_EXPR_VAR (expr);
626 cond = ASSERT_EXPR_COND (expr);
628 gcc_assert (COMPARISON_CLASS_P (cond));
630 /* Find VAR in the ASSERT_EXPR conditional. */
631 if (var == TREE_OPERAND (cond, 0))
633 /* If the predicate is of the form VAR COMP LIMIT, then we just
634 take LIMIT from the RHS and use the same comparison code. */
635 limit = TREE_OPERAND (cond, 1);
636 cond_code = TREE_CODE (cond);
638 else
640 /* If the predicate is of the form LIMIT COMP VAR, then we need
641 to flip around the comparison code to create the proper range
642 for VAR. */
643 limit = TREE_OPERAND (cond, 0);
644 cond_code = swap_tree_comparison (TREE_CODE (cond));
647 type = TREE_TYPE (limit);
648 gcc_assert (limit != var);
650 /* For pointer arithmetic, we only keep track of pointer equality
651 and inequality. */
652 if (POINTER_TYPE_P (type) && cond_code != NE_EXPR && cond_code != EQ_EXPR)
654 set_value_range_to_varying (vr_p);
655 return;
658 /* If LIMIT is another SSA name and LIMIT has a range of its own,
659 try to use LIMIT's range to avoid creating symbolic ranges
660 unnecessarily. */
661 limit_vr = (TREE_CODE (limit) == SSA_NAME) ? get_value_range (limit) : NULL;
663 /* LIMIT's range is only interesting if it has any useful information. */
664 if (limit_vr
665 && (limit_vr->type == VR_UNDEFINED
666 || limit_vr->type == VR_VARYING
667 || symbolic_range_p (limit_vr)))
668 limit_vr = NULL;
670 /* Special handling for integral types with super-types. Some FEs
671 construct integral types derived from other types and restrict
672 the range of values these new types may take.
674 It may happen that LIMIT is actually smaller than TYPE's minimum
675 value. For instance, the Ada FE is generating code like this
676 during bootstrap:
678 D.1480_32 = nam_30 - 300000361;
679 if (D.1480_32 <= 1) goto <L112>; else goto <L52>;
680 <L112>:;
681 D.1480_94 = ASSERT_EXPR <D.1480_32, D.1480_32 <= 1>;
683 All the names are of type types__name_id___XDLU_300000000__399999999
684 which has min == 300000000 and max == 399999999. This means that
685 the ASSERT_EXPR would try to create the range [3000000, 1] which
686 is invalid.
688 The fact that the type specifies MIN and MAX values does not
689 automatically mean that every variable of that type will always
690 be within that range, so the predicate may well be true at run
691 time. If we had symbolic -INF and +INF values, we could
692 represent this range, but we currently represent -INF and +INF
693 using the type's min and max values.
695 So, the only sensible thing we can do for now is set the
696 resulting range to VR_VARYING. TODO, would having symbolic -INF
697 and +INF values be worth the trouble? */
698 if (TREE_CODE (limit) != SSA_NAME
699 && INTEGRAL_TYPE_P (type)
700 && TREE_TYPE (type))
702 if (cond_code == LE_EXPR || cond_code == LT_EXPR)
704 tree type_min = TYPE_MIN_VALUE (type);
705 int cmp = compare_values (limit, type_min);
707 /* For < or <= comparisons, if LIMIT is smaller than
708 TYPE_MIN, set the range to VR_VARYING. */
709 if (cmp == -1 || cmp == 0)
711 set_value_range_to_varying (vr_p);
712 return;
715 else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
717 tree type_max = TYPE_MIN_VALUE (type);
718 int cmp = compare_values (limit, type_max);
720 /* For > or >= comparisons, if LIMIT is bigger than
721 TYPE_MAX, set the range to VR_VARYING. */
722 if (cmp == 1 || cmp == 0)
724 set_value_range_to_varying (vr_p);
725 return;
730 /* The new range has the same set of equivalences of VAR's range. */
731 gcc_assert (vr_p->equiv == NULL);
732 vr_p->equiv = BITMAP_ALLOC (NULL);
733 add_equivalence (vr_p->equiv, var);
735 /* Extract a new range based on the asserted comparison for VAR and
736 LIMIT's value range. Notice that if LIMIT has an anti-range, we
737 will only use it for equality comparisons (EQ_EXPR). For any
738 other kind of assertion, we cannot derive a range from LIMIT's
739 anti-range that can be used to describe the new range. For
740 instance, ASSERT_EXPR <x_2, x_2 <= b_4>. If b_4 is ~[2, 10],
741 then b_4 takes on the ranges [-INF, 1] and [11, +INF]. There is
742 no single range for x_2 that could describe LE_EXPR, so we might
743 as well build the range [b_4, +INF] for it. */
744 if (cond_code == EQ_EXPR)
746 enum value_range_type range_type;
748 if (limit_vr)
750 range_type = limit_vr->type;
751 min = limit_vr->min;
752 max = limit_vr->max;
754 else
756 range_type = VR_RANGE;
757 min = limit;
758 max = limit;
761 set_value_range (vr_p, range_type, min, max, vr_p->equiv);
763 /* When asserting the equality VAR == LIMIT and LIMIT is another
764 SSA name, the new range will also inherit the equivalence set
765 from LIMIT. */
766 if (TREE_CODE (limit) == SSA_NAME)
767 add_equivalence (vr_p->equiv, limit);
769 else if (cond_code == NE_EXPR)
771 /* As described above, when LIMIT's range is an anti-range and
772 this assertion is an inequality (NE_EXPR), then we cannot
773 derive anything from the anti-range. For instance, if
774 LIMIT's range was ~[0, 0], the assertion 'VAR != LIMIT' does
775 not imply that VAR's range is [0, 0]. So, in the case of
776 anti-ranges, we just assert the inequality using LIMIT and
777 not its anti-range. */
778 if (limit_vr == NULL
779 || limit_vr->type == VR_ANTI_RANGE)
781 min = limit;
782 max = limit;
784 else
786 min = limit_vr->min;
787 max = limit_vr->max;
790 /* If MIN and MAX cover the whole range for their type, then
791 just use the original LIMIT. */
792 if (INTEGRAL_TYPE_P (type)
793 && min == TYPE_MIN_VALUE (type)
794 && max == TYPE_MAX_VALUE (type))
795 min = max = limit;
797 set_value_range (vr_p, VR_ANTI_RANGE, min, max, vr_p->equiv);
799 else if (cond_code == LE_EXPR || cond_code == LT_EXPR)
801 min = TYPE_MIN_VALUE (type);
803 if (limit_vr == NULL || limit_vr->type == VR_ANTI_RANGE)
804 max = limit;
805 else
807 /* If LIMIT_VR is of the form [N1, N2], we need to build the
808 range [MIN, N2] for LE_EXPR and [MIN, N2 - 1] for
809 LT_EXPR. */
810 max = limit_vr->max;
813 /* For LT_EXPR, we create the range [MIN, MAX - 1]. */
814 if (cond_code == LT_EXPR)
816 tree one = build_int_cst (type, 1);
817 max = fold_build2 (MINUS_EXPR, type, max, one);
820 set_value_range (vr_p, VR_RANGE, min, max, vr_p->equiv);
822 else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
824 max = TYPE_MAX_VALUE (type);
826 if (limit_vr == NULL || limit_vr->type == VR_ANTI_RANGE)
827 min = limit;
828 else
830 /* If LIMIT_VR is of the form [N1, N2], we need to build the
831 range [N1, MAX] for GE_EXPR and [N1 + 1, MAX] for
832 GT_EXPR. */
833 min = limit_vr->min;
836 /* For GT_EXPR, we create the range [MIN + 1, MAX]. */
837 if (cond_code == GT_EXPR)
839 tree one = build_int_cst (type, 1);
840 min = fold_build2 (PLUS_EXPR, type, min, one);
843 set_value_range (vr_p, VR_RANGE, min, max, vr_p->equiv);
845 else
846 gcc_unreachable ();
848 /* If VAR already had a known range and the two ranges have a
849 non-empty intersection, we can refine the resulting range.
850 Since the assert expression creates an equivalency and at the
851 same time it asserts a predicate, we can take the intersection of
852 the two ranges to get better precision. */
853 var_vr = get_value_range (var);
854 if (var_vr->type == VR_RANGE
855 && vr_p->type == VR_RANGE
856 && value_ranges_intersect_p (var_vr, vr_p))
858 /* Use the larger of the two minimums. */
859 if (compare_values (vr_p->min, var_vr->min) == -1)
860 min = var_vr->min;
861 else
862 min = vr_p->min;
864 /* Use the smaller of the two maximums. */
865 if (compare_values (vr_p->max, var_vr->max) == 1)
866 max = var_vr->max;
867 else
868 max = vr_p->max;
870 set_value_range (vr_p, vr_p->type, min, max, vr_p->equiv);
875 /* Extract range information from SSA name VAR and store it in VR. If
876 VAR has an interesting range, use it. Otherwise, create the
877 range [VAR, VAR] and return it. This is useful in situations where
878 we may have conditionals testing values of VARYING names. For
879 instance,
881 x_3 = y_5;
882 if (x_3 > y_5)
885 Even if y_5 is deemed VARYING, we can determine that x_3 > y_5 is
886 always false. */
888 static void
889 extract_range_from_ssa_name (value_range_t *vr, tree var)
891 value_range_t *var_vr = get_value_range (var);
893 if (var_vr->type != VR_UNDEFINED && var_vr->type != VR_VARYING)
894 copy_value_range (vr, var_vr);
895 else
896 set_value_range (vr, VR_RANGE, var, var, NULL);
898 add_equivalence (vr->equiv, var);
902 /* Wrapper around int_const_binop. If the operation overflows and we
903 are not using wrapping arithmetic, then adjust the result to be
904 -INF or +INF depending on CODE, VAL1 and VAL2. */
906 static inline tree
907 vrp_int_const_binop (enum tree_code code, tree val1, tree val2)
909 tree res;
911 if (flag_wrapv)
912 return int_const_binop (code, val1, val2, 0);
914 /* If we are not using wrapping arithmetic, operate symbolically
915 on -INF and +INF. */
916 res = int_const_binop (code, val1, val2, 0);
918 if (TYPE_UNSIGNED (TREE_TYPE (val1)))
920 int checkz = compare_values (res, val1);
922 /* Ensure that res = val1 + val2 >= val1
923 or that res = val1 - val2 <= val1. */
924 if ((code == PLUS_EXPR && !(checkz == 1 || checkz == 0))
925 || (code == MINUS_EXPR && !(checkz == 0 || checkz == -1)))
927 res = copy_node (res);
928 TREE_OVERFLOW (res) = 1;
931 /* If the operation overflowed but neither VAL1 nor VAL2 are
932 overflown, return -INF or +INF depending on the operation
933 and the combination of signs of the operands. */
934 else if (TREE_OVERFLOW (res)
935 && !TREE_OVERFLOW (val1)
936 && !TREE_OVERFLOW (val2))
938 int sgn1 = tree_int_cst_sgn (val1);
939 int sgn2 = tree_int_cst_sgn (val2);
941 /* Notice that we only need to handle the restricted set of
942 operations handled by extract_range_from_binary_expr.
943 Among them, only multiplication, addition and subtraction
944 can yield overflow without overflown operands because we
945 are working with integral types only... except in the
946 case VAL1 = -INF and VAL2 = -1 which overflows to +INF
947 for division too. */
949 /* For multiplication, the sign of the overflow is given
950 by the comparison of the signs of the operands. */
951 if ((code == MULT_EXPR && sgn1 == sgn2)
952 /* For addition, the operands must be of the same sign
953 to yield an overflow. Its sign is therefore that
954 of one of the operands, for example the first. */
955 || (code == PLUS_EXPR && sgn1 > 0)
956 /* For subtraction, the operands must be of different
957 signs to yield an overflow. Its sign is therefore
958 that of the first operand or the opposite of that
959 of the second operand. A first operand of 0 counts
960 as positive here, for the corner case 0 - (-INF),
961 which overflows, but must yield +INF. */
962 || (code == MINUS_EXPR && sgn1 >= 0)
963 /* For division, the only case is -INF / -1 = +INF. */
964 || code == TRUNC_DIV_EXPR
965 || code == FLOOR_DIV_EXPR
966 || code == CEIL_DIV_EXPR
967 || code == EXACT_DIV_EXPR
968 || code == ROUND_DIV_EXPR)
969 return TYPE_MAX_VALUE (TREE_TYPE (res));
970 else
971 return TYPE_MIN_VALUE (TREE_TYPE (res));
974 return res;
978 /* Extract range information from a binary expression EXPR based on
979 the ranges of each of its operands and the expression code. */
981 static void
982 extract_range_from_binary_expr (value_range_t *vr, tree expr)
984 enum tree_code code = TREE_CODE (expr);
985 tree op0, op1, min, max;
986 int cmp;
987 value_range_t vr0 = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
988 value_range_t vr1 = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
990 /* Not all binary expressions can be applied to ranges in a
991 meaningful way. Handle only arithmetic operations. */
992 if (code != PLUS_EXPR
993 && code != MINUS_EXPR
994 && code != MULT_EXPR
995 && code != TRUNC_DIV_EXPR
996 && code != FLOOR_DIV_EXPR
997 && code != CEIL_DIV_EXPR
998 && code != EXACT_DIV_EXPR
999 && code != ROUND_DIV_EXPR
1000 && code != MIN_EXPR
1001 && code != MAX_EXPR
1002 && code != TRUTH_ANDIF_EXPR
1003 && code != TRUTH_ORIF_EXPR
1004 && code != TRUTH_AND_EXPR
1005 && code != TRUTH_OR_EXPR
1006 && code != TRUTH_XOR_EXPR)
1008 set_value_range_to_varying (vr);
1009 return;
1012 /* Get value ranges for each operand. For constant operands, create
1013 a new value range with the operand to simplify processing. */
1014 op0 = TREE_OPERAND (expr, 0);
1015 if (TREE_CODE (op0) == SSA_NAME)
1016 vr0 = *(get_value_range (op0));
1017 else if (is_gimple_min_invariant (op0))
1018 set_value_range (&vr0, VR_RANGE, op0, op0, NULL);
1019 else
1020 set_value_range_to_varying (&vr0);
1022 op1 = TREE_OPERAND (expr, 1);
1023 if (TREE_CODE (op1) == SSA_NAME)
1024 vr1 = *(get_value_range (op1));
1025 else if (is_gimple_min_invariant (op1))
1026 set_value_range (&vr1, VR_RANGE, op1, op1, NULL);
1027 else
1028 set_value_range_to_varying (&vr1);
1030 /* If either range is UNDEFINED, so is the result. */
1031 if (vr0.type == VR_UNDEFINED || vr1.type == VR_UNDEFINED)
1033 set_value_range_to_undefined (vr);
1034 return;
1037 /* Refuse to operate on VARYING ranges, ranges of different kinds
1038 and symbolic ranges. TODO, we may be able to derive anti-ranges
1039 in some cases. */
1040 if (vr0.type == VR_VARYING
1041 || vr1.type == VR_VARYING
1042 || vr0.type != vr1.type
1043 || symbolic_range_p (&vr0)
1044 || symbolic_range_p (&vr1))
1046 set_value_range_to_varying (vr);
1047 return;
1050 /* Now evaluate the expression to determine the new range. */
1051 if (POINTER_TYPE_P (TREE_TYPE (expr))
1052 || POINTER_TYPE_P (TREE_TYPE (op0))
1053 || POINTER_TYPE_P (TREE_TYPE (op1)))
1055 /* For pointer types, we are really only interested in asserting
1056 whether the expression evaluates to non-NULL. FIXME, we used
1057 to gcc_assert (code == PLUS_EXPR || code == MINUS_EXPR), but
1058 ivopts is generating expressions with pointer multiplication
1059 in them. */
1060 if (code == PLUS_EXPR)
1062 if (range_is_nonnull (&vr0) || range_is_nonnull (&vr1))
1063 set_value_range_to_nonnull (vr, TREE_TYPE (expr));
1064 else if (range_is_null (&vr0) && range_is_null (&vr1))
1065 set_value_range_to_null (vr, TREE_TYPE (expr));
1066 else
1067 set_value_range_to_varying (vr);
1069 else
1071 /* Subtracting from a pointer, may yield 0, so just drop the
1072 resulting range to varying. */
1073 set_value_range_to_varying (vr);
1076 return;
1079 /* For integer ranges, apply the operation to each end of the
1080 range and see what we end up with. */
1081 if (code == TRUTH_ANDIF_EXPR
1082 || code == TRUTH_ORIF_EXPR
1083 || code == TRUTH_AND_EXPR
1084 || code == TRUTH_OR_EXPR
1085 || code == TRUTH_XOR_EXPR)
1087 /* Boolean expressions cannot be folded with int_const_binop. */
1088 min = fold_binary (code, TREE_TYPE (expr), vr0.min, vr1.min);
1089 max = fold_binary (code, TREE_TYPE (expr), vr0.max, vr1.max);
1091 else if (code == PLUS_EXPR
1092 || code == MIN_EXPR
1093 || code == MAX_EXPR)
1095 /* If we have a PLUS_EXPR with two VR_ANTI_RANGEs, drop to
1096 VR_VARYING. It would take more effort to compute a precise
1097 range for such a case. For example, if we have op0 == 1 and
1098 op1 == -1 with their ranges both being ~[0,0], we would have
1099 op0 + op1 == 0, so we cannot claim that the sum is in ~[0,0].
1100 Note that we are guaranteed to have vr0.type == vr1.type at
1101 this point. */
1102 if (code == PLUS_EXPR && vr0.type == VR_ANTI_RANGE)
1104 set_value_range_to_varying (vr);
1105 return;
1108 /* For operations that make the resulting range directly
1109 proportional to the original ranges, apply the operation to
1110 the same end of each range. */
1111 min = vrp_int_const_binop (code, vr0.min, vr1.min);
1112 max = vrp_int_const_binop (code, vr0.max, vr1.max);
1114 else if (code == MULT_EXPR
1115 || code == TRUNC_DIV_EXPR
1116 || code == FLOOR_DIV_EXPR
1117 || code == CEIL_DIV_EXPR
1118 || code == EXACT_DIV_EXPR
1119 || code == ROUND_DIV_EXPR)
1121 tree val[4];
1122 size_t i;
1124 /* If we have an unsigned MULT_EXPR with two VR_ANTI_RANGEs,
1125 drop to VR_VARYING. It would take more effort to compute a
1126 precise range for such a case. For example, if we have
1127 op0 == 65536 and op1 == 65536 with their ranges both being
1128 ~[0,0] on a 32-bit machine, we would have op0 * op1 == 0, so
1129 we cannot claim that the product is in ~[0,0]. Note that we
1130 are guaranteed to have vr0.type == vr1.type at this
1131 point. */
1132 if (code == MULT_EXPR
1133 && vr0.type == VR_ANTI_RANGE
1134 && (flag_wrapv || TYPE_UNSIGNED (TREE_TYPE (op0))))
1136 set_value_range_to_varying (vr);
1137 return;
1140 /* Multiplications and divisions are a bit tricky to handle,
1141 depending on the mix of signs we have in the two ranges, we
1142 need to operate on different values to get the minimum and
1143 maximum values for the new range. One approach is to figure
1144 out all the variations of range combinations and do the
1145 operations.
1147 However, this involves several calls to compare_values and it
1148 is pretty convoluted. It's simpler to do the 4 operations
1149 (MIN0 OP MIN1, MIN0 OP MAX1, MAX0 OP MIN1 and MAX0 OP MAX0 OP
1150 MAX1) and then figure the smallest and largest values to form
1151 the new range. */
1153 /* Divisions by zero result in a VARYING value. */
1154 if (code != MULT_EXPR
1155 && (vr0.type == VR_ANTI_RANGE || range_includes_zero_p (&vr1)))
1157 set_value_range_to_varying (vr);
1158 return;
1161 /* Compute the 4 cross operations. */
1162 val[0] = vrp_int_const_binop (code, vr0.min, vr1.min);
1164 val[1] = (vr1.max != vr1.min)
1165 ? vrp_int_const_binop (code, vr0.min, vr1.max)
1166 : NULL_TREE;
1168 val[2] = (vr0.max != vr0.min)
1169 ? vrp_int_const_binop (code, vr0.max, vr1.min)
1170 : NULL_TREE;
1172 val[3] = (vr0.min != vr0.max && vr1.min != vr1.max)
1173 ? vrp_int_const_binop (code, vr0.max, vr1.max)
1174 : NULL_TREE;
1176 /* Set MIN to the minimum of VAL[i] and MAX to the maximum
1177 of VAL[i]. */
1178 min = val[0];
1179 max = val[0];
1180 for (i = 1; i < 4; i++)
1182 if (TREE_OVERFLOW (min) || TREE_OVERFLOW (max))
1183 break;
1185 if (val[i])
1187 if (TREE_OVERFLOW (val[i]))
1189 /* If we found an overflowed value, set MIN and MAX
1190 to it so that we set the resulting range to
1191 VARYING. */
1192 min = max = val[i];
1193 break;
1196 if (compare_values (val[i], min) == -1)
1197 min = val[i];
1199 if (compare_values (val[i], max) == 1)
1200 max = val[i];
1204 else if (code == MINUS_EXPR)
1206 /* If we have a MINUS_EXPR with two VR_ANTI_RANGEs, drop to
1207 VR_VARYING. It would take more effort to compute a precise
1208 range for such a case. For example, if we have op0 == 1 and
1209 op1 == 1 with their ranges both being ~[0,0], we would have
1210 op0 - op1 == 0, so we cannot claim that the difference is in
1211 ~[0,0]. Note that we are guaranteed to have
1212 vr0.type == vr1.type at this point. */
1213 if (vr0.type == VR_ANTI_RANGE)
1215 set_value_range_to_varying (vr);
1216 return;
1219 /* For MINUS_EXPR, apply the operation to the opposite ends of
1220 each range. */
1221 min = vrp_int_const_binop (code, vr0.min, vr1.max);
1222 max = vrp_int_const_binop (code, vr0.max, vr1.min);
1224 else
1225 gcc_unreachable ();
1227 /* If either MIN or MAX overflowed, then set the resulting range to
1228 VARYING. */
1229 if (TREE_OVERFLOW (min) || TREE_OVERFLOW (max))
1231 set_value_range_to_varying (vr);
1232 return;
1235 cmp = compare_values (min, max);
1236 if (cmp == -2 || cmp == 1)
1238 /* If the new range has its limits swapped around (MIN > MAX),
1239 then the operation caused one of them to wrap around, mark
1240 the new range VARYING. */
1241 set_value_range_to_varying (vr);
1243 else
1244 set_value_range (vr, vr0.type, min, max, NULL);
1248 /* Extract range information from a unary expression EXPR based on
1249 the range of its operand and the expression code. */
1251 static void
1252 extract_range_from_unary_expr (value_range_t *vr, tree expr)
1254 enum tree_code code = TREE_CODE (expr);
1255 tree min, max, op0;
1256 int cmp;
1257 value_range_t vr0 = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
1259 /* Refuse to operate on certain unary expressions for which we
1260 cannot easily determine a resulting range. */
1261 if (code == FIX_TRUNC_EXPR
1262 || code == FIX_CEIL_EXPR
1263 || code == FIX_FLOOR_EXPR
1264 || code == FIX_ROUND_EXPR
1265 || code == FLOAT_EXPR
1266 || code == BIT_NOT_EXPR
1267 || code == NON_LVALUE_EXPR
1268 || code == CONJ_EXPR)
1270 set_value_range_to_varying (vr);
1271 return;
1274 /* Get value ranges for the operand. For constant operands, create
1275 a new value range with the operand to simplify processing. */
1276 op0 = TREE_OPERAND (expr, 0);
1277 if (TREE_CODE (op0) == SSA_NAME)
1278 vr0 = *(get_value_range (op0));
1279 else if (is_gimple_min_invariant (op0))
1280 set_value_range (&vr0, VR_RANGE, op0, op0, NULL);
1281 else
1282 set_value_range_to_varying (&vr0);
1284 /* If VR0 is UNDEFINED, so is the result. */
1285 if (vr0.type == VR_UNDEFINED)
1287 set_value_range_to_undefined (vr);
1288 return;
1291 /* Refuse to operate on varying and symbolic ranges. Also, if the
1292 operand is neither a pointer nor an integral type, set the
1293 resulting range to VARYING. TODO, in some cases we may be able
1294 to derive anti-ranges (like nonzero values). */
1295 if (vr0.type == VR_VARYING
1296 || (!INTEGRAL_TYPE_P (TREE_TYPE (op0))
1297 && !POINTER_TYPE_P (TREE_TYPE (op0)))
1298 || symbolic_range_p (&vr0))
1300 set_value_range_to_varying (vr);
1301 return;
1304 /* If the expression involves pointers, we are only interested in
1305 determining if it evaluates to NULL [0, 0] or non-NULL (~[0, 0]). */
1306 if (POINTER_TYPE_P (TREE_TYPE (expr)) || POINTER_TYPE_P (TREE_TYPE (op0)))
1308 if (range_is_nonnull (&vr0) || tree_expr_nonzero_p (expr))
1309 set_value_range_to_nonnull (vr, TREE_TYPE (expr));
1310 else if (range_is_null (&vr0))
1311 set_value_range_to_null (vr, TREE_TYPE (expr));
1312 else
1313 set_value_range_to_varying (vr);
1315 return;
1318 /* Handle unary expressions on integer ranges. */
1319 if (code == NOP_EXPR || code == CONVERT_EXPR)
1321 tree inner_type = TREE_TYPE (op0);
1322 tree outer_type = TREE_TYPE (expr);
1324 /* If VR0 represents a simple range, then try to convert
1325 the min and max values for the range to the same type
1326 as OUTER_TYPE. If the results compare equal to VR0's
1327 min and max values and the new min is still less than
1328 or equal to the new max, then we can safely use the newly
1329 computed range for EXPR. This allows us to compute
1330 accurate ranges through many casts. */
1331 if (vr0.type == VR_RANGE)
1333 tree new_min, new_max;
1335 /* Convert VR0's min/max to OUTER_TYPE. */
1336 new_min = fold_convert (outer_type, vr0.min);
1337 new_max = fold_convert (outer_type, vr0.max);
1339 /* Verify the new min/max values are gimple values and
1340 that they compare equal to VR0's min/max values. */
1341 if (is_gimple_val (new_min)
1342 && is_gimple_val (new_max)
1343 && tree_int_cst_equal (new_min, vr0.min)
1344 && tree_int_cst_equal (new_max, vr0.max)
1345 && compare_values (new_min, new_max) <= 0
1346 && compare_values (new_min, new_max) >= -1)
1348 set_value_range (vr, VR_RANGE, new_min, new_max, vr->equiv);
1349 return;
1353 /* When converting types of different sizes, set the result to
1354 VARYING. Things like sign extensions and precision loss may
1355 change the range. For instance, if x_3 is of type 'long long
1356 int' and 'y_5 = (unsigned short) x_3', if x_3 is ~[0, 0], it
1357 is impossible to know at compile time whether y_5 will be
1358 ~[0, 0]. */
1359 if (TYPE_SIZE (inner_type) != TYPE_SIZE (outer_type)
1360 || TYPE_PRECISION (inner_type) != TYPE_PRECISION (outer_type))
1362 set_value_range_to_varying (vr);
1363 return;
1367 /* Apply the operation to each end of the range and see what we end
1368 up with. */
1369 if (code == NEGATE_EXPR
1370 && !TYPE_UNSIGNED (TREE_TYPE (expr)))
1372 /* NEGATE_EXPR flips the range around. */
1373 min = (vr0.max == TYPE_MAX_VALUE (TREE_TYPE (expr)) && !flag_wrapv)
1374 ? TYPE_MIN_VALUE (TREE_TYPE (expr))
1375 : fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
1377 max = (vr0.min == TYPE_MIN_VALUE (TREE_TYPE (expr)) && !flag_wrapv)
1378 ? TYPE_MAX_VALUE (TREE_TYPE (expr))
1379 : fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
1381 else if (code == ABS_EXPR
1382 && !TYPE_UNSIGNED (TREE_TYPE (expr)))
1384 /* -TYPE_MIN_VALUE = TYPE_MIN_VALUE with flag_wrapv so we can't get a
1385 useful range. */
1386 if (flag_wrapv
1387 && ((vr0.type == VR_RANGE
1388 && vr0.min == TYPE_MIN_VALUE (TREE_TYPE (expr)))
1389 || (vr0.type == VR_ANTI_RANGE
1390 && vr0.min != TYPE_MIN_VALUE (TREE_TYPE (expr))
1391 && !range_includes_zero_p (&vr0))))
1393 set_value_range_to_varying (vr);
1394 return;
1397 /* ABS_EXPR may flip the range around, if the original range
1398 included negative values. */
1399 min = (vr0.min == TYPE_MIN_VALUE (TREE_TYPE (expr)))
1400 ? TYPE_MAX_VALUE (TREE_TYPE (expr))
1401 : fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
1403 max = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
1405 cmp = compare_values (min, max);
1407 /* If a VR_ANTI_RANGEs contains zero, then we have
1408 ~[-INF, min(MIN, MAX)]. */
1409 if (vr0.type == VR_ANTI_RANGE)
1411 if (range_includes_zero_p (&vr0))
1413 tree type_min_value = TYPE_MIN_VALUE (TREE_TYPE (expr));
1415 /* Take the lower of the two values. */
1416 if (cmp != 1)
1417 max = min;
1419 /* Create ~[-INF, min (abs(MIN), abs(MAX))]
1420 or ~[-INF + 1, min (abs(MIN), abs(MAX))] when
1421 flag_wrapv is set and the original anti-range doesn't include
1422 TYPE_MIN_VALUE, remember -TYPE_MIN_VALUE = TYPE_MIN_VALUE. */
1423 min = (flag_wrapv && vr0.min != type_min_value
1424 ? int_const_binop (PLUS_EXPR,
1425 type_min_value,
1426 integer_one_node, 0)
1427 : type_min_value);
1429 else
1431 /* All else has failed, so create the range [0, INF], even for
1432 flag_wrapv since TYPE_MIN_VALUE is in the original
1433 anti-range. */
1434 vr0.type = VR_RANGE;
1435 min = build_int_cst (TREE_TYPE (expr), 0);
1436 max = TYPE_MAX_VALUE (TREE_TYPE (expr));
1440 /* If the range contains zero then we know that the minimum value in the
1441 range will be zero. */
1442 else if (range_includes_zero_p (&vr0))
1444 if (cmp == 1)
1445 max = min;
1446 min = build_int_cst (TREE_TYPE (expr), 0);
1448 else
1450 /* If the range was reversed, swap MIN and MAX. */
1451 if (cmp == 1)
1453 tree t = min;
1454 min = max;
1455 max = t;
1459 else
1461 /* Otherwise, operate on each end of the range. */
1462 min = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
1463 max = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
1466 cmp = compare_values (min, max);
1467 if (cmp == -2 || cmp == 1)
1469 /* If the new range has its limits swapped around (MIN > MAX),
1470 then the operation caused one of them to wrap around, mark
1471 the new range VARYING. */
1472 set_value_range_to_varying (vr);
1474 else
1475 set_value_range (vr, vr0.type, min, max, NULL);
1479 /* Extract range information from a comparison expression EXPR based
1480 on the range of its operand and the expression code. */
1482 static void
1483 extract_range_from_comparison (value_range_t *vr, tree expr)
1485 tree val = vrp_evaluate_conditional (expr, false);
1486 if (val)
1488 /* Since this expression was found on the RHS of an assignment,
1489 its type may be different from _Bool. Convert VAL to EXPR's
1490 type. */
1491 val = fold_convert (TREE_TYPE (expr), val);
1492 set_value_range (vr, VR_RANGE, val, val, vr->equiv);
1494 else
1495 set_value_range_to_varying (vr);
1499 /* Try to compute a useful range out of expression EXPR and store it
1500 in *VR. */
1502 static void
1503 extract_range_from_expr (value_range_t *vr, tree expr)
1505 enum tree_code code = TREE_CODE (expr);
1507 if (code == ASSERT_EXPR)
1508 extract_range_from_assert (vr, expr);
1509 else if (code == SSA_NAME)
1510 extract_range_from_ssa_name (vr, expr);
1511 else if (TREE_CODE_CLASS (code) == tcc_binary
1512 || code == TRUTH_ANDIF_EXPR
1513 || code == TRUTH_ORIF_EXPR
1514 || code == TRUTH_AND_EXPR
1515 || code == TRUTH_OR_EXPR
1516 || code == TRUTH_XOR_EXPR)
1517 extract_range_from_binary_expr (vr, expr);
1518 else if (TREE_CODE_CLASS (code) == tcc_unary)
1519 extract_range_from_unary_expr (vr, expr);
1520 else if (TREE_CODE_CLASS (code) == tcc_comparison)
1521 extract_range_from_comparison (vr, expr);
1522 else if (is_gimple_min_invariant (expr))
1523 set_value_range (vr, VR_RANGE, expr, expr, NULL);
1524 else if (vrp_expr_computes_nonzero (expr))
1525 set_value_range_to_nonnull (vr, TREE_TYPE (expr));
1526 else
1527 set_value_range_to_varying (vr);
1530 /* Given a range VR, a LOOP and a variable VAR, determine whether it
1531 would be profitable to adjust VR using scalar evolution information
1532 for VAR. If so, update VR with the new limits. */
1534 static void
1535 adjust_range_with_scev (value_range_t *vr, struct loop *loop, tree stmt,
1536 tree var)
1538 tree init, step, chrec;
1539 bool init_is_max, unknown_max;
1541 /* TODO. Don't adjust anti-ranges. An anti-range may provide
1542 better opportunities than a regular range, but I'm not sure. */
1543 if (vr->type == VR_ANTI_RANGE)
1544 return;
1546 chrec = instantiate_parameters (loop, analyze_scalar_evolution (loop, var));
1547 if (TREE_CODE (chrec) != POLYNOMIAL_CHREC)
1548 return;
1550 init = initial_condition_in_loop_num (chrec, loop->num);
1551 step = evolution_part_in_loop_num (chrec, loop->num);
1553 /* If STEP is symbolic, we can't know whether INIT will be the
1554 minimum or maximum value in the range. */
1555 if (step == NULL_TREE
1556 || !is_gimple_min_invariant (step))
1557 return;
1559 /* Do not adjust ranges when chrec may wrap. */
1560 if (scev_probably_wraps_p (chrec_type (chrec), init, step, stmt,
1561 cfg_loops->parray[CHREC_VARIABLE (chrec)],
1562 &init_is_max, &unknown_max)
1563 || unknown_max)
1564 return;
1566 if (!POINTER_TYPE_P (TREE_TYPE (init))
1567 && (vr->type == VR_VARYING || vr->type == VR_UNDEFINED))
1569 /* For VARYING or UNDEFINED ranges, just about anything we get
1570 from scalar evolutions should be better. */
1571 if (init_is_max)
1572 set_value_range (vr, VR_RANGE, TYPE_MIN_VALUE (TREE_TYPE (init)),
1573 init, vr->equiv);
1574 else
1575 set_value_range (vr, VR_RANGE, init, TYPE_MAX_VALUE (TREE_TYPE (init)),
1576 vr->equiv);
1578 else if (vr->type == VR_RANGE)
1580 tree min = vr->min;
1581 tree max = vr->max;
1583 if (init_is_max)
1585 /* INIT is the maximum value. If INIT is lower than VR->MAX
1586 but no smaller than VR->MIN, set VR->MAX to INIT. */
1587 if (compare_values (init, max) == -1)
1589 max = init;
1591 /* If we just created an invalid range with the minimum
1592 greater than the maximum, take the minimum all the
1593 way to -INF. */
1594 if (compare_values (min, max) == 1)
1595 min = TYPE_MIN_VALUE (TREE_TYPE (min));
1598 else
1600 /* If INIT is bigger than VR->MIN, set VR->MIN to INIT. */
1601 if (compare_values (init, min) == 1)
1603 min = init;
1605 /* If we just created an invalid range with the minimum
1606 greater than the maximum, take the maximum all the
1607 way to +INF. */
1608 if (compare_values (min, max) == 1)
1609 max = TYPE_MAX_VALUE (TREE_TYPE (max));
1613 set_value_range (vr, VR_RANGE, min, max, vr->equiv);
1618 /* Given two numeric value ranges VR0, VR1 and a comparison code COMP:
1620 - Return BOOLEAN_TRUE_NODE if VR0 COMP VR1 always returns true for
1621 all the values in the ranges.
1623 - Return BOOLEAN_FALSE_NODE if the comparison always returns false.
1625 - Return NULL_TREE if it is not always possible to determine the
1626 value of the comparison. */
1629 static tree
1630 compare_ranges (enum tree_code comp, value_range_t *vr0, value_range_t *vr1)
1632 /* VARYING or UNDEFINED ranges cannot be compared. */
1633 if (vr0->type == VR_VARYING
1634 || vr0->type == VR_UNDEFINED
1635 || vr1->type == VR_VARYING
1636 || vr1->type == VR_UNDEFINED)
1637 return NULL_TREE;
1639 /* Anti-ranges need to be handled separately. */
1640 if (vr0->type == VR_ANTI_RANGE || vr1->type == VR_ANTI_RANGE)
1642 /* If both are anti-ranges, then we cannot compute any
1643 comparison. */
1644 if (vr0->type == VR_ANTI_RANGE && vr1->type == VR_ANTI_RANGE)
1645 return NULL_TREE;
1647 /* These comparisons are never statically computable. */
1648 if (comp == GT_EXPR
1649 || comp == GE_EXPR
1650 || comp == LT_EXPR
1651 || comp == LE_EXPR)
1652 return NULL_TREE;
1654 /* Equality can be computed only between a range and an
1655 anti-range. ~[VAL1, VAL2] == [VAL1, VAL2] is always false. */
1656 if (vr0->type == VR_RANGE)
1658 /* To simplify processing, make VR0 the anti-range. */
1659 value_range_t *tmp = vr0;
1660 vr0 = vr1;
1661 vr1 = tmp;
1664 gcc_assert (comp == NE_EXPR || comp == EQ_EXPR);
1666 if (compare_values (vr0->min, vr1->min) == 0
1667 && compare_values (vr0->max, vr1->max) == 0)
1668 return (comp == NE_EXPR) ? boolean_true_node : boolean_false_node;
1670 return NULL_TREE;
1673 /* Simplify processing. If COMP is GT_EXPR or GE_EXPR, switch the
1674 operands around and change the comparison code. */
1675 if (comp == GT_EXPR || comp == GE_EXPR)
1677 value_range_t *tmp;
1678 comp = (comp == GT_EXPR) ? LT_EXPR : LE_EXPR;
1679 tmp = vr0;
1680 vr0 = vr1;
1681 vr1 = tmp;
1684 if (comp == EQ_EXPR)
1686 /* Equality may only be computed if both ranges represent
1687 exactly one value. */
1688 if (compare_values (vr0->min, vr0->max) == 0
1689 && compare_values (vr1->min, vr1->max) == 0)
1691 int cmp_min = compare_values (vr0->min, vr1->min);
1692 int cmp_max = compare_values (vr0->max, vr1->max);
1693 if (cmp_min == 0 && cmp_max == 0)
1694 return boolean_true_node;
1695 else if (cmp_min != -2 && cmp_max != -2)
1696 return boolean_false_node;
1699 return NULL_TREE;
1701 else if (comp == NE_EXPR)
1703 int cmp1, cmp2;
1705 /* If VR0 is completely to the left or completely to the right
1706 of VR1, they are always different. Notice that we need to
1707 make sure that both comparisons yield similar results to
1708 avoid comparing values that cannot be compared at
1709 compile-time. */
1710 cmp1 = compare_values (vr0->max, vr1->min);
1711 cmp2 = compare_values (vr0->min, vr1->max);
1712 if ((cmp1 == -1 && cmp2 == -1) || (cmp1 == 1 && cmp2 == 1))
1713 return boolean_true_node;
1715 /* If VR0 and VR1 represent a single value and are identical,
1716 return false. */
1717 else if (compare_values (vr0->min, vr0->max) == 0
1718 && compare_values (vr1->min, vr1->max) == 0
1719 && compare_values (vr0->min, vr1->min) == 0
1720 && compare_values (vr0->max, vr1->max) == 0)
1721 return boolean_false_node;
1723 /* Otherwise, they may or may not be different. */
1724 else
1725 return NULL_TREE;
1727 else if (comp == LT_EXPR || comp == LE_EXPR)
1729 int tst;
1731 /* If VR0 is to the left of VR1, return true. */
1732 tst = compare_values (vr0->max, vr1->min);
1733 if ((comp == LT_EXPR && tst == -1)
1734 || (comp == LE_EXPR && (tst == -1 || tst == 0)))
1735 return boolean_true_node;
1737 /* If VR0 is to the right of VR1, return false. */
1738 tst = compare_values (vr0->min, vr1->max);
1739 if ((comp == LT_EXPR && (tst == 0 || tst == 1))
1740 || (comp == LE_EXPR && tst == 1))
1741 return boolean_false_node;
1743 /* Otherwise, we don't know. */
1744 return NULL_TREE;
1747 gcc_unreachable ();
1751 /* Given a value range VR, a value VAL and a comparison code COMP, return
1752 BOOLEAN_TRUE_NODE if VR COMP VAL always returns true for all the
1753 values in VR. Return BOOLEAN_FALSE_NODE if the comparison
1754 always returns false. Return NULL_TREE if it is not always
1755 possible to determine the value of the comparison. */
1757 static tree
1758 compare_range_with_value (enum tree_code comp, value_range_t *vr, tree val)
1760 if (vr->type == VR_VARYING || vr->type == VR_UNDEFINED)
1761 return NULL_TREE;
1763 /* Anti-ranges need to be handled separately. */
1764 if (vr->type == VR_ANTI_RANGE)
1766 /* For anti-ranges, the only predicates that we can compute at
1767 compile time are equality and inequality. */
1768 if (comp == GT_EXPR
1769 || comp == GE_EXPR
1770 || comp == LT_EXPR
1771 || comp == LE_EXPR)
1772 return NULL_TREE;
1774 /* ~[VAL_1, VAL_2] OP VAL is known if VAL_1 <= VAL <= VAL_2. */
1775 if (value_inside_range (val, vr) == 1)
1776 return (comp == NE_EXPR) ? boolean_true_node : boolean_false_node;
1778 return NULL_TREE;
1781 if (comp == EQ_EXPR)
1783 /* EQ_EXPR may only be computed if VR represents exactly
1784 one value. */
1785 if (compare_values (vr->min, vr->max) == 0)
1787 int cmp = compare_values (vr->min, val);
1788 if (cmp == 0)
1789 return boolean_true_node;
1790 else if (cmp == -1 || cmp == 1 || cmp == 2)
1791 return boolean_false_node;
1793 else if (compare_values (val, vr->min) == -1
1794 || compare_values (vr->max, val) == -1)
1795 return boolean_false_node;
1797 return NULL_TREE;
1799 else if (comp == NE_EXPR)
1801 /* If VAL is not inside VR, then they are always different. */
1802 if (compare_values (vr->max, val) == -1
1803 || compare_values (vr->min, val) == 1)
1804 return boolean_true_node;
1806 /* If VR represents exactly one value equal to VAL, then return
1807 false. */
1808 if (compare_values (vr->min, vr->max) == 0
1809 && compare_values (vr->min, val) == 0)
1810 return boolean_false_node;
1812 /* Otherwise, they may or may not be different. */
1813 return NULL_TREE;
1815 else if (comp == LT_EXPR || comp == LE_EXPR)
1817 int tst;
1819 /* If VR is to the left of VAL, return true. */
1820 tst = compare_values (vr->max, val);
1821 if ((comp == LT_EXPR && tst == -1)
1822 || (comp == LE_EXPR && (tst == -1 || tst == 0)))
1823 return boolean_true_node;
1825 /* If VR is to the right of VAL, return false. */
1826 tst = compare_values (vr->min, val);
1827 if ((comp == LT_EXPR && (tst == 0 || tst == 1))
1828 || (comp == LE_EXPR && tst == 1))
1829 return boolean_false_node;
1831 /* Otherwise, we don't know. */
1832 return NULL_TREE;
1834 else if (comp == GT_EXPR || comp == GE_EXPR)
1836 int tst;
1838 /* If VR is to the right of VAL, return true. */
1839 tst = compare_values (vr->min, val);
1840 if ((comp == GT_EXPR && tst == 1)
1841 || (comp == GE_EXPR && (tst == 0 || tst == 1)))
1842 return boolean_true_node;
1844 /* If VR is to the left of VAL, return false. */
1845 tst = compare_values (vr->max, val);
1846 if ((comp == GT_EXPR && (tst == -1 || tst == 0))
1847 || (comp == GE_EXPR && tst == -1))
1848 return boolean_false_node;
1850 /* Otherwise, we don't know. */
1851 return NULL_TREE;
1854 gcc_unreachable ();
1858 /* Debugging dumps. */
1860 void dump_value_range (FILE *, value_range_t *);
1861 void debug_value_range (value_range_t *);
1862 void dump_all_value_ranges (FILE *);
1863 void debug_all_value_ranges (void);
1864 void dump_vr_equiv (FILE *, bitmap);
1865 void debug_vr_equiv (bitmap);
1868 /* Dump value range VR to FILE. */
1870 void
1871 dump_value_range (FILE *file, value_range_t *vr)
1873 if (vr == NULL)
1874 fprintf (file, "[]");
1875 else if (vr->type == VR_UNDEFINED)
1876 fprintf (file, "UNDEFINED");
1877 else if (vr->type == VR_RANGE || vr->type == VR_ANTI_RANGE)
1879 tree type = TREE_TYPE (vr->min);
1881 fprintf (file, "%s[", (vr->type == VR_ANTI_RANGE) ? "~" : "");
1883 if (INTEGRAL_TYPE_P (type)
1884 && !TYPE_UNSIGNED (type)
1885 && vr->min == TYPE_MIN_VALUE (type))
1886 fprintf (file, "-INF");
1887 else
1888 print_generic_expr (file, vr->min, 0);
1890 fprintf (file, ", ");
1892 if (INTEGRAL_TYPE_P (type)
1893 && vr->max == TYPE_MAX_VALUE (type))
1894 fprintf (file, "+INF");
1895 else
1896 print_generic_expr (file, vr->max, 0);
1898 fprintf (file, "]");
1900 if (vr->equiv)
1902 bitmap_iterator bi;
1903 unsigned i, c = 0;
1905 fprintf (file, " EQUIVALENCES: { ");
1907 EXECUTE_IF_SET_IN_BITMAP (vr->equiv, 0, i, bi)
1909 print_generic_expr (file, ssa_name (i), 0);
1910 fprintf (file, " ");
1911 c++;
1914 fprintf (file, "} (%u elements)", c);
1917 else if (vr->type == VR_VARYING)
1918 fprintf (file, "VARYING");
1919 else
1920 fprintf (file, "INVALID RANGE");
1924 /* Dump value range VR to stderr. */
1926 void
1927 debug_value_range (value_range_t *vr)
1929 dump_value_range (stderr, vr);
1933 /* Dump value ranges of all SSA_NAMEs to FILE. */
1935 void
1936 dump_all_value_ranges (FILE *file)
1938 size_t i;
1940 for (i = 0; i < num_ssa_names; i++)
1942 if (vr_value[i])
1944 print_generic_expr (file, ssa_name (i), 0);
1945 fprintf (file, ": ");
1946 dump_value_range (file, vr_value[i]);
1947 fprintf (file, "\n");
1951 fprintf (file, "\n");
1955 /* Dump all value ranges to stderr. */
1957 void
1958 debug_all_value_ranges (void)
1960 dump_all_value_ranges (stderr);
1964 /* Given a COND_EXPR COND of the form 'V OP W', and an SSA name V,
1965 create a new SSA name N and return the assertion assignment
1966 'V = ASSERT_EXPR <V, V OP W>'. */
1968 static tree
1969 build_assert_expr_for (tree cond, tree v)
1971 tree n, assertion;
1973 gcc_assert (TREE_CODE (v) == SSA_NAME);
1974 n = duplicate_ssa_name (v, NULL_TREE);
1976 if (COMPARISON_CLASS_P (cond))
1978 tree a = build (ASSERT_EXPR, TREE_TYPE (v), v, cond);
1979 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, a);
1981 else if (TREE_CODE (cond) == TRUTH_NOT_EXPR)
1983 /* Given !V, build the assignment N = false. */
1984 tree op0 = TREE_OPERAND (cond, 0);
1985 gcc_assert (op0 == v);
1986 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, boolean_false_node);
1988 else if (TREE_CODE (cond) == SSA_NAME)
1990 /* Given V, build the assignment N = true. */
1991 gcc_assert (v == cond);
1992 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, boolean_true_node);
1994 else
1995 gcc_unreachable ();
1997 SSA_NAME_DEF_STMT (n) = assertion;
1999 /* The new ASSERT_EXPR, creates a new SSA name that replaces the
2000 operand of the ASSERT_EXPR. Register the new name and the old one
2001 in the replacement table so that we can fix the SSA web after
2002 adding all the ASSERT_EXPRs. */
2003 register_new_name_mapping (n, v);
2005 return assertion;
2009 /* Return false if EXPR is a predicate expression involving floating
2010 point values. */
2012 static inline bool
2013 fp_predicate (tree expr)
2015 return (COMPARISON_CLASS_P (expr)
2016 && FLOAT_TYPE_P (TREE_TYPE (TREE_OPERAND (expr, 0))));
2020 /* If the range of values taken by OP can be inferred after STMT executes,
2021 return the comparison code (COMP_CODE_P) and value (VAL_P) that
2022 describes the inferred range. Return true if a range could be
2023 inferred. */
2025 static bool
2026 infer_value_range (tree stmt, tree op, enum tree_code *comp_code_p, tree *val_p)
2028 *val_p = NULL_TREE;
2029 *comp_code_p = ERROR_MARK;
2031 /* Do not attempt to infer anything in names that flow through
2032 abnormal edges. */
2033 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (op))
2034 return false;
2036 /* Similarly, don't infer anything from statements that may throw
2037 exceptions. */
2038 if (tree_could_throw_p (stmt))
2039 return false;
2041 if (POINTER_TYPE_P (TREE_TYPE (op)))
2043 bool is_store;
2044 unsigned num_uses, num_derefs;
2046 count_uses_and_derefs (op, stmt, &num_uses, &num_derefs, &is_store);
2047 if (num_derefs > 0 && flag_delete_null_pointer_checks)
2049 /* We can only assume that a pointer dereference will yield
2050 non-NULL if -fdelete-null-pointer-checks is enabled. */
2051 *val_p = build_int_cst (TREE_TYPE (op), 0);
2052 *comp_code_p = NE_EXPR;
2053 return true;
2057 return false;
2061 void dump_asserts_for (FILE *, tree);
2062 void debug_asserts_for (tree);
2063 void dump_all_asserts (FILE *);
2064 void debug_all_asserts (void);
2066 /* Dump all the registered assertions for NAME to FILE. */
2068 void
2069 dump_asserts_for (FILE *file, tree name)
2071 assert_locus_t loc;
2073 fprintf (file, "Assertions to be inserted for ");
2074 print_generic_expr (file, name, 0);
2075 fprintf (file, "\n");
2077 loc = asserts_for[SSA_NAME_VERSION (name)];
2078 while (loc)
2080 fprintf (file, "\t");
2081 print_generic_expr (file, bsi_stmt (loc->si), 0);
2082 fprintf (file, "\n\tBB #%d", loc->bb->index);
2083 if (loc->e)
2085 fprintf (file, "\n\tEDGE %d->%d", loc->e->src->index,
2086 loc->e->dest->index);
2087 dump_edge_info (file, loc->e, 0);
2089 fprintf (file, "\n\tPREDICATE: ");
2090 print_generic_expr (file, name, 0);
2091 fprintf (file, " %s ", tree_code_name[(int)loc->comp_code]);
2092 print_generic_expr (file, loc->val, 0);
2093 fprintf (file, "\n\n");
2094 loc = loc->next;
2097 fprintf (file, "\n");
2101 /* Dump all the registered assertions for NAME to stderr. */
2103 void
2104 debug_asserts_for (tree name)
2106 dump_asserts_for (stderr, name);
2110 /* Dump all the registered assertions for all the names to FILE. */
2112 void
2113 dump_all_asserts (FILE *file)
2115 unsigned i;
2116 bitmap_iterator bi;
2118 fprintf (file, "\nASSERT_EXPRs to be inserted\n\n");
2119 EXECUTE_IF_SET_IN_BITMAP (need_assert_for, 0, i, bi)
2120 dump_asserts_for (file, ssa_name (i));
2121 fprintf (file, "\n");
2125 /* Dump all the registered assertions for all the names to stderr. */
2127 void
2128 debug_all_asserts (void)
2130 dump_all_asserts (stderr);
2134 /* If NAME doesn't have an ASSERT_EXPR registered for asserting
2135 'NAME COMP_CODE VAL' at a location that dominates block BB or
2136 E->DEST, then register this location as a possible insertion point
2137 for ASSERT_EXPR <NAME, NAME COMP_CODE VAL>.
2139 BB, E and SI provide the exact insertion point for the new
2140 ASSERT_EXPR. If BB is NULL, then the ASSERT_EXPR is to be inserted
2141 on edge E. Otherwise, if E is NULL, the ASSERT_EXPR is inserted on
2142 BB. If SI points to a COND_EXPR or a SWITCH_EXPR statement, then E
2143 must not be NULL. */
2145 static void
2146 register_new_assert_for (tree name,
2147 enum tree_code comp_code,
2148 tree val,
2149 basic_block bb,
2150 edge e,
2151 block_stmt_iterator si)
2153 assert_locus_t n, loc, last_loc;
2154 bool found;
2155 basic_block dest_bb;
2157 #if defined ENABLE_CHECKING
2158 gcc_assert (bb == NULL || e == NULL);
2160 if (e == NULL)
2161 gcc_assert (TREE_CODE (bsi_stmt (si)) != COND_EXPR
2162 && TREE_CODE (bsi_stmt (si)) != SWITCH_EXPR);
2163 #endif
2165 /* The new assertion A will be inserted at BB or E. We need to
2166 determine if the new location is dominated by a previously
2167 registered location for A. If we are doing an edge insertion,
2168 assume that A will be inserted at E->DEST. Note that this is not
2169 necessarily true.
2171 If E is a critical edge, it will be split. But even if E is
2172 split, the new block will dominate the same set of blocks that
2173 E->DEST dominates.
2175 The reverse, however, is not true, blocks dominated by E->DEST
2176 will not be dominated by the new block created to split E. So,
2177 if the insertion location is on a critical edge, we will not use
2178 the new location to move another assertion previously registered
2179 at a block dominated by E->DEST. */
2180 dest_bb = (bb) ? bb : e->dest;
2182 /* If NAME already has an ASSERT_EXPR registered for COMP_CODE and
2183 VAL at a block dominating DEST_BB, then we don't need to insert a new
2184 one. Similarly, if the same assertion already exists at a block
2185 dominated by DEST_BB and the new location is not on a critical
2186 edge, then update the existing location for the assertion (i.e.,
2187 move the assertion up in the dominance tree).
2189 Note, this is implemented as a simple linked list because there
2190 should not be more than a handful of assertions registered per
2191 name. If this becomes a performance problem, a table hashed by
2192 COMP_CODE and VAL could be implemented. */
2193 loc = asserts_for[SSA_NAME_VERSION (name)];
2194 last_loc = loc;
2195 found = false;
2196 while (loc)
2198 if (loc->comp_code == comp_code
2199 && (loc->val == val
2200 || operand_equal_p (loc->val, val, 0)))
2202 /* If the assertion NAME COMP_CODE VAL has already been
2203 registered at a basic block that dominates DEST_BB, then
2204 we don't need to insert the same assertion again. Note
2205 that we don't check strict dominance here to avoid
2206 replicating the same assertion inside the same basic
2207 block more than once (e.g., when a pointer is
2208 dereferenced several times inside a block).
2210 An exception to this rule are edge insertions. If the
2211 new assertion is to be inserted on edge E, then it will
2212 dominate all the other insertions that we may want to
2213 insert in DEST_BB. So, if we are doing an edge
2214 insertion, don't do this dominance check. */
2215 if (e == NULL
2216 && dominated_by_p (CDI_DOMINATORS, dest_bb, loc->bb))
2217 return;
2219 /* Otherwise, if E is not a critical edge and DEST_BB
2220 dominates the existing location for the assertion, move
2221 the assertion up in the dominance tree by updating its
2222 location information. */
2223 if ((e == NULL || !EDGE_CRITICAL_P (e))
2224 && dominated_by_p (CDI_DOMINATORS, loc->bb, dest_bb))
2226 loc->bb = dest_bb;
2227 loc->e = e;
2228 loc->si = si;
2229 return;
2233 /* Update the last node of the list and move to the next one. */
2234 last_loc = loc;
2235 loc = loc->next;
2238 /* If we didn't find an assertion already registered for
2239 NAME COMP_CODE VAL, add a new one at the end of the list of
2240 assertions associated with NAME. */
2241 n = xmalloc (sizeof (*n));
2242 n->bb = dest_bb;
2243 n->e = e;
2244 n->si = si;
2245 n->comp_code = comp_code;
2246 n->val = val;
2247 n->next = NULL;
2249 if (last_loc)
2250 last_loc->next = n;
2251 else
2252 asserts_for[SSA_NAME_VERSION (name)] = n;
2254 bitmap_set_bit (need_assert_for, SSA_NAME_VERSION (name));
2258 /* Try to register an edge assertion for SSA name NAME on edge E for
2259 the conditional jump pointed to by SI. Return true if an assertion
2260 for NAME could be registered. */
2262 static bool
2263 register_edge_assert_for (tree name, edge e, block_stmt_iterator si)
2265 tree val, stmt;
2266 enum tree_code comp_code;
2268 stmt = bsi_stmt (si);
2270 /* Do not attempt to infer anything in names that flow through
2271 abnormal edges. */
2272 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (name))
2273 return false;
2275 /* If NAME was not found in the sub-graph reachable from E, then
2276 there's nothing to do. */
2277 if (!TEST_BIT (found_in_subgraph, SSA_NAME_VERSION (name)))
2278 return false;
2280 /* We found a use of NAME in the sub-graph rooted at E->DEST.
2281 Register an assertion for NAME according to the value that NAME
2282 takes on edge E. */
2283 if (TREE_CODE (stmt) == COND_EXPR)
2285 /* If BB ends in a COND_EXPR then NAME then we should insert
2286 the original predicate on EDGE_TRUE_VALUE and the
2287 opposite predicate on EDGE_FALSE_VALUE. */
2288 tree cond = COND_EXPR_COND (stmt);
2289 bool is_else_edge = (e->flags & EDGE_FALSE_VALUE) != 0;
2291 /* Predicates may be a single SSA name or NAME OP VAL. */
2292 if (cond == name)
2294 /* If the predicate is a name, it must be NAME, in which
2295 case we create the predicate NAME == true or
2296 NAME == false accordingly. */
2297 comp_code = EQ_EXPR;
2298 val = (is_else_edge) ? boolean_false_node : boolean_true_node;
2300 else
2302 /* Otherwise, we have a comparison of the form NAME COMP VAL
2303 or VAL COMP NAME. */
2304 if (name == TREE_OPERAND (cond, 1))
2306 /* If the predicate is of the form VAL COMP NAME, flip
2307 COMP around because we need to register NAME as the
2308 first operand in the predicate. */
2309 comp_code = swap_tree_comparison (TREE_CODE (cond));
2310 val = TREE_OPERAND (cond, 0);
2312 else
2314 /* The comparison is of the form NAME COMP VAL, so the
2315 comparison code remains unchanged. */
2316 comp_code = TREE_CODE (cond);
2317 val = TREE_OPERAND (cond, 1);
2320 /* If we are inserting the assertion on the ELSE edge, we
2321 need to invert the sign comparison. */
2322 if (is_else_edge)
2323 comp_code = invert_tree_comparison (comp_code, 0);
2326 else
2328 /* FIXME. Handle SWITCH_EXPR. */
2329 gcc_unreachable ();
2332 register_new_assert_for (name, comp_code, val, NULL, e, si);
2333 return true;
2337 static bool find_assert_locations (basic_block bb);
2339 /* Determine whether the outgoing edges of BB should receive an
2340 ASSERT_EXPR for each of the operands of BB's last statement. The
2341 last statement of BB must be a COND_EXPR or a SWITCH_EXPR.
2343 If any of the sub-graphs rooted at BB have an interesting use of
2344 the predicate operands, an assert location node is added to the
2345 list of assertions for the corresponding operands. */
2347 static bool
2348 find_conditional_asserts (basic_block bb)
2350 bool need_assert;
2351 block_stmt_iterator last_si;
2352 tree op, last;
2353 edge_iterator ei;
2354 edge e;
2355 ssa_op_iter iter;
2357 need_assert = false;
2358 last_si = bsi_last (bb);
2359 last = bsi_stmt (last_si);
2361 /* Look for uses of the operands in each of the sub-graphs
2362 rooted at BB. We need to check each of the outgoing edges
2363 separately, so that we know what kind of ASSERT_EXPR to
2364 insert. */
2365 FOR_EACH_EDGE (e, ei, bb->succs)
2367 if (e->dest == bb)
2368 continue;
2370 /* Remove the COND_EXPR operands from the FOUND_IN_SUBGRAPH bitmap.
2371 Otherwise, when we finish traversing each of the sub-graphs, we
2372 won't know whether the variables were found in the sub-graphs or
2373 if they had been found in a block upstream from BB. */
2374 FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
2375 RESET_BIT (found_in_subgraph, SSA_NAME_VERSION (op));
2377 /* Traverse the strictly dominated sub-graph rooted at E->DEST
2378 to determine if any of the operands in the conditional
2379 predicate are used. */
2380 if (e->dest != bb)
2381 need_assert |= find_assert_locations (e->dest);
2383 /* Register the necessary assertions for each operand in the
2384 conditional predicate. */
2385 FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
2386 need_assert |= register_edge_assert_for (op, e, last_si);
2389 /* Finally, indicate that we have found the operands in the
2390 conditional. */
2391 FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
2392 SET_BIT (found_in_subgraph, SSA_NAME_VERSION (op));
2394 return need_assert;
2398 /* Traverse all the statements in block BB looking for statements that
2399 may generate useful assertions for the SSA names in their operand.
2400 If a statement produces a useful assertion A for name N_i, then the
2401 list of assertions already generated for N_i is scanned to
2402 determine if A is actually needed.
2404 If N_i already had the assertion A at a location dominating the
2405 current location, then nothing needs to be done. Otherwise, the
2406 new location for A is recorded instead.
2408 1- For every statement S in BB, all the variables used by S are
2409 added to bitmap FOUND_IN_SUBGRAPH.
2411 2- If statement S uses an operand N in a way that exposes a known
2412 value range for N, then if N was not already generated by an
2413 ASSERT_EXPR, create a new assert location for N. For instance,
2414 if N is a pointer and the statement dereferences it, we can
2415 assume that N is not NULL.
2417 3- COND_EXPRs are a special case of #2. We can derive range
2418 information from the predicate but need to insert different
2419 ASSERT_EXPRs for each of the sub-graphs rooted at the
2420 conditional block. If the last statement of BB is a conditional
2421 expression of the form 'X op Y', then
2423 a) Remove X and Y from the set FOUND_IN_SUBGRAPH.
2425 b) If the conditional is the only entry point to the sub-graph
2426 corresponding to the THEN_CLAUSE, recurse into it. On
2427 return, if X and/or Y are marked in FOUND_IN_SUBGRAPH, then
2428 an ASSERT_EXPR is added for the corresponding variable.
2430 c) Repeat step (b) on the ELSE_CLAUSE.
2432 d) Mark X and Y in FOUND_IN_SUBGRAPH.
2434 For instance,
2436 if (a == 9)
2437 b = a;
2438 else
2439 b = c + 1;
2441 In this case, an assertion on the THEN clause is useful to
2442 determine that 'a' is always 9 on that edge. However, an assertion
2443 on the ELSE clause would be unnecessary.
2445 4- If BB does not end in a conditional expression, then we recurse
2446 into BB's dominator children.
2448 At the end of the recursive traversal, every SSA name will have a
2449 list of locations where ASSERT_EXPRs should be added. When a new
2450 location for name N is found, it is registered by calling
2451 register_new_assert_for. That function keeps track of all the
2452 registered assertions to prevent adding unnecessary assertions.
2453 For instance, if a pointer P_4 is dereferenced more than once in a
2454 dominator tree, only the location dominating all the dereference of
2455 P_4 will receive an ASSERT_EXPR.
2457 If this function returns true, then it means that there are names
2458 for which we need to generate ASSERT_EXPRs. Those assertions are
2459 inserted by process_assert_insertions.
2461 TODO. Handle SWITCH_EXPR. */
2463 static bool
2464 find_assert_locations (basic_block bb)
2466 block_stmt_iterator si;
2467 tree last, phi;
2468 bool need_assert;
2469 basic_block son;
2471 if (TEST_BIT (blocks_visited, bb->index))
2472 return false;
2474 SET_BIT (blocks_visited, bb->index);
2476 need_assert = false;
2478 /* Traverse all PHI nodes in BB marking used operands. */
2479 for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2481 use_operand_p arg_p;
2482 ssa_op_iter i;
2484 FOR_EACH_PHI_ARG (arg_p, phi, i, SSA_OP_USE)
2486 tree arg = USE_FROM_PTR (arg_p);
2487 if (TREE_CODE (arg) == SSA_NAME)
2489 gcc_assert (is_gimple_reg (PHI_RESULT (phi)));
2490 SET_BIT (found_in_subgraph, SSA_NAME_VERSION (arg));
2495 /* Traverse all the statements in BB marking used names and looking
2496 for statements that may infer assertions for their used operands. */
2497 last = NULL_TREE;
2498 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2500 tree stmt, op;
2501 ssa_op_iter i;
2503 stmt = bsi_stmt (si);
2505 /* See if we can derive an assertion for any of STMT's operands. */
2506 FOR_EACH_SSA_TREE_OPERAND (op, stmt, i, SSA_OP_USE)
2508 tree value;
2509 enum tree_code comp_code;
2511 /* Mark OP in bitmap FOUND_IN_SUBGRAPH. If STMT is inside
2512 the sub-graph of a conditional block, when we return from
2513 this recursive walk, our parent will use the
2514 FOUND_IN_SUBGRAPH bitset to determine if one of the
2515 operands it was looking for was present in the sub-graph. */
2516 SET_BIT (found_in_subgraph, SSA_NAME_VERSION (op));
2518 /* If OP is used only once, namely in this STMT, don't
2519 bother creating an ASSERT_EXPR for it. Such an
2520 ASSERT_EXPR would do nothing but increase compile time.
2521 Experiments show that with this simple check, we can save
2522 more than 20% of ASSERT_EXPRs. */
2523 if (has_single_use (op))
2524 continue;
2526 /* If OP is used in such a way that we can infer a value
2527 range for it, and we don't find a previous assertion for
2528 it, create a new assertion location node for OP. */
2529 if (infer_value_range (stmt, op, &comp_code, &value))
2531 register_new_assert_for (op, comp_code, value, bb, NULL, si);
2532 need_assert = true;
2536 /* Remember the last statement of the block. */
2537 last = stmt;
2540 /* If BB's last statement is a conditional expression
2541 involving integer operands, recurse into each of the sub-graphs
2542 rooted at BB to determine if we need to add ASSERT_EXPRs. */
2543 if (last
2544 && TREE_CODE (last) == COND_EXPR
2545 && !fp_predicate (COND_EXPR_COND (last))
2546 && !ZERO_SSA_OPERANDS (last, SSA_OP_USE))
2547 need_assert |= find_conditional_asserts (bb);
2549 /* Recurse into the dominator children of BB. */
2550 for (son = first_dom_son (CDI_DOMINATORS, bb);
2551 son;
2552 son = next_dom_son (CDI_DOMINATORS, son))
2553 need_assert |= find_assert_locations (son);
2555 return need_assert;
2559 /* Create an ASSERT_EXPR for NAME and insert it in the location
2560 indicated by LOC. Return true if we made any edge insertions. */
2562 static bool
2563 process_assert_insertions_for (tree name, assert_locus_t loc)
2565 /* Build the comparison expression NAME_i COMP_CODE VAL. */
2566 tree stmt, cond, assert_expr;
2567 edge_iterator ei;
2568 edge e;
2570 cond = build (loc->comp_code, boolean_type_node, name, loc->val);
2571 assert_expr = build_assert_expr_for (cond, name);
2573 if (loc->e)
2575 /* We have been asked to insert the assertion on an edge. This
2576 is used only by COND_EXPR and SWITCH_EXPR assertions. */
2577 #if defined ENABLE_CHECKING
2578 gcc_assert (TREE_CODE (bsi_stmt (loc->si)) == COND_EXPR
2579 || TREE_CODE (bsi_stmt (loc->si)) == SWITCH_EXPR);
2580 #endif
2582 bsi_insert_on_edge (loc->e, assert_expr);
2583 return true;
2586 /* Otherwise, we can insert right after LOC->SI iff the
2587 statement must not be the last statement in the block. */
2588 stmt = bsi_stmt (loc->si);
2589 if (!stmt_ends_bb_p (stmt))
2591 bsi_insert_after (&loc->si, assert_expr, BSI_SAME_STMT);
2592 return false;
2595 /* If STMT must be the last statement in BB, we can only insert new
2596 assertions on the non-abnormal edge out of BB. Note that since
2597 STMT is not control flow, there may only be one non-abnormal edge
2598 out of BB. */
2599 FOR_EACH_EDGE (e, ei, loc->bb->succs)
2600 if (!(e->flags & EDGE_ABNORMAL))
2602 bsi_insert_on_edge (e, assert_expr);
2603 return true;
2606 gcc_unreachable ();
2610 /* Process all the insertions registered for every name N_i registered
2611 in NEED_ASSERT_FOR. The list of assertions to be inserted are
2612 found in ASSERTS_FOR[i]. */
2614 static void
2615 process_assert_insertions (void)
2617 unsigned i;
2618 bitmap_iterator bi;
2619 bool update_edges_p = false;
2620 int num_asserts = 0;
2622 if (dump_file && (dump_flags & TDF_DETAILS))
2623 dump_all_asserts (dump_file);
2625 EXECUTE_IF_SET_IN_BITMAP (need_assert_for, 0, i, bi)
2627 assert_locus_t loc = asserts_for[i];
2628 gcc_assert (loc);
2630 while (loc)
2632 assert_locus_t next = loc->next;
2633 update_edges_p |= process_assert_insertions_for (ssa_name (i), loc);
2634 free (loc);
2635 loc = next;
2636 num_asserts++;
2640 if (update_edges_p)
2641 bsi_commit_edge_inserts ();
2643 if (dump_file && (dump_flags & TDF_STATS))
2644 fprintf (dump_file, "\nNumber of ASSERT_EXPR expressions inserted: %d\n\n",
2645 num_asserts);
2649 /* Traverse the flowgraph looking for conditional jumps to insert range
2650 expressions. These range expressions are meant to provide information
2651 to optimizations that need to reason in terms of value ranges. They
2652 will not be expanded into RTL. For instance, given:
2654 x = ...
2655 y = ...
2656 if (x < y)
2657 y = x - 2;
2658 else
2659 x = y + 3;
2661 this pass will transform the code into:
2663 x = ...
2664 y = ...
2665 if (x < y)
2667 x = ASSERT_EXPR <x, x < y>
2668 y = x - 2
2670 else
2672 y = ASSERT_EXPR <y, x <= y>
2673 x = y + 3
2676 The idea is that once copy and constant propagation have run, other
2677 optimizations will be able to determine what ranges of values can 'x'
2678 take in different paths of the code, simply by checking the reaching
2679 definition of 'x'. */
2681 static void
2682 insert_range_assertions (void)
2684 edge e;
2685 edge_iterator ei;
2686 bool update_ssa_p;
2688 found_in_subgraph = sbitmap_alloc (num_ssa_names);
2689 sbitmap_zero (found_in_subgraph);
2691 blocks_visited = sbitmap_alloc (last_basic_block);
2692 sbitmap_zero (blocks_visited);
2694 need_assert_for = BITMAP_ALLOC (NULL);
2695 asserts_for = xmalloc (num_ssa_names * sizeof (assert_locus_t));
2696 memset (asserts_for, 0, num_ssa_names * sizeof (assert_locus_t));
2698 calculate_dominance_info (CDI_DOMINATORS);
2700 update_ssa_p = false;
2701 FOR_EACH_EDGE (e, ei, ENTRY_BLOCK_PTR->succs)
2702 if (find_assert_locations (e->dest))
2703 update_ssa_p = true;
2705 if (update_ssa_p)
2707 process_assert_insertions ();
2708 update_ssa (TODO_update_ssa_no_phi);
2711 if (dump_file && (dump_flags & TDF_DETAILS))
2713 fprintf (dump_file, "\nSSA form after inserting ASSERT_EXPRs\n");
2714 dump_function_to_file (current_function_decl, dump_file, dump_flags);
2717 sbitmap_free (found_in_subgraph);
2718 free (asserts_for);
2719 BITMAP_FREE (need_assert_for);
2723 /* Convert range assertion expressions into the implied copies and
2724 copy propagate away the copies. Doing the trivial copy propagation
2725 here avoids the need to run the full copy propagation pass after
2726 VRP.
2728 FIXME, this will eventually lead to copy propagation removing the
2729 names that had useful range information attached to them. For
2730 instance, if we had the assertion N_i = ASSERT_EXPR <N_j, N_j > 3>,
2731 then N_i will have the range [3, +INF].
2733 However, by converting the assertion into the implied copy
2734 operation N_i = N_j, we will then copy-propagate N_j into the uses
2735 of N_i and lose the range information. We may want to hold on to
2736 ASSERT_EXPRs a little while longer as the ranges could be used in
2737 things like jump threading.
2739 The problem with keeping ASSERT_EXPRs around is that passes after
2740 VRP need to handle them appropriately.
2742 Another approach would be to make the range information a first
2743 class property of the SSA_NAME so that it can be queried from
2744 any pass. This is made somewhat more complex by the need for
2745 multiple ranges to be associated with one SSA_NAME. */
2747 static void
2748 remove_range_assertions (void)
2750 basic_block bb;
2751 block_stmt_iterator si;
2753 /* Note that the BSI iterator bump happens at the bottom of the
2754 loop and no bump is necessary if we're removing the statement
2755 referenced by the current BSI. */
2756 FOR_EACH_BB (bb)
2757 for (si = bsi_start (bb); !bsi_end_p (si);)
2759 tree stmt = bsi_stmt (si);
2761 if (TREE_CODE (stmt) == MODIFY_EXPR
2762 && TREE_CODE (TREE_OPERAND (stmt, 1)) == ASSERT_EXPR)
2764 tree rhs = TREE_OPERAND (stmt, 1);
2765 tree cond = fold (ASSERT_EXPR_COND (rhs));
2766 use_operand_p use_p;
2767 imm_use_iterator iter;
2769 gcc_assert (cond != boolean_false_node);
2770 TREE_OPERAND (stmt, 1) = ASSERT_EXPR_VAR (rhs);
2771 update_stmt (stmt);
2773 /* The statement is now a copy. Propagate the RHS into
2774 every use of the LHS. */
2775 FOR_EACH_IMM_USE_SAFE (use_p, iter, TREE_OPERAND (stmt, 0))
2777 SET_USE (use_p, ASSERT_EXPR_VAR (rhs));
2778 update_stmt (USE_STMT (use_p));
2781 /* And finally, remove the copy, it is not needed. */
2782 bsi_remove (&si);
2784 else
2785 bsi_next (&si);
2788 sbitmap_free (blocks_visited);
2792 /* Return true if STMT is interesting for VRP. */
2794 static bool
2795 stmt_interesting_for_vrp (tree stmt)
2797 if (TREE_CODE (stmt) == PHI_NODE
2798 && is_gimple_reg (PHI_RESULT (stmt))
2799 && (INTEGRAL_TYPE_P (TREE_TYPE (PHI_RESULT (stmt)))
2800 || POINTER_TYPE_P (TREE_TYPE (PHI_RESULT (stmt)))))
2801 return true;
2802 else if (TREE_CODE (stmt) == MODIFY_EXPR)
2804 tree lhs = TREE_OPERAND (stmt, 0);
2806 if (TREE_CODE (lhs) == SSA_NAME
2807 && (INTEGRAL_TYPE_P (TREE_TYPE (lhs))
2808 || POINTER_TYPE_P (TREE_TYPE (lhs)))
2809 && ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS))
2810 return true;
2812 else if (TREE_CODE (stmt) == COND_EXPR || TREE_CODE (stmt) == SWITCH_EXPR)
2813 return true;
2815 return false;
2819 /* Initialize local data structures for VRP. */
2821 static void
2822 vrp_initialize (void)
2824 basic_block bb;
2826 vr_value = xmalloc (num_ssa_names * sizeof (value_range_t *));
2827 memset (vr_value, 0, num_ssa_names * sizeof (value_range_t *));
2829 FOR_EACH_BB (bb)
2831 block_stmt_iterator si;
2832 tree phi;
2834 for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2836 if (!stmt_interesting_for_vrp (phi))
2838 tree lhs = PHI_RESULT (phi);
2839 set_value_range_to_varying (get_value_range (lhs));
2840 DONT_SIMULATE_AGAIN (phi) = true;
2842 else
2843 DONT_SIMULATE_AGAIN (phi) = false;
2846 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2848 tree stmt = bsi_stmt (si);
2850 if (!stmt_interesting_for_vrp (stmt))
2852 ssa_op_iter i;
2853 tree def;
2854 FOR_EACH_SSA_TREE_OPERAND (def, stmt, i, SSA_OP_DEF)
2855 set_value_range_to_varying (get_value_range (def));
2856 DONT_SIMULATE_AGAIN (stmt) = true;
2858 else
2860 DONT_SIMULATE_AGAIN (stmt) = false;
2867 /* Visit assignment STMT. If it produces an interesting range, record
2868 the SSA name in *OUTPUT_P. */
2870 static enum ssa_prop_result
2871 vrp_visit_assignment (tree stmt, tree *output_p)
2873 tree lhs, rhs, def;
2874 ssa_op_iter iter;
2876 lhs = TREE_OPERAND (stmt, 0);
2877 rhs = TREE_OPERAND (stmt, 1);
2879 /* We only keep track of ranges in integral and pointer types. */
2880 if (TREE_CODE (lhs) == SSA_NAME
2881 && (INTEGRAL_TYPE_P (TREE_TYPE (lhs))
2882 || POINTER_TYPE_P (TREE_TYPE (lhs))))
2884 struct loop *l;
2885 value_range_t new_vr = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
2887 extract_range_from_expr (&new_vr, rhs);
2889 /* If STMT is inside a loop, we may be able to know something
2890 else about the range of LHS by examining scalar evolution
2891 information. */
2892 if (cfg_loops && (l = loop_containing_stmt (stmt)))
2893 adjust_range_with_scev (&new_vr, l, stmt, lhs);
2895 if (update_value_range (lhs, &new_vr))
2897 *output_p = lhs;
2899 if (dump_file && (dump_flags & TDF_DETAILS))
2901 fprintf (dump_file, "Found new range for ");
2902 print_generic_expr (dump_file, lhs, 0);
2903 fprintf (dump_file, ": ");
2904 dump_value_range (dump_file, &new_vr);
2905 fprintf (dump_file, "\n\n");
2908 if (new_vr.type == VR_VARYING)
2909 return SSA_PROP_VARYING;
2911 return SSA_PROP_INTERESTING;
2914 return SSA_PROP_NOT_INTERESTING;
2917 /* Every other statement produces no useful ranges. */
2918 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
2919 set_value_range_to_varying (get_value_range (def));
2921 return SSA_PROP_VARYING;
2925 /* Compare all the value ranges for names equivalent to VAR with VAL
2926 using comparison code COMP. Return the same value returned by
2927 compare_range_with_value. */
2929 static tree
2930 compare_name_with_value (enum tree_code comp, tree var, tree val)
2932 bitmap_iterator bi;
2933 unsigned i;
2934 bitmap e;
2935 tree retval, t;
2937 t = retval = NULL_TREE;
2939 /* Get the set of equivalences for VAR. */
2940 e = get_value_range (var)->equiv;
2942 /* Add VAR to its own set of equivalences so that VAR's value range
2943 is processed by this loop (otherwise, we would have to replicate
2944 the body of the loop just to check VAR's value range). */
2945 bitmap_set_bit (e, SSA_NAME_VERSION (var));
2947 EXECUTE_IF_SET_IN_BITMAP (e, 0, i, bi)
2949 value_range_t equiv_vr = *(vr_value[i]);
2951 /* If name N_i does not have a valid range, use N_i as its own
2952 range. This allows us to compare against names that may
2953 have N_i in their ranges. */
2954 if (equiv_vr.type == VR_VARYING || equiv_vr.type == VR_UNDEFINED)
2956 equiv_vr.type = VR_RANGE;
2957 equiv_vr.min = ssa_name (i);
2958 equiv_vr.max = ssa_name (i);
2961 t = compare_range_with_value (comp, &equiv_vr, val);
2962 if (t)
2964 /* All the ranges should compare the same against VAL. */
2965 gcc_assert (retval == NULL || t == retval);
2966 retval = t;
2970 /* Remove VAR from its own equivalence set. */
2971 bitmap_clear_bit (e, SSA_NAME_VERSION (var));
2973 if (retval)
2974 return retval;
2976 /* We couldn't find a non-NULL value for the predicate. */
2977 return NULL_TREE;
2981 /* Given a comparison code COMP and names N1 and N2, compare all the
2982 ranges equivalent to N1 against all the ranges equivalent to N2
2983 to determine the value of N1 COMP N2. Return the same value
2984 returned by compare_ranges. */
2986 static tree
2987 compare_names (enum tree_code comp, tree n1, tree n2)
2989 tree t, retval;
2990 bitmap e1, e2;
2991 bitmap_iterator bi1, bi2;
2992 unsigned i1, i2;
2994 /* Compare the ranges of every name equivalent to N1 against the
2995 ranges of every name equivalent to N2. */
2996 e1 = get_value_range (n1)->equiv;
2997 e2 = get_value_range (n2)->equiv;
2999 /* Add N1 and N2 to their own set of equivalences to avoid
3000 duplicating the body of the loop just to check N1 and N2
3001 ranges. */
3002 bitmap_set_bit (e1, SSA_NAME_VERSION (n1));
3003 bitmap_set_bit (e2, SSA_NAME_VERSION (n2));
3005 /* If the equivalence sets have a common intersection, then the two
3006 names can be compared without checking their ranges. */
3007 if (bitmap_intersect_p (e1, e2))
3009 bitmap_clear_bit (e1, SSA_NAME_VERSION (n1));
3010 bitmap_clear_bit (e2, SSA_NAME_VERSION (n2));
3012 return (comp == EQ_EXPR || comp == GE_EXPR || comp == LE_EXPR)
3013 ? boolean_true_node
3014 : boolean_false_node;
3017 /* Otherwise, compare all the equivalent ranges. First, add N1 and
3018 N2 to their own set of equivalences to avoid duplicating the body
3019 of the loop just to check N1 and N2 ranges. */
3020 EXECUTE_IF_SET_IN_BITMAP (e1, 0, i1, bi1)
3022 value_range_t vr1 = *(vr_value[i1]);
3024 /* If the range is VARYING or UNDEFINED, use the name itself. */
3025 if (vr1.type == VR_VARYING || vr1.type == VR_UNDEFINED)
3027 vr1.type = VR_RANGE;
3028 vr1.min = ssa_name (i1);
3029 vr1.max = ssa_name (i1);
3032 t = retval = NULL_TREE;
3033 EXECUTE_IF_SET_IN_BITMAP (e2, 0, i2, bi2)
3035 value_range_t vr2 = *(vr_value[i2]);
3037 if (vr2.type == VR_VARYING || vr2.type == VR_UNDEFINED)
3039 vr2.type = VR_RANGE;
3040 vr2.min = ssa_name (i2);
3041 vr2.max = ssa_name (i2);
3044 t = compare_ranges (comp, &vr1, &vr2);
3045 if (t)
3047 /* All the ranges in the equivalent sets should compare
3048 the same. */
3049 gcc_assert (retval == NULL || t == retval);
3050 retval = t;
3054 if (retval)
3056 bitmap_clear_bit (e1, SSA_NAME_VERSION (n1));
3057 bitmap_clear_bit (e2, SSA_NAME_VERSION (n2));
3058 return retval;
3062 /* None of the equivalent ranges are useful in computing this
3063 comparison. */
3064 bitmap_clear_bit (e1, SSA_NAME_VERSION (n1));
3065 bitmap_clear_bit (e2, SSA_NAME_VERSION (n2));
3066 return NULL_TREE;
3070 /* Given a conditional predicate COND, try to determine if COND yields
3071 true or false based on the value ranges of its operands. Return
3072 BOOLEAN_TRUE_NODE if the conditional always evaluates to true,
3073 BOOLEAN_FALSE_NODE if the conditional always evaluates to false, and,
3074 NULL if the conditional cannot be evaluated at compile time.
3076 If USE_EQUIV_P is true, the ranges of all the names equivalent with
3077 the operands in COND are used when trying to compute its value.
3078 This is only used during final substitution. During propagation,
3079 we only check the range of each variable and not its equivalents. */
3081 tree
3082 vrp_evaluate_conditional (tree cond, bool use_equiv_p)
3084 gcc_assert (TREE_CODE (cond) == SSA_NAME
3085 || TREE_CODE_CLASS (TREE_CODE (cond)) == tcc_comparison);
3087 if (TREE_CODE (cond) == SSA_NAME)
3089 value_range_t *vr;
3090 tree retval;
3092 if (use_equiv_p)
3093 retval = compare_name_with_value (NE_EXPR, cond, boolean_false_node);
3094 else
3096 value_range_t *vr = get_value_range (cond);
3097 retval = compare_range_with_value (NE_EXPR, vr, boolean_false_node);
3100 /* If COND has a known boolean range, return it. */
3101 if (retval)
3102 return retval;
3104 /* Otherwise, if COND has a symbolic range of exactly one value,
3105 return it. */
3106 vr = get_value_range (cond);
3107 if (vr->type == VR_RANGE && vr->min == vr->max)
3108 return vr->min;
3110 else
3112 tree op0 = TREE_OPERAND (cond, 0);
3113 tree op1 = TREE_OPERAND (cond, 1);
3115 /* We only deal with integral and pointer types. */
3116 if (!INTEGRAL_TYPE_P (TREE_TYPE (op0))
3117 && !POINTER_TYPE_P (TREE_TYPE (op0)))
3118 return NULL_TREE;
3120 if (use_equiv_p)
3122 if (TREE_CODE (op0) == SSA_NAME && TREE_CODE (op1) == SSA_NAME)
3123 return compare_names (TREE_CODE (cond), op0, op1);
3124 else if (TREE_CODE (op0) == SSA_NAME)
3125 return compare_name_with_value (TREE_CODE (cond), op0, op1);
3126 else if (TREE_CODE (op1) == SSA_NAME)
3127 return compare_name_with_value (
3128 swap_tree_comparison (TREE_CODE (cond)), op1, op0);
3130 else
3132 value_range_t *vr0, *vr1;
3134 vr0 = (TREE_CODE (op0) == SSA_NAME) ? get_value_range (op0) : NULL;
3135 vr1 = (TREE_CODE (op1) == SSA_NAME) ? get_value_range (op1) : NULL;
3137 if (vr0 && vr1)
3138 return compare_ranges (TREE_CODE (cond), vr0, vr1);
3139 else if (vr0 && vr1 == NULL)
3140 return compare_range_with_value (TREE_CODE (cond), vr0, op1);
3141 else if (vr0 == NULL && vr1)
3142 return compare_range_with_value (
3143 swap_tree_comparison (TREE_CODE (cond)), vr1, op0);
3147 /* Anything else cannot be computed statically. */
3148 return NULL_TREE;
3152 /* Visit conditional statement STMT. If we can determine which edge
3153 will be taken out of STMT's basic block, record it in
3154 *TAKEN_EDGE_P and return SSA_PROP_INTERESTING. Otherwise, return
3155 SSA_PROP_VARYING. */
3157 static enum ssa_prop_result
3158 vrp_visit_cond_stmt (tree stmt, edge *taken_edge_p)
3160 tree cond, val;
3162 *taken_edge_p = NULL;
3164 /* FIXME. Handle SWITCH_EXPRs. But first, the assert pass needs to
3165 add ASSERT_EXPRs for them. */
3166 if (TREE_CODE (stmt) == SWITCH_EXPR)
3167 return SSA_PROP_VARYING;
3169 cond = COND_EXPR_COND (stmt);
3171 if (dump_file && (dump_flags & TDF_DETAILS))
3173 tree use;
3174 ssa_op_iter i;
3176 fprintf (dump_file, "\nVisiting conditional with predicate: ");
3177 print_generic_expr (dump_file, cond, 0);
3178 fprintf (dump_file, "\nWith known ranges\n");
3180 FOR_EACH_SSA_TREE_OPERAND (use, stmt, i, SSA_OP_USE)
3182 fprintf (dump_file, "\t");
3183 print_generic_expr (dump_file, use, 0);
3184 fprintf (dump_file, ": ");
3185 dump_value_range (dump_file, vr_value[SSA_NAME_VERSION (use)]);
3188 fprintf (dump_file, "\n");
3191 /* Compute the value of the predicate COND by checking the known
3192 ranges of each of its operands.
3194 Note that we cannot evaluate all the equivalent ranges here
3195 because those ranges may not yet be final and with the current
3196 propagation strategy, we cannot determine when the value ranges
3197 of the names in the equivalence set have changed.
3199 For instance, given the following code fragment
3201 i_5 = PHI <8, i_13>
3203 i_14 = ASSERT_EXPR <i_5, i_5 != 0>
3204 if (i_14 == 1)
3207 Assume that on the first visit to i_14, i_5 has the temporary
3208 range [8, 8] because the second argument to the PHI function is
3209 not yet executable. We derive the range ~[0, 0] for i_14 and the
3210 equivalence set { i_5 }. So, when we visit 'if (i_14 == 1)' for
3211 the first time, since i_14 is equivalent to the range [8, 8], we
3212 determine that the predicate is always false.
3214 On the next round of propagation, i_13 is determined to be
3215 VARYING, which causes i_5 to drop down to VARYING. So, another
3216 visit to i_14 is scheduled. In this second visit, we compute the
3217 exact same range and equivalence set for i_14, namely ~[0, 0] and
3218 { i_5 }. But we did not have the previous range for i_5
3219 registered, so vrp_visit_assignment thinks that the range for
3220 i_14 has not changed. Therefore, the predicate 'if (i_14 == 1)'
3221 is not visited again, which stops propagation from visiting
3222 statements in the THEN clause of that if().
3224 To properly fix this we would need to keep the previous range
3225 value for the names in the equivalence set. This way we would've
3226 discovered that from one visit to the other i_5 changed from
3227 range [8, 8] to VR_VARYING.
3229 However, fixing this apparent limitation may not be worth the
3230 additional checking. Testing on several code bases (GCC, DLV,
3231 MICO, TRAMP3D and SPEC2000) showed that doing this results in
3232 4 more predicates folded in SPEC. */
3233 val = vrp_evaluate_conditional (cond, false);
3234 if (val)
3235 *taken_edge_p = find_taken_edge (bb_for_stmt (stmt), val);
3237 if (dump_file && (dump_flags & TDF_DETAILS))
3239 fprintf (dump_file, "\nPredicate evaluates to: ");
3240 if (val == NULL_TREE)
3241 fprintf (dump_file, "DON'T KNOW\n");
3242 else
3243 print_generic_stmt (dump_file, val, 0);
3246 return (*taken_edge_p) ? SSA_PROP_INTERESTING : SSA_PROP_VARYING;
3250 /* Evaluate statement STMT. If the statement produces a useful range,
3251 return SSA_PROP_INTERESTING and record the SSA name with the
3252 interesting range into *OUTPUT_P.
3254 If STMT is a conditional branch and we can determine its truth
3255 value, the taken edge is recorded in *TAKEN_EDGE_P.
3257 If STMT produces a varying value, return SSA_PROP_VARYING. */
3259 static enum ssa_prop_result
3260 vrp_visit_stmt (tree stmt, edge *taken_edge_p, tree *output_p)
3262 tree def;
3263 ssa_op_iter iter;
3264 stmt_ann_t ann;
3266 if (dump_file && (dump_flags & TDF_DETAILS))
3268 fprintf (dump_file, "\nVisiting statement:\n");
3269 print_generic_stmt (dump_file, stmt, dump_flags);
3270 fprintf (dump_file, "\n");
3273 ann = stmt_ann (stmt);
3274 if (TREE_CODE (stmt) == MODIFY_EXPR
3275 && ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS))
3276 return vrp_visit_assignment (stmt, output_p);
3277 else if (TREE_CODE (stmt) == COND_EXPR || TREE_CODE (stmt) == SWITCH_EXPR)
3278 return vrp_visit_cond_stmt (stmt, taken_edge_p);
3280 /* All other statements produce nothing of interest for VRP, so mark
3281 their outputs varying and prevent further simulation. */
3282 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
3283 set_value_range_to_varying (get_value_range (def));
3285 return SSA_PROP_VARYING;
3289 /* Meet operation for value ranges. Given two value ranges VR0 and
3290 VR1, store in VR0 the result of meeting VR0 and VR1.
3292 The meeting rules are as follows:
3294 1- If VR0 and VR1 have an empty intersection, set VR0 to VR_VARYING.
3296 2- If VR0 and VR1 have a non-empty intersection, set VR0 to the
3297 union of VR0 and VR1. */
3299 static void
3300 vrp_meet (value_range_t *vr0, value_range_t *vr1)
3302 if (vr0->type == VR_UNDEFINED)
3304 copy_value_range (vr0, vr1);
3305 return;
3308 if (vr1->type == VR_UNDEFINED)
3310 /* Nothing to do. VR0 already has the resulting range. */
3311 return;
3314 if (vr0->type == VR_VARYING)
3316 /* Nothing to do. VR0 already has the resulting range. */
3317 return;
3320 if (vr1->type == VR_VARYING)
3322 set_value_range_to_varying (vr0);
3323 return;
3326 if (vr0->type == VR_RANGE && vr1->type == VR_RANGE)
3328 /* If VR0 and VR1 have a non-empty intersection, compute the
3329 union of both ranges. */
3330 if (value_ranges_intersect_p (vr0, vr1))
3332 int cmp;
3333 tree min, max;
3335 /* The lower limit of the new range is the minimum of the
3336 two ranges. If they cannot be compared, the result is
3337 VARYING. */
3338 cmp = compare_values (vr0->min, vr1->min);
3339 if (cmp == 0 || cmp == 1)
3340 min = vr1->min;
3341 else if (cmp == -1)
3342 min = vr0->min;
3343 else
3345 set_value_range_to_varying (vr0);
3346 return;
3349 /* Similarly, the upper limit of the new range is the
3350 maximum of the two ranges. If they cannot be compared,
3351 the result is VARYING. */
3352 cmp = compare_values (vr0->max, vr1->max);
3353 if (cmp == 0 || cmp == -1)
3354 max = vr1->max;
3355 else if (cmp == 1)
3356 max = vr0->max;
3357 else
3359 set_value_range_to_varying (vr0);
3360 return;
3363 /* The resulting set of equivalences is the intersection of
3364 the two sets. */
3365 if (vr0->equiv && vr1->equiv && vr0->equiv != vr1->equiv)
3366 bitmap_and_into (vr0->equiv, vr1->equiv);
3367 else if (vr0->equiv && !vr1->equiv)
3368 bitmap_clear (vr0->equiv);
3370 set_value_range (vr0, vr0->type, min, max, vr0->equiv);
3372 else
3373 goto no_meet;
3375 else if (vr0->type == VR_ANTI_RANGE && vr1->type == VR_ANTI_RANGE)
3377 /* Two anti-ranges meet only if they are both identical. */
3378 if (compare_values (vr0->min, vr1->min) == 0
3379 && compare_values (vr0->max, vr1->max) == 0
3380 && compare_values (vr0->min, vr0->max) == 0)
3382 /* The resulting set of equivalences is the intersection of
3383 the two sets. */
3384 if (vr0->equiv && vr1->equiv && vr0->equiv != vr1->equiv)
3385 bitmap_and_into (vr0->equiv, vr1->equiv);
3386 else if (vr0->equiv && !vr1->equiv)
3387 bitmap_clear (vr0->equiv);
3389 else
3390 goto no_meet;
3392 else if (vr0->type == VR_ANTI_RANGE || vr1->type == VR_ANTI_RANGE)
3394 /* A numeric range [VAL1, VAL2] and an anti-range ~[VAL3, VAL4]
3395 meet only if the ranges have an empty intersection. The
3396 result of the meet operation is the anti-range. */
3397 if (!symbolic_range_p (vr0)
3398 && !symbolic_range_p (vr1)
3399 && !value_ranges_intersect_p (vr0, vr1))
3401 if (vr1->type == VR_ANTI_RANGE)
3402 copy_value_range (vr0, vr1);
3404 /* The resulting set of equivalences is the intersection of
3405 the two sets. */
3406 if (vr0->equiv && vr1->equiv && vr0->equiv != vr1->equiv)
3407 bitmap_and_into (vr0->equiv, vr1->equiv);
3408 else if (vr0->equiv && !vr1->equiv)
3409 bitmap_clear (vr0->equiv);
3411 else
3412 goto no_meet;
3414 else
3415 gcc_unreachable ();
3417 return;
3419 no_meet:
3420 /* The two range VR0 and VR1 do not meet. Before giving up and
3421 setting the result to VARYING, see if we can at least derive a
3422 useful anti-range. */
3423 if (!symbolic_range_p (vr0)
3424 && !range_includes_zero_p (vr0)
3425 && !symbolic_range_p (vr1)
3426 && !range_includes_zero_p (vr1))
3427 set_value_range_to_nonnull (vr0, TREE_TYPE (vr0->min));
3428 else
3429 set_value_range_to_varying (vr0);
3433 /* Visit all arguments for PHI node PHI that flow through executable
3434 edges. If a valid value range can be derived from all the incoming
3435 value ranges, set a new range for the LHS of PHI. */
3437 static enum ssa_prop_result
3438 vrp_visit_phi_node (tree phi)
3440 int i;
3441 tree lhs = PHI_RESULT (phi);
3442 value_range_t *lhs_vr = get_value_range (lhs);
3443 value_range_t vr_result = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
3445 copy_value_range (&vr_result, lhs_vr);
3447 if (dump_file && (dump_flags & TDF_DETAILS))
3449 fprintf (dump_file, "\nVisiting PHI node: ");
3450 print_generic_expr (dump_file, phi, dump_flags);
3453 for (i = 0; i < PHI_NUM_ARGS (phi); i++)
3455 edge e = PHI_ARG_EDGE (phi, i);
3457 if (dump_file && (dump_flags & TDF_DETAILS))
3459 fprintf (dump_file,
3460 "\n Argument #%d (%d -> %d %sexecutable)\n",
3461 i, e->src->index, e->dest->index,
3462 (e->flags & EDGE_EXECUTABLE) ? "" : "not ");
3465 if (e->flags & EDGE_EXECUTABLE)
3467 tree arg = PHI_ARG_DEF (phi, i);
3468 value_range_t vr_arg;
3470 if (TREE_CODE (arg) == SSA_NAME)
3471 vr_arg = *(get_value_range (arg));
3472 else
3474 vr_arg.type = VR_RANGE;
3475 vr_arg.min = arg;
3476 vr_arg.max = arg;
3477 vr_arg.equiv = NULL;
3480 if (dump_file && (dump_flags & TDF_DETAILS))
3482 fprintf (dump_file, "\t");
3483 print_generic_expr (dump_file, arg, dump_flags);
3484 fprintf (dump_file, "\n\tValue: ");
3485 dump_value_range (dump_file, &vr_arg);
3486 fprintf (dump_file, "\n");
3489 vrp_meet (&vr_result, &vr_arg);
3491 if (vr_result.type == VR_VARYING)
3492 break;
3496 if (vr_result.type == VR_VARYING)
3497 goto varying;
3499 /* To prevent infinite iterations in the algorithm, derive ranges
3500 when the new value is slightly bigger or smaller than the
3501 previous one. */
3502 if (lhs_vr->type == VR_RANGE)
3504 if (!POINTER_TYPE_P (TREE_TYPE (lhs)))
3506 int cmp_min = compare_values (lhs_vr->min, vr_result.min);
3507 int cmp_max = compare_values (lhs_vr->max, vr_result.max);
3509 /* If the new minimum is smaller or larger than the previous
3510 one, go all the way to -INF. In the first case, to avoid
3511 iterating millions of times to reach -INF, and in the
3512 other case to avoid infinite bouncing between different
3513 minimums. */
3514 if (cmp_min > 0 || cmp_min < 0)
3515 vr_result.min = TYPE_MIN_VALUE (TREE_TYPE (vr_result.min));
3517 /* Similarly, if the new maximum is smaller or larger than
3518 the previous one, go all the way to +INF. */
3519 if (cmp_max < 0 || cmp_max > 0)
3520 vr_result.max = TYPE_MAX_VALUE (TREE_TYPE (vr_result.max));
3522 /* If we ended up with a (-INF, +INF) range, set it to
3523 VARYING. */
3524 if (vr_result.min == TYPE_MIN_VALUE (TREE_TYPE (vr_result.min))
3525 && vr_result.max == TYPE_MAX_VALUE (TREE_TYPE (vr_result.max)))
3526 goto varying;
3530 /* If the new range is different than the previous value, keep
3531 iterating. */
3532 if (update_value_range (lhs, &vr_result))
3533 return SSA_PROP_INTERESTING;
3535 /* Nothing changed, don't add outgoing edges. */
3536 return SSA_PROP_NOT_INTERESTING;
3538 /* No match found. Set the LHS to VARYING. */
3539 varying:
3540 set_value_range_to_varying (lhs_vr);
3541 return SSA_PROP_VARYING;
3544 /* Simplify a division or modulo operator to a right shift or
3545 bitwise and if the first operand is unsigned or is greater
3546 than zero and the second operand is an exact power of two. */
3548 static void
3549 simplify_div_or_mod_using_ranges (tree stmt, tree rhs, enum tree_code rhs_code)
3551 tree val = NULL;
3552 tree op = TREE_OPERAND (rhs, 0);
3553 value_range_t *vr = get_value_range (TREE_OPERAND (rhs, 0));
3555 if (TYPE_UNSIGNED (TREE_TYPE (op)))
3557 val = integer_one_node;
3559 else
3561 val = compare_range_with_value (GT_EXPR, vr, integer_zero_node);
3564 if (val && integer_onep (val))
3566 tree t;
3567 tree op0 = TREE_OPERAND (rhs, 0);
3568 tree op1 = TREE_OPERAND (rhs, 1);
3570 if (rhs_code == TRUNC_DIV_EXPR)
3572 t = build_int_cst (NULL_TREE, tree_log2 (op1));
3573 t = build2 (RSHIFT_EXPR, TREE_TYPE (op0), op0, t);
3575 else
3577 t = build_int_cst (TREE_TYPE (op1), 1);
3578 t = int_const_binop (MINUS_EXPR, op1, t, 0);
3579 t = fold_convert (TREE_TYPE (op0), t);
3580 t = build2 (BIT_AND_EXPR, TREE_TYPE (op0), op0, t);
3583 TREE_OPERAND (stmt, 1) = t;
3584 update_stmt (stmt);
3588 /* If the operand to an ABS_EXPR is >= 0, then eliminate the
3589 ABS_EXPR. If the operand is <= 0, then simplify the
3590 ABS_EXPR into a NEGATE_EXPR. */
3592 static void
3593 simplify_abs_using_ranges (tree stmt, tree rhs)
3595 tree val = NULL;
3596 tree op = TREE_OPERAND (rhs, 0);
3597 tree type = TREE_TYPE (op);
3598 value_range_t *vr = get_value_range (TREE_OPERAND (rhs, 0));
3600 if (TYPE_UNSIGNED (type))
3602 val = integer_zero_node;
3604 else if (vr)
3606 val = compare_range_with_value (LE_EXPR, vr, integer_zero_node);
3607 if (!val)
3609 val = compare_range_with_value (GE_EXPR, vr, integer_zero_node);
3611 if (val)
3613 if (integer_zerop (val))
3614 val = integer_one_node;
3615 else if (integer_onep (val))
3616 val = integer_zero_node;
3620 if (val
3621 && (integer_onep (val) || integer_zerop (val)))
3623 tree t;
3625 if (integer_onep (val))
3626 t = build1 (NEGATE_EXPR, TREE_TYPE (op), op);
3627 else
3628 t = op;
3630 TREE_OPERAND (stmt, 1) = t;
3631 update_stmt (stmt);
3636 /* We are comparing trees OP0 and OP1 using COND_CODE. OP0 has
3637 a known value range VR.
3639 If there is one and only one value which will satisfy the
3640 conditional, then return that value. Else return NULL. */
3642 static tree
3643 test_for_singularity (enum tree_code cond_code, tree op0,
3644 tree op1, value_range_t *vr)
3646 tree min = NULL;
3647 tree max = NULL;
3649 /* Extract minimum/maximum values which satisfy the
3650 the conditional as it was written. */
3651 if (cond_code == LE_EXPR || cond_code == LT_EXPR)
3653 min = TYPE_MIN_VALUE (TREE_TYPE (op0));
3655 max = op1;
3656 if (cond_code == LT_EXPR)
3658 tree one = build_int_cst (TREE_TYPE (op0), 1);
3659 max = fold_build2 (MINUS_EXPR, TREE_TYPE (op0), max, one);
3662 else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
3664 max = TYPE_MAX_VALUE (TREE_TYPE (op0));
3666 min = op1;
3667 if (cond_code == GT_EXPR)
3669 tree one = build_int_cst (TREE_TYPE (op0), 1);
3670 max = fold_build2 (PLUS_EXPR, TREE_TYPE (op0), max, one);
3674 /* Now refine the minimum and maximum values using any
3675 value range information we have for op0. */
3676 if (min && max)
3678 if (compare_values (vr->min, min) == -1)
3679 min = min;
3680 else
3681 min = vr->min;
3682 if (compare_values (vr->max, max) == 1)
3683 max = max;
3684 else
3685 max = vr->max;
3687 /* If the new min/max values have converged to a
3688 single value, then there is only one value which
3689 can satisfy the condition, return that value. */
3690 if (min == max && is_gimple_min_invariant (min))
3691 return min;
3693 return NULL;
3696 /* Simplify a conditional using a relational operator to an equality
3697 test if the range information indicates only one value can satisfy
3698 the original conditional. */
3700 static void
3701 simplify_cond_using_ranges (tree stmt)
3703 tree cond = COND_EXPR_COND (stmt);
3704 tree op0 = TREE_OPERAND (cond, 0);
3705 tree op1 = TREE_OPERAND (cond, 1);
3706 enum tree_code cond_code = TREE_CODE (cond);
3708 if (cond_code != NE_EXPR
3709 && cond_code != EQ_EXPR
3710 && TREE_CODE (op0) == SSA_NAME
3711 && INTEGRAL_TYPE_P (TREE_TYPE (op0))
3712 && is_gimple_min_invariant (op1))
3714 value_range_t *vr = get_value_range (op0);
3716 /* If we have range information for OP0, then we might be
3717 able to simplify this conditional. */
3718 if (vr->type == VR_RANGE)
3720 tree new = test_for_singularity (cond_code, op0, op1, vr);
3722 if (new)
3724 if (dump_file)
3726 fprintf (dump_file, "Simplified relational ");
3727 print_generic_expr (dump_file, cond, 0);
3728 fprintf (dump_file, " into ");
3731 COND_EXPR_COND (stmt)
3732 = build (EQ_EXPR, boolean_type_node, op0, new);
3733 update_stmt (stmt);
3735 if (dump_file)
3737 print_generic_expr (dump_file, COND_EXPR_COND (stmt), 0);
3738 fprintf (dump_file, "\n");
3740 return;
3744 /* Try again after inverting the condition. We only deal
3745 with integral types here, so no need to worry about
3746 issues with inverting FP comparisons. */
3747 cond_code = invert_tree_comparison (cond_code, false);
3748 new = test_for_singularity (cond_code, op0, op1, vr);
3750 if (new)
3752 if (dump_file)
3754 fprintf (dump_file, "Simplified relational ");
3755 print_generic_expr (dump_file, cond, 0);
3756 fprintf (dump_file, " into ");
3759 COND_EXPR_COND (stmt)
3760 = build (NE_EXPR, boolean_type_node, op0, new);
3761 update_stmt (stmt);
3763 if (dump_file)
3765 print_generic_expr (dump_file, COND_EXPR_COND (stmt), 0);
3766 fprintf (dump_file, "\n");
3768 return;
3775 /* Simplify STMT using ranges if possible. */
3777 void
3778 simplify_stmt_using_ranges (tree stmt)
3780 if (TREE_CODE (stmt) == MODIFY_EXPR)
3782 tree rhs = TREE_OPERAND (stmt, 1);
3783 enum tree_code rhs_code = TREE_CODE (rhs);
3785 /* Transform TRUNC_DIV_EXPR and TRUNC_MOD_EXPR into RSHIFT_EXPR
3786 and BIT_AND_EXPR respectively if the first operand is greater
3787 than zero and the second operand is an exact power of two. */
3788 if ((rhs_code == TRUNC_DIV_EXPR || rhs_code == TRUNC_MOD_EXPR)
3789 && INTEGRAL_TYPE_P (TREE_TYPE (TREE_OPERAND (rhs, 0)))
3790 && integer_pow2p (TREE_OPERAND (rhs, 1)))
3791 simplify_div_or_mod_using_ranges (stmt, rhs, rhs_code);
3793 /* Transform ABS (X) into X or -X as appropriate. */
3794 if (rhs_code == ABS_EXPR
3795 && TREE_CODE (TREE_OPERAND (rhs, 0)) == SSA_NAME
3796 && INTEGRAL_TYPE_P (TREE_TYPE (TREE_OPERAND (rhs, 0))))
3797 simplify_abs_using_ranges (stmt, rhs);
3799 else if (TREE_CODE (stmt) == COND_EXPR
3800 && COMPARISON_CLASS_P (COND_EXPR_COND (stmt)))
3802 simplify_cond_using_ranges (stmt);
3808 /* Traverse all the blocks folding conditionals with known ranges. */
3810 static void
3811 vrp_finalize (void)
3813 size_t i;
3814 prop_value_t *single_val_range;
3815 bool do_value_subst_p;
3817 if (dump_file)
3819 fprintf (dump_file, "\nValue ranges after VRP:\n\n");
3820 dump_all_value_ranges (dump_file);
3821 fprintf (dump_file, "\n");
3824 /* We may have ended with ranges that have exactly one value. Those
3825 values can be substituted as any other copy/const propagated
3826 value using substitute_and_fold. */
3827 single_val_range = xmalloc (num_ssa_names * sizeof (*single_val_range));
3828 memset (single_val_range, 0, num_ssa_names * sizeof (*single_val_range));
3830 do_value_subst_p = false;
3831 for (i = 0; i < num_ssa_names; i++)
3832 if (vr_value[i]
3833 && vr_value[i]->type == VR_RANGE
3834 && vr_value[i]->min == vr_value[i]->max)
3836 single_val_range[i].value = vr_value[i]->min;
3837 do_value_subst_p = true;
3840 if (!do_value_subst_p)
3842 /* We found no single-valued ranges, don't waste time trying to
3843 do single value substitution in substitute_and_fold. */
3844 free (single_val_range);
3845 single_val_range = NULL;
3848 substitute_and_fold (single_val_range, true);
3850 /* Free allocated memory. */
3851 for (i = 0; i < num_ssa_names; i++)
3852 if (vr_value[i])
3854 BITMAP_FREE (vr_value[i]->equiv);
3855 free (vr_value[i]);
3858 free (single_val_range);
3859 free (vr_value);
3863 /* Main entry point to VRP (Value Range Propagation). This pass is
3864 loosely based on J. R. C. Patterson, ``Accurate Static Branch
3865 Prediction by Value Range Propagation,'' in SIGPLAN Conference on
3866 Programming Language Design and Implementation, pp. 67-78, 1995.
3867 Also available at http://citeseer.ist.psu.edu/patterson95accurate.html
3869 This is essentially an SSA-CCP pass modified to deal with ranges
3870 instead of constants.
3872 While propagating ranges, we may find that two or more SSA name
3873 have equivalent, though distinct ranges. For instance,
3875 1 x_9 = p_3->a;
3876 2 p_4 = ASSERT_EXPR <p_3, p_3 != 0>
3877 3 if (p_4 == q_2)
3878 4 p_5 = ASSERT_EXPR <p_4, p_4 == q_2>;
3879 5 endif
3880 6 if (q_2)
3882 In the code above, pointer p_5 has range [q_2, q_2], but from the
3883 code we can also determine that p_5 cannot be NULL and, if q_2 had
3884 a non-varying range, p_5's range should also be compatible with it.
3886 These equivalences are created by two expressions: ASSERT_EXPR and
3887 copy operations. Since p_5 is an assertion on p_4, and p_4 was the
3888 result of another assertion, then we can use the fact that p_5 and
3889 p_4 are equivalent when evaluating p_5's range.
3891 Together with value ranges, we also propagate these equivalences
3892 between names so that we can take advantage of information from
3893 multiple ranges when doing final replacement. Note that this
3894 equivalency relation is transitive but not symmetric.
3896 In the example above, p_5 is equivalent to p_4, q_2 and p_3, but we
3897 cannot assert that q_2 is equivalent to p_5 because q_2 may be used
3898 in contexts where that assertion does not hold (e.g., in line 6).
3900 TODO, the main difference between this pass and Patterson's is that
3901 we do not propagate edge probabilities. We only compute whether
3902 edges can be taken or not. That is, instead of having a spectrum
3903 of jump probabilities between 0 and 1, we only deal with 0, 1 and
3904 DON'T KNOW. In the future, it may be worthwhile to propagate
3905 probabilities to aid branch prediction. */
3907 static void
3908 execute_vrp (void)
3910 insert_range_assertions ();
3912 cfg_loops = loop_optimizer_init (NULL);
3913 if (cfg_loops)
3914 scev_initialize (cfg_loops);
3916 vrp_initialize ();
3917 ssa_propagate (vrp_visit_stmt, vrp_visit_phi_node);
3918 vrp_finalize ();
3920 if (cfg_loops)
3922 scev_finalize ();
3923 loop_optimizer_finalize (cfg_loops, NULL);
3924 current_loops = NULL;
3927 remove_range_assertions ();
3930 static bool
3931 gate_vrp (void)
3933 return flag_tree_vrp != 0;
3936 struct tree_opt_pass pass_vrp =
3938 "vrp", /* name */
3939 gate_vrp, /* gate */
3940 execute_vrp, /* execute */
3941 NULL, /* sub */
3942 NULL, /* next */
3943 0, /* static_pass_number */
3944 TV_TREE_VRP, /* tv_id */
3945 PROP_ssa | PROP_alias, /* properties_required */
3946 0, /* properties_provided */
3947 0, /* properties_destroyed */
3948 0, /* todo_flags_start */
3949 TODO_cleanup_cfg
3950 | TODO_ggc_collect
3951 | TODO_verify_ssa
3952 | TODO_dump_func
3953 | TODO_update_ssa, /* todo_flags_finish */
3954 0 /* letter */