ScalarEvolution.h

Go to the documentation of this file.

//===- llvm/Analysis/ScalarEvolution.h - Scalar Evolution -------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// The ScalarEvolution class is an LLVM pass which can be used to analyze and
// categorize scalar expressions in loops.  It specializes in recognizing
// general induction variables, representing them with the abstract and opaque
// SCEV class.  Given this analysis, trip counts of loops and other important
// properties can be obtained.
//
// This analysis is primarily useful for induction variable substitution and
// strength reduction.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_ANALYSIS_SCALAREVOLUTION_H
#define LLVM_ANALYSIS_SCALAREVOLUTION_H
 
#include "llvm/ADT/APInt.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/BitmaskEnum.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/DenseMapInfo.h"
#include "llvm/ADT/FoldingSet.h"
#include "llvm/ADT/PointerIntPair.h"
#include "llvm/ADT/SetVector.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/IR/ConstantRange.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/PassManager.h"
#include "llvm/IR/ValueHandle.h"
#include "llvm/IR/ValueMap.h"
#include "llvm/Pass.h"
#include "llvm/Support/Compiler.h"
#include <cassert>
#include <cstdint>
#include <memory>
#include <optional>
#include <utility>
 
namespace llvm {
 
class OverflowingBinaryOperator;
class AssumptionCache;
class BasicBlock;
class Constant;
class ConstantInt;
class DataLayout;
class DominatorTree;
class GEPOperator;
class LLVMContext;
class Loop;
class LoopInfo;
class raw_ostream;
class ScalarEvolution;
class SCEVAddRecExpr;
class SCEVUnknown;
class StructType;
class TargetLibraryInfo;
class Type;
enum SCEVTypes : unsigned short;
 
LLVM_ABI extern bool VerifySCEV;
 
/// NoWrapFlags are bitfield indices into SCEV's SubclassData.
///
/// Add and Mul expressions may have no-unsigned-wrap <NUW> or
/// no-signed-wrap <NSW> properties, which are derived from the IR
/// operator. NSW is a misnomer that we use to mean no signed overflow or
/// underflow. NUW and NSW must hold for all subsets and orders of
/// Add/Mul operands. That is, in `(a + b + c)<nsw>`, all of `a + b`,
/// `b + c`, `a + c` must be nsw as well.
///
/// AddRec expressions may have a no-self-wraparound <NW> property if, in
/// the integer domain, abs(step) * max-iteration(loop) <=
/// unsigned-max(bitwidth).  This means that the recurrence will never reach
/// its start value if the step is non-zero.  Computing the same value on
/// each iteration is not considered wrapping, and recurrences with step = 0
/// are trivially <NW>.  <NW> is independent of the sign of step and the
/// value the add recurrence starts with.
///
/// Note that NUW and NSW are also valid properties of a recurrence, and
/// either implies NW. For convenience, NW will be set for a recurrence
/// whenever either NUW or NSW are set.
///
/// We require that the flag on a SCEV apply to the entire scope in which
/// that SCEV is defined.  A SCEV's scope is set of locations dominated by
/// a defining location, which is in turn described by the following rules:
/// * A SCEVUnknown is at the point of definition of the Value.
/// * A SCEVConstant is defined at all points.
/// * A SCEVAddRec is defined starting with the header of the associated
///   loop.
/// * All other SCEVs are defined at the earlest point all operands are
///   defined.
///
/// The above rules describe a maximally hoisted form (without regards to
/// potential control dependence).  A SCEV is defined anywhere a
/// corresponding instruction could be defined in said maximally hoisted
/// form.  Note that SCEVUDivExpr (currently the only expression type which
/// can trap) can be defined per these rules in regions where it would trap
/// at runtime.  A SCEV being defined does not require the existence of any
/// instruction within the defined scope.
enum class SCEVNoWrapFlags {
  FlagAnyWrap = 0,    // No guarantee.
  FlagNW = (1 << 0),  // No self-wrap.
  FlagNUW = (1 << 1), // No unsigned wrap.
  FlagNSW = (1 << 2), // No signed wrap.
  NoWrapMask = (1 << 3) - 1,
  LLVM_MARK_AS_BITMASK_ENUM(/*LargestValue=*/NoWrapMask)
};
 
class SCEV;
 
template <typename SCEVPtrT = const SCEV *>
struct SCEVUseT : private PointerIntPair<SCEVPtrT, 2> {
  using Base = PointerIntPair<SCEVPtrT, 2>;
  using Base::getOpaqueValue;
  using Base::getPointer;
 
  SCEVUseT() : Base(nullptr, 0) {}
  SCEVUseT(SCEVPtrT S) : Base(S, 0) {}
  /// Construct with NoWrapFlags; only NUW/NSW are encoded, NW is dropped.
  SCEVUseT(SCEVPtrT S, SCEVNoWrapFlags Flags)
      : Base(S, static_cast<unsigned>(Flags) >> 1) {}
  template <typename OtherPtrT, typename = std::enable_if_t<
                                    std::is_convertible_v<OtherPtrT, SCEVPtrT>>>
  SCEVUseT(const SCEVUseT<OtherPtrT> &Other)
      : SCEVUseT(Other.getPointer(), Other.getUseNoWrapFlags()) {}
 
  operator SCEVPtrT() const { return getPointer(); }
  SCEVPtrT operator->() const { return getPointer(); }
 
  /// Returns true if the SCEVUse is canonical, i.e. no SCEVUse flags set in any
  /// operands.
  bool isCanonical() const { return getCanonical() == getOpaqueValue(); }
 
  /// Return the canonical SCEV for this SCEVUse.
  const SCEV *getCanonical() const;
 
  /// Return the no-wrap flags for this SCEVUse, which is the union of the
  /// use-specific flags and the underlying SCEV's flags, masked by \p Mask.
  SCEVNoWrapFlags
  getNoWrapFlags(SCEVNoWrapFlags Mask = SCEVNoWrapFlags::NoWrapMask) const;
 
  /// Return only the use-specific no-wrap flags (NUW/NSW) without the
  /// underlying SCEV's flags.
  SCEVNoWrapFlags getUseNoWrapFlags() const {
    SCEVNoWrapFlags UseFlags =
        static_cast<SCEVNoWrapFlags>(Base::getInt() << 1);
    if (any(UseFlags & (SCEVNoWrapFlags::FlagNUW | SCEVNoWrapFlags::FlagNSW)))
      UseFlags |= SCEVNoWrapFlags::FlagNW;
    return UseFlags;
  }
 
  bool operator==(const SCEVUseT &RHS) const {
    return getOpaqueValue() == RHS.getOpaqueValue();
  }
 
  bool operator!=(const SCEVUseT &RHS) const { return !(*this == RHS); }
 
  bool operator>(const SCEVUseT &RHS) const { return Base::operator>(RHS); }
 
  bool operator==(const SCEV *RHS) const { return getOpaqueValue() == RHS; }
  bool operator!=(const SCEV *RHS) const { return getOpaqueValue() != RHS; }
 
  /// Print out the internal representation of this scalar to the specified
  /// stream.  This should really only be used for debugging purposes.
  void print(raw_ostream &OS) const;
 
  /// This method is used for debugging.
  void dump() const;
 
private:
  using Base::setFromOpaqueValue;
  friend struct PointerLikeTypeTraits<SCEVUseT>;
};
 
/// Deduction guide for various SCEV subclass pointers.
template <typename SCEVPtrT> SCEVUseT(SCEVPtrT) -> SCEVUseT<SCEVPtrT>;
 
using SCEVUse = SCEVUseT<const SCEV *>;
 
/// Provide PointerLikeTypeTraits for SCEVUse, so it can be used with
/// SmallPtrSet, among others.
template <> struct PointerLikeTypeTraits<SCEVUse> {
  static inline void *getAsVoidPointer(SCEVUse U) { return U.getOpaqueValue(); }
  static inline SCEVUse getFromVoidPointer(void *P) {
    SCEVUse U;
    U.setFromOpaqueValue(P);
    return U;
  }
 
  /// The Low bits are used by the PointerIntPair.
  static constexpr int NumLowBitsAvailable = 0;
};
 
template <> struct DenseMapInfo<SCEVUse> {
  static inline SCEVUse getEmptyKey() {
    uintptr_t Val = static_cast<uintptr_t>(-1);
    return PointerLikeTypeTraits<SCEVUse>::getFromVoidPointer((void *)Val);
  }
 
  static inline SCEVUse getTombstoneKey() {
    uintptr_t Val = static_cast<uintptr_t>(-2);
    return PointerLikeTypeTraits<SCEVUse>::getFromVoidPointer((void *)Val);
  }
 
  static unsigned getHashValue(SCEVUse U) {
    return hash_value(U.getOpaqueValue());
  }
 
  static bool isEqual(const SCEVUse LHS, const SCEVUse RHS) {
    return LHS.getOpaqueValue() == RHS.getOpaqueValue();
  }
};
 
template <> struct simplify_type<SCEVUse> {
  using SimpleType = const SCEV *;
 
  static SimpleType getSimplifiedValue(SCEVUse &Val) {
    return Val.getPointer();
  }
};
 
/// Provide CastInfo for SCEVUseT so that cast<SCEVUseT<const To *>>(use)
/// returns SCEVUseT<const To *> with flags preserved.
template <typename ToSCEVPtrT>
struct CastInfo<SCEVUseT<ToSCEVPtrT>, SCEVUse,
                std::enable_if_t<!is_simple_type<SCEVUse>::value>> {
  using To = std::remove_cv_t<std::remove_pointer_t<ToSCEVPtrT>>;
  using CastReturnType = SCEVUseT<ToSCEVPtrT>;
 
  static bool isPossible(const SCEVUse &U) { return isa<To>(U.getPointer()); }
  static CastReturnType doCast(const SCEVUse &U) {
    return CastReturnType(cast<To>(U.getPointer()), U.getUseNoWrapFlags());
  }
  static CastReturnType castFailed() { return CastReturnType(nullptr); }
  static CastReturnType doCastIfPossible(const SCEVUse &U) {
    if (!isPossible(U))
      return castFailed();
    return doCast(U);
  }
};
 
template <typename ToSCEVPtrT>
struct CastInfo<SCEVUseT<ToSCEVPtrT>, const SCEVUse,
                std::enable_if_t<!is_simple_type<const SCEVUse>::value>>
    : CastInfo<SCEVUseT<ToSCEVPtrT>, SCEVUse> {};
 
/// This class represents an analyzed expression in the program.  These are
/// opaque objects that the client is not allowed to do much with directly.
///
class SCEV : public FoldingSetNode {
  friend struct FoldingSetTrait<SCEV>;
 
  /// A reference to an Interned FoldingSetNodeID for this node.  The
  /// ScalarEvolution's BumpPtrAllocator holds the data.
  FoldingSetNodeIDRef FastID;
 
  // The SCEV baseclass this node corresponds to
  const SCEVTypes SCEVType;
 
protected:
  // Estimated complexity of this node's expression tree size.
  const unsigned short ExpressionSize;
 
  /// This field is initialized to zero and may be used in subclasses to store
  /// miscellaneous information.
  unsigned short SubclassData = 0;
 
  /// Pointer to the canonical version of the SCEV, i.e. one where all operands
  /// have no SCEVUse flags.
  const SCEV *CanonicalSCEV = nullptr;
 
public:
  using NoWrapFlags = SCEVNoWrapFlags;
  static constexpr auto FlagAnyWrap = SCEVNoWrapFlags::FlagAnyWrap;
  static constexpr auto FlagNW = SCEVNoWrapFlags::FlagNW;
  static constexpr auto FlagNUW = SCEVNoWrapFlags::FlagNUW;
  static constexpr auto FlagNSW = SCEVNoWrapFlags::FlagNSW;
  static constexpr auto NoWrapMask = SCEVNoWrapFlags::NoWrapMask;
 
  explicit SCEV(const FoldingSetNodeIDRef ID, SCEVTypes SCEVTy,
                unsigned short ExpressionSize)
      : FastID(ID), SCEVType(SCEVTy), ExpressionSize(ExpressionSize) {}
  SCEV(const SCEV &) = delete;
  SCEV &operator=(const SCEV &) = delete;
 
  SCEVTypes getSCEVType() const { return SCEVType; }
 
  /// Return the LLVM type of this SCEV expression.
  LLVM_ABI Type *getType() const;
 
  /// Return operands of this SCEV expression.
  LLVM_ABI ArrayRef<SCEVUse> operands() const;
 
  /// Return true if the expression is a constant zero.
  LLVM_ABI bool isZero() const;
 
  /// Return true if the expression is a constant one.
  LLVM_ABI bool isOne() const;
 
  /// Return true if the expression is a constant all-ones value.
  LLVM_ABI bool isAllOnesValue() const;
 
  /// Return true if the specified scev is negated, but not a constant.
  LLVM_ABI bool isNonConstantNegative() const;
 
  // Returns estimated size of the mathematical expression represented by this
  // SCEV. The rules of its calculation are following:
  // 1) Size of a SCEV without operands (like constants and SCEVUnknown) is 1;
  // 2) Size SCEV with operands Op1, Op2, ..., OpN is calculated by formula:
  //    (1 + Size(Op1) + ... + Size(OpN)).
  // This value gives us an estimation of time we need to traverse through this
  // SCEV and all its operands recursively. We may use it to avoid performing
  // heavy transformations on SCEVs of excessive size for sake of saving the
  // compilation time.
  unsigned short getExpressionSize() const {
    return ExpressionSize;
  }
 
  /// Print out the internal representation of this scalar to the specified
  /// stream.  This should really only be used for debugging purposes.
  LLVM_ABI void print(raw_ostream &OS) const;
 
  /// This method is used for debugging.
  LLVM_ABI void dump() const;
 
  /// Compute and set the canonical SCEV, by constructing a SCEV with the same
  /// operands, but all SCEVUse flags dropped.
  LLVM_ABI void computeAndSetCanonical(ScalarEvolution &SE);
 
  /// Return the canonical SCEV.
  LLVM_ABI const SCEV *getCanonical() const {
    assert(CanonicalSCEV && "canonical SCEV not yet computed");
    return CanonicalSCEV;
  }
};
 
// Specialize FoldingSetTrait for SCEV to avoid needing to compute
// temporary FoldingSetNodeID values.
template <> struct FoldingSetTrait<SCEV> : DefaultFoldingSetTrait<SCEV> {
  static void Profile(const SCEV &X, FoldingSetNodeID &ID) { ID = X.FastID; }
 
  static bool Equals(const SCEV &X, const FoldingSetNodeID &ID, unsigned IDHash,
                     FoldingSetNodeID &TempID) {
    return ID == X.FastID;
  }
 
  static unsigned ComputeHash(const SCEV &X, FoldingSetNodeID &TempID) {
    return X.FastID.ComputeHash();
  }
};
 
inline raw_ostream &operator<<(raw_ostream &OS, const SCEV &S) {
  S.print(OS);
  return OS;
}
 
inline raw_ostream &operator<<(raw_ostream &OS, SCEVUse U) {
  U.print(OS);
  return OS;
}
 
/// An object of this class is returned by queries that could not be answered.
/// For example, if you ask for the number of iterations of a linked-list
/// traversal loop, you will get one of these.  None of the standard SCEV
/// operations are valid on this class, it is just a marker.
struct SCEVCouldNotCompute : public SCEV {
  LLVM_ABI SCEVCouldNotCompute();
 
  /// Methods for support type inquiry through isa, cast, and dyn_cast:
  LLVM_ABI static bool classof(const SCEV *S);
};
 
/// This class represents an assumption made using SCEV expressions which can
/// be checked at run-time.
class SCEVPredicate : public FoldingSetNode {
  friend struct FoldingSetTrait<SCEVPredicate>;
 
  /// A reference to an Interned FoldingSetNodeID for this node.  The
  /// ScalarEvolution's BumpPtrAllocator holds the data.
  FoldingSetNodeIDRef FastID;
 
public:
  enum SCEVPredicateKind { P_Union, P_Compare, P_Wrap };
 
protected:
  SCEVPredicateKind Kind;
  ~SCEVPredicate() = default;
  SCEVPredicate(const SCEVPredicate &) = default;
  SCEVPredicate &operator=(const SCEVPredicate &) = default;
 
public:
  LLVM_ABI SCEVPredicate(const FoldingSetNodeIDRef ID, SCEVPredicateKind Kind);
 
