OSDN Git Service

PR 23604
[pf3gnuchains/gcc-fork.git] / gcc / tree-vrp.c
1 /* Support routines for Value Range Propagation (VRP).
2    Copyright (C) 2005 Free Software Foundation, Inc.
3    Contributed by Diego Novillo <dnovillo@redhat.com>.
4
5 This file is part of GCC.
6
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.
11
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.
16
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.  */
21
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"
39
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;
43
44 /* Loop structure of the program.  Used to analyze scalar evolutions
45    inside adjust_range_with_scev.  */
46 static struct loops *cfg_loops;
47
48 /* Local functions.  */
49 static int compare_values (tree val1, tree val2);
50
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
57 {
58   /* Basic block where the assertion would be inserted.  */
59   basic_block bb;
60
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;
64
65   /* Pointer to the statement that generated this assertion.  */
66   block_stmt_iterator si;
67
68   /* Predicate code for the ASSERT_EXPR.  Must be COMPARISON_CLASS_P.  */
69   enum tree_code comp_code;
70
71   /* Value being compared against.  */
72   tree val;
73
74   /* Next node in the linked list.  */
75   struct assert_locus_d *next;
76 };
77
78 typedef struct assert_locus_d *assert_locus_t;
79
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;
83
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;
88
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;
92
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;
96
97
98 /* Return true if ARG is marked with the nonnull attribute in the
99    current function signature.  */
100
101 static bool
102 nonnull_arg_p (tree arg)
103 {
104   tree t, attrs, fntype;
105   unsigned HOST_WIDE_INT arg_num;
106
107   gcc_assert (TREE_CODE (arg) == PARM_DECL && POINTER_TYPE_P (TREE_TYPE (arg)));
108
109   fntype = TREE_TYPE (current_function_decl);
110   attrs = lookup_attribute ("nonnull", TYPE_ATTRIBUTES (fntype));
111
112   /* If "nonnull" wasn't specified, we know nothing about the argument.  */
113   if (attrs == NULL_TREE)
114     return false;
115
116   /* If "nonnull" applies to all the arguments, then ARG is non-null.  */
117   if (TREE_VALUE (attrs) == NULL_TREE)
118     return true;
119
120   /* Get the position number for ARG in the function signature.  */
121   for (arg_num = 1, t = DECL_ARGUMENTS (current_function_decl);
122        t;
123        t = TREE_CHAIN (t), arg_num++)
124     {
125       if (t == arg)
126         break;
127     }
128
129   gcc_assert (t == arg);
130
131   /* Now see if ARG_NUM is mentioned in the nonnull list.  */
132   for (t = TREE_VALUE (attrs); t; t = TREE_CHAIN (t))
133     {
134       if (compare_tree_int (TREE_VALUE (t), arg_num) == 0)
135         return true;
136     }
137
138   return false;
139 }
140
141
142 /* Set value range VR to {T, MIN, MAX, EQUIV}.  */
143
144 static void
145 set_value_range (value_range_t *vr, enum value_range_type t, tree min,
146                  tree max, bitmap equiv)
147 {
148 #if defined ENABLE_CHECKING
149   /* Check the validity of the range.  */
150   if (t == VR_RANGE || t == VR_ANTI_RANGE)
151     {
152       int cmp;
153
154       gcc_assert (min && max);
155
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)));
159
160       cmp = compare_values (min, max);
161       gcc_assert (cmp == 0 || cmp == -1 || cmp == -2);
162     }
163
164   if (t == VR_UNDEFINED || t == VR_VARYING)
165     gcc_assert (min == NULL_TREE && max == NULL_TREE);
166
167   if (t == VR_UNDEFINED || t == VR_VARYING)
168     gcc_assert (equiv == NULL || bitmap_empty_p (equiv));
169 #endif
170
171   vr->type = t;
172   vr->min = min;
173   vr->max = max;
174
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);
179
180   if (equiv != vr->equiv)
181     {
182       if (equiv && !bitmap_empty_p (equiv))
183         bitmap_copy (vr->equiv, equiv);
184       else
185         bitmap_clear (vr->equiv);
186     }
187 }
188
189
190 /* Copy value range FROM into value range TO.  */
191
192 static inline void
193 copy_value_range (value_range_t *to, value_range_t *from)
194 {
195   set_value_range (to, from->type, from->min, from->max, from->equiv);
196 }
197
198
199 /* Set value range VR to a non-NULL range of type TYPE.  */
200
201 static inline void
202 set_value_range_to_nonnull (value_range_t *vr, tree type)
203 {
204   tree zero = build_int_cst (type, 0);
205   set_value_range (vr, VR_ANTI_RANGE, zero, zero, vr->equiv);
206 }
207
208
209 /* Set value range VR to a NULL range of type TYPE.  */
210
211 static inline void
212 set_value_range_to_null (value_range_t *vr, tree type)
213 {
214   tree zero = build_int_cst (type, 0);
215   set_value_range (vr, VR_RANGE, zero, zero, vr->equiv);
216 }
217
218
219 /* Set value range VR to VR_VARYING.  */
220
221 static inline void
222 set_value_range_to_varying (value_range_t *vr)
223 {
224   vr->type = VR_VARYING;
225   vr->min = vr->max = NULL_TREE;
226   if (vr->equiv)
227     bitmap_clear (vr->equiv);
228 }
229
230
231 /* Set value range VR to VR_UNDEFINED.  */
232
233 static inline void
234 set_value_range_to_undefined (value_range_t *vr)
235 {
236   vr->type = VR_UNDEFINED;
237   vr->min = vr->max = NULL_TREE;
238   if (vr->equiv)
239     bitmap_clear (vr->equiv);
240 }
241
242
243 /* Return value range information for VAR.  Create an empty range
244    if none existed.  */
245
246 static value_range_t *
247 get_value_range (tree var)
248 {
249   value_range_t *vr;
250   tree sym;
251   unsigned ver = SSA_NAME_VERSION (var);
252
253   vr = vr_value[ver];
254   if (vr)
255     return vr;
256
257   /* Create a default value range.  */
258   vr_value[ver] = vr = xmalloc (sizeof (*vr));
259   memset (vr, 0, sizeof (*vr));
260
261   /* Allocate an equivalence set.  */
262   vr->equiv = BITMAP_ALLOC (NULL);
263
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))
268     {
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);
278     }
279
280   return vr;
281 }
282
283
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.
287
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.  */
293
294 static inline bool
295 update_value_range (tree var, value_range_t *new_vr)
296 {
297   value_range_t *old_vr;
298   bool is_new;
299
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));
308
309   if (is_new)
310     set_value_range (old_vr, new_vr->type, new_vr->min, new_vr->max,
311                      new_vr->equiv);
312
313   BITMAP_FREE (new_vr->equiv);
314   new_vr->equiv = NULL;
315
316   return is_new;
317 }
318
319
320 /* Add VAR and VAR's equivalence set to EQUIV.  */
321
322 static void
323 add_equivalence (bitmap equiv, tree var)
324 {
325   unsigned ver = SSA_NAME_VERSION (var);
326   value_range_t *vr = vr_value[ver];
327
328   bitmap_set_bit (equiv, ver);
329   if (vr && vr->equiv)
330     bitmap_ior_into (equiv, vr->equiv);
331 }
332
333
334 /* Return true if VR is ~[0, 0].  */
335
336 static inline bool
337 range_is_nonnull (value_range_t *vr)
338 {
339   return vr->type == VR_ANTI_RANGE
340          && integer_zerop (vr->min)
341          && integer_zerop (vr->max);
342 }
343
344
345 /* Return true if VR is [0, 0].  */
346
347 static inline bool
348 range_is_null (value_range_t *vr)
349 {
350   return vr->type == VR_RANGE
351          && integer_zerop (vr->min)
352          && integer_zerop (vr->max);
353 }
354
355
356 /* Return true if value range VR involves at least one symbol.  */
357
358 static inline bool
359 symbolic_range_p (value_range_t *vr)
360 {
361   return (!is_gimple_min_invariant (vr->min)
362           || !is_gimple_min_invariant (vr->max));
363 }
364
365
366 /* Like tree_expr_nonzero_p, but this function uses value ranges
367    obtained so far.  */
368
369 static bool
370 vrp_expr_computes_nonzero (tree expr)
371 {
372   if (tree_expr_nonzero_p (expr))
373     return true;
374
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)
378     {
379       tree base = get_base_address (TREE_OPERAND (expr, 0));
380
381       if (base != NULL_TREE
382           && TREE_CODE (base) == INDIRECT_REF
383           && TREE_CODE (TREE_OPERAND (base, 0)) == SSA_NAME)
384         {
385           value_range_t *vr = get_value_range (TREE_OPERAND (base, 0));
386           if (range_is_nonnull (vr))
387             return true;
388         }
389     }
390
391   return false;
392 }
393
394
395 /* Compare two values VAL1 and VAL2.  Return
396    
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
402
403    This is similar to tree_int_cst_compare but supports pointer values
404    and values that cannot be compared at compile time.  */
405
406 static int
407 compare_values (tree val1, tree val2)
408 {
409   if (val1 == val2)
410     return 0;
411
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)));
416
417   /* Do some limited symbolic comparisons.  */
418   if (!POINTER_TYPE_P (TREE_TYPE (val1)))
419     {
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)
424         {
425           /* +INF > NAME - CST.  */
426           return 1;
427         }
428       else if (val1 == TYPE_MIN_VALUE (TREE_TYPE (val1))
429                && TREE_CODE (val2) == PLUS_EXPR)
430         {
431           /* -INF < NAME + CST.  */
432           return -1;
433         }
434       else if (TREE_CODE (val1) == MINUS_EXPR
435                && val2 == TYPE_MAX_VALUE (TREE_TYPE (val2)))
436         {
437           /* NAME - CST < +INF.  */
438           return -1;
439         }
440       else if (TREE_CODE (val1) == PLUS_EXPR
441                && val2 == TYPE_MIN_VALUE (TREE_TYPE (val2)))
442         {
443           /* NAME + CST > -INF.  */
444           return 1;
445         }
446     }
447
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))
454     {
455       tree n1, c1, n2, c2;
456   
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)
461         {
462           n1 = val1;
463           c1 = NULL_TREE;
464         }
465       else
466         {
467           n1 = TREE_OPERAND (val1, 0);
468           c1 = TREE_OPERAND (val1, 1);
469         }
470
471       if (TREE_CODE (val2) == SSA_NAME)
472         {
473           n2 = val2;
474           c2 = NULL_TREE;
475         }
476       else
477         {
478           n2 = TREE_OPERAND (val2, 0);
479           c2 = TREE_OPERAND (val2, 1);
480         }
481
482       /* Both values must use the same name.  */
483       if (n1 != n2)
484         return -2;
485
486       if (TREE_CODE (val1) == SSA_NAME)
487         {
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;
497         }
498       else if (TREE_CODE (val1) == PLUS_EXPR)
499         {
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;
509         }
510       else if (TREE_CODE (val1) == MINUS_EXPR)
511         {
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);
522         }
523
524       gcc_unreachable ();
525     }
526
527   /* We cannot compare non-constants.  */
528   if (!is_gimple_min_invariant (val1) || !is_gimple_min_invariant (val2))
529     return -2;
530
531   /* We cannot compare overflowed values.  */
532   if (TREE_OVERFLOW (val1) || TREE_OVERFLOW (val2))
533     return -2;
534
535   if (!POINTER_TYPE_P (TREE_TYPE (val1)))
536     return tree_int_cst_compare (val1, val2);
537   else
538     {
539       tree t;
540
541       /* First see if VAL1 and VAL2 are not the same.  */
542       if (val1 == val2 || operand_equal_p (val1, val2, 0))
543         return 0;
544       
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;
549
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;
554
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;
559
560       return -2;
561     }
562 }
563
564
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.  */
568
569 static inline int
570 value_inside_range (tree val, value_range_t *vr)
571 {
572   int cmp1, cmp2;
573
574   cmp1 = compare_values (val, vr->min);
575   if (cmp1 == -2 || cmp1 == 2)
576     return -2;
577
578   cmp2 = compare_values (val, vr->max);
579   if (cmp2 == -2 || cmp2 == 2)
580     return -2;
581
582   return (cmp1 == 0 || cmp1 == 1) && (cmp2 == -1 || cmp2 == 0);
583 }
584
585
586 /* Return true if value ranges VR0 and VR1 have a non-empty
587    intersection.  */
588
589 static inline bool
590 value_ranges_intersect_p (value_range_t *vr0, value_range_t *vr1)
591 {
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);
596 }
597
598
599 /* Return true if VR includes the value zero, false otherwise.  */
600
601 static inline bool
602 range_includes_zero_p (value_range_t *vr)
603 {
604   tree zero;
605
606   gcc_assert (vr->type != VR_UNDEFINED
607               && vr->type != VR_VARYING
608               && !symbolic_range_p (vr));
609
610   zero = build_int_cst (TREE_TYPE (vr->min), 0);
611   return (value_inside_range (zero, vr) == 1);
612 }
613
614
615 /* Extract value range information from an ASSERT_EXPR EXPR and store
616    it in *VR_P.  */
617
618 static void
619 extract_range_from_assert (value_range_t *vr_p, tree expr)
620 {
621   tree var, cond, limit, min, max, type;
622   value_range_t *var_vr, *limit_vr;
623   enum tree_code cond_code;
624
625   var = ASSERT_EXPR_VAR (expr);
626   cond = ASSERT_EXPR_COND (expr);
627
628   gcc_assert (COMPARISON_CLASS_P (cond));
629
630   /* Find VAR in the ASSERT_EXPR conditional.  */
631   if (var == TREE_OPERAND (cond, 0))
632     {
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);
637     }
638   else
639     {
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));
645     }
646
647   type = TREE_TYPE (limit);
648   gcc_assert (limit != var);
649
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)
653     {
654       set_value_range_to_varying (vr_p);
655       return;
656     }
657
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;
662
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;
669
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.
673
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:
677
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>;
682
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.
687
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.
694          
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))
701     {
702       if (cond_code == LE_EXPR || cond_code == LT_EXPR)
703         {
704           tree type_min = TYPE_MIN_VALUE (type);
705           int cmp = compare_values (limit, type_min);
706
707           /* For < or <= comparisons, if LIMIT is smaller than
708              TYPE_MIN, set the range to VR_VARYING.  */
709           if (cmp == -1 || cmp == 0)
710             {
711               set_value_range_to_varying (vr_p);
712               return;
713             }
714         }
715       else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
716         {
717           tree type_max = TYPE_MIN_VALUE (type);
718           int cmp = compare_values (limit, type_max);
719
720           /* For > or >= comparisons, if LIMIT is bigger than
721              TYPE_MAX, set the range to VR_VARYING.  */
722           if (cmp == 1 || cmp == 0)
723             {
724               set_value_range_to_varying (vr_p);
725               return;
726             }
727         }
728     }
729
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);
734
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)
745     {
746       enum value_range_type range_type;
747
748       if (limit_vr)
749         {
750           range_type = limit_vr->type;
751           min = limit_vr->min;
752           max = limit_vr->max;
753         }
754       else
755         {
756           range_type = VR_RANGE;
757           min = limit;
758           max = limit;
759         }
760
761       set_value_range (vr_p, range_type, min, max, vr_p->equiv);
762
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);
768     }
769   else if (cond_code == NE_EXPR)
770     {
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
779          If LIMIT_VR is a range, we can only use it to build a new
780          anti-range if LIMIT_VR is a single-valued range.  For
781          instance, if LIMIT_VR is [0, 1], the predicate
782          VAR != [0, 1] does not mean that VAR's range is ~[0, 1].
783          Rather, it means that for value 0 VAR should be ~[0, 0]
784          and for value 1, VAR should be ~[1, 1].  We cannot
785          represent these ranges.
786
787          The only situation in which we can build a valid
788          anti-range is when LIMIT_VR is a single-valued range
789          (i.e., LIMIT_VR->MIN == LIMIT_VR->MAX).  In that case, 
790          build the anti-range ~[LIMIT_VR->MIN, LIMIT_VR->MAX].  */
791       if (limit_vr
792           && limit_vr->type == VR_RANGE
793           && compare_values (limit_vr->min, limit_vr->max) == 0)
794         {
795           min = limit_vr->min;
796           max = limit_vr->max;
797         }
798       else
799         {
800           /* In any other case, we cannot use LIMIT's range to build a
801              valid anti-range.  */
802           min = max = limit;
803         }
804
805       /* If MIN and MAX cover the whole range for their type, then
806          just use the original LIMIT.  */
807       if (INTEGRAL_TYPE_P (type)
808           && min == TYPE_MIN_VALUE (type)
809           && max == TYPE_MAX_VALUE (type))
810         min = max = limit;
811
812       set_value_range (vr_p, VR_ANTI_RANGE, min, max, vr_p->equiv);
813     }
814   else if (cond_code == LE_EXPR || cond_code == LT_EXPR)
815     {
816       min = TYPE_MIN_VALUE (type);
817
818       if (limit_vr == NULL || limit_vr->type == VR_ANTI_RANGE)
819         max = limit;
820       else
821         {
822           /* If LIMIT_VR is of the form [N1, N2], we need to build the
823              range [MIN, N2] for LE_EXPR and [MIN, N2 - 1] for
824              LT_EXPR.  */
825           max = limit_vr->max;
826         }
827
828       /* For LT_EXPR, we create the range [MIN, MAX - 1].  */
829       if (cond_code == LT_EXPR)
830         {
831           tree one = build_int_cst (type, 1);
832           max = fold_build2 (MINUS_EXPR, type, max, one);
833         }
834
835       set_value_range (vr_p, VR_RANGE, min, max, vr_p->equiv);
836     }
837   else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
838     {
839       max = TYPE_MAX_VALUE (type);
840
841       if (limit_vr == NULL || limit_vr->type == VR_ANTI_RANGE)
842         min = limit;
843       else
844         {
845           /* If LIMIT_VR is of the form [N1, N2], we need to build the
846              range [N1, MAX] for GE_EXPR and [N1 + 1, MAX] for
847              GT_EXPR.  */
848           min = limit_vr->min;
849         }
850
851       /* For GT_EXPR, we create the range [MIN + 1, MAX].  */
852       if (cond_code == GT_EXPR)
853         {
854           tree one = build_int_cst (type, 1);
855           min = fold_build2 (PLUS_EXPR, type, min, one);
856         }
857
858       set_value_range (vr_p, VR_RANGE, min, max, vr_p->equiv);
859     }
860   else
861     gcc_unreachable ();
862
863   /* If VAR already had a known range and the two ranges have a
864      non-empty intersection, we can refine the resulting range.
865      Since the assert expression creates an equivalency and at the
866      same time it asserts a predicate, we can take the intersection of
867      the two ranges to get better precision.  */
868   var_vr = get_value_range (var);
869   if (var_vr->type == VR_RANGE
870       && vr_p->type == VR_RANGE
871       && value_ranges_intersect_p (var_vr, vr_p))
872     {
873       /* Use the larger of the two minimums.  */
874       if (compare_values (vr_p->min, var_vr->min) == -1)
875         min = var_vr->min;
876       else
877         min = vr_p->min;
878
879       /* Use the smaller of the two maximums.  */
880       if (compare_values (vr_p->max, var_vr->max) == 1)
881         max = var_vr->max;
882       else
883         max = vr_p->max;
884
885       set_value_range (vr_p, vr_p->type, min, max, vr_p->equiv);
886     }
887 }
888
889
890 /* Extract range information from SSA name VAR and store it in VR.  If
891    VAR has an interesting range, use it.  Otherwise, create the
892    range [VAR, VAR] and return it.  This is useful in situations where
893    we may have conditionals testing values of VARYING names.  For
894    instance,
895
896         x_3 = y_5;
897         if (x_3 > y_5)
898           ...
899
900     Even if y_5 is deemed VARYING, we can determine that x_3 > y_5 is
901     always false.  */
902
903 static void
904 extract_range_from_ssa_name (value_range_t *vr, tree var)
905 {
906   value_range_t *var_vr = get_value_range (var);
907
908   if (var_vr->type != VR_UNDEFINED && var_vr->type != VR_VARYING)
909     copy_value_range (vr, var_vr);
910   else
911     set_value_range (vr, VR_RANGE, var, var, NULL);
912
913   add_equivalence (vr->equiv, var);
914 }
915
916
917 /* Wrapper around int_const_binop.  If the operation overflows and we
918    are not using wrapping arithmetic, then adjust the result to be
919    -INF or +INF depending on CODE, VAL1 and VAL2.  */
920
921 static inline tree
922 vrp_int_const_binop (enum tree_code code, tree val1, tree val2)
923 {
924   tree res;
925
926   if (flag_wrapv)
927     return int_const_binop (code, val1, val2, 0);
928
929   /* If we are not using wrapping arithmetic, operate symbolically
930      on -INF and +INF.  */
931   res = int_const_binop (code, val1, val2, 0);
932
933   if (TYPE_UNSIGNED (TREE_TYPE (val1)))
934     {
935       int checkz = compare_values (res, val1);
936
937       /* Ensure that res = val1 + val2 >= val1
938          or that res = val1 - val2 <= val1.  */
939       if ((code == PLUS_EXPR && !(checkz == 1 || checkz == 0))
940           || (code == MINUS_EXPR && !(checkz == 0 || checkz == -1)))
941         {
942           res = copy_node (res);
943           TREE_OVERFLOW (res) = 1;
944         }
945     }
946   /* If the operation overflowed but neither VAL1 nor VAL2 are
947      overflown, return -INF or +INF depending on the operation
948      and the combination of signs of the operands.  */
949   else if (TREE_OVERFLOW (res)
950            && !TREE_OVERFLOW (val1)
951            && !TREE_OVERFLOW (val2))
952     {
953       int sgn1 = tree_int_cst_sgn (val1);
954       int sgn2 = tree_int_cst_sgn (val2);
955
956       /* Notice that we only need to handle the restricted set of
957          operations handled by extract_range_from_binary_expr.
958          Among them, only multiplication, addition and subtraction
959          can yield overflow without overflown operands because we
960          are working with integral types only... except in the
961          case VAL1 = -INF and VAL2 = -1 which overflows to +INF
962          for division too.  */
963
964       /* For multiplication, the sign of the overflow is given
965          by the comparison of the signs of the operands.  */
966       if ((code == MULT_EXPR && sgn1 == sgn2)
967           /* For addition, the operands must be of the same sign
968              to yield an overflow.  Its sign is therefore that
969              of one of the operands, for example the first.  */
970           || (code == PLUS_EXPR && sgn1 > 0)
971           /* For subtraction, the operands must be of different
972              signs to yield an overflow.  Its sign is therefore
973              that of the first operand or the opposite of that
974              of the second operand.  A first operand of 0 counts
975              as positive here, for the corner case 0 - (-INF),
976              which overflows, but must yield +INF.  */
977           || (code == MINUS_EXPR && sgn1 >= 0)
978           /* For division, the only case is -INF / -1 = +INF.  */
979           || code == TRUNC_DIV_EXPR
980           || code == FLOOR_DIV_EXPR
981           || code == CEIL_DIV_EXPR
982           || code == EXACT_DIV_EXPR
983           || code == ROUND_DIV_EXPR)
984         return TYPE_MAX_VALUE (TREE_TYPE (res));
985       else
986         return TYPE_MIN_VALUE (TREE_TYPE (res));
987     }
988
989   return res;
990 }
991
992
993 /* Extract range information from a binary expression EXPR based on
994    the ranges of each of its operands and the expression code.  */
995
996 static void
997 extract_range_from_binary_expr (value_range_t *vr, tree expr)
998 {
999   enum tree_code code = TREE_CODE (expr);
1000   tree op0, op1, min, max;
1001   int cmp;
1002   value_range_t vr0 = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
1003   value_range_t vr1 = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
1004
1005   /* Not all binary expressions can be applied to ranges in a
1006      meaningful way.  Handle only arithmetic operations.  */
1007   if (code != PLUS_EXPR
1008       && code != MINUS_EXPR
1009       && code != MULT_EXPR
1010       && code != TRUNC_DIV_EXPR
1011       && code != FLOOR_DIV_EXPR
1012       && code != CEIL_DIV_EXPR
1013       && code != EXACT_DIV_EXPR
1014       && code != ROUND_DIV_EXPR
1015       && code != MIN_EXPR
1016       && code != MAX_EXPR
1017       && code != TRUTH_ANDIF_EXPR
1018       && code != TRUTH_ORIF_EXPR
1019       && code != TRUTH_AND_EXPR
1020       && code != TRUTH_OR_EXPR
1021       && code != TRUTH_XOR_EXPR)
1022     {
1023       set_value_range_to_varying (vr);
1024       return;
1025     }
1026
1027   /* Get value ranges for each operand.  For constant operands, create
1028      a new value range with the operand to simplify processing.  */
1029   op0 = TREE_OPERAND (expr, 0);
1030   if (TREE_CODE (op0) == SSA_NAME)
1031     vr0 = *(get_value_range (op0));
1032   else if (is_gimple_min_invariant (op0))
1033     set_value_range (&vr0, VR_RANGE, op0, op0, NULL);
1034   else
1035     set_value_range_to_varying (&vr0);
1036
1037   op1 = TREE_OPERAND (expr, 1);
1038   if (TREE_CODE (op1) == SSA_NAME)
1039     vr1 = *(get_value_range (op1));
1040   else if (is_gimple_min_invariant (op1))
1041     set_value_range (&vr1, VR_RANGE, op1, op1, NULL);
1042   else
1043     set_value_range_to_varying (&vr1);
1044
1045   /* If either range is UNDEFINED, so is the result.  */
1046   if (vr0.type == VR_UNDEFINED || vr1.type == VR_UNDEFINED)
1047     {
1048       set_value_range_to_undefined (vr);
1049       return;
1050     }
1051
1052   /* Refuse to operate on VARYING ranges, ranges of different kinds
1053      and symbolic ranges.  TODO, we may be able to derive anti-ranges
1054      in some cases.  */
1055   if (vr0.type == VR_VARYING
1056       || vr1.type == VR_VARYING
1057       || vr0.type != vr1.type
1058       || symbolic_range_p (&vr0)
1059       || symbolic_range_p (&vr1))
1060     {
1061       set_value_range_to_varying (vr);
1062       return;
1063     }
1064
1065   /* Now evaluate the expression to determine the new range.  */
1066   if (POINTER_TYPE_P (TREE_TYPE (expr))
1067       || POINTER_TYPE_P (TREE_TYPE (op0))
1068       || POINTER_TYPE_P (TREE_TYPE (op1)))
1069     {
1070       /* For pointer types, we are really only interested in asserting
1071          whether the expression evaluates to non-NULL.  FIXME, we used
1072          to gcc_assert (code == PLUS_EXPR || code == MINUS_EXPR), but
1073          ivopts is generating expressions with pointer multiplication
1074          in them.  */
1075       if (code == PLUS_EXPR)
1076         {
1077           if (range_is_nonnull (&vr0) || range_is_nonnull (&vr1))
1078             set_value_range_to_nonnull (vr, TREE_TYPE (expr));
1079           else if (range_is_null (&vr0) && range_is_null (&vr1))
1080             set_value_range_to_null (vr, TREE_TYPE (expr));
1081           else
1082             set_value_range_to_varying (vr);
1083         }
1084       else
1085         {
1086           /* Subtracting from a pointer, may yield 0, so just drop the
1087              resulting range to varying.  */
1088           set_value_range_to_varying (vr);
1089         }
1090
1091       return;
1092     }
1093
1094   /* For integer ranges, apply the operation to each end of the
1095      range and see what we end up with.  */
1096   if (code == TRUTH_ANDIF_EXPR
1097       || code == TRUTH_ORIF_EXPR
1098       || code == TRUTH_AND_EXPR
1099       || code == TRUTH_OR_EXPR
1100       || code == TRUTH_XOR_EXPR)
1101     {
1102       /* Boolean expressions cannot be folded with int_const_binop.  */
1103       min = fold_binary (code, TREE_TYPE (expr), vr0.min, vr1.min);
1104       max = fold_binary (code, TREE_TYPE (expr), vr0.max, vr1.max);
1105     }
1106   else if (code == PLUS_EXPR
1107            || code == MIN_EXPR
1108            || code == MAX_EXPR)
1109     {
1110       /* If we have a PLUS_EXPR with two VR_ANTI_RANGEs, drop to
1111          VR_VARYING.  It would take more effort to compute a precise
1112          range for such a case.  For example, if we have op0 == 1 and
1113          op1 == -1 with their ranges both being ~[0,0], we would have
1114          op0 + op1 == 0, so we cannot claim that the sum is in ~[0,0].
1115          Note that we are guaranteed to have vr0.type == vr1.type at
1116          this point.  */
1117       if (code == PLUS_EXPR && vr0.type == VR_ANTI_RANGE)
1118         {
1119           set_value_range_to_varying (vr);
1120           return;
1121         }
1122
1123       /* For operations that make the resulting range directly
1124          proportional to the original ranges, apply the operation to
1125          the same end of each range.  */
1126       min = vrp_int_const_binop (code, vr0.min, vr1.min);
1127       max = vrp_int_const_binop (code, vr0.max, vr1.max);
1128     }
1129   else if (code == MULT_EXPR
1130            || code == TRUNC_DIV_EXPR
1131            || code == FLOOR_DIV_EXPR
1132            || code == CEIL_DIV_EXPR
1133            || code == EXACT_DIV_EXPR
1134            || code == ROUND_DIV_EXPR)
1135     {
1136       tree val[4];
1137       size_t i;
1138
1139       /* If we have an unsigned MULT_EXPR with two VR_ANTI_RANGEs,
1140          drop to VR_VARYING.  It would take more effort to compute a
1141          precise range for such a case.  For example, if we have
1142          op0 == 65536 and op1 == 65536 with their ranges both being
1143          ~[0,0] on a 32-bit machine, we would have op0 * op1 == 0, so
1144          we cannot claim that the product is in ~[0,0].  Note that we
1145          are guaranteed to have vr0.type == vr1.type at this
1146          point.  */
1147       if (code == MULT_EXPR
1148           && vr0.type == VR_ANTI_RANGE
1149           && (flag_wrapv || TYPE_UNSIGNED (TREE_TYPE (op0))))
1150         {
1151           set_value_range_to_varying (vr);
1152           return;
1153         }
1154
1155       /* Multiplications and divisions are a bit tricky to handle,
1156          depending on the mix of signs we have in the two ranges, we
1157          need to operate on different values to get the minimum and
1158          maximum values for the new range.  One approach is to figure
1159          out all the variations of range combinations and do the
1160          operations.
1161
1162          However, this involves several calls to compare_values and it
1163          is pretty convoluted.  It's simpler to do the 4 operations
1164          (MIN0 OP MIN1, MIN0 OP MAX1, MAX0 OP MIN1 and MAX0 OP MAX0 OP
1165          MAX1) and then figure the smallest and largest values to form
1166          the new range.  */
1167
1168       /* Divisions by zero result in a VARYING value.  */
1169       if (code != MULT_EXPR
1170           && (vr0.type == VR_ANTI_RANGE || range_includes_zero_p (&vr1)))
1171         {
1172           set_value_range_to_varying (vr);
1173           return;
1174         }
1175
1176       /* Compute the 4 cross operations.  */
1177       val[0] = vrp_int_const_binop (code, vr0.min, vr1.min);
1178
1179       val[1] = (vr1.max != vr1.min)
1180                ? vrp_int_const_binop (code, vr0.min, vr1.max)
1181                : NULL_TREE;
1182
1183       val[2] = (vr0.max != vr0.min)
1184                ? vrp_int_const_binop (code, vr0.max, vr1.min)
1185                : NULL_TREE;
1186
1187       val[3] = (vr0.min != vr0.max && vr1.min != vr1.max)
1188                ? vrp_int_const_binop (code, vr0.max, vr1.max)
1189                : NULL_TREE;
1190
1191       /* Set MIN to the minimum of VAL[i] and MAX to the maximum
1192          of VAL[i].  */
1193       min = val[0];
1194       max = val[0];
1195       for (i = 1; i < 4; i++)
1196         {
1197           if (TREE_OVERFLOW (min) || TREE_OVERFLOW (max))
1198             break;
1199
1200           if (val[i])
1201             {
1202               if (TREE_OVERFLOW (val[i]))
1203                 {
1204                   /* If we found an overflowed value, set MIN and MAX
1205                      to it so that we set the resulting range to
1206                      VARYING.  */
1207                   min = max = val[i];
1208                   break;
1209                 }
1210
1211               if (compare_values (val[i], min) == -1)
1212                 min = val[i];
1213
1214               if (compare_values (val[i], max) == 1)
1215                 max = val[i];
1216             }
1217         }
1218     }
1219   else if (code == MINUS_EXPR)
1220     {
1221       /* If we have a MINUS_EXPR with two VR_ANTI_RANGEs, drop to
1222          VR_VARYING.  It would take more effort to compute a precise
1223          range for such a case.  For example, if we have op0 == 1 and
1224          op1 == 1 with their ranges both being ~[0,0], we would have
1225          op0 - op1 == 0, so we cannot claim that the difference is in
1226          ~[0,0].  Note that we are guaranteed to have
1227          vr0.type == vr1.type at this point.  */
1228       if (vr0.type == VR_ANTI_RANGE)
1229         {
1230           set_value_range_to_varying (vr);
1231           return;
1232         }
1233
1234       /* For MINUS_EXPR, apply the operation to the opposite ends of
1235          each range.  */
1236       min = vrp_int_const_binop (code, vr0.min, vr1.max);
1237       max = vrp_int_const_binop (code, vr0.max, vr1.min);
1238     }
1239   else
1240     gcc_unreachable ();
1241
1242   /* If either MIN or MAX overflowed, then set the resulting range to
1243      VARYING.  */
1244   if (TREE_OVERFLOW (min) || TREE_OVERFLOW (max))
1245     {
1246       set_value_range_to_varying (vr);
1247       return;
1248     }
1249
1250   cmp = compare_values (min, max);
1251   if (cmp == -2 || cmp == 1)
1252     {
1253       /* If the new range has its limits swapped around (MIN > MAX),
1254          then the operation caused one of them to wrap around, mark
1255          the new range VARYING.  */
1256       set_value_range_to_varying (vr);
1257     }
1258   else
1259     set_value_range (vr, vr0.type, min, max, NULL);
1260 }
1261
1262
1263 /* Extract range information from a unary expression EXPR based on
1264    the range of its operand and the expression code.  */
1265
1266 static void
1267 extract_range_from_unary_expr (value_range_t *vr, tree expr)
1268 {
1269   enum tree_code code = TREE_CODE (expr);
1270   tree min, max, op0;
1271   int cmp;
1272   value_range_t vr0 = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
1273
1274   /* Refuse to operate on certain unary expressions for which we
1275      cannot easily determine a resulting range.  */
1276   if (code == FIX_TRUNC_EXPR
1277       || code == FIX_CEIL_EXPR
1278       || code == FIX_FLOOR_EXPR
1279       || code == FIX_ROUND_EXPR
1280       || code == FLOAT_EXPR
1281       || code == BIT_NOT_EXPR
1282       || code == NON_LVALUE_EXPR
1283       || code == CONJ_EXPR)
1284     {
1285       set_value_range_to_varying (vr);
1286       return;
1287     }
1288
1289   /* Get value ranges for the operand.  For constant operands, create
1290      a new value range with the operand to simplify processing.  */
1291   op0 = TREE_OPERAND (expr, 0);
1292   if (TREE_CODE (op0) == SSA_NAME)
1293     vr0 = *(get_value_range (op0));
1294   else if (is_gimple_min_invariant (op0))
1295     set_value_range (&vr0, VR_RANGE, op0, op0, NULL);
1296   else
1297     set_value_range_to_varying (&vr0);
1298
1299   /* If VR0 is UNDEFINED, so is the result.  */
1300   if (vr0.type == VR_UNDEFINED)
1301     {
1302       set_value_range_to_undefined (vr);
1303       return;
1304     }
1305
1306   /* Refuse to operate on varying and symbolic ranges.  Also, if the
1307      operand is neither a pointer nor an integral type, set the
1308      resulting range to VARYING.  TODO, in some cases we may be able
1309      to derive anti-ranges (like nonzero values).  */
1310   if (vr0.type == VR_VARYING
1311       || (!INTEGRAL_TYPE_P (TREE_TYPE (op0))
1312           && !POINTER_TYPE_P (TREE_TYPE (op0)))
1313       || symbolic_range_p (&vr0))
1314     {
1315       set_value_range_to_varying (vr);
1316       return;
1317     }
1318
1319   /* If the expression involves pointers, we are only interested in
1320      determining if it evaluates to NULL [0, 0] or non-NULL (~[0, 0]).  */
1321   if (POINTER_TYPE_P (TREE_TYPE (expr)) || POINTER_TYPE_P (TREE_TYPE (op0)))
1322     {
1323       if (range_is_nonnull (&vr0) || tree_expr_nonzero_p (expr))
1324         set_value_range_to_nonnull (vr, TREE_TYPE (expr));
1325       else if (range_is_null (&vr0))
1326         set_value_range_to_null (vr, TREE_TYPE (expr));
1327       else
1328         set_value_range_to_varying (vr);
1329
1330       return;
1331     }
1332
1333   /* Handle unary expressions on integer ranges.  */
1334   if (code == NOP_EXPR || code == CONVERT_EXPR)
1335     {
1336       tree inner_type = TREE_TYPE (op0);
1337       tree outer_type = TREE_TYPE (expr);
1338
1339       /* If VR0 represents a simple range, then try to convert
1340          the min and max values for the range to the same type
1341          as OUTER_TYPE.  If the results compare equal to VR0's
1342          min and max values and the new min is still less than
1343          or equal to the new max, then we can safely use the newly
1344          computed range for EXPR.  This allows us to compute
1345          accurate ranges through many casts.  */
1346       if (vr0.type == VR_RANGE)
1347         {
1348           tree new_min, new_max;
1349
1350           /* Convert VR0's min/max to OUTER_TYPE.  */
1351           new_min = fold_convert (outer_type, vr0.min);
1352           new_max = fold_convert (outer_type, vr0.max);
1353
1354           /* Verify the new min/max values are gimple values and
1355              that they compare equal to VR0's min/max values.  */
1356           if (is_gimple_val (new_min)
1357               && is_gimple_val (new_max)
1358               && tree_int_cst_equal (new_min, vr0.min)
1359               && tree_int_cst_equal (new_max, vr0.max)
1360               && compare_values (new_min, new_max) <= 0
1361               && compare_values (new_min, new_max) >= -1)
1362             {
1363               set_value_range (vr, VR_RANGE, new_min, new_max, vr->equiv);
1364               return;
1365             }
1366         }
1367
1368       /* When converting types of different sizes, set the result to
1369          VARYING.  Things like sign extensions and precision loss may
1370          change the range.  For instance, if x_3 is of type 'long long
1371          int' and 'y_5 = (unsigned short) x_3', if x_3 is ~[0, 0], it
1372          is impossible to know at compile time whether y_5 will be
1373          ~[0, 0].  */
1374       if (TYPE_SIZE (inner_type) != TYPE_SIZE (outer_type)
1375           || TYPE_PRECISION (inner_type) != TYPE_PRECISION (outer_type))
1376         {
1377           set_value_range_to_varying (vr);
1378           return;
1379         }
1380     }
1381
1382   /* Apply the operation to each end of the range and see what we end
1383      up with.  */
1384   if (code == NEGATE_EXPR
1385       && !TYPE_UNSIGNED (TREE_TYPE (expr)))
1386     {
1387       /* NEGATE_EXPR flips the range around.  */
1388       min = (vr0.max == TYPE_MAX_VALUE (TREE_TYPE (expr)) && !flag_wrapv)
1389              ? TYPE_MIN_VALUE (TREE_TYPE (expr))
1390              : fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
1391
1392       max = (vr0.min == TYPE_MIN_VALUE (TREE_TYPE (expr)) && !flag_wrapv)
1393              ? TYPE_MAX_VALUE (TREE_TYPE (expr))
1394              : fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
1395     }
1396   else if (code == ABS_EXPR
1397            && !TYPE_UNSIGNED (TREE_TYPE (expr)))
1398     {
1399       /* -TYPE_MIN_VALUE = TYPE_MIN_VALUE with flag_wrapv so we can't get a
1400          useful range.  */
1401       if (flag_wrapv
1402           && ((vr0.type == VR_RANGE
1403                && vr0.min == TYPE_MIN_VALUE (TREE_TYPE (expr)))
1404               || (vr0.type == VR_ANTI_RANGE
1405                   && vr0.min != TYPE_MIN_VALUE (TREE_TYPE (expr))
1406                   && !range_includes_zero_p (&vr0))))
1407         {
1408           set_value_range_to_varying (vr);
1409           return;
1410         }
1411         
1412       /* ABS_EXPR may flip the range around, if the original range
1413          included negative values.  */
1414       min = (vr0.min == TYPE_MIN_VALUE (TREE_TYPE (expr)))
1415             ? TYPE_MAX_VALUE (TREE_TYPE (expr))
1416             : fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
1417
1418       max = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
1419
1420       cmp = compare_values (min, max);
1421
1422       /* If a VR_ANTI_RANGEs contains zero, then we have
1423          ~[-INF, min(MIN, MAX)].  */
1424       if (vr0.type == VR_ANTI_RANGE)
1425         { 
1426           if (range_includes_zero_p (&vr0))
1427             {
1428               tree type_min_value = TYPE_MIN_VALUE (TREE_TYPE (expr));
1429
1430               /* Take the lower of the two values.  */
1431               if (cmp != 1)
1432                 max = min;
1433
1434               /* Create ~[-INF, min (abs(MIN), abs(MAX))]
1435                  or ~[-INF + 1, min (abs(MIN), abs(MAX))] when
1436                  flag_wrapv is set and the original anti-range doesn't include
1437                  TYPE_MIN_VALUE, remember -TYPE_MIN_VALUE = TYPE_MIN_VALUE.  */
1438               min = (flag_wrapv && vr0.min != type_min_value
1439                      ? int_const_binop (PLUS_EXPR,
1440                                         type_min_value,
1441                                         integer_one_node, 0)
1442                      : type_min_value);
1443             }
1444           else
1445             {
1446               /* All else has failed, so create the range [0, INF], even for
1447                  flag_wrapv since TYPE_MIN_VALUE is in the original
1448                  anti-range.  */
1449               vr0.type = VR_RANGE;
1450               min = build_int_cst (TREE_TYPE (expr), 0);
1451               max = TYPE_MAX_VALUE (TREE_TYPE (expr));
1452             }
1453         }
1454
1455       /* If the range contains zero then we know that the minimum value in the
1456          range will be zero.  */
1457       else if (range_includes_zero_p (&vr0))
1458         {
1459           if (cmp == 1)
1460             max = min;
1461           min = build_int_cst (TREE_TYPE (expr), 0);
1462         }
1463       else
1464         {
1465           /* If the range was reversed, swap MIN and MAX.  */
1466           if (cmp == 1)
1467             {
1468               tree t = min;
1469               min = max;
1470               max = t;
1471             }
1472         }
1473     }
1474   else
1475     {
1476       /* Otherwise, operate on each end of the range.  */
1477       min = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.min);
1478       max = fold_unary_to_constant (code, TREE_TYPE (expr), vr0.max);
1479     }
1480
1481   cmp = compare_values (min, max);
1482   if (cmp == -2 || cmp == 1)
1483     {
1484       /* If the new range has its limits swapped around (MIN > MAX),
1485          then the operation caused one of them to wrap around, mark
1486          the new range VARYING.  */
1487       set_value_range_to_varying (vr);
1488     }
1489   else
1490     set_value_range (vr, vr0.type, min, max, NULL);
1491 }
1492
1493
1494 /* Extract range information from a comparison expression EXPR based
1495    on the range of its operand and the expression code.  */
1496
1497 static void
1498 extract_range_from_comparison (value_range_t *vr, tree expr)
1499 {
1500   tree val = vrp_evaluate_conditional (expr, false);
1501   if (val)
1502     {
1503       /* Since this expression was found on the RHS of an assignment,
1504          its type may be different from _Bool.  Convert VAL to EXPR's
1505          type.  */
1506       val = fold_convert (TREE_TYPE (expr), val);
1507       set_value_range (vr, VR_RANGE, val, val, vr->equiv);
1508     }
1509   else
1510     set_value_range_to_varying (vr);
1511 }
1512
1513
1514 /* Try to compute a useful range out of expression EXPR and store it
1515    in *VR.  */
1516
1517 static void
1518 extract_range_from_expr (value_range_t *vr, tree expr)
1519 {
1520   enum tree_code code = TREE_CODE (expr);
1521
1522   if (code == ASSERT_EXPR)
1523     extract_range_from_assert (vr, expr);
1524   else if (code == SSA_NAME)
1525     extract_range_from_ssa_name (vr, expr);
1526   else if (TREE_CODE_CLASS (code) == tcc_binary
1527            || code == TRUTH_ANDIF_EXPR
1528            || code == TRUTH_ORIF_EXPR
1529            || code == TRUTH_AND_EXPR
1530            || code == TRUTH_OR_EXPR
1531            || code == TRUTH_XOR_EXPR)
1532     extract_range_from_binary_expr (vr, expr);
1533   else if (TREE_CODE_CLASS (code) == tcc_unary)
1534     extract_range_from_unary_expr (vr, expr);
1535   else if (TREE_CODE_CLASS (code) == tcc_comparison)
1536     extract_range_from_comparison (vr, expr);
1537   else if (is_gimple_min_invariant (expr))
1538     set_value_range (vr, VR_RANGE, expr, expr, NULL);
1539   else if (vrp_expr_computes_nonzero (expr))
1540     set_value_range_to_nonnull (vr, TREE_TYPE (expr));
1541   else
1542     set_value_range_to_varying (vr);
1543 }
1544
1545 /* Given a range VR, a LOOP and a variable VAR, determine whether it
1546    would be profitable to adjust VR using scalar evolution information
1547    for VAR.  If so, update VR with the new limits.  */
1548
1549 static void
1550 adjust_range_with_scev (value_range_t *vr, struct loop *loop, tree stmt,
1551                         tree var)
1552 {
1553   tree init, step, chrec;
1554   bool init_is_max, unknown_max;
1555
1556   /* TODO.  Don't adjust anti-ranges.  An anti-range may provide
1557      better opportunities than a regular range, but I'm not sure.  */
1558   if (vr->type == VR_ANTI_RANGE)
1559     return;
1560
1561   chrec = instantiate_parameters (loop, analyze_scalar_evolution (loop, var));
1562   if (TREE_CODE (chrec) != POLYNOMIAL_CHREC)
1563     return;
1564
1565   init = initial_condition_in_loop_num (chrec, loop->num);
1566   step = evolution_part_in_loop_num (chrec, loop->num);
1567
1568   /* If STEP is symbolic, we can't know whether INIT will be the
1569      minimum or maximum value in the range.  */
1570   if (step == NULL_TREE
1571       || !is_gimple_min_invariant (step))
1572     return;
1573
1574   /* Do not adjust ranges when chrec may wrap.  */
1575   if (scev_probably_wraps_p (chrec_type (chrec), init, step, stmt,
1576                              cfg_loops->parray[CHREC_VARIABLE (chrec)],
1577                              &init_is_max, &unknown_max)
1578       || unknown_max)
1579     return;
1580
1581   if (!POINTER_TYPE_P (TREE_TYPE (init))
1582       && (vr->type == VR_VARYING || vr->type == VR_UNDEFINED))
1583     {
1584       /* For VARYING or UNDEFINED ranges, just about anything we get
1585          from scalar evolutions should be better.  */
1586       if (init_is_max)
1587         set_value_range (vr, VR_RANGE, TYPE_MIN_VALUE (TREE_TYPE (init)),
1588                          init, vr->equiv);
1589       else
1590         set_value_range (vr, VR_RANGE, init, TYPE_MAX_VALUE (TREE_TYPE (init)),
1591                          vr->equiv);
1592     }
1593   else if (vr->type == VR_RANGE)
1594     {
1595       tree min = vr->min;
1596       tree max = vr->max;
1597
1598       if (init_is_max)
1599         {
1600           /* INIT is the maximum value.  If INIT is lower than VR->MAX
1601              but no smaller than VR->MIN, set VR->MAX to INIT.  */
1602           if (compare_values (init, max) == -1)
1603             {
1604               max = init;
1605
1606               /* If we just created an invalid range with the minimum
1607                  greater than the maximum, take the minimum all the
1608                  way to -INF.  */
1609               if (compare_values (min, max) == 1)
1610                 min = TYPE_MIN_VALUE (TREE_TYPE (min));
1611             }
1612         }
1613       else
1614         {
1615           /* If INIT is bigger than VR->MIN, set VR->MIN to INIT.  */
1616           if (compare_values (init, min) == 1)
1617             {
1618               min = init;
1619
1620               /* If we just created an invalid range with the minimum
1621                  greater than the maximum, take the maximum all the
1622                  way to +INF.  */
1623               if (compare_values (min, max) == 1)
1624                 max = TYPE_MAX_VALUE (TREE_TYPE (max));
1625             }
1626         }
1627
1628       set_value_range (vr, VR_RANGE, min, max, vr->equiv);
1629     }
1630 }
1631
1632
1633 /* Given two numeric value ranges VR0, VR1 and a comparison code COMP:
1634    
1635    - Return BOOLEAN_TRUE_NODE if VR0 COMP VR1 always returns true for
1636      all the values in the ranges.
1637
1638    - Return BOOLEAN_FALSE_NODE if the comparison always returns false.
1639
1640    - Return NULL_TREE if it is not always possible to determine the
1641      value of the comparison.  */
1642
1643
1644 static tree
1645 compare_ranges (enum tree_code comp, value_range_t *vr0, value_range_t *vr1)
1646 {
1647   /* VARYING or UNDEFINED ranges cannot be compared.  */
1648   if (vr0->type == VR_VARYING
1649       || vr0->type == VR_UNDEFINED
1650       || vr1->type == VR_VARYING
1651       || vr1->type == VR_UNDEFINED)
1652     return NULL_TREE;
1653
1654   /* Anti-ranges need to be handled separately.  */
1655   if (vr0->type == VR_ANTI_RANGE || vr1->type == VR_ANTI_RANGE)
1656     {
1657       /* If both are anti-ranges, then we cannot compute any
1658          comparison.  */
1659       if (vr0->type == VR_ANTI_RANGE && vr1->type == VR_ANTI_RANGE)
1660         return NULL_TREE;
1661
1662       /* These comparisons are never statically computable.  */
1663       if (comp == GT_EXPR
1664           || comp == GE_EXPR
1665           || comp == LT_EXPR
1666           || comp == LE_EXPR)
1667         return NULL_TREE;
1668
1669       /* Equality can be computed only between a range and an
1670          anti-range.  ~[VAL1, VAL2] == [VAL1, VAL2] is always false.  */
1671       if (vr0->type == VR_RANGE)
1672         {
1673           /* To simplify processing, make VR0 the anti-range.  */
1674           value_range_t *tmp = vr0;
1675           vr0 = vr1;
1676           vr1 = tmp;
1677         }
1678
1679       gcc_assert (comp == NE_EXPR || comp == EQ_EXPR);
1680
1681       if (compare_values (vr0->min, vr1->min) == 0
1682           && compare_values (vr0->max, vr1->max) == 0)
1683         return (comp == NE_EXPR) ? boolean_true_node : boolean_false_node;
1684
1685       return NULL_TREE;
1686     }
1687
1688   /* Simplify processing.  If COMP is GT_EXPR or GE_EXPR, switch the
1689      operands around and change the comparison code.  */
1690   if (comp == GT_EXPR || comp == GE_EXPR)
1691     {
1692       value_range_t *tmp;
1693       comp = (comp == GT_EXPR) ? LT_EXPR : LE_EXPR;
1694       tmp = vr0;
1695       vr0 = vr1;
1696       vr1 = tmp;
1697     }
1698
1699   if (comp == EQ_EXPR)
1700     {
1701       /* Equality may only be computed if both ranges represent
1702          exactly one value.  */
1703       if (compare_values (vr0->min, vr0->max) == 0
1704           && compare_values (vr1->min, vr1->max) == 0)
1705         {
1706           int cmp_min = compare_values (vr0->min, vr1->min);
1707           int cmp_max = compare_values (vr0->max, vr1->max);
1708           if (cmp_min == 0 && cmp_max == 0)
1709             return boolean_true_node;
1710           else if (cmp_min != -2 && cmp_max != -2)
1711             return boolean_false_node;
1712         }
1713
1714       return NULL_TREE;
1715     }
1716   else if (comp == NE_EXPR)
1717     {
1718       int cmp1, cmp2;
1719
1720       /* If VR0 is completely to the left or completely to the right
1721          of VR1, they are always different.  Notice that we need to
1722          make sure that both comparisons yield similar results to
1723          avoid comparing values that cannot be compared at
1724          compile-time.  */
1725       cmp1 = compare_values (vr0->max, vr1->min);
1726       cmp2 = compare_values (vr0->min, vr1->max);
1727       if ((cmp1 == -1 && cmp2 == -1) || (cmp1 == 1 && cmp2 == 1))
1728         return boolean_true_node;
1729
1730       /* If VR0 and VR1 represent a single value and are identical,
1731          return false.  */
1732       else if (compare_values (vr0->min, vr0->max) == 0
1733                && compare_values (vr1->min, vr1->max) == 0
1734                && compare_values (vr0->min, vr1->min) == 0
1735                && compare_values (vr0->max, vr1->max) == 0)
1736         return boolean_false_node;
1737
1738       /* Otherwise, they may or may not be different.  */
1739       else
1740         return NULL_TREE;
1741     }
1742   else if (comp == LT_EXPR || comp == LE_EXPR)
1743     {
1744       int tst;
1745
1746       /* If VR0 is to the left of VR1, return true.  */
1747       tst = compare_values (vr0->max, vr1->min);
1748       if ((comp == LT_EXPR && tst == -1)
1749           || (comp == LE_EXPR && (tst == -1 || tst == 0)))
1750         return boolean_true_node;
1751
1752       /* If VR0 is to the right of VR1, return false.  */
1753       tst = compare_values (vr0->min, vr1->max);
1754       if ((comp == LT_EXPR && (tst == 0 || tst == 1))
1755           || (comp == LE_EXPR && tst == 1))
1756         return boolean_false_node;
1757
1758       /* Otherwise, we don't know.  */
1759       return NULL_TREE;
1760     }
1761     
1762   gcc_unreachable ();
1763 }
1764
1765
1766 /* Given a value range VR, a value VAL and a comparison code COMP, return
1767    BOOLEAN_TRUE_NODE if VR COMP VAL always returns true for all the
1768    values in VR.  Return BOOLEAN_FALSE_NODE if the comparison
1769    always returns false.  Return NULL_TREE if it is not always
1770    possible to determine the value of the comparison.  */
1771
1772 static tree
1773 compare_range_with_value (enum tree_code comp, value_range_t *vr, tree val)
1774 {
1775   if (vr->type == VR_VARYING || vr->type == VR_UNDEFINED)
1776     return NULL_TREE;
1777
1778   /* Anti-ranges need to be handled separately.  */
1779   if (vr->type == VR_ANTI_RANGE)
1780     {
1781       /* For anti-ranges, the only predicates that we can compute at
1782          compile time are equality and inequality.  */
1783       if (comp == GT_EXPR
1784           || comp == GE_EXPR
1785           || comp == LT_EXPR
1786           || comp == LE_EXPR)
1787         return NULL_TREE;
1788
1789       /* ~[VAL_1, VAL_2] OP VAL is known if VAL_1 <= VAL <= VAL_2.  */
1790       if (value_inside_range (val, vr) == 1)
1791         return (comp == NE_EXPR) ? boolean_true_node : boolean_false_node;
1792
1793       return NULL_TREE;
1794     }
1795
1796   if (comp == EQ_EXPR)
1797     {
1798       /* EQ_EXPR may only be computed if VR represents exactly
1799          one value.  */
1800       if (compare_values (vr->min, vr->max) == 0)
1801         {
1802           int cmp = compare_values (vr->min, val);
1803           if (cmp == 0)
1804             return boolean_true_node;
1805           else if (cmp == -1 || cmp == 1 || cmp == 2)
1806             return boolean_false_node;
1807         }
1808       else if (compare_values (val, vr->min) == -1
1809                || compare_values (vr->max, val) == -1)
1810         return boolean_false_node;
1811
1812       return NULL_TREE;
1813     }
1814   else if (comp == NE_EXPR)
1815     {
1816       /* If VAL is not inside VR, then they are always different.  */
1817       if (compare_values (vr->max, val) == -1
1818           || compare_values (vr->min, val) == 1)
1819         return boolean_true_node;
1820
1821       /* If VR represents exactly one value equal to VAL, then return
1822          false.  */
1823       if (compare_values (vr->min, vr->max) == 0
1824           && compare_values (vr->min, val) == 0)
1825         return boolean_false_node;
1826
1827       /* Otherwise, they may or may not be different.  */
1828       return NULL_TREE;
1829     }
1830   else if (comp == LT_EXPR || comp == LE_EXPR)
1831     {
1832       int tst;
1833
1834       /* If VR is to the left of VAL, return true.  */
1835       tst = compare_values (vr->max, val);
1836       if ((comp == LT_EXPR && tst == -1)
1837           || (comp == LE_EXPR && (tst == -1 || tst == 0)))
1838         return boolean_true_node;
1839
1840       /* If VR is to the right of VAL, return false.  */
1841       tst = compare_values (vr->min, val);
1842       if ((comp == LT_EXPR && (tst == 0 || tst == 1))
1843           || (comp == LE_EXPR && tst == 1))
1844         return boolean_false_node;
1845
1846       /* Otherwise, we don't know.  */
1847       return NULL_TREE;
1848     }
1849   else if (comp == GT_EXPR || comp == GE_EXPR)
1850     {
1851       int tst;
1852
1853       /* If VR is to the right of VAL, return true.  */
1854       tst = compare_values (vr->min, val);
1855       if ((comp == GT_EXPR && tst == 1)
1856           || (comp == GE_EXPR && (tst == 0 || tst == 1)))
1857         return boolean_true_node;
1858
1859       /* If VR is to the left of VAL, return false.  */
1860       tst = compare_values (vr->max, val);
1861       if ((comp == GT_EXPR && (tst == -1 || tst == 0))
1862           || (comp == GE_EXPR && tst == -1))
1863         return boolean_false_node;
1864
1865       /* Otherwise, we don't know.  */
1866       return NULL_TREE;
1867     }
1868
1869   gcc_unreachable ();
1870 }
1871
1872
1873 /* Debugging dumps.  */
1874
1875 void dump_value_range (FILE *, value_range_t *);
1876 void debug_value_range (value_range_t *);
1877 void dump_all_value_ranges (FILE *);
1878 void debug_all_value_ranges (void);
1879 void dump_vr_equiv (FILE *, bitmap);
1880 void debug_vr_equiv (bitmap);
1881
1882
1883 /* Dump value range VR to FILE.  */
1884
1885 void
1886 dump_value_range (FILE *file, value_range_t *vr)
1887 {
1888   if (vr == NULL)
1889     fprintf (file, "[]");
1890   else if (vr->type == VR_UNDEFINED)
1891     fprintf (file, "UNDEFINED");
1892   else if (vr->type == VR_RANGE || vr->type == VR_ANTI_RANGE)
1893     {
1894       tree type = TREE_TYPE (vr->min);
1895
1896       fprintf (file, "%s[", (vr->type == VR_ANTI_RANGE) ? "~" : "");
1897
1898       if (INTEGRAL_TYPE_P (type)
1899           && !TYPE_UNSIGNED (type)
1900           && vr->min == TYPE_MIN_VALUE (type))
1901         fprintf (file, "-INF");
1902       else
1903         print_generic_expr (file, vr->min, 0);
1904
1905       fprintf (file, ", ");
1906
1907       if (INTEGRAL_TYPE_P (type)
1908           && vr->max == TYPE_MAX_VALUE (type))
1909         fprintf (file, "+INF");
1910       else
1911         print_generic_expr (file, vr->max, 0);
1912
1913       fprintf (file, "]");
1914
1915       if (vr->equiv)
1916         {
1917           bitmap_iterator bi;
1918           unsigned i, c = 0;
1919
1920           fprintf (file, "  EQUIVALENCES: { ");
1921
1922           EXECUTE_IF_SET_IN_BITMAP (vr->equiv, 0, i, bi)
1923             {
1924               print_generic_expr (file, ssa_name (i), 0);
1925               fprintf (file, " ");
1926               c++;
1927             }
1928
1929           fprintf (file, "} (%u elements)", c);
1930         }
1931     }
1932   else if (vr->type == VR_VARYING)
1933     fprintf (file, "VARYING");
1934   else
1935     fprintf (file, "INVALID RANGE");
1936 }
1937
1938
1939 /* Dump value range VR to stderr.  */
1940
1941 void
1942 debug_value_range (value_range_t *vr)
1943 {
1944   dump_value_range (stderr, vr);
1945 }
1946
1947
1948 /* Dump value ranges of all SSA_NAMEs to FILE.  */
1949
1950 void
1951 dump_all_value_ranges (FILE *file)
1952 {
1953   size_t i;
1954
1955   for (i = 0; i < num_ssa_names; i++)
1956     {
1957       if (vr_value[i])
1958         {
1959           print_generic_expr (file, ssa_name (i), 0);
1960           fprintf (file, ": ");
1961           dump_value_range (file, vr_value[i]);
1962           fprintf (file, "\n");
1963         }
1964     }
1965
1966   fprintf (file, "\n");
1967 }
1968
1969
1970 /* Dump all value ranges to stderr.  */
1971
1972 void
1973 debug_all_value_ranges (void)
1974 {
1975   dump_all_value_ranges (stderr);
1976 }
1977
1978
1979 /* Given a COND_EXPR COND of the form 'V OP W', and an SSA name V,
1980    create a new SSA name N and return the assertion assignment
1981    'V = ASSERT_EXPR <V, V OP W>'.  */
1982
1983 static tree
1984 build_assert_expr_for (tree cond, tree v)
1985 {
1986   tree n, assertion;
1987
1988   gcc_assert (TREE_CODE (v) == SSA_NAME);
1989   n = duplicate_ssa_name (v, NULL_TREE);
1990
1991   if (COMPARISON_CLASS_P (cond))
1992     {
1993       tree a = build (ASSERT_EXPR, TREE_TYPE (v), v, cond); 
1994       assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, a);
1995     }
1996   else if (TREE_CODE (cond) == TRUTH_NOT_EXPR)
1997     {
1998       /* Given !V, build the assignment N = false.  */
1999       tree op0 = TREE_OPERAND (cond, 0);
2000       gcc_assert (op0 == v);
2001       assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, boolean_false_node);
2002     }
2003   else if (TREE_CODE (cond) == SSA_NAME)
2004     {
2005       /* Given V, build the assignment N = true.  */
2006       gcc_assert (v == cond);
2007       assertion = build (MODIFY_EXPR, TREE_TYPE (v), n, boolean_true_node);
2008     }
2009   else
2010     gcc_unreachable ();
2011
2012   SSA_NAME_DEF_STMT (n) = assertion;
2013
2014   /* The new ASSERT_EXPR, creates a new SSA name that replaces the
2015      operand of the ASSERT_EXPR. Register the new name and the old one
2016      in the replacement table so that we can fix the SSA web after
2017      adding all the ASSERT_EXPRs.  */
2018   register_new_name_mapping (n, v);
2019
2020   return assertion;
2021 }
2022
2023
2024 /* Return false if EXPR is a predicate expression involving floating
2025    point values.  */
2026
2027 static inline bool
2028 fp_predicate (tree expr)
2029 {
2030   return (COMPARISON_CLASS_P (expr)
2031           && FLOAT_TYPE_P (TREE_TYPE (TREE_OPERAND (expr, 0))));
2032 }
2033
2034
2035 /* If the range of values taken by OP can be inferred after STMT executes,
2036    return the comparison code (COMP_CODE_P) and value (VAL_P) that
2037    describes the inferred range.  Return true if a range could be
2038    inferred.  */
2039
2040 static bool
2041 infer_value_range (tree stmt, tree op, enum tree_code *comp_code_p, tree *val_p)
2042 {
2043   *val_p = NULL_TREE;
2044   *comp_code_p = ERROR_MARK;
2045
2046   /* Do not attempt to infer anything in names that flow through
2047      abnormal edges.  */
2048   if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (op))
2049     return false;
2050
2051   /* Similarly, don't infer anything from statements that may throw
2052      exceptions.  */
2053   if (tree_could_throw_p (stmt))
2054     return false;
2055
2056   if (POINTER_TYPE_P (TREE_TYPE (op)))
2057     {
2058       bool is_store;
2059       unsigned num_uses, num_derefs;
2060
2061       count_uses_and_derefs (op, stmt, &num_uses, &num_derefs, &is_store);
2062       if (num_derefs > 0 && flag_delete_null_pointer_checks)
2063         {
2064           /* We can only assume that a pointer dereference will yield
2065              non-NULL if -fdelete-null-pointer-checks is enabled.  */
2066           *val_p = build_int_cst (TREE_TYPE (op), 0);
2067           *comp_code_p = NE_EXPR;
2068           return true;
2069         }
2070     }
2071
2072   return false;
2073 }
2074
2075
2076 void dump_asserts_for (FILE *, tree);
2077 void debug_asserts_for (tree);
2078 void dump_all_asserts (FILE *);
2079 void debug_all_asserts (void);
2080
2081 /* Dump all the registered assertions for NAME to FILE.  */
2082
2083 void
2084 dump_asserts_for (FILE *file, tree name)
2085 {
2086   assert_locus_t loc;
2087
2088   fprintf (file, "Assertions to be inserted for ");
2089   print_generic_expr (file, name, 0);
2090   fprintf (file, "\n");
2091
2092   loc = asserts_for[SSA_NAME_VERSION (name)];
2093   while (loc)
2094     {
2095       fprintf (file, "\t");
2096       print_generic_expr (file, bsi_stmt (loc->si), 0);
2097       fprintf (file, "\n\tBB #%d", loc->bb->index);
2098       if (loc->e)
2099         {
2100           fprintf (file, "\n\tEDGE %d->%d", loc->e->src->index,
2101                    loc->e->dest->index);
2102           dump_edge_info (file, loc->e, 0);
2103         }
2104       fprintf (file, "\n\tPREDICATE: ");
2105       print_generic_expr (file, name, 0);
2106       fprintf (file, " %s ", tree_code_name[(int)loc->comp_code]);
2107       print_generic_expr (file, loc->val, 0);
2108       fprintf (file, "\n\n");
2109       loc = loc->next;
2110     }
2111
2112   fprintf (file, "\n");
2113 }
2114
2115
2116 /* Dump all the registered assertions for NAME to stderr.  */
2117
2118 void
2119 debug_asserts_for (tree name)
2120 {
2121   dump_asserts_for (stderr, name);
2122 }
2123
2124
2125 /* Dump all the registered assertions for all the names to FILE.  */
2126
2127 void
2128 dump_all_asserts (FILE *file)
2129 {
2130   unsigned i;
2131   bitmap_iterator bi;
2132
2133   fprintf (file, "\nASSERT_EXPRs to be inserted\n\n");
2134   EXECUTE_IF_SET_IN_BITMAP (need_assert_for, 0, i, bi)
2135     dump_asserts_for (file, ssa_name (i));
2136   fprintf (file, "\n");
2137 }
2138
2139
2140 /* Dump all the registered assertions for all the names to stderr.  */
2141
2142 void
2143 debug_all_asserts (void)
2144 {
2145   dump_all_asserts (stderr);
2146 }
2147
2148
2149 /* If NAME doesn't have an ASSERT_EXPR registered for asserting
2150    'NAME COMP_CODE VAL' at a location that dominates block BB or
2151    E->DEST, then register this location as a possible insertion point
2152    for ASSERT_EXPR <NAME, NAME COMP_CODE VAL>.
2153
2154    BB, E and SI provide the exact insertion point for the new
2155    ASSERT_EXPR.  If BB is NULL, then the ASSERT_EXPR is to be inserted
2156    on edge E.  Otherwise, if E is NULL, the ASSERT_EXPR is inserted on
2157    BB.  If SI points to a COND_EXPR or a SWITCH_EXPR statement, then E
2158    must not be NULL.  */
2159
2160 static void
2161 register_new_assert_for (tree name,
2162                          enum tree_code comp_code,
2163                          tree val,
2164                          basic_block bb,
2165                          edge e,
2166                          block_stmt_iterator si)
2167 {
2168   assert_locus_t n, loc, last_loc;
2169   bool found;
2170   basic_block dest_bb;
2171
2172 #if defined ENABLE_CHECKING
2173   gcc_assert (bb == NULL || e == NULL);
2174
2175   if (e == NULL)
2176     gcc_assert (TREE_CODE (bsi_stmt (si)) != COND_EXPR
2177                 && TREE_CODE (bsi_stmt (si)) != SWITCH_EXPR);
2178 #endif
2179
2180   /* The new assertion A will be inserted at BB or E.  We need to
2181      determine if the new location is dominated by a previously
2182      registered location for A.  If we are doing an edge insertion,
2183      assume that A will be inserted at E->DEST.  Note that this is not
2184      necessarily true.
2185      
2186      If E is a critical edge, it will be split.  But even if E is
2187      split, the new block will dominate the same set of blocks that
2188      E->DEST dominates.
2189      
2190      The reverse, however, is not true, blocks dominated by E->DEST
2191      will not be dominated by the new block created to split E.  So,
2192      if the insertion location is on a critical edge, we will not use
2193      the new location to move another assertion previously registered
2194      at a block dominated by E->DEST.  */
2195   dest_bb = (bb) ? bb : e->dest;
2196
2197   /* If NAME already has an ASSERT_EXPR registered for COMP_CODE and
2198      VAL at a block dominating DEST_BB, then we don't need to insert a new
2199      one.  Similarly, if the same assertion already exists at a block
2200      dominated by DEST_BB and the new location is not on a critical
2201      edge, then update the existing location for the assertion (i.e.,
2202      move the assertion up in the dominance tree).
2203
2204      Note, this is implemented as a simple linked list because there
2205      should not be more than a handful of assertions registered per
2206      name.  If this becomes a performance problem, a table hashed by
2207      COMP_CODE and VAL could be implemented.  */
2208   loc = asserts_for[SSA_NAME_VERSION (name)];
2209   last_loc = loc;
2210   found = false;
2211   while (loc)
2212     {
2213       if (loc->comp_code == comp_code
2214           && (loc->val == val
2215               || operand_equal_p (loc->val, val, 0)))
2216         {
2217           /* If the assertion NAME COMP_CODE VAL has already been
2218              registered at a basic block that dominates DEST_BB, then
2219              we don't need to insert the same assertion again.  Note
2220              that we don't check strict dominance here to avoid
2221              replicating the same assertion inside the same basic
2222              block more than once (e.g., when a pointer is
2223              dereferenced several times inside a block).
2224
2225              An exception to this rule are edge insertions.  If the
2226              new assertion is to be inserted on edge E, then it will
2227              dominate all the other insertions that we may want to
2228              insert in DEST_BB.  So, if we are doing an edge
2229              insertion, don't do this dominance check.  */
2230           if (e == NULL
2231               && dominated_by_p (CDI_DOMINATORS, dest_bb, loc->bb))
2232             return;
2233
2234           /* Otherwise, if E is not a critical edge and DEST_BB
2235              dominates the existing location for the assertion, move
2236              the assertion up in the dominance tree by updating its
2237              location information.  */
2238           if ((e == NULL || !EDGE_CRITICAL_P (e))
2239               && dominated_by_p (CDI_DOMINATORS, loc->bb, dest_bb))
2240             {
2241               loc->bb = dest_bb;
2242               loc->e = e;
2243               loc->si = si;
2244               return;
2245             }
2246         }
2247
2248       /* Update the last node of the list and move to the next one.  */
2249       last_loc = loc;
2250       loc = loc->next;
2251     }
2252
2253   /* If we didn't find an assertion already registered for
2254      NAME COMP_CODE VAL, add a new one at the end of the list of
2255      assertions associated with NAME.  */
2256   n = xmalloc (sizeof (*n));
2257   n->bb = dest_bb;
2258   n->e = e;
2259   n->si = si;
2260   n->comp_code = comp_code;
2261   n->val = val;
2262   n->next = NULL;
2263
2264   if (last_loc)
2265     last_loc->next = n;
2266   else
2267     asserts_for[SSA_NAME_VERSION (name)] = n;
2268
2269   bitmap_set_bit (need_assert_for, SSA_NAME_VERSION (name));
2270 }
2271
2272
2273 /* Try to register an edge assertion for SSA name NAME on edge E for
2274    the conditional jump pointed to by SI.  Return true if an assertion
2275    for NAME could be registered.  */
2276
2277 static bool
2278 register_edge_assert_for (tree name, edge e, block_stmt_iterator si)
2279 {
2280   tree val, stmt;
2281   enum tree_code comp_code;
2282
2283   stmt = bsi_stmt (si);
2284
2285   /* Do not attempt to infer anything in names that flow through
2286      abnormal edges.  */
2287   if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (name))
2288     return false;
2289
2290   /* If NAME was not found in the sub-graph reachable from E, then
2291      there's nothing to do.  */
2292   if (!TEST_BIT (found_in_subgraph, SSA_NAME_VERSION (name)))
2293     return false;
2294
2295   /* We found a use of NAME in the sub-graph rooted at E->DEST.
2296      Register an assertion for NAME according to the value that NAME
2297      takes on edge E.  */
2298   if (TREE_CODE (stmt) == COND_EXPR)
2299     {
2300       /* If BB ends in a COND_EXPR then NAME then we should insert
2301          the original predicate on EDGE_TRUE_VALUE and the
2302          opposite predicate on EDGE_FALSE_VALUE.  */
2303       tree cond = COND_EXPR_COND (stmt);
2304       bool is_else_edge = (e->flags & EDGE_FALSE_VALUE) != 0;
2305
2306       /* Predicates may be a single SSA name or NAME OP VAL.  */
2307       if (cond == name)
2308         {
2309           /* If the predicate is a name, it must be NAME, in which
2310              case we create the predicate NAME == true or
2311              NAME == false accordingly.  */
2312           comp_code = EQ_EXPR;
2313           val = (is_else_edge) ? boolean_false_node : boolean_true_node;
2314         }
2315       else
2316         {
2317           /* Otherwise, we have a comparison of the form NAME COMP VAL
2318              or VAL COMP NAME.  */
2319           if (name == TREE_OPERAND (cond, 1))
2320             {
2321               /* If the predicate is of the form VAL COMP NAME, flip
2322                  COMP around because we need to register NAME as the
2323                  first operand in the predicate.  */
2324               comp_code = swap_tree_comparison (TREE_CODE (cond));
2325               val = TREE_OPERAND (cond, 0);
2326             }
2327           else
2328             {
2329               /* The comparison is of the form NAME COMP VAL, so the
2330                  comparison code remains unchanged.  */
2331               comp_code = TREE_CODE (cond);
2332               val = TREE_OPERAND (cond, 1);
2333             }
2334
2335           /* If we are inserting the assertion on the ELSE edge, we
2336              need to invert the sign comparison.  */
2337           if (is_else_edge)
2338             comp_code = invert_tree_comparison (comp_code, 0);
2339         }
2340     }
2341   else
2342     {
2343       /* FIXME.  Handle SWITCH_EXPR.  */
2344       gcc_unreachable ();
2345     }
2346
2347   register_new_assert_for (name, comp_code, val, NULL, e, si);
2348   return true;
2349 }
2350
2351
2352 static bool find_assert_locations (basic_block bb);
2353
2354 /* Determine whether the outgoing edges of BB should receive an
2355    ASSERT_EXPR for each of the operands of BB's last statement.  The
2356    last statement of BB must be a COND_EXPR or a SWITCH_EXPR.
2357
2358    If any of the sub-graphs rooted at BB have an interesting use of
2359    the predicate operands, an assert location node is added to the
2360    list of assertions for the corresponding operands.  */
2361
2362 static bool
2363 find_conditional_asserts (basic_block bb)
2364 {
2365   bool need_assert;
2366   block_stmt_iterator last_si;
2367   tree op, last;
2368   edge_iterator ei;
2369   edge e;
2370   ssa_op_iter iter;
2371
2372   need_assert = false;
2373   last_si = bsi_last (bb);
2374   last = bsi_stmt (last_si);
2375
2376   /* Look for uses of the operands in each of the sub-graphs
2377      rooted at BB.  We need to check each of the outgoing edges
2378      separately, so that we know what kind of ASSERT_EXPR to
2379      insert.  */
2380   FOR_EACH_EDGE (e, ei, bb->succs)
2381     {
2382       if (e->dest == bb)
2383         continue;
2384
2385       /* Remove the COND_EXPR operands from the FOUND_IN_SUBGRAPH bitmap.
2386          Otherwise, when we finish traversing each of the sub-graphs, we
2387          won't know whether the variables were found in the sub-graphs or
2388          if they had been found in a block upstream from BB.  */
2389       FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
2390         RESET_BIT (found_in_subgraph, SSA_NAME_VERSION (op));
2391
2392       /* Traverse the strictly dominated sub-graph rooted at E->DEST
2393          to determine if any of the operands in the conditional
2394          predicate are used.  */
2395       if (e->dest != bb)
2396         need_assert |= find_assert_locations (e->dest);
2397
2398       /* Register the necessary assertions for each operand in the
2399          conditional predicate.  */
2400       FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
2401         need_assert |= register_edge_assert_for (op, e, last_si);
2402     }
2403
2404   /* Finally, indicate that we have found the operands in the
2405      conditional.  */
2406   FOR_EACH_SSA_TREE_OPERAND (op, last, iter, SSA_OP_USE)
2407     SET_BIT (found_in_subgraph, SSA_NAME_VERSION (op));
2408
2409   return need_assert;
2410 }
2411
2412
2413 /* Traverse all the statements in block BB looking for statements that
2414    may generate useful assertions for the SSA names in their operand.
2415    If a statement produces a useful assertion A for name N_i, then the
2416    list of assertions already generated for N_i is scanned to
2417    determine if A is actually needed.
2418    
2419    If N_i already had the assertion A at a location dominating the
2420    current location, then nothing needs to be done.  Otherwise, the
2421    new location for A is recorded instead.
2422
2423    1- For every statement S in BB, all the variables used by S are
2424       added to bitmap FOUND_IN_SUBGRAPH.
2425
2426    2- If statement S uses an operand N in a way that exposes a known
2427       value range for N, then if N was not already generated by an
2428       ASSERT_EXPR, create a new assert location for N.  For instance,
2429       if N is a pointer and the statement dereferences it, we can
2430       assume that N is not NULL.
2431
2432    3- COND_EXPRs are a special case of #2.  We can derive range
2433       information from the predicate but need to insert different
2434       ASSERT_EXPRs for each of the sub-graphs rooted at the
2435       conditional block.  If the last statement of BB is a conditional
2436       expression of the form 'X op Y', then
2437
2438       a) Remove X and Y from the set FOUND_IN_SUBGRAPH.
2439
2440       b) If the conditional is the only entry point to the sub-graph
2441          corresponding to the THEN_CLAUSE, recurse into it.  On
2442          return, if X and/or Y are marked in FOUND_IN_SUBGRAPH, then
2443          an ASSERT_EXPR is added for the corresponding variable.
2444
2445       c) Repeat step (b) on the ELSE_CLAUSE.
2446
2447       d) Mark X and Y in FOUND_IN_SUBGRAPH.
2448
2449       For instance,
2450
2451             if (a == 9)
2452               b = a;
2453             else
2454               b = c + 1;
2455
2456       In this case, an assertion on the THEN clause is useful to
2457       determine that 'a' is always 9 on that edge.  However, an assertion
2458       on the ELSE clause would be unnecessary.
2459
2460    4- If BB does not end in a conditional expression, then we recurse
2461       into BB's dominator children.
2462    
2463    At the end of the recursive traversal, every SSA name will have a
2464    list of locations where ASSERT_EXPRs should be added.  When a new
2465    location for name N is found, it is registered by calling
2466    register_new_assert_for.  That function keeps track of all the
2467    registered assertions to prevent adding unnecessary assertions.
2468    For instance, if a pointer P_4 is dereferenced more than once in a
2469    dominator tree, only the location dominating all the dereference of
2470    P_4 will receive an ASSERT_EXPR.
2471
2472    If this function returns true, then it means that there are names
2473    for which we need to generate ASSERT_EXPRs.  Those assertions are
2474    inserted by process_assert_insertions.
2475
2476    TODO.  Handle SWITCH_EXPR.  */
2477
2478 static bool
2479 find_assert_locations (basic_block bb)
2480 {
2481   block_stmt_iterator si;
2482   tree last, phi;
2483   bool need_assert;
2484   basic_block son;
2485
2486   if (TEST_BIT (blocks_visited, bb->index))
2487     return false;
2488
2489   SET_BIT (blocks_visited, bb->index);
2490
2491   need_assert = false;
2492
2493   /* Traverse all PHI nodes in BB marking used operands.  */
2494   for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2495     {
2496       use_operand_p arg_p;
2497       ssa_op_iter i;
2498
2499       FOR_EACH_PHI_ARG (arg_p, phi, i, SSA_OP_USE)
2500         {
2501           tree arg = USE_FROM_PTR (arg_p);
2502           if (TREE_CODE (arg) == SSA_NAME)
2503             {
2504               gcc_assert (is_gimple_reg (PHI_RESULT (phi)));
2505               SET_BIT (found_in_subgraph, SSA_NAME_VERSION (arg));
2506             }
2507         }
2508     }
2509
2510   /* Traverse all the statements in BB marking used names and looking
2511      for statements that may infer assertions for their used operands.  */
2512   last = NULL_TREE;
2513   for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2514     {
2515       tree stmt, op;
2516       ssa_op_iter i;
2517
2518       stmt = bsi_stmt (si);
2519
2520       /* See if we can derive an assertion for any of STMT's operands.  */
2521       FOR_EACH_SSA_TREE_OPERAND (op, stmt, i, SSA_OP_USE)
2522         {
2523           tree value;
2524           enum tree_code comp_code;
2525
2526           /* Mark OP in bitmap FOUND_IN_SUBGRAPH.  If STMT is inside
2527              the sub-graph of a conditional block, when we return from
2528              this recursive walk, our parent will use the
2529              FOUND_IN_SUBGRAPH bitset to determine if one of the
2530              operands it was looking for was present in the sub-graph.  */
2531           SET_BIT (found_in_subgraph, SSA_NAME_VERSION (op));
2532
2533           /* If OP is used only once, namely in this STMT, don't
2534              bother creating an ASSERT_EXPR for it.  Such an
2535              ASSERT_EXPR would do nothing but increase compile time.
2536              Experiments show that with this simple check, we can save
2537              more than 20% of ASSERT_EXPRs.  */
2538           if (has_single_use (op))
2539             continue;
2540
2541           /* If OP is used in such a way that we can infer a value
2542              range for it, and we don't find a previous assertion for
2543              it, create a new assertion location node for OP.  */
2544           if (infer_value_range (stmt, op, &comp_code, &value))
2545             {
2546               register_new_assert_for (op, comp_code, value, bb, NULL, si);
2547               need_assert = true;
2548             }
2549         }
2550
2551       /* Remember the last statement of the block.  */
2552       last = stmt;
2553     }
2554
2555   /* If BB's last statement is a conditional expression
2556      involving integer operands, recurse into each of the sub-graphs
2557      rooted at BB to determine if we need to add ASSERT_EXPRs.  */
2558   if (last
2559       && TREE_CODE (last) == COND_EXPR
2560       && !fp_predicate (COND_EXPR_COND (last))
2561       && !ZERO_SSA_OPERANDS (last, SSA_OP_USE))
2562     need_assert |= find_conditional_asserts (bb);
2563
2564   /* Recurse into the dominator children of BB.  */
2565   for (son = first_dom_son (CDI_DOMINATORS, bb);
2566        son;
2567        son = next_dom_son (CDI_DOMINATORS, son))
2568     need_assert |= find_assert_locations (son);
2569
2570   return need_assert;
2571 }
2572
2573
2574 /* Create an ASSERT_EXPR for NAME and insert it in the location
2575    indicated by LOC.  Return true if we made any edge insertions.  */
2576
2577 static bool
2578 process_assert_insertions_for (tree name, assert_locus_t loc)
2579 {
2580   /* Build the comparison expression NAME_i COMP_CODE VAL.  */
2581   tree stmt, cond, assert_expr;
2582   edge_iterator ei;
2583   edge e;
2584
2585   cond = build (loc->comp_code, boolean_type_node, name, loc->val);
2586   assert_expr = build_assert_expr_for (cond, name);
2587
2588   if (loc->e)
2589     {
2590       /* We have been asked to insert the assertion on an edge.  This
2591          is used only by COND_EXPR and SWITCH_EXPR assertions.  */
2592 #if defined ENABLE_CHECKING
2593       gcc_assert (TREE_CODE (bsi_stmt (loc->si)) == COND_EXPR
2594           || TREE_CODE (bsi_stmt (loc->si)) == SWITCH_EXPR);
2595 #endif
2596
2597       bsi_insert_on_edge (loc->e, assert_expr);
2598       return true;
2599     }
2600
2601   /* Otherwise, we can insert right after LOC->SI iff the
2602      statement must not be the last statement in the block.  */
2603   stmt = bsi_stmt (loc->si);
2604   if (!stmt_ends_bb_p (stmt))
2605     {
2606       bsi_insert_after (&loc->si, assert_expr, BSI_SAME_STMT);
2607       return false;
2608     }
2609
2610   /* If STMT must be the last statement in BB, we can only insert new
2611      assertions on the non-abnormal edge out of BB.  Note that since
2612      STMT is not control flow, there may only be one non-abnormal edge
2613      out of BB.  */
2614   FOR_EACH_EDGE (e, ei, loc->bb->succs)
2615     if (!(e->flags & EDGE_ABNORMAL))
2616       {
2617         bsi_insert_on_edge (e, assert_expr);
2618         return true;
2619       }
2620
2621   gcc_unreachable ();
2622 }
2623
2624
2625 /* Process all the insertions registered for every name N_i registered
2626    in NEED_ASSERT_FOR.  The list of assertions to be inserted are
2627    found in ASSERTS_FOR[i].  */
2628
2629 static void
2630 process_assert_insertions (void)
2631 {
2632   unsigned i;
2633   bitmap_iterator bi;
2634   bool update_edges_p = false;
2635   int num_asserts = 0;
2636
2637   if (dump_file && (dump_flags & TDF_DETAILS))
2638     dump_all_asserts (dump_file);
2639
2640   EXECUTE_IF_SET_IN_BITMAP (need_assert_for, 0, i, bi)
2641     {
2642       assert_locus_t loc = asserts_for[i];
2643       gcc_assert (loc);
2644
2645       while (loc)
2646         {
2647           assert_locus_t next = loc->next;
2648           update_edges_p |= process_assert_insertions_for (ssa_name (i), loc);
2649           free (loc);
2650           loc = next;
2651           num_asserts++;
2652         }
2653     }
2654
2655   if (update_edges_p)
2656     bsi_commit_edge_inserts ();
2657
2658   if (dump_file && (dump_flags & TDF_STATS))
2659     fprintf (dump_file, "\nNumber of ASSERT_EXPR expressions inserted: %d\n\n",
2660              num_asserts);
2661 }
2662
2663
2664 /* Traverse the flowgraph looking for conditional jumps to insert range
2665    expressions.  These range expressions are meant to provide information
2666    to optimizations that need to reason in terms of value ranges.  They
2667    will not be expanded into RTL.  For instance, given:
2668
2669    x = ...
2670    y = ...
2671    if (x < y)
2672      y = x - 2;
2673    else
2674      x = y + 3;
2675
2676    this pass will transform the code into:
2677
2678    x = ...
2679    y = ...
2680    if (x < y)
2681     {
2682       x = ASSERT_EXPR <x, x < y>
2683       y = x - 2
2684     }
2685    else
2686     {
2687       y = ASSERT_EXPR <y, x <= y>
2688       x = y + 3
2689     }
2690
2691    The idea is that once copy and constant propagation have run, other
2692    optimizations will be able to determine what ranges of values can 'x'
2693    take in different paths of the code, simply by checking the reaching
2694    definition of 'x'.  */
2695
2696 static void
2697 insert_range_assertions (void)
2698 {
2699   edge e;
2700   edge_iterator ei;
2701   bool update_ssa_p;
2702   
2703   found_in_subgraph = sbitmap_alloc (num_ssa_names);
2704   sbitmap_zero (found_in_subgraph);
2705
2706   blocks_visited = sbitmap_alloc (last_basic_block);
2707   sbitmap_zero (blocks_visited);
2708
2709   need_assert_for = BITMAP_ALLOC (NULL);
2710   asserts_for = xmalloc (num_ssa_names * sizeof (assert_locus_t));
2711   memset (asserts_for, 0, num_ssa_names * sizeof (assert_locus_t));
2712
2713   calculate_dominance_info (CDI_DOMINATORS);
2714
2715   update_ssa_p = false;
2716   FOR_EACH_EDGE (e, ei, ENTRY_BLOCK_PTR->succs)
2717     if (find_assert_locations (e->dest))
2718       update_ssa_p = true;
2719
2720   if (update_ssa_p)
2721     {
2722       process_assert_insertions ();
2723       update_ssa (TODO_update_ssa_no_phi);
2724     }
2725
2726   if (dump_file && (dump_flags & TDF_DETAILS))
2727     {
2728       fprintf (dump_file, "\nSSA form after inserting ASSERT_EXPRs\n");
2729       dump_function_to_file (current_function_decl, dump_file, dump_flags);
2730     }
2731
2732   sbitmap_free (found_in_subgraph);
2733   free (asserts_for);
2734   BITMAP_FREE (need_assert_for);
2735 }
2736
2737
2738 /* Convert range assertion expressions into the implied copies and
2739    copy propagate away the copies.  Doing the trivial copy propagation
2740    here avoids the need to run the full copy propagation pass after
2741    VRP. 
2742    
2743    FIXME, this will eventually lead to copy propagation removing the
2744    names that had useful range information attached to them.  For
2745    instance, if we had the assertion N_i = ASSERT_EXPR <N_j, N_j > 3>,
2746    then N_i will have the range [3, +INF].
2747    
2748    However, by converting the assertion into the implied copy
2749    operation N_i = N_j, we will then copy-propagate N_j into the uses
2750    of N_i and lose the range information.  We may want to hold on to
2751    ASSERT_EXPRs a little while longer as the ranges could be used in
2752    things like jump threading.
2753    
2754    The problem with keeping ASSERT_EXPRs around is that passes after
2755    VRP need to handle them appropriately. 
2756
2757    Another approach would be to make the range information a first
2758    class property of the SSA_NAME so that it can be queried from
2759    any pass.  This is made somewhat more complex by the need for
2760    multiple ranges to be associated with one SSA_NAME.  */
2761
2762 static void
2763 remove_range_assertions (void)
2764 {
2765   basic_block bb;
2766   block_stmt_iterator si;
2767
2768   /* Note that the BSI iterator bump happens at the bottom of the
2769      loop and no bump is necessary if we're removing the statement
2770      referenced by the current BSI.  */
2771   FOR_EACH_BB (bb)
2772     for (si = bsi_start (bb); !bsi_end_p (si);)
2773       {
2774         tree stmt = bsi_stmt (si);
2775
2776         if (TREE_CODE (stmt) == MODIFY_EXPR
2777             && TREE_CODE (TREE_OPERAND (stmt, 1)) == ASSERT_EXPR)
2778           {
2779             tree rhs = TREE_OPERAND (stmt, 1);
2780             tree cond = fold (ASSERT_EXPR_COND (rhs));
2781             use_operand_p use_p;
2782             imm_use_iterator iter;
2783
2784             gcc_assert (cond != boolean_false_node);
2785             TREE_OPERAND (stmt, 1) = ASSERT_EXPR_VAR (rhs);
2786             update_stmt (stmt);
2787
2788             /* The statement is now a copy.  Propagate the RHS into
2789                every use of the LHS.  */
2790             FOR_EACH_IMM_USE_SAFE (use_p, iter, TREE_OPERAND (stmt, 0))
2791               {
2792                 SET_USE (use_p, ASSERT_EXPR_VAR (rhs));
2793                 update_stmt (USE_STMT (use_p));
2794               }
2795
2796             /* And finally, remove the copy, it is not needed.  */
2797             bsi_remove (&si);
2798           }
2799         else
2800           bsi_next (&si);
2801       }
2802
2803   sbitmap_free (blocks_visited);
2804 }
2805
2806
2807 /* Return true if STMT is interesting for VRP.  */
2808
2809 static bool
2810 stmt_interesting_for_vrp (tree stmt)
2811 {
2812   if (TREE_CODE (stmt) == PHI_NODE
2813       && is_gimple_reg (PHI_RESULT (stmt))
2814       && (INTEGRAL_TYPE_P (TREE_TYPE (PHI_RESULT (stmt)))
2815           || POINTER_TYPE_P (TREE_TYPE (PHI_RESULT (stmt)))))
2816     return true;
2817   else if (TREE_CODE (stmt) == MODIFY_EXPR)
2818     {
2819       tree lhs = TREE_OPERAND (stmt, 0);
2820
2821       if (TREE_CODE (lhs) == SSA_NAME
2822           && (INTEGRAL_TYPE_P (TREE_TYPE (lhs))
2823               || POINTER_TYPE_P (TREE_TYPE (lhs)))
2824           && ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS))
2825         return true;
2826     }
2827   else if (TREE_CODE (stmt) == COND_EXPR || TREE_CODE (stmt) == SWITCH_EXPR)
2828     return true;
2829
2830   return false;
2831 }
2832
2833
2834 /* Initialize local data structures for VRP.  */
2835
2836 static void
2837 vrp_initialize (void)
2838 {
2839   basic_block bb;
2840
2841   vr_value = xmalloc (num_ssa_names * sizeof (value_range_t *));
2842   memset (vr_value, 0, num_ssa_names * sizeof (value_range_t *));
2843
2844   FOR_EACH_BB (bb)
2845     {
2846       block_stmt_iterator si;
2847       tree phi;
2848
2849       for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2850         {
2851           if (!stmt_interesting_for_vrp (phi))
2852             {
2853               tree lhs = PHI_RESULT (phi);
2854               set_value_range_to_varying (get_value_range (lhs));
2855               DONT_SIMULATE_AGAIN (phi) = true;
2856             }
2857           else
2858             DONT_SIMULATE_AGAIN (phi) = false;
2859         }
2860
2861       for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2862         {
2863           tree stmt = bsi_stmt (si);
2864
2865           if (!stmt_interesting_for_vrp (stmt))
2866             {
2867               ssa_op_iter i;
2868               tree def;
2869               FOR_EACH_SSA_TREE_OPERAND (def, stmt, i, SSA_OP_DEF)
2870                 set_value_range_to_varying (get_value_range (def));
2871               DONT_SIMULATE_AGAIN (stmt) = true;
2872             }
2873           else
2874             {
2875               DONT_SIMULATE_AGAIN (stmt) = false;
2876             }
2877         }
2878     }
2879 }
2880
2881
2882 /* Visit assignment STMT.  If it produces an interesting range, record
2883    the SSA name in *OUTPUT_P.  */
2884
2885 static enum ssa_prop_result
2886 vrp_visit_assignment (tree stmt, tree *output_p)
2887 {
2888   tree lhs, rhs, def;
2889   ssa_op_iter iter;
2890
2891   lhs = TREE_OPERAND (stmt, 0);
2892   rhs = TREE_OPERAND (stmt, 1);
2893
2894   /* We only keep track of ranges in integral and pointer types.  */
2895   if (TREE_CODE (lhs) == SSA_NAME
2896       && (INTEGRAL_TYPE_P (TREE_TYPE (lhs))
2897           || POINTER_TYPE_P (TREE_TYPE (lhs))))
2898     {
2899       struct loop *l;
2900       value_range_t new_vr = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
2901
2902       extract_range_from_expr (&new_vr, rhs);
2903
2904       /* If STMT is inside a loop, we may be able to know something
2905          else about the range of LHS by examining scalar evolution
2906          information.  */
2907       if (cfg_loops && (l = loop_containing_stmt (stmt)))
2908         adjust_range_with_scev (&new_vr, l, stmt, lhs);
2909
2910       if (update_value_range (lhs, &new_vr))
2911         {
2912           *output_p = lhs;
2913
2914           if (dump_file && (dump_flags & TDF_DETAILS))
2915             {
2916               fprintf (dump_file, "Found new range for ");
2917               print_generic_expr (dump_file, lhs, 0);
2918               fprintf (dump_file, ": ");
2919               dump_value_range (dump_file, &new_vr);
2920               fprintf (dump_file, "\n\n");
2921             }
2922
2923           if (new_vr.type == VR_VARYING)
2924             return SSA_PROP_VARYING;
2925
2926           return SSA_PROP_INTERESTING;
2927         }
2928
2929       return SSA_PROP_NOT_INTERESTING;
2930     }
2931   
2932   /* Every other statement produces no useful ranges.  */
2933   FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
2934     set_value_range_to_varying (get_value_range (def));
2935
2936   return SSA_PROP_VARYING;
2937 }
2938
2939
2940 /* Compare all the value ranges for names equivalent to VAR with VAL
2941    using comparison code COMP.  Return the same value returned by
2942    compare_range_with_value.  */
2943
2944 static tree
2945 compare_name_with_value (enum tree_code comp, tree var, tree val)
2946 {
2947   bitmap_iterator bi;
2948   unsigned i;
2949   bitmap e;
2950   tree retval, t;
2951   
2952   t = retval = NULL_TREE;
2953
2954   /* Get the set of equivalences for VAR.  */
2955   e = get_value_range (var)->equiv;
2956
2957   /* Add VAR to its own set of equivalences so that VAR's value range
2958      is processed by this loop (otherwise, we would have to replicate
2959      the body of the loop just to check VAR's value range).  */
2960   bitmap_set_bit (e, SSA_NAME_VERSION (var));
2961
2962   EXECUTE_IF_SET_IN_BITMAP (e, 0, i, bi)
2963     {
2964       value_range_t equiv_vr = *(vr_value[i]);
2965
2966       /* If name N_i does not have a valid range, use N_i as its own
2967          range.  This allows us to compare against names that may
2968          have N_i in their ranges.  */
2969       if (equiv_vr.type == VR_VARYING || equiv_vr.type == VR_UNDEFINED)
2970         {
2971           equiv_vr.type = VR_RANGE;
2972           equiv_vr.min = ssa_name (i);
2973           equiv_vr.max = ssa_name (i);
2974         }
2975
2976       t = compare_range_with_value (comp, &equiv_vr, val);
2977       if (t)
2978         {
2979           /* All the ranges should compare the same against VAL.  */
2980           gcc_assert (retval == NULL || t == retval);
2981           retval = t;
2982         }
2983     }
2984
2985   /* Remove VAR from its own equivalence set.  */
2986   bitmap_clear_bit (e, SSA_NAME_VERSION (var));
2987
2988   if (retval)
2989     return retval;
2990
2991   /* We couldn't find a non-NULL value for the predicate.  */
2992   return NULL_TREE;
2993 }
2994
2995
2996 /* Given a comparison code COMP and names N1 and N2, compare all the
2997    ranges equivalent to N1 against all the ranges equivalent to N2
2998    to determine the value of N1 COMP N2.  Return the same value
2999    returned by compare_ranges.  */
3000
3001 static tree
3002 compare_names (enum tree_code comp, tree n1, tree n2)
3003 {
3004   tree t, retval;
3005   bitmap e1, e2;
3006   bitmap_iterator bi1, bi2;
3007   unsigned i1, i2;
3008
3009   /* Compare the ranges of every name equivalent to N1 against the
3010      ranges of every name equivalent to N2.  */
3011   e1 = get_value_range (n1)->equiv;
3012   e2 = get_value_range (n2)->equiv;
3013
3014   /* Add N1 and N2 to their own set of equivalences to avoid
3015      duplicating the body of the loop just to check N1 and N2
3016      ranges.  */
3017   bitmap_set_bit (e1, SSA_NAME_VERSION (n1));
3018   bitmap_set_bit (e2, SSA_NAME_VERSION (n2));
3019
3020   /* If the equivalence sets have a common intersection, then the two
3021      names can be compared without checking their ranges.  */
3022   if (bitmap_intersect_p (e1, e2))
3023     {
3024       bitmap_clear_bit (e1, SSA_NAME_VERSION (n1));
3025       bitmap_clear_bit (e2, SSA_NAME_VERSION (n2));
3026
3027       return (comp == EQ_EXPR || comp == GE_EXPR || comp == LE_EXPR)
3028              ? boolean_true_node
3029              : boolean_false_node;
3030     }
3031
3032   /* Otherwise, compare all the equivalent ranges.  First, add N1 and
3033      N2 to their own set of equivalences to avoid duplicating the body
3034      of the loop just to check N1 and N2 ranges.  */
3035   EXECUTE_IF_SET_IN_BITMAP (e1, 0, i1, bi1)
3036     {
3037       value_range_t vr1 = *(vr_value[i1]);
3038
3039       /* If the range is VARYING or UNDEFINED, use the name itself.  */
3040       if (vr1.type == VR_VARYING || vr1.type == VR_UNDEFINED)
3041         {
3042           vr1.type = VR_RANGE;
3043           vr1.min = ssa_name (i1);
3044           vr1.max = ssa_name (i1);
3045         }
3046
3047       t = retval = NULL_TREE;
3048       EXECUTE_IF_SET_IN_BITMAP (e2, 0, i2, bi2)
3049         {
3050           value_range_t vr2 = *(vr_value[i2]);
3051
3052           if (vr2.type == VR_VARYING || vr2.type == VR_UNDEFINED)
3053             {
3054               vr2.type = VR_RANGE;
3055               vr2.min = ssa_name (i2);
3056               vr2.max = ssa_name (i2);
3057             }
3058
3059           t = compare_ranges (comp, &vr1, &vr2);
3060           if (t)
3061             {
3062               /* All the ranges in the equivalent sets should compare
3063                  the same.  */
3064               gcc_assert (retval == NULL || t == retval);
3065               retval = t;
3066             }
3067         }
3068
3069       if (retval)
3070         {
3071           bitmap_clear_bit (e1, SSA_NAME_VERSION (n1));
3072           bitmap_clear_bit (e2, SSA_NAME_VERSION (n2));
3073           return retval;
3074         }
3075     }
3076
3077   /* None of the equivalent ranges are useful in computing this
3078      comparison.  */
3079   bitmap_clear_bit (e1, SSA_NAME_VERSION (n1));
3080   bitmap_clear_bit (e2, SSA_NAME_VERSION (n2));
3081   return NULL_TREE;
3082 }
3083
3084
3085 /* Given a conditional predicate COND, try to determine if COND yields
3086    true or false based on the value ranges of its operands.  Return
3087    BOOLEAN_TRUE_NODE if the conditional always evaluates to true,
3088    BOOLEAN_FALSE_NODE if the conditional always evaluates to false, and,
3089    NULL if the conditional cannot be evaluated at compile time.
3090
3091    If USE_EQUIV_P is true, the ranges of all the names equivalent with
3092    the operands in COND are used when trying to compute its value.
3093    This is only used during final substitution.  During propagation,
3094    we only check the range of each variable and not its equivalents.  */
3095
3096 tree
3097 vrp_evaluate_conditional (tree cond, bool use_equiv_p)
3098 {
3099   gcc_assert (TREE_CODE (cond) == SSA_NAME
3100               || TREE_CODE_CLASS (TREE_CODE (cond)) == tcc_comparison);
3101
3102   if (TREE_CODE (cond) == SSA_NAME)
3103     {
3104       value_range_t *vr;
3105       tree retval;
3106
3107       if (use_equiv_p)
3108         retval = compare_name_with_value (NE_EXPR, cond, boolean_false_node);
3109       else
3110         {
3111           value_range_t *vr = get_value_range (cond);
3112           retval = compare_range_with_value (NE_EXPR, vr, boolean_false_node);
3113         }
3114
3115       /* If COND has a known boolean range, return it.  */
3116       if (retval)
3117         return retval;
3118
3119       /* Otherwise, if COND has a symbolic range of exactly one value,
3120          return it.  */
3121       vr = get_value_range (cond);
3122       if (vr->type == VR_RANGE && vr->min == vr->max)
3123         return vr->min;
3124     }
3125   else
3126     {
3127       tree op0 = TREE_OPERAND (cond, 0);
3128       tree op1 = TREE_OPERAND (cond, 1);
3129
3130       /* We only deal with integral and pointer types.  */
3131       if (!INTEGRAL_TYPE_P (TREE_TYPE (op0))
3132           && !POINTER_TYPE_P (TREE_TYPE (op0)))
3133         return NULL_TREE;
3134
3135       if (use_equiv_p)
3136         {
3137           if (TREE_CODE (op0) == SSA_NAME && TREE_CODE (op1) == SSA_NAME)
3138             return compare_names (TREE_CODE (cond), op0, op1);
3139           else if (TREE_CODE (op0) == SSA_NAME)
3140             return compare_name_with_value (TREE_CODE (cond), op0, op1);
3141           else if (TREE_CODE (op1) == SSA_NAME)
3142             return compare_name_with_value (
3143                     swap_tree_comparison (TREE_CODE (cond)), op1, op0);
3144         }
3145       else
3146         {
3147           value_range_t *vr0, *vr1;
3148
3149           vr0 = (TREE_CODE (op0) == SSA_NAME) ? get_value_range (op0) : NULL;
3150           vr1 = (TREE_CODE (op1) == SSA_NAME) ? get_value_range (op1) : NULL;
3151
3152           if (vr0 && vr1)
3153             return compare_ranges (TREE_CODE (cond), vr0, vr1);
3154           else if (vr0 && vr1 == NULL)
3155             return compare_range_with_value (TREE_CODE (cond), vr0, op1);
3156           else if (vr0 == NULL && vr1)
3157             return compare_range_with_value (
3158                     swap_tree_comparison (TREE_CODE (cond)), vr1, op0);
3159         }
3160     }
3161
3162   /* Anything else cannot be computed statically.  */
3163   return NULL_TREE;
3164 }
3165
3166
3167 /* Visit conditional statement STMT.  If we can determine which edge
3168    will be taken out of STMT's basic block, record it in
3169    *TAKEN_EDGE_P and return SSA_PROP_INTERESTING.  Otherwise, return
3170    SSA_PROP_VARYING.  */
3171
3172 static enum ssa_prop_result
3173 vrp_visit_cond_stmt (tree stmt, edge *taken_edge_p)
3174 {
3175   tree cond, val;
3176
3177   *taken_edge_p = NULL;
3178
3179   /* FIXME.  Handle SWITCH_EXPRs.  But first, the assert pass needs to
3180      add ASSERT_EXPRs for them.  */
3181   if (TREE_CODE (stmt) == SWITCH_EXPR)
3182     return SSA_PROP_VARYING;
3183
3184   cond = COND_EXPR_COND (stmt);
3185
3186   if (dump_file && (dump_flags & TDF_DETAILS))
3187     {
3188       tree use;
3189       ssa_op_iter i;
3190
3191       fprintf (dump_file, "\nVisiting conditional with predicate: ");
3192       print_generic_expr (dump_file, cond, 0);
3193       fprintf (dump_file, "\nWith known ranges\n");
3194       
3195       FOR_EACH_SSA_TREE_OPERAND (use, stmt, i, SSA_OP_USE)
3196         {
3197           fprintf (dump_file, "\t");
3198           print_generic_expr (dump_file, use, 0);
3199           fprintf (dump_file, ": ");
3200           dump_value_range (dump_file, vr_value[SSA_NAME_VERSION (use)]);
3201         }
3202
3203       fprintf (dump_file, "\n");
3204     }
3205
3206   /* Compute the value of the predicate COND by checking the known
3207      ranges of each of its operands.
3208      
3209      Note that we cannot evaluate all the equivalent ranges here
3210      because those ranges may not yet be final and with the current
3211      propagation strategy, we cannot determine when the value ranges
3212      of the names in the equivalence set have changed.
3213
3214      For instance, given the following code fragment
3215
3216         i_5 = PHI <8, i_13>
3217         ...
3218         i_14 = ASSERT_EXPR <i_5, i_5 != 0>
3219         if (i_14 == 1)
3220           ...
3221
3222      Assume that on the first visit to i_14, i_5 has the temporary
3223      range [8, 8] because the second argument to the PHI function is
3224      not yet executable.  We derive the range ~[0, 0] for i_14 and the
3225      equivalence set { i_5 }.  So, when we visit 'if (i_14 == 1)' for
3226      the first time, since i_14 is equivalent to the range [8, 8], we
3227      determine that the predicate is always false.
3228
3229      On the next round of propagation, i_13 is determined to be
3230      VARYING, which causes i_5 to drop down to VARYING.  So, another
3231      visit to i_14 is scheduled.  In this second visit, we compute the
3232      exact same range and equivalence set for i_14, namely ~[0, 0] and
3233      { i_5 }.  But we did not have the previous range for i_5
3234      registered, so vrp_visit_assignment thinks that the range for
3235      i_14 has not changed.  Therefore, the predicate 'if (i_14 == 1)'
3236      is not visited again, which stops propagation from visiting
3237      statements in the THEN clause of that if().
3238
3239      To properly fix this we would need to keep the previous range
3240      value for the names in the equivalence set.  This way we would've
3241      discovered that from one visit to the other i_5 changed from
3242      range [8, 8] to VR_VARYING.
3243
3244      However, fixing this apparent limitation may not be worth the
3245      additional checking.  Testing on several code bases (GCC, DLV,
3246      MICO, TRAMP3D and SPEC2000) showed that doing this results in
3247      4 more predicates folded in SPEC.  */
3248   val = vrp_evaluate_conditional (cond, false);
3249   if (val)
3250     *taken_edge_p = find_taken_edge (bb_for_stmt (stmt), val);
3251
3252   if (dump_file && (dump_flags & TDF_DETAILS))
3253     {
3254       fprintf (dump_file, "\nPredicate evaluates to: ");
3255       if (val == NULL_TREE)
3256         fprintf (dump_file, "DON'T KNOW\n");
3257       else
3258         print_generic_stmt (dump_file, val, 0);
3259     }
3260
3261   return (*taken_edge_p) ? SSA_PROP_INTERESTING : SSA_PROP_VARYING;
3262 }
3263
3264
3265 /* Evaluate statement STMT.  If the statement produces a useful range,
3266    return SSA_PROP_INTERESTING and record the SSA name with the
3267    interesting range into *OUTPUT_P.
3268
3269    If STMT is a conditional branch and we can determine its truth
3270    value, the taken edge is recorded in *TAKEN_EDGE_P.
3271
3272    If STMT produces a varying value, return SSA_PROP_VARYING.  */
3273
3274 static enum ssa_prop_result
3275 vrp_visit_stmt (tree stmt, edge *taken_edge_p, tree *output_p)
3276 {
3277   tree def;
3278   ssa_op_iter iter;
3279   stmt_ann_t ann;
3280
3281   if (dump_file && (dump_flags & TDF_DETAILS))
3282     {
3283       fprintf (dump_file, "\nVisiting statement:\n");
3284       print_generic_stmt (dump_file, stmt, dump_flags);
3285       fprintf (dump_file, "\n");
3286     }
3287
3288   ann = stmt_ann (stmt);
3289   if (TREE_CODE (stmt) == MODIFY_EXPR
3290       && ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS))
3291     return vrp_visit_assignment (stmt, output_p);
3292   else if (TREE_CODE (stmt) == COND_EXPR || TREE_CODE (stmt) == SWITCH_EXPR)
3293     return vrp_visit_cond_stmt (stmt, taken_edge_p);
3294
3295   /* All other statements produce nothing of interest for VRP, so mark
3296      their outputs varying and prevent further simulation.  */
3297   FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
3298     set_value_range_to_varying (get_value_range (def));
3299
3300   return SSA_PROP_VARYING;
3301 }
3302
3303
3304 /* Meet operation for value ranges.  Given two value ranges VR0 and
3305    VR1, store in VR0 the result of meeting VR0 and VR1.
3306    
3307    The meeting rules are as follows:
3308
3309    1- If VR0 and VR1 have an empty intersection, set VR0 to VR_VARYING.
3310
3311    2- If VR0 and VR1 have a non-empty intersection, set VR0 to the
3312       union of VR0 and VR1.  */
3313
3314 static void
3315 vrp_meet (value_range_t *vr0, value_range_t *vr1)
3316 {
3317   if (vr0->type == VR_UNDEFINED)
3318     {
3319       copy_value_range (vr0, vr1);
3320       return;
3321     }
3322
3323   if (vr1->type == VR_UNDEFINED)
3324     {
3325       /* Nothing to do.  VR0 already has the resulting range.  */
3326       return;
3327     }
3328
3329   if (vr0->type == VR_VARYING)
3330     {
3331       /* Nothing to do.  VR0 already has the resulting range.  */
3332       return;
3333     }
3334
3335   if (vr1->type == VR_VARYING)
3336     {
3337       set_value_range_to_varying (vr0);
3338       return;
3339     }
3340
3341   if (vr0->type == VR_RANGE && vr1->type == VR_RANGE)
3342     {
3343       /* If VR0 and VR1 have a non-empty intersection, compute the
3344          union of both ranges.  */
3345       if (value_ranges_intersect_p (vr0, vr1))
3346         {
3347           int cmp;
3348           tree min, max;
3349
3350           /* The lower limit of the new range is the minimum of the
3351              two ranges.  If they cannot be compared, the result is
3352              VARYING.  */
3353           cmp = compare_values (vr0->min, vr1->min);
3354           if (cmp == 0 || cmp == 1)
3355             min = vr1->min;
3356           else if (cmp == -1)
3357             min = vr0->min;
3358           else
3359             {
3360               set_value_range_to_varying (vr0);
3361               return;
3362             }
3363
3364           /* Similarly, the upper limit of the new range is the
3365              maximum of the two ranges.  If they cannot be compared,
3366              the result is VARYING.  */
3367           cmp = compare_values (vr0->max, vr1->max);
3368           if (cmp == 0 || cmp == -1)
3369             max = vr1->max;
3370           else if (cmp == 1)
3371             max = vr0->max;
3372           else
3373             {
3374               set_value_range_to_varying (vr0);
3375               return;
3376             }
3377
3378           /* The resulting set of equivalences is the intersection of
3379              the two sets.  */
3380           if (vr0->equiv && vr1->equiv && vr0->equiv != vr1->equiv)
3381             bitmap_and_into (vr0->equiv, vr1->equiv);
3382           else if (vr0->equiv && !vr1->equiv)
3383             bitmap_clear (vr0->equiv);
3384
3385           set_value_range (vr0, vr0->type, min, max, vr0->equiv);
3386         }
3387       else
3388         goto no_meet;
3389     }
3390   else if (vr0->type == VR_ANTI_RANGE && vr1->type == VR_ANTI_RANGE)
3391     {
3392       /* Two anti-ranges meet only if they are both identical.  */
3393       if (compare_values (vr0->min, vr1->min) == 0
3394           && compare_values (vr0->max, vr1->max) == 0
3395           && compare_values (vr0->min, vr0->max) == 0)
3396         {
3397           /* The resulting set of equivalences is the intersection of
3398              the two sets.  */
3399           if (vr0->equiv && vr1->equiv && vr0->equiv != vr1->equiv)
3400             bitmap_and_into (vr0->equiv, vr1->equiv);
3401           else if (vr0->equiv && !vr1->equiv)
3402             bitmap_clear (vr0->equiv);
3403         }
3404       else
3405         goto no_meet;
3406     }
3407   else if (vr0->type == VR_ANTI_RANGE || vr1->type == VR_ANTI_RANGE)
3408     {
3409       /* A numeric range [VAL1, VAL2] and an anti-range ~[VAL3, VAL4]
3410          meet only if the ranges have an empty intersection.  The
3411          result of the meet operation is the anti-range.  */
3412       if (!symbolic_range_p (vr0)
3413           && !symbolic_range_p (vr1)
3414           && !value_ranges_intersect_p (vr0, vr1))
3415         {
3416           if (vr1->type == VR_ANTI_RANGE)
3417             copy_value_range (vr0, vr1);
3418
3419           /* The resulting set of equivalences is the intersection of
3420              the two sets.  */
3421           if (vr0->equiv && vr1->equiv && vr0->equiv != vr1->equiv)
3422             bitmap_and_into (vr0->equiv, vr1->equiv);
3423           else if (vr0->equiv && !vr1->equiv)
3424             bitmap_clear (vr0->equiv);
3425         }
3426       else
3427         goto no_meet;
3428     }
3429   else
3430     gcc_unreachable ();
3431
3432   return;
3433
3434 no_meet:
3435   /* The two range VR0 and VR1 do not meet.  Before giving up and
3436      setting the result to VARYING, see if we can at least derive a
3437      useful anti-range.  */
3438   if (!symbolic_range_p (vr0)
3439       && !range_includes_zero_p (vr0)
3440       && !symbolic_range_p (vr1)
3441       && !range_includes_zero_p (vr1))
3442     set_value_range_to_nonnull (vr0, TREE_TYPE (vr0->min));
3443   else
3444     set_value_range_to_varying (vr0);
3445 }
3446
3447
3448 /* Visit all arguments for PHI node PHI that flow through executable
3449    edges.  If a valid value range can be derived from all the incoming
3450    value ranges, set a new range for the LHS of PHI.  */
3451
3452 static enum ssa_prop_result
3453 vrp_visit_phi_node (tree phi)
3454 {
3455   int i;
3456   tree lhs = PHI_RESULT (phi);
3457   value_range_t *lhs_vr = get_value_range (lhs);
3458   value_range_t vr_result = { VR_UNDEFINED, NULL_TREE, NULL_TREE, NULL };
3459
3460   copy_value_range (&vr_result, lhs_vr);
3461
3462   if (dump_file && (dump_flags & TDF_DETAILS))
3463     {
3464       fprintf (dump_file, "\nVisiting PHI node: ");
3465       print_generic_expr (dump_file, phi, dump_flags);
3466     }
3467
3468   for (i = 0; i < PHI_NUM_ARGS (phi); i++)
3469     {
3470       edge e = PHI_ARG_EDGE (phi, i);
3471
3472       if (dump_file && (dump_flags & TDF_DETAILS))
3473         {
3474           fprintf (dump_file,
3475               "\n    Argument #%d (%d -> %d %sexecutable)\n",
3476               i, e->src->index, e->dest->index,
3477               (e->flags & EDGE_EXECUTABLE) ? "" : "not ");
3478         }
3479
3480       if (e->flags & EDGE_EXECUTABLE)
3481         {
3482           tree arg = PHI_ARG_DEF (phi, i);
3483           value_range_t vr_arg;
3484
3485           if (TREE_CODE (arg) == SSA_NAME)
3486             vr_arg = *(get_value_range (arg));
3487           else
3488             {
3489               vr_arg.type = VR_RANGE;
3490               vr_arg.min = arg;
3491               vr_arg.max = arg;
3492               vr_arg.equiv = NULL;
3493             }
3494
3495           if (dump_file && (dump_flags & TDF_DETAILS))
3496             {
3497               fprintf (dump_file, "\t");
3498               print_generic_expr (dump_file, arg, dump_flags);
3499               fprintf (dump_file, "\n\tValue: ");
3500               dump_value_range (dump_file, &vr_arg);
3501               fprintf (dump_file, "\n");
3502             }
3503
3504           vrp_meet (&vr_result, &vr_arg);
3505
3506           if (vr_result.type == VR_VARYING)
3507             break;
3508         }
3509     }
3510
3511   if (vr_result.type == VR_VARYING)
3512     goto varying;
3513
3514   /* To prevent infinite iterations in the algorithm, derive ranges
3515      when the new value is slightly bigger or smaller than the
3516      previous one.  */
3517   if (lhs_vr->type == VR_RANGE)
3518     {
3519       if (!POINTER_TYPE_P (TREE_TYPE (lhs)))
3520         {
3521           int cmp_min = compare_values (lhs_vr->min, vr_result.min);
3522           int cmp_max = compare_values (lhs_vr->max, vr_result.max);
3523
3524           /* If the new minimum is smaller or larger than the previous
3525              one, go all the way to -INF.  In the first case, to avoid
3526              iterating millions of times to reach -INF, and in the
3527              other case to avoid infinite bouncing between different
3528              minimums.  */
3529           if (cmp_min > 0 || cmp_min < 0)
3530             vr_result.min = TYPE_MIN_VALUE (TREE_TYPE (vr_result.min));
3531
3532           /* Similarly, if the new maximum is smaller or larger than
3533              the previous one, go all the way to +INF.  */
3534           if (cmp_max < 0 || cmp_max > 0)
3535             vr_result.max = TYPE_MAX_VALUE (TREE_TYPE (vr_result.max));
3536
3537           /* If we ended up with a (-INF, +INF) range, set it to
3538              VARYING.  */
3539           if (vr_result.min == TYPE_MIN_VALUE (TREE_TYPE (vr_result.min))
3540               && vr_result.max == TYPE_MAX_VALUE (TREE_TYPE (vr_result.max)))
3541             goto varying;
3542         }
3543     }
3544
3545   /* If the new range is different than the previous value, keep
3546      iterating.  */
3547   if (update_value_range (lhs, &vr_result))
3548     return SSA_PROP_INTERESTING;
3549
3550   /* Nothing changed, don't add outgoing edges.  */
3551   return SSA_PROP_NOT_INTERESTING;
3552
3553   /* No match found.  Set the LHS to VARYING.  */
3554 varying:
3555   set_value_range_to_varying (lhs_vr);
3556   return SSA_PROP_VARYING;
3557 }
3558
3559 /* Simplify a division or modulo operator to a right shift or
3560    bitwise and if the first operand is unsigned or is greater
3561    than zero and the second operand is an exact power of two.  */
3562
3563 static void
3564 simplify_div_or_mod_using_ranges (tree stmt, tree rhs, enum tree_code rhs_code)
3565 {
3566   tree val = NULL;
3567   tree op = TREE_OPERAND (rhs, 0);
3568   value_range_t *vr = get_value_range (TREE_OPERAND (rhs, 0));
3569
3570   if (TYPE_UNSIGNED (TREE_TYPE (op)))
3571     {
3572       val = integer_one_node;
3573     }
3574   else
3575     {
3576       val = compare_range_with_value (GT_EXPR, vr, integer_zero_node);
3577     }
3578
3579   if (val && integer_onep (val))
3580     {
3581       tree t;
3582       tree op0 = TREE_OPERAND (rhs, 0);
3583       tree op1 = TREE_OPERAND (rhs, 1);
3584
3585       if (rhs_code == TRUNC_DIV_EXPR)
3586         {
3587           t = build_int_cst (NULL_TREE, tree_log2 (op1));
3588           t = build2 (RSHIFT_EXPR, TREE_TYPE (op0), op0, t);
3589         }
3590       else
3591         {
3592           t = build_int_cst (TREE_TYPE (op1), 1);
3593           t = int_const_binop (MINUS_EXPR, op1, t, 0);
3594           t = fold_convert (TREE_TYPE (op0), t);
3595           t = build2 (BIT_AND_EXPR, TREE_TYPE (op0), op0, t);
3596         }
3597
3598       TREE_OPERAND (stmt, 1) = t;
3599       update_stmt (stmt);
3600     }
3601 }
3602
3603 /* If the operand to an ABS_EXPR is >= 0, then eliminate the
3604    ABS_EXPR.  If the operand is <= 0, then simplify the
3605    ABS_EXPR into a NEGATE_EXPR.  */
3606
3607 static void
3608 simplify_abs_using_ranges (tree stmt, tree rhs)
3609 {
3610   tree val = NULL;
3611   tree op = TREE_OPERAND (rhs, 0);
3612   tree type = TREE_TYPE (op);
3613   value_range_t *vr = get_value_range (TREE_OPERAND (rhs, 0));
3614
3615   if (TYPE_UNSIGNED (type))
3616     {
3617       val = integer_zero_node;
3618     }
3619   else if (vr)
3620     {
3621       val = compare_range_with_value (LE_EXPR, vr, integer_zero_node);
3622       if (!val)
3623         {
3624           val = compare_range_with_value (GE_EXPR, vr, integer_zero_node);
3625
3626           if (val)
3627             {
3628               if (integer_zerop (val))
3629                 val = integer_one_node;
3630               else if (integer_onep (val))
3631                 val = integer_zero_node;
3632             }
3633         }
3634
3635       if (val
3636           && (integer_onep (val) || integer_zerop (val)))
3637         {
3638           tree t;
3639
3640           if (integer_onep (val))
3641             t = build1 (NEGATE_EXPR, TREE_TYPE (op), op);
3642           else
3643             t = op;
3644
3645           TREE_OPERAND (stmt, 1) = t;
3646           update_stmt (stmt);
3647         }
3648     }
3649 }
3650
3651 /* We are comparing trees OP0 and OP1 using COND_CODE.  OP0 has
3652    a known value range VR.
3653
3654    If there is one and only one value which will satisfy the
3655    conditional, then return that value.  Else return NULL.  */
3656
3657 static tree
3658 test_for_singularity (enum tree_code cond_code, tree op0,
3659                       tree op1, value_range_t *vr)
3660 {
3661   tree min = NULL;
3662   tree max = NULL;
3663
3664   /* Extract minimum/maximum values which satisfy the
3665      the conditional as it was written.  */
3666   if (cond_code == LE_EXPR || cond_code == LT_EXPR)
3667     {
3668       min = TYPE_MIN_VALUE (TREE_TYPE (op0));
3669
3670       max = op1;
3671       if (cond_code == LT_EXPR)
3672         {
3673           tree one = build_int_cst (TREE_TYPE (op0), 1);
3674           max = fold_build2 (MINUS_EXPR, TREE_TYPE (op0), max, one);
3675         }
3676     }
3677   else if (cond_code == GE_EXPR || cond_code == GT_EXPR)
3678     {
3679       max = TYPE_MAX_VALUE (TREE_TYPE (op0));
3680
3681       min = op1;
3682       if (cond_code == GT_EXPR)
3683         {
3684           tree one = build_int_cst (TREE_TYPE (op0), 1);
3685           max = fold_build2 (PLUS_EXPR, TREE_TYPE (op0), max, one);
3686         }
3687     }
3688
3689   /* Now refine the minimum and maximum values using any
3690      value range information we have for op0.  */
3691   if (min && max)
3692     {
3693       if (compare_values (vr->min, min) == -1)
3694         min = min;
3695       else
3696         min = vr->min;
3697       if (compare_values (vr->max, max) == 1)
3698         max = max;
3699       else
3700         max = vr->max;
3701
3702       /* If the new min/max values have converged to a
3703          single value, then there is only one value which
3704          can satisfy the condition, return that value.  */
3705       if (min == max && is_gimple_min_invariant (min))
3706         return min;
3707     }
3708   return NULL;
3709 }
3710
3711 /* Simplify a conditional using a relational operator to an equality
3712    test if the range information indicates only one value can satisfy
3713    the original conditional.  */
3714
3715 static void
3716 simplify_cond_using_ranges (tree stmt)
3717 {
3718   tree cond = COND_EXPR_COND (stmt);
3719   tree op0 = TREE_OPERAND (cond, 0);
3720   tree op1 = TREE_OPERAND (cond, 1);
3721   enum tree_code cond_code = TREE_CODE (cond);
3722
3723   if (cond_code != NE_EXPR
3724       && cond_code != EQ_EXPR
3725       && TREE_CODE (op0) == SSA_NAME
3726       && INTEGRAL_TYPE_P (TREE_TYPE (op0))
3727       && is_gimple_min_invariant (op1))
3728     {
3729       value_range_t *vr = get_value_range (op0);
3730           
3731       /* If we have range information for OP0, then we might be
3732          able to simplify this conditional. */
3733       if (vr->type == VR_RANGE)
3734         {
3735           tree new = test_for_singularity (cond_code, op0, op1, vr);
3736
3737           if (new)
3738             {
3739               if (dump_file)
3740                 {
3741                   fprintf (dump_file, "Simplified relational ");
3742                   print_generic_expr (dump_file, cond, 0);
3743                   fprintf (dump_file, " into ");
3744                 }
3745
3746               COND_EXPR_COND (stmt)
3747                 = build (EQ_EXPR, boolean_type_node, op0, new);
3748               update_stmt (stmt);
3749
3750               if (dump_file)
3751                 {
3752                   print_generic_expr (dump_file, COND_EXPR_COND (stmt), 0);
3753                   fprintf (dump_file, "\n");
3754                 }
3755               return;
3756
3757             }
3758
3759           /* Try again after inverting the condition.  We only deal
3760              with integral types here, so no need to worry about
3761              issues with inverting FP comparisons.  */
3762           cond_code = invert_tree_comparison (cond_code, false);
3763           new = test_for_singularity (cond_code, op0, op1, vr);
3764
3765           if (new)
3766             {
3767               if (dump_file)
3768                 {
3769                   fprintf (dump_file, "Simplified relational ");
3770                   print_generic_expr (dump_file, cond, 0);
3771                   fprintf (dump_file, " into ");
3772                 }
3773
3774               COND_EXPR_COND (stmt)
3775                 = build (NE_EXPR, boolean_type_node, op0, new);
3776               update_stmt (stmt);
3777
3778               if (dump_file)
3779                 {
3780                   print_generic_expr (dump_file, COND_EXPR_COND (stmt), 0);
3781                   fprintf (dump_file, "\n");
3782                 }
3783               return;
3784
3785             }
3786         }
3787     }
3788 }
3789
3790 /* Simplify STMT using ranges if possible.  */
3791
3792 void
3793 simplify_stmt_using_ranges (tree stmt)
3794 {
3795   if (TREE_CODE (stmt) == MODIFY_EXPR)
3796     {
3797       tree rhs = TREE_OPERAND (stmt, 1);
3798       enum tree_code rhs_code = TREE_CODE (rhs);
3799
3800       /* Transform TRUNC_DIV_EXPR and TRUNC_MOD_EXPR into RSHIFT_EXPR
3801          and BIT_AND_EXPR respectively if the first operand is greater
3802          than zero and the second operand is an exact power of two.  */
3803       if ((rhs_code == TRUNC_DIV_EXPR || rhs_code == TRUNC_MOD_EXPR)
3804           && INTEGRAL_TYPE_P (TREE_TYPE (TREE_OPERAND (rhs, 0)))
3805           && integer_pow2p (TREE_OPERAND (rhs, 1)))
3806         simplify_div_or_mod_using_ranges (stmt, rhs, rhs_code);
3807
3808       /* Transform ABS (X) into X or -X as appropriate.  */
3809       if (rhs_code == ABS_EXPR
3810           && TREE_CODE (TREE_OPERAND (rhs, 0)) == SSA_NAME
3811           && INTEGRAL_TYPE_P (TREE_TYPE (TREE_OPERAND (rhs, 0))))
3812         simplify_abs_using_ranges (stmt, rhs);
3813     }
3814   else if (TREE_CODE (stmt) == COND_EXPR
3815            && COMPARISON_CLASS_P (COND_EXPR_COND (stmt)))
3816     {
3817       simplify_cond_using_ranges (stmt);
3818     }
3819 }
3820
3821
3822
3823 /* Traverse all the blocks folding conditionals with known ranges.  */
3824
3825 static void
3826 vrp_finalize (void)
3827 {
3828   size_t i;
3829   prop_value_t *single_val_range;
3830   bool do_value_subst_p;
3831
3832   if (dump_file)
3833     {
3834       fprintf (dump_file, "\nValue ranges after VRP:\n\n");
3835       dump_all_value_ranges (dump_file);
3836       fprintf (dump_file, "\n");
3837     }
3838
3839   /* We may have ended with ranges that have exactly one value.  Those
3840      values can be substituted as any other copy/const propagated
3841      value using substitute_and_fold.  */
3842   single_val_range = xmalloc (num_ssa_names * sizeof (*single_val_range));
3843   memset (single_val_range, 0, num_ssa_names * sizeof (*single_val_range));
3844
3845   do_value_subst_p = false;
3846   for (i = 0; i < num_ssa_names; i++)
3847     if (vr_value[i]
3848         && vr_value[i]->type == VR_RANGE
3849         && vr_value[i]->min == vr_value[i]->max)
3850       {
3851         single_val_range[i].value = vr_value[i]->min;
3852         do_value_subst_p = true;
3853       }
3854
3855   if (!do_value_subst_p)
3856     {
3857       /* We found no single-valued ranges, don't waste time trying to
3858          do single value substitution in substitute_and_fold.  */
3859       free (single_val_range);
3860       single_val_range = NULL;
3861     }
3862
3863   substitute_and_fold (single_val_range, true);
3864
3865   /* Free allocated memory.  */
3866   for (i = 0; i < num_ssa_names; i++)
3867     if (vr_value[i])
3868       {
3869         BITMAP_FREE (vr_value[i]->equiv);
3870         free (vr_value[i]);
3871       }
3872
3873   free (single_val_range);
3874   free (vr_value);
3875 }
3876
3877
3878 /* Main entry point to VRP (Value Range Propagation).  This pass is
3879    loosely based on J. R. C. Patterson, ``Accurate Static Branch
3880    Prediction by Value Range Propagation,'' in SIGPLAN Conference on
3881    Programming Language Design and Implementation, pp. 67-78, 1995.
3882    Also available at http://citeseer.ist.psu.edu/patterson95accurate.html
3883
3884    This is essentially an SSA-CCP pass modified to deal with ranges
3885    instead of constants.
3886
3887    While propagating ranges, we may find that two or more SSA name
3888    have equivalent, though distinct ranges.  For instance,
3889
3890      1  x_9 = p_3->a;
3891      2  p_4 = ASSERT_EXPR <p_3, p_3 != 0>
3892      3  if (p_4 == q_2)
3893      4    p_5 = ASSERT_EXPR <p_4, p_4 == q_2>;
3894      5  endif
3895      6  if (q_2)
3896         
3897    In the code above, pointer p_5 has range [q_2, q_2], but from the
3898    code we can also determine that p_5 cannot be NULL and, if q_2 had
3899    a non-varying range, p_5's range should also be compatible with it.
3900
3901    These equivalences are created by two expressions: ASSERT_EXPR and
3902    copy operations.  Since p_5 is an assertion on p_4, and p_4 was the
3903    result of another assertion, then we can use the fact that p_5 and
3904    p_4 are equivalent when evaluating p_5's range.
3905
3906    Together with value ranges, we also propagate these equivalences
3907    between names so that we can take advantage of information from
3908    multiple ranges when doing final replacement.  Note that this
3909    equivalency relation is transitive but not symmetric.
3910    
3911    In the example above, p_5 is equivalent to p_4, q_2 and p_3, but we
3912    cannot assert that q_2 is equivalent to p_5 because q_2 may be used
3913    in contexts where that assertion does not hold (e.g., in line 6).
3914
3915    TODO, the main difference between this pass and Patterson's is that
3916    we do not propagate edge probabilities.  We only compute whether
3917    edges can be taken or not.  That is, instead of having a spectrum
3918    of jump probabilities between 0 and 1, we only deal with 0, 1 and
3919    DON'T KNOW.  In the future, it may be worthwhile to propagate
3920    probabilities to aid branch prediction.  */
3921
3922 static void
3923 execute_vrp (void)
3924 {
3925   insert_range_assertions ();
3926
3927   cfg_loops = loop_optimizer_init (NULL);
3928   if (cfg_loops)
3929     scev_initialize (cfg_loops);
3930
3931   vrp_initialize ();
3932   ssa_propagate (vrp_visit_stmt, vrp_visit_phi_node);
3933   vrp_finalize ();
3934
3935   if (cfg_loops)
3936     {
3937       scev_finalize ();
3938       loop_optimizer_finalize (cfg_loops, NULL);
3939       current_loops = NULL;
3940     }
3941
3942   remove_range_assertions ();
3943 }
3944
3945 static bool
3946 gate_vrp (void)
3947 {
3948   return flag_tree_vrp != 0;
3949 }
3950
3951 struct tree_opt_pass pass_vrp =
3952 {
3953   "vrp",                                /* name */
3954   gate_vrp,                             /* gate */
3955   execute_vrp,                          /* execute */
3956   NULL,                                 /* sub */
3957   NULL,                                 /* next */
3958   0,                                    /* static_pass_number */
3959   TV_TREE_VRP,                          /* tv_id */
3960   PROP_ssa | PROP_alias,                /* properties_required */
3961   0,                                    /* properties_provided */
3962   0,                                    /* properties_destroyed */
3963   0,                                    /* todo_flags_start */
3964   TODO_cleanup_cfg
3965     | TODO_ggc_collect
3966     | TODO_verify_ssa
3967     | TODO_dump_func
3968     | TODO_update_ssa,                  /* todo_flags_finish */
3969   0                                     /* letter */
3970 };