* opt-functions.awk (var_type): New function.
[official-gcc.git] / gcc / tree-vrp.c
blob16fa58b23b181fc4993b6db72d6644ca8c1f4846
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, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, 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 maybe_add_assert_expr. */
42 static sbitmap found;
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 /* Given a conditional predicate COND that has WHICH as one of its
52 operands, return the other operand. No error checking is done.
53 This helper assumes that COND is a comparison and WHICH is one of
54 its operands. */
56 static inline tree
57 get_opposite_operand (tree cond, tree which)
59 if (TREE_OPERAND (cond, 0) == which)
60 return TREE_OPERAND (cond, 1);
61 else
62 return TREE_OPERAND (cond, 0);
66 /* Given a comparison code, return its opposite. Note that this is *not*
67 the same as inverting its truth value (invert_tree_comparison). Here we
68 just want to literally flip the comparison around.
70 So, '<' gets '>', '<=' gets '>='. Both '==' and '!=' are returned
71 unchanged. */
73 static enum tree_code
74 opposite_comparison (enum tree_code code)
76 switch (code)
78 case EQ_EXPR:
79 case NE_EXPR:
80 case ORDERED_EXPR:
81 case UNORDERED_EXPR:
82 case LTGT_EXPR:
83 case UNEQ_EXPR:
84 return code;
85 case GT_EXPR:
86 return LT_EXPR;
87 case GE_EXPR:
88 return LE_EXPR;
89 case LT_EXPR:
90 return GT_EXPR;
91 case LE_EXPR:
92 return GE_EXPR;
93 case UNGT_EXPR:
94 return UNLT_EXPR;
95 case UNGE_EXPR:
96 return UNLE_EXPR;
97 case UNLT_EXPR:
98 return UNGT_EXPR;
99 case UNLE_EXPR:
100 return UNGE_EXPR;
101 default:
102 gcc_unreachable ();
107 /* Set value range VR to {T, MIN, MAX}. */
109 static inline void
110 set_value_range (value_range *vr, enum value_range_type t, tree min, tree max)
112 #if defined ENABLE_CHECKING
113 if (t == VR_RANGE || t == VR_ANTI_RANGE)
115 int cmp;
117 gcc_assert (min && max);
119 if (INTEGRAL_TYPE_P (TREE_TYPE (min)) && t == VR_ANTI_RANGE)
120 gcc_assert (min != TYPE_MIN_VALUE (TREE_TYPE (min))
121 || max != TYPE_MAX_VALUE (TREE_TYPE (max)));
123 cmp = compare_values (min, max);
124 gcc_assert (cmp == 0 || cmp == -1 || cmp == -2);
126 #endif
128 if (t == VR_RANGE
129 && INTEGRAL_TYPE_P (TREE_TYPE (min))
130 && min == TYPE_MIN_VALUE (TREE_TYPE (min))
131 && max == TYPE_MAX_VALUE (TREE_TYPE (max)))
133 /* Ranges that cover all the possible values for the type decay
134 to VARYING. */
135 vr->type = VR_VARYING;
136 vr->min = NULL_TREE;
137 vr->max = NULL_TREE;
138 return;
141 vr->type = t;
142 vr->min = min;
143 vr->max = max;
147 /* Similar to set_value_range but return true if any field of VR
148 changed from its previous value. */
150 static inline bool
151 update_value_range (value_range *vr, enum value_range_type t, tree min,
152 tree max)
154 bool is_new = vr->type != t || vr->min != min || vr->max != max;
155 if (is_new)
156 set_value_range (vr, t, min, max);
158 return is_new;
162 /* Return value range information for VAR. Create an empty range if
163 none existed. */
165 value_range *
166 get_value_range (tree var)
168 value_range *vr;
169 tree sym;
171 vr = SSA_NAME_VALUE_RANGE (var);
172 if (vr)
173 return vr;
175 /* Create a default value range. */
176 vr = ggc_alloc (sizeof (*vr));
177 memset ((void *) vr, 0, sizeof (*vr));
178 SSA_NAME_VALUE_RANGE (var) = vr;
180 /* If VAR is a default definition for a PARM_DECL, then we have to
181 assume a VARYING range for it. */
182 sym = SSA_NAME_VAR (var);
183 if (TREE_CODE (sym) == PARM_DECL && var == var_ann (sym)->default_def)
184 set_value_range (vr, VR_VARYING, NULL_TREE, NULL_TREE);
186 return vr;
190 /* Return true if value range VR involves at least one symbol. */
192 static inline bool
193 symbolic_range_p (value_range *vr)
195 return (!is_gimple_min_invariant (vr->min)
196 || !is_gimple_min_invariant (vr->max));
200 /* Return true if EXPR computes a non-zero value. */
202 bool
203 expr_computes_nonzero (tree expr)
205 /* Type casts won't change anything, so just strip it. */
206 STRIP_NOPS (expr);
208 /* Calling alloca, guarantees that the value is non-NULL. */
209 if (alloca_call_p (expr))
210 return true;
212 /* The address of a non-weak symbol is never NULL, unless the user
213 has requested not to remove NULL pointer checks. */
214 if (flag_delete_null_pointer_checks
215 && TREE_CODE (expr) == ADDR_EXPR
216 && DECL_P (TREE_OPERAND (expr, 0))
217 && !DECL_WEAK (TREE_OPERAND (expr, 0)))
218 return true;
220 /* IOR of any value with a nonzero value will result in a nonzero
221 value. */
222 if (TREE_CODE (expr) == BIT_IOR_EXPR
223 && integer_nonzerop (TREE_OPERAND (expr, 1)))
224 return true;
226 return false;
230 /* Return true if VR is ~[0, 0]. */
232 static inline bool
233 range_is_nonnull (value_range *vr)
235 return vr->type == VR_ANTI_RANGE
236 && integer_zerop (vr->min)
237 && integer_zerop (vr->max);
241 /* Return true if VR is [0, 0]. */
243 static inline bool
244 range_is_null (value_range *vr)
246 return vr->type == VR_RANGE
247 && integer_zerop (vr->min)
248 && integer_zerop (vr->max);
252 /* Set value range VR to a non-NULL range of type TYPE. */
254 static inline void
255 set_value_range_to_nonnull (value_range *vr, tree type)
257 tree zero = build_int_cst (type, 0);
258 set_value_range (vr, VR_ANTI_RANGE, zero, zero);
262 /* Set value range VR to a NULL range of type TYPE. */
264 static inline void
265 set_value_range_to_null (value_range *vr, tree type)
267 tree zero = build_int_cst (type, 0);
268 set_value_range (vr, VR_RANGE, zero, zero);
272 /* Set value range VR to VR_VARYING. */
274 static inline void
275 set_value_range_to_varying (value_range *vr)
277 set_value_range (vr, VR_VARYING, NULL_TREE, NULL_TREE);
281 /* Compare two values VAL1 and VAL2. Return
283 -2 if VAL1 and VAL2 cannot be compared at compile-time,
284 -1 if VAL1 < VAL2,
285 0 if VAL1 == VAL2,
286 +1 if VAL1 > VAL2, and
287 +2 if VAL1 != VAL2
289 This is similar to tree_int_cst_compare but supports pointer values
290 and values that cannot be compared at compile time. */
292 static int
293 compare_values (tree val1, tree val2)
295 if (val1 == val2)
296 return 0;
298 /* Below we rely on the fact that VAL1 and VAL2 are both pointers or
299 both integers. */
300 gcc_assert (POINTER_TYPE_P (TREE_TYPE (val1))
301 == POINTER_TYPE_P (TREE_TYPE (val2)));
303 /* Do some limited symbolic comparisons. */
304 if (!POINTER_TYPE_P (TREE_TYPE (val1)))
306 /* We can determine some comparisons against +INF and -INF even
307 if the other value is an expression. */
308 if (val1 == TYPE_MAX_VALUE (TREE_TYPE (val1))
309 && TREE_CODE (val2) == MINUS_EXPR)
311 /* +INF > NAME - CST. */
312 return 1;
314 else if (val1 == TYPE_MIN_VALUE (TREE_TYPE (val1))
315 && TREE_CODE (val2) == PLUS_EXPR)
317 /* -INF < NAME + CST. */
318 return -1;
320 else if (TREE_CODE (val1) == MINUS_EXPR
321 && val2 == TYPE_MAX_VALUE (TREE_TYPE (val2)))
323 /* NAME - CST < +INF. */
324 return -1;
326 else if (TREE_CODE (val1) == PLUS_EXPR
327 && val2 == TYPE_MIN_VALUE (TREE_TYPE (val2)))
329 /* NAME + CST > -INF. */
330 return 1;
334 if ((TREE_CODE (val1) == SSA_NAME
335 || TREE_CODE (val1) == PLUS_EXPR
336 || TREE_CODE (val1) == MINUS_EXPR)
337 && (TREE_CODE (val2) == SSA_NAME
338 || TREE_CODE (val2) == PLUS_EXPR
339 || TREE_CODE (val2) == MINUS_EXPR))
341 tree n1, c1, n2, c2;
343 /* If VAL1 and VAL2 are of the form 'NAME [+-] CST' or 'NAME',
344 return -1 or +1 accordingly. If VAL1 and VAL2 don't use the
345 same name, return -2. */
346 if (TREE_CODE (val1) == SSA_NAME)
348 n1 = val1;
349 c1 = NULL_TREE;
351 else
353 n1 = TREE_OPERAND (val1, 0);
354 c1 = TREE_OPERAND (val1, 1);
357 if (TREE_CODE (val2) == SSA_NAME)
359 n2 = val2;
360 c2 = NULL_TREE;
362 else
364 n2 = TREE_OPERAND (val2, 0);
365 c2 = TREE_OPERAND (val2, 1);
368 /* Both values must use the same name. */
369 if (n1 != n2)
370 return -2;
372 if (TREE_CODE (val1) == SSA_NAME)
374 if (TREE_CODE (val2) == SSA_NAME)
375 /* NAME == NAME */
376 return 0;
377 else if (TREE_CODE (val2) == PLUS_EXPR)
378 /* NAME < NAME + CST */
379 return -1;
380 else if (TREE_CODE (val2) == MINUS_EXPR)
381 /* NAME > NAME - CST */
382 return 1;
384 else if (TREE_CODE (val1) == PLUS_EXPR)
386 if (TREE_CODE (val2) == SSA_NAME)
387 /* NAME + CST > NAME */
388 return 1;
389 else if (TREE_CODE (val2) == PLUS_EXPR)
390 /* NAME + CST1 > NAME + CST2, if CST1 > CST2 */
391 return compare_values (c1, c2);
392 else if (TREE_CODE (val2) == MINUS_EXPR)
393 /* NAME + CST1 > NAME - CST2 */
394 return 1;
396 else if (TREE_CODE (val1) == MINUS_EXPR)
398 if (TREE_CODE (val2) == SSA_NAME)
399 /* NAME - CST < NAME */
400 return -1;
401 else if (TREE_CODE (val2) == PLUS_EXPR)
402 /* NAME - CST1 < NAME + CST2 */
403 return -1;
404 else if (TREE_CODE (val2) == MINUS_EXPR)
405 /* NAME - CST1 > NAME - CST2, if CST1 < CST2. Notice that
406 C1 and C2 are swapped in the call to compare_values. */
407 return compare_values (c2, c1);
410 gcc_unreachable ();
413 /* We cannot compare non-constants. */
414 if (!is_gimple_min_invariant (val1) || !is_gimple_min_invariant (val2))
415 return -2;
417 if (!POINTER_TYPE_P (TREE_TYPE (val1)))
418 return tree_int_cst_compare (val1, val2);
419 else
421 tree t;
423 /* First see if VAL1 and VAL2 are not the same. */
424 if (val1 == val2 || operand_equal_p (val1, val2, 0))
425 return 0;
427 /* If VAL1 is a lower address than VAL2, return -1. */
428 t = fold_binary (LT_EXPR, boolean_type_node, val1, val2);
429 if (t == boolean_true_node)
430 return -1;
432 /* If VAL1 is a higher address than VAL2, return +1. */
433 t = fold_binary (GT_EXPR, boolean_type_node, val1, val2);
434 if (t == boolean_true_node)
435 return 1;
437 /* If VAL1 is different than VAL2, return +2. */
438 t = fold_binary (NE_EXPR, boolean_type_node, val1, val2);
439 if (t == boolean_true_node)
440 return 2;
442 return -2;
447 /* Return 1 if VAL is inside value range VR (VR->MIN <= VAL <= VR->MAX),
448 0 if VAL is not inside VR,
449 -2 if we cannot tell either way. */
451 static inline int
452 value_inside_range (tree val, value_range *vr)
454 int cmp1, cmp2;
456 cmp1 = compare_values (val, vr->min);
457 if (cmp1 == -2 || cmp1 == 2)
458 return -2;
460 cmp2 = compare_values (val, vr->max);
461 if (cmp2 == -2 || cmp2 == 2)
462 return -2;
464 return (cmp1 == 0 || cmp1 == 1) && (cmp2 == -1 || cmp2 == 0);
468 /* Return true if value ranges VR0 and VR1 have a non-empty
469 intersection. */
471 static inline bool
472 value_ranges_intersect_p (value_range *vr0, value_range *vr1)
474 return (value_inside_range (vr1->min, vr0) == 1
475 || value_inside_range (vr1->max, vr0) == 1
476 || value_inside_range (vr0->min, vr1) == 1
477 || value_inside_range (vr0->max, vr1) == 1);
481 /* Extract value range information from an ASSERT_EXPR EXPR and store
482 it in *VR_P. */
484 static void
485 extract_range_from_assert (value_range *vr_p, tree expr)
487 tree var, cond, limit, type;
488 value_range *var_vr;
489 enum tree_code cond_code;
491 var = ASSERT_EXPR_VAR (expr);
492 cond = ASSERT_EXPR_COND (expr);
493 cond_code = TREE_CODE (cond);
495 gcc_assert (COMPARISON_CLASS_P (cond));
497 /* Find VAR in the ASSERT_EXPR conditional. */
498 limit = get_opposite_operand (cond, var);
499 type = TREE_TYPE (limit);
501 gcc_assert (limit != var);
503 /* For pointer arithmetic, we only keep track of anti-ranges
504 (NE_EXPR). Notice that we don't need to handle EQ_EXPR in these
505 cases because assertions with equalities are never generated.
506 The assert pass generates straight assignments in those cases. */
507 if (POINTER_TYPE_P (type) && cond_code != NE_EXPR)
509 set_value_range_to_varying (vr_p);
510 return;
513 /* Special handling for integral types with super-types. Some FEs
514 construct integral types derived from other types and restrict
515 the range of values these new types may take.
517 It may happen that LIMIT is actually smaller than TYPE's minimum
518 value. For instance, the Ada FE is generating code like this
519 during bootstrap:
521 D.1480_32 = nam_30 - 300000361;
522 if (D.1480_32 <= 1) goto <L112>; else goto <L52>;
523 <L112>:;
524 D.1480_94 = ASSERT_EXPR <D.1480_32, D.1480_32 <= 1>;
526 All the names are of type types__name_id___XDLU_300000000__399999999
527 which has min == 300000000 and max == 399999999. This means that
528 the ASSERT_EXPR would try to create the range [3000000, 1] which
529 is invalid.
531 The fact that the type specifies MIN and MAX values does not
532 automatically mean that every variable of that type will always
533 be within that range, so the predicate may well be true at run
534 time. If we had symbolic -INF and +INF values, we could
535 represent this range, but we currently represent -INF and +INF
536 using the type's min and max values.
538 So, the only sensible thing we can do for now is set the
539 resulting range to VR_VARYING. TODO, would having symbolic -INF
540 and +INF values be worth the trouble? */
541 if (TREE_TYPE (type))
543 if (cond_code == LE_EXPR || cond_code == LT_EXPR)
545 tree type_min = TYPE_MIN_VALUE (type);
546 int cmp = compare_values (limit, type_min);
548 /* For < or <= comparisons, if LIMIT is smaller than
549 TYPE_MIN, set the range to VR_VARYING. */
550 if (cmp == -1 || cmp == 0)
552 set_value_range_to_varying (vr_p);
553 return;
556 else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
558 tree type_max = TYPE_MIN_VALUE (type);
559 int cmp = compare_values (limit, type_max);
561 /* For > or >= comparisons, if LIMIT is bigger than
562 TYPE_MAX, set the range to VR_VARYING. */
563 if (cmp == 1 || cmp == 0)
565 set_value_range_to_varying (vr_p);
566 return;
571 if (TREE_CODE (cond) == NE_EXPR)
572 set_value_range (vr_p, VR_ANTI_RANGE, limit, limit);
573 else if (TREE_CODE (cond) == LE_EXPR)
574 set_value_range (vr_p, VR_RANGE, TYPE_MIN_VALUE (type), limit);
575 else if (TREE_CODE (cond) == LT_EXPR)
577 tree one = build_int_cst (type, 1);
578 set_value_range (vr_p, VR_RANGE, TYPE_MIN_VALUE (type),
579 fold (build (MINUS_EXPR, type, limit, one)));
581 else if (TREE_CODE (cond) == GE_EXPR)
582 set_value_range (vr_p, VR_RANGE, limit, TYPE_MAX_VALUE (type));
583 else if (TREE_CODE (cond) == GT_EXPR)
585 tree one = build_int_cst (type, 1);
586 set_value_range (vr_p, VR_RANGE,
587 fold (build (PLUS_EXPR, type, limit, one)),
588 TYPE_MAX_VALUE (type));
590 else
591 gcc_unreachable ();
593 /* If VAR already has a known range and the two ranges have a
594 non-empty intersection, we can refine the resulting range.
595 Since the assert expression creates an equivalency and at the
596 same time it asserts a predicate, we can take the intersection of
597 the two ranges to get better precision. */
598 var_vr = get_value_range (var);
599 if (var_vr->type == VR_RANGE
600 && vr_p->type == VR_RANGE
601 && value_ranges_intersect_p (var_vr, vr_p))
603 tree min, max;
605 /* Use the larger of the two minimums. */
606 if (compare_values (vr_p->min, var_vr->min) == -1)
607 min = var_vr->min;
608 else
609 min = vr_p->min;
611 /* Use the smaller of the two maximums. */
612 if (compare_values (vr_p->max, var_vr->max) == 1)
613 max = var_vr->max;
614 else
615 max = vr_p->max;
617 set_value_range (vr_p, vr_p->type, min, max);
622 /* Extract range information from SSA name VAR and store it in VR. If
623 VAR has an interesting range, use it. Otherwise, create the
624 range [VAR, VAR] and return it. This is useful in situations where
625 we may have conditionals testing values of VARYING names. For
626 instance,
628 x_3 = y_5;
629 if (x_3 > y_5)
632 Even if y_5 is deemed VARYING, we can determine that x_3 > y_5 is
633 always false. */
635 static void
636 extract_range_from_ssa_name (value_range *vr, tree var)
638 value_range *var_vr = get_value_range (var);
640 if (var_vr->type != VR_UNDEFINED && var_vr->type != VR_VARYING)
641 *vr = *var_vr;
642 else
643 set_value_range (vr, VR_RANGE, var, var);
647 /* Extract range information from a binary expression EXPR based on
648 the ranges of each of its operands and the expression code. */
650 static void
651 extract_range_from_binary_expr (value_range *vr, tree expr)
653 enum tree_code code = TREE_CODE (expr);
654 tree op0, op1, min, max;
655 value_range vr0, vr1;
656 int cmp;
658 /* Not all binary expressions can be applied to ranges in a
659 meaningful way. Handle only arithmetic operations. */
660 if (code != PLUS_EXPR
661 && code != MINUS_EXPR
662 && code != MULT_EXPR
663 && code != TRUNC_DIV_EXPR
664 && code != FLOOR_DIV_EXPR
665 && code != CEIL_DIV_EXPR
666 && code != EXACT_DIV_EXPR
667 && code != ROUND_DIV_EXPR
668 && code != MIN_EXPR
669 && code != MAX_EXPR)
671 set_value_range_to_varying (vr);
672 return;
675 /* Get value ranges for each operand. For constant operands, create
676 a new value range with the operand to simplify processing. */
677 op0 = TREE_OPERAND (expr, 0);
678 if (TREE_CODE (op0) == SSA_NAME)
679 vr0 = *(get_value_range (op0));
680 else
682 if (is_gimple_min_invariant (op0))
683 set_value_range (&vr0, VR_RANGE, op0, op0);
684 else
685 set_value_range_to_varying (&vr0);
688 op1 = TREE_OPERAND (expr, 1);
689 if (TREE_CODE (op1) == SSA_NAME)
690 vr1 = *(get_value_range (op1));
691 else
693 if (is_gimple_min_invariant (op1))
694 set_value_range (&vr1, VR_RANGE, op1, op1);
695 else
696 set_value_range_to_varying (&vr1);
699 /* If either range is UNDEFINED, so is the result. */
700 if (vr0.type == VR_UNDEFINED || vr1.type == VR_UNDEFINED)
702 set_value_range (vr, VR_UNDEFINED, NULL_TREE, NULL_TREE);
703 return;
706 /* If either range is VARYING, so is the result. */
707 if (vr0.type == VR_VARYING || vr1.type == VR_VARYING)
709 set_value_range_to_varying (vr);
710 return;
713 /* If the ranges are of different types, the result is VARYING. */
714 if (vr0.type != vr1.type)
716 set_value_range_to_varying (vr);
717 return;
720 /* TODO. Refuse to do any symbolic range operations for now. */
721 if (symbolic_range_p (&vr0) || symbolic_range_p (&vr1))
723 set_value_range_to_varying (vr);
724 return;
727 /* Now evaluate the expression to determine the new range. */
728 if (POINTER_TYPE_P (TREE_TYPE (expr))
729 || POINTER_TYPE_P (TREE_TYPE (op0))
730 || POINTER_TYPE_P (TREE_TYPE (op1)))
732 /* For pointer types, we are really only interested in asserting
733 whether the expression evaluates to non-NULL. FIXME. We
734 used to gcc_assert (code == PLUS_EXPR || code == MINUS_EXPR),
735 but ivopts is generating expressions with pointer
736 multiplication in them. */
737 if (code == PLUS_EXPR)
739 /* Assume that pointers can never wrap around. FIXME, Is
740 this always safe? */
741 tree zero = build_int_cst (TREE_TYPE (expr), 0);
742 set_value_range (vr, VR_ANTI_RANGE, zero, zero);
744 else
746 /* Subtracting from a pointer, may yield 0, so just drop the
747 resulting range to varying. */
748 set_value_range_to_varying (vr);
751 return;
754 /* For integer ranges, apply the operation to each end of the
755 range and see what we end up with. */
756 if (code == PLUS_EXPR
757 || code == MULT_EXPR
758 || code == MIN_EXPR
759 || code == MAX_EXPR)
761 /* For operations that make the resulting range directly
762 proportional to the original ranges, apply the operation to
763 the same end of each range. */
764 min = int_const_binop (code, vr0.min, vr1.min, 0);
765 max = int_const_binop (code, vr0.max, vr1.max, 0);
767 else
769 /* For operations that make the resulting range inversely
770 proportional to the original ranges (-, /), apply the
771 operation to the opposite ends of each range. */
772 min = int_const_binop (code, vr0.min, vr1.max, 0);
773 max = int_const_binop (code, vr0.max, vr1.min, 0);
776 cmp = compare_values (min, max);
777 if (cmp == -2 || cmp == 1)
779 /* If the new range has its limits swapped around (MIN > MAX),
780 then the operation caused one of them to wrap around, mark
781 the new range VARYING. */
782 set_value_range_to_varying (vr);
784 else
785 set_value_range (vr, vr0.type, min, max);
789 /* Like expr_computes_nonzero, but this function uses value ranges
790 obtained so far. */
792 static bool
793 vrp_expr_computes_nonzero (tree expr)
795 if (expr_computes_nonzero (expr))
796 return true;
798 /* If we have an expression of the form &X->a, then the expression
799 is nonnull if X is nonnull. */
800 if (TREE_CODE (expr) == ADDR_EXPR)
802 tree base = get_base_address (TREE_OPERAND (expr, 0));
804 if (base != NULL_TREE
805 && TREE_CODE (base) == INDIRECT_REF
806 && TREE_CODE (TREE_OPERAND (base, 0)) == SSA_NAME)
808 value_range *vr = get_value_range (TREE_OPERAND (base, 0));
809 if (range_is_nonnull (vr))
810 return true;
814 return false;
818 /* Extract range information from a unary expression EXPR based on
819 the range of its operand and the expression code. */
821 static void
822 extract_range_from_unary_expr (value_range *vr, tree expr)
824 enum tree_code code = TREE_CODE (expr);
825 tree min, max, op0;
826 value_range vr0;
827 int cmp;
829 /* Get value ranges for the operand. For constant operands, create
830 a new value range with the operand to simplify processing. */
831 op0 = TREE_OPERAND (expr, 0);
832 if (TREE_CODE (op0) == SSA_NAME)
833 vr0 = *(get_value_range (op0));
834 else
836 if (is_gimple_min_invariant (op0))
837 set_value_range (&vr0, VR_RANGE, op0, op0);
838 else
839 set_value_range_to_varying (&vr0);
842 /* If VR0 is UNDEFINED, so is the result. */
843 if (vr0.type == VR_UNDEFINED)
845 set_value_range (vr, VR_UNDEFINED, NULL_TREE, NULL_TREE);
846 return;
849 /* If VR0 is VARYING, so is the result. */
850 if (vr0.type == VR_VARYING)
852 set_value_range_to_varying (vr);
853 return;
856 /* TODO. Refuse to do any symbolic range operations for now. */
857 if (symbolic_range_p (&vr0))
859 set_value_range_to_varying (vr);
860 return;
863 /* If the operand is neither a pointer nor an integral type, set the
864 range to VARYING. TODO, we may set the range to non-zero. */
865 if (!INTEGRAL_TYPE_P (TREE_TYPE (op0))
866 && !POINTER_TYPE_P (TREE_TYPE (op0)))
868 set_value_range_to_varying (vr);
869 return;
872 /* If the expression involves pointers, we are only interested in
873 determining if it evaluates to NULL [0, 0] or non-NULL (~[0, 0]). */
874 if (POINTER_TYPE_P (TREE_TYPE (expr)) || POINTER_TYPE_P (TREE_TYPE (op0)))
876 if (range_is_nonnull (&vr0) || expr_computes_nonzero (expr))
877 set_value_range_to_nonnull (vr, TREE_TYPE (expr));
878 else if (range_is_null (&vr0))
879 set_value_range_to_null (vr, TREE_TYPE (expr));
880 else
881 set_value_range_to_varying (vr);
883 return;
886 /* Handle unary expressions on integer ranges. */
887 if ((code == NOP_EXPR || code == CONVERT_EXPR)
888 && (TYPE_SIZE (TREE_TYPE (vr0.min)) != TYPE_SIZE (TREE_TYPE (expr))))
890 /* When converting types of different sizes, set the result to
891 VARYING. Things like sign extensions and precision loss may
892 change the range. For instance, if x_3 is of type 'long long
893 int' and 'y_5 = (unsigned short) x_3', if x_3 is ~[0, 0], it
894 is impossible to know at compile time whether y_5 will be
895 ~[0, 0]. */
896 set_value_range_to_varying (vr);
897 return;
900 /* Apply the operation to each end of the range and see what we end
901 up with. */
902 min = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
903 max = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
905 cmp = compare_values (min, max);
906 if (cmp == -2 || cmp == 1)
908 /* If the new range has its limits swapped around (MIN > MAX),
909 then the operation caused one of them to wrap around, mark
910 the new range VARYING. */
911 set_value_range_to_varying (vr);
913 else
914 set_value_range (vr, vr0.type, min, max);
918 /* Try to compute a useful range out of expression EXPR and store it
919 in *VR_P. */
921 static void
922 extract_range_from_expr (value_range *vr, tree expr)
924 enum tree_code code = TREE_CODE (expr);
926 if (code == ASSERT_EXPR)
927 extract_range_from_assert (vr, expr);
928 else if (code == SSA_NAME)
929 extract_range_from_ssa_name (vr, expr);
930 else if (TREE_CODE_CLASS (code) == tcc_binary)
931 extract_range_from_binary_expr (vr, expr);
932 else if (TREE_CODE_CLASS (code) == tcc_unary)
933 extract_range_from_unary_expr (vr, expr);
934 else if (vrp_expr_computes_nonzero (expr))
935 set_value_range_to_nonnull (vr, TREE_TYPE (expr));
936 else if (TREE_CODE (expr) == INTEGER_CST)
937 set_value_range (vr, VR_RANGE, expr, expr);
938 else
939 set_value_range_to_varying (vr);
943 /* Given a range VR, a loop L and a variable VAR, determine whether it
944 would be profitable to adjust VR using scalar evolution information
945 for VAR. If so, update VR with the new limits. */
947 static void
948 adjust_range_with_scev (value_range *vr, struct loop *l, tree var)
950 tree init, step, chrec;
951 bool init_is_max;
953 /* TODO. Don't adjust anti-ranges. An anti-range may provide
954 better opportunities than a regular range, but I'm not sure. */
955 if (vr->type == VR_ANTI_RANGE)
956 return;
958 chrec = analyze_scalar_evolution (l, var);
959 if (TREE_CODE (chrec) != POLYNOMIAL_CHREC)
960 return;
962 init = CHREC_LEFT (chrec);
963 step = CHREC_RIGHT (chrec);
965 /* If STEP is symbolic, we can't know whether INIT will be the
966 minimum or maximum value in the range. */
967 if (!is_gimple_min_invariant (step))
968 return;
970 /* FIXME. When dealing with unsigned types,
971 analyze_scalar_evolution sets STEP to very large unsigned values
972 when the evolution goes backwards. This confuses this analysis
973 because we think that INIT is the smallest value that the range
974 can take, instead of the largest. Ignore these chrecs for now. */
975 if (INTEGRAL_TYPE_P (TREE_TYPE (step)) && TYPE_UNSIGNED (TREE_TYPE (step)))
976 return;
978 /* If STEP is negative, then INIT is the maximum value the range
979 will take. Otherwise, INIT is the minimum value. */
980 init_is_max = (tree_int_cst_sgn (step) < 0);
982 if (!POINTER_TYPE_P (TREE_TYPE (init))
983 && (vr->type == VR_VARYING || vr->type == VR_UNDEFINED))
985 /* For VARYING or UNDEFINED ranges, just about anything we get
986 from scalar evolutions should be better. */
987 if (init_is_max)
988 set_value_range (vr, VR_RANGE, TYPE_MIN_VALUE (TREE_TYPE (init)), init);
989 else
990 set_value_range (vr, VR_RANGE, init, TYPE_MAX_VALUE (TREE_TYPE (init)));
992 else if (vr->type == VR_RANGE)
994 tree min = vr->min;
995 tree max = vr->max;
997 if (init_is_max)
999 /* INIT is the maximum value. If INIT is lower than VR->MAX
1000 but no smaller than VR->MIN, set VR->MAX to INIT. */
1001 if (compare_values (init, max) == -1)
1003 max = init;
1005 /* If we just created an invalid range with the minimum
1006 greater than the maximum, take the minimum all the
1007 way to -INF. */
1008 if (compare_values (min, max) == 1)
1009 min = TYPE_MIN_VALUE (TREE_TYPE (min));
1012 else
1014 /* If INIT is bigger than VR->MIN, set VR->MIN to INIT. */
1015 if (compare_values (init, min) == 1)
1017 min = init;
1019 /* If we just created an invalid range with the minimum
1020 greater than the maximum, take the maximum all the
1021 way to +INF. */
1022 if (compare_values (min, max) == 1)
1023 max = TYPE_MAX_VALUE (TREE_TYPE (max));
1027 set_value_range (vr, VR_RANGE, min, max);
1032 /* Given two numeric value ranges VR0, VR1 and a comparison code COMP:
1034 - Return BOOLEAN_TRUE_NODE if VR0 COMP VR1 always returns true for all the
1035 values in the ranges.
1037 - Return BOOLEAN_FALSE_NODE if the comparison always returns false.
1039 - Return NULL_TREE if it is not always possible to determine the value of
1040 the comparison. */
1042 static tree
1043 compare_ranges (enum tree_code comp, value_range *vr0, value_range *vr1)
1045 /* VARYING or UNDEFINED ranges cannot be compared. */
1046 if (vr0->type == VR_VARYING
1047 || vr0->type == VR_UNDEFINED
1048 || vr1->type == VR_VARYING
1049 || vr1->type == VR_UNDEFINED)
1050 return NULL_TREE;
1052 /* Anti-ranges need to be handled separately. */
1053 if (vr0->type == VR_ANTI_RANGE || vr1->type == VR_ANTI_RANGE)
1055 /* If both are anti-ranges, then we cannot compute any
1056 comparison. */
1057 if (vr0->type == VR_ANTI_RANGE && vr1->type == VR_ANTI_RANGE)
1058 return NULL_TREE;
1060 /* These comparisons are never statically computable. */
1061 if (comp == GT_EXPR
1062 || comp == GE_EXPR
1063 || comp == LT_EXPR
1064 || comp == LE_EXPR)
1065 return NULL_TREE;
1067 /* Equality can be computed only between a range and an
1068 anti-range. ~[VAL1, VAL2] == [VAL1, VAL2] is always false. */
1069 if (vr0->type == VR_RANGE)
1071 /* To simplify processing, make VR0 the anti-range. */
1072 value_range *tmp = vr0;
1073 vr0 = vr1;
1074 vr1 = tmp;
1077 gcc_assert (comp == NE_EXPR || comp == EQ_EXPR);
1079 if (compare_values (vr0->min, vr1->min) == 0
1080 && compare_values (vr0->max, vr1->max) == 0)
1081 return (comp == NE_EXPR) ? boolean_true_node : boolean_false_node;
1083 return NULL_TREE;
1086 /* Simplify processing. If COMP is GT_EXPR or GE_EXPR, switch the
1087 operands around and change the comparison code. */
1088 if (comp == GT_EXPR || comp == GE_EXPR)
1090 value_range *tmp;
1091 comp = (comp == GT_EXPR) ? LT_EXPR : LE_EXPR;
1092 tmp = vr0;
1093 vr0 = vr1;
1094 vr1 = tmp;
1097 if (comp == EQ_EXPR)
1099 /* Equality may only be computed if both ranges represent
1100 exactly one value. */
1101 if (compare_values (vr0->min, vr0->max) == 0
1102 && compare_values (vr1->min, vr1->max) == 0)
1104 int cmp_min = compare_values (vr0->min, vr1->min);
1105 int cmp_max = compare_values (vr0->max, vr1->max);
1106 if (cmp_min == 0 && cmp_max == 0)
1107 return boolean_true_node;
1108 else if (cmp_min != -2 && cmp_max != -2)
1109 return boolean_false_node;
1112 return NULL_TREE;
1114 else if (comp == NE_EXPR)
1116 int cmp1, cmp2;
1118 /* If VR0 is completely to the left or completely to the right
1119 of VR1, they are always different. Notice that we need to
1120 make sure that both comparisons yield similar results to
1121 avoid comparing values that cannot be compared at
1122 compile-time. */
1123 cmp1 = compare_values (vr0->max, vr1->min);
1124 cmp2 = compare_values (vr0->min, vr1->max);
1125 if ((cmp1 == -1 && cmp2 == -1) || (cmp1 == 1 && cmp2 == 1))
1126 return boolean_true_node;
1128 /* If VR0 and VR1 represent a single value and are identical,
1129 return false. */
1130 else if (compare_values (vr0->min, vr0->max) == 0
1131 && compare_values (vr1->min, vr1->max) == 0
1132 && compare_values (vr0->min, vr1->min) == 0
1133 && compare_values (vr0->max, vr1->max) == 0)
1134 return boolean_false_node;
1136 /* Otherwise, they may or may not be different. */
1137 else
1138 return NULL_TREE;
1140 else if (comp == LT_EXPR || comp == LE_EXPR)
1142 int tst;
1144 /* If VR0 is to the left of VR1, return true. */
1145 tst = compare_values (vr0->max, vr1->min);
1146 if ((comp == LT_EXPR && tst == -1)
1147 || (comp == LE_EXPR && (tst == -1 || tst == 0)))
1148 return boolean_true_node;
1150 /* If VR0 is to the right of VR1, return false. */
1151 tst = compare_values (vr0->min, vr1->max);
1152 if ((comp == LT_EXPR && (tst == 0 || tst == 1))
1153 || (comp == LE_EXPR && tst == 1))
1154 return boolean_false_node;
1156 /* Otherwise, we don't know. */
1157 return NULL_TREE;
1160 gcc_unreachable ();
1164 /* Given a value range VR, a value VAL and a comparison code COMP, return
1165 BOOLEAN_TRUE_NODE if VR COMP VR1 always returns true for all the
1166 values in VR. Return BOOLEAN_FALSE_NODE if the comparison
1167 always returns false. Return NULL_TREE if it is not always
1168 possible to determine the value of the comparison. */
1170 static tree
1171 compare_range_with_value (enum tree_code comp, value_range *vr, tree val)
1173 if (vr->type == VR_VARYING || vr->type == VR_UNDEFINED)
1174 return NULL_TREE;
1176 /* Anti-ranges need to be handled separately. */
1177 if (vr->type == VR_ANTI_RANGE)
1179 /* For anti-ranges, the only predicates that we can compute at
1180 compile time are equality and inequality. */
1181 if (comp == GT_EXPR
1182 || comp == GE_EXPR
1183 || comp == LT_EXPR
1184 || comp == LE_EXPR)
1185 return NULL_TREE;
1187 /* ~[VAL, VAL] == VAL is always false. */
1188 if (compare_values (vr->min, val) == 0
1189 && compare_values (vr->max, val) == 0)
1190 return (comp == NE_EXPR) ? boolean_true_node : boolean_false_node;
1192 return NULL_TREE;
1195 if (comp == EQ_EXPR)
1197 /* EQ_EXPR may only be computed if VR represents exactly
1198 one value. */
1199 if (compare_values (vr->min, vr->max) == 0)
1201 int cmp = compare_values (vr->min, val);
1202 if (cmp == 0)
1203 return boolean_true_node;
1204 else if (cmp == -1 || cmp == 1 || cmp == 2)
1205 return boolean_false_node;
1207 else if (compare_values (val, vr->min) == -1
1208 || compare_values (vr->max, val) == -1)
1209 return boolean_false_node;
1211 return NULL_TREE;
1213 else if (comp == NE_EXPR)
1215 /* If VAL is not inside VR, then they are always different. */
1216 if (compare_values (vr->max, val) == -1
1217 || compare_values (vr->min, val) == 1)
1218 return boolean_true_node;
1220 /* If VR represents exactly one value equal to VAL, then return
1221 false. */
1222 if (compare_values (vr->min, vr->max) == 0
1223 && compare_values (vr->min, val) == 0)
1224 return boolean_false_node;
1226 /* Otherwise, they may or may not be different. */
1227 return NULL_TREE;
1229 else if (comp == LT_EXPR || comp == LE_EXPR)
1231 int tst;
1233 /* If VR is to the left of VAL, return true. */
1234 tst = compare_values (vr->max, val);
1235 if ((comp == LT_EXPR && tst == -1)
1236 || (comp == LE_EXPR && (tst == -1 || tst == 0)))
1237 return boolean_true_node;
1239 /* If VR is to the right of VAL, return false. */
1240 tst = compare_values (vr->min, val);
1241 if ((comp == LT_EXPR && (tst == 0 || tst == 1))
1242 || (comp == LE_EXPR && tst == 1))
1243 return boolean_false_node;
1245 /* Otherwise, we don't know. */
1246 return NULL_TREE;
1248 else if (comp == GT_EXPR || comp == GE_EXPR)
1250 int tst;
1252 /* If VR is to the right of VAL, return true. */
1253 tst = compare_values (vr->min, val);
1254 if ((comp == GT_EXPR && tst == 1)
1255 || (comp == GE_EXPR && (tst == 0 || tst == 1)))
1256 return boolean_true_node;
1258 /* If VR is to the left of VAL, return false. */
1259 tst = compare_values (vr->max, val);
1260 if ((comp == GT_EXPR && (tst == -1 || tst == 0))
1261 || (comp == GE_EXPR && tst == -1))
1262 return boolean_false_node;
1264 /* Otherwise, we don't know. */
1265 return NULL_TREE;
1268 gcc_unreachable ();
1272 /* Debugging dumps. */
1274 void
1275 dump_value_range (FILE *file, value_range *vr)
1277 if (vr == NULL)
1278 fprintf (file, "[]");
1279 else if (vr->type == VR_UNDEFINED)
1280 fprintf (file, "UNDEFINED");
1281 else if (vr->type == VR_RANGE || vr->type == VR_ANTI_RANGE)
1283 fprintf (file, "%s[", (vr->type == VR_ANTI_RANGE) ? "~" : "");
1284 print_generic_expr (file, vr->min, 0);
1285 fprintf (file, ", ");
1286 print_generic_expr (file, vr->max, 0);
1287 fprintf (file, "]");
1289 else if (vr->type == VR_VARYING)
1290 fprintf (file, "VARYING");
1291 else
1292 fprintf (file, "INVALID RANGE");
1296 /* Dump value range VR to stderr. */
1298 void
1299 debug_value_range (value_range *vr)
1301 dump_value_range (stderr, vr);
1305 /* Dump value ranges of all SSA_NAMEs to FILE. */
1307 void
1308 dump_all_value_ranges (FILE *file)
1310 size_t i;
1312 for (i = 0; i < num_ssa_names; i++)
1314 tree var = ssa_name (i);
1315 if (var && SSA_NAME_VALUE_RANGE (var))
1317 print_generic_expr (file, var, 0);
1318 fprintf (file, ": ");
1319 dump_value_range (file, SSA_NAME_VALUE_RANGE (var));
1320 fprintf (file, "\n");
1324 fprintf (file, "\n");
1328 /* Dump all value ranges to stderr. */
1330 void
1331 debug_all_value_ranges (void)
1333 dump_all_value_ranges (stderr);
1337 /*---------------------------------------------------------------------------
1338 Value Range Propagation
1339 ---------------------------------------------------------------------------*/
1341 /* Given a COND_EXPR COND of the form 'V OP W', and an SSA name V,
1342 create a new SSA name N and return the assertion assignment
1343 'V = ASSERT_EXPR <V, V OP W>'. */
1345 static tree
1346 build_assert_expr_for (tree cond, tree v)
1348 tree n, assertion;
1350 gcc_assert (TREE_CODE (v) == SSA_NAME);
1351 n = duplicate_ssa_name (v, NULL_TREE);
1353 if (COMPARISON_CLASS_P (cond))
1355 /* Build N = ASSERT_EXPR <V, COND>. As a special case, if the
1356 conditional is an EQ_EXPR (V == Z), just build the assignment
1357 N = Z. */
1358 if (TREE_CODE (cond) == EQ_EXPR)
1360 tree other = get_opposite_operand (cond, v);
1361 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, other);
1363 else
1364 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n,
1365 build (ASSERT_EXPR, TREE_TYPE (v), v, cond));
1367 else if (TREE_CODE (cond) == TRUTH_NOT_EXPR)
1369 /* Given !V, build the assignment N = false. */
1370 tree op0 = TREE_OPERAND (cond, 0);
1371 gcc_assert (op0 == v);
1372 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, boolean_false_node);
1374 else if (TREE_CODE (cond) == SSA_NAME)
1376 /* Given V, build the assignment N = true. */
1377 gcc_assert (v == cond);
1378 assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, boolean_true_node);
1380 else
1381 gcc_unreachable ();
1383 SSA_NAME_DEF_STMT (n) = assertion;
1385 /* The new ASSERT_EXPR, creates a new SSA name that replaces the
1386 operand of the ASSERT_EXPR. Register the new name and the old one
1387 in the replacement table so that we can fix the SSA web after
1388 adding all the ASSERT_EXPRs. */
1389 register_new_name_mapping (n, v);
1391 return assertion;
1395 /* Return false if EXPR is a predicate expression involving floating
1396 point values. */
1398 static inline bool
1399 fp_predicate (tree expr)
1401 return (COMPARISON_CLASS_P (expr)
1402 && FLOAT_TYPE_P (TREE_TYPE (TREE_OPERAND (expr, 0))));
1406 /* Return an expression predicate that represents the range of values
1407 that can be taken by operand OP after STMT executes. */
1409 static tree
1410 infer_value_range (tree stmt, tree op)
1412 /* Do not attempt to infer anything in names that flow through
1413 abnormal edges. */
1414 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (op))
1415 return NULL_TREE;
1417 if (POINTER_TYPE_P (TREE_TYPE (op)))
1419 bool is_store;
1420 unsigned num_uses, num_derefs;
1422 count_uses_and_derefs (op, stmt, &num_uses, &num_derefs, &is_store);
1423 if (num_derefs > 0 && flag_delete_null_pointer_checks)
1425 /* We can only assume that a pointer dereference will yield
1426 non-NULL if -fdelete-null-pointer-checks is enabled. */
1427 tree null = build_int_cst (TREE_TYPE (op), 0);
1428 tree t = build (NE_EXPR, boolean_type_node, op, null);
1429 return t;
1433 return NULL_TREE;
1437 /* Return true if OP is the result of an ASSERT_EXPR that tests the
1438 same condition as COND. */
1440 static bool
1441 has_assert_expr (tree op, tree cond)
1443 tree def_stmt = SSA_NAME_DEF_STMT (op);
1444 tree assert_expr, other_cond, other_op;
1446 /* If OP was not generated by an ASSERT_EXPR, return false. */
1447 if (TREE_CODE (def_stmt) != MODIFY_EXPR
1448 || TREE_CODE (TREE_OPERAND (def_stmt, 1)) != ASSERT_EXPR)
1449 return false;
1451 assert_expr = TREE_OPERAND (def_stmt, 1);
1452 other_cond = ASSERT_EXPR_COND (assert_expr);
1453 other_op = ASSERT_EXPR_VAR (assert_expr);
1455 if (TREE_CODE (cond) == TREE_CODE (other_cond))
1457 tree t1, t2;
1459 /* If COND is not a comparison predicate, something is wrong. */
1460 gcc_assert (COMPARISON_CLASS_P (cond));
1462 /* Note that we only need to compare against one of the operands
1463 of OTHER_COND.
1465 Suppose that we are about to insert the assertion ASSERT_EXPR
1466 <x_4, x_4 != 0> and the defining statement for x_4 is x_4 =
1467 ASSERT_EXPR <x_3, x_3 != 0>.
1469 In this case, we don't really want to insert a new
1470 ASSERT_EXPR for x_4 because that would be redundant. We
1471 already know that x_4 is not 0. So, when comparing the
1472 conditionals 'x_3 != 0' and 'x_4 != 0', we don't want to
1473 compare x_3 and x_4, we just want to compare the predicate's
1474 code (!=) and the other operand (0). */
1475 if (TREE_OPERAND (cond, 0) == op)
1476 t1 = TREE_OPERAND (cond, 1);
1477 else
1478 t1 = TREE_OPERAND (cond, 0);
1480 if (TREE_OPERAND (other_cond, 0) == other_op)
1481 t2 = TREE_OPERAND (other_cond, 1);
1482 else
1483 t2 = TREE_OPERAND (other_cond, 0);
1485 return (t1 == t2 || operand_equal_p (t1, t2, 0));
1488 return false;
1492 /* Traverse all the statements in block BB looking for used variables.
1493 Variables used in BB are added to bitmap FOUND. The algorithm
1494 works in three main parts:
1496 1- For every statement S in BB, all the variables used by S are
1497 added to bitmap FOUND.
1499 2- If statement S uses an operand N in a way that exposes a known
1500 value range for N, then if N was not already generated by an
1501 ASSERT_EXPR, create a new ASSERT_EXPR for N. For instance, if N
1502 is a pointer and the statement dereferences it, we can assume
1503 that N is not NULL.
1505 3- COND_EXPRs are a special case of #2. We can derive range
1506 information from the predicate but need to insert different
1507 ASSERT_EXPRs for each of the sub-graphs rooted at the
1508 conditional block. If the last statement of BB is a conditional
1509 expression of the form 'X op Y', then
1511 a) Remove X and Y from the set FOUND.
1513 b) If the conditional dominates its THEN_CLAUSE sub-graph,
1514 recurse into it. On return, if X and/or Y are marked in
1515 FOUND, then an ASSERT_EXPR is added for the corresponding
1516 variable.
1518 c) Repeat step (b) on the ELSE_CLAUSE.
1520 d) Mark X and Y in FOUND.
1522 4- If BB does not end in a conditional expression, then we recurse
1523 into BB's dominator children.
1525 At the end of the recursive traversal, ASSERT_EXPRs will have been
1526 added to the edges of COND_EXPR blocks that have sub-graphs using
1527 one or both predicate operands. For instance,
1529 if (a == 9)
1530 b = a;
1531 else
1532 b = c + 1;
1534 In this case, an assertion on the THEN clause is useful to
1535 determine that 'a' is always 9 on that edge. However, an assertion
1536 on the ELSE clause would be unnecessary.
1538 On exit from this function, all the names created by the newly
1539 inserted ASSERT_EXPRs need to be added to the SSA web by rewriting
1540 the SSA names that they replace.
1542 TODO. Handle SWITCH_EXPR. */
1544 static bool
1545 maybe_add_assert_expr (basic_block bb)
1547 block_stmt_iterator si;
1548 tree last;
1549 bool added;
1551 /* Step 1. Mark all the SSA names used in BB in bitmap FOUND. */
1552 added = false;
1553 last = NULL_TREE;
1554 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
1556 tree stmt, op;
1557 ssa_op_iter i;
1559 stmt = bsi_stmt (si);
1561 /* Mark all the SSA names used by STMT in bitmap FOUND. If STMT
1562 is inside the sub-graph of a conditional block, when we
1563 return from this recursive walk, our parent will use the
1564 FOUND bitset to determine if one of the operands it was
1565 looking for was present in the sub-graph. */
1566 FOR_EACH_SSA_TREE_OPERAND (op, stmt, i, SSA_OP_USE)
1568 tree cond;
1570 /* If OP is used only once, namely in this STMT, don't
1571 bother inserting an ASSERT_EXPR for it. Such an
1572 ASSERT_EXPR would do nothing but increase compile time.
1573 Experiments show that with this simple check, we can save
1574 more than 20% of ASSERT_EXPRs. */
1575 if (has_single_use (op))
1576 continue;
1578 SET_BIT (found, SSA_NAME_VERSION (op));
1580 cond = infer_value_range (stmt, op);
1581 if (!cond)
1582 continue;
1584 /* Step 2. If OP is used in such a way that we can infer a
1585 value range for it, create a new ASSERT_EXPR for OP
1586 (unless OP already has an ASSERT_EXPR). */
1587 gcc_assert (!is_ctrl_stmt (stmt));
1589 if (has_assert_expr (op, cond))
1590 continue;
1592 if (!stmt_ends_bb_p (stmt))
1594 /* If STMT does not end the block, we can insert the new
1595 assertion right after it. */
1596 tree t = build_assert_expr_for (cond, op);
1597 bsi_insert_after (&si, t, BSI_NEW_STMT);
1598 added = true;
1600 else
1602 /* STMT must be the last statement in BB. We can only
1603 insert new assertions on the non-abnormal edge out of
1604 BB. Note that since STMT is not control flow, there
1605 may only be one non-abnormal edge out of BB. */
1606 edge_iterator ei;
1607 edge e;
1609 FOR_EACH_EDGE (e, ei, bb->succs)
1610 if (!(e->flags & EDGE_ABNORMAL))
1612 tree t = build_assert_expr_for (cond, op);
1613 bsi_insert_on_edge (e, t);
1614 added = true;
1615 break;
1620 /* Remember the last statement of the block. */
1621 last = stmt;
1624 /* Step 3. If BB's last statement is a conditional expression
1625 involving integer operands, recurse into each of the sub-graphs
1626 rooted at BB to determine if we need to add ASSERT_EXPRs.
1627 Notice that we only care about the first operand of the
1628 conditional. Adding assertions for both operands may actually
1629 hinder VRP. FIXME, add example. */
1630 if (last
1631 && TREE_CODE (last) == COND_EXPR
1632 && !fp_predicate (COND_EXPR_COND (last))
1633 && !ZERO_SSA_OPERANDS (last, SSA_OP_USE))
1635 edge e;
1636 edge_iterator ei;
1637 tree op, cond;
1638 basic_block son;
1639 ssa_op_iter iter;
1641 cond = COND_EXPR_COND (last);
1643 /* Get just the first use operand. */
1644 FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
1645 break;
1646 gcc_assert (op != NULL);
1648 /* Do not attempt to infer anything in names that flow through
1649 abnormal edges. */
1650 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (op))
1651 return false;
1653 /* Remove the COND_EXPR operand from the FOUND bitmap.
1654 Otherwise, when we finish traversing each of the sub-graphs,
1655 we won't know whether the variables were found in the
1656 sub-graphs or if they had been found in a block upstream from
1657 BB. */
1658 RESET_BIT (found, SSA_NAME_VERSION (op));
1660 /* Look for uses of the operands in each of the sub-graphs
1661 rooted at BB. We need to check each of the outgoing edges
1662 separately, so that we know what kind of ASSERT_EXPR to
1663 insert. */
1664 FOR_EACH_EDGE (e, ei, bb->succs)
1666 /* If BB strictly dominates the sub-graph at E->DEST,
1667 recurse into it. */
1668 if (e->dest != bb
1669 && dominated_by_p (CDI_DOMINATORS, e->dest, bb))
1670 added |= maybe_add_assert_expr (e->dest);
1672 /* Once we traversed the sub-graph, check if any block inside
1673 used either of the predicate's operands. If so, add the
1674 appropriate ASSERT_EXPR. */
1675 if (TEST_BIT (found, SSA_NAME_VERSION (op)))
1677 /* We found a use of OP in the sub-graph rooted at
1678 E->DEST. Add an ASSERT_EXPR according to whether
1679 E goes to THEN_CLAUSE or ELSE_CLAUSE. */
1680 tree c, t;
1682 if (e->flags & EDGE_TRUE_VALUE)
1683 c = unshare_expr (cond);
1684 else if (e->flags & EDGE_FALSE_VALUE)
1685 c = invert_truthvalue (cond);
1686 else
1687 gcc_unreachable ();
1689 t = build_assert_expr_for (c, op);
1690 bsi_insert_on_edge (e, t);
1691 added = true;
1695 /* Finally, mark all the COND_EXPR operands as found. */
1696 SET_BIT (found, SSA_NAME_VERSION (op));
1698 /* Recurse into the dominator children of BB that are not BB's
1699 immediate successors. Note that we have already visited BB's
1700 other dominator children above. */
1701 for (son = first_dom_son (CDI_DOMINATORS, bb);
1702 son;
1703 son = next_dom_son (CDI_DOMINATORS, son))
1705 if (find_edge (bb, son) == NULL)
1706 added |= maybe_add_assert_expr (son);
1709 else
1711 /* Step 4. Recurse into the dominator children of BB. */
1712 basic_block son;
1714 for (son = first_dom_son (CDI_DOMINATORS, bb);
1715 son;
1716 son = next_dom_son (CDI_DOMINATORS, son))
1717 added |= maybe_add_assert_expr (son);
1720 return added;
1724 /* Traverse the flowgraph looking for conditional jumps to insert range
1725 expressions. These range expressions are meant to provide information
1726 to optimizations that need to reason in terms of value ranges. They
1727 will not be expanded into RTL. For instance, given:
1729 x = ...
1730 y = ...
1731 if (x < y)
1732 y = x - 2;
1733 else
1734 x = y + 3;
1736 this pass will transform the code into:
1738 x = ...
1739 y = ...
1740 if (x < y)
1742 x = ASSERT_EXPR <x, x < y>
1743 y = x - 2
1745 else
1747 y = ASSERT_EXPR <y, x <= y>
1748 x = y + 3
1751 The idea is that once copy and constant propagation have run, other
1752 optimizations will be able to determine what ranges of values can 'x'
1753 take in different paths of the code, simply by checking the reaching
1754 definition of 'x'. */
1756 static void
1757 insert_range_assertions (void)
1759 edge e;
1760 edge_iterator ei;
1761 bool update_ssa_p;
1763 found = sbitmap_alloc (num_ssa_names);
1764 sbitmap_zero (found);
1766 calculate_dominance_info (CDI_DOMINATORS);
1768 update_ssa_p = false;
1769 FOR_EACH_EDGE (e, ei, ENTRY_BLOCK_PTR->succs)
1770 if (maybe_add_assert_expr (e->dest))
1771 update_ssa_p = true;
1773 if (update_ssa_p)
1775 bsi_commit_edge_inserts ();
1776 update_ssa (TODO_update_ssa_no_phi);
1779 if (dump_file && (dump_flags & TDF_DETAILS))
1781 fprintf (dump_file, "\nSSA form after inserting ASSERT_EXPRs\n");
1782 dump_function_to_file (current_function_decl, dump_file, dump_flags);
1785 sbitmap_free (found);
1789 /* Convert range assertion expressions into copies. FIXME, explain why. */
1791 static void
1792 remove_range_assertions (void)
1794 basic_block bb;
1795 block_stmt_iterator si;
1797 FOR_EACH_BB (bb)
1798 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
1800 tree stmt = bsi_stmt (si);
1802 if (TREE_CODE (stmt) == MODIFY_EXPR
1803 && TREE_CODE (TREE_OPERAND (stmt, 1)) == ASSERT_EXPR)
1805 tree rhs = TREE_OPERAND (stmt, 1);
1806 tree cond = fold (ASSERT_EXPR_COND (rhs));
1807 gcc_assert (cond != boolean_false_node);
1808 TREE_OPERAND (stmt, 1) = ASSERT_EXPR_VAR (rhs);
1809 update_stmt (stmt);
1815 /* Return true if STMT is interesting for VRP. */
1817 static bool
1818 stmt_interesting_for_vrp (tree stmt)
1820 if (TREE_CODE (stmt) == PHI_NODE
1821 && is_gimple_reg (PHI_RESULT (stmt))
1822 && (INTEGRAL_TYPE_P (TREE_TYPE (PHI_RESULT (stmt)))
1823 || POINTER_TYPE_P (TREE_TYPE (PHI_RESULT (stmt)))))
1824 return true;
1825 else if (TREE_CODE (stmt) == MODIFY_EXPR)
1827 tree lhs = TREE_OPERAND (stmt, 0);
1829 if (TREE_CODE (lhs) == SSA_NAME
1830 && (INTEGRAL_TYPE_P (TREE_TYPE (lhs))
1831 || POINTER_TYPE_P (TREE_TYPE (lhs)))
1832 && ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS))
1833 return true;
1835 else if (TREE_CODE (stmt) == COND_EXPR || TREE_CODE (stmt) == SWITCH_EXPR)
1836 return true;
1838 return false;
1842 /* Initialize local data structures for VRP. Return true if VRP
1843 is worth running (i.e. if we found any statements that could
1844 benefit from range information). */
1846 static bool
1847 vrp_initialize (void)
1849 basic_block bb;
1850 bool do_vrp;
1852 /* If we don't find any ASSERT_EXPRs in the code, there's no point
1853 running VRP. */
1854 do_vrp = false;
1856 FOR_EACH_BB (bb)
1858 block_stmt_iterator si;
1859 tree phi;
1861 for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
1863 if (!stmt_interesting_for_vrp (phi))
1865 tree lhs = PHI_RESULT (phi);
1866 set_value_range_to_varying (get_value_range (lhs));
1867 DONT_SIMULATE_AGAIN (phi) = true;
1869 else
1870 DONT_SIMULATE_AGAIN (phi) = false;
1873 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
1875 tree stmt = bsi_stmt (si);
1877 if (!stmt_interesting_for_vrp (stmt))
1879 ssa_op_iter i;
1880 tree def;
1881 FOR_EACH_SSA_TREE_OPERAND (def, stmt, i, SSA_OP_DEF)
1882 set_value_range_to_varying (get_value_range (def));
1883 DONT_SIMULATE_AGAIN (stmt) = true;
1885 else
1887 if (TREE_CODE (stmt) == MODIFY_EXPR
1888 && TREE_CODE (TREE_OPERAND (stmt, 1)) == ASSERT_EXPR)
1889 do_vrp = true;
1891 DONT_SIMULATE_AGAIN (stmt) = false;
1896 return do_vrp;
1900 /* Visit assignment STMT. If it produces an interesting range, record
1901 the SSA name in *OUTPUT_P. */
1903 static enum ssa_prop_result
1904 vrp_visit_assignment (tree stmt, tree *output_p)
1906 tree lhs, rhs, def;
1907 ssa_op_iter iter;
1909 lhs = TREE_OPERAND (stmt, 0);
1910 rhs = TREE_OPERAND (stmt, 1);
1912 /* We only keep track of ranges in integral and pointer types. */
1913 if (TREE_CODE (lhs) == SSA_NAME
1914 && (INTEGRAL_TYPE_P (TREE_TYPE (lhs))
1915 || POINTER_TYPE_P (TREE_TYPE (lhs))))
1917 value_range *vr, new_vr;
1918 struct loop *l;
1920 vr = get_value_range (lhs);
1921 extract_range_from_expr (&new_vr, rhs);
1923 /* If STMT is inside a loop, we may be able to know something
1924 else about the range of LHS by examining scalar evolution
1925 information. */
1926 if (cfg_loops && (l = loop_containing_stmt (stmt)))
1927 adjust_range_with_scev (&new_vr, l, lhs);
1929 if (update_value_range (vr, new_vr.type, new_vr.min, new_vr.max))
1931 *output_p = lhs;
1933 if (dump_file && (dump_flags & TDF_DETAILS))
1935 fprintf (dump_file, "Found new range ");
1936 dump_value_range (dump_file, &new_vr);
1937 fprintf (dump_file, " for ");
1938 print_generic_expr (dump_file, lhs, 0);
1939 fprintf (dump_file, "\n\n");
1942 if (new_vr.type == VR_VARYING)
1943 return SSA_PROP_VARYING;
1945 return SSA_PROP_INTERESTING;
1948 return SSA_PROP_NOT_INTERESTING;
1951 /* Every other statements produces no useful ranges. */
1952 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
1953 set_value_range_to_varying (get_value_range (def));
1955 return SSA_PROP_VARYING;
1959 /* Given a conditional predicate COND, try to determine if COND yields
1960 true or false based on the value ranges of its operands. */
1962 static tree
1963 vrp_evaluate_conditional (tree cond)
1965 gcc_assert (TREE_CODE (cond) == SSA_NAME
1966 || TREE_CODE_CLASS (TREE_CODE (cond)) == tcc_comparison);
1968 if (TREE_CODE (cond) == SSA_NAME)
1970 /* For SSA names, only return a truth value if the range is
1971 known and contains exactly one value. */
1972 value_range *vr = SSA_NAME_VALUE_RANGE (cond);
1973 if (vr && vr->type == VR_RANGE && vr->min == vr->max)
1974 return vr->min;
1976 else
1978 /* For comparisons, evaluate each operand and compare their
1979 ranges. */
1980 tree op0, op1;
1981 value_range *vr0, *vr1;
1983 op0 = TREE_OPERAND (cond, 0);
1984 vr0 = (TREE_CODE (op0) == SSA_NAME) ? get_value_range (op0) : NULL;
1986 op1 = TREE_OPERAND (cond, 1);
1987 vr1 = (TREE_CODE (op1) == SSA_NAME) ? get_value_range (op1) : NULL;
1989 if (vr0 && vr1)
1990 return compare_ranges (TREE_CODE (cond), vr0, vr1);
1991 else if (vr0 && vr1 == NULL)
1992 return compare_range_with_value (TREE_CODE (cond), vr0, op1);
1993 else if (vr0 == NULL && vr1)
1994 return compare_range_with_value (opposite_comparison (TREE_CODE (cond)),
1995 vr1, op0);
1998 /* Anything else cannot be computed statically. */
1999 return NULL_TREE;
2003 /* Visit conditional statement STMT. If we can determine which edge
2004 will be taken out of STMT's basic block, record it in
2005 *TAKEN_EDGE_P and return SSA_PROP_INTERESTING. Otherwise, return
2006 SSA_PROP_VARYING. */
2008 static enum ssa_prop_result
2009 vrp_visit_cond_stmt (tree stmt, edge *taken_edge_p)
2011 tree cond, val;
2013 *taken_edge_p = NULL;
2015 /* FIXME. Handle SWITCH_EXPRs. But first, the assert pass needs to
2016 add ASSERT_EXPRs for them. */
2017 if (TREE_CODE (stmt) == SWITCH_EXPR)
2018 return SSA_PROP_VARYING;
2020 cond = COND_EXPR_COND (stmt);
2022 if (dump_file && (dump_flags & TDF_DETAILS))
2024 tree use;
2025 ssa_op_iter i;
2027 fprintf (dump_file, "\nVisiting conditional with predicate: ");
2028 print_generic_expr (dump_file, cond, 0);
2029 fprintf (dump_file, "\nWith known ranges\n");
2031 FOR_EACH_SSA_TREE_OPERAND (use, stmt, i, SSA_OP_USE)
2033 fprintf (dump_file, "\t");
2034 print_generic_expr (dump_file, use, 0);
2035 fprintf (dump_file, ": ");
2036 dump_value_range (dump_file, SSA_NAME_VALUE_RANGE (use));
2039 fprintf (dump_file, "\n");
2042 /* Compute the value of the predicate COND by checking the known
2043 ranges of each of its operands. */
2044 val = vrp_evaluate_conditional (cond);
2045 if (val)
2046 *taken_edge_p = find_taken_edge (bb_for_stmt (stmt), val);
2048 if (dump_file && (dump_flags & TDF_DETAILS))
2050 fprintf (dump_file, "\nPredicate evaluates to: ");
2051 if (val == NULL_TREE)
2052 fprintf (dump_file, "DON'T KNOW\n");
2053 else
2054 print_generic_stmt (dump_file, val, 0);
2057 return (*taken_edge_p) ? SSA_PROP_INTERESTING : SSA_PROP_VARYING;
2061 /* Evaluate statement STMT. If the statement produces a useful range,
2062 return SSA_PROP_INTERESTING and record the SSA name with the
2063 interesting range into *OUTPUT_P.
2065 If STMT is a conditional branch and we can determine its truth
2066 value, the taken edge is recorded in *TAKEN_EDGE_P.
2068 If STMT produces a varying value, return SSA_PROP_VARYING. */
2070 static enum ssa_prop_result
2071 vrp_visit_stmt (tree stmt, edge *taken_edge_p, tree *output_p)
2073 tree def;
2074 ssa_op_iter iter;
2075 stmt_ann_t ann;
2077 if (dump_file && (dump_flags & TDF_DETAILS))
2079 fprintf (dump_file, "\nVisiting statement:\n");
2080 print_generic_stmt (dump_file, stmt, dump_flags);
2081 fprintf (dump_file, "\n");
2084 ann = stmt_ann (stmt);
2085 if (TREE_CODE (stmt) == MODIFY_EXPR
2086 && ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS))
2087 return vrp_visit_assignment (stmt, output_p);
2088 else if (TREE_CODE (stmt) == COND_EXPR || TREE_CODE (stmt) == SWITCH_EXPR)
2089 return vrp_visit_cond_stmt (stmt, taken_edge_p);
2091 /* All other statements produce nothing of interest for VRP, so mark
2092 their outputs varying and prevent further simulation. */
2093 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
2094 set_value_range_to_varying (get_value_range (def));
2096 return SSA_PROP_VARYING;
2100 /* Meet operation for value ranges. Given two value ranges VR0 and
2101 VR1, store in VR0 the result of meeting VR0 and VR1.
2103 The meeting rules are as follows:
2105 1- If VR0 and VR1 have an empty intersection, set VR0 to VR_VARYING.
2107 2- If VR0 and VR1 have a non-empty intersection, set VR0 to the
2108 union of VR0 and VR1. */
2110 static void
2111 vrp_meet (value_range *vr0, value_range *vr1)
2113 if (vr0->type == VR_UNDEFINED)
2115 *vr0 = *vr1;
2116 return;
2119 if (vr1->type == VR_UNDEFINED)
2121 /* Nothing to do. VR0 already has the resulting range. */
2122 return;
2125 if (vr0->type == VR_VARYING)
2127 /* Nothing to do. VR0 already has the resulting range. */
2128 return;
2131 if (vr1->type == VR_VARYING)
2133 *vr0 = *vr1;
2134 return;
2137 /* If either is a symbolic range, drop to VARYING. */
2138 if (symbolic_range_p (vr0) || symbolic_range_p (vr1))
2140 set_value_range_to_varying (vr0);
2141 return;
2144 if (vr0->type == VR_RANGE && vr1->type == VR_RANGE)
2146 /* If VR0 and VR1 have a non-empty intersection, compute the
2147 union of both ranges. */
2148 if (value_ranges_intersect_p (vr0, vr1))
2150 tree min, max;
2152 min = vr0->min;
2153 max = vr0->max;
2155 /* The lower limit of the new range is the minimum of the
2156 two ranges. */
2157 if (compare_values (vr0->min, vr1->min) == 1)
2158 min = vr1->min;
2160 /* The upper limit of the new range is the maximum of the
2161 two ranges. */
2162 if (compare_values (vr0->max, vr1->max) == -1)
2163 max = vr1->max;
2165 set_value_range (vr0, vr0->type, min, max);
2167 else
2169 /* The two ranges don't intersect, set the result to VR_VARYING. */
2170 set_value_range_to_varying (vr0);
2173 else if (vr0->type == VR_ANTI_RANGE && vr1->type == VR_ANTI_RANGE)
2175 /* Two anti-ranges meet only if they are both identical. */
2176 if (compare_values (vr0->min, vr1->min) == 0
2177 && compare_values (vr0->max, vr1->max) == 0
2178 && compare_values (vr0->min, vr0->max) == 0)
2179 /* Nothing to do. */ ;
2180 else
2181 set_value_range_to_varying (vr0);
2183 else if (vr0->type == VR_ANTI_RANGE || vr1->type == VR_ANTI_RANGE)
2185 /* A range [VAL1, VAL2] and an anti-range ~[VAL3, VAL4] meet
2186 only if the ranges have an empty intersection. The result of
2187 the meet operation is the anti-range. */
2188 if (!value_ranges_intersect_p (vr0, vr1))
2190 if (vr1->type == VR_ANTI_RANGE)
2191 *vr0 = *vr1;
2193 else
2194 set_value_range_to_varying (vr0);
2196 else
2197 gcc_unreachable ();
2201 /* Visit all arguments for PHI node PHI that flow through executable
2202 edges. If a valid value range can be derived from all the incoming
2203 value ranges, set a new range for the LHS of PHI. */
2205 static enum ssa_prop_result
2206 vrp_visit_phi_node (tree phi)
2208 int i;
2209 tree lhs = PHI_RESULT (phi);
2210 value_range *lhs_vr = get_value_range (lhs);
2211 value_range vr_result = *lhs_vr;
2213 if (dump_file && (dump_flags & TDF_DETAILS))
2215 fprintf (dump_file, "\nVisiting PHI node: ");
2216 print_generic_expr (dump_file, phi, dump_flags);
2219 for (i = 0; i < PHI_NUM_ARGS (phi); i++)
2221 edge e = PHI_ARG_EDGE (phi, i);
2223 if (dump_file && (dump_flags & TDF_DETAILS))
2225 fprintf (dump_file,
2226 "\n Argument #%d (%d -> %d %sexecutable)\n",
2227 i, e->src->index, e->dest->index,
2228 (e->flags & EDGE_EXECUTABLE) ? "" : "not ");
2231 if (e->flags & EDGE_EXECUTABLE)
2233 tree arg = PHI_ARG_DEF (phi, i);
2234 value_range vr_arg;
2236 if (TREE_CODE (arg) == SSA_NAME)
2237 vr_arg = *(get_value_range (arg));
2238 else
2240 vr_arg.type = VR_RANGE;
2241 vr_arg.min = arg;
2242 vr_arg.max = arg;
2245 if (dump_file && (dump_flags & TDF_DETAILS))
2247 fprintf (dump_file, "\t");
2248 print_generic_expr (dump_file, arg, dump_flags);
2249 fprintf (dump_file, "\n\tValue: ");
2250 dump_value_range (dump_file, &vr_arg);
2251 fprintf (dump_file, "\n");
2254 vrp_meet (&vr_result, &vr_arg);
2256 if (vr_result.type == VR_VARYING)
2257 break;
2261 if (vr_result.type == VR_VARYING)
2263 set_value_range_to_varying (lhs_vr);
2264 return SSA_PROP_VARYING;
2267 /* To prevent infinite iterations in the algorithm, derive ranges
2268 when the new value is slightly bigger or smaller than the
2269 previous one. */
2270 if (lhs_vr->type == VR_RANGE)
2272 if (!POINTER_TYPE_P (TREE_TYPE (lhs)))
2274 int cmp_min = compare_values (lhs_vr->min, vr_result.min);
2275 int cmp_max = compare_values (lhs_vr->max, vr_result.max);
2277 /* If the new minimum is smaller or larger than the previous
2278 one, go all the way to -INF. In the first case, to avoid
2279 iterating millions of times to reach -INF, and in the
2280 other case to avoid infinite bouncing between different
2281 minimums. */
2282 if (cmp_min > 0 || cmp_min < 0)
2283 vr_result.min = TYPE_MIN_VALUE (TREE_TYPE (vr_result.min));
2285 /* Similarly, if the new maximum is smaller or larger than
2286 the previous one, go all the way to +INF. */
2287 if (cmp_max < 0 || cmp_max > 0)
2288 vr_result.max = TYPE_MAX_VALUE (TREE_TYPE (vr_result.max));
2290 /* If we ended up with a (-INF, +INF) range, set it to
2291 VARYING. */
2292 if (vr_result.min == TYPE_MIN_VALUE (TREE_TYPE (vr_result.min))
2293 && vr_result.max == TYPE_MAX_VALUE (TREE_TYPE (vr_result.max)))
2295 set_value_range_to_varying (lhs_vr);
2296 return SSA_PROP_VARYING;
2301 /* If the new range is different than the previous value, keep
2302 iterating. */
2303 if (update_value_range (lhs_vr, vr_result.type, vr_result.min, vr_result.max))
2304 return SSA_PROP_INTERESTING;
2306 /* Nothing changed, don't add outgoing edges. */
2307 return SSA_PROP_NOT_INTERESTING;
2311 /* Traverse all the blocks folding conditionals with known ranges. */
2313 static void
2314 vrp_finalize (void)
2316 basic_block bb;
2317 int num_pred_folded = 0;
2319 if (dump_file)
2321 fprintf (dump_file, "\nValue ranges after VRP:\n\n");
2322 dump_all_value_ranges (dump_file);
2323 fprintf (dump_file, "\n");
2326 FOR_EACH_BB (bb)
2328 tree last = last_stmt (bb);
2329 if (last && TREE_CODE (last) == COND_EXPR)
2331 tree val = vrp_evaluate_conditional (COND_EXPR_COND (last));
2332 if (val)
2334 if (dump_file)
2336 fprintf (dump_file, "Folding predicate ");
2337 print_generic_expr (dump_file, COND_EXPR_COND (last), 0);
2338 fprintf (dump_file, " to ");
2339 print_generic_expr (dump_file, val, 0);
2340 fprintf (dump_file, "\n");
2343 num_pred_folded++;
2344 COND_EXPR_COND (last) = val;
2345 update_stmt (last);
2350 if (dump_file && (dump_flags & TDF_STATS))
2351 fprintf (dump_file, "\nNumber of predicates folded: %d\n\n",
2352 num_pred_folded);
2356 /* Main entry point to VRP (Value Range Propagation). This pass is
2357 loosely based on J. R. C. Patterson, ``Accurate Static Branch
2358 Prediction by Value Range Propagation,'' in SIGPLAN Conference on
2359 Programming Language Design and Implementation, pp. 67-78, 1995.
2360 Also available at http://citeseer.ist.psu.edu/patterson95accurate.html
2362 This is essentially an SSA-CCP pass modified to deal with ranges
2363 instead of constants.
2365 TODO, the main difference between this pass and Patterson's is that
2366 we do not propagate edge probabilities. We only compute whether
2367 edges can be taken or not. That is, instead of having a spectrum
2368 of jump probabilities between 0 and 1, we only deal with 0, 1 and
2369 DON'T KNOW. In the future, it may be worthwhile to propagate
2370 probabilities to aid branch prediction. */
2372 static void
2373 execute_vrp (void)
2375 insert_range_assertions ();
2377 cfg_loops = loop_optimizer_init (NULL);
2378 if (cfg_loops)
2379 scev_initialize (cfg_loops);
2381 if (vrp_initialize ())
2383 ssa_propagate (vrp_visit_stmt, vrp_visit_phi_node);
2384 vrp_finalize ();
2387 if (cfg_loops)
2389 scev_finalize ();
2390 loop_optimizer_finalize (cfg_loops, NULL);
2391 current_loops = NULL;
2394 remove_range_assertions ();
2397 static bool
2398 gate_vrp (void)
2400 return flag_tree_vrp != 0;
2403 struct tree_opt_pass pass_vrp =
2405 "vrp", /* name */
2406 gate_vrp, /* gate */
2407 execute_vrp, /* execute */
2408 NULL, /* sub */
2409 NULL, /* next */
2410 0, /* static_pass_number */
2411 TV_TREE_VRP, /* tv_id */
2412 PROP_ssa | PROP_alias, /* properties_required */
2413 0, /* properties_provided */
2414 0, /* properties_destroyed */
2415 0, /* todo_flags_start */
2416 TODO_cleanup_cfg
2417 | TODO_ggc_collect
2418 | TODO_verify_ssa
2419 | TODO_dump_func
2420 | TODO_update_ssa, /* todo_flags_finish */
2421 0 /* letter */