  SCEVPredicateKind getKind() const { return Kind; }
 
  /// Returns the estimated complexity of this predicate.  This is roughly
  /// measured in the number of run-time checks required.
  virtual unsigned getComplexity() const { return 1; }
 
  /// Returns true if the predicate is always true. This means that no
  /// assumptions were made and nothing needs to be checked at run-time.
  virtual bool isAlwaysTrue() const = 0;
 
  /// Returns true if this predicate implies \p N.
  virtual bool implies(const SCEVPredicate *N, ScalarEvolution &SE) const = 0;
 
  /// Prints a textual representation of this predicate with an indentation of
  /// \p Depth.
  virtual void print(raw_ostream &OS, unsigned Depth = 0) const = 0;
};
 
inline raw_ostream &operator<<(raw_ostream &OS, const SCEVPredicate &P) {
  P.print(OS);
  return OS;
}
 
// Specialize FoldingSetTrait for SCEVPredicate to avoid needing to compute
// temporary FoldingSetNodeID values.
template <>
struct FoldingSetTrait<SCEVPredicate> : DefaultFoldingSetTrait<SCEVPredicate> {
  static void Profile(const SCEVPredicate &X, FoldingSetNodeID &ID) {
    ID = X.FastID;
  }
 
  static bool Equals(const SCEVPredicate &X, const FoldingSetNodeID &ID,
                     unsigned IDHash, FoldingSetNodeID &TempID) {
    return ID == X.FastID;
  }
 
  static unsigned ComputeHash(const SCEVPredicate &X,
                              FoldingSetNodeID &TempID) {
    return X.FastID.ComputeHash();
  }
};
 
/// This class represents an assumption that the expression LHS Pred RHS
/// evaluates to true, and this can be checked at run-time.
class LLVM_ABI SCEVComparePredicate final : public SCEVPredicate {
  /// We assume that LHS Pred RHS is true.
  const ICmpInst::Predicate Pred;
  const SCEV *LHS;
  const SCEV *RHS;
 
public:
  SCEVComparePredicate(const FoldingSetNodeIDRef ID,
                       const ICmpInst::Predicate Pred,
                       const SCEV *LHS, const SCEV *RHS);
 
  /// Implementation of the SCEVPredicate interface
  bool implies(const SCEVPredicate *N, ScalarEvolution &SE) const override;
  void print(raw_ostream &OS, unsigned Depth = 0) const override;
  bool isAlwaysTrue() const override;
 
  ICmpInst::Predicate getPredicate() const { return Pred; }
 
  /// Returns the left hand side of the predicate.
  const SCEV *getLHS() const { return LHS; }
 
  /// Returns the right hand side of the predicate.
  const SCEV *getRHS() const { return RHS; }
 
  /// Methods for support type inquiry through isa, cast, and dyn_cast:
  static bool classof(const SCEVPredicate *P) {
    return P->getKind() == P_Compare;
  }
};
 
/// This class represents an assumption made on an AddRec expression. Given an
/// affine AddRec expression {a,+,b}, we assume that it has the nssw or nusw
/// flags (defined below) in the first X iterations of the loop, where X is a
/// SCEV expression returned by getPredicatedBackedgeTakenCount).
///
/// Note that this does not imply that X is equal to the backedge taken
/// count. This means that if we have a nusw predicate for i32 {0,+,1} with a
/// predicated backedge taken count of X, we only guarantee that {0,+,1} has
/// nusw in the first X iterations. {0,+,1} may still wrap in the loop if we
/// have more than X iterations.
class LLVM_ABI SCEVWrapPredicate final : public SCEVPredicate {
public:
  /// Similar to SCEV::NoWrapFlags, but with slightly different semantics
  /// for FlagNUSW. The increment is considered to be signed, and a + b
  /// (where b is the increment) is considered to wrap if:
  ///    zext(a + b) != zext(a) + sext(b)
  ///
  /// If Signed is a function that takes an n-bit tuple and maps to the
  /// integer domain as the tuples value interpreted as twos complement,
  /// and Unsigned a function that takes an n-bit tuple and maps to the
  /// integer domain as the base two value of input tuple, then a + b
  /// has IncrementNUSW iff:
  ///
  /// 0 <= Unsigned(a) + Signed(b) < 2^n
  ///
  /// The IncrementNSSW flag has identical semantics with SCEV::FlagNSW.
  ///
  /// Note that the IncrementNUSW flag is not commutative: if base + inc
  /// has IncrementNUSW, then inc + base doesn't neccessarily have this
  /// property. The reason for this is that this is used for sign/zero
  /// extending affine AddRec SCEV expressions when a SCEVWrapPredicate is
  /// assumed. A {base,+,inc} expression is already non-commutative with
  /// regards to base and inc, since it is interpreted as:
  ///     (((base + inc) + inc) + inc) ...
  enum IncrementWrapFlags {
    IncrementAnyWrap = 0,     // No guarantee.
    IncrementNUSW = (1 << 0), // No unsigned with signed increment wrap.
    IncrementNSSW = (1 << 1), // No signed with signed increment wrap
                              // (equivalent with SCEV::NSW)
    IncrementNoWrapMask = (1 << 2) - 1
  };
 
  /// Convenient IncrementWrapFlags manipulation methods.
  [[nodiscard]] static SCEVWrapPredicate::IncrementWrapFlags
  clearFlags(SCEVWrapPredicate::IncrementWrapFlags Flags,
             SCEVWrapPredicate::IncrementWrapFlags OffFlags) {
    assert((Flags & IncrementNoWrapMask) == Flags && "Invalid flags value!");
    assert((OffFlags & IncrementNoWrapMask) == OffFlags &&
           "Invalid flags value!");
    return (SCEVWrapPredicate::IncrementWrapFlags)(Flags & ~OffFlags);
  }
 
  [[nodiscard]] static SCEVWrapPredicate::IncrementWrapFlags
  maskFlags(SCEVWrapPredicate::IncrementWrapFlags Flags, int Mask) {
    assert((Flags & IncrementNoWrapMask) == Flags && "Invalid flags value!");
    assert((Mask & IncrementNoWrapMask) == Mask && "Invalid mask value!");
 
    return (SCEVWrapPredicate::IncrementWrapFlags)(Flags & Mask);
  }
 
  [[nodiscard]] static SCEVWrapPredicate::IncrementWrapFlags
  setFlags(SCEVWrapPredicate::IncrementWrapFlags Flags,
           SCEVWrapPredicate::IncrementWrapFlags OnFlags) {
    assert((Flags & IncrementNoWrapMask) == Flags && "Invalid flags value!");
    assert((OnFlags & IncrementNoWrapMask) == OnFlags &&
           "Invalid flags value!");
 
    return (SCEVWrapPredicate::IncrementWrapFlags)(Flags | OnFlags);
  }
 
  /// Returns the set of SCEVWrapPredicate no wrap flags implied by a
  /// SCEVAddRecExpr.
  [[nodiscard]] static SCEVWrapPredicate::IncrementWrapFlags
  getImpliedFlags(const SCEVAddRecExpr *AR, ScalarEvolution &SE);
 
private:
  const SCEVAddRecExpr *AR;
  IncrementWrapFlags Flags;
 
public:
  explicit SCEVWrapPredicate(const FoldingSetNodeIDRef ID,
                             const SCEVAddRecExpr *AR,
                             IncrementWrapFlags Flags);
 
  /// Returns the set assumed no overflow flags.
  IncrementWrapFlags getFlags() const { return Flags; }
 
  /// Implementation of the SCEVPredicate interface
  const SCEVAddRecExpr *getExpr() const;
  bool implies(const SCEVPredicate *N, ScalarEvolution &SE) const override;
  void print(raw_ostream &OS, unsigned Depth = 0) const override;
  bool isAlwaysTrue() const override;
 
  /// Methods for support type inquiry through isa, cast, and dyn_cast:
  static bool classof(const SCEVPredicate *P) {
    return P->getKind() == P_Wrap;
  }
};
 
/// This class represents a composition of other SCEV predicates, and is the
/// class that most clients will interact with.  This is equivalent to a
/// logical "AND" of all the predicates in the union.
///
/// NB! Unlike other SCEVPredicate sub-classes this class does not live in the
/// ScalarEvolution::Preds folding set.  This is why the \c add function is sound.
class LLVM_ABI SCEVUnionPredicate final : public SCEVPredicate {
private:
  using PredicateMap =
      DenseMap<const SCEV *, SmallVector<const SCEVPredicate *, 4>>;
 
  /// Vector with references to all predicates in this union.
  SmallVector<const SCEVPredicate *, 16> Preds;
 
  /// Adds a predicate to this union.
  void add(const SCEVPredicate *N, ScalarEvolution &SE);
 
public:
  SCEVUnionPredicate(ArrayRef<const SCEVPredicate *> Preds,
                     ScalarEvolution &SE);
 
  ArrayRef<const SCEVPredicate *> getPredicates() const { return Preds; }
 
  /// Returns a new SCEVUnionPredicate that is the union of this predicate
  /// and the given predicate \p N.
  SCEVUnionPredicate getUnionWith(const SCEVPredicate *N,
                                  ScalarEvolution &SE) const {
    SCEVUnionPredicate Result(Preds, SE);
    Result.add(N, SE);
    return Result;
  }
 
  /// Implementation of the SCEVPredicate interface
  bool isAlwaysTrue() const override;
  bool implies(const SCEVPredicate *N, ScalarEvolution &SE) const override;
  void print(raw_ostream &OS, unsigned Depth) const override;
 
  /// We estimate the complexity of a union predicate as the size number of
  /// predicates in the union.
  unsigned getComplexity() const override { return Preds.size(); }
 
  /// Methods for support type inquiry through isa, cast, and dyn_cast:
  static bool classof(const SCEVPredicate *P) {
    return P->getKind() == P_Union;
  }
};
 
/// The main scalar evolution driver. Because client code (intentionally)
/// can't do much with the SCEV objects directly, they must ask this class
/// for services.
class ScalarEvolution {
  friend class ScalarEvolutionsTest;
 
public:
  /// An enum describing the relationship between a SCEV and a loop.
  enum LoopDisposition {
    LoopVariant,   ///< The SCEV is loop-variant (unknown).
    LoopInvariant, ///< The SCEV is loop-invariant.
    LoopUniform,   ///< The SCEV is loop-uniform.
    LoopComputable ///< The SCEV varies predictably with the loop.
  };
 
  /// An enum describing the relationship between a SCEV and a basic block.
  enum BlockDisposition {
    DoesNotDominateBlock,  ///< The SCEV does not dominate the block.
    DominatesBlock,        ///< The SCEV dominates the block.
    ProperlyDominatesBlock ///< The SCEV properly dominates the block.
  };
 
  /// Convenient NoWrapFlags manipulation. TODO: Replace with & operator of
  /// enum class.
  [[nodiscard]] static SCEV::NoWrapFlags maskFlags(SCEV::NoWrapFlags Flags,
                                                   SCEV::NoWrapFlags Mask) {
    return Flags & Mask;
  }
  [[nodiscard]] static SCEV::NoWrapFlags setFlags(SCEV::NoWrapFlags Flags,
                                                  SCEV::NoWrapFlags OnFlags) {
    return Flags | OnFlags;
  }
  [[nodiscard]] static SCEV::NoWrapFlags
  clearFlags(SCEV::NoWrapFlags Flags, SCEV::NoWrapFlags OffFlags) {
    return Flags & ~OffFlags;
  }
  [[nodiscard]] static bool hasFlags(SCEV::NoWrapFlags Flags,
                                     SCEV::NoWrapFlags TestFlags) {
    return TestFlags == maskFlags(Flags, TestFlags);
  };
 
  LLVM_ABI ScalarEvolution(Function &F, TargetLibraryInfo &TLI,
                           AssumptionCache &AC, DominatorTree &DT,
                           LoopInfo &LI);
  LLVM_ABI ScalarEvolution(ScalarEvolution &&Arg);
  LLVM_ABI ~ScalarEvolution();
 
  LLVMContext &getContext() const { return F.getContext(); }
 
  /// Test if values of the given type are analyzable within the SCEV
  /// framework. This primarily includes integer types, and it can optionally
  /// include pointer types if the ScalarEvolution class has access to
  /// target-specific information.
  LLVM_ABI bool isSCEVable(Type *Ty) const;
 
  /// Return the size in bits of the specified type, for which isSCEVable must
  /// return true.
  LLVM_ABI uint64_t getTypeSizeInBits(Type *Ty) const;
 
  /// Return a type with the same bitwidth as the given type and which
  /// represents how SCEV will treat the given type, for which isSCEVable must
  /// return true. For pointer types, this is the pointer-sized integer type.
  LLVM_ABI Type *getEffectiveSCEVType(Type *Ty) const;
 
  // Returns a wider type among {Ty1, Ty2}.
  LLVM_ABI Type *getWiderType(Type *Ty1, Type *Ty2) const;
 
  /// Return true if there exists a point in the program at which both
  /// A and B could be operands to the same instruction.
  /// SCEV expressions are generally assumed to correspond to instructions
  /// which could exists in IR.  In general, this requires that there exists
  /// a use point in the program where all operands dominate the use.
  ///
  /// Example:
  /// loop {
  ///   if
  ///     loop { v1 = load @global1; }
  ///   else
  ///     loop { v2 = load @global2; }
  /// }
  /// No SCEV with operand V1, and v2 can exist in this program.
  LLVM_ABI bool instructionCouldExistWithOperands(const SCEV *A, const SCEV *B);
 
  /// Return true if the SCEV is a scAddRecExpr or it contains
  /// scAddRecExpr. The result will be cached in HasRecMap.
  LLVM_ABI bool containsAddRecurrence(const SCEV *S);
 
  /// Is operation \p BinOp between \p LHS and \p RHS provably does not have
  /// a signed/unsigned overflow (\p Signed)? If \p CtxI is specified, the
  /// no-overflow fact should be true in the context of this instruction.
  LLVM_ABI bool willNotOverflow(Instruction::BinaryOps BinOp, bool Signed,
                                const SCEV *LHS, const SCEV *RHS,
                                const Instruction *CtxI = nullptr);
 
  /// Parse NSW/NUW flags from add/sub/mul IR binary operation \p Op into
  /// SCEV no-wrap flags, and deduce flag[s] that aren't known yet.
  /// Does not mutate the original instruction. Returns std::nullopt if it could
  /// not deduce more precise flags than the instruction already has, otherwise
  /// returns proven flags.
  LLVM_ABI std::optional<SCEV::NoWrapFlags>
  getStrengthenedNoWrapFlagsFromBinOp(const OverflowingBinaryOperator *OBO);
 
  /// Notify this ScalarEvolution that \p User directly uses SCEVs in \p Ops.
  LLVM_ABI void registerUser(const SCEV *User, ArrayRef<const SCEV *> Ops);
  LLVM_ABI void registerUser(const SCEV *User, ArrayRef<SCEVUse> Ops);
 
  /// Return true if the SCEV expression contains an undef value.
  LLVM_ABI bool containsUndefs(const SCEV *S) const;
 
  /// Return true if the SCEV expression contains a Value that has been
  /// optimised out and is now a nullptr.
  LLVM_ABI bool containsErasedValue(const SCEV *S) const;
 
  /// Return a SCEV expression for the full generality of the specified
  /// expression.
  LLVM_ABI const SCEV *getSCEV(Value *V);
 
  /// Return an existing SCEV for V if there is one, otherwise return nullptr.
  LLVM_ABI const SCEV *getExistingSCEV(Value *V);
 
  LLVM_ABI const SCEV *getConstant(ConstantInt *V);
  LLVM_ABI const SCEV *getConstant(const APInt &Val);
  LLVM_ABI const SCEV *getConstant(Type *Ty, uint64_t V, bool isSigned = false);
  LLVM_ABI const SCEV *getLosslessPtrToIntExpr(const SCEV *Op);
 
