libgo: bump major version
[official-gcc.git] / gcc / gimple-range-fold.cc
bloba899d8260b3d0834ebece5047df2286b3c351197
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)
11 any later version.
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/>. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "backend.h"
26 #include "insn-codes.h"
27 #include "tree.h"
28 #include "gimple.h"
29 #include "ssa.h"
30 #include "gimple-pretty-print.h"
31 #include "optabs-tree.h"
32 #include "gimple-iterator.h"
33 #include "gimple-fold.h"
34 #include "wide-int.h"
35 #include "fold-const.h"
36 #include "case-cfn-macros.h"
37 #include "omp-general.h"
38 #include "cfgloop.h"
39 #include "tree-ssa-loop.h"
40 #include "tree-scalar-evolution.h"
41 #include "langhooks.h"
42 #include "vr-values.h"
43 #include "range.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)
51 if (q)
52 m_query = q;
53 else if (cfun)
54 m_query = get_range_query (cfun);
55 else
56 m_query = get_global_range_query ();
57 m_gori = NULL;
60 // Invoke range_of_expr on EXPR.
62 bool
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.
71 bool
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.
79 relation_kind
80 fur_source::query_relation (tree op1 ATTRIBUTE_UNUSED,
81 tree op2 ATTRIBUTE_UNUSED)
83 return VREL_VARYING;
86 // Default registers nothing.
88 void
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.
98 void
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
110 public:
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;
114 private:
115 edge m_edge;
118 // Instantiate an edge based fur_source.
120 inline
121 fur_edge::fur_edge (edge e, range_query *q) : fur_source (q)
123 m_edge = e;
126 // Get the value of EXPR on edge m_edge.
128 bool
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.
137 bool
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)
149 m_stmt = s;
152 // Retreive range of EXPR as it occurs as a use on stmt M_STMT.
154 bool
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.
163 bool
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.
173 relation_kind
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)
183 : fur_stmt (s, q)
185 gcc_checking_assert (gori);
186 m_gori = 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.
195 void
196 fur_depend::register_relation (gimple *s, relation_kind k, tree op1, tree op2)
198 if (m_oracle)
199 m_oracle->register_stmt (s, k, op1, op2);
202 // Register a relation on an edge if there is an oracle.
204 void
205 fur_depend::register_relation (edge e, relation_kind k, tree op1, tree op2)
207 if (m_oracle)
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
216 public:
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;
222 private:
223 vrange *m_local[2];
224 vrange **m_list;
225 unsigned m_index;
226 unsigned m_limit;
229 // One range supplied for unary operations.
231 fur_list::fur_list (vrange &r1) : fur_source (NULL)
233 m_list = m_local;
234 m_index = 0;
235 m_limit = 1;
236 m_local[0] = &r1;
239 // Two ranges supplied for binary operations.
241 fur_list::fur_list (vrange &r1, vrange &r2) : fur_source (NULL)
243 m_list = m_local;
244 m_index = 0;
245 m_limit = 2;
246 m_local[0] = &r1;
247 m_local[1] = &r2;
250 // Arbitrary number of ranges in a vector.
252 fur_list::fur_list (unsigned num, vrange **list) : fur_source (NULL)
254 m_list = list;
255 m_index = 0;
256 m_limit = num;
259 // Get the next operand from the vector, ensure types are compatible.
261 bool
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 ()));
268 return true;
271 // This will simply pick the next operand from the vector.
272 bool
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.
280 bool
281 fold_range (vrange &r, gimple *s, vrange &r1)
283 fold_using_range f;
284 fur_list src (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.
290 bool
291 fold_range (vrange &r, gimple *s, vrange &r1, vrange &r2)
293 fold_using_range f;
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.
301 bool
302 fold_range (vrange &r, gimple *s, unsigned num_elements, vrange **vector)
304 fold_using_range f;
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.
311 bool
312 fold_range (vrange &r, gimple *s, range_query *q)
314 fold_using_range f;
315 fur_stmt src (s, 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.
321 bool
322 fold_range (vrange &r, gimple *s, edge on_edge, range_query *q)
324 fold_using_range f;
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
332 // from a memchr.
334 // This notices the following sequence:
336 // def = __builtin_memchr (arg, 0, sz)
337 // n = def - arg
339 // The range for N can be narrowed to [0, PTRDIFF_MAX - 1].
341 static void
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));
348 gimple *call;
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.
372 static void
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))
378 return;
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:
390 int_range<2> r;
391 r.set_varying (boolean_type_node);
392 tree type = TREE_TYPE (gimple_assign_lhs (stmt));
393 range_cast (r, type);
394 res.intersect (r);
396 default:
397 break;
399 return;
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.
415 static void
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)
421 return;
423 gimple *def_stmt = SSA_NAME_DEF_STMT (name);
424 if (!SSA_NAME_DEF_STMT (name))
425 return;
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);
435 res.intersect (tmp);
440 // This function looks for situations when walking the use/def chains
441 // may provide additonal contextual range information not exposed on
442 // this statement.
444 static void
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);
451 return;
453 case IMAGPART_EXPR:
454 adjust_imagpart_expr (res, stmt);
455 return;
457 case REALPART_EXPR:
458 adjust_realpart_expr (res, stmt);
459 return;
461 default:
462 break;
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.
471 bool
472 fold_using_range::fold_stmt (vrange &r, gimple *s, fur_source &src, tree name)
474 bool res = false;
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));
479 if (!name)
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);
488 if (handler)
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);
497 // If the result is varying, check for basic nonnegativeness.
498 // Specifically this helps for now with strict enum in cases like
499 // g++.dg/warn/pr33738.C.
500 bool so_p;
501 if (res && r.varying_p () && INTEGRAL_TYPE_P (r.type ())
502 && gimple_stmt_nonnegative_warnv_p (s, &so_p))
503 r.set_nonnegative (r.type ());
505 if (!res)
507 // If no name specified or range is unsupported, bail.
508 if (!name || !gimple_range_ssa_p (name))
509 return false;
510 // We don't understand the stmt, so return the global range.
511 gimple_range_global (r, name);
512 return true;
515 if (r.undefined_p ())
516 return true;
518 // We sometimes get compatible types copied from operands, make sure
519 // the correct type is being returned.
520 if (name && TREE_TYPE (name) != r.type ())
522 gcc_checking_assert (range_compatible_p (r.type (), TREE_TYPE (name)));
523 range_cast (r, TREE_TYPE (name));
525 return true;
528 // Calculate a range for range_op statement S and return it in R. If any
529 // If a range cannot be calculated, return false.
531 bool
532 fold_using_range::range_of_range_op (vrange &r,
533 gimple_range_op_handler &handler,
534 fur_source &src)
536 gcc_checking_assert (handler);
537 gimple *s = handler.stmt ();
538 tree type = gimple_range_type (s);
539 if (!type)
540 return false;
542 tree lhs = handler.lhs ();
543 tree op1 = handler.operand1 ();
544 tree op2 = handler.operand2 ();
546 // Certain types of builtin functions may have no arguments.
547 if (!op1)
549 Value_Range r1 (type);
550 if (!handler.fold_range (r, type, r1, r1))
551 r.set_varying (type);
552 return true;
555 Value_Range range1 (TREE_TYPE (op1));
556 Value_Range range2 (op2 ? TREE_TYPE (op2) : TREE_TYPE (op1));
558 if (src.get_operand (range1, op1))
560 if (!op2)
562 // Fold range, and register any dependency if available.
563 Value_Range r2 (type);
564 r2.set_varying (type);
565 if (!handler.fold_range (r, type, range1, r2))
566 r.set_varying (type);
567 if (lhs && gimple_range_ssa_p (op1))
569 if (src.gori ())
570 src.gori ()->register_dependency (lhs, op1);
571 relation_kind rel;
572 rel = handler.lhs_op1_relation (r, range1, range1);
573 if (rel != VREL_VARYING)
574 src.register_relation (s, rel, lhs, op1);
577 else if (src.get_operand (range2, op2))
579 relation_kind rel = src.query_relation (op1, op2);
580 if (dump_file && (dump_flags & TDF_DETAILS) && rel != VREL_VARYING)
582 fprintf (dump_file, " folding with relation ");
583 print_generic_expr (dump_file, op1, TDF_SLIM);
584 print_relation (dump_file, rel);
585 print_generic_expr (dump_file, op2, TDF_SLIM);
586 fputc ('\n', dump_file);
588 // Fold range, and register any dependency if available.
589 if (!handler.fold_range (r, type, range1, range2,
590 relation_trio::op1_op2 (rel)))
591 r.set_varying (type);
592 if (irange::supports_p (type))
593 relation_fold_and_or (as_a <irange> (r), s, src);
594 if (lhs)
596 if (src.gori ())
598 src.gori ()->register_dependency (lhs, op1);
599 src.gori ()->register_dependency (lhs, op2);
601 if (gimple_range_ssa_p (op1))
603 rel = handler.lhs_op1_relation (r, range1, range2, rel);
604 if (rel != VREL_VARYING)
605 src.register_relation (s, rel, lhs, op1);
607 if (gimple_range_ssa_p (op2))
609 rel = handler.lhs_op2_relation (r, range1, range2, rel);
610 if (rel != VREL_VARYING)
611 src.register_relation (s, rel, lhs, op2);
614 // Check for an existing BB, as we maybe asked to fold an
615 // artificial statement not in the CFG.
616 else if (is_a<gcond *> (s) && gimple_bb (s))
618 basic_block bb = gimple_bb (s);
619 edge e0 = EDGE_SUCC (bb, 0);
620 edge e1 = EDGE_SUCC (bb, 1);
622 if (!single_pred_p (e0->dest))
623 e0 = NULL;
624 if (!single_pred_p (e1->dest))
625 e1 = NULL;
626 src.register_outgoing_edges (as_a<gcond *> (s),
627 as_a <irange> (r), e0, e1);
630 else
631 r.set_varying (type);
633 else
634 r.set_varying (type);
635 // Make certain range-op adjustments that aren't handled any other way.
636 gimple_range_adjustment (r, s);
637 return true;
640 // Calculate the range of an assignment containing an ADDR_EXPR.
641 // Return the range in R.
642 // If a range cannot be calculated, set it to VARYING and return true.
644 bool
645 fold_using_range::range_of_address (irange &r, gimple *stmt, fur_source &src)
647 gcc_checking_assert (gimple_code (stmt) == GIMPLE_ASSIGN);
648 gcc_checking_assert (gimple_assign_rhs_code (stmt) == ADDR_EXPR);
650 bool strict_overflow_p;
651 tree expr = gimple_assign_rhs1 (stmt);
652 poly_int64 bitsize, bitpos;
653 tree offset;
654 machine_mode mode;
655 int unsignedp, reversep, volatilep;
656 tree base = get_inner_reference (TREE_OPERAND (expr, 0), &bitsize,
657 &bitpos, &offset, &mode, &unsignedp,
658 &reversep, &volatilep);
661 if (base != NULL_TREE
662 && TREE_CODE (base) == MEM_REF
663 && TREE_CODE (TREE_OPERAND (base, 0)) == SSA_NAME)
665 tree ssa = TREE_OPERAND (base, 0);
666 tree lhs = gimple_get_lhs (stmt);
667 if (lhs && gimple_range_ssa_p (ssa) && src.gori ())
668 src.gori ()->register_dependency (lhs, ssa);
669 src.get_operand (r, ssa);
670 range_cast (r, TREE_TYPE (gimple_assign_rhs1 (stmt)));
672 poly_offset_int off = 0;
673 bool off_cst = false;
674 if (offset == NULL_TREE || TREE_CODE (offset) == INTEGER_CST)
676 off = mem_ref_offset (base);
677 if (offset)
678 off += poly_offset_int::from (wi::to_poly_wide (offset),
679 SIGNED);
680 off <<= LOG2_BITS_PER_UNIT;
681 off += bitpos;
682 off_cst = true;
684 /* If &X->a is equal to X, the range of X is the result. */
685 if (off_cst && known_eq (off, 0))
686 return true;
687 else if (flag_delete_null_pointer_checks
688 && !TYPE_OVERFLOW_WRAPS (TREE_TYPE (expr)))
690 /* For -fdelete-null-pointer-checks -fno-wrapv-pointer we don't
691 allow going from non-NULL pointer to NULL. */
692 if (r.undefined_p () || !r.contains_p (build_zero_cst (r.type ())))
694 /* We could here instead adjust r by off >> LOG2_BITS_PER_UNIT
695 using POINTER_PLUS_EXPR if off_cst and just fall back to
696 this. */
697 r.set_nonzero (TREE_TYPE (gimple_assign_rhs1 (stmt)));
698 return true;
701 /* If MEM_REF has a "positive" offset, consider it non-NULL
702 always, for -fdelete-null-pointer-checks also "negative"
703 ones. Punt for unknown offsets (e.g. variable ones). */
704 if (!TYPE_OVERFLOW_WRAPS (TREE_TYPE (expr))
705 && off_cst
706 && known_ne (off, 0)
707 && (flag_delete_null_pointer_checks || known_gt (off, 0)))
709 r.set_nonzero (TREE_TYPE (gimple_assign_rhs1 (stmt)));
710 return true;
712 r.set_varying (TREE_TYPE (gimple_assign_rhs1 (stmt)));
713 return true;
716 // Handle "= &a".
717 if (tree_single_nonzero_warnv_p (expr, &strict_overflow_p))
719 r.set_nonzero (TREE_TYPE (gimple_assign_rhs1 (stmt)));
720 return true;
723 // Otherwise return varying.
724 r.set_varying (TREE_TYPE (gimple_assign_rhs1 (stmt)));
725 return true;
728 // Calculate a range for phi statement S and return it in R.
729 // If a range cannot be calculated, return false.
731 bool
732 fold_using_range::range_of_phi (vrange &r, gphi *phi, fur_source &src)
734 tree phi_def = gimple_phi_result (phi);
735 tree type = gimple_range_type (phi);
736 Value_Range arg_range (type);
737 Value_Range equiv_range (type);
738 unsigned x;
740 if (!type)
741 return false;
743 // Track if all executable arguments are the same.
744 tree single_arg = NULL_TREE;
745 bool seen_arg = false;
747 // Start with an empty range, unioning in each argument's range.
748 r.set_undefined ();
749 for (x = 0; x < gimple_phi_num_args (phi); x++)
751 tree arg = gimple_phi_arg_def (phi, x);
752 // An argument that is the same as the def provides no new range.
753 if (arg == phi_def)
754 continue;
756 edge e = gimple_phi_arg_edge (phi, x);
758 // Get the range of the argument on its edge.
759 src.get_phi_operand (arg_range, arg, e);
761 if (!arg_range.undefined_p ())
763 // Register potential dependencies for stale value tracking.
764 // Likewise, if the incoming PHI argument is equivalent to this
765 // PHI definition, it provides no new info. Accumulate these ranges
766 // in case all arguments are equivalences.
767 if (src.query ()->query_relation (e, arg, phi_def, false) == VREL_EQ)
768 equiv_range.union_(arg_range);
769 else
770 r.union_ (arg_range);
772 if (gimple_range_ssa_p (arg) && src.gori ())
773 src.gori ()->register_dependency (phi_def, arg);
775 // Track if all arguments are the same.
776 if (!seen_arg)
778 seen_arg = true;
779 single_arg = arg;
781 else if (single_arg != arg)
782 single_arg = NULL_TREE;
785 // Once the value reaches varying, stop looking.
786 if (r.varying_p () && single_arg == NULL_TREE)
787 break;
790 // If all arguments were equivalences, use the equivalence ranges as no
791 // arguments were processed.
792 if (r.undefined_p () && !equiv_range.undefined_p ())
793 r = equiv_range;
795 // If the PHI boils down to a single effective argument, look at it.
796 if (single_arg)
798 // Symbolic arguments are equivalences.
799 if (gimple_range_ssa_p (single_arg))
800 src.register_relation (phi, VREL_EQ, phi_def, single_arg);
801 else if (src.get_operand (arg_range, single_arg)
802 && arg_range.singleton_p ())
804 // Numerical arguments that are a constant can be returned as
805 // the constant. This can help fold later cases where even this
806 // constant might have been UNDEFINED via an unreachable edge.
807 r = arg_range;
808 return true;
812 // If SCEV is available, query if this PHI has any knonwn values.
813 if (scev_initialized_p ()
814 && !POINTER_TYPE_P (TREE_TYPE (phi_def)))
816 class loop *l = loop_containing_stmt (phi);
817 if (l && loop_outer (l))
819 Value_Range loop_range (type);
820 range_of_ssa_name_with_loop_info (loop_range, phi_def, l, phi, src);
821 if (!loop_range.varying_p ())
823 if (dump_file && (dump_flags & TDF_DETAILS))
825 fprintf (dump_file, " Loops range found for ");
826 print_generic_expr (dump_file, phi_def, TDF_SLIM);
827 fprintf (dump_file, ": ");
828 loop_range.dump (dump_file);
829 fprintf (dump_file, " and calculated range :");
830 r.dump (dump_file);
831 fprintf (dump_file, "\n");
833 r.intersect (loop_range);
838 return true;
841 // Calculate a range for call statement S and return it in R.
842 // If a range cannot be calculated, return false.
844 bool
845 fold_using_range::range_of_call (vrange &r, gcall *call, fur_source &)
847 tree type = gimple_range_type (call);
848 if (!type)
849 return false;
851 tree lhs = gimple_call_lhs (call);
852 bool strict_overflow_p;
854 if (gimple_stmt_nonnegative_warnv_p (call, &strict_overflow_p))
855 r.set_nonnegative (type);
856 else if (gimple_call_nonnull_result_p (call)
857 || gimple_call_nonnull_arg (call))
858 r.set_nonzero (type);
859 else
860 r.set_varying (type);
862 // If there is an LHS, intersect that with what is known.
863 if (lhs)
865 Value_Range def (TREE_TYPE (lhs));
866 gimple_range_global (def, lhs);
867 r.intersect (def);
869 return true;
872 // Calculate a range for COND_EXPR statement S and return it in R.
873 // If a range cannot be calculated, return false.
875 bool
876 fold_using_range::range_of_cond_expr (vrange &r, gassign *s, fur_source &src)
878 tree cond = gimple_assign_rhs1 (s);
879 tree op1 = gimple_assign_rhs2 (s);
880 tree op2 = gimple_assign_rhs3 (s);
882 tree type = gimple_range_type (s);
883 if (!type)
884 return false;
886 Value_Range range1 (TREE_TYPE (op1));
887 Value_Range range2 (TREE_TYPE (op2));
888 Value_Range cond_range (TREE_TYPE (cond));
889 gcc_checking_assert (gimple_assign_rhs_code (s) == COND_EXPR);
890 gcc_checking_assert (range_compatible_p (TREE_TYPE (op1), TREE_TYPE (op2)));
891 src.get_operand (cond_range, cond);
892 src.get_operand (range1, op1);
893 src.get_operand (range2, op2);
895 // Try to see if there is a dependence between the COND and either operand
896 if (src.gori ())
897 if (src.gori ()->condexpr_adjust (range1, range2, s, cond, op1, op2, src))
898 if (dump_file && (dump_flags & TDF_DETAILS))
900 fprintf (dump_file, "Possible COND_EXPR adjustment. Range op1 : ");
901 range1.dump(dump_file);
902 fprintf (dump_file, " and Range op2: ");
903 range2.dump(dump_file);
904 fprintf (dump_file, "\n");
907 // If the condition is known, choose the appropriate expression.
908 if (cond_range.singleton_p ())
910 // False, pick second operand.
911 if (cond_range.zero_p ())
912 r = range2;
913 else
914 r = range1;
916 else
918 r = range1;
919 r.union_ (range2);
921 gcc_checking_assert (r.undefined_p ()
922 || range_compatible_p (r.type (), type));
923 return true;
926 // Return the lower bound of R as a tree.
928 static inline tree
929 tree_lower_bound (const vrange &r, tree type)
931 if (is_a <irange> (r))
932 return wide_int_to_tree (type, as_a <irange> (r).lower_bound ());
933 // ?? Handle floats when they contain endpoints.
934 return NULL;
937 // Return the upper bound of R as a tree.
939 static inline tree
940 tree_upper_bound (const vrange &r, tree type)
942 if (is_a <irange> (r))
943 return wide_int_to_tree (type, as_a <irange> (r).upper_bound ());
944 // ?? Handle floats when they contain endpoints.
945 return NULL;
948 // If SCEV has any information about phi node NAME, return it as a range in R.
950 void
951 fold_using_range::range_of_ssa_name_with_loop_info (vrange &r, tree name,
952 class loop *l, gphi *phi,
953 fur_source &src)
955 gcc_checking_assert (TREE_CODE (name) == SSA_NAME);
956 tree min, max, type = TREE_TYPE (name);
957 if (bounds_of_var_in_loop (&min, &max, src.query (), l, phi, name))
959 if (!is_gimple_constant (min))
961 if (src.query ()->range_of_expr (r, min, phi) && !r.undefined_p ())
962 min = tree_lower_bound (r, type);
963 else
964 min = vrp_val_min (type);
966 if (!is_gimple_constant (max))
968 if (src.query ()->range_of_expr (r, max, phi) && !r.undefined_p ())
969 max = tree_upper_bound (r, type);
970 else
971 max = vrp_val_max (type);
973 if (min && max)
975 r.set (min, max);
976 return;
979 r.set_varying (type);
982 // -----------------------------------------------------------------------
984 // Check if an && or || expression can be folded based on relations. ie
985 // c_2 = a_6 > b_7
986 // c_3 = a_6 < b_7
987 // c_4 = c_2 && c_3
988 // c_2 and c_3 can never be true at the same time,
989 // Therefore c_4 can always resolve to false based purely on the relations.
991 void
992 fold_using_range::relation_fold_and_or (irange& lhs_range, gimple *s,
993 fur_source &src)
995 // No queries or already folded.
996 if (!src.gori () || !src.query ()->oracle () || lhs_range.singleton_p ())
997 return;
999 // Only care about AND and OR expressions.
1000 enum tree_code code = gimple_expr_code (s);
1001 bool is_and = false;
1002 if (code == BIT_AND_EXPR || code == TRUTH_AND_EXPR)
1003 is_and = true;
1004 else if (code != BIT_IOR_EXPR && code != TRUTH_OR_EXPR)
1005 return;
1007 gimple_range_op_handler handler (s);
1008 tree lhs = handler.lhs ();
1009 tree ssa1 = gimple_range_ssa_p (handler.operand1 ());
1010 tree ssa2 = gimple_range_ssa_p (handler.operand2 ());
1012 // Deal with || and && only when there is a full set of symbolics.
1013 if (!lhs || !ssa1 || !ssa2
1014 || (TREE_CODE (TREE_TYPE (lhs)) != BOOLEAN_TYPE)
1015 || (TREE_CODE (TREE_TYPE (ssa1)) != BOOLEAN_TYPE)
1016 || (TREE_CODE (TREE_TYPE (ssa2)) != BOOLEAN_TYPE))
1017 return;
1019 // Now we know its a boolean AND or OR expression with boolean operands.
1020 // Ideally we search dependencies for common names, and see what pops out.
1021 // until then, simply try to resolve direct dependencies.
1023 gimple *ssa1_stmt = SSA_NAME_DEF_STMT (ssa1);
1024 gimple *ssa2_stmt = SSA_NAME_DEF_STMT (ssa2);
1026 gimple_range_op_handler handler1 (ssa1_stmt);
1027 gimple_range_op_handler handler2 (ssa2_stmt);
1029 // If either handler is not present, no relation can be found.
1030 if (!handler1 || !handler2)
1031 return;
1033 // Both stmts will need to have 2 ssa names in the stmt.
1034 tree ssa1_dep1 = gimple_range_ssa_p (handler1.operand1 ());
1035 tree ssa1_dep2 = gimple_range_ssa_p (handler1.operand2 ());
1036 tree ssa2_dep1 = gimple_range_ssa_p (handler2.operand1 ());
1037 tree ssa2_dep2 = gimple_range_ssa_p (handler2.operand2 ());
1039 if (!ssa1_dep1 || !ssa1_dep2 || !ssa2_dep1 || !ssa2_dep2)
1040 return;
1042 // Make sure they are the same dependencies, and detect the order of the
1043 // relationship.
1044 bool reverse_op2 = true;
1045 if (ssa1_dep1 == ssa2_dep1 && ssa1_dep2 == ssa2_dep2)
1046 reverse_op2 = false;
1047 else if (ssa1_dep1 != ssa2_dep2 || ssa1_dep2 != ssa2_dep1)
1048 return;
1050 int_range<2> bool_one (boolean_true_node, boolean_true_node);
1052 relation_kind relation1 = handler1.op1_op2_relation (bool_one);
1053 relation_kind relation2 = handler2.op1_op2_relation (bool_one);
1054 if (relation1 == VREL_VARYING || relation2 == VREL_VARYING)
1055 return;
1057 if (reverse_op2)
1058 relation2 = relation_negate (relation2);
1060 // x && y is false if the relation intersection of the true cases is NULL.
1061 if (is_and && relation_intersect (relation1, relation2) == VREL_UNDEFINED)
1062 lhs_range = int_range<2> (boolean_false_node, boolean_false_node);
1063 // x || y is true if the union of the true cases is NO-RELATION..
1064 // ie, one or the other being true covers the full range of possibilties.
1065 else if (!is_and && relation_union (relation1, relation2) == VREL_VARYING)
1066 lhs_range = bool_one;
1067 else
1068 return;
1070 range_cast (lhs_range, TREE_TYPE (lhs));
1071 if (dump_file && (dump_flags & TDF_DETAILS))
1073 fprintf (dump_file, " Relation adjustment: ");
1074 print_generic_expr (dump_file, ssa1, TDF_SLIM);
1075 fprintf (dump_file, " and ");
1076 print_generic_expr (dump_file, ssa2, TDF_SLIM);
1077 fprintf (dump_file, " combine to produce ");
1078 lhs_range.dump (dump_file);
1079 fputc ('\n', dump_file);
1082 return;
1085 // Register any outgoing edge relations from a conditional branch.
1087 void
1088 fur_source::register_outgoing_edges (gcond *s, irange &lhs_range, edge e0, edge e1)
1090 int_range<2> e0_range, e1_range;
1091 tree name;
1092 basic_block bb = gimple_bb (s);
1094 gimple_range_op_handler handler (s);
1095 if (!handler)
1096 return;
1098 if (e0)
1100 // If this edge is never taken, ignore it.
1101 gcond_edge_range (e0_range, e0);
1102 e0_range.intersect (lhs_range);
1103 if (e0_range.undefined_p ())
1104 e0 = NULL;
1107 if (e1)
1109 // If this edge is never taken, ignore it.
1110 gcond_edge_range (e1_range, e1);
1111 e1_range.intersect (lhs_range);
1112 if (e1_range.undefined_p ())
1113 e1 = NULL;
1116 if (!e0 && !e1)
1117 return;
1119 // First, register the gcond itself. This will catch statements like
1120 // if (a_2 < b_5)
1121 tree ssa1 = gimple_range_ssa_p (handler.operand1 ());
1122 tree ssa2 = gimple_range_ssa_p (handler.operand2 ());
1123 if (ssa1 && ssa2)
1125 if (e0)
1127 relation_kind relation = handler.op1_op2_relation (e0_range);
1128 if (relation != VREL_VARYING)
1129 register_relation (e0, relation, ssa1, ssa2);
1131 if (e1)
1133 relation_kind relation = handler.op1_op2_relation (e1_range);
1134 if (relation != VREL_VARYING)
1135 register_relation (e1, relation, ssa1, ssa2);
1139 // Outgoing relations of GORI exports require a gori engine.
1140 if (!gori ())
1141 return;
1143 // Now look for other relations in the exports. This will find stmts
1144 // leading to the condition such as:
1145 // c_2 = a_4 < b_7
1146 // if (c_2)
1147 FOR_EACH_GORI_EXPORT_NAME (*(gori ()), bb, name)
1149 if (TREE_CODE (TREE_TYPE (name)) != BOOLEAN_TYPE)
1150 continue;
1151 gimple *stmt = SSA_NAME_DEF_STMT (name);
1152 gimple_range_op_handler handler (stmt);
1153 if (!handler)
1154 continue;
1155 tree ssa1 = gimple_range_ssa_p (handler.operand1 ());
1156 tree ssa2 = gimple_range_ssa_p (handler.operand2 ());
1157 Value_Range r (TREE_TYPE (name));
1158 if (ssa1 && ssa2)
1160 if (e0 && gori ()->outgoing_edge_range_p (r, e0, name, *m_query)
1161 && r.singleton_p ())
1163 relation_kind relation = handler.op1_op2_relation (r);
1164 if (relation != VREL_VARYING)
1165 register_relation (e0, relation, ssa1, ssa2);
1167 if (e1 && gori ()->outgoing_edge_range_p (r, e1, name, *m_query)
1168 && r.singleton_p ())
1170 relation_kind relation = handler.op1_op2_relation (r);
1171 if (relation != VREL_VARYING)
1172 register_relation (e1, relation, ssa1, ssa2);