1 /* Code for GIMPLE range related routines.
2 Copyright (C) 2019-2022 Free Software Foundation, Inc.
3 Contributed by Andrew MacLeod <amacleod@redhat.com>
4 and Aldy Hernandez <aldyh@redhat.com>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
24 #include "coretypes.h"
26 #include "insn-codes.h"
30 #include "gimple-pretty-print.h"
31 #include "optabs-tree.h"
32 #include "gimple-iterator.h"
33 #include "gimple-fold.h"
35 #include "fold-const.h"
36 #include "case-cfn-macros.h"
37 #include "omp-general.h"
39 #include "tree-ssa-loop.h"
40 #include "tree-scalar-evolution.h"
41 #include "langhooks.h"
42 #include "vr-values.h"
44 #include "value-query.h"
45 #include "gimple-range-op.h"
46 #include "gimple-range.h"
47 // Construct a fur_source, and set the m_query field.
49 fur_source::fur_source (range_query
*q
)
54 m_query
= get_range_query (cfun
);
56 m_query
= get_global_range_query ();
60 // Invoke range_of_expr on EXPR.
63 fur_source::get_operand (vrange
&r
, tree expr
)
65 return m_query
->range_of_expr (r
, expr
);
68 // Evaluate EXPR for this stmt as a PHI argument on edge E. Use the current
69 // range_query to get the range on the edge.
72 fur_source::get_phi_operand (vrange
&r
, tree expr
, edge e
)
74 return m_query
->range_on_edge (r
, e
, expr
);
77 // Default is no relation.
80 fur_source::query_relation (tree op1 ATTRIBUTE_UNUSED
,
81 tree op2 ATTRIBUTE_UNUSED
)
86 // Default registers nothing.
89 fur_source::register_relation (gimple
*s ATTRIBUTE_UNUSED
,
90 relation_kind k ATTRIBUTE_UNUSED
,
91 tree op1 ATTRIBUTE_UNUSED
,
92 tree op2 ATTRIBUTE_UNUSED
)
96 // Default registers nothing.
99 fur_source::register_relation (edge e ATTRIBUTE_UNUSED
,
100 relation_kind k ATTRIBUTE_UNUSED
,
101 tree op1 ATTRIBUTE_UNUSED
,
102 tree op2 ATTRIBUTE_UNUSED
)
106 // This version of fur_source will pick a range up off an edge.
108 class fur_edge
: public fur_source
111 fur_edge (edge e
, range_query
*q
= NULL
);
112 virtual bool get_operand (vrange
&r
, tree expr
) override
;
113 virtual bool get_phi_operand (vrange
&r
, tree expr
, edge e
) override
;
118 // Instantiate an edge based fur_source.
121 fur_edge::fur_edge (edge e
, range_query
*q
) : fur_source (q
)
126 // Get the value of EXPR on edge m_edge.
129 fur_edge::get_operand (vrange
&r
, tree expr
)
131 return m_query
->range_on_edge (r
, m_edge
, expr
);
134 // Evaluate EXPR for this stmt as a PHI argument on edge E. Use the current
135 // range_query to get the range on the edge.
138 fur_edge::get_phi_operand (vrange
&r
, tree expr
, edge e
)
140 // Edge to edge recalculations not supoprted yet, until we sort it out.
141 gcc_checking_assert (e
== m_edge
);
142 return m_query
->range_on_edge (r
, e
, expr
);
145 // Instantiate a stmt based fur_source.
147 fur_stmt::fur_stmt (gimple
*s
, range_query
*q
) : fur_source (q
)
152 // Retreive range of EXPR as it occurs as a use on stmt M_STMT.
155 fur_stmt::get_operand (vrange
&r
, tree expr
)
157 return m_query
->range_of_expr (r
, expr
, m_stmt
);
160 // Evaluate EXPR for this stmt as a PHI argument on edge E. Use the current
161 // range_query to get the range on the edge.
164 fur_stmt::get_phi_operand (vrange
&r
, tree expr
, edge e
)
166 // Pick up the range of expr from edge E.
167 fur_edge
e_src (e
, m_query
);
168 return e_src
.get_operand (r
, expr
);
171 // Return relation based from m_stmt.
174 fur_stmt::query_relation (tree op1
, tree op2
)
176 return m_query
->query_relation (m_stmt
, op1
, op2
);
179 // Instantiate a stmt based fur_source with a GORI object.
182 fur_depend::fur_depend (gimple
*s
, gori_compute
*gori
, range_query
*q
)
185 gcc_checking_assert (gori
);
187 // Set relations if there is an oracle in the range_query.
188 // This will enable registering of relationships as they are discovered.
189 m_oracle
= q
->oracle ();
193 // Register a relation on a stmt if there is an oracle.
196 fur_depend::register_relation (gimple
*s
, relation_kind k
, tree op1
, tree op2
)
199 m_oracle
->register_stmt (s
, k
, op1
, op2
);
202 // Register a relation on an edge if there is an oracle.
205 fur_depend::register_relation (edge e
, relation_kind k
, tree op1
, tree op2
)
208 m_oracle
->register_edge (e
, k
, op1
, op2
);
211 // This version of fur_source will pick a range up from a list of ranges
212 // supplied by the caller.
214 class fur_list
: public fur_source
217 fur_list (vrange
&r1
);
218 fur_list (vrange
&r1
, vrange
&r2
);
219 fur_list (unsigned num
, vrange
**list
);
220 virtual bool get_operand (vrange
&r
, tree expr
) override
;
221 virtual bool get_phi_operand (vrange
&r
, tree expr
, edge e
) override
;
229 // One range supplied for unary operations.
231 fur_list::fur_list (vrange
&r1
) : fur_source (NULL
)
239 // Two ranges supplied for binary operations.
241 fur_list::fur_list (vrange
&r1
, vrange
&r2
) : fur_source (NULL
)
250 // Arbitrary number of ranges in a vector.
252 fur_list::fur_list (unsigned num
, vrange
**list
) : fur_source (NULL
)
259 // Get the next operand from the vector, ensure types are compatible.
262 fur_list::get_operand (vrange
&r
, tree expr
)
264 if (m_index
>= m_limit
)
265 return m_query
->range_of_expr (r
, expr
);
266 r
= *m_list
[m_index
++];
267 gcc_checking_assert (range_compatible_p (TREE_TYPE (expr
), r
.type ()));
271 // This will simply pick the next operand from the vector.
273 fur_list::get_phi_operand (vrange
&r
, tree expr
, edge e ATTRIBUTE_UNUSED
)
275 return get_operand (r
, expr
);
278 // Fold stmt S into range R using R1 as the first operand.
281 fold_range (vrange
&r
, gimple
*s
, vrange
&r1
)
285 return f
.fold_stmt (r
, s
, src
);
288 // Fold stmt S into range R using R1 and R2 as the first two operands.
291 fold_range (vrange
&r
, gimple
*s
, vrange
&r1
, vrange
&r2
)
294 fur_list
src (r1
, r2
);
295 return f
.fold_stmt (r
, s
, src
);
298 // Fold stmt S into range R using NUM_ELEMENTS from VECTOR as the initial
299 // operands encountered.
302 fold_range (vrange
&r
, gimple
*s
, unsigned num_elements
, vrange
**vector
)
305 fur_list
src (num_elements
, vector
);
306 return f
.fold_stmt (r
, s
, src
);
309 // Fold stmt S into range R using range query Q.
312 fold_range (vrange
&r
, gimple
*s
, range_query
*q
)
316 return f
.fold_stmt (r
, s
, src
);
319 // Recalculate stmt S into R using range query Q as if it were on edge ON_EDGE.
322 fold_range (vrange
&r
, gimple
*s
, edge on_edge
, range_query
*q
)
325 fur_edge
src (on_edge
, q
);
326 return f
.fold_stmt (r
, s
, src
);
329 // -------------------------------------------------------------------------
331 // Adjust the range for a pointer difference where the operands came
334 // This notices the following sequence:
336 // def = __builtin_memchr (arg, 0, sz)
339 // The range for N can be narrowed to [0, PTRDIFF_MAX - 1].
342 adjust_pointer_diff_expr (irange
&res
, const gimple
*diff_stmt
)
344 tree op0
= gimple_assign_rhs1 (diff_stmt
);
345 tree op1
= gimple_assign_rhs2 (diff_stmt
);
346 tree op0_ptype
= TREE_TYPE (TREE_TYPE (op0
));
347 tree op1_ptype
= TREE_TYPE (TREE_TYPE (op1
));
350 if (TREE_CODE (op0
) == SSA_NAME
351 && TREE_CODE (op1
) == SSA_NAME
352 && (call
= SSA_NAME_DEF_STMT (op0
))
353 && is_gimple_call (call
)
354 && gimple_call_builtin_p (call
, BUILT_IN_MEMCHR
)
355 && TYPE_MODE (op0_ptype
) == TYPE_MODE (char_type_node
)
356 && TYPE_PRECISION (op0_ptype
) == TYPE_PRECISION (char_type_node
)
357 && TYPE_MODE (op1_ptype
) == TYPE_MODE (char_type_node
)
358 && TYPE_PRECISION (op1_ptype
) == TYPE_PRECISION (char_type_node
)
359 && gimple_call_builtin_p (call
, BUILT_IN_MEMCHR
)
360 && vrp_operand_equal_p (op1
, gimple_call_arg (call
, 0))
361 && integer_zerop (gimple_call_arg (call
, 1)))
363 tree max
= vrp_val_max (ptrdiff_type_node
);
364 unsigned prec
= TYPE_PRECISION (TREE_TYPE (max
));
365 wide_int wmaxm1
= wi::to_wide (max
, prec
) - 1;
366 res
.intersect (int_range
<2> (TREE_TYPE (max
), wi::zero (prec
), wmaxm1
));
370 // Adjust the range for an IMAGPART_EXPR.
373 adjust_imagpart_expr (vrange
&res
, const gimple
*stmt
)
375 tree name
= TREE_OPERAND (gimple_assign_rhs1 (stmt
), 0);
377 if (TREE_CODE (name
) != SSA_NAME
|| !SSA_NAME_DEF_STMT (name
))
380 gimple
*def_stmt
= SSA_NAME_DEF_STMT (name
);
381 if (is_gimple_call (def_stmt
) && gimple_call_internal_p (def_stmt
))
383 switch (gimple_call_internal_fn (def_stmt
))
385 case IFN_ADD_OVERFLOW
:
386 case IFN_SUB_OVERFLOW
:
387 case IFN_MUL_OVERFLOW
:
388 case IFN_ATOMIC_COMPARE_EXCHANGE
:
391 r
.set_varying (boolean_type_node
);
392 tree type
= TREE_TYPE (gimple_assign_lhs (stmt
));
393 range_cast (r
, type
);
401 if (is_gimple_assign (def_stmt
)
402 && gimple_assign_rhs_code (def_stmt
) == COMPLEX_CST
)
404 tree cst
= gimple_assign_rhs1 (def_stmt
);
405 if (TREE_CODE (cst
) == COMPLEX_CST
)
407 int_range
<2> imag (TREE_IMAGPART (cst
), TREE_IMAGPART (cst
));
408 res
.intersect (imag
);
413 // Adjust the range for a REALPART_EXPR.
416 adjust_realpart_expr (vrange
&res
, const gimple
*stmt
)
418 tree name
= TREE_OPERAND (gimple_assign_rhs1 (stmt
), 0);
420 if (TREE_CODE (name
) != SSA_NAME
)
423 gimple
*def_stmt
= SSA_NAME_DEF_STMT (name
);
424 if (!SSA_NAME_DEF_STMT (name
))
427 if (is_gimple_assign (def_stmt
)
428 && gimple_assign_rhs_code (def_stmt
) == COMPLEX_CST
)
430 tree cst
= gimple_assign_rhs1 (def_stmt
);
431 if (TREE_CODE (cst
) == COMPLEX_CST
)
433 tree imag
= TREE_REALPART (cst
);
434 int_range
<2> tmp (imag
, imag
);
440 // This function looks for situations when walking the use/def chains
441 // may provide additonal contextual range information not exposed on
445 gimple_range_adjustment (vrange
&res
, const gimple
*stmt
)
447 switch (gimple_expr_code (stmt
))
449 case POINTER_DIFF_EXPR
:
450 adjust_pointer_diff_expr (as_a
<irange
> (res
), stmt
);
454 adjust_imagpart_expr (res
, stmt
);
458 adjust_realpart_expr (res
, stmt
);
466 // Calculate a range for statement S and return it in R. If NAME is provided it
467 // represents the SSA_NAME on the LHS of the statement. It is only required
468 // if there is more than one lhs/output. If a range cannot
469 // be calculated, return false.
472 fold_using_range::fold_stmt (vrange
&r
, gimple
*s
, fur_source
&src
, tree name
)
475 // If name and S are specified, make sure it is an LHS of S.
476 gcc_checking_assert (!name
|| !gimple_get_lhs (s
) ||
477 name
== gimple_get_lhs (s
));
480 name
= gimple_get_lhs (s
);
482 // Process addresses.
483 if (gimple_code (s
) == GIMPLE_ASSIGN
484 && gimple_assign_rhs_code (s
) == ADDR_EXPR
)
485 return range_of_address (as_a
<irange
> (r
), s
, src
);
487 gimple_range_op_handler
handler (s
);
489 res
= range_of_range_op (r
, handler
, src
);
490 else if (is_a
<gphi
*>(s
))
491 res
= range_of_phi (r
, as_a
<gphi
*> (s
), src
);
492 else if (is_a
<gcall
*>(s
))
493 res
= range_of_call (r
, as_a
<gcall
*> (s
), src
);
494 else if (is_a
<gassign
*> (s
) && gimple_assign_rhs_code (s
) == COND_EXPR
)
495 res
= range_of_cond_expr (r
, as_a
<gassign
*> (s
), src
);
499 // If no name specified or range is unsupported, bail.
500 if (!name
|| !gimple_range_ssa_p (name
))
502 // We don't understand the stmt, so return the global range.
503 gimple_range_global (r
, name
);
507 if (r
.undefined_p ())
510 // We sometimes get compatible types copied from operands, make sure
511 // the correct type is being returned.
512 if (name
&& TREE_TYPE (name
) != r
.type ())
514 gcc_checking_assert (range_compatible_p (r
.type (), TREE_TYPE (name
)));
515 range_cast (r
, TREE_TYPE (name
));
520 // Calculate a range for range_op statement S and return it in R. If any
521 // If a range cannot be calculated, return false.
524 fold_using_range::range_of_range_op (vrange
&r
,
525 gimple_range_op_handler
&handler
,
528 gcc_checking_assert (handler
);
529 gimple
*s
= handler
.stmt ();
530 tree type
= gimple_range_type (s
);
534 tree lhs
= handler
.lhs ();
535 tree op1
= handler
.operand1 ();
536 tree op2
= handler
.operand2 ();
537 Value_Range
range1 (TREE_TYPE (op1
));
538 Value_Range
range2 (op2
? TREE_TYPE (op2
) : TREE_TYPE (op1
));
540 if (src
.get_operand (range1
, op1
))
544 // Fold range, and register any dependency if available.
545 Value_Range
r2 (type
);
546 r2
.set_varying (type
);
547 if (!handler
.fold_range (r
, type
, range1
, r2
))
548 r
.set_varying (type
);
549 if (lhs
&& gimple_range_ssa_p (op1
))
552 src
.gori ()->register_dependency (lhs
, op1
);
554 rel
= handler
.lhs_op1_relation (r
, range1
, range1
);
555 if (rel
!= VREL_VARYING
)
556 src
.register_relation (s
, rel
, lhs
, op1
);
559 else if (src
.get_operand (range2
, op2
))
561 relation_kind rel
= src
.query_relation (op1
, op2
);
562 if (dump_file
&& (dump_flags
& TDF_DETAILS
) && rel
!= VREL_VARYING
)
564 fprintf (dump_file
, " folding with relation ");
565 print_generic_expr (dump_file
, op1
, TDF_SLIM
);
566 print_relation (dump_file
, rel
);
567 print_generic_expr (dump_file
, op2
, TDF_SLIM
);
568 fputc ('\n', dump_file
);
570 // Fold range, and register any dependency if available.
571 if (!handler
.fold_range (r
, type
, range1
, range2
, rel
))
572 r
.set_varying (type
);
573 if (irange::supports_p (type
))
574 relation_fold_and_or (as_a
<irange
> (r
), s
, src
);
579 src
.gori ()->register_dependency (lhs
, op1
);
580 src
.gori ()->register_dependency (lhs
, op2
);
582 if (gimple_range_ssa_p (op1
))
584 rel
= handler
.lhs_op1_relation (r
, range1
, range2
, rel
);
585 if (rel
!= VREL_VARYING
)
586 src
.register_relation (s
, rel
, lhs
, op1
);
588 if (gimple_range_ssa_p (op2
))
590 rel
= handler
.lhs_op2_relation (r
, range1
, range2
, rel
);
591 if (rel
!= VREL_VARYING
)
592 src
.register_relation (s
, rel
, lhs
, op2
);
595 // Check for an existing BB, as we maybe asked to fold an
596 // artificial statement not in the CFG.
597 else if (is_a
<gcond
*> (s
) && gimple_bb (s
))
599 basic_block bb
= gimple_bb (s
);
600 edge e0
= EDGE_SUCC (bb
, 0);
601 edge e1
= EDGE_SUCC (bb
, 1);
603 if (!single_pred_p (e0
->dest
))
605 if (!single_pred_p (e1
->dest
))
607 src
.register_outgoing_edges (as_a
<gcond
*> (s
),
608 as_a
<irange
> (r
), e0
, e1
);
612 r
.set_varying (type
);
615 r
.set_varying (type
);
616 // Make certain range-op adjustments that aren't handled any other way.
617 gimple_range_adjustment (r
, s
);
621 // Calculate the range of an assignment containing an ADDR_EXPR.
622 // Return the range in R.
623 // If a range cannot be calculated, set it to VARYING and return true.
626 fold_using_range::range_of_address (irange
&r
, gimple
*stmt
, fur_source
&src
)
628 gcc_checking_assert (gimple_code (stmt
) == GIMPLE_ASSIGN
);
629 gcc_checking_assert (gimple_assign_rhs_code (stmt
) == ADDR_EXPR
);
631 bool strict_overflow_p
;
632 tree expr
= gimple_assign_rhs1 (stmt
);
633 poly_int64 bitsize
, bitpos
;
636 int unsignedp
, reversep
, volatilep
;
637 tree base
= get_inner_reference (TREE_OPERAND (expr
, 0), &bitsize
,
638 &bitpos
, &offset
, &mode
, &unsignedp
,
639 &reversep
, &volatilep
);
642 if (base
!= NULL_TREE
643 && TREE_CODE (base
) == MEM_REF
644 && TREE_CODE (TREE_OPERAND (base
, 0)) == SSA_NAME
)
646 tree ssa
= TREE_OPERAND (base
, 0);
647 tree lhs
= gimple_get_lhs (stmt
);
648 if (lhs
&& gimple_range_ssa_p (ssa
) && src
.gori ())
649 src
.gori ()->register_dependency (lhs
, ssa
);
650 src
.get_operand (r
, ssa
);
651 range_cast (r
, TREE_TYPE (gimple_assign_rhs1 (stmt
)));
653 poly_offset_int off
= 0;
654 bool off_cst
= false;
655 if (offset
== NULL_TREE
|| TREE_CODE (offset
) == INTEGER_CST
)
657 off
= mem_ref_offset (base
);
659 off
+= poly_offset_int::from (wi::to_poly_wide (offset
),
661 off
<<= LOG2_BITS_PER_UNIT
;
665 /* If &X->a is equal to X, the range of X is the result. */
666 if (off_cst
&& known_eq (off
, 0))
668 else if (flag_delete_null_pointer_checks
669 && !TYPE_OVERFLOW_WRAPS (TREE_TYPE (expr
)))
671 /* For -fdelete-null-pointer-checks -fno-wrapv-pointer we don't
672 allow going from non-NULL pointer to NULL. */
673 if (r
.undefined_p () || !r
.contains_p (build_zero_cst (r
.type ())))
675 /* We could here instead adjust r by off >> LOG2_BITS_PER_UNIT
676 using POINTER_PLUS_EXPR if off_cst and just fall back to
678 r
.set_nonzero (TREE_TYPE (gimple_assign_rhs1 (stmt
)));
682 /* If MEM_REF has a "positive" offset, consider it non-NULL
683 always, for -fdelete-null-pointer-checks also "negative"
684 ones. Punt for unknown offsets (e.g. variable ones). */
685 if (!TYPE_OVERFLOW_WRAPS (TREE_TYPE (expr
))
688 && (flag_delete_null_pointer_checks
|| known_gt (off
, 0)))
690 r
.set_nonzero (TREE_TYPE (gimple_assign_rhs1 (stmt
)));
693 r
.set_varying (TREE_TYPE (gimple_assign_rhs1 (stmt
)));
698 if (tree_single_nonzero_warnv_p (expr
, &strict_overflow_p
))
700 r
.set_nonzero (TREE_TYPE (gimple_assign_rhs1 (stmt
)));
704 // Otherwise return varying.
705 r
.set_varying (TREE_TYPE (gimple_assign_rhs1 (stmt
)));
709 // Calculate a range for phi statement S and return it in R.
710 // If a range cannot be calculated, return false.
713 fold_using_range::range_of_phi (vrange
&r
, gphi
*phi
, fur_source
&src
)
715 tree phi_def
= gimple_phi_result (phi
);
716 tree type
= gimple_range_type (phi
);
717 Value_Range
arg_range (type
);
718 Value_Range
equiv_range (type
);
724 // Track if all executable arguments are the same.
725 tree single_arg
= NULL_TREE
;
726 bool seen_arg
= false;
728 // Start with an empty range, unioning in each argument's range.
730 for (x
= 0; x
< gimple_phi_num_args (phi
); x
++)
732 tree arg
= gimple_phi_arg_def (phi
, x
);
733 // An argument that is the same as the def provides no new range.
737 edge e
= gimple_phi_arg_edge (phi
, x
);
739 // Get the range of the argument on its edge.
740 src
.get_phi_operand (arg_range
, arg
, e
);
742 if (!arg_range
.undefined_p ())
744 // Register potential dependencies for stale value tracking.
745 // Likewise, if the incoming PHI argument is equivalent to this
746 // PHI definition, it provides no new info. Accumulate these ranges
747 // in case all arguments are equivalences.
748 if (src
.query ()->query_relation (e
, arg
, phi_def
, false) == VREL_EQ
)
749 equiv_range
.union_(arg_range
);
751 r
.union_ (arg_range
);
753 if (gimple_range_ssa_p (arg
) && src
.gori ())
754 src
.gori ()->register_dependency (phi_def
, arg
);
756 // Track if all arguments are the same.
762 else if (single_arg
!= arg
)
763 single_arg
= NULL_TREE
;
766 // Once the value reaches varying, stop looking.
767 if (r
.varying_p () && single_arg
== NULL_TREE
)
771 // If all arguments were equivalences, use the equivalence ranges as no
772 // arguments were processed.
773 if (r
.undefined_p () && !equiv_range
.undefined_p ())
776 // If the PHI boils down to a single effective argument, look at it.
779 // Symbolic arguments are equivalences.
780 if (gimple_range_ssa_p (single_arg
))
781 src
.register_relation (phi
, VREL_EQ
, phi_def
, single_arg
);
782 else if (src
.get_operand (arg_range
, single_arg
)
783 && arg_range
.singleton_p ())
785 // Numerical arguments that are a constant can be returned as
786 // the constant. This can help fold later cases where even this
787 // constant might have been UNDEFINED via an unreachable edge.
793 // If SCEV is available, query if this PHI has any knonwn values.
794 if (scev_initialized_p ()
795 && !POINTER_TYPE_P (TREE_TYPE (phi_def
)))
797 class loop
*l
= loop_containing_stmt (phi
);
798 if (l
&& loop_outer (l
))
800 Value_Range
loop_range (type
);
801 range_of_ssa_name_with_loop_info (loop_range
, phi_def
, l
, phi
, src
);
802 if (!loop_range
.varying_p ())
804 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
806 fprintf (dump_file
, " Loops range found for ");
807 print_generic_expr (dump_file
, phi_def
, TDF_SLIM
);
808 fprintf (dump_file
, ": ");
809 loop_range
.dump (dump_file
);
810 fprintf (dump_file
, " and calculated range :");
812 fprintf (dump_file
, "\n");
814 r
.intersect (loop_range
);
822 // Calculate a range for call statement S and return it in R.
823 // If a range cannot be calculated, return false.
826 fold_using_range::range_of_call (vrange
&r
, gcall
*call
, fur_source
&src
)
828 tree type
= gimple_range_type (call
);
832 tree lhs
= gimple_call_lhs (call
);
833 bool strict_overflow_p
;
835 if (range_of_builtin_call (r
, call
, src
))
837 else if (gimple_stmt_nonnegative_warnv_p (call
, &strict_overflow_p
))
838 r
.set_nonnegative (type
);
839 else if (gimple_call_nonnull_result_p (call
)
840 || gimple_call_nonnull_arg (call
))
841 r
.set_nonzero (type
);
843 r
.set_varying (type
);
845 // If there is an LHS, intersect that with what is known.
848 Value_Range
def (TREE_TYPE (lhs
));
849 gimple_range_global (def
, lhs
);
855 // Return the range of a __builtin_ubsan* in CALL and set it in R.
856 // CODE is the type of ubsan call (PLUS_EXPR, MINUS_EXPR or
860 fold_using_range::range_of_builtin_ubsan_call (irange
&r
, gcall
*call
,
861 tree_code code
, fur_source
&src
)
863 gcc_checking_assert (code
== PLUS_EXPR
|| code
== MINUS_EXPR
864 || code
== MULT_EXPR
);
865 tree type
= gimple_range_type (call
);
866 range_op_handler
op (code
, type
);
867 gcc_checking_assert (op
);
868 int_range_max ir0
, ir1
;
869 tree arg0
= gimple_call_arg (call
, 0);
870 tree arg1
= gimple_call_arg (call
, 1);
871 src
.get_operand (ir0
, arg0
);
872 src
.get_operand (ir1
, arg1
);
873 // Check for any relation between arg0 and arg1.
874 relation_kind relation
= src
.query_relation (arg0
, arg1
);
876 bool saved_flag_wrapv
= flag_wrapv
;
877 // Pretend the arithmetic is wrapping. If there is any overflow,
878 // we'll complain, but will actually do wrapping operation.
880 op
.fold_range (r
, type
, ir0
, ir1
, relation
);
881 flag_wrapv
= saved_flag_wrapv
;
883 // If for both arguments vrp_valueize returned non-NULL, this should
884 // have been already folded and if not, it wasn't folded because of
885 // overflow. Avoid removing the UBSAN_CHECK_* calls in that case.
886 if (r
.singleton_p ())
887 r
.set_varying (type
);
890 // Return TRUE if we recognize the target character set and return the
891 // range for lower case and upper case letters.
894 get_letter_range (tree type
, irange
&lowers
, irange
&uppers
)
897 int a
= lang_hooks
.to_target_charset ('a');
898 int z
= lang_hooks
.to_target_charset ('z');
899 int A
= lang_hooks
.to_target_charset ('A');
900 int Z
= lang_hooks
.to_target_charset ('Z');
902 if ((z
- a
== 25) && (Z
- A
== 25))
904 lowers
= int_range
<2> (build_int_cst (type
, a
), build_int_cst (type
, z
));
905 uppers
= int_range
<2> (build_int_cst (type
, A
), build_int_cst (type
, Z
));
908 // Unknown character set.
912 // For a builtin in CALL, return a range in R if known and return
913 // TRUE. Otherwise return FALSE.
916 fold_using_range::range_of_builtin_call (vrange
&r
, gcall
*call
,
919 combined_fn func
= gimple_call_combined_fn (call
);
920 if (func
== CFN_LAST
)
923 tree type
= gimple_range_type (call
);
924 gcc_checking_assert (type
);
926 if (irange::supports_p (type
))
927 return range_of_builtin_int_call (as_a
<irange
> (r
), call
, src
);
933 fold_using_range::range_of_builtin_int_call (irange
&r
, gcall
*call
,
936 combined_fn func
= gimple_call_combined_fn (call
);
937 if (func
== CFN_LAST
)
940 tree type
= gimple_range_type (call
);
942 int mini
, maxi
, zerov
= 0, prec
;
943 scalar_int_mode mode
;
947 case CFN_BUILT_IN_SIGNBIT
:
949 arg
= gimple_call_arg (call
, 0);
951 if (src
.get_operand (tmp
, arg
))
954 if (tmp
.signbit_p (signbit
))
957 r
.set_nonzero (type
);
967 case CFN_BUILT_IN_TOUPPER
:
969 arg
= gimple_call_arg (call
, 0);
970 // If the argument isn't compatible with the LHS, do nothing.
971 if (!range_compatible_p (type
, TREE_TYPE (arg
)))
973 if (!src
.get_operand (r
, arg
))
978 if (!get_letter_range (type
, lowers
, uppers
))
981 // Return the range passed in without any lower case characters,
982 // but including all the upper case ones.
984 r
.intersect (lowers
);
989 case CFN_BUILT_IN_TOLOWER
:
991 arg
= gimple_call_arg (call
, 0);
992 // If the argument isn't compatible with the LHS, do nothing.
993 if (!range_compatible_p (type
, TREE_TYPE (arg
)))
995 if (!src
.get_operand (r
, arg
))
1000 if (!get_letter_range (type
, lowers
, uppers
))
1003 // Return the range passed in without any upper case characters,
1004 // but including all the lower case ones.
1006 r
.intersect (uppers
);
1013 // __builtin_ffs* and __builtin_popcount* return [0, prec].
1014 arg
= gimple_call_arg (call
, 0);
1015 prec
= TYPE_PRECISION (TREE_TYPE (arg
));
1018 src
.get_operand (r
, arg
);
1019 // If arg is non-zero, then ffs or popcount are non-zero.
1020 if (!range_includes_zero_p (&r
))
1022 // If some high bits are known to be zero, decrease the maximum.
1023 if (!r
.undefined_p ())
1025 if (TYPE_SIGN (r
.type ()) == SIGNED
)
1026 range_cast (r
, unsigned_type_for (r
.type ()));
1027 wide_int max
= r
.upper_bound ();
1028 maxi
= wi::floor_log2 (max
) + 1;
1030 r
.set (build_int_cst (type
, mini
), build_int_cst (type
, maxi
));
1034 r
.set (build_zero_cst (type
), build_one_cst (type
));
1038 // __builtin_c[lt]z* return [0, prec-1], except when the
1039 // argument is 0, but that is undefined behavior.
1041 // For __builtin_c[lt]z* consider argument of 0 always undefined
1042 // behavior, for internal fns depending on C?Z_DEFINED_VALUE_AT_ZERO.
1043 arg
= gimple_call_arg (call
, 0);
1044 prec
= TYPE_PRECISION (TREE_TYPE (arg
));
1047 mode
= SCALAR_INT_TYPE_MODE (TREE_TYPE (arg
));
1048 if (gimple_call_internal_p (call
))
1050 if (optab_handler (clz_optab
, mode
) != CODE_FOR_nothing
1051 && CLZ_DEFINED_VALUE_AT_ZERO (mode
, zerov
) == 2)
1053 // Only handle the single common value.
1057 // Magic value to give up, unless we can prove arg is non-zero.
1062 src
.get_operand (r
, arg
);
1063 // From clz of minimum we can compute result maximum.
1064 if (!r
.undefined_p ())
1066 // From clz of minimum we can compute result maximum.
1067 if (wi::gt_p (r
.lower_bound (), 0, TYPE_SIGN (r
.type ())))
1069 maxi
= prec
- 1 - wi::floor_log2 (r
.lower_bound ());
1073 else if (!range_includes_zero_p (&r
))
1080 // From clz of maximum we can compute result minimum.
1081 wide_int max
= r
.upper_bound ();
1082 int newmini
= prec
- 1 - wi::floor_log2 (max
);
1085 // If CLZ_DEFINED_VALUE_AT_ZERO is 2 with VALUE of prec,
1086 // return [prec, prec], otherwise ignore the range.
1095 r
.set (build_int_cst (type
, mini
), build_int_cst (type
, maxi
));
1099 // __builtin_ctz* return [0, prec-1], except for when the
1100 // argument is 0, but that is undefined behavior.
1102 // For __builtin_ctz* consider argument of 0 always undefined
1103 // behavior, for internal fns depending on CTZ_DEFINED_VALUE_AT_ZERO.
1104 arg
= gimple_call_arg (call
, 0);
1105 prec
= TYPE_PRECISION (TREE_TYPE (arg
));
1108 mode
= SCALAR_INT_TYPE_MODE (TREE_TYPE (arg
));
1109 if (gimple_call_internal_p (call
))
1111 if (optab_handler (ctz_optab
, mode
) != CODE_FOR_nothing
1112 && CTZ_DEFINED_VALUE_AT_ZERO (mode
, zerov
) == 2)
1114 // Handle only the two common values.
1117 else if (zerov
== prec
)
1120 // Magic value to give up, unless we can prove arg is non-zero.
1124 src
.get_operand (r
, arg
);
1125 if (!r
.undefined_p ())
1127 // If arg is non-zero, then use [0, prec - 1].
1128 if (!range_includes_zero_p (&r
))
1133 // If some high bits are known to be zero, we can decrease
1135 wide_int max
= r
.upper_bound ();
1138 // Argument is [0, 0]. If CTZ_DEFINED_VALUE_AT_ZERO
1139 // is 2 with value -1 or prec, return [-1, -1] or [prec, prec].
1140 // Otherwise ignore the range.
1143 else if (maxi
== prec
)
1146 // If value at zero is prec and 0 is in the range, we can't lower
1147 // the upper bound. We could create two separate ranges though,
1148 // [0,floor_log2(max)][prec,prec] though.
1149 else if (maxi
!= prec
)
1150 maxi
= wi::floor_log2 (max
);
1154 r
.set (build_int_cst (type
, mini
), build_int_cst (type
, maxi
));
1158 arg
= gimple_call_arg (call
, 0);
1159 prec
= TYPE_PRECISION (TREE_TYPE (arg
));
1160 r
.set (build_int_cst (type
, 0), build_int_cst (type
, prec
- 1));
1162 case CFN_UBSAN_CHECK_ADD
:
1163 range_of_builtin_ubsan_call (r
, call
, PLUS_EXPR
, src
);
1165 case CFN_UBSAN_CHECK_SUB
:
1166 range_of_builtin_ubsan_call (r
, call
, MINUS_EXPR
, src
);
1168 case CFN_UBSAN_CHECK_MUL
:
1169 range_of_builtin_ubsan_call (r
, call
, MULT_EXPR
, src
);
1172 case CFN_GOACC_DIM_SIZE
:
1173 case CFN_GOACC_DIM_POS
:
1174 // Optimizing these two internal functions helps the loop
1175 // optimizer eliminate outer comparisons. Size is [1,N]
1176 // and pos is [0,N-1].
1178 bool is_pos
= func
== CFN_GOACC_DIM_POS
;
1179 int axis
= oacc_get_ifn_dim_arg (call
);
1180 int size
= oacc_get_fn_dim_size (current_function_decl
, axis
);
1182 // If it's dynamic, the backend might know a hardware limitation.
1183 size
= targetm
.goacc
.dim_limit (axis
);
1185 r
.set (build_int_cst (type
, is_pos
? 0 : 1),
1187 ? build_int_cst (type
, size
- is_pos
) : vrp_val_max (type
));
1191 case CFN_BUILT_IN_STRLEN
:
1192 if (tree lhs
= gimple_call_lhs (call
))
1193 if (ptrdiff_type_node
1194 && (TYPE_PRECISION (ptrdiff_type_node
)
1195 == TYPE_PRECISION (TREE_TYPE (lhs
))))
1197 tree type
= TREE_TYPE (lhs
);
1198 tree max
= vrp_val_max (ptrdiff_type_node
);
1200 = wi::to_wide (max
, TYPE_PRECISION (TREE_TYPE (max
)));
1201 tree range_min
= build_zero_cst (type
);
1202 // To account for the terminating NULL, the maximum length
1203 // is one less than the maximum array size, which in turn
1204 // is one less than PTRDIFF_MAX (or SIZE_MAX where it's
1205 // smaller than the former type).
1206 // FIXME: Use max_object_size() - 1 here.
1207 tree range_max
= wide_int_to_tree (type
, wmax
- 2);
1208 r
.set (range_min
, range_max
);
1219 // Calculate a range for COND_EXPR statement S and return it in R.
1220 // If a range cannot be calculated, return false.
1223 fold_using_range::range_of_cond_expr (vrange
&r
, gassign
*s
, fur_source
&src
)
1225 tree cond
= gimple_assign_rhs1 (s
);
1226 tree op1
= gimple_assign_rhs2 (s
);
1227 tree op2
= gimple_assign_rhs3 (s
);
1229 tree type
= gimple_range_type (s
);
1233 Value_Range
range1 (TREE_TYPE (op1
));
1234 Value_Range
range2 (TREE_TYPE (op2
));
1235 Value_Range
cond_range (TREE_TYPE (cond
));
1236 gcc_checking_assert (gimple_assign_rhs_code (s
) == COND_EXPR
);
1237 gcc_checking_assert (range_compatible_p (TREE_TYPE (op1
), TREE_TYPE (op2
)));
1238 src
.get_operand (cond_range
, cond
);
1239 src
.get_operand (range1
, op1
);
1240 src
.get_operand (range2
, op2
);
1242 // Try to see if there is a dependence between the COND and either operand
1244 if (src
.gori ()->condexpr_adjust (range1
, range2
, s
, cond
, op1
, op2
, src
))
1245 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1247 fprintf (dump_file
, "Possible COND_EXPR adjustment. Range op1 : ");
1248 range1
.dump(dump_file
);
1249 fprintf (dump_file
, " and Range op2: ");
1250 range2
.dump(dump_file
);
1251 fprintf (dump_file
, "\n");
1254 // If the condition is known, choose the appropriate expression.
1255 if (cond_range
.singleton_p ())
1257 // False, pick second operand.
1258 if (cond_range
.zero_p ())
1268 gcc_checking_assert (r
.undefined_p ()
1269 || range_compatible_p (r
.type (), type
));
1273 // Return the lower bound of R as a tree.
1276 tree_lower_bound (const vrange
&r
, tree type
)
1278 if (is_a
<irange
> (r
))
1279 return wide_int_to_tree (type
, as_a
<irange
> (r
).lower_bound ());
1280 // ?? Handle floats when they contain endpoints.
1284 // Return the upper bound of R as a tree.
1287 tree_upper_bound (const vrange
&r
, tree type
)
1289 if (is_a
<irange
> (r
))
1290 return wide_int_to_tree (type
, as_a
<irange
> (r
).upper_bound ());
1291 // ?? Handle floats when they contain endpoints.
1295 // If SCEV has any information about phi node NAME, return it as a range in R.
1298 fold_using_range::range_of_ssa_name_with_loop_info (vrange
&r
, tree name
,
1299 class loop
*l
, gphi
*phi
,
1302 gcc_checking_assert (TREE_CODE (name
) == SSA_NAME
);
1303 tree min
, max
, type
= TREE_TYPE (name
);
1304 if (bounds_of_var_in_loop (&min
, &max
, src
.query (), l
, phi
, name
))
1306 if (!is_gimple_constant (min
))
1308 if (src
.query ()->range_of_expr (r
, min
, phi
) && !r
.undefined_p ())
1309 min
= tree_lower_bound (r
, type
);
1311 min
= vrp_val_min (type
);
1313 if (!is_gimple_constant (max
))
1315 if (src
.query ()->range_of_expr (r
, max
, phi
) && !r
.undefined_p ())
1316 max
= tree_upper_bound (r
, type
);
1318 max
= vrp_val_max (type
);
1326 r
.set_varying (type
);
1329 // -----------------------------------------------------------------------
1331 // Check if an && or || expression can be folded based on relations. ie
1335 // c_2 and c_3 can never be true at the same time,
1336 // Therefore c_4 can always resolve to false based purely on the relations.
1339 fold_using_range::relation_fold_and_or (irange
& lhs_range
, gimple
*s
,
1342 // No queries or already folded.
1343 if (!src
.gori () || !src
.query ()->oracle () || lhs_range
.singleton_p ())
1346 // Only care about AND and OR expressions.
1347 enum tree_code code
= gimple_expr_code (s
);
1348 bool is_and
= false;
1349 if (code
== BIT_AND_EXPR
|| code
== TRUTH_AND_EXPR
)
1351 else if (code
!= BIT_IOR_EXPR
&& code
!= TRUTH_OR_EXPR
)
1354 gimple_range_op_handler
handler (s
);
1355 tree lhs
= handler
.lhs ();
1356 tree ssa1
= gimple_range_ssa_p (handler
.operand1 ());
1357 tree ssa2
= gimple_range_ssa_p (handler
.operand2 ());
1359 // Deal with || and && only when there is a full set of symbolics.
1360 if (!lhs
|| !ssa1
|| !ssa2
1361 || (TREE_CODE (TREE_TYPE (lhs
)) != BOOLEAN_TYPE
)
1362 || (TREE_CODE (TREE_TYPE (ssa1
)) != BOOLEAN_TYPE
)
1363 || (TREE_CODE (TREE_TYPE (ssa2
)) != BOOLEAN_TYPE
))
1366 // Now we know its a boolean AND or OR expression with boolean operands.
1367 // Ideally we search dependencies for common names, and see what pops out.
1368 // until then, simply try to resolve direct dependencies.
1370 gimple
*ssa1_stmt
= SSA_NAME_DEF_STMT (ssa1
);
1371 gimple
*ssa2_stmt
= SSA_NAME_DEF_STMT (ssa2
);
1373 gimple_range_op_handler
handler1 (ssa1_stmt
);
1374 gimple_range_op_handler
handler2 (ssa2_stmt
);
1376 // If either handler is not present, no relation can be found.
1377 if (!handler1
|| !handler2
)
1380 // Both stmts will need to have 2 ssa names in the stmt.
1381 tree ssa1_dep1
= gimple_range_ssa_p (handler1
.operand1 ());
1382 tree ssa1_dep2
= gimple_range_ssa_p (handler1
.operand2 ());
1383 tree ssa2_dep1
= gimple_range_ssa_p (handler2
.operand1 ());
1384 tree ssa2_dep2
= gimple_range_ssa_p (handler2
.operand2 ());
1386 if (!ssa1_dep1
|| !ssa1_dep2
|| !ssa2_dep1
|| !ssa2_dep2
)
1389 // Make sure they are the same dependencies, and detect the order of the
1391 bool reverse_op2
= true;
1392 if (ssa1_dep1
== ssa2_dep1
&& ssa1_dep2
== ssa2_dep2
)
1393 reverse_op2
= false;
1394 else if (ssa1_dep1
!= ssa2_dep2
|| ssa1_dep2
!= ssa2_dep1
)
1397 int_range
<2> bool_one (boolean_true_node
, boolean_true_node
);
1399 relation_kind relation1
= handler1
.op1_op2_relation (bool_one
);
1400 relation_kind relation2
= handler2
.op1_op2_relation (bool_one
);
1401 if (relation1
== VREL_VARYING
|| relation2
== VREL_VARYING
)
1405 relation2
= relation_negate (relation2
);
1407 // x && y is false if the relation intersection of the true cases is NULL.
1408 if (is_and
&& relation_intersect (relation1
, relation2
) == VREL_UNDEFINED
)
1409 lhs_range
= int_range
<2> (boolean_false_node
, boolean_false_node
);
1410 // x || y is true if the union of the true cases is NO-RELATION..
1411 // ie, one or the other being true covers the full range of possibilties.
1412 else if (!is_and
&& relation_union (relation1
, relation2
) == VREL_VARYING
)
1413 lhs_range
= bool_one
;
1417 range_cast (lhs_range
, TREE_TYPE (lhs
));
1418 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
1420 fprintf (dump_file
, " Relation adjustment: ");
1421 print_generic_expr (dump_file
, ssa1
, TDF_SLIM
);
1422 fprintf (dump_file
, " and ");
1423 print_generic_expr (dump_file
, ssa2
, TDF_SLIM
);
1424 fprintf (dump_file
, " combine to produce ");
1425 lhs_range
.dump (dump_file
);
1426 fputc ('\n', dump_file
);
1432 // Register any outgoing edge relations from a conditional branch.
1435 fur_source::register_outgoing_edges (gcond
*s
, irange
&lhs_range
, edge e0
, edge e1
)
1437 int_range
<2> e0_range
, e1_range
;
1439 basic_block bb
= gimple_bb (s
);
1441 gimple_range_op_handler
handler (s
);
1447 // If this edge is never taken, ignore it.
1448 gcond_edge_range (e0_range
, e0
);
1449 e0_range
.intersect (lhs_range
);
1450 if (e0_range
.undefined_p ())
1456 // If this edge is never taken, ignore it.
1457 gcond_edge_range (e1_range
, e1
);
1458 e1_range
.intersect (lhs_range
);
1459 if (e1_range
.undefined_p ())
1466 // First, register the gcond itself. This will catch statements like
1468 tree ssa1
= gimple_range_ssa_p (handler
.operand1 ());
1469 tree ssa2
= gimple_range_ssa_p (handler
.operand2 ());
1474 relation_kind relation
= handler
.op1_op2_relation (e0_range
);
1475 if (relation
!= VREL_VARYING
)
1476 register_relation (e0
, relation
, ssa1
, ssa2
);
1480 relation_kind relation
= handler
.op1_op2_relation (e1_range
);
1481 if (relation
!= VREL_VARYING
)
1482 register_relation (e1
, relation
, ssa1
, ssa2
);
1486 // Outgoing relations of GORI exports require a gori engine.
1490 // Now look for other relations in the exports. This will find stmts
1491 // leading to the condition such as:
1494 FOR_EACH_GORI_EXPORT_NAME (*(gori ()), bb
, name
)
1496 if (TREE_CODE (TREE_TYPE (name
)) != BOOLEAN_TYPE
)
1498 gimple
*stmt
= SSA_NAME_DEF_STMT (name
);
1499 gimple_range_op_handler
handler (stmt
);
1502 tree ssa1
= gimple_range_ssa_p (handler
.operand1 ());
1503 tree ssa2
= gimple_range_ssa_p (handler
.operand2 ());
1504 Value_Range
r (TREE_TYPE (name
));
1507 if (e0
&& gori ()->outgoing_edge_range_p (r
, e0
, name
, *m_query
)
1508 && r
.singleton_p ())
1510 relation_kind relation
= handler
.op1_op2_relation (r
);
1511 if (relation
!= VREL_VARYING
)
1512 register_relation (e0
, relation
, ssa1
, ssa2
);
1514 if (e1
&& gori ()->outgoing_edge_range_p (r
, e1
, name
, *m_query
)
1515 && r
.singleton_p ())
1517 relation_kind relation
= handler
.op1_op2_relation (r
);
1518 if (relation
!= VREL_VARYING
)
1519 register_relation (e1
, relation
, ssa1
, ssa2
);