  LLVM_ABI const SCEV *getPtrToAddrExpr(const SCEV *Op);
  LLVM_ABI const SCEV *getPtrToIntExpr(const SCEV *Op, Type *Ty);
  LLVM_ABI const SCEV *getTruncateExpr(const SCEV *Op, Type *Ty,
                                       unsigned Depth = 0);
  LLVM_ABI const SCEV *getVScale(Type *Ty);
  LLVM_ABI const SCEV *
  getElementCount(Type *Ty, ElementCount EC,
                  SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap);
  LLVM_ABI const SCEV *getZeroExtendExpr(const SCEV *Op, Type *Ty,
                                         unsigned Depth = 0);
  LLVM_ABI const SCEV *getZeroExtendExprImpl(const SCEV *Op, Type *Ty,
                                             unsigned Depth = 0);
  LLVM_ABI const SCEV *getSignExtendExpr(const SCEV *Op, Type *Ty,
                                         unsigned Depth = 0);
  LLVM_ABI const SCEV *getSignExtendExprImpl(const SCEV *Op, Type *Ty,
                                             unsigned Depth = 0);
  LLVM_ABI const SCEV *getCastExpr(SCEVTypes Kind, const SCEV *Op, Type *Ty);
  LLVM_ABI const SCEV *getAnyExtendExpr(const SCEV *Op, Type *Ty);
 
  LLVM_ABI const SCEV *getAddExpr(SmallVectorImpl<SCEVUse> &Ops,
                                  SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                                  unsigned Depth = 0);
  const SCEV *getAddExpr(SCEVUse LHS, SCEVUse RHS,
                         SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                         unsigned Depth = 0) {
    SmallVector<SCEVUse, 2> Ops = {LHS, RHS};
    return getAddExpr(Ops, Flags, Depth);
  }
  const SCEV *getAddExpr(SCEVUse Op0, SCEVUse Op1, SCEVUse Op2,
                         SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                         unsigned Depth = 0) {
    SmallVector<SCEVUse, 3> Ops = {Op0, Op1, Op2};
    return getAddExpr(Ops, Flags, Depth);
  }
  LLVM_ABI const SCEV *getMulExpr(SmallVectorImpl<SCEVUse> &Ops,
                                  SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                                  unsigned Depth = 0);
  const SCEV *getMulExpr(SCEVUse LHS, SCEVUse RHS,
                         SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                         unsigned Depth = 0) {
    SmallVector<SCEVUse, 2> Ops = {LHS, RHS};
    return getMulExpr(Ops, Flags, Depth);
  }
  const SCEV *getMulExpr(SCEVUse Op0, SCEVUse Op1, SCEVUse Op2,
                         SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                         unsigned Depth = 0) {
    SmallVector<SCEVUse, 3> Ops = {Op0, Op1, Op2};
    return getMulExpr(Ops, Flags, Depth);
  }
  LLVM_ABI const SCEV *getUDivExpr(SCEVUse LHS, SCEVUse RHS);
  LLVM_ABI const SCEV *getUDivExactExpr(SCEVUse LHS, SCEVUse RHS);
  LLVM_ABI const SCEV *getURemExpr(SCEVUse LHS, SCEVUse RHS);
  LLVM_ABI const SCEV *getAddRecExpr(SCEVUse Start, SCEVUse Step, const Loop *L,
                                     SCEV::NoWrapFlags Flags);
  LLVM_ABI const SCEV *getAddRecExpr(SmallVectorImpl<SCEVUse> &Operands,
                                     const Loop *L, SCEV::NoWrapFlags Flags);
  const SCEV *getAddRecExpr(const SmallVectorImpl<SCEVUse> &Operands,
                            const Loop *L, SCEV::NoWrapFlags Flags) {
    SmallVector<SCEVUse, 4> NewOp(Operands.begin(), Operands.end());
    return getAddRecExpr(NewOp, L, Flags);
  }
 
  /// Checks if \p SymbolicPHI can be rewritten as an AddRecExpr under some
  /// Predicates. If successful return these <AddRecExpr, Predicates>;
  /// The function is intended to be called from PSCEV (the caller will decide
  /// whether to actually add the predicates and carry out the rewrites).
  LLVM_ABI std::optional<
      std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
  createAddRecFromPHIWithCasts(const SCEVUnknown *SymbolicPHI);
 
  /// Returns an expression for a GEP
  ///
  /// \p GEP The GEP. The indices contained in the GEP itself are ignored,
  /// instead we use IndexExprs.
  /// \p IndexExprs The expressions for the indices.
  LLVM_ABI const SCEV *getGEPExpr(GEPOperator *GEP,
                                  ArrayRef<SCEVUse> IndexExprs);
  LLVM_ABI const SCEV *getGEPExpr(SCEVUse BaseExpr,
                                  ArrayRef<SCEVUse> IndexExprs,
                                  Type *SrcElementTy,
                                  GEPNoWrapFlags NW = GEPNoWrapFlags::none());
  LLVM_ABI const SCEV *getAbsExpr(const SCEV *Op, bool IsNSW);
  LLVM_ABI const SCEV *getMinMaxExpr(SCEVTypes Kind,
                                     SmallVectorImpl<SCEVUse> &Operands);
  LLVM_ABI const SCEV *
  getSequentialMinMaxExpr(SCEVTypes Kind, SmallVectorImpl<SCEVUse> &Operands);
  LLVM_ABI const SCEV *getSMaxExpr(SCEVUse LHS, SCEVUse RHS);
  LLVM_ABI const SCEV *getSMaxExpr(SmallVectorImpl<SCEVUse> &Operands);
  LLVM_ABI const SCEV *getUMaxExpr(SCEVUse LHS, SCEVUse RHS);
  LLVM_ABI const SCEV *getUMaxExpr(SmallVectorImpl<SCEVUse> &Operands);
  LLVM_ABI const SCEV *getSMinExpr(SCEVUse LHS, SCEVUse RHS);
  LLVM_ABI const SCEV *getSMinExpr(SmallVectorImpl<SCEVUse> &Operands);
  LLVM_ABI const SCEV *getUMinExpr(SCEVUse LHS, SCEVUse RHS,
                                   bool Sequential = false);
  LLVM_ABI const SCEV *getUMinExpr(SmallVectorImpl<SCEVUse> &Operands,
                                   bool Sequential = false);
  LLVM_ABI const SCEV *getUnknown(Value *V);
  LLVM_ABI const SCEV *getCouldNotCompute();
 
  /// Return a SCEV for the constant 0 of a specific type.
  const SCEV *getZero(Type *Ty) { return getConstant(Ty, 0); }
 
  /// Return a SCEV for the constant 1 of a specific type.
  const SCEV *getOne(Type *Ty) { return getConstant(Ty, 1); }
 
  /// Return a SCEV for the constant \p Power of two.
  const SCEV *getPowerOfTwo(Type *Ty, unsigned Power) {
    assert(Power < getTypeSizeInBits(Ty) && "Power out of range");
    return getConstant(APInt::getOneBitSet(getTypeSizeInBits(Ty), Power));
  }
 
  /// Return a SCEV for the constant -1 of a specific type.
  const SCEV *getMinusOne(Type *Ty) {
    return getConstant(Ty, -1, /*isSigned=*/true);
  }
 
  /// Return an expression for a TypeSize.
  LLVM_ABI const SCEV *getSizeOfExpr(Type *IntTy, TypeSize Size);
 
  /// Return an expression for the alloc size of AllocTy that is type IntTy
  LLVM_ABI const SCEV *getSizeOfExpr(Type *IntTy, Type *AllocTy);
 
  /// Return an expression for the store size of StoreTy that is type IntTy
  LLVM_ABI const SCEV *getStoreSizeOfExpr(Type *IntTy, Type *StoreTy);
 
  /// Return an expression for offsetof on the given field with type IntTy
  LLVM_ABI const SCEV *getOffsetOfExpr(Type *IntTy, StructType *STy,
                                       unsigned FieldNo);
 
  /// Return the SCEV object corresponding to -V.
  LLVM_ABI const SCEV *
  getNegativeSCEV(const SCEV *V, SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap);
 
  /// Return the SCEV object corresponding to ~V.
  LLVM_ABI const SCEV *getNotSCEV(const SCEV *V);
 
  /// Return LHS-RHS.  Minus is represented in SCEV as A+B*-1.
  ///
  /// If the LHS and RHS are pointers which don't share a common base
  /// (according to getPointerBase()), this returns a SCEVCouldNotCompute.
  /// To compute the difference between two unrelated pointers, you can
  /// explicitly convert the arguments using getPtrToIntExpr(), for pointer
  /// types that support it.
  LLVM_ABI const SCEV *getMinusSCEV(SCEVUse LHS, SCEVUse RHS,
                                    SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap,
                                    unsigned Depth = 0);
 
  /// Compute ceil(N / D). N and D are treated as unsigned values.
  ///
  /// Since SCEV doesn't have native ceiling division, this generates a
  /// SCEV expression of the following form:
  ///
  /// umin(N, 1) + floor((N - umin(N, 1)) / D)
  ///
  /// A denominator of zero or poison is handled the same way as getUDivExpr().
  LLVM_ABI const SCEV *getUDivCeilSCEV(const SCEV *N, const SCEV *D);
 
  /// Return a SCEV corresponding to a conversion of the input value to the
  /// specified type.  If the type must be extended, it is zero extended.
  LLVM_ABI const SCEV *getTruncateOrZeroExtend(const SCEV *V, Type *Ty,
                                               unsigned Depth = 0);
 
  /// Return a SCEV corresponding to a conversion of the input value to the
  /// specified type.  If the type must be extended, it is sign extended.
  LLVM_ABI const SCEV *getTruncateOrSignExtend(const SCEV *V, Type *Ty,
                                               unsigned Depth = 0);
 
  /// Return a SCEV corresponding to a conversion of the input value to the
  /// specified type.  If the type must be extended, it is zero extended.  The
  /// conversion must not be narrowing.
  LLVM_ABI const SCEV *getNoopOrZeroExtend(const SCEV *V, Type *Ty);
 
  /// Return a SCEV corresponding to a conversion of the input value to the
  /// specified type.  If the type must be extended, it is sign extended.  The
  /// conversion must not be narrowing.
  LLVM_ABI const SCEV *getNoopOrSignExtend(const SCEV *V, Type *Ty);
 
  /// Return a SCEV corresponding to a conversion of the input value to the
  /// specified type. If the type must be extended, it is extended with
  /// unspecified bits. The conversion must not be narrowing.
  LLVM_ABI const SCEV *getNoopOrAnyExtend(const SCEV *V, Type *Ty);
 
  /// Return a SCEV corresponding to a conversion of the input value to the
  /// specified type.  The conversion must not be widening.
  LLVM_ABI const SCEV *getTruncateOrNoop(const SCEV *V, Type *Ty);
 
  /// Promote the operands to the wider of the types using zero-extension, and
  /// then perform a umax operation with them.
  LLVM_ABI const SCEV *getUMaxFromMismatchedTypes(const SCEV *LHS,
                                                  const SCEV *RHS);
 
  /// Promote the operands to the wider of the types using zero-extension, and
  /// then perform a umin operation with them.
  LLVM_ABI const SCEV *getUMinFromMismatchedTypes(const SCEV *LHS,
                                                  const SCEV *RHS,
                                                  bool Sequential = false);
 
  /// Promote the operands to the wider of the types using zero-extension, and
  /// then perform a umin operation with them. N-ary function.
  LLVM_ABI const SCEV *getUMinFromMismatchedTypes(SmallVectorImpl<SCEVUse> &Ops,
                                                  bool Sequential = false);
 
  /// Transitively follow the chain of pointer-type operands until reaching a
  /// SCEV that does not have a single pointer operand. This returns a
  /// SCEVUnknown pointer for well-formed pointer-type expressions, but corner
  /// cases do exist.
  LLVM_ABI const SCEV *getPointerBase(const SCEV *V);
 
  /// Compute an expression equivalent to S - getPointerBase(S).
  LLVM_ABI const SCEV *removePointerBase(const SCEV *S);
 
  /// Return a SCEV expression for the specified value at the specified scope
  /// in the program.  The L value specifies a loop nest to evaluate the
  /// expression at, where null is the top-level or a specified loop is
  /// immediately inside of the loop.
  ///
  /// This method can be used to compute the exit value for a variable defined
  /// in a loop by querying what the value will hold in the parent loop.
  ///
  /// In the case that a relevant loop exit value cannot be computed, the
  /// original value V is returned.
  LLVM_ABI const SCEV *getSCEVAtScope(const SCEV *S, const Loop *L);
 
  /// This is a convenience function which does getSCEVAtScope(getSCEV(V), L).
  LLVM_ABI const SCEV *getSCEVAtScope(Value *V, const Loop *L);
 
  /// Test whether entry to the loop is protected by a conditional between LHS
  /// and RHS.  This is used to help avoid max expressions in loop trip
  /// counts, and to eliminate casts.
  LLVM_ABI bool isLoopEntryGuardedByCond(const Loop *L, CmpPredicate Pred,
                                         const SCEV *LHS, const SCEV *RHS);
 
  /// Test whether entry to the basic block is protected by a conditional
  /// between LHS and RHS.
  LLVM_ABI bool isBasicBlockEntryGuardedByCond(const BasicBlock *BB,
                                               CmpPredicate Pred,
                                               const SCEV *LHS,
                                               const SCEV *RHS);
 
  /// Test whether the backedge of the loop is protected by a conditional
  /// between LHS and RHS.  This is used to eliminate casts.
  LLVM_ABI bool isLoopBackedgeGuardedByCond(const Loop *L, CmpPredicate Pred,
                                            const SCEV *LHS, const SCEV *RHS);
 
  /// A version of getTripCountFromExitCount below which always picks an
  /// evaluation type which can not result in overflow.
  LLVM_ABI const SCEV *getTripCountFromExitCount(const SCEV *ExitCount);
 
  /// Convert from an "exit count" (i.e. "backedge taken count") to a "trip
  /// count".  A "trip count" is the number of times the header of the loop
  /// will execute if an exit is taken after the specified number of backedges
  /// have been taken.  (e.g. TripCount = ExitCount + 1).  Note that the
  /// expression can overflow if ExitCount = UINT_MAX.  If EvalTy is not wide
  /// enough to hold the result without overflow, result unsigned wraps with
  /// 2s-complement semantics.  ex: EC = 255 (i8), TC = 0 (i8)
  LLVM_ABI const SCEV *getTripCountFromExitCount(const SCEV *ExitCount,
                                                 Type *EvalTy, const Loop *L);
 
  /// Returns the exact trip count of the loop if we can compute it, and
  /// the result is a small constant.  '0' is used to represent an unknown
  /// or non-constant trip count.  Note that a trip count is simply one more
  /// than the backedge taken count for the loop.
  LLVM_ABI unsigned getSmallConstantTripCount(const Loop *L);
 
  /// Return the exact trip count for this loop if we exit through ExitingBlock.
  /// '0' is used to represent an unknown or non-constant trip count.  Note
  /// that a trip count is simply one more than the backedge taken count for
  /// the same exit.
  /// This "trip count" assumes that control exits via ExitingBlock. More
  /// precisely, it is the number of times that control will reach ExitingBlock
  /// before taking the branch. For loops with multiple exits, it may not be
  /// the number times that the loop header executes if the loop exits
  /// prematurely via another branch.
  LLVM_ABI unsigned getSmallConstantTripCount(const Loop *L,
                                              const BasicBlock *ExitingBlock);
 
  /// Returns the upper bound of the loop trip count as a normal unsigned
  /// value.
  /// Returns 0 if the trip count is unknown, not constant or requires
  /// SCEV predicates and \p Predicates is nullptr.
  LLVM_ABI unsigned getSmallConstantMaxTripCount(
      const Loop *L,
      SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr);
 
  /// Returns the largest constant divisor of the trip count as a normal
  /// unsigned value, if possible. This means that the actual trip count is
  /// always a multiple of the returned value. Returns 1 if the trip count is
  /// unknown or not guaranteed to be the multiple of a constant., Will also
  /// return 1 if the trip count is very large (>= 2^32).
  /// Note that the argument is an exit count for loop L, NOT a trip count.
  LLVM_ABI unsigned getSmallConstantTripMultiple(const Loop *L,
                                                 const SCEV *ExitCount);
 
  /// Returns the largest constant divisor of the trip count of the
  /// loop.  Will return 1 if no trip count could be computed, or if a
  /// divisor could not be found.
  LLVM_ABI unsigned getSmallConstantTripMultiple(const Loop *L);
 
  /// Returns the largest constant divisor of the trip count of this loop as a
  /// normal unsigned value, if possible. This means that the actual trip
  /// count is always a multiple of the returned value (don't forget the trip
  /// count could very well be zero as well!). As explained in the comments
  /// for getSmallConstantTripCount, this assumes that control exits the loop
  /// via ExitingBlock.
  LLVM_ABI unsigned
  getSmallConstantTripMultiple(const Loop *L, const BasicBlock *ExitingBlock);
 
  /// The terms "backedge taken count" and "exit count" are used
  /// interchangeably to refer to the number of times the backedge of a loop
  /// has executed before the loop is exited.
  enum ExitCountKind {
    /// An expression exactly describing the number of times the backedge has
    /// executed when a loop is exited.
    Exact,
    /// A constant which provides an upper bound on the exact trip count.
    ConstantMaximum,
    /// An expression which provides an upper bound on the exact trip count.
    SymbolicMaximum,
  };
 
  /// Return the number of times the backedge executes before the given exit
  /// would be taken; if not exactly computable, return SCEVCouldNotCompute.
  /// For a single exit loop, this value is equivelent to the result of
  /// getBackedgeTakenCount.  The loop is guaranteed to exit (via *some* exit)
  /// before the backedge is executed (ExitCount + 1) times.  Note that there
  /// is no guarantee about *which* exit is taken on the exiting iteration.
  LLVM_ABI const SCEV *getExitCount(const Loop *L,
                                    const BasicBlock *ExitingBlock,
                                    ExitCountKind Kind = Exact);
 
  /// Same as above except this uses the predicated backedge taken info and
  /// may require predicates.
  LLVM_ABI const SCEV *
  getPredicatedExitCount(const Loop *L, const BasicBlock *ExitingBlock,
                         SmallVectorImpl<const SCEVPredicate *> *Predicates,
                         ExitCountKind Kind = Exact);
 
  /// If the specified loop has a predictable backedge-taken count, return it,
  /// otherwise return a SCEVCouldNotCompute object. The backedge-taken count is
  /// the number of times the loop header will be branched to from within the
  /// loop, assuming there are no abnormal exists like exception throws. This is
  /// one less than the trip count of the loop, since it doesn't count the first
  /// iteration, when the header is branched to from outside the loop.
  ///
  /// Note that it is not valid to call this method on a loop without a
  /// loop-invariant backedge-taken count (see
  /// hasLoopInvariantBackedgeTakenCount).
  LLVM_ABI const SCEV *getBackedgeTakenCount(const Loop *L,
                                             ExitCountKind Kind = Exact);
 
  /// Similar to getBackedgeTakenCount, except it will add a set of
  /// SCEV predicates to Predicates that are required to be true in order for
  /// the answer to be correct. Predicates can be checked with run-time
  /// checks and can be used to perform loop versioning.
  LLVM_ABI const SCEV *getPredicatedBackedgeTakenCount(
      const Loop *L, SmallVectorImpl<const SCEVPredicate *> &Predicates);
 
  /// When successful, this returns a SCEVConstant that is greater than or equal
  /// to (i.e. a "conservative over-approximation") of the value returend by
  /// getBackedgeTakenCount.  If such a value cannot be computed, it returns the
  /// SCEVCouldNotCompute object.
  const SCEV *getConstantMaxBackedgeTakenCount(const Loop *L) {
    return getBackedgeTakenCount(L, ConstantMaximum);
  }
 
  /// Similar to getConstantMaxBackedgeTakenCount, except it will add a set of
  /// SCEV predicates to Predicates that are required to be true in order for
  /// the answer to be correct. Predicates can be checked with run-time
  /// checks and can be used to perform loop versioning.
  LLVM_ABI const SCEV *getPredicatedConstantMaxBackedgeTakenCount(
      const Loop *L, SmallVectorImpl<const SCEVPredicate *> &Predicates);
 
  /// When successful, this returns a SCEV that is greater than or equal
  /// to (i.e. a "conservative over-approximation") of the value returend by
  /// getBackedgeTakenCount.  If such a value cannot be computed, it returns the
  /// SCEVCouldNotCompute object.
  const SCEV *getSymbolicMaxBackedgeTakenCount(const Loop *L) {
    return getBackedgeTakenCount(L, SymbolicMaximum);
  }
 
  /// Similar to getSymbolicMaxBackedgeTakenCount, except it will add a set of
  /// SCEV predicates to Predicates that are required to be true in order for
  /// the answer to be correct. Predicates can be checked with run-time
  /// checks and can be used to perform loop versioning.
  LLVM_ABI const SCEV *getPredicatedSymbolicMaxBackedgeTakenCount(
      const Loop *L, SmallVectorImpl<const SCEVPredicate *> &Predicates);
 
  /// Return true if the backedge taken count is either the value returned by
  /// getConstantMaxBackedgeTakenCount or zero.
  LLVM_ABI bool isBackedgeTakenCountMaxOrZero(const Loop *L);
 
  /// Return true if the specified loop has an analyzable loop-invariant
  /// backedge-taken count.
  LLVM_ABI bool hasLoopInvariantBackedgeTakenCount(const Loop *L);
 
  // This method should be called by the client when it made any change that
  // would invalidate SCEV's answers, and the client wants to remove all loop
  // information held internally by ScalarEvolution. This is intended to be used
  // when the alternative to forget a loop is too expensive (i.e. large loop
  // bodies).
  LLVM_ABI void forgetAllLoops();
 
  /// This method should be called by the client when it has changed a loop in
  /// a way that may effect ScalarEvolution's ability to compute a trip count,
  /// or if the loop is deleted.  This call is potentially expensive for large
  /// loop bodies.
  LLVM_ABI void forgetLoop(const Loop *L);
 
  // This method invokes forgetLoop for the outermost loop of the given loop
  // \p L, making ScalarEvolution forget about all this subtree. This needs to
  // be done whenever we make a transform that may affect the parameters of the
  // outer loop, such as exit counts for branches.
  LLVM_ABI void forgetTopmostLoop(const Loop *L);
 
  /// This method should be called by the client when it has changed a value
  /// in a way that may effect its value, or which may disconnect it from a
  /// def-use chain linking it to a loop.
  LLVM_ABI void forgetValue(Value *V);
 
  /// Forget LCSSA phi node V of loop L to which a new predecessor was added,
  /// such that it may no longer be trivial.
  LLVM_ABI void forgetLcssaPhiWithNewPredecessor(Loop *L, PHINode *V);
 
  /// Called when the client has changed the disposition of values in
  /// this loop.
  ///
  /// We don't have a way to invalidate per-loop dispositions. Clear and
  /// recompute is simpler.
  LLVM_ABI void forgetLoopDispositions();
 
  /// Called when the client has changed the disposition of values in
  /// a loop or block.
  ///
  /// We don't have a way to invalidate per-loop/per-block dispositions. Clear
  /// and recompute is simpler.
  LLVM_ABI void forgetBlockAndLoopDispositions(Value *V = nullptr);
 
  /// Determine the minimum number of zero bits that S is guaranteed to end in
  /// (at every loop iteration).  It is, at the same time, the minimum number
  /// of times S is divisible by 2.  For example, given {4,+,8} it returns 2.
  /// If S is guaranteed to be 0, it returns the bitwidth of S.
  /// If \p CtxI is not nullptr, return a constant multiple valid at \p CtxI.
  LLVM_ABI uint32_t getMinTrailingZeros(const SCEV *S,
                                        const Instruction *CtxI = nullptr);
 
  /// Returns the max constant multiple of S. If \p CtxI is not nullptr, return
  /// a constant multiple valid at \p CtxI.
  LLVM_ABI APInt getConstantMultiple(const SCEV *S,
                                     const Instruction *CtxI = nullptr);
 
  // Returns the max constant multiple of S. If S is exactly 0, return 1.
  LLVM_ABI APInt getNonZeroConstantMultiple(const SCEV *S);
 
  /// Determine the unsigned range for a particular SCEV.
  /// NOTE: This returns a copy of the reference returned by getRangeRef.
  ConstantRange getUnsignedRange(const SCEV *S) {
    return getRangeRef(S, HINT_RANGE_UNSIGNED);
  }
 
  /// Determine the min of the unsigned range for a particular SCEV.
  APInt getUnsignedRangeMin(const SCEV *S) {
    return getRangeRef(S, HINT_RANGE_UNSIGNED).getUnsignedMin();
  }
 
  /// Determine the max of the unsigned range for a particular SCEV.
  APInt getUnsignedRangeMax(const SCEV *S) {
    return getRangeRef(S, HINT_RANGE_UNSIGNED).getUnsignedMax();
  }
 
  /// Determine the signed range for a particular SCEV.
  /// NOTE: This returns a copy of the reference returned by getRangeRef.
  ConstantRange getSignedRange(const SCEV *S) {
    return getRangeRef(S, HINT_RANGE_SIGNED);
  }
 
  /// Determine the min of the signed range for a particular SCEV.
  APInt getSignedRangeMin(const SCEV *S) {
    return getRangeRef(S, HINT_RANGE_SIGNED).getSignedMin();
  }
 
  /// Determine the max of the signed range for a particular SCEV.
  APInt getSignedRangeMax(const SCEV *S) {
    return getRangeRef(S, HINT_RANGE_SIGNED).getSignedMax();
  }
 
  /// Test if the given expression is known to be negative.
  LLVM_ABI bool isKnownNegative(const SCEV *S);
 
  /// Test if the given expression is known to be positive.
  LLVM_ABI bool isKnownPositive(const SCEV *S);
 
  /// Test if the given expression is known to be non-negative.
  LLVM_ABI bool isKnownNonNegative(const SCEV *S);
 
  /// Test if the given expression is known to be non-positive.
  LLVM_ABI bool isKnownNonPositive(const SCEV *S);
 
  /// Test if the given expression is known to be non-zero.
  LLVM_ABI bool isKnownNonZero(const SCEV *S);
 
  /// Test if the given expression is known to be a power of 2.  OrNegative
  /// allows matching negative power of 2s, and OrZero allows matching 0.
  LLVM_ABI bool isKnownToBeAPowerOfTwo(const SCEV *S, bool OrZero = false,
                                       bool OrNegative = false);
 
  /// Check that \p S is a multiple of \p M. When \p S is an AddRecExpr, \p S is
  /// a multiple of \p M if \p S starts with a multiple of \p M and at every
  /// iteration step \p S only adds multiples of \p M. \p Assumptions records
  /// the runtime predicates under which \p S is a multiple of \p M.
  LLVM_ABI bool
  isKnownMultipleOf(const SCEV *S, uint64_t M,
                    SmallVectorImpl<const SCEVPredicate *> &Assumptions);
 
  /// Return true if we know that S1 and S2 must have the same sign.
  LLVM_ABI bool haveSameSign(const SCEV *S1, const SCEV *S2);
 
  /// Splits SCEV expression \p S into two SCEVs. One of them is obtained from
  /// \p S by substitution of all AddRec sub-expression related to loop \p L
  /// with initial value of that SCEV. The second is obtained from \p S by
  /// substitution of all AddRec sub-expressions related to loop \p L with post
  /// increment of this AddRec in the loop \p L. In both cases all other AddRec
  /// sub-expressions (not related to \p L) remain the same.
  /// If the \p S contains non-invariant unknown SCEV the function returns
  /// CouldNotCompute SCEV in both values of std::pair.
  /// For example, for SCEV S={0, +, 1}<L1> + {0, +, 1}<L2> and loop L=L1
  /// the function returns pair:
  /// first = {0, +, 1}<L2>
  /// second = {1, +, 1}<L1> + {0, +, 1}<L2>
  /// We can see that for the first AddRec sub-expression it was replaced with
  /// 0 (initial value) for the first element and to {1, +, 1}<L1> (post
  /// increment value) for the second one. In both cases AddRec expression
  /// related to L2 remains the same.
  LLVM_ABI std::pair<const SCEV *, const SCEV *>
  SplitIntoInitAndPostInc(const Loop *L, const SCEV *S);
 
  /// We'd like to check the predicate on every iteration of the most dominated
  /// loop between loops used in LHS and RHS.
  /// To do this we use the following list of steps:
  /// 1. Collect set S all loops on which either LHS or RHS depend.
  /// 2. If S is non-empty
  /// a. Let PD be the element of S which is dominated by all other elements.
  /// b. Let E(LHS) be value of LHS on entry of PD.
  ///    To get E(LHS), we should just take LHS and replace all AddRecs that are
  ///    attached to PD on with their entry values.
  ///    Define E(RHS) in the same way.
  /// c. Let B(LHS) be value of L on backedge of PD.
  ///    To get B(LHS), we should just take LHS and replace all AddRecs that are
  ///    attached to PD on with their backedge values.
  ///    Define B(RHS) in the same way.
  /// d. Note that E(LHS) and E(RHS) are automatically available on entry of PD,
  ///    so we can assert on that.
  /// e. Return true if isLoopEntryGuardedByCond(Pred, E(LHS), E(RHS)) &&
  ///                   isLoopBackedgeGuardedByCond(Pred, B(LHS), B(RHS))
  LLVM_ABI bool isKnownViaInduction(CmpPredicate Pred, SCEVUse LHS,
                                    SCEVUse RHS);
 
  /// Test if the given expression is known to satisfy the condition described
  /// by Pred, LHS, and RHS.
  LLVM_ABI bool isKnownPredicate(CmpPredicate Pred, SCEVUse LHS, SCEVUse RHS);
 
  /// Check whether the condition described by Pred, LHS, and RHS is true or
  /// false. If we know it, return the evaluation of this condition. If neither
  /// is proved, return std::nullopt.
  LLVM_ABI std::optional<bool>
  evaluatePredicate(CmpPredicate Pred, const SCEV *LHS, const SCEV *RHS);
 
  /// Test if the given expression is known to satisfy the condition described
  /// by Pred, LHS, and RHS in the given Context.
  LLVM_ABI bool isKnownPredicateAt(CmpPredicate Pred, const SCEV *LHS,
                                   const SCEV *RHS, const Instruction *CtxI);
 
  /// Check whether the condition described by Pred, LHS, and RHS is true or
  /// false in the given \p Context. If we know it, return the evaluation of
  /// this condition. If neither is proved, return std::nullopt.
  LLVM_ABI std::optional<bool> evaluatePredicateAt(CmpPredicate Pred,
                                                   const SCEV *LHS,
                                                   const SCEV *RHS,
                                                   const Instruction *CtxI);
 
  /// Test if the condition described by Pred, LHS, RHS is known to be true on
  /// every iteration of the loop of the recurrency LHS.
  LLVM_ABI bool isKnownOnEveryIteration(CmpPredicate Pred,
                                        const SCEVAddRecExpr *LHS,
                                        const SCEV *RHS);
 
  /// Information about the number of loop iterations for which a loop exit's
  /// branch condition evaluates to the not-taken path.  This is a temporary
  /// pair of exact and max expressions that are eventually summarized in
  /// ExitNotTakenInfo and BackedgeTakenInfo.
  struct ExitLimit {
    const SCEV *ExactNotTaken; // The exit is not taken exactly this many times
    const SCEV *ConstantMaxNotTaken; // The exit is not taken at most this many
                                     // times
    const SCEV *SymbolicMaxNotTaken;
 
    // Not taken either exactly ConstantMaxNotTaken or zero times
    bool MaxOrZero = false;
 
    /// A vector of predicate guards for this ExitLimit. The result is only
    /// valid if all of the predicates in \c Predicates evaluate to 'true' at
    /// run-time.
    SmallVector<const SCEVPredicate *, 4> Predicates;
 
    /// Construct either an exact exit limit from a constant, or an unknown
    /// one from a SCEVCouldNotCompute.  No other types of SCEVs are allowed
    /// as arguments and asserts enforce that internally.
    /*implicit*/ LLVM_ABI ExitLimit(const SCEV *E);
    /*implicit*/ ExitLimit(SCEVUse E) : ExitLimit((const SCEV *)E) {}
 
    LLVM_ABI
    ExitLimit(const SCEV *E, const SCEV *ConstantMaxNotTaken,
              const SCEV *SymbolicMaxNotTaken, bool MaxOrZero,
              ArrayRef<ArrayRef<const SCEVPredicate *>> PredLists = {});
 
    LLVM_ABI ExitLimit(const SCEV *E, const SCEV *ConstantMaxNotTaken,
                       const SCEV *SymbolicMaxNotTaken, bool MaxOrZero,
                       ArrayRef<const SCEVPredicate *> PredList);
 
    /// Test whether this ExitLimit contains any computed information, or
    /// whether it's all SCEVCouldNotCompute values.
    bool hasAnyInfo() const {
      return !isa<SCEVCouldNotCompute>(ExactNotTaken) ||
             !isa<SCEVCouldNotCompute>(ConstantMaxNotTaken);
    }
 
    /// Test whether this ExitLimit contains all information.
    bool hasFullInfo() const {
      return !isa<SCEVCouldNotCompute>(ExactNotTaken);
    }
  };
 
  /// Compute the number of times the backedge of the specified loop will
  /// execute if its exit condition were a conditional branch of ExitCond.
  ///
  /// \p ControlsOnlyExit is true if ExitCond directly controls the only exit
  /// branch. In this case, we can assume that the loop exits only if the
  /// condition is true and can infer that failing to meet the condition prior
  /// to integer wraparound results in undefined behavior.
  ///
  /// If \p AllowPredicates is set, this call will try to use a minimal set of
  /// SCEV predicates in order to return an exact answer.
  LLVM_ABI ExitLimit computeExitLimitFromCond(const Loop *L, Value *ExitCond,
                                              bool ExitIfTrue,
                                              bool ControlsOnlyExit,
                                              bool AllowPredicates = false);
 
  /// A predicate is said to be monotonically increasing if may go from being
  /// false to being true as the loop iterates, but never the other way
  /// around.  A predicate is said to be monotonically decreasing if may go
  /// from being true to being false as the loop iterates, but never the other
  /// way around.
  enum MonotonicPredicateType {
    MonotonicallyIncreasing,
    MonotonicallyDecreasing
  };
 
  /// If, for all loop invariant X, the predicate "LHS `Pred` X" is
  /// monotonically increasing or decreasing, returns
  /// Some(MonotonicallyIncreasing) and Some(MonotonicallyDecreasing)
  /// respectively. If we could not prove either of these facts, returns
  /// std::nullopt.
  LLVM_ABI std::optional<MonotonicPredicateType>
  getMonotonicPredicateType(const SCEVAddRecExpr *LHS,
                            ICmpInst::Predicate Pred);
 
  struct LoopInvariantPredicate {
    CmpPredicate Pred;
    const SCEV *LHS;
    const SCEV *RHS;
 
    LoopInvariantPredicate(CmpPredicate Pred, const SCEV *LHS, const SCEV *RHS)
        : Pred(Pred), LHS(LHS), RHS(RHS) {}
  };
  /// If the result of the predicate LHS `Pred` RHS is loop invariant with
  /// respect to L, return a LoopInvariantPredicate with LHS and RHS being
  /// invariants, available at L's entry. Otherwise, return std::nullopt.
  LLVM_ABI std::optional<LoopInvariantPredicate>
  getLoopInvariantPredicate(CmpPredicate Pred, const SCEV *LHS, const SCEV *RHS,
                            const Loop *L, const Instruction *CtxI = nullptr);
 
  /// If the result of the predicate LHS `Pred` RHS is loop invariant with
  /// respect to L at given Context during at least first MaxIter iterations,
  /// return a LoopInvariantPredicate with LHS and RHS being invariants,
  /// available at L's entry. Otherwise, return std::nullopt. The predicate
  /// should be the loop's exit condition.
  LLVM_ABI std::optional<LoopInvariantPredicate>
  getLoopInvariantExitCondDuringFirstIterations(CmpPredicate Pred,
                                                const SCEV *LHS,
                                                const SCEV *RHS, const Loop *L,
                                                const Instruction *CtxI,
                                                const SCEV *MaxIter);
 
  LLVM_ABI std::optional<LoopInvariantPredicate>
  getLoopInvariantExitCondDuringFirstIterationsImpl(
      CmpPredicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L,
      const Instruction *CtxI, const SCEV *MaxIter);
 
  /// Simplify LHS and RHS in a comparison with predicate Pred. Return true
  /// iff any changes were made. If the operands are provably equal or
  /// unequal, LHS and RHS are set to the same value and Pred is set to either
  /// ICMP_EQ or ICMP_NE.
  LLVM_ABI bool SimplifyICmpOperands(CmpPredicate &Pred, SCEVUse &LHS,
                                     SCEVUse &RHS, unsigned Depth = 0);
 
  /// Return the "disposition" of the given SCEV with respect to the given
  /// loop.
  LLVM_ABI LoopDisposition getLoopDisposition(const SCEV *S, const Loop *L);
 
  /// Returns true if the given SCEV is loop-uniform with respect to the
  /// specified loop L.
  ///
  /// A SCEV is considered loop-uniform if its value is invariant across all
  /// iterations of L, meaning it does not depend on any induction variables
  /// or values that vary within L.
  ///
  /// This notion is particularly useful in nested loops, where a value may vary
  /// in an inner loop but remain invariant in an outer loop.
  ///
  /// Example:
  /// \code
  ///   for (i)
  ///     for (j)
  ///       dep(j);
  ///       dep(i, j);
  /// \endcode
  /// isLoopUniform(SCEV(dep(j)), loop_i) returns true, as `j` is independent of
  /// `i`.
  /// isLoopUniform(SCEV(dep(i, j)), loop_i) returns false, as the expression
  /// depends on `i`, which varies in loop_i.
  LLVM_ABI bool isLoopUniform(const SCEV *S, const Loop *L);
 
  /// Return true if the value of the given SCEV is unchanging in the
  /// specified loop.
  LLVM_ABI bool isLoopInvariant(const SCEV *S, const Loop *L);
 
  /// Determine if the SCEV can be evaluated at loop's entry. It is true if it
  /// doesn't depend on a SCEVUnknown of an instruction which is dominated by
  /// the header of loop L.
  LLVM_ABI bool isAvailableAtLoopEntry(const SCEV *S, const Loop *L);
 
  /// Return true if the given SCEV changes value in a known way in the
  /// specified loop.  This property being true implies that the value is
  /// variant in the loop AND that we can emit an expression to compute the
  /// value of the expression at any particular loop iteration.
  LLVM_ABI bool hasComputableLoopEvolution(const SCEV *S, const Loop *L);
 
  /// Return the "disposition" of the given SCEV with respect to the given
  /// block.
  LLVM_ABI BlockDisposition getBlockDisposition(const SCEV *S,
                                                const BasicBlock *BB);
 
  /// Return true if elements that makes up the given SCEV dominate the
  /// specified basic block.
  LLVM_ABI bool dominates(const SCEV *S, const BasicBlock *BB);
 
  /// Return true if elements that makes up the given SCEV properly dominate
  /// the specified basic block.
  LLVM_ABI bool properlyDominates(const SCEV *S, const BasicBlock *BB);
 
  /// Test whether the given SCEV has Op as a direct or indirect operand.
  LLVM_ABI bool hasOperand(const SCEV *S, const SCEV *Op) const;
 
  /// Return the size of an element read or written by Inst.
  LLVM_ABI const SCEV *getElementSize(Instruction *Inst);
 
  LLVM_ABI void print(raw_ostream &OS) const;
  LLVM_ABI void verify() const;
  LLVM_ABI bool invalidate(Function &F, const PreservedAnalyses &PA,
                           FunctionAnalysisManager::Invalidator &Inv);
 
  /// Return the DataLayout associated with the module this SCEV instance is
  /// operating on.
  const DataLayout &getDataLayout() const { return DL; }
 
  LLVM_ABI const SCEVPredicate *getEqualPredicate(const SCEV *LHS,
                                                  const SCEV *RHS);
  LLVM_ABI const SCEVPredicate *getComparePredicate(ICmpInst::Predicate Pred,
                                                    const SCEV *LHS,
                                                    const SCEV *RHS);
 
  LLVM_ABI const SCEVPredicate *
  getWrapPredicate(const SCEVAddRecExpr *AR,
                   SCEVWrapPredicate::IncrementWrapFlags AddedFlags);
 
  /// Re-writes the SCEV according to the Predicates in \p A.
  LLVM_ABI const SCEV *rewriteUsingPredicate(const SCEV *S, const Loop *L,
                                             const SCEVPredicate &A);
  /// Tries to convert the \p S expression to an AddRec expression,
  /// adding additional predicates to \p Preds as required.
  LLVM_ABI const SCEVAddRecExpr *convertSCEVToAddRecWithPredicates(
      const SCEV *S, const Loop *L,
      SmallVectorImpl<const SCEVPredicate *> &Preds);
 
  /// Compute \p LHS - \p RHS and returns the result as an APInt if it is a
  /// constant, and std::nullopt if it isn't.
  ///
  /// This is intended to be a cheaper version of getMinusSCEV.  We can be
  /// frugal here since we just bail out of actually constructing and
  /// canonicalizing an expression in the cases where the result isn't going
  /// to be a constant.
  LLVM_ABI std::optional<APInt> computeConstantDifference(const SCEV *LHS,
                                                          const SCEV *RHS);
 
  /// Update no-wrap flags of an AddRec. This may drop the cached info about
  /// this AddRec (such as range info) in case if new flags may potentially
  /// sharpen it.
  LLVM_ABI void setNoWrapFlags(SCEVAddRecExpr *AddRec, SCEV::NoWrapFlags Flags);
 
  class LoopGuards {
    DenseMap<const SCEV *, const SCEV *> RewriteMap;
    SmallDenseSet<std::pair<const SCEV *, const SCEV *>> NotEqual;
    bool PreserveNUW = false;
    bool PreserveNSW = false;
    ScalarEvolution &SE;
 
    LoopGuards(ScalarEvolution &SE) : SE(SE) {}
 
    /// Recursively collect loop guards in \p Guards, starting from
    /// block \p Block with predecessor \p Pred. The intended starting point
    /// is to collect from a loop header and its predecessor.
    static void
    collectFromBlock(ScalarEvolution &SE, ScalarEvolution::LoopGuards &Guards,
                     const BasicBlock *Block, const BasicBlock *Pred,
                     SmallPtrSetImpl<const BasicBlock *> &VisitedBlocks,
                     unsigned Depth = 0);
 
    /// Collect loop guards in \p Guards, starting from PHINode \p
    /// Phi, by calling \p collectFromBlock on the incoming blocks of
    /// \Phi and trying to merge the found constraints into a single
    /// combined one for \p Phi.
    static void collectFromPHI(
        ScalarEvolution &SE, ScalarEvolution::LoopGuards &Guards,
        const PHINode &Phi, SmallPtrSetImpl<const BasicBlock *> &VisitedBlocks,
        SmallDenseMap<const BasicBlock *, LoopGuards> &IncomingGuards,
        unsigned Depth);
 
  public:
    /// Collect rewrite map for loop guards for loop \p L, together with flags
    /// indicating if NUW and NSW can be preserved during rewriting.
    LLVM_ABI static LoopGuards collect(const Loop *L, ScalarEvolution &SE);
 
    /// Try to apply the collected loop guards to \p Expr.
    LLVM_ABI const SCEV *rewrite(const SCEV *Expr) const;
  };
 
  /// Try to apply information from loop guards for \p L to \p Expr.
  LLVM_ABI const SCEV *applyLoopGuards(const SCEV *Expr, const Loop *L);
  LLVM_ABI const SCEV *applyLoopGuards(const SCEV *Expr,
                                       const LoopGuards &Guards);
 
  /// Return true if the loop has no abnormal exits. That is, if the loop
  /// is not infinite, it must exit through an explicit edge in the CFG.
  /// (As opposed to either a) throwing out of the function or b) entering a
  /// well defined infinite loop in some callee.)
  bool loopHasNoAbnormalExits(const Loop *L) {
    return getLoopProperties(L).HasNoAbnormalExits;
  }
 
  /// Return true if this loop is finite by assumption.  That is,
  /// to be infinite, it must also be undefined.
  LLVM_ABI bool loopIsFiniteByAssumption(const Loop *L);
 
  /// Return the set of Values that, if poison, will definitively result in S
  /// being poison as well. The returned set may be incomplete, i.e. there can
  /// be additional Values that also result in S being poison.
  LLVM_ABI void
  getPoisonGeneratingValues(SmallPtrSetImpl<const Value *> &Result,
                            const SCEV *S);
 
  /// Check whether it is poison-safe to represent the expression S using the
  /// instruction I. If such a replacement is performed, the poison flags of
  /// instructions in DropPoisonGeneratingInsts must be dropped.
  LLVM_ABI bool canReuseInstruction(
      const SCEV *S, Instruction *I,
      SmallVectorImpl<Instruction *> &DropPoisonGeneratingInsts);
 
  class FoldID {
    const SCEV *Op = nullptr;
    const Type *Ty = nullptr;
    unsigned short C;
 
  public:
    FoldID(SCEVTypes C, const SCEV *Op, const Type *Ty) : Op(Op), Ty(Ty), C(C) {
      assert(Op);
      assert(Ty);
    }
 
    FoldID(unsigned short C) : C(C) {}
 
    unsigned computeHash() const {
      return detail::combineHashValue(
          C, detail::combineHashValue(reinterpret_cast<uintptr_t>(Op),
                                      reinterpret_cast<uintptr_t>(Ty)));
    }
 
    bool operator==(const FoldID &RHS) const {
      return std::tie(Op, Ty, C) == std::tie(RHS.Op, RHS.Ty, RHS.C);
    }
  };
 
private:
  /// A CallbackVH to arrange for ScalarEvolution to be notified whenever a
  /// Value is deleted.
  class LLVM_ABI SCEVCallbackVH final : public CallbackVH {
    ScalarEvolution *SE;
 
    void deleted() override;
    void allUsesReplacedWith(Value *New) override;
 
  public:
    SCEVCallbackVH(Value *V, ScalarEvolution *SE = nullptr);
  };
 
  friend class SCEVCallbackVH;
  friend class SCEVExpander;
  friend class SCEVUnknown;
 
  /// The function we are analyzing.
  Function &F;
 
  /// Data layout of the module.
  const DataLayout &DL;
 
  /// Does the module have any calls to the llvm.experimental.guard intrinsic
  /// at all?  If this is false, we avoid doing work that will only help if
  /// thare are guards present in the IR.
  bool HasGuards;
 
  /// The target library information for the target we are targeting.
  TargetLibraryInfo &TLI;
 
  /// The tracker for \@llvm.assume intrinsics in this function.
  AssumptionCache &AC;
 
  /// The dominator tree.
  DominatorTree &DT;
 
  /// The loop information for the function we are currently analyzing.
  LoopInfo &LI;
 
  /// This SCEV is used to represent unknown trip counts and things.
  std::unique_ptr<SCEVCouldNotCompute> CouldNotCompute;
 
  /// The type for HasRecMap.
  using HasRecMapType = DenseMap<const SCEV *, bool>;
 
  /// This is a cache to record whether a SCEV contains any scAddRecExpr.
  HasRecMapType HasRecMap;
 
  /// The type for ExprValueMap.
  using ValueSetVector = SmallSetVector<Value *, 4>;
  using ExprValueMapType = DenseMap<const SCEV *, ValueSetVector>;
 
  /// ExprValueMap -- This map records the original values from which
  /// the SCEV expr is generated from.
  ExprValueMapType ExprValueMap;
 
  /// The type for ValueExprMap.
  using ValueExprMapType =
      DenseMap<SCEVCallbackVH, const SCEV *, DenseMapInfo<Value *>>;
 
  /// This is a cache of the values we have analyzed so far.
  ValueExprMapType ValueExprMap;
 
  /// This is a cache for expressions that got folded to a different existing
  /// SCEV.
  DenseMap<FoldID, const SCEV *> FoldCache;
  DenseMap<const SCEV *, SmallVector<FoldID, 2>> FoldCacheUser;
 
  /// Mark predicate values currently being processed by isImpliedCond.
  SmallPtrSet<const Value *, 6> PendingLoopPredicates;
 
  // Mark SCEVUnknown Phis currently being processed by isImpliedViaMerge.
  SmallPtrSet<const PHINode *, 6> PendingMerges;
 
  /// Set to true by isLoopBackedgeGuardedByCond when we're walking the set of
  /// conditions dominating the backedge of a loop.
  bool WalkingBEDominatingConds = false;
 
  /// Set to true by isKnownPredicateViaSplitting when we're trying to prove a
  /// predicate by splitting it into a set of independent predicates.
  bool ProvingSplitPredicate = false;
 
  /// Memoized values for the getConstantMultiple
  DenseMap<const SCEV *, APInt> ConstantMultipleCache;
 
  /// Return the Value set from which the SCEV expr is generated.
  ArrayRef<Value *> getSCEVValues(const SCEV *S);
 
  /// Private helper method for the getConstantMultiple method. If \p CtxI is
  /// not nullptr, return a constant multiple valid at \p CtxI.
  APInt getConstantMultipleImpl(const SCEV *S,
                                const Instruction *Ctx = nullptr);
 
  /// Information about the number of times a particular loop exit may be
  /// reached before exiting the loop.
  struct ExitNotTakenInfo {
    PoisoningVH<BasicBlock> ExitingBlock;
    const SCEV *ExactNotTaken;
    const SCEV *ConstantMaxNotTaken;
    const SCEV *SymbolicMaxNotTaken;
    SmallVector<const SCEVPredicate *, 4> Predicates;
 
    explicit ExitNotTakenInfo(PoisoningVH<BasicBlock> ExitingBlock,
                              const SCEV *ExactNotTaken,
                              const SCEV *ConstantMaxNotTaken,
                              const SCEV *SymbolicMaxNotTaken,
                              ArrayRef<const SCEVPredicate *> Predicates)
        : ExitingBlock(ExitingBlock), ExactNotTaken(ExactNotTaken),
          ConstantMaxNotTaken(ConstantMaxNotTaken),
          SymbolicMaxNotTaken(SymbolicMaxNotTaken), Predicates(Predicates) {}
 
    bool hasAlwaysTruePredicate() const {
      return Predicates.empty();
    }
  };
 
  /// Information about the backedge-taken count of a loop. This currently
  /// includes an exact count and a maximum count.
  ///
  class BackedgeTakenInfo {
    friend class ScalarEvolution;
 
    /// A list of computable exits and their not-taken counts.  Loops almost
    /// never have more than one computable exit.
    SmallVector<ExitNotTakenInfo, 1> ExitNotTaken;
 
    /// Expression indicating the least constant maximum backedge-taken count of
    /// the loop that is known, or a SCEVCouldNotCompute. This expression is
    /// only valid if the predicates associated with all loop exits are true.
    const SCEV *ConstantMax = nullptr;
 
    /// Indicating if \c ExitNotTaken has an element for every exiting block in
    /// the loop.
    bool IsComplete = false;
 
    /// Expression indicating the least maximum backedge-taken count of the loop
    /// that is known, or a SCEVCouldNotCompute. Lazily computed on first query.
    const SCEV *SymbolicMax = nullptr;
 
    /// True iff the backedge is taken either exactly Max or zero times.
    bool MaxOrZero = false;
 
    bool isComplete() const { return IsComplete; }
    const SCEV *getConstantMax() const { return ConstantMax; }
 
    LLVM_ABI const ExitNotTakenInfo *getExitNotTaken(
        const BasicBlock *ExitingBlock,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) const;
 
  public:
    BackedgeTakenInfo() = default;
    BackedgeTakenInfo(BackedgeTakenInfo &&) = default;
    BackedgeTakenInfo &operator=(BackedgeTakenInfo &&) = default;
 
    using EdgeExitInfo = std::pair<BasicBlock *, ExitLimit>;
 
    /// Initialize BackedgeTakenInfo from a list of exact exit counts.
    LLVM_ABI BackedgeTakenInfo(ArrayRef<EdgeExitInfo> ExitCounts,
                               bool IsComplete, const SCEV *ConstantMax,
                               bool MaxOrZero);
 
    /// Test whether this BackedgeTakenInfo contains any computed information,
    /// or whether it's all SCEVCouldNotCompute values.
    bool hasAnyInfo() const {
      return !ExitNotTaken.empty() ||
             !isa<SCEVCouldNotCompute>(getConstantMax());
    }
 
    /// Test whether this BackedgeTakenInfo contains complete information.
    bool hasFullInfo() const { return isComplete(); }
 
    /// Return an expression indicating the exact *backedge-taken*
    /// count of the loop if it is known or SCEVCouldNotCompute
    /// otherwise.  If execution makes it to the backedge on every
    /// iteration (i.e. there are no abnormal exists like exception
    /// throws and thread exits) then this is the number of times the
    /// loop header will execute minus one.
    ///
    /// If the SCEV predicate associated with the answer can be different
    /// from AlwaysTrue, we must add a (non null) Predicates argument.
    /// The SCEV predicate associated with the answer will be added to
    /// Predicates. A run-time check needs to be emitted for the SCEV
    /// predicate in order for the answer to be valid.
    ///
    /// Note that we should always know if we need to pass a predicate
    /// argument or not from the way the ExitCounts vector was computed.
    /// If we allowed SCEV predicates to be generated when populating this
    /// vector, this information can contain them and therefore a
    /// SCEVPredicate argument should be added to getExact.
    LLVM_ABI const SCEV *getExact(
        const Loop *L, ScalarEvolution *SE,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) const;
 
    /// Return the number of times this loop exit may fall through to the back
    /// edge, or SCEVCouldNotCompute. The loop is guaranteed not to exit via
    /// this block before this number of iterations, but may exit via another
    /// block. If \p Predicates is null the function returns CouldNotCompute if
    /// predicates are required, otherwise it fills in the required predicates.
    const SCEV *getExact(
        const BasicBlock *ExitingBlock, ScalarEvolution *SE,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) const {
      if (auto *ENT = getExitNotTaken(ExitingBlock, Predicates))
        return ENT->ExactNotTaken;
      else
        return SE->getCouldNotCompute();
    }
 
    /// Get the constant max backedge taken count for the loop.
    LLVM_ABI const SCEV *getConstantMax(
        ScalarEvolution *SE,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) const;
 
    /// Get the constant max backedge taken count for the particular loop exit.
    const SCEV *getConstantMax(
        const BasicBlock *ExitingBlock, ScalarEvolution *SE,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) const {
      if (auto *ENT = getExitNotTaken(ExitingBlock, Predicates))
        return ENT->ConstantMaxNotTaken;
      else
        return SE->getCouldNotCompute();
    }
 
    /// Get the symbolic max backedge taken count for the loop.
    LLVM_ABI const SCEV *getSymbolicMax(
        const Loop *L, ScalarEvolution *SE,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr);
 
    /// Get the symbolic max backedge taken count for the particular loop exit.
    const SCEV *getSymbolicMax(
        const BasicBlock *ExitingBlock, ScalarEvolution *SE,
        SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) const {
      if (auto *ENT = getExitNotTaken(ExitingBlock, Predicates))
        return ENT->SymbolicMaxNotTaken;
      else
        return SE->getCouldNotCompute();
    }
 
    /// Return true if the number of times this backedge is taken is either the
    /// value returned by getConstantMax or zero.
    LLVM_ABI bool isConstantMaxOrZero(ScalarEvolution *SE) const;
  };
 
  /// Cache the backedge-taken count of the loops for this function as they
  /// are computed.
  DenseMap<const Loop *, BackedgeTakenInfo> BackedgeTakenCounts;
 
  /// Cache the predicated backedge-taken count of the loops for this
  /// function as they are computed.
  DenseMap<const Loop *, BackedgeTakenInfo> PredicatedBackedgeTakenCounts;
 
  /// Loops whose backedge taken counts directly use this non-constant SCEV.
  DenseMap<const SCEV *, SmallPtrSet<PointerIntPair<const Loop *, 1, bool>, 4>>
      BECountUsers;
 
  /// This map contains entries for all of the PHI instructions that we
  /// attempt to compute constant evolutions for.  This allows us to avoid
  /// potentially expensive recomputation of these properties.  An instruction
  /// maps to null if we are unable to compute its exit value.
  DenseMap<PHINode *, Constant *> ConstantEvolutionLoopExitValue;
 
  /// This map contains entries for all the expressions that we attempt to
  /// compute getSCEVAtScope information for, which can be expensive in
  /// extreme cases.
  DenseMap<const SCEV *, SmallVector<std::pair<const Loop *, const SCEV *>, 2>>
      ValuesAtScopes;
 
  /// Reverse map for invalidation purposes: Stores of which SCEV and which
  /// loop this is the value-at-scope of.
  DenseMap<const SCEV *, SmallVector<std::pair<const Loop *, const SCEV *>, 2>>
      ValuesAtScopesUsers;
 
  /// Memoized computeLoopDisposition results.
  DenseMap<const SCEV *,
           SmallVector<PointerIntPair<const Loop *, 2, LoopDisposition>, 2>>
      LoopDispositions;
 
  struct LoopProperties {
    /// Set to true if the loop contains no instruction that can abnormally exit
    /// the loop (i.e. via throwing an exception, by terminating the thread
    /// cleanly or by infinite looping in a called function).  Strictly
    /// speaking, the last one is not leaving the loop, but is identical to
    /// leaving the loop for reasoning about undefined behavior.
    bool HasNoAbnormalExits;
 
    /// Set to true if the loop contains no instruction that can have side
    /// effects (i.e. via throwing an exception, volatile or atomic access).
    bool HasNoSideEffects;
  };
 
  /// Cache for \c getLoopProperties.
  DenseMap<const Loop *, LoopProperties> LoopPropertiesCache;
 
  /// Return a \c LoopProperties instance for \p L, creating one if necessary.
  LLVM_ABI LoopProperties getLoopProperties(const Loop *L);
 
  bool loopHasNoSideEffects(const Loop *L) {
    return getLoopProperties(L).HasNoSideEffects;
  }
 
  /// Compute a LoopDisposition value.
  LoopDisposition computeLoopDisposition(const SCEV *S, const Loop *L);
 
  /// Memoized computeBlockDisposition results.
  DenseMap<
      const SCEV *,
      SmallVector<PointerIntPair<const BasicBlock *, 2, BlockDisposition>, 2>>
      BlockDispositions;
 
  /// Compute a BlockDisposition value.
  BlockDisposition computeBlockDisposition(const SCEV *S, const BasicBlock *BB);
 
  /// Stores all SCEV that use a given SCEV as its direct operand.
  DenseMap<const SCEV *, SmallPtrSet<const SCEV *, 8> > SCEVUsers;
 
  /// Memoized results from getRange
  DenseMap<const SCEV *, ConstantRange> UnsignedRanges;
 
  /// Memoized results from getRange
  DenseMap<const SCEV *, ConstantRange> SignedRanges;
 
  /// Used to parameterize getRange
  enum RangeSignHint { HINT_RANGE_UNSIGNED, HINT_RANGE_SIGNED };
 
  /// Set the memoized range for the given SCEV.
  const ConstantRange &setRange(const SCEV *S, RangeSignHint Hint,
                                ConstantRange CR) {
    DenseMap<const SCEV *, ConstantRange> &Cache =
        Hint == HINT_RANGE_UNSIGNED ? UnsignedRanges : SignedRanges;
 
    auto Pair = Cache.insert_or_assign(S, std::move(CR));
    return Pair.first->second;
  }
 
  /// Determine the range for a particular SCEV.
  /// NOTE: This returns a reference to an entry in a cache. It must be
  /// copied if its needed for longer.
  LLVM_ABI const ConstantRange &getRangeRef(const SCEV *S, RangeSignHint Hint,
                                            unsigned Depth = 0);
 
  /// Determine the range for a particular SCEV, but evaluates ranges for
  /// operands iteratively first.
  const ConstantRange &getRangeRefIter(const SCEV *S, RangeSignHint Hint);
 
  /// Determines the range for the affine SCEVAddRecExpr {\p Start,+,\p Step}.
  /// Helper for \c getRange.
  ConstantRange getRangeForAffineAR(const SCEV *Start, const SCEV *Step,
                                    const APInt &MaxBECount);
 
  /// Determines the range for the affine non-self-wrapping SCEVAddRecExpr {\p
  /// Start,+,\p Step}<nw>.
  ConstantRange getRangeForAffineNoSelfWrappingAR(const SCEVAddRecExpr *AddRec,
                                                  const SCEV *MaxBECount,
                                                  unsigned BitWidth,
                                                  RangeSignHint SignHint);
 
  /// Try to compute a range for the affine SCEVAddRecExpr {\p Start,+,\p
  /// Step} by "factoring out" a ternary expression from the add recurrence.
  /// Helper called by \c getRange.
  ConstantRange getRangeViaFactoring(const SCEV *Start, const SCEV *Step,
                                     const APInt &MaxBECount);
 
  /// If the unknown expression U corresponds to a simple recurrence, return
  /// a constant range which represents the entire recurrence.  Note that
  /// *add* recurrences with loop invariant steps aren't represented by
  /// SCEVUnknowns and thus don't use this mechanism.
  ConstantRange getRangeForUnknownRecurrence(const SCEVUnknown *U);
 
  /// We know that there is no SCEV for the specified value.  Analyze the
  /// expression recursively.
  const SCEV *createSCEV(Value *V);
 
  /// We know that there is no SCEV for the specified value. Create a new SCEV
  /// for \p V iteratively.
  const SCEV *createSCEVIter(Value *V);
  /// Collect operands of \p V for which SCEV expressions should be constructed
  /// first. Returns a SCEV directly if it can be constructed trivially for \p
  /// V.
  const SCEV *getOperandsToCreate(Value *V, SmallVectorImpl<Value *> &Ops);
 
  /// Returns SCEV for the first operand of a phi if all phi operands have
  /// identical opcodes and operands.
  const SCEV *createNodeForPHIWithIdenticalOperands(PHINode *PN);
 
  /// Provide the special handling we need to analyze PHI SCEVs.
  const SCEV *createNodeForPHI(PHINode *PN);
 
  /// Helper function called from createNodeForPHI.
  const SCEV *createAddRecFromPHI(PHINode *PN);
 
  /// A helper function for createAddRecFromPHI to handle simple cases.
  const SCEV *createSimpleAffineAddRec(PHINode *PN, Value *BEValueV,
                                            Value *StartValueV);
 
  /// Helper function called from createNodeForPHI.
  const SCEV *createNodeFromSelectLikePHI(PHINode *PN);
 
  /// Provide special handling for a select-like instruction (currently this
  /// is either a select instruction or a phi node).  \p Ty is the type of the
  /// instruction being processed, that is assumed equivalent to
  /// "Cond ? TrueVal : FalseVal".
  std::optional<const SCEV *>
  createNodeForSelectOrPHIInstWithICmpInstCond(Type *Ty, ICmpInst *Cond,
                                               Value *TrueVal, Value *FalseVal);
 
  /// See if we can model this select-like instruction via umin_seq expression.
  const SCEV *createNodeForSelectOrPHIViaUMinSeq(Value *I, Value *Cond,
                                                 Value *TrueVal,
                                                 Value *FalseVal);
 
  /// Given a value \p V, which is a select-like instruction (currently this is
  /// either a select instruction or a phi node), which is assumed equivalent to
  ///   Cond ? TrueVal : FalseVal
  /// see if we can model it as a SCEV expression.
  const SCEV *createNodeForSelectOrPHI(Value *V, Value *Cond, Value *TrueVal,
                                       Value *FalseVal);
 
  /// Provide the special handling we need to analyze GEP SCEVs.
  const SCEV *createNodeForGEP(GEPOperator *GEP);
 
  /// Implementation code for getSCEVAtScope; called at most once for each
  /// SCEV+Loop pair.
  const SCEV *computeSCEVAtScope(const SCEV *S, const Loop *L);
 
  /// Return the BackedgeTakenInfo for the given loop, lazily computing new
  /// values if the loop hasn't been analyzed yet. The returned result is
  /// guaranteed not to be predicated.
  BackedgeTakenInfo &getBackedgeTakenInfo(const Loop *L);
 
  /// Similar to getBackedgeTakenInfo, but will add predicates as required
  /// with the purpose of returning complete information.
  BackedgeTakenInfo &getPredicatedBackedgeTakenInfo(const Loop *L);
 
  /// Compute the number of times the specified loop will iterate.
  /// If AllowPredicates is set, we will create new SCEV predicates as
  /// necessary in order to return an exact answer.
  BackedgeTakenInfo computeBackedgeTakenCount(const Loop *L,
                                              bool AllowPredicates = false);
 
  /// Compute the number of times the backedge of the specified loop will
  /// execute if it exits via the specified block. If AllowPredicates is set,
  /// this call will try to use a minimal set of SCEV predicates in order to
  /// return an exact answer.
  ExitLimit computeExitLimit(const Loop *L, BasicBlock *ExitingBlock,
                             bool IsOnlyExit, bool AllowPredicates = false);
 
  // Helper functions for computeExitLimitFromCond to avoid exponential time
  // complexity.
 
  class ExitLimitCache {
    // It may look like we need key on the whole (L, ExitIfTrue,
    // ControlsOnlyExit, AllowPredicates) tuple, but recursive calls to
    // computeExitLimitFromCondCached from computeExitLimitFromCondImpl only
    // vary the in \c ExitCond and \c ControlsOnlyExit parameters.  We remember
    // the initial values of the other values to assert our assumption.
    SmallDenseMap<PointerIntPair<Value *, 1>, ExitLimit> TripCountMap;
 
    const Loop *L;
    bool ExitIfTrue;
    bool AllowPredicates;
 
  public:
    ExitLimitCache(const Loop *L, bool ExitIfTrue, bool AllowPredicates)
        : L(L), ExitIfTrue(ExitIfTrue), AllowPredicates(AllowPredicates) {}
 
    LLVM_ABI std::optional<ExitLimit> find(const Loop *L, Value *ExitCond,
                                           bool ExitIfTrue,
                                           bool ControlsOnlyExit,
                                           bool AllowPredicates);
 
    LLVM_ABI void insert(const Loop *L, Value *ExitCond, bool ExitIfTrue,
                         bool ControlsOnlyExit, bool AllowPredicates,
                         const ExitLimit &EL);
  };
 
  using ExitLimitCacheTy = ExitLimitCache;
 
  ExitLimit computeExitLimitFromCondCached(ExitLimitCacheTy &Cache,
                                           const Loop *L, Value *ExitCond,
                                           bool ExitIfTrue,
                                           bool ControlsOnlyExit,
                                           bool AllowPredicates);
  ExitLimit computeExitLimitFromCondImpl(ExitLimitCacheTy &Cache, const Loop *L,
                                         Value *ExitCond, bool ExitIfTrue,
                                         bool ControlsOnlyExit,
                                         bool AllowPredicates);
  std::optional<ScalarEvolution::ExitLimit>
  computeExitLimitFromCondFromBinOp(ExitLimitCacheTy &Cache, const Loop *L,
                                    Value *ExitCond, bool ExitIfTrue,
                                    bool AllowPredicates);
 
  /// Compute the number of times the backedge of the specified loop will
  /// execute if its exit condition were a conditional branch of the ICmpInst
  /// ExitCond and ExitIfTrue. If AllowPredicates is set, this call will try
  /// to use a minimal set of SCEV predicates in order to return an exact
  /// answer.
  ExitLimit computeExitLimitFromICmp(const Loop *L, ICmpInst *ExitCond,
                                     bool ExitIfTrue,
                                     bool IsSubExpr,
                                     bool AllowPredicates = false);
 
  /// Variant of previous which takes the components representing an ICmp
  /// as opposed to the ICmpInst itself.  Note that the prior version can
  /// return more precise results in some cases and is preferred when caller
  /// has a materialized ICmp.
  ExitLimit computeExitLimitFromICmp(const Loop *L, CmpPredicate Pred,
                                     SCEVUse LHS, SCEVUse RHS, bool IsSubExpr,
                                     bool AllowPredicates = false);
 
  /// Compute the number of times the backedge of the specified loop will
  /// execute if its exit condition were a switch with a single exiting case
  /// to ExitingBB.
  ExitLimit computeExitLimitFromSingleExitSwitch(const Loop *L,
                                                 SwitchInst *Switch,
                                                 BasicBlock *ExitingBB,
                                                 bool IsSubExpr);
 
  /// Compute the exit limit of a loop that is controlled by a
  /// "(IV >> 1) != 0" type comparison.  We cannot compute the exact trip
  /// count in these cases (since SCEV has no way of expressing them), but we
  /// can still sometimes compute an upper bound.
  ///
  /// Return an ExitLimit for a loop whose backedge is guarded by `LHS Pred
  /// RHS`.
  ExitLimit computeShiftCompareExitLimit(Value *LHS, Value *RHS, const Loop *L,
                                         ICmpInst::Predicate Pred);
 
  /// If the loop is known to execute a constant number of times (the
  /// condition evolves only from constants), try to evaluate a few iterations
  /// of the loop until we get the exit condition gets a value of ExitWhen
  /// (true or false).  If we cannot evaluate the exit count of the loop,
  /// return CouldNotCompute.
  const SCEV *computeExitCountExhaustively(const Loop *L, Value *Cond,
                                           bool ExitWhen);
 
  /// Return the number of times an exit condition comparing the specified
  /// value to zero will execute.  If not computable, return CouldNotCompute.
  /// If AllowPredicates is set, this call will try to use a minimal set of
  /// SCEV predicates in order to return an exact answer.
  ExitLimit howFarToZero(const SCEV *V, const Loop *L, bool IsSubExpr,
                         bool AllowPredicates = false);
 
  /// Return the number of times an exit condition checking the specified
  /// value for nonzero will execute.  If not computable, return
  /// CouldNotCompute.
  ExitLimit howFarToNonZero(const SCEV *V, const Loop *L);
 
  /// Return the number of times an exit condition containing the specified
  /// less-than comparison will execute.  If not computable, return
  /// CouldNotCompute.
  ///
  /// \p isSigned specifies whether the less-than is signed.
  ///
  /// \p ControlsOnlyExit is true when the LHS < RHS condition directly controls
  /// the branch (loops exits only if condition is true). In this case, we can
  /// use NoWrapFlags to skip overflow checks.
  ///
  /// If \p AllowPredicates is set, this call will try to use a minimal set of
  /// SCEV predicates in order to return an exact answer.
  ExitLimit howManyLessThans(const SCEV *LHS, const SCEV *RHS, const Loop *L,
                             bool isSigned, bool ControlsOnlyExit,
                             bool AllowPredicates = false);
 
  ExitLimit howManyGreaterThans(const SCEV *LHS, const SCEV *RHS, const Loop *L,
                                bool isSigned, bool IsSubExpr,
                                bool AllowPredicates = false);
 
  /// Return a predecessor of BB (which may not be an immediate predecessor)
  /// which has exactly one successor from which BB is reachable, or null if
  /// no such block is found.
  std::pair<const BasicBlock *, const BasicBlock *>
  getPredecessorWithUniqueSuccessorForBB(const BasicBlock *BB) const;
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the given FoundCondValue value evaluates to true in given
  /// Context. If Context is nullptr, then the found predicate is true
  /// everywhere. LHS and FoundLHS may have different type width.
  LLVM_ABI bool isImpliedCond(CmpPredicate Pred, const SCEV *LHS,
                              const SCEV *RHS, const Value *FoundCondValue,
                              bool Inverse,
                              const Instruction *Context = nullptr);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the given FoundCondValue value evaluates to true in given
  /// Context. If Context is nullptr, then the found predicate is true
  /// everywhere. LHS and FoundLHS must have same type width.
  LLVM_ABI bool isImpliedCondBalancedTypes(CmpPredicate Pred, SCEVUse LHS,
                                           SCEVUse RHS, CmpPredicate FoundPred,
                                           SCEVUse FoundLHS, SCEVUse FoundRHS,
                                           const Instruction *CtxI);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by FoundPred, FoundLHS, FoundRHS is
  /// true in given Context. If Context is nullptr, then the found predicate is
  /// true everywhere.
  LLVM_ABI bool isImpliedCond(CmpPredicate Pred, const SCEV *LHS,
                              const SCEV *RHS, CmpPredicate FoundPred,
                              const SCEV *FoundLHS, const SCEV *FoundRHS,
                              const Instruction *Context = nullptr);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true in given Context. If Context is nullptr, then the found predicate is
  /// true everywhere.
  bool isImpliedCondOperands(CmpPredicate Pred, const SCEV *LHS,
                             const SCEV *RHS, const SCEV *FoundLHS,
                             const SCEV *FoundRHS,
                             const Instruction *Context = nullptr);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true. Here LHS is an operation that includes FoundLHS as one of its
  /// arguments.
  bool isImpliedViaOperations(CmpPredicate Pred, const SCEV *LHS,
                              const SCEV *RHS, const SCEV *FoundLHS,
                              const SCEV *FoundRHS, unsigned Depth = 0);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true.
  /// Use only simple non-recursive types of checks, such as range analysis etc.
  bool isKnownViaNonRecursiveReasoning(CmpPredicate Pred, SCEVUse LHS,
                                       SCEVUse RHS);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true.
  bool isImpliedCondOperandsHelper(CmpPredicate Pred, const SCEV *LHS,
                                   const SCEV *RHS, const SCEV *FoundLHS,
                                   const SCEV *FoundRHS);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true.  Utility function used by isImpliedCondOperands.  Tries to get
  /// cases like "X `sgt` 0 => X - 1 `sgt` -1".
  bool isImpliedCondOperandsViaRanges(CmpPredicate Pred, const SCEV *LHS,
                                      const SCEV *RHS, CmpPredicate FoundPred,
                                      const SCEV *FoundLHS,
                                      const SCEV *FoundRHS);
 
  /// Return true if the condition denoted by \p LHS \p Pred \p RHS is implied
  /// by a call to @llvm.experimental.guard in \p BB.
  bool isImpliedViaGuard(const BasicBlock *BB, CmpPredicate Pred,
                         const SCEV *LHS, const SCEV *RHS);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true.
  ///
  /// This routine tries to rule out certain kinds of integer overflow, and
  /// then tries to reason about arithmetic properties of the predicates.
  bool isImpliedCondOperandsViaNoOverflow(CmpPredicate Pred, const SCEV *LHS,
                                          const SCEV *RHS, const SCEV *FoundLHS,
                                          const SCEV *FoundRHS);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true.
  ///
  /// This routine tries to weaken the known condition basing on fact that
  /// FoundLHS is an AddRec.
  bool isImpliedCondOperandsViaAddRecStart(CmpPredicate Pred, const SCEV *LHS,
                                           const SCEV *RHS,
                                           const SCEV *FoundLHS,
                                           const SCEV *FoundRHS,
                                           const Instruction *CtxI);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true.
  ///
  /// This routine tries to figure out predicate for Phis which are SCEVUnknown
  /// if it is true for every possible incoming value from their respective
  /// basic blocks.
  bool isImpliedViaMerge(CmpPredicate Pred, const SCEV *LHS, const SCEV *RHS,
                         const SCEV *FoundLHS, const SCEV *FoundRHS,
                         unsigned Depth);
 
  /// Test whether the condition described by Pred, LHS, and RHS is true
  /// whenever the condition described by Pred, FoundLHS, and FoundRHS is
  /// true.
  ///
  /// This routine tries to reason about shifts.
  bool isImpliedCondOperandsViaShift(CmpPredicate Pred, const SCEV *LHS,
                                     const SCEV *RHS, const SCEV *FoundLHS,
                                     const SCEV *FoundRHS);
 
  /// If we know that the specified Phi is in the header of its containing
  /// loop, we know the loop executes a constant number of times, and the PHI
  /// node is just a recurrence involving constants, fold it.
  Constant *getConstantEvolutionLoopExitValue(PHINode *PN, const APInt &BEs,
                                              const Loop *L);
 
  /// Test if the given expression is known to satisfy the condition described
  /// by Pred and the known constant ranges of LHS and RHS.
  bool isKnownPredicateViaConstantRanges(CmpPredicate Pred, SCEVUse LHS,
                                         SCEVUse RHS);
 
  /// Try to prove the condition described by "LHS Pred RHS" by ruling out
  /// integer overflow.
  ///
  /// For instance, this will return true for "A s< (A + C)<nsw>" if C is
  /// positive.
  bool isKnownPredicateViaNoOverflow(CmpPredicate Pred, SCEVUse LHS,
                                     SCEVUse RHS);
 
  /// Try to split Pred LHS RHS into logical conjunctions (and's) and try to
  /// prove them individually.
  bool isKnownPredicateViaSplitting(CmpPredicate Pred, SCEVUse LHS,
                                    SCEVUse RHS);
 
  /// Try to match the Expr as "(L + R)<Flags>".
  bool splitBinaryAdd(SCEVUse Expr, SCEVUse &L, SCEVUse &R,
                      SCEV::NoWrapFlags &Flags);
 
  /// Forget predicated/non-predicated backedge taken counts for the given loop.
  void forgetBackedgeTakenCounts(const Loop *L, bool Predicated);
 
  /// Drop memoized information for all \p SCEVs.
  void forgetMemoizedResults(ArrayRef<SCEVUse> SCEVs);
 
  /// Helper for forgetMemoizedResults.
  void forgetMemoizedResultsImpl(const SCEV *S);
 
  /// Iterate over instructions in \p Worklist and their users. Erase entries
  /// from ValueExprMap and collect SCEV expressions in \p ToForget
  void visitAndClearUsers(SmallVectorImpl<Instruction *> &Worklist,
                          SmallPtrSetImpl<Instruction *> &Visited,
                          SmallVectorImpl<SCEVUse> &ToForget);
 
  /// Erase Value from ValueExprMap and ExprValueMap.
  void eraseValueFromMap(Value *V);
 
  /// Insert V to S mapping into ValueExprMap and ExprValueMap.
  void insertValueToMap(Value *V, const SCEV *S);
 
  /// Return false iff given SCEV contains a SCEVUnknown with NULL value-
  /// pointer.
  bool checkValidity(const SCEV *S) const;
 
  /// Return true if `ExtendOpTy`({`Start`,+,`Step`}) can be proved to be
  /// equal to {`ExtendOpTy`(`Start`),+,`ExtendOpTy`(`Step`)}.  This is
  /// equivalent to proving no signed (resp. unsigned) wrap in
  /// {`Start`,+,`Step`} if `ExtendOpTy` is `SCEVSignExtendExpr`
  /// (resp. `SCEVZeroExtendExpr`).
  template <typename ExtendOpTy>
  bool proveNoWrapByVaryingStart(const SCEV *Start, const SCEV *Step,
                                 const Loop *L);
 
  /// Try to prove NSW or NUW on \p AR relying on ConstantRange manipulation.
  SCEV::NoWrapFlags proveNoWrapViaConstantRanges(const SCEVAddRecExpr *AR);
 
  /// Try to prove NSW on \p AR by proving facts about conditions known  on
  /// entry and backedge.
  SCEV::NoWrapFlags proveNoSignedWrapViaInduction(const SCEVAddRecExpr *AR);
 
  /// Try to prove NUW on \p AR by proving facts about conditions known on
  /// entry and backedge.
  SCEV::NoWrapFlags proveNoUnsignedWrapViaInduction(const SCEVAddRecExpr *AR);
 
  std::optional<MonotonicPredicateType>
  getMonotonicPredicateTypeImpl(const SCEVAddRecExpr *LHS,
                                ICmpInst::Predicate Pred);
 
  /// Return SCEV no-wrap flags that can be proven based on reasoning about
  /// how poison produced from no-wrap flags on this value (e.g. a nuw add)
  /// would trigger undefined behavior on overflow.
  SCEV::NoWrapFlags getNoWrapFlagsFromUB(const Value *V);
 
  /// Return a scope which provides an upper bound on the defining scope of
  /// 'S'. Specifically, return the first instruction in said bounding scope.
  /// Return nullptr if the scope is trivial (function entry).
  /// (See scope definition rules associated with flag discussion above)
  const Instruction *getNonTrivialDefiningScopeBound(const SCEV *S);
 
  /// Return a scope which provides an upper bound on the defining scope for
  /// a SCEV with the operands in Ops.  The outparam Precise is set if the
  /// bound found is a precise bound (i.e. must be the defining scope.)
  const Instruction *getDefiningScopeBound(ArrayRef<SCEVUse> Ops,
                                           bool &Precise);
 
  /// Wrapper around the above for cases which don't care if the bound
  /// is precise.
  const Instruction *getDefiningScopeBound(ArrayRef<SCEVUse> Ops);
 
  /// Given two instructions in the same function, return true if we can
  /// prove B must execute given A executes.
  bool isGuaranteedToTransferExecutionTo(const Instruction *A,
                                         const Instruction *B);
 
  /// Returns true if \p Op is guaranteed not to cause immediate UB.
  bool isGuaranteedNotToCauseUB(const SCEV *Op);
 
  /// Returns true if \p Op is guaranteed to not be poison.
  static bool isGuaranteedNotToBePoison(const SCEV *Op);
 
  /// Return true if the SCEV corresponding to \p I is never poison.  Proving
  /// this is more complex than proving that just \p I is never poison, since
  /// SCEV commons expressions across control flow, and you can have cases
  /// like:
  ///
  ///   idx0 = a + b;
  ///   ptr[idx0] = 100;
  ///   if (<condition>) {
  ///     idx1 = a +nsw b;
  ///     ptr[idx1] = 200;
  ///   }
  ///
  /// where the SCEV expression (+ a b) is guaranteed to not be poison (and
  /// hence not sign-overflow) only if "<condition>" is true.  Since both
  /// `idx0` and `idx1` will be mapped to the same SCEV expression, (+ a b),
  /// it is not okay to annotate (+ a b) with <nsw> in the above example.
  bool isSCEVExprNeverPoison(const Instruction *I);
 
  /// This is like \c isSCEVExprNeverPoison but it specifically works for
  /// instructions that will get mapped to SCEV add recurrences.  Return true
  /// if \p I will never generate poison under the assumption that \p I is an
  /// add recurrence on the loop \p L.
  bool isAddRecNeverPoison(const Instruction *I, const Loop *L);
 
  /// Similar to createAddRecFromPHI, but with the additional flexibility of
  /// suggesting runtime overflow checks in case casts are encountered.
  /// If successful, the analysis records that for this loop, \p SymbolicPHI,
  /// which is the UnknownSCEV currently representing the PHI, can be rewritten
  /// into an AddRec, assuming some predicates; The function then returns the
  /// AddRec and the predicates as a pair, and caches this pair in
  /// PredicatedSCEVRewrites.
  /// If the analysis is not successful, a mapping from the \p SymbolicPHI to
  /// itself (with no predicates) is recorded, and a nullptr with an empty
  /// predicates vector is returned as a pair.
  std::optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
  createAddRecFromPHIWithCastsImpl(const SCEVUnknown *SymbolicPHI);
 
  /// Compute the maximum backedge count based on the range of values
  /// permitted by Start, End, and Stride. This is for loops of the form
  /// {Start, +, Stride} LT End.
  ///
  /// Preconditions:
  /// * the induction variable is known to be positive.
  /// * the induction variable is assumed not to overflow (i.e. either it
  ///   actually doesn't, or we'd have to immediately execute UB)
  /// We *don't* assert these preconditions so please be careful.
  const SCEV *computeMaxBECountForLT(const SCEV *Start, const SCEV *Stride,
                                     const SCEV *End, unsigned BitWidth,
                                     bool IsSigned);
 
  /// Verify if an linear IV with positive stride can overflow when in a
  /// less-than comparison, knowing the invariant term of the comparison,
  /// the stride.
  bool canIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride, bool IsSigned);
 
  /// Verify if an linear IV with negative stride can overflow when in a
  /// greater-than comparison, knowing the invariant term of the comparison,
  /// the stride.
  bool canIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride, bool IsSigned);
 
  /// Get add expr already created or create a new one.
  const SCEV *getOrCreateAddExpr(ArrayRef<SCEVUse> Ops,
                                 SCEV::NoWrapFlags Flags);
 
  /// Get mul expr already created or create a new one.
  const SCEV *getOrCreateMulExpr(ArrayRef<SCEVUse> Ops,
                                 SCEV::NoWrapFlags Flags);
 
  // Get addrec expr already created or create a new one.
  const SCEV *getOrCreateAddRecExpr(ArrayRef<SCEVUse> Ops, const Loop *L,
                                    SCEV::NoWrapFlags Flags);
 
  /// Return x if \p Val is f(x) where f is a 1-1 function.
  const SCEV *stripInjectiveFunctions(const SCEV *Val) const;
 
  /// Find all of the loops transitively used in \p S, and fill \p LoopsUsed.
  /// A loop is considered "used" by an expression if it contains
  /// an add rec on said loop.
  void getUsedLoops(const SCEV *S, SmallPtrSetImpl<const Loop *> &LoopsUsed);
 
  /// Look for a SCEV expression with type `SCEVType` and operands `Ops` in
  /// `UniqueSCEVs`.  Return if found, else nullptr.
  SCEV *findExistingSCEVInCache(SCEVTypes SCEVType, ArrayRef<const SCEV *> Ops);
  SCEV *findExistingSCEVInCache(SCEVTypes SCEVType, ArrayRef<SCEVUse> Ops);
 
  /// Get reachable blocks in this function, making limited use of SCEV
  /// reasoning about conditions.
  void getReachableBlocks(SmallPtrSetImpl<BasicBlock *> &Reachable,
                          Function &F);
 
  /// Return the given SCEV expression with a new set of operands.
  /// This preserves the origial nowrap flags.
  const SCEV *getWithOperands(const SCEV *S, SmallVectorImpl<SCEVUse> &NewOps);
 
  FoldingSet<SCEV> UniqueSCEVs;
  FoldingSet<SCEVPredicate> UniquePreds;
  BumpPtrAllocator SCEVAllocator;
 
  /// This maps loops to a list of addrecs that directly use said loop.
  DenseMap<const Loop *, SmallVector<const SCEVAddRecExpr *, 4>> LoopUsers;
 
  /// Cache tentative mappings from UnknownSCEVs in a Loop, to a SCEV expression
  /// they can be rewritten into under certain predicates.
  DenseMap<std::pair<const SCEVUnknown *, const Loop *>,
           std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
      PredicatedSCEVRewrites;
 
  /// Set of AddRecs for which proving NUW via an induction has already been
  /// tried.
  SmallPtrSet<const SCEVAddRecExpr *, 16> UnsignedWrapViaInductionTried;
 
  /// Set of AddRecs for which proving NSW via an induction has already been
  /// tried.
  SmallPtrSet<const SCEVAddRecExpr *, 16> SignedWrapViaInductionTried;
 
  /// The head of a linked list of all SCEVUnknown values that have been
  /// allocated. This is used by releaseMemory to locate them all and call
  /// their destructors.
  SCEVUnknown *FirstUnknown = nullptr;
};
 
/// Analysis pass that exposes the \c ScalarEvolution for a function.
class ScalarEvolutionAnalysis
    : public AnalysisInfoMixin<ScalarEvolutionAnalysis> {
  friend AnalysisInfoMixin<ScalarEvolutionAnalysis>;
 
  LLVM_ABI static AnalysisKey Key;
 
public:
  using Result = ScalarEvolution;
 
  LLVM_ABI ScalarEvolution run(Function &F, FunctionAnalysisManager &AM);
};
 
/// Verifier pass for the \c ScalarEvolutionAnalysis results.
class ScalarEvolutionVerifierPass
    : public RequiredPassInfoMixin<ScalarEvolutionVerifierPass> {
public:
  LLVM_ABI PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
};
 
/// Printer pass for the \c ScalarEvolutionAnalysis results.
class ScalarEvolutionPrinterPass
    : public RequiredPassInfoMixin<ScalarEvolutionPrinterPass> {
  raw_ostream &OS;
 
public:
  explicit ScalarEvolutionPrinterPass(raw_ostream &OS) : OS(OS) {}
 
  LLVM_ABI PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
};
 
class LLVM_ABI ScalarEvolutionWrapperPass : public FunctionPass {
  std::unique_ptr<ScalarEvolution> SE;
 
public:
  static char ID;
 
  ScalarEvolutionWrapperPass();
 
  ScalarEvolution &getSE() { return *SE; }
  const ScalarEvolution &getSE() const { return *SE; }
 
  bool runOnFunction(Function &F) override;
  void releaseMemory() override;
  void getAnalysisUsage(AnalysisUsage &AU) const override;
  void print(raw_ostream &OS, const Module * = nullptr) const override;
  void verifyAnalysis() const override;
};
 
/// An interface layer with SCEV used to manage how we see SCEV expressions
/// for values in the context of existing predicates. We can add new
/// predicates, but we cannot remove them.
///
/// This layer has multiple purposes:
///   - provides a simple interface for SCEV versioning.
///   - guarantees that the order of transformations applied on a SCEV
///     expression for a single Value is consistent across two different
///     getSCEV calls. This means that, for example, once we've obtained
///     an AddRec expression for a certain value through expression
///     rewriting, we will continue to get an AddRec expression for that
///     Value.
///   - lowers the number of expression rewrites.
class PredicatedScalarEvolution {
public:
  LLVM_ABI PredicatedScalarEvolution(ScalarEvolution &SE, Loop &L);
 
  LLVM_ABI const SCEVPredicate &getPredicate() const;
 
  /// Returns the SCEV expression of V, in the context of the current SCEV
  /// predicate.  The order of transformations applied on the expression of V
  /// returned by ScalarEvolution is guaranteed to be preserved, even when
  /// adding new predicates.
  LLVM_ABI const SCEV *getSCEV(Value *V);
 
  /// Returns the rewritten SCEV for \p Expr in the context of the current SCEV
  /// predicate. The order of transformations applied on the expression of \p
  /// Expr returned by ScalarEvolution is guaranteed to be preserved, even when
  /// adding new predicates.
  LLVM_ABI const SCEV *getPredicatedSCEV(const SCEV *Expr);
 
  /// Get the (predicated) backedge count for the analyzed loop.
  LLVM_ABI const SCEV *getBackedgeTakenCount();
 
  /// Get the (predicated) symbolic max backedge count for the analyzed loop.
  LLVM_ABI const SCEV *getSymbolicMaxBackedgeTakenCount();
 
  /// Returns the upper bound of the loop trip count as a normal unsigned
  /// value, or 0 if the trip count is unknown.
  LLVM_ABI unsigned getSmallConstantMaxTripCount();
 
  /// Adds a new predicate.
  LLVM_ABI void addPredicate(const SCEVPredicate &Pred);
 
  /// Attempts to produce an AddRecExpr for V by adding additional SCEV
  /// predicates. If we can't transform the expression into an AddRecExpr we
  /// return nullptr and not add additional SCEV predicates to the current
  /// context.
  LLVM_ABI const SCEVAddRecExpr *getAsAddRec(Value *V);
 
  /// Proves that V doesn't overflow by adding SCEV predicate.
  LLVM_ABI void setNoOverflow(Value *V,
                              SCEVWrapPredicate::IncrementWrapFlags Flags);
 
  /// Returns true if we've proved that V doesn't wrap by means of a SCEV
  /// predicate.
  LLVM_ABI bool hasNoOverflow(Value *V,
                              SCEVWrapPredicate::IncrementWrapFlags Flags);
 
  /// Returns the ScalarEvolution analysis used.
  ScalarEvolution *getSE() const { return &SE; }
 
  /// We need to explicitly define the copy constructor because of FlagsMap.
  LLVM_ABI PredicatedScalarEvolution(const PredicatedScalarEvolution &);
 
  /// Print the SCEV mappings done by the Predicated Scalar Evolution.
  /// The printed text is indented by \p Depth.
  LLVM_ABI void print(raw_ostream &OS, unsigned Depth) const;
 
  /// Check if \p AR1 and \p AR2 are equal, while taking into account
  /// Equal predicates in Preds.
  LLVM_ABI bool areAddRecsEqualWithPreds(const SCEVAddRecExpr *AR1,
                                         const SCEVAddRecExpr *AR2) const;
 
private:
  /// Increments the version number of the predicate.  This needs to be called
  /// every time the SCEV predicate changes.
  void updateGeneration();
 
  /// Holds a SCEV and the version number of the SCEV predicate used to
  /// perform the rewrite of the expression.
  using RewriteEntry = std::pair<unsigned, const SCEV *>;
 
  /// Maps a SCEV to the rewrite result of that SCEV at a certain version
  /// number. If this number doesn't match the current Generation, we will
  /// need to do a rewrite. To preserve the transformation order of previous
  /// rewrites, we will rewrite the previous result instead of the original
  /// SCEV.
  DenseMap<const SCEV *, RewriteEntry> RewriteMap;
 
  /// Records what NoWrap flags we've added to a Value *.
  ValueMap<Value *, SCEVWrapPredicate::IncrementWrapFlags> FlagsMap;
 
  /// The ScalarEvolution analysis.
  ScalarEvolution &SE;
 
  /// The analyzed Loop.
  const Loop &L;
 
  /// The SCEVPredicate that forms our context. We will rewrite all
  /// expressions assuming that this predicate true.
  std::unique_ptr<SCEVUnionPredicate> Preds;
 
  /// Marks the version of the SCEV predicate used. When rewriting a SCEV
  /// expression we mark it with the version of the predicate. We use this to
  /// figure out if the predicate has changed from the last rewrite of the
  /// SCEV. If so, we need to perform a new rewrite.
  unsigned Generation = 0;
 
  /// The backedge taken count.
  const SCEV *BackedgeCount = nullptr;
 
  /// The symbolic backedge taken count.
  const SCEV *SymbolicMaxBackedgeCount = nullptr;
 
  /// The constant max trip count for the loop.
  std::optional<unsigned> SmallConstantMaxTripCount;
};
 
template <> struct DenseMapInfo<ScalarEvolution::FoldID> {
  static inline ScalarEvolution::FoldID getEmptyKey() {
    ScalarEvolution::FoldID ID(0);
    return ID;
  }
  static inline ScalarEvolution::FoldID getTombstoneKey() {
    ScalarEvolution::FoldID ID(1);
    return ID;
  }
 
  static unsigned getHashValue(const ScalarEvolution::FoldID &Val) {
    return Val.computeHash();
  }
 
  static bool isEqual(const ScalarEvolution::FoldID &LHS,
                      const ScalarEvolution::FoldID &RHS) {
    return LHS == RHS;
  }
};
 
template <> inline const SCEV *SCEVUseT<const SCEV *>::getCanonical() const {
  return getPointer()->getCanonical();
}
 
template <typename SCEVPtrT>
void SCEVUseT<SCEVPtrT>::print(raw_ostream &OS) const {
  getPointer()->print(OS);
  SCEV::NoWrapFlags Flags = getUseNoWrapFlags();
  if (any(Flags & SCEV::FlagNUW))
    OS << "(u nuw)";
  if (any(Flags & SCEV::FlagNSW))
    OS << "(u nsw)";
}
 
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
template <typename SCEVPtrT>
LLVM_DUMP_METHOD void SCEVUseT<SCEVPtrT>::dump() const {
  print(dbgs());
  dbgs() << '\n';
}
#endif
 
} // end namespace llvm
 
#endif // LLVM_ANALYSIS_SCALAREVOLUTION_H