/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h

Bug Summary

File:	llvm/include/llvm/ADT/APInt.h
Warning:	line 927, column 15 Assigned value is garbage or undefined

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name BasicAliasAnalysis.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -fno-split-dwarf-inlining -debugger-tuning=gdb -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-12/lib/clang/12.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/build-llvm/lib/Analysis -I /build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis -I /build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/build-llvm/include -I /build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-12/lib/clang/12.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/build-llvm/lib/Analysis -fdebug-prefix-map=/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2=. -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2020-12-05-164821-2931-1 -x c++ /build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp

/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp

→

1//===- BasicAliasAnalysis.cpp - Stateless Alias Analysis Impl -------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the primary stateless implementation of the
10// Alias Analysis interface that implements identities (two different
11// globals cannot alias, etc), but does no stateful analysis.
12//
13//===----------------------------------------------------------------------===//

15#include "llvm/Analysis/BasicAliasAnalysis.h"
16#include "llvm/ADT/APInt.h"
17#include "llvm/ADT/ScopeExit.h"
18#include "llvm/ADT/SmallPtrSet.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/ADT/Statistic.h"
21#include "llvm/Analysis/AliasAnalysis.h"
22#include "llvm/Analysis/AssumptionCache.h"
23#include "llvm/Analysis/CFG.h"
24#include "llvm/Analysis/CaptureTracking.h"
25#include "llvm/Analysis/InstructionSimplify.h"
26#include "llvm/Analysis/LoopInfo.h"
27#include "llvm/Analysis/MemoryBuiltins.h"
28#include "llvm/Analysis/MemoryLocation.h"
29#include "llvm/Analysis/PhiValues.h"
30#include "llvm/Analysis/TargetLibraryInfo.h"
31#include "llvm/Analysis/ValueTracking.h"
32#include "llvm/IR/Argument.h"
33#include "llvm/IR/Attributes.h"
34#include "llvm/IR/Constant.h"
35#include "llvm/IR/Constants.h"
36#include "llvm/IR/DataLayout.h"
37#include "llvm/IR/DerivedTypes.h"
38#include "llvm/IR/Dominators.h"
39#include "llvm/IR/Function.h"
40#include "llvm/IR/GetElementPtrTypeIterator.h"
41#include "llvm/IR/GlobalAlias.h"
42#include "llvm/IR/GlobalVariable.h"
43#include "llvm/IR/InstrTypes.h"
44#include "llvm/IR/Instruction.h"
45#include "llvm/IR/Instructions.h"
46#include "llvm/IR/IntrinsicInst.h"
47#include "llvm/IR/Intrinsics.h"
48#include "llvm/IR/Metadata.h"
49#include "llvm/IR/Operator.h"
50#include "llvm/IR/Type.h"
51#include "llvm/IR/User.h"
52#include "llvm/IR/Value.h"
53#include "llvm/InitializePasses.h"
54#include "llvm/Pass.h"
55#include "llvm/Support/Casting.h"
56#include "llvm/Support/CommandLine.h"
57#include "llvm/Support/Compiler.h"
58#include "llvm/Support/KnownBits.h"
59#include <cassert>
60#include <cstdint>
61#include <cstdlib>
62#include <utility>

64#define DEBUG_TYPE"basicaa" "basicaa"

66using namespace llvm;

68/// Enable analysis of recursive PHI nodes.
69static cl::opt<bool> EnableRecPhiAnalysis("basic-aa-recphi", cl::Hidden,
                                        cl::init(true));

72/// By default, even on 32-bit architectures we use 64-bit integers for
73/// calculations. This will allow us to more-aggressively decompose indexing
74/// expressions calculated using i64 values (e.g., long long in C) which is
75/// common enough to worry about.
76static cl::opt<bool> ForceAtLeast64Bits("basic-aa-force-at-least-64b",
                                      cl::Hidden, cl::init(true));
78static cl::opt<bool> DoubleCalcBits("basic-aa-double-calc-bits",
                                  cl::Hidden, cl::init(false));

81/// SearchLimitReached / SearchTimes shows how often the limit of
82/// to decompose GEPs is reached. It will affect the precision
83/// of basic alias analysis.
84STATISTIC(SearchLimitReached, "Number of times the limit to "static llvm::Statistic SearchLimitReached = {"basicaa", "SearchLimitReached"
, "Number of times the limit to " "decompose GEPs is reached"
}
                            "decompose GEPs is reached")static llvm::Statistic SearchLimitReached = {"basicaa", "SearchLimitReached"
, "Number of times the limit to " "decompose GEPs is reached"
};
86STATISTIC(SearchTimes, "Number of times a GEP is decomposed")static llvm::Statistic SearchTimes = {"basicaa", "SearchTimes"
, "Number of times a GEP is decomposed"};

88/// Cutoff after which to stop analysing a set of phi nodes potentially involved
89/// in a cycle. Because we are analysing 'through' phi nodes, we need to be
90/// careful with value equivalence. We use reachability to make sure a value
91/// cannot be involved in a cycle.
92const unsigned MaxNumPhiBBsValueReachabilityCheck = 20;

94// The max limit of the search depth in DecomposeGEPExpression() and
95// getUnderlyingObject(), both functions need to use the same search
96// depth otherwise the algorithm in aliasGEP will assert.
97static const unsigned MaxLookupSearchDepth = 6;

99bool BasicAAResult::invalidate(Function &Fn, const PreservedAnalyses &PA,
                             FunctionAnalysisManager::Invalidator &Inv) {
// We don't care if this analysis itself is preserved, it has no state. But
// we need to check that the analyses it depends on have been. Note that we
// may be created without handles to some analyses and in that case don't
// depend on them.
if (Inv.invalidate<AssumptionAnalysis>(Fn, PA) ||
    (DT && Inv.invalidate<DominatorTreeAnalysis>(Fn, PA)) ||
    (LI && Inv.invalidate<LoopAnalysis>(Fn, PA)) ||
    (PV && Inv.invalidate<PhiValuesAnalysis>(Fn, PA)))
  return true;

// Otherwise this analysis result remains valid.
return false;
113}

115//===----------------------------------------------------------------------===//
116// Useful predicates
117//===----------------------------------------------------------------------===//

119/// Returns true if the pointer is one which would have been considered an
120/// escape by isNonEscapingLocalObject.
121static bool isEscapeSource(const Value *V) {
if (isa<CallBase>(V))
  return true;

if (isa<Argument>(V))
  return true;

// The load case works because isNonEscapingLocalObject considers all
// stores to be escapes (it passes true for the StoreCaptures argument
// to PointerMayBeCaptured).
if (isa<LoadInst>(V))
  return true;

return false;
135}

137/// Returns the size of the object specified by V or UnknownSize if unknown.
138static uint64_t getObjectSize(const Value *V, const DataLayout &DL,
                            const TargetLibraryInfo &TLI,
                            bool NullIsValidLoc,
                            bool RoundToAlign = false) {
uint64_t Size;
ObjectSizeOpts Opts;
Opts.RoundToAlign = RoundToAlign;
Opts.NullIsUnknownSize = NullIsValidLoc;
if (getObjectSize(V, Size, DL, &TLI, Opts))
  return Size;
return MemoryLocation::UnknownSize;
149}

151/// Returns true if we can prove that the object specified by V is smaller than
152/// Size.
153static bool isObjectSmallerThan(const Value *V, uint64_t Size,
                              const DataLayout &DL,
                              const TargetLibraryInfo &TLI,
                              bool NullIsValidLoc) {
// Note that the meanings of the "object" are slightly different in the
// following contexts:
//    c1: llvm::getObjectSize()
//    c2: llvm.objectsize() intrinsic
//    c3: isObjectSmallerThan()
// c1 and c2 share the same meaning; however, the meaning of "object" in c3
// refers to the "entire object".
//
//  Consider this example:
//     char *p = (char*)malloc(100)
//     char *q = p+80;
//
//  In the context of c1 and c2, the "object" pointed by q refers to the
// stretch of memory of q[0:19]. So, getObjectSize(q) should return 20.
//
//  However, in the context of c3, the "object" refers to the chunk of memory
// being allocated. So, the "object" has 100 bytes, and q points to the middle
// the "object". In case q is passed to isObjectSmallerThan() as the 1st
// parameter, before the llvm::getObjectSize() is called to get the size of
// entire object, we should:
//    - either rewind the pointer q to the base-address of the object in
//      question (in this case rewind to p), or
//    - just give up. It is up to caller to make sure the pointer is pointing
//      to the base address the object.
//
// We go for 2nd option for simplicity.
if (!isIdentifiedObject(V))
  return false;

// This function needs to use the aligned object size because we allow
// reads a bit past the end given sufficient alignment.
uint64_t ObjectSize = getObjectSize(V, DL, TLI, NullIsValidLoc,
                                    /*RoundToAlign*/ true);

return ObjectSize != MemoryLocation::UnknownSize && ObjectSize < Size;
192}

194/// Return the minimal extent from \p V to the end of the underlying object,
195/// assuming the result is used in an aliasing query. E.g., we do use the query
196/// location size and the fact that null pointers cannot alias here.
197static uint64_t getMinimalExtentFrom(const Value &V,
                                   const LocationSize &LocSize,
                                   const DataLayout &DL,
                                   bool NullIsValidLoc) {
// If we have dereferenceability information we know a lower bound for the
// extent as accesses for a lower offset would be valid. We need to exclude
// the "or null" part if null is a valid pointer.
bool CanBeNull;
uint64_t DerefBytes = V.getPointerDereferenceableBytes(DL, CanBeNull);
DerefBytes = (CanBeNull && NullIsValidLoc) ? 0 : DerefBytes;
// If queried with a precise location size, we assume that location size to be
// accessed, thus valid.
if (LocSize.isPrecise())
  DerefBytes = std::max(DerefBytes, LocSize.getValue());
return DerefBytes;
212}

214/// Returns true if we can prove that the object specified by V has size Size.
215static bool isObjectSize(const Value *V, uint64_t Size, const DataLayout &DL,
                       const TargetLibraryInfo &TLI, bool NullIsValidLoc) {
uint64_t ObjectSize = getObjectSize(V, DL, TLI, NullIsValidLoc);
return ObjectSize != MemoryLocation::UnknownSize && ObjectSize == Size;
219}

221//===----------------------------------------------------------------------===//
222// GetElementPtr Instruction Decomposition and Analysis
223//===----------------------------------------------------------------------===//

225/// Analyzes the specified value as a linear expression: "A*V + B", where A and
226/// B are constant integers.
227///
228/// Returns the scale and offset values as APInts and return V as a Value*, and
229/// return whether we looked through any sign or zero extends.  The incoming
230/// Value is known to have IntegerType, and it may already be sign or zero
231/// extended.
232///
233/// Note that this looks through extends, so the high bits may not be
234/// represented in the result.
235/*static*/ const Value *BasicAAResult::GetLinearExpression(
  const Value *V, APInt &Scale, APInt &Offset, unsigned &ZExtBits,
  unsigned &SExtBits, const DataLayout &DL, unsigned Depth,
  AssumptionCache *AC, DominatorTree *DT, bool &NSW, bool &NUW) {
assert(V->getType()->isIntegerTy() && "Not an integer value")((V->getType()->isIntegerTy() && "Not an integer value"
) ? static_cast<void> (0) : __assert_fail ("V->getType()->isIntegerTy() && \"Not an integer value\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 239, __PRETTY_FUNCTION__));
7
←
'?' condition is true→

// Limit our recursion depth.
if (Depth7.1
'Depth' is not equal to 6
1
'Depth' is not equal to 6
 == 6) {
8
←
Taking false branch→
  Scale = 1;
  Offset = 0;
  return V;
}

if (const ConstantInt *Const9.1
'Const' is null
1
'Const' is null
 = dyn_cast<ConstantInt>(V)) {
9
←
Assuming 'V' is not a 'ConstantInt'→
10
←
Taking false branch→
  // If it's a constant, just convert it to an offset and remove the variable.
  // If we've been called recursively, the Offset bit width will be greater
  // than the constant's (the Offset's always as wide as the outermost call),
  // so we'll zext here and process any extension in the isa<SExtInst> &
  // isa<ZExtInst> cases below.
  Offset += Const->getValue().zextOrSelf(Offset.getBitWidth());
  assert(Scale == 0 && "Constant values don't have a scale")((Scale == 0 && "Constant values don't have a scale")
 ? static_cast<void> (0) : __assert_fail ("Scale == 0 && \"Constant values don't have a scale\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 255, __PRETTY_FUNCTION__));
  return V;
}

if (const BinaryOperator *BOp11.1
'BOp' is non-null
1
'BOp' is non-null
 = dyn_cast<BinaryOperator>(V)) {
11
←
Assuming 'V' is a 'BinaryOperator'→
12
←
Taking true branch→
  if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
13
←
Assuming 'RHSC' is non-null→
14
←
Taking true branch→
    // If we've been called recursively, then Offset and Scale will be wider
    // than the BOp operands. We'll always zext it here as we'll process sign
    // extensions below (see the isa<SExtInst> / isa<ZExtInst> cases).
    APInt RHS = RHSC->getValue().zextOrSelf(Offset.getBitWidth());

    switch (BOp->getOpcode()) {
15
←
Control jumps to 'case Shl:'  at line 299→
    default:
      // We don't understand this instruction, so we can't decompose it any
      // further.
      Scale = 1;
      Offset = 0;
      return V;
    case Instruction::Or:
      // X|C == X+C if all the bits in C are unset in X.  Otherwise we can't
      // analyze it.
      if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), DL, 0, AC,
                             BOp, DT)) {
        Scale = 1;
        Offset = 0;
        return V;
      }
      LLVM_FALLTHROUGH[[gnu::fallthrough]];
    case Instruction::Add:
      V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
                              SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
      Offset += RHS;
      break;
    case Instruction::Sub:
      V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
                              SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
      Offset -= RHS;
      break;
    case Instruction::Mul:
      V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
                              SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);
      Offset *= RHS;
      Scale *= RHS;
      break;
    case Instruction::Shl:
      V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, ZExtBits,
                              SExtBits, DL, Depth + 1, AC, DT, NSW, NUW);

      // We're trying to linearize an expression of the kind:
      //   shl i8 -128, 36
      // where the shift count exceeds the bitwidth of the type.
      // We can't decompose this further (the expression would return
      // a poison value).
      if (Offset.getBitWidth() < RHS.getLimitedValue() ||
16
←
Assuming the condition is false→
18
←
Taking false branch→
          Scale.getBitWidth() < RHS.getLimitedValue()) {
17
←
Assuming the condition is false→
        Scale = 1;
        Offset = 0;
        return V;
      }

      Offset <<= RHS.getLimitedValue();
19
←
Passing the value 18446744073709551615 via 1st parameter 'Limit'→
20
←
Calling 'APInt::getLimitedValue'→
23
←
Returning from 'APInt::getLimitedValue'→
24
←
Passing the value 4294967295 via 1st parameter 'ShiftAmt'→
25
←
Calling 'APInt::operator<<='→
      Scale <<= RHS.getLimitedValue();
      // the semantics of nsw and nuw for left shifts don't match those of
      // multiplications, so we won't propagate them.
      NSW = NUW = false;
      return V;
    }

    if (isa<OverflowingBinaryOperator>(BOp)) {
      NUW &= BOp->hasNoUnsignedWrap();
      NSW &= BOp->hasNoSignedWrap();
    }
    return V;
  }
}

// Since GEP indices are sign extended anyway, we don't care about the high
// bits of a sign or zero extended value - just scales and offsets.  The
// extensions have to be consistent though.
if (isa<SExtInst>(V) || isa<ZExtInst>(V)) {
  Value *CastOp = cast<CastInst>(V)->getOperand(0);
  unsigned NewWidth = V->getType()->getPrimitiveSizeInBits();
  unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
  unsigned OldZExtBits = ZExtBits, OldSExtBits = SExtBits;
  const Value *Result =
      GetLinearExpression(CastOp, Scale, Offset, ZExtBits, SExtBits, DL,
                          Depth + 1, AC, DT, NSW, NUW);

  // zext(zext(%x)) == zext(%x), and similarly for sext; we'll handle this
  // by just incrementing the number of bits we've extended by.
  unsigned ExtendedBy = NewWidth - SmallWidth;

  if (isa<SExtInst>(V) && ZExtBits == 0) {
    // sext(sext(%x, a), b) == sext(%x, a + b)

    if (NSW) {
      // We haven't sign-wrapped, so it's valid to decompose sext(%x + c)
      // into sext(%x) + sext(c). We'll sext the Offset ourselves:
      unsigned OldWidth = Offset.getBitWidth();
      Offset = Offset.trunc(SmallWidth).sext(NewWidth).zextOrSelf(OldWidth);
    } else {
      // We may have signed-wrapped, so don't decompose sext(%x + c) into
      // sext(%x) + sext(c)
      Scale = 1;
      Offset = 0;
      Result = CastOp;
      ZExtBits = OldZExtBits;
      SExtBits = OldSExtBits;
    }
    SExtBits += ExtendedBy;
  } else {
    // sext(zext(%x, a), b) = zext(zext(%x, a), b) = zext(%x, a + b)

    if (!NUW) {
      // We may have unsigned-wrapped, so don't decompose zext(%x + c) into
      // zext(%x) + zext(c)
      Scale = 1;
      Offset = 0;
      Result = CastOp;
      ZExtBits = OldZExtBits;
      SExtBits = OldSExtBits;
    }
    ZExtBits += ExtendedBy;
  }

  return Result;
}

Scale = 1;
Offset = 0;
return V;
386}

388/// To ensure a pointer offset fits in an integer of size PointerSize
389/// (in bits) when that size is smaller than the maximum pointer size. This is
390/// an issue, for example, in particular for 32b pointers with negative indices
391/// that rely on two's complement wrap-arounds for precise alias information
392/// where the maximum pointer size is 64b.
393static APInt adjustToPointerSize(const APInt &Offset, unsigned PointerSize) {
assert(PointerSize <= Offset.getBitWidth() && "Invalid PointerSize!")((PointerSize <= Offset.getBitWidth() && "Invalid PointerSize!"
) ? static_cast<void> (0) : __assert_fail ("PointerSize <= Offset.getBitWidth() && \"Invalid PointerSize!\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 394, __PRETTY_FUNCTION__));
unsigned ShiftBits = Offset.getBitWidth() - PointerSize;
return (Offset << ShiftBits).ashr(ShiftBits);
397}

399static unsigned getMaxPointerSize(const DataLayout &DL) {
unsigned MaxPointerSize = DL.getMaxPointerSizeInBits();
if (MaxPointerSize < 64 && ForceAtLeast64Bits) MaxPointerSize = 64;
if (DoubleCalcBits) MaxPointerSize *= 2;

return MaxPointerSize;
405}

407/// If V is a symbolic pointer expression, decompose it into a base pointer
408/// with a constant offset and a number of scaled symbolic offsets.
409///
410/// The scaled symbolic offsets (represented by pairs of a Value* and a scale
411/// in the VarIndices vector) are Value*'s that are known to be scaled by the
412/// specified amount, but which may have other unrepresented high bits. As
413/// such, the gep cannot necessarily be reconstructed from its decomposed form.
414///
415/// This function is capable of analyzing everything that getUnderlyingObject
416/// can look through. To be able to do that getUnderlyingObject and
417/// DecomposeGEPExpression must use the same search depth
418/// (MaxLookupSearchDepth).
419BasicAAResult::DecomposedGEP
420BasicAAResult::DecomposeGEPExpression(const Value *V, const DataLayout &DL,
                                    AssumptionCache *AC, DominatorTree *DT) {
// Limit recursion depth to limit compile time in crazy cases.
unsigned MaxLookup = MaxLookupSearchDepth;
SearchTimes++;

unsigned MaxPointerSize = getMaxPointerSize(DL);
DecomposedGEP Decomposed;
Decomposed.Offset = APInt(MaxPointerSize, 0);
Decomposed.HasCompileTimeConstantScale = true;
do {
  // See if this is a bitcast or GEP.
  const Operator *Op = dyn_cast<Operator>(V);
  if (!Op) {
    // The only non-operator case we can handle are GlobalAliases.
    if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
      if (!GA->isInterposable()) {
        V = GA->getAliasee();
        continue;
      }
    }
    Decomposed.Base = V;
    return Decomposed;
  }

  if (Op->getOpcode() == Instruction::BitCast ||
      Op->getOpcode() == Instruction::AddrSpaceCast) {
    V = Op->getOperand(0);
    continue;
  }

  const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
  if (!GEPOp) {
    if (const auto *PHI = dyn_cast<PHINode>(V)) {
      // Look through single-arg phi nodes created by LCSSA.
      if (PHI->getNumIncomingValues() == 1) {
        V = PHI->getIncomingValue(0);
        continue;
      }
    } else if (const auto *Call = dyn_cast<CallBase>(V)) {
      // CaptureTracking can know about special capturing properties of some
      // intrinsics like launder.invariant.group, that can't be expressed with
      // the attributes, but have properties like returning aliasing pointer.
      // Because some analysis may assume that nocaptured pointer is not
      // returned from some special intrinsic (because function would have to
      // be marked with returns attribute), it is crucial to use this function
      // because it should be in sync with CaptureTracking. Not using it may
      // cause weird miscompilations where 2 aliasing pointers are assumed to
      // noalias.
      if (auto *RP = getArgumentAliasingToReturnedPointer(Call, false)) {
        V = RP;
        continue;
      }
    }

    Decomposed.Base = V;
    return Decomposed;
  }

  // Don't attempt to analyze GEPs over unsized objects.
  if (!GEPOp->getSourceElementType()->isSized()) {
    Decomposed.Base = V;
    return Decomposed;
  }

  // Don't attempt to analyze GEPs if index scale is not a compile-time
  // constant.
  if (isa<ScalableVectorType>(GEPOp->getSourceElementType())) {
    Decomposed.Base = V;
    Decomposed.HasCompileTimeConstantScale = false;
    return Decomposed;
  }

  unsigned AS = GEPOp->getPointerAddressSpace();
  // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
  gep_type_iterator GTI = gep_type_begin(GEPOp);
  unsigned PointerSize = DL.getPointerSizeInBits(AS);
  // Assume all GEP operands are constants until proven otherwise.
  bool GepHasConstantOffset = true;
  for (User::const_op_iterator I = GEPOp->op_begin() + 1, E = GEPOp->op_end();
       I != E; ++I, ++GTI) {
    const Value *Index = *I;
    // Compute the (potentially symbolic) offset in bytes for this index.
    if (StructType *STy = GTI.getStructTypeOrNull()) {
      // For a struct, add the member offset.
      unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
      if (FieldNo == 0)
        continue;

      Decomposed.Offset += DL.getStructLayout(STy)->getElementOffset(FieldNo);
      continue;
    }

    // For an array/pointer, add the element offset, explicitly scaled.
    if (const ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
      if (CIdx->isZero())
        continue;
      Decomposed.Offset +=
          DL.getTypeAllocSize(GTI.getIndexedType()).getFixedSize() *
          CIdx->getValue().sextOrTrunc(MaxPointerSize);
      continue;
    }

    GepHasConstantOffset = false;

    APInt Scale(MaxPointerSize,
                DL.getTypeAllocSize(GTI.getIndexedType()).getFixedSize());
    unsigned ZExtBits = 0, SExtBits = 0;

    // If the integer type is smaller than the pointer size, it is implicitly
    // sign extended to pointer size.
    unsigned Width = Index->getType()->getIntegerBitWidth();
    if (PointerSize > Width)
      SExtBits += PointerSize - Width;

    // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
    APInt IndexScale(Width, 0), IndexOffset(Width, 0);
    bool NSW = true, NUW = true;
    const Value *OrigIndex = Index;
    Index = GetLinearExpression(Index, IndexScale, IndexOffset, ZExtBits,
                                SExtBits, DL, 0, AC, DT, NSW, NUW);

    // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
    // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.

    // It can be the case that, even through C1*V+C2 does not overflow for
    // relevant values of V, (C2*Scale) can overflow. In that case, we cannot
    // decompose the expression in this way.
    //
    // FIXME: C1*Scale and the other operations in the decomposed
    // (C1*Scale)*V+C2*Scale can also overflow. We should check for this
    // possibility.
    bool Overflow;
    APInt ScaledOffset = IndexOffset.sextOrTrunc(MaxPointerSize)
                         .smul_ov(Scale, Overflow);
    if (Overflow) {
      Index = OrigIndex;
      IndexScale = 1;
      IndexOffset = 0;

      ZExtBits = SExtBits = 0;
      if (PointerSize > Width)
        SExtBits += PointerSize - Width;
    } else {
      Decomposed.Offset += ScaledOffset;
      Scale *= IndexScale.sextOrTrunc(MaxPointerSize);
    }

    // If we already had an occurrence of this index variable, merge this
    // scale into it.  For example, we want to handle:
    //   A[x][x] -> x*16 + x*4 -> x*20
    // This also ensures that 'x' only appears in the index list once.
    for (unsigned i = 0, e = Decomposed.VarIndices.size(); i != e; ++i) {
      if (Decomposed.VarIndices[i].V == Index &&
          Decomposed.VarIndices[i].ZExtBits == ZExtBits &&
          Decomposed.VarIndices[i].SExtBits == SExtBits) {
        Scale += Decomposed.VarIndices[i].Scale;
        Decomposed.VarIndices.erase(Decomposed.VarIndices.begin() + i);
        break;
      }
    }

    // Make sure that we have a scale that makes sense for this target's
    // pointer size.
    Scale = adjustToPointerSize(Scale, PointerSize);

    if (!!Scale) {
      VariableGEPIndex Entry = {Index, ZExtBits, SExtBits, Scale};
      Decomposed.VarIndices.push_back(Entry);
    }
  }

  // Take care of wrap-arounds
  if (GepHasConstantOffset)
    Decomposed.Offset = adjustToPointerSize(Decomposed.Offset, PointerSize);

  // Analyze the base pointer next.
  V = GEPOp->getOperand(0);
} while (--MaxLookup);

// If the chain of expressions is too deep, just return early.
Decomposed.Base = V;
SearchLimitReached++;
return Decomposed;
604}

606/// Returns whether the given pointer value points to memory that is local to
607/// the function, with global constants being considered local to all
608/// functions.
609bool BasicAAResult::pointsToConstantMemory(const MemoryLocation &Loc,
                                         AAQueryInfo &AAQI, bool OrLocal) {
assert(Visited.empty() && "Visited must be cleared after use!")((Visited.empty() && "Visited must be cleared after use!"
) ? static_cast<void> (0) : __assert_fail ("Visited.empty() && \"Visited must be cleared after use!\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 611, __PRETTY_FUNCTION__));

unsigned MaxLookup = 8;
SmallVector<const Value *, 16> Worklist;
Worklist.push_back(Loc.Ptr);
do {
  const Value *V = getUnderlyingObject(Worklist.pop_back_val());
  if (!Visited.insert(V).second) {
    Visited.clear();
    return AAResultBase::pointsToConstantMemory(Loc, AAQI, OrLocal);
  }

  // An alloca instruction defines local memory.
  if (OrLocal && isa<AllocaInst>(V))
    continue;

  // A global constant counts as local memory for our purposes.
  if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
    // Note: this doesn't require GV to be "ODR" because it isn't legal for a
    // global to be marked constant in some modules and non-constant in
    // others.  GV may even be a declaration, not a definition.
    if (!GV->isConstant()) {
      Visited.clear();
      return AAResultBase::pointsToConstantMemory(Loc, AAQI, OrLocal);
    }
    continue;
  }

  // If both select values point to local memory, then so does the select.
  if (const SelectInst *SI = dyn_cast<SelectInst>(V)) {
    Worklist.push_back(SI->getTrueValue());
    Worklist.push_back(SI->getFalseValue());
    continue;
  }

  // If all values incoming to a phi node point to local memory, then so does
  // the phi.
  if (const PHINode *PN = dyn_cast<PHINode>(V)) {
    // Don't bother inspecting phi nodes with many operands.
    if (PN->getNumIncomingValues() > MaxLookup) {
      Visited.clear();
      return AAResultBase::pointsToConstantMemory(Loc, AAQI, OrLocal);
    }
    for (Value *IncValue : PN->incoming_values())
      Worklist.push_back(IncValue);
    continue;
  }

  // Otherwise be conservative.
  Visited.clear();
  return AAResultBase::pointsToConstantMemory(Loc, AAQI, OrLocal);
} while (!Worklist.empty() && --MaxLookup);

Visited.clear();
return Worklist.empty();
666}

668/// Returns the behavior when calling the given call site.
669FunctionModRefBehavior BasicAAResult::getModRefBehavior(const CallBase *Call) {
if (Call->doesNotAccessMemory())
  // Can't do better than this.
  return FMRB_DoesNotAccessMemory;

FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;

// If the callsite knows it only reads memory, don't return worse
// than that.
if (Call->onlyReadsMemory())
  Min = FMRB_OnlyReadsMemory;
else if (Call->doesNotReadMemory())
  Min = FMRB_OnlyWritesMemory;

if (Call->onlyAccessesArgMemory())
  Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
else if (Call->onlyAccessesInaccessibleMemory())
  Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleMem);
else if (Call->onlyAccessesInaccessibleMemOrArgMem())
  Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleOrArgMem);

// If the call has operand bundles then aliasing attributes from the function
// it calls do not directly apply to the call.  This can be made more precise
// in the future.
if (!Call->hasOperandBundles())
  if (const Function *F = Call->getCalledFunction())
    Min =
        FunctionModRefBehavior(Min & getBestAAResults().getModRefBehavior(F));

return Min;
699}

701/// Returns the behavior when calling the given function. For use when the call
702/// site is not known.
703FunctionModRefBehavior BasicAAResult::getModRefBehavior(const Function *F) {
// If the function declares it doesn't access memory, we can't do better.
if (F->doesNotAccessMemory())
  return FMRB_DoesNotAccessMemory;

FunctionModRefBehavior Min = FMRB_UnknownModRefBehavior;

// If the function declares it only reads memory, go with that.
if (F->onlyReadsMemory())
  Min = FMRB_OnlyReadsMemory;
else if (F->doesNotReadMemory())
  Min = FMRB_OnlyWritesMemory;

if (F->onlyAccessesArgMemory())
  Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesArgumentPointees);
else if (F->onlyAccessesInaccessibleMemory())
  Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleMem);
else if (F->onlyAccessesInaccessibleMemOrArgMem())
  Min = FunctionModRefBehavior(Min & FMRB_OnlyAccessesInaccessibleOrArgMem);

return Min;
724}

726/// Returns true if this is a writeonly (i.e Mod only) parameter.
727static bool isWriteOnlyParam(const CallBase *Call, unsigned ArgIdx,
                           const TargetLibraryInfo &TLI) {
if (Call->paramHasAttr(ArgIdx, Attribute::WriteOnly))
  return true;

// We can bound the aliasing properties of memset_pattern16 just as we can
// for memcpy/memset.  This is particularly important because the
// LoopIdiomRecognizer likes to turn loops into calls to memset_pattern16
// whenever possible.
// FIXME Consider handling this in InferFunctionAttr.cpp together with other
// attributes.
LibFunc F;
if (Call->getCalledFunction() &&
    TLI.getLibFunc(*Call->getCalledFunction(), F) &&
    F == LibFunc_memset_pattern16 && TLI.has(F))
  if (ArgIdx == 0)
    return true;

// TODO: memset_pattern4, memset_pattern8
// TODO: _chk variants
// TODO: strcmp, strcpy

return false;
750}

752ModRefInfo BasicAAResult::getArgModRefInfo(const CallBase *Call,
                                         unsigned ArgIdx) {
// Checking for known builtin intrinsics and target library functions.
if (isWriteOnlyParam(Call, ArgIdx, TLI))
  return ModRefInfo::Mod;

if (Call->paramHasAttr(ArgIdx, Attribute::ReadOnly))
  return ModRefInfo::Ref;

if (Call->paramHasAttr(ArgIdx, Attribute::ReadNone))
  return ModRefInfo::NoModRef;

return AAResultBase::getArgModRefInfo(Call, ArgIdx);
765}

767static bool isIntrinsicCall(const CallBase *Call, Intrinsic::ID IID) {
const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Call);
return II && II->getIntrinsicID() == IID;
770}

772#ifndef NDEBUG
773static const Function *getParent(const Value *V) {
if (const Instruction *inst = dyn_cast<Instruction>(V)) {
  if (!inst->getParent())
    return nullptr;
  return inst->getParent()->getParent();
}

if (const Argument *arg = dyn_cast<Argument>(V))
  return arg->getParent();

return nullptr;
784}

786static bool notDifferentParent(const Value *O1, const Value *O2) {

const Function *F1 = getParent(O1);
const Function *F2 = getParent(O2);

return !F1 || !F2 || F1 == F2;
792}
793#endif

795AliasResult BasicAAResult::alias(const MemoryLocation &LocA,
                               const MemoryLocation &LocB,
                               AAQueryInfo &AAQI) {
assert(notDifferentParent(LocA.Ptr, LocB.Ptr) &&((notDifferentParent(LocA.Ptr, LocB.Ptr) && "BasicAliasAnalysis doesn't support interprocedural queries."
) ? static_cast<void> (0) : __assert_fail ("notDifferentParent(LocA.Ptr, LocB.Ptr) && \"BasicAliasAnalysis doesn't support interprocedural queries.\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 799, __PRETTY_FUNCTION__))
       "BasicAliasAnalysis doesn't support interprocedural queries.")((notDifferentParent(LocA.Ptr, LocB.Ptr) && "BasicAliasAnalysis doesn't support interprocedural queries."
) ? static_cast<void> (0) : __assert_fail ("notDifferentParent(LocA.Ptr, LocB.Ptr) && \"BasicAliasAnalysis doesn't support interprocedural queries.\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 799, __PRETTY_FUNCTION__));

// If we have a directly cached entry for these locations, we have recursed
// through this once, so just return the cached results. Notably, when this
// happens, we don't clear the cache.
AAQueryInfo::LocPair Locs(LocA, LocB);
if (Locs.first.Ptr > Locs.second.Ptr)
  std::swap(Locs.first, Locs.second);
auto CacheIt = AAQI.AliasCache.find(Locs);
if (CacheIt != AAQI.AliasCache.end())
  return CacheIt->second;

AliasResult Alias = aliasCheck(LocA.Ptr, LocA.Size, LocA.AATags, LocB.Ptr,
                               LocB.Size, LocB.AATags, AAQI);

assert(VisitedPhiBBs.empty())((VisitedPhiBBs.empty()) ? static_cast<void> (0) : __assert_fail
 ("VisitedPhiBBs.empty()", "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 814, __PRETTY_FUNCTION__));
return Alias;
816}

818/// Checks to see if the specified callsite can clobber the specified memory
819/// object.
820///
821/// Since we only look at local properties of this function, we really can't
822/// say much about this query.  We do, however, use simple "address taken"
823/// analysis on local objects.
824ModRefInfo BasicAAResult::getModRefInfo(const CallBase *Call,
                                      const MemoryLocation &Loc,
                                      AAQueryInfo &AAQI) {
assert(notDifferentParent(Call, Loc.Ptr) &&((notDifferentParent(Call, Loc.Ptr) && "AliasAnalysis query involving multiple functions!"
) ? static_cast<void> (0) : __assert_fail ("notDifferentParent(Call, Loc.Ptr) && \"AliasAnalysis query involving multiple functions!\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 828, __PRETTY_FUNCTION__))
       "AliasAnalysis query involving multiple functions!")((notDifferentParent(Call, Loc.Ptr) && "AliasAnalysis query involving multiple functions!"
) ? static_cast<void> (0) : __assert_fail ("notDifferentParent(Call, Loc.Ptr) && \"AliasAnalysis query involving multiple functions!\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 828, __PRETTY_FUNCTION__));

const Value *Object = getUnderlyingObject(Loc.Ptr);

// Calls marked 'tail' cannot read or write allocas from the current frame
// because the current frame might be destroyed by the time they run. However,
// a tail call may use an alloca with byval. Calling with byval copies the
// contents of the alloca into argument registers or stack slots, so there is
// no lifetime issue.
if (isa<AllocaInst>(Object))
  if (const CallInst *CI = dyn_cast<CallInst>(Call))
    if (CI->isTailCall() &&
        !CI->getAttributes().hasAttrSomewhere(Attribute::ByVal))
      return ModRefInfo::NoModRef;

// Stack restore is able to modify unescaped dynamic allocas. Assume it may
// modify them even though the alloca is not escaped.
if (auto *AI = dyn_cast<AllocaInst>(Object))
  if (!AI->isStaticAlloca() && isIntrinsicCall(Call, Intrinsic::stackrestore))
    return ModRefInfo::Mod;

// If the pointer is to a locally allocated object that does not escape,
// then the call can not mod/ref the pointer unless the call takes the pointer
// as an argument, and itself doesn't capture it.
if (!isa<Constant>(Object) && Call != Object &&
    isNonEscapingLocalObject(Object, &AAQI.IsCapturedCache)) {

  // Optimistically assume that call doesn't touch Object and check this
  // assumption in the following loop.
  ModRefInfo Result = ModRefInfo::NoModRef;
  bool IsMustAlias = true;

  unsigned OperandNo = 0;
  for (auto CI = Call->data_operands_begin(), CE = Call->data_operands_end();
       CI != CE; ++CI, ++OperandNo) {
    // Only look at the no-capture or byval pointer arguments.  If this
    // pointer were passed to arguments that were neither of these, then it
    // couldn't be no-capture.
    if (!(*CI)->getType()->isPointerTy() ||
        (!Call->doesNotCapture(OperandNo) &&
         OperandNo < Call->getNumArgOperands() &&
         !Call->isByValArgument(OperandNo)))
      continue;

    // Call doesn't access memory through this operand, so we don't care
    // if it aliases with Object.
    if (Call->doesNotAccessMemory(OperandNo))
      continue;

    // If this is a no-capture pointer argument, see if we can tell that it
    // is impossible to alias the pointer we're checking.
    AliasResult AR = getBestAAResults().alias(
        MemoryLocation::getBeforeOrAfter(*CI),
        MemoryLocation::getBeforeOrAfter(Object), AAQI);
    if (AR != MustAlias)
      IsMustAlias = false;
    // Operand doesn't alias 'Object', continue looking for other aliases
    if (AR == NoAlias)
      continue;
    // Operand aliases 'Object', but call doesn't modify it. Strengthen
    // initial assumption and keep looking in case if there are more aliases.
    if (Call->onlyReadsMemory(OperandNo)) {
      Result = setRef(Result);
      continue;
    }
    // Operand aliases 'Object' but call only writes into it.
    if (Call->doesNotReadMemory(OperandNo)) {
      Result = setMod(Result);
      continue;
    }
    // This operand aliases 'Object' and call reads and writes into it.
    // Setting ModRef will not yield an early return below, MustAlias is not
    // used further.
    Result = ModRefInfo::ModRef;
    break;
  }

  // No operand aliases, reset Must bit. Add below if at least one aliases
  // and all aliases found are MustAlias.
  if (isNoModRef(Result))
    IsMustAlias = false;

  // Early return if we improved mod ref information
  if (!isModAndRefSet(Result)) {
    if (isNoModRef(Result))
      return ModRefInfo::NoModRef;
    return IsMustAlias ? setMust(Result) : clearMust(Result);
  }
}

// If the call is malloc/calloc like, we can assume that it doesn't
// modify any IR visible value.  This is only valid because we assume these
// routines do not read values visible in the IR.  TODO: Consider special
// casing realloc and strdup routines which access only their arguments as
// well.  Or alternatively, replace all of this with inaccessiblememonly once
// that's implemented fully.
if (isMallocOrCallocLikeFn(Call, &TLI)) {
  // Be conservative if the accessed pointer may alias the allocation -
  // fallback to the generic handling below.
  if (getBestAAResults().alias(MemoryLocation::getBeforeOrAfter(Call),
                               Loc, AAQI) == NoAlias)
    return ModRefInfo::NoModRef;
}

// The semantics of memcpy intrinsics either exactly overlap or do not
// overlap, i.e., source and destination of any given memcpy are either
// no-alias or must-alias.
if (auto *Inst = dyn_cast<AnyMemCpyInst>(Call)) {
  AliasResult SrcAA =
      getBestAAResults().alias(MemoryLocation::getForSource(Inst), Loc, AAQI);
  AliasResult DestAA =
      getBestAAResults().alias(MemoryLocation::getForDest(Inst), Loc, AAQI);
  // It's also possible for Loc to alias both src and dest, or neither.
  ModRefInfo rv = ModRefInfo::NoModRef;
  if (SrcAA != NoAlias)
    rv = setRef(rv);
  if (DestAA != NoAlias)
    rv = setMod(rv);
  return rv;
}

// While the assume intrinsic is marked as arbitrarily writing so that
// proper control dependencies will be maintained, it never aliases any
// particular memory location.
if (isIntrinsicCall(Call, Intrinsic::assume))
  return ModRefInfo::NoModRef;

// Like assumes, guard intrinsics are also marked as arbitrarily writing so
// that proper control dependencies are maintained but they never mods any
// particular memory location.
//
// *Unlike* assumes, guard intrinsics are modeled as reading memory since the
// heap state at the point the guard is issued needs to be consistent in case
// the guard invokes the "deopt" continuation.
if (isIntrinsicCall(Call, Intrinsic::experimental_guard))
  return ModRefInfo::Ref;
// The same applies to deoptimize which is essentially a guard(false).
if (isIntrinsicCall(Call, Intrinsic::experimental_deoptimize))
  return ModRefInfo::Ref;

// Like assumes, invariant.start intrinsics were also marked as arbitrarily
// writing so that proper control dependencies are maintained but they never
// mod any particular memory location visible to the IR.
// *Unlike* assumes (which are now modeled as NoModRef), invariant.start
// intrinsic is now modeled as reading memory. This prevents hoisting the
// invariant.start intrinsic over stores. Consider:
// *ptr = 40;
// *ptr = 50;
// invariant_start(ptr)
// int val = *ptr;
// print(val);
//
// This cannot be transformed to:
//
// *ptr = 40;
// invariant_start(ptr)
// *ptr = 50;
// int val = *ptr;
// print(val);
//
// The transformation will cause the second store to be ignored (based on
// rules of invariant.start)  and print 40, while the first program always
// prints 50.
if (isIntrinsicCall(Call, Intrinsic::invariant_start))
  return ModRefInfo::Ref;

// The AAResultBase base class has some smarts, lets use them.
return AAResultBase::getModRefInfo(Call, Loc, AAQI);
996}

998ModRefInfo BasicAAResult::getModRefInfo(const CallBase *Call1,
                                      const CallBase *Call2,
                                      AAQueryInfo &AAQI) {
// While the assume intrinsic is marked as arbitrarily writing so that
// proper control dependencies will be maintained, it never aliases any
// particular memory location.
if (isIntrinsicCall(Call1, Intrinsic::assume) ||
    isIntrinsicCall(Call2, Intrinsic::assume))
  return ModRefInfo::NoModRef;

// Like assumes, guard intrinsics are also marked as arbitrarily writing so
// that proper control dependencies are maintained but they never mod any
// particular memory location.
//
// *Unlike* assumes, guard intrinsics are modeled as reading memory since the
// heap state at the point the guard is issued needs to be consistent in case
// the guard invokes the "deopt" continuation.

// NB! This function is *not* commutative, so we special case two
// possibilities for guard intrinsics.

if (isIntrinsicCall(Call1, Intrinsic::experimental_guard))
  return isModSet(createModRefInfo(getModRefBehavior(Call2)))
             ? ModRefInfo::Ref
             : ModRefInfo::NoModRef;

if (isIntrinsicCall(Call2, Intrinsic::experimental_guard))
  return isModSet(createModRefInfo(getModRefBehavior(Call1)))
             ? ModRefInfo::Mod
             : ModRefInfo::NoModRef;

// The AAResultBase base class has some smarts, lets use them.
return AAResultBase::getModRefInfo(Call1, Call2, AAQI);
1031}

1033/// Provide ad-hoc rules to disambiguate accesses through two GEP operators,
1034/// both having the exact same pointer operand.
1035static AliasResult aliasSameBasePointerGEPs(const GEPOperator *GEP1,
                                          LocationSize MaybeV1Size,
                                          const GEPOperator *GEP2,
                                          LocationSize MaybeV2Size,
                                          const DataLayout &DL) {
assert(GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups() ==((GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups
() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups
() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType
() && "Expected GEPs with the same pointer operand") ?
 static_cast<void> (0) : __assert_fail ("GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType() && \"Expected GEPs with the same pointer operand\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1043, __PRETTY_FUNCTION__))
           GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups() &&((GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups
() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups
() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType
() && "Expected GEPs with the same pointer operand") ?
 static_cast<void> (0) : __assert_fail ("GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType() && \"Expected GEPs with the same pointer operand\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1043, __PRETTY_FUNCTION__))
       GEP1->getPointerOperandType() == GEP2->getPointerOperandType() &&((GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups
() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups
() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType
() && "Expected GEPs with the same pointer operand") ?
 static_cast<void> (0) : __assert_fail ("GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType() && \"Expected GEPs with the same pointer operand\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1043, __PRETTY_FUNCTION__))
       "Expected GEPs with the same pointer operand")((GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups
() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups
() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType
() && "Expected GEPs with the same pointer operand") ?
 static_cast<void> (0) : __assert_fail ("GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups() == GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups() && GEP1->getPointerOperandType() == GEP2->getPointerOperandType() && \"Expected GEPs with the same pointer operand\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1043, __PRETTY_FUNCTION__));

// Try to determine whether GEP1 and GEP2 index through arrays, into structs,
// such that the struct field accesses provably cannot alias.
// We also need at least two indices (the pointer, and the struct field).
if (GEP1->getNumIndices() != GEP2->getNumIndices() ||
    GEP1->getNumIndices() < 2)
  return MayAlias;

// If we don't know the size of the accesses through both GEPs, we can't
// determine whether the struct fields accessed can't alias.
if (!MaybeV1Size.hasValue() || !MaybeV2Size.hasValue())
  return MayAlias;

const uint64_t V1Size = MaybeV1Size.getValue();
const uint64_t V2Size = MaybeV2Size.getValue();

ConstantInt *C1 =
    dyn_cast<ConstantInt>(GEP1->getOperand(GEP1->getNumOperands() - 1));
ConstantInt *C2 =
    dyn_cast<ConstantInt>(GEP2->getOperand(GEP2->getNumOperands() - 1));

// If the last (struct) indices are constants and are equal, the other indices
// might be also be dynamically equal, so the GEPs can alias.
if (C1 && C2) {
  unsigned BitWidth = std::max(C1->getBitWidth(), C2->getBitWidth());
  if (C1->getValue().sextOrSelf(BitWidth) ==
      C2->getValue().sextOrSelf(BitWidth))
    return MayAlias;
}

// Find the last-indexed type of the GEP, i.e., the type you'd get if
// you stripped the last index.
// On the way, look at each indexed type.  If there's something other
// than an array, different indices can lead to different final types.
SmallVector<Value *, 8> IntermediateIndices;

// Insert the first index; we don't need to check the type indexed
// through it as it only drops the pointer indirection.
assert(GEP1->getNumIndices() > 1 && "Not enough GEP indices to examine")((GEP1->getNumIndices() > 1 && "Not enough GEP indices to examine"
) ? static_cast<void> (0) : __assert_fail ("GEP1->getNumIndices() > 1 && \"Not enough GEP indices to examine\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1082, __PRETTY_FUNCTION__));
IntermediateIndices.push_back(GEP1->getOperand(1));

// Insert all the remaining indices but the last one.
// Also, check that they all index through arrays.
for (unsigned i = 1, e = GEP1->getNumIndices() - 1; i != e; ++i) {
  if (!isa<ArrayType>(GetElementPtrInst::getIndexedType(
          GEP1->getSourceElementType(), IntermediateIndices)))
    return MayAlias;
  IntermediateIndices.push_back(GEP1->getOperand(i + 1));
}

auto *Ty = GetElementPtrInst::getIndexedType(
  GEP1->getSourceElementType(), IntermediateIndices);
if (isa<ArrayType>(Ty) || isa<VectorType>(Ty)) {
  // We know that:
  // - both GEPs begin indexing from the exact same pointer;
  // - the last indices in both GEPs are constants, indexing into a sequential
  //   type (array or vector);
  // - both GEPs only index through arrays prior to that.
  //
  // Because array indices greater than the number of elements are valid in
  // GEPs, unless we know the intermediate indices are identical between
  // GEP1 and GEP2 we cannot guarantee that the last indexed arrays don't
  // partially overlap. We also need to check that the loaded size matches
  // the element size, otherwise we could still have overlap.
  Type *LastElementTy = GetElementPtrInst::getTypeAtIndex(Ty, (uint64_t)0);
  const uint64_t ElementSize =
      DL.getTypeStoreSize(LastElementTy).getFixedSize();
  if (V1Size != ElementSize || V2Size != ElementSize)
    return MayAlias;

  for (unsigned i = 0, e = GEP1->getNumIndices() - 1; i != e; ++i)
    if (GEP1->getOperand(i + 1) != GEP2->getOperand(i + 1))
      return MayAlias;

  // Now we know that the array/pointer that GEP1 indexes into and that
  // that GEP2 indexes into must either precisely overlap or be disjoint.
  // Because they cannot partially overlap and because fields in an array
  // cannot overlap, if we can prove the final indices are different between
  // GEP1 and GEP2, we can conclude GEP1 and GEP2 don't alias.

  // If the last indices are constants, we've already checked they don't
  // equal each other so we can exit early.
  if (C1 && C2)
    return NoAlias;
  {
    Value *GEP1LastIdx = GEP1->getOperand(GEP1->getNumOperands() - 1);
    Value *GEP2LastIdx = GEP2->getOperand(GEP2->getNumOperands() - 1);
    if (isa<PHINode>(GEP1LastIdx) || isa<PHINode>(GEP2LastIdx)) {
      // If one of the indices is a PHI node, be safe and only use
      // computeKnownBits so we don't make any assumptions about the
      // relationships between the two indices. This is important if we're
      // asking about values from different loop iterations. See PR32314.
      // TODO: We may be able to change the check so we only do this when
      // we definitely looked through a PHINode.
      if (GEP1LastIdx != GEP2LastIdx &&
          GEP1LastIdx->getType() == GEP2LastIdx->getType()) {
        KnownBits Known1 = computeKnownBits(GEP1LastIdx, DL);
        KnownBits Known2 = computeKnownBits(GEP2LastIdx, DL);
        if (Known1.Zero.intersects(Known2.One) ||
            Known1.One.intersects(Known2.Zero))
          return NoAlias;
      }
    } else if (isKnownNonEqual(GEP1LastIdx, GEP2LastIdx, DL))
      return NoAlias;
  }
}
return MayAlias;
1151}

1153// If a we have (a) a GEP and (b) a pointer based on an alloca, and the
1154// beginning of the object the GEP points would have a negative offset with
1155// repsect to the alloca, that means the GEP can not alias pointer (b).
1156// Note that the pointer based on the alloca may not be a GEP. For
1157// example, it may be the alloca itself.
1158// The same applies if (b) is based on a GlobalVariable. Note that just being
1159// based on isIdentifiedObject() is not enough - we need an identified object
1160// that does not permit access to negative offsets. For example, a negative
1161// offset from a noalias argument or call can be inbounds w.r.t the actual
1162// underlying object.
1163//
1164// For example, consider:
1165//
1166//   struct { int f0, int f1, ...} foo;
1167//   foo alloca;
1168//   foo* random = bar(alloca);
1169//   int *f0 = &alloca.f0
1170//   int *f1 = &random->f1;
1171//
1172// Which is lowered, approximately, to:
1173//
1174//  %alloca = alloca %struct.foo
1175//  %random = call %struct.foo* @random(%struct.foo* %alloca)
1176//  %f0 = getelementptr inbounds %struct, %struct.foo* %alloca, i32 0, i32 0
1177//  %f1 = getelementptr inbounds %struct, %struct.foo* %random, i32 0, i32 1
1178//
1179// Assume %f1 and %f0 alias. Then %f1 would point into the object allocated
1180// by %alloca. Since the %f1 GEP is inbounds, that means %random must also
1181// point into the same object. But since %f0 points to the beginning of %alloca,
1182// the highest %f1 can be is (%alloca + 3). This means %random can not be higher
1183// than (%alloca - 1), and so is not inbounds, a contradiction.
1184bool BasicAAResult::isGEPBaseAtNegativeOffset(const GEPOperator *GEPOp,
    const DecomposedGEP &DecompGEP, const DecomposedGEP &DecompObject,
    LocationSize MaybeObjectAccessSize) {
// If the object access size is unknown, or the GEP isn't inbounds, bail.
if (!MaybeObjectAccessSize.hasValue() || !GEPOp->isInBounds())
  return false;

const uint64_t ObjectAccessSize = MaybeObjectAccessSize.getValue();

// We need the object to be an alloca or a globalvariable, and want to know
// the offset of the pointer from the object precisely, so no variable
// indices are allowed.
if (!(isa<AllocaInst>(DecompObject.Base) ||
      isa<GlobalVariable>(DecompObject.Base)) ||
    !DecompObject.VarIndices.empty())
  return false;

// If the GEP has no variable indices, we know the precise offset
// from the base, then use it. If the GEP has variable indices,
// we can't get exact GEP offset to identify pointer alias. So return
// false in that case.
if (!DecompGEP.VarIndices.empty())
  return false;

return DecompGEP.Offset.sge(DecompObject.Offset + (int64_t)ObjectAccessSize);
1209}

1211/// Provides a bunch of ad-hoc rules to disambiguate a GEP instruction against
1212/// another pointer.
1213///
1214/// We know that V1 is a GEP, but we don't know anything about V2.
1215/// UnderlyingV1 is getUnderlyingObject(GEP1), UnderlyingV2 is the same for
1216/// V2.
1217AliasResult BasicAAResult::aliasGEP(
  const GEPOperator *GEP1, LocationSize V1Size, const AAMDNodes &V1AAInfo,
  const Value *V2, LocationSize V2Size, const AAMDNodes &V2AAInfo,
  const Value *UnderlyingV1, const Value *UnderlyingV2, AAQueryInfo &AAQI) {
DecomposedGEP DecompGEP1 = DecomposeGEPExpression(GEP1, DL, &AC, DT);
DecomposedGEP DecompGEP2 = DecomposeGEPExpression(V2, DL, &AC, DT);

// Don't attempt to analyze the decomposed GEP if index scale is not a
// compile-time constant.
if (!DecompGEP1.HasCompileTimeConstantScale ||
    !DecompGEP2.HasCompileTimeConstantScale)
  return MayAlias;

assert(DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base == UnderlyingV2 &&((DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base ==
 UnderlyingV2 && "DecomposeGEPExpression returned a result different from "
 "getUnderlyingObject") ? static_cast<void> (0) : __assert_fail
 ("DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base == UnderlyingV2 && \"DecomposeGEPExpression returned a result different from \" \"getUnderlyingObject\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1232, __PRETTY_FUNCTION__))
       "DecomposeGEPExpression returned a result different from "((DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base ==
 UnderlyingV2 && "DecomposeGEPExpression returned a result different from "
 "getUnderlyingObject") ? static_cast<void> (0) : __assert_fail
 ("DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base == UnderlyingV2 && \"DecomposeGEPExpression returned a result different from \" \"getUnderlyingObject\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1232, __PRETTY_FUNCTION__))
       "getUnderlyingObject")((DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base ==
 UnderlyingV2 && "DecomposeGEPExpression returned a result different from "
 "getUnderlyingObject") ? static_cast<void> (0) : __assert_fail
 ("DecompGEP1.Base == UnderlyingV1 && DecompGEP2.Base == UnderlyingV2 && \"DecomposeGEPExpression returned a result different from \" \"getUnderlyingObject\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1232, __PRETTY_FUNCTION__));

// If the GEP's offset relative to its base is such that the base would
// fall below the start of the object underlying V2, then the GEP and V2
// cannot alias.
if (isGEPBaseAtNegativeOffset(GEP1, DecompGEP1, DecompGEP2, V2Size))
  return NoAlias;
// If we have two gep instructions with must-alias or not-alias'ing base
// pointers, figure out if the indexes to the GEP tell us anything about the
// derived pointer.
if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
  // Check for the GEP base being at a negative offset, this time in the other
  // direction.
  if (isGEPBaseAtNegativeOffset(GEP2, DecompGEP2, DecompGEP1, V1Size))
    return NoAlias;
  // Do the base pointers alias?
  AliasResult BaseAlias = aliasCheck(
      UnderlyingV1, LocationSize::beforeOrAfterPointer(), AAMDNodes(),
      UnderlyingV2, LocationSize::beforeOrAfterPointer(), AAMDNodes(), AAQI);

  // For GEPs with identical offsets, we can preserve the size and AAInfo
  // when performing the alias check on the underlying objects.
  if (BaseAlias == MayAlias && DecompGEP1.Offset == DecompGEP2.Offset &&
      DecompGEP1.VarIndices == DecompGEP2.VarIndices) {
    AliasResult PreciseBaseAlias = aliasCheck(
        UnderlyingV1, V1Size, V1AAInfo, UnderlyingV2, V2Size, V2AAInfo, AAQI);
    if (PreciseBaseAlias == NoAlias)
      return NoAlias;
  }

  // If we get a No or May, then return it immediately, no amount of analysis
  // will improve this situation.
  if (BaseAlias != MustAlias) {
    assert(BaseAlias == NoAlias || BaseAlias == MayAlias)((BaseAlias == NoAlias || BaseAlias == MayAlias) ? static_cast
<void> (0) : __assert_fail ("BaseAlias == NoAlias || BaseAlias == MayAlias"
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1265, __PRETTY_FUNCTION__));
    return BaseAlias;
  }

  // Otherwise, we have a MustAlias.  Since the base pointers alias each other
  // exactly, see if the computed offset from the common pointer tells us
  // about the relation of the resulting pointer.
  // If we know the two GEPs are based off of the exact same pointer (and not
  // just the same underlying object), see if that tells us anything about
  // the resulting pointers.
  if (GEP1->getPointerOperand()->stripPointerCastsAndInvariantGroups() ==
          GEP2->getPointerOperand()->stripPointerCastsAndInvariantGroups() &&
      GEP1->getPointerOperandType() == GEP2->getPointerOperandType()) {
    AliasResult R = aliasSameBasePointerGEPs(GEP1, V1Size, GEP2, V2Size, DL);
    // If we couldn't find anything interesting, don't abandon just yet.
    if (R != MayAlias)
      return R;
  }

  // Subtract the GEP2 pointer from the GEP1 pointer to find out their
  // symbolic difference.
  DecompGEP1.Offset -= DecompGEP2.Offset;
  GetIndexDifference(DecompGEP1.VarIndices, DecompGEP2.VarIndices);

} else {
  // Check to see if these two pointers are related by the getelementptr
  // instruction.  If one pointer is a GEP with a non-zero index of the other
  // pointer, we know they cannot alias.

  // If both accesses are unknown size, we can't do anything useful here.
  if (!V1Size.hasValue() && !V2Size.hasValue())
    return MayAlias;

  AliasResult R = aliasCheck(
      UnderlyingV1, LocationSize::beforeOrAfterPointer(), AAMDNodes(),
      V2, V2Size, V2AAInfo, AAQI, nullptr, UnderlyingV2);
  if (R != MustAlias) {
    // If V2 may alias GEP base pointer, conservatively returns MayAlias.
    // If V2 is known not to alias GEP base pointer, then the two values
    // cannot alias per GEP semantics: "Any memory access must be done through
    // a pointer value associated with an address range of the memory access,
    // otherwise the behavior is undefined.".
    assert(R == NoAlias || R == MayAlias)((R == NoAlias || R == MayAlias) ? static_cast<void> (0
) : __assert_fail ("R == NoAlias || R == MayAlias", "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1307, __PRETTY_FUNCTION__));
    return R;
  }
}

// In the two GEP Case, if there is no difference in the offsets of the
// computed pointers, the resultant pointers are a must alias.  This
// happens when we have two lexically identical GEP's (for example).
//
// In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
// must aliases the GEP, the end result is a must alias also.
if (DecompGEP1.Offset == 0 && DecompGEP1.VarIndices.empty())
  return MustAlias;

// If there is a constant difference between the pointers, but the difference
// is less than the size of the associated memory object, then we know
// that the objects are partially overlapping.  If the difference is
// greater, we know they do not overlap.
if (DecompGEP1.Offset != 0 && DecompGEP1.VarIndices.empty()) {
  if (DecompGEP1.Offset.sge(0)) {
    if (V2Size.hasValue()) {
      if (DecompGEP1.Offset.ult(V2Size.getValue()))
        return PartialAlias;
      return NoAlias;
    }
  } else {
    // We have the situation where:
    // +                +
    // | BaseOffset     |
    // ---------------->|
    // |-->V1Size       |-------> V2Size
    // GEP1             V2
    if (V1Size.hasValue()) {
      if ((-DecompGEP1.Offset).ult(V1Size.getValue()))
        return PartialAlias;
      return NoAlias;
    }
  }
}

if (!DecompGEP1.VarIndices.empty()) {
  APInt GCD;
  bool AllNonNegative = DecompGEP1.Offset.isNonNegative();
  bool AllNonPositive = DecompGEP1.Offset.isNonPositive();
  for (unsigned i = 0, e = DecompGEP1.VarIndices.size(); i != e; ++i) {
    const APInt &Scale = DecompGEP1.VarIndices[i].Scale;
    if (i == 0)
      GCD = Scale.abs();
    else
      GCD = APIntOps::GreatestCommonDivisor(GCD, Scale.abs());

    if (AllNonNegative || AllNonPositive) {
      // If the Value could change between cycles, then any reasoning about
      // the Value this cycle may not hold in the next cycle. We'll just
      // give up if we can't determine conditions that hold for every cycle:
      const Value *V = DecompGEP1.VarIndices[i].V;

      KnownBits Known =
          computeKnownBits(V, DL, 0, &AC, dyn_cast<Instruction>(GEP1), DT);
      bool SignKnownZero = Known.isNonNegative();
      bool SignKnownOne = Known.isNegative();

      // Zero-extension widens the variable, and so forces the sign
      // bit to zero.
      bool IsZExt = DecompGEP1.VarIndices[i].ZExtBits > 0 || isa<ZExtInst>(V);
      SignKnownZero |= IsZExt;
      SignKnownOne &= !IsZExt;

      AllNonNegative &= (SignKnownZero && Scale.isNonNegative()) ||
                        (SignKnownOne && Scale.isNonPositive());
      AllNonPositive &= (SignKnownZero && Scale.isNonPositive()) ||
                        (SignKnownOne && Scale.isNonNegative());
    }
  }

  // We now have accesses at two offsets from the same base:
  //  1. (...)*GCD + DecompGEP1.Offset with size V1Size
  //  2. 0 with size V2Size
  // Using arithmetic modulo GCD, the accesses are at
  // [ModOffset..ModOffset+V1Size) and [0..V2Size). If the first access fits
  // into the range [V2Size..GCD), then we know they cannot overlap.
  APInt ModOffset = DecompGEP1.Offset.srem(GCD);
  if (ModOffset.isNegative())
    ModOffset += GCD; // We want mod, not rem.
  if (V1Size.hasValue() && V2Size.hasValue() &&
      ModOffset.uge(V2Size.getValue()) &&
      (GCD - ModOffset).uge(V1Size.getValue()))
    return NoAlias;

  // If we know all the variables are non-negative, then the total offset is
  // also non-negative and >= DecompGEP1.Offset. We have the following layout:
  // [0, V2Size) ... [TotalOffset, TotalOffer+V1Size]
  // If DecompGEP1.Offset >= V2Size, the accesses don't alias.
  if (AllNonNegative && V2Size.hasValue() &&
      DecompGEP1.Offset.uge(V2Size.getValue()))
    return NoAlias;
  // Similarly, if the variables are non-positive, then the total offset is
  // also non-positive and <= DecompGEP1.Offset. We have the following layout:
  // [TotalOffset, TotalOffset+V1Size) ... [0, V2Size)
  // If -DecompGEP1.Offset >= V1Size, the accesses don't alias.
  if (AllNonPositive && V1Size.hasValue() &&
      (-DecompGEP1.Offset).uge(V1Size.getValue()))
    return NoAlias;

  if (constantOffsetHeuristic(DecompGEP1.VarIndices, V1Size, V2Size,
                              DecompGEP1.Offset, &AC, DT))
    return NoAlias;
}

// Statically, we can see that the base objects are the same, but the
// pointers have dynamic offsets which we can't resolve. And none of our
// little tricks above worked.
return MayAlias;
1420}

1422static AliasResult MergeAliasResults(AliasResult A, AliasResult B) {
// If the results agree, take it.
if (A == B)
  return A;
// A mix of PartialAlias and MustAlias is PartialAlias.
if ((A == PartialAlias && B == MustAlias) ||
    (B == PartialAlias && A == MustAlias))
  return PartialAlias;
// Otherwise, we don't know anything.
return MayAlias;
1432}

1434/// Provides a bunch of ad-hoc rules to disambiguate a Select instruction
1435/// against another.
1436AliasResult
1437BasicAAResult::aliasSelect(const SelectInst *SI, LocationSize SISize,
                         const AAMDNodes &SIAAInfo, const Value *V2,
                         LocationSize V2Size, const AAMDNodes &V2AAInfo,
                         const Value *UnderV2, AAQueryInfo &AAQI) {
// If the values are Selects with the same condition, we can do a more precise
// check: just check for aliases between the values on corresponding arms.
if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
  if (SI->getCondition() == SI2->getCondition()) {
    AliasResult Alias =
        aliasCheck(SI->getTrueValue(), SISize, SIAAInfo, SI2->getTrueValue(),
                   V2Size, V2AAInfo, AAQI);
    if (Alias == MayAlias)
      return MayAlias;
    AliasResult ThisAlias =
        aliasCheck(SI->getFalseValue(), SISize, SIAAInfo,
                   SI2->getFalseValue(), V2Size, V2AAInfo, AAQI);
    return MergeAliasResults(ThisAlias, Alias);
  }

// If both arms of the Select node NoAlias or MustAlias V2, then returns
// NoAlias / MustAlias. Otherwise, returns MayAlias.
AliasResult Alias = aliasCheck(V2, V2Size, V2AAInfo, SI->getTrueValue(),
                               SISize, SIAAInfo, AAQI, UnderV2);
if (Alias == MayAlias)
  return MayAlias;

AliasResult ThisAlias = aliasCheck(V2, V2Size, V2AAInfo, SI->getFalseValue(),
                                   SISize, SIAAInfo, AAQI, UnderV2);
return MergeAliasResults(ThisAlias, Alias);
1466}

1468/// Provide a bunch of ad-hoc rules to disambiguate a PHI instruction against
1469/// another.
1470AliasResult BasicAAResult::aliasPHI(const PHINode *PN, LocationSize PNSize,
                                  const AAMDNodes &PNAAInfo, const Value *V2,
                                  LocationSize V2Size,
                                  const AAMDNodes &V2AAInfo,
                                  const Value *UnderV2, AAQueryInfo &AAQI) {
// If the values are PHIs in the same block, we can do a more precise
// as well as efficient check: just check for aliases between the values
// on corresponding edges.
if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
  if (PN2->getParent() == PN->getParent()) {
    AAQueryInfo::LocPair Locs(MemoryLocation(PN, PNSize, PNAAInfo),
                              MemoryLocation(V2, V2Size, V2AAInfo));
    if (PN > V2)
      std::swap(Locs.first, Locs.second);
    // Analyse the PHIs' inputs under the assumption that the PHIs are
    // NoAlias.
    // If the PHIs are May/MustAlias there must be (recursively) an input
    // operand from outside the PHIs' cycle that is MayAlias/MustAlias or
    // there must be an operation on the PHIs within the PHIs' value cycle
    // that causes a MayAlias.
    // Pretend the phis do not alias.
    AliasResult Alias = NoAlias;
    AliasResult OrigAliasResult;
    {
      // Limited lifetime iterator invalidated by the aliasCheck call below.
      auto CacheIt = AAQI.AliasCache.find(Locs);
      assert((CacheIt != AAQI.AliasCache.end()) &&(((CacheIt != AAQI.AliasCache.end()) && "There must exist an entry for the phi node"
) ? static_cast<void> (0) : __assert_fail ("(CacheIt != AAQI.AliasCache.end()) && \"There must exist an entry for the phi node\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1497, __PRETTY_FUNCTION__))
             "There must exist an entry for the phi node")(((CacheIt != AAQI.AliasCache.end()) && "There must exist an entry for the phi node"
) ? static_cast<void> (0) : __assert_fail ("(CacheIt != AAQI.AliasCache.end()) && \"There must exist an entry for the phi node\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/lib/Analysis/BasicAliasAnalysis.cpp"
, 1497, __PRETTY_FUNCTION__));
      OrigAliasResult = CacheIt->second;
      CacheIt->second = NoAlias;
    }

    for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
      AliasResult ThisAlias =
          aliasCheck(PN->getIncomingValue(i), PNSize, PNAAInfo,
                     PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
                     V2Size, V2AAInfo, AAQI);
      Alias = MergeAliasResults(ThisAlias, Alias);
      if (Alias == MayAlias)
        break;
    }

    // Reset if speculation failed.
    if (Alias != NoAlias)
      AAQI.updateResult(Locs, OrigAliasResult);
    return Alias;
  }

SmallVector<Value *, 4> V1Srcs;
// If a phi operand recurses back to the phi, we can still determine NoAlias
// if we don't alias the underlying objects of the other phi operands, as we
// know that the recursive phi needs to be based on them in some way.
bool isRecursive = false;
auto CheckForRecPhi = [&](Value *PV) {
  if (!EnableRecPhiAnalysis)
    return false;
  if (getUnderlyingObject(PV) == PN) {
    isRecursive = true;
    return true;
  }
  return false;
};

if (PV) {
  // If we have PhiValues then use it to get the underlying phi values.
  const PhiValues::ValueSet &PhiValueSet = PV->getValuesForPhi(PN);
  // If we have more phi values than the search depth then return MayAlias
  // conservatively to avoid compile time explosion. The worst possible case
  // is if both sides are PHI nodes. In which case, this is O(m x n) time
  // where 'm' and 'n' are the number of PHI sources.
  if (PhiValueSet.size() > MaxLookupSearchDepth)
    return MayAlias;
  // Add the values to V1Srcs
  for (Value *PV1 : PhiValueSet) {
    if (CheckForRecPhi(PV1))
      continue;
    V1Srcs.push_back(PV1);
  }
} else {
  // If we don't have PhiInfo then just look at the operands of the phi itself
  // FIXME: Remove this once we can guarantee that we have PhiInfo always
  SmallPtrSet<Value *, 4> UniqueSrc;
  for (Value *PV1 : PN->incoming_values()) {
    if (isa<PHINode>(PV1))
      // If any of the source itself is a PHI, return MayAlias conservatively
      // to avoid compile time explosion. The worst possible case is if both
      // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
      // and 'n' are the number of PHI sources.
      return MayAlias;

    if (CheckForRecPhi(PV1))
      continue;

    if (UniqueSrc.insert(PV1).second)
      V1Srcs.push_back(PV1);
  }
}

// If V1Srcs is empty then that means that the phi has no underlying non-phi
// value. This should only be possible in blocks unreachable from the entry
// block, but return MayAlias just in case.
if (V1Srcs.empty())
  return MayAlias;

// If this PHI node is recursive, indicate that the pointer may be moved
// across iterations. We can only prove NoAlias if different underlying
// objects are involved.
if (isRecursive)
  PNSize = LocationSize::beforeOrAfterPointer();

// In the recursive alias queries below, we may compare values from two
// different loop iterations. Keep track of visited phi blocks, which will
// be used when determining value equivalence.
bool BlockInserted = VisitedPhiBBs.insert(PN->getParent()).second;
auto _ = make_scope_exit([&]() {
  if (BlockInserted)
    VisitedPhiBBs.erase(PN->getParent());
});

// If we inserted a block into VisitedPhiBBs, alias analysis results that
// have been cached earlier may no longer be valid. Perform recursive queries
// with a new AAQueryInfo.
AAQueryInfo NewAAQI;
AAQueryInfo *UseAAQI = BlockInserted ? &NewAAQI : &AAQI;

AliasResult Alias = aliasCheck(V2, V2Size, V2AAInfo, V1Srcs[0], PNSize,
                               PNAAInfo, *UseAAQI, UnderV2);

// Early exit if the check of the first PHI source against V2 is MayAlias.
// Other results are not possible.
if (Alias == MayAlias)
  return MayAlias;
// With recursive phis we cannot guarantee that MustAlias/PartialAlias will
// remain valid to all elements and needs to conservatively return MayAlias.
if (isRecursive && Alias != NoAlias)
  return MayAlias;

// If all sources of the PHI node NoAlias or MustAlias V2, then returns
// NoAlias / MustAlias. Otherwise, returns MayAlias.
for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
  Value *V = V1Srcs[i];

  AliasResult ThisAlias = aliasCheck(V2, V2Size, V2AAInfo, V, PNSize,
                                     PNAAInfo, *UseAAQI, UnderV2);
  Alias = MergeAliasResults(ThisAlias, Alias);
  if (Alias == MayAlias)
    break;
}

return Alias;
1620}

1622/// Provides a bunch of ad-hoc rules to disambiguate in common cases, such as
1623/// array references.
1624AliasResult BasicAAResult::aliasCheck(const Value *V1, LocationSize V1Size,
                                    const AAMDNodes &V1AAInfo,
                                    const Value *V2, LocationSize V2Size,
                                    const AAMDNodes &V2AAInfo,
                                    AAQueryInfo &AAQI, const Value *O1,
                                    const Value *O2) {
// If either of the memory references is empty, it doesn't matter what the
// pointer values are.
if (V1Size.isZero() || V2Size.isZero())
  return NoAlias;

// Strip off any casts if they exist.
V1 = V1->stripPointerCastsAndInvariantGroups();
V2 = V2->stripPointerCastsAndInvariantGroups();

// If V1 or V2 is undef, the result is NoAlias because we can always pick a
// value for undef that aliases nothing in the program.
if (isa<UndefValue>(V1) || isa<UndefValue>(V2))
  return NoAlias;

// Are we checking for alias of the same value?
// Because we look 'through' phi nodes, we could look at "Value" pointers from
// different iterations. We must therefore make sure that this is not the
// case. The function isValueEqualInPotentialCycles ensures that this cannot
// happen by looking at the visited phi nodes and making sure they cannot
// reach the value.
if (isValueEqualInPotentialCycles(V1, V2))
  return MustAlias;

if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
  return NoAlias; // Scalars cannot alias each other

// Figure out what objects these things are pointing to if we can.
if (O1 == nullptr)
  O1 = getUnderlyingObject(V1, MaxLookupSearchDepth);

if (O2 == nullptr)
  O2 = getUnderlyingObject(V2, MaxLookupSearchDepth);

// Null values in the default address space don't point to any object, so they
// don't alias any other pointer.
if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
  if (!NullPointerIsDefined(&F, CPN->getType()->getAddressSpace()))
    return NoAlias;
if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
  if (!NullPointerIsDefined(&F, CPN->getType()->getAddressSpace()))
    return NoAlias;

if (O1 != O2) {
  // If V1/V2 point to two different objects, we know that we have no alias.
  if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
    return NoAlias;

  // Constant pointers can't alias with non-const isIdentifiedObject objects.
  if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
      (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
    return NoAlias;

  // Function arguments can't alias with things that are known to be
  // unambigously identified at the function level.
  if ((isa<Argument>(O1) && isIdentifiedFunctionLocal(O2)) ||
      (isa<Argument>(O2) && isIdentifiedFunctionLocal(O1)))
    return NoAlias;

  // If one pointer is the result of a call/invoke or load and the other is a
  // non-escaping local object within the same function, then we know the
  // object couldn't escape to a point where the call could return it.
  //
  // Note that if the pointers are in different functions, there are a
  // variety of complications. A call with a nocapture argument may still
  // temporary store the nocapture argument's value in a temporary memory
  // location if that memory location doesn't escape. Or it may pass a
  // nocapture value to other functions as long as they don't capture it.
  if (isEscapeSource(O1) &&
      isNonEscapingLocalObject(O2, &AAQI.IsCapturedCache))
    return NoAlias;
  if (isEscapeSource(O2) &&
      isNonEscapingLocalObject(O1, &AAQI.IsCapturedCache))
    return NoAlias;
}

// If the size of one access is larger than the entire object on the other
// side, then we know such behavior is undefined and can assume no alias.
bool NullIsValidLocation = NullPointerIsDefined(&F);
if ((isObjectSmallerThan(
        O2, getMinimalExtentFrom(*V1, V1Size, DL, NullIsValidLocation), DL,
        TLI, NullIsValidLocation)) ||
    (isObjectSmallerThan(
        O1, getMinimalExtentFrom(*V2, V2Size, DL, NullIsValidLocation), DL,
        TLI, NullIsValidLocation)))
  return NoAlias;

// If one the accesses may be before the accessed pointer, canonicalize this
// by using unknown after-pointer sizes for both accesses. This is
// equivalent, because regardless of which pointer is lower, one of them
// will always came after the other, as long as the underlying objects aren't
// disjoint. We do this so that the rest of BasicAA does not have to deal
// with accesses before the base pointer, and to improve cache utilization by
// merging equivalent states.
if (V1Size.mayBeBeforePointer() || V2Size.mayBeBeforePointer()) {
  V1Size = LocationSize::afterPointer();
  V2Size = LocationSize::afterPointer();
}

// Check the cache before climbing up use-def chains. This also terminates
// otherwise infinitely recursive queries.
AAQueryInfo::LocPair Locs(MemoryLocation(V1, V1Size, V1AAInfo),
                          MemoryLocation(V2, V2Size, V2AAInfo));
if (V1 > V2)
  std::swap(Locs.first, Locs.second);
std::pair<AAQueryInfo::AliasCacheT::iterator, bool> Pair =
    AAQI.AliasCache.try_emplace(Locs, MayAlias);
if (!Pair.second)
  return Pair.first->second;

if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1)) {
  AliasResult Result =
      aliasGEP(GV1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O1, O2, AAQI);
  if (Result != MayAlias)
    return AAQI.updateResult(Locs, Result);
} else if (const GEPOperator *GV2 = dyn_cast<GEPOperator>(V2)) {
  AliasResult Result =
      aliasGEP(GV2, V2Size, V2AAInfo, V1, V1Size, V1AAInfo, O2, O1, AAQI);
  if (Result != MayAlias)
    return AAQI.updateResult(Locs, Result);
}

if (const PHINode *PN = dyn_cast<PHINode>(V1)) {
  AliasResult Result =
      aliasPHI(PN, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O2, AAQI);
  if (Result != MayAlias)
    return AAQI.updateResult(Locs, Result);
} else if (const PHINode *PN = dyn_cast<PHINode>(V2)) {
  AliasResult Result =
      aliasPHI(PN, V2Size, V2AAInfo, V1, V1Size, V1AAInfo, O1, AAQI);
  if (Result != MayAlias)
    return AAQI.updateResult(Locs, Result);
}

if (const SelectInst *S1 = dyn_cast<SelectInst>(V1)) {
  AliasResult Result =
      aliasSelect(S1, V1Size, V1AAInfo, V2, V2Size, V2AAInfo, O2, AAQI);
  if (Result != MayAlias)
    return AAQI.updateResult(Locs, Result);
} else if (const SelectInst *S2 = dyn_cast<SelectInst>(V2)) {
  AliasResult Result =
      aliasSelect(S2, V2Size, V2AAInfo, V1, V1Size, V1AAInfo, O1, AAQI);
  if (Result != MayAlias)
    return AAQI.updateResult(Locs, Result);
}

// If both pointers are pointing into the same object and one of them
// accesses the entire object, then the accesses must overlap in some way.
if (O1 == O2)
  if (V1Size.isPrecise() && V2Size.isPrecise() &&
      (isObjectSize(O1, V1Size.getValue(), DL, TLI, NullIsValidLocation) ||
       isObjectSize(O2, V2Size.getValue(), DL, TLI, NullIsValidLocation)))
    return AAQI.updateResult(Locs, PartialAlias);

// Recurse back into the best AA results we have, potentially with refined
// memory locations. We have already ensured that BasicAA has a MayAlias
// cache result for these, so any recursion back into BasicAA won't loop.
AliasResult Result = getBestAAResults().alias(Locs.first, Locs.second, AAQI);
if (Result != MayAlias)
  return AAQI.updateResult(Locs, Result);

// MayAlias is already in the cache.
return MayAlias;
1792}

1794/// Check whether two Values can be considered equivalent.
1795///
1796/// In addition to pointer equivalence of \p V1 and \p V2 this checks whether
1797/// they can not be part of a cycle in the value graph by looking at all
1798/// visited phi nodes an making sure that the phis cannot reach the value. We
1799/// have to do this because we are looking through phi nodes (That is we say
1800/// noalias(V, phi(VA, VB)) if noalias(V, VA) and noalias(V, VB).
1801bool BasicAAResult::isValueEqualInPotentialCycles(const Value *V,
                                                const Value *V2) {
if (V != V2)
  return false;

const Instruction *Inst = dyn_cast<Instruction>(V);
if (!Inst)
  return true;

if (VisitedPhiBBs.empty())
  return true;

if (VisitedPhiBBs.size() > MaxNumPhiBBsValueReachabilityCheck)
  return false;

// Make sure that the visited phis cannot reach the Value. This ensures that
// the Values cannot come from different iterations of a potential cycle the
// phi nodes could be involved in.
for (auto *P : VisitedPhiBBs)
  if (isPotentiallyReachable(&P->front(), Inst, nullptr, DT, LI))
    return false;

return true;
1824}

1826/// Computes the symbolic difference between two de-composed GEPs.
1827///
1828/// Dest and Src are the variable indices from two decomposed GetElementPtr
1829/// instructions GEP1 and GEP2 which have common base pointers.
1830void BasicAAResult::GetIndexDifference(
  SmallVectorImpl<VariableGEPIndex> &Dest,
  const SmallVectorImpl<VariableGEPIndex> &Src) {
if (Src.empty())
  return;

for (unsigned i = 0, e = Src.size(); i != e; ++i) {
  const Value *V = Src[i].V;
  unsigned ZExtBits = Src[i].ZExtBits, SExtBits = Src[i].SExtBits;
  APInt Scale = Src[i].Scale;

  // Find V in Dest.  This is N^2, but pointer indices almost never have more
  // than a few variable indexes.
  for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
    if (!isValueEqualInPotentialCycles(Dest[j].V, V) ||
        Dest[j].ZExtBits != ZExtBits || Dest[j].SExtBits != SExtBits)
      continue;

    // If we found it, subtract off Scale V's from the entry in Dest.  If it
    // goes to zero, remove the entry.
    if (Dest[j].Scale != Scale)
      Dest[j].Scale -= Scale;
    else
      Dest.erase(Dest.begin() + j);
    Scale = 0;
    break;
  }

  // If we didn't consume this entry, add it to the end of the Dest list.
  if (!!Scale) {
    VariableGEPIndex Entry = {V, ZExtBits, SExtBits, -Scale};
    Dest.push_back(Entry);
  }
}
1864}

1866bool BasicAAResult::constantOffsetHeuristic(
  const SmallVectorImpl<VariableGEPIndex> &VarIndices,
  LocationSize MaybeV1Size, LocationSize MaybeV2Size, const APInt &BaseOffset,
  AssumptionCache *AC, DominatorTree *DT) {
if (VarIndices.size() != 2 || !MaybeV1Size.hasValue() ||
1
Assuming the condition is false→
2
←
Taking false branch→
    !MaybeV2Size.hasValue())
  return false;

const uint64_t V1Size = MaybeV1Size.getValue();
const uint64_t V2Size = MaybeV2Size.getValue();

const VariableGEPIndex &Var0 = VarIndices[0], &Var1 = VarIndices[1];

if (Var0.ZExtBits != Var1.ZExtBits || Var0.SExtBits != Var1.SExtBits ||
3
←
Assuming 'Var0.ZExtBits' is equal to 'Var1.ZExtBits'→
4
←
Assuming 'Var0.SExtBits' is equal to 'Var1.SExtBits'→
5
←
Taking false branch→
    Var0.Scale != -Var1.Scale)
  return false;

unsigned Width = Var1.V->getType()->getIntegerBitWidth();

// We'll strip off the Extensions of Var0 and Var1 and do another round
// of GetLinearExpression decomposition. In the example above, if Var0
// is zext(%x + 1) we should get V1 == %x and V1Offset == 1.

APInt V0Scale(Width, 0), V0Offset(Width, 0), V1Scale(Width, 0),
    V1Offset(Width, 0);
bool NSW = true, NUW = true;
unsigned V0ZExtBits = 0, V0SExtBits = 0, V1ZExtBits = 0, V1SExtBits = 0;
const Value *V0 = GetLinearExpression(Var0.V, V0Scale, V0Offset, V0ZExtBits,
6
←
Calling 'BasicAAResult::GetLinearExpression'→
                                      V0SExtBits, DL, 0, AC, DT, NSW, NUW);
NSW = true;
NUW = true;
const Value *V1 = GetLinearExpression(Var1.V, V1Scale, V1Offset, V1ZExtBits,
                                      V1SExtBits, DL, 0, AC, DT, NSW, NUW);

if (V0Scale != V1Scale || V0ZExtBits != V1ZExtBits ||
    V0SExtBits != V1SExtBits || !isValueEqualInPotentialCycles(V0, V1))
  return false;

// We have a hit - Var0 and Var1 only differ by a constant offset!

// If we've been sext'ed then zext'd the maximum difference between Var0 and
// Var1 is possible to calculate, but we're just interested in the absolute
// minimum difference between the two. The minimum distance may occur due to
// wrapping; consider "add i3 %i, 5": if %i == 7 then 7 + 5 mod 8 == 4, and so
// the minimum distance between %i and %i + 5 is 3.
APInt MinDiff = V0Offset - V1Offset, Wrapped = -MinDiff;
MinDiff = APIntOps::umin(MinDiff, Wrapped);
APInt MinDiffBytes =
  MinDiff.zextOrTrunc(Var0.Scale.getBitWidth()) * Var0.Scale.abs();

// We can't definitely say whether GEP1 is before or after V2 due to wrapping
// arithmetic (i.e. for some values of GEP1 and V2 GEP1 < V2, and for other
// values GEP1 > V2). We'll therefore only declare NoAlias if both V1Size and
// V2Size can fit in the MinDiffBytes gap.
return MinDiffBytes.uge(V1Size + BaseOffset.abs()) &&
       MinDiffBytes.uge(V2Size + BaseOffset.abs());
1922}

1924//===----------------------------------------------------------------------===//
1925// BasicAliasAnalysis Pass
1926//===----------------------------------------------------------------------===//

1928AnalysisKey BasicAA::Key;

1930BasicAAResult BasicAA::run(Function &F, FunctionAnalysisManager &AM) {
return BasicAAResult(F.getParent()->getDataLayout(),
                     F,
                     AM.getResult<TargetLibraryAnalysis>(F),
                     AM.getResult<AssumptionAnalysis>(F),
                     &AM.getResult<DominatorTreeAnalysis>(F),
                     AM.getCachedResult<LoopAnalysis>(F),
                     AM.getCachedResult<PhiValuesAnalysis>(F));
1938}

1940BasicAAWrapperPass::BasicAAWrapperPass() : FunctionPass(ID) {
initializeBasicAAWrapperPassPass(*PassRegistry::getPassRegistry());
1942}

1944char BasicAAWrapperPass::ID = 0;

1946void BasicAAWrapperPass::anchor() {}

1948INITIALIZE_PASS_BEGIN(BasicAAWrapperPass, "basic-aa",static void *initializeBasicAAWrapperPassPassOnce(PassRegistry
 &Registry) {
                    "Basic Alias Analysis (stateless AA impl)", true, true)static void *initializeBasicAAWrapperPassPassOnce(PassRegistry
 &Registry) {
1950INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)initializeAssumptionCacheTrackerPass(Registry);
1951INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)initializeDominatorTreeWrapperPassPass(Registry);
1952INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)initializeTargetLibraryInfoWrapperPassPass(Registry);
1953INITIALIZE_PASS_DEPENDENCY(PhiValuesWrapperPass)initializePhiValuesWrapperPassPass(Registry);
1954INITIALIZE_PASS_END(BasicAAWrapperPass, "basic-aa",PassInfo *PI = new PassInfo( "Basic Alias Analysis (stateless AA impl)"
, "basic-aa", &BasicAAWrapperPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<BasicAAWrapperPass>), true, true); Registry
.registerPass(*PI, true); return PI; } static llvm::once_flag
 InitializeBasicAAWrapperPassPassFlag; void llvm::initializeBasicAAWrapperPassPass
(PassRegistry &Registry) { llvm::call_once(InitializeBasicAAWrapperPassPassFlag
, initializeBasicAAWrapperPassPassOnce, std::ref(Registry)); }
                  "Basic Alias Analysis (stateless AA impl)", true, true)PassInfo *PI = new PassInfo( "Basic Alias Analysis (stateless AA impl)"
, "basic-aa", &BasicAAWrapperPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<BasicAAWrapperPass>), true, true); Registry
.registerPass(*PI, true); return PI; } static llvm::once_flag
 InitializeBasicAAWrapperPassPassFlag; void llvm::initializeBasicAAWrapperPassPass
(PassRegistry &Registry) { llvm::call_once(InitializeBasicAAWrapperPassPassFlag
, initializeBasicAAWrapperPassPassOnce, std::ref(Registry)); }

1957FunctionPass *llvm::createBasicAAWrapperPass() {
return new BasicAAWrapperPass();
1959}

1961bool BasicAAWrapperPass::runOnFunction(Function &F) {
auto &ACT = getAnalysis<AssumptionCacheTracker>();
auto &TLIWP = getAnalysis<TargetLibraryInfoWrapperPass>();
auto &DTWP = getAnalysis<DominatorTreeWrapperPass>();
auto *LIWP = getAnalysisIfAvailable<LoopInfoWrapperPass>();
auto *PVWP = getAnalysisIfAvailable<PhiValuesWrapperPass>();

Result.reset(new BasicAAResult(F.getParent()->getDataLayout(), F,
                               TLIWP.getTLI(F), ACT.getAssumptionCache(F),
                               &DTWP.getDomTree(),
                               LIWP ? &LIWP->getLoopInfo() : nullptr,
                               PVWP ? &PVWP->getResult() : nullptr));

return false;
1975}

1977void BasicAAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequired<AssumptionCacheTracker>();
AU.addRequired<DominatorTreeWrapperPass>();
AU.addRequired<TargetLibraryInfoWrapperPass>();
AU.addUsedIfAvailable<PhiValuesWrapperPass>();
1983}

1985BasicAAResult llvm::createLegacyPMBasicAAResult(Pass &P, Function &F) {
return BasicAAResult(
    F.getParent()->getDataLayout(), F,
    P.getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(F),
    P.getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F));
1990}

←

/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h

1//===-- llvm/ADT/APInt.h - For Arbitrary Precision Integer -----*- C++ -*--===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// This file implements a class to represent arbitrary precision
11/// integral constant values and operations on them.
12///
13//===----------------------------------------------------------------------===//

15#ifndef LLVM_ADT_APINT_H
16#define LLVM_ADT_APINT_H

18#include "llvm/Support/Compiler.h"
19#include "llvm/Support/MathExtras.h"
20#include <cassert>
21#include <climits>
22#include <cstring>
23#include <string>

25namespace llvm {
26class FoldingSetNodeID;
27class StringRef;
28class hash_code;
29class raw_ostream;

31template <typename T> class SmallVectorImpl;
32template <typename T> class ArrayRef;
33template <typename T> class Optional;
34template <typename T> struct DenseMapInfo;

36class APInt;

38inline APInt operator-(APInt);

40//===----------------------------------------------------------------------===//
41//                              APInt Class
42//===----------------------------------------------------------------------===//

44/// Class for arbitrary precision integers.
45///
46/// APInt is a functional replacement for common case unsigned integer type like
47/// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
48/// integer sizes and large integer value types such as 3-bits, 15-bits, or more
49/// than 64-bits of precision. APInt provides a variety of arithmetic operators
50/// and methods to manipulate integer values of any bit-width. It supports both
51/// the typical integer arithmetic and comparison operations as well as bitwise
52/// manipulation.
53///
54/// The class has several invariants worth noting:
55///   * All bit, byte, and word positions are zero-based.
56///   * Once the bit width is set, it doesn't change except by the Truncate,
57///     SignExtend, or ZeroExtend operations.
58///   * All binary operators must be on APInt instances of the same bit width.
59///     Attempting to use these operators on instances with different bit
60///     widths will yield an assertion.
61///   * The value is stored canonically as an unsigned value. For operations
62///     where it makes a difference, there are both signed and unsigned variants
63///     of the operation. For example, sdiv and udiv. However, because the bit
64///     widths must be the same, operations such as Mul and Add produce the same
65///     results regardless of whether the values are interpreted as signed or
66///     not.
67///   * In general, the class tries to follow the style of computation that LLVM
68///     uses in its IR. This simplifies its use for LLVM.
69///
70class LLVM_NODISCARD[[clang::warn_unused_result]] APInt {
71public:
typedef uint64_t WordType;

/// This enum is used to hold the constants we needed for APInt.
enum : unsigned {
  /// Byte size of a word.
  APINT_WORD_SIZE = sizeof(WordType),
  /// Bits in a word.
  APINT_BITS_PER_WORD = APINT_WORD_SIZE * CHAR_BIT8
};

enum class Rounding {
  DOWN,
  TOWARD_ZERO,
  UP,
};

static constexpr WordType WORDTYPE_MAX = ~WordType(0);

90private:
/// This union is used to store the integer value. When the
/// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
union {
  uint64_t VAL;   ///< Used to store the <= 64 bits integer value.
  uint64_t *pVal; ///< Used to store the >64 bits integer value.
} U;

unsigned BitWidth; ///< The number of bits in this APInt.

friend struct DenseMapInfo<APInt>;

friend class APSInt;

/// Fast internal constructor
///
/// This constructor is used only internally for speed of construction of
/// temporaries. It is unsafe for general use so it is not public.
APInt(uint64_t *val, unsigned bits) : BitWidth(bits) {
  U.pVal = val;
}

/// Determine if this APInt just has one word to store value.
///
/// \returns true if the number of bits <= 64, false otherwise.
bool isSingleWord() const { return BitWidth <= APINT_BITS_PER_WORD; }

/// Determine which word a bit is in.
///
/// \returns the word position for the specified bit position.
static unsigned whichWord(unsigned bitPosition) {
  return bitPosition / APINT_BITS_PER_WORD;
}

/// Determine which bit in a word a bit is in.
///
/// \returns the bit position in a word for the specified bit position
/// in the APInt.
static unsigned whichBit(unsigned bitPosition) {
  return bitPosition % APINT_BITS_PER_WORD;
}

/// Get a single bit mask.
///
/// \returns a uint64_t with only bit at "whichBit(bitPosition)" set
/// This method generates and returns a uint64_t (word) mask for a single
/// bit at a specific bit position. This is used to mask the bit in the
/// corresponding word.
static uint64_t maskBit(unsigned bitPosition) {
  return 1ULL << whichBit(bitPosition);
}

/// Clear unused high order bits
///
/// This method is used internally to clear the top "N" bits in the high order
/// word that are not used by the APInt. This is needed after the most
/// significant word is assigned a value to ensure that those bits are
/// zero'd out.
APInt &clearUnusedBits() {
  // Compute how many bits are used in the final word
  unsigned WordBits = ((BitWidth-1) % APINT_BITS_PER_WORD) + 1;

  // Mask out the high bits.
  uint64_t mask = WORDTYPE_MAX >> (APINT_BITS_PER_WORD - WordBits);
  if (isSingleWord())
    U.VAL &= mask;
  else
    U.pVal[getNumWords() - 1] &= mask;
  return *this;
}

/// Get the word corresponding to a bit position
/// \returns the corresponding word for the specified bit position.
uint64_t getWord(unsigned bitPosition) const {
  return isSingleWord() ? U.VAL : U.pVal[whichWord(bitPosition)];
}

/// Utility method to change the bit width of this APInt to new bit width,
/// allocating and/or deallocating as necessary. There is no guarantee on the
/// value of any bits upon return. Caller should populate the bits after.
void reallocate(unsigned NewBitWidth);

/// Convert a char array into an APInt
///
/// \param radix 2, 8, 10, 16, or 36
/// Converts a string into a number.  The string must be non-empty
/// and well-formed as a number of the given base. The bit-width
/// must be sufficient to hold the result.
///
/// This is used by the constructors that take string arguments.
///
/// StringRef::getAsInteger is superficially similar but (1) does
/// not assume that the string is well-formed and (2) grows the
/// result to hold the input.
void fromString(unsigned numBits, StringRef str, uint8_t radix);

/// An internal division function for dividing APInts.
///
/// This is used by the toString method to divide by the radix. It simply
/// provides a more convenient form of divide for internal use since KnuthDiv
/// has specific constraints on its inputs. If those constraints are not met
/// then it provides a simpler form of divide.
static void divide(const WordType *LHS, unsigned lhsWords,
                   const WordType *RHS, unsigned rhsWords, WordType *Quotient,
                   WordType *Remainder);

/// out-of-line slow case for inline constructor
void initSlowCase(uint64_t val, bool isSigned);

/// shared code between two array constructors
void initFromArray(ArrayRef<uint64_t> array);

/// out-of-line slow case for inline copy constructor
void initSlowCase(const APInt &that);

/// out-of-line slow case for shl
void shlSlowCase(unsigned ShiftAmt);

/// out-of-line slow case for lshr.
void lshrSlowCase(unsigned ShiftAmt);

/// out-of-line slow case for ashr.
void ashrSlowCase(unsigned ShiftAmt);

/// out-of-line slow case for operator=
void AssignSlowCase(const APInt &RHS);

/// out-of-line slow case for operator==
bool EqualSlowCase(const APInt &RHS) const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for countLeadingZeros
unsigned countLeadingZerosSlowCase() const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for countLeadingOnes.
unsigned countLeadingOnesSlowCase() const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for countTrailingZeros.
unsigned countTrailingZerosSlowCase() const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for countTrailingOnes
unsigned countTrailingOnesSlowCase() const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for countPopulation
unsigned countPopulationSlowCase() const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for intersects.
bool intersectsSlowCase(const APInt &RHS) const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for isSubsetOf.
bool isSubsetOfSlowCase(const APInt &RHS) const LLVM_READONLY__attribute__((__pure__));

/// out-of-line slow case for setBits.
void setBitsSlowCase(unsigned loBit, unsigned hiBit);

/// out-of-line slow case for flipAllBits.
void flipAllBitsSlowCase();

/// out-of-line slow case for operator&=.
void AndAssignSlowCase(const APInt& RHS);

/// out-of-line slow case for operator|=.
void OrAssignSlowCase(const APInt& RHS);

/// out-of-line slow case for operator^=.
void XorAssignSlowCase(const APInt& RHS);

/// Unsigned comparison. Returns -1, 0, or 1 if this APInt is less than, equal
/// to, or greater than RHS.
int compare(const APInt &RHS) const LLVM_READONLY__attribute__((__pure__));

/// Signed comparison. Returns -1, 0, or 1 if this APInt is less than, equal
/// to, or greater than RHS.
int compareSigned(const APInt &RHS) const LLVM_READONLY__attribute__((__pure__));

264public:
/// \name Constructors
/// @{

/// Create a new APInt of numBits width, initialized as val.
///
/// If isSigned is true then val is treated as if it were a signed value
/// (i.e. as an int64_t) and the appropriate sign extension to the bit width
/// will be done. Otherwise, no sign extension occurs (high order bits beyond
/// the range of val are zero filled).
///
/// \param numBits the bit width of the constructed APInt
/// \param val the initial value of the APInt
/// \param isSigned how to treat signedness of val
APInt(unsigned numBits, uint64_t val, bool isSigned = false)
    : BitWidth(numBits) {
  assert(BitWidth && "bitwidth too small")((BitWidth && "bitwidth too small") ? static_cast<
void> (0) : __assert_fail ("BitWidth && \"bitwidth too small\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 280, __PRETTY_FUNCTION__));
  if (isSingleWord()) {
    U.VAL = val;
    clearUnusedBits();
  } else {
    initSlowCase(val, isSigned);
  }
}

/// Construct an APInt of numBits width, initialized as bigVal[].
///
/// Note that bigVal.size() can be smaller or larger than the corresponding
/// bit width but any extraneous bits will be dropped.
///
/// \param numBits the bit width of the constructed APInt
/// \param bigVal a sequence of words to form the initial value of the APInt
APInt(unsigned numBits, ArrayRef<uint64_t> bigVal);

/// Equivalent to APInt(numBits, ArrayRef<uint64_t>(bigVal, numWords)), but
/// deprecated because this constructor is prone to ambiguity with the
/// APInt(unsigned, uint64_t, bool) constructor.
///
/// If this overload is ever deleted, care should be taken to prevent calls
/// from being incorrectly captured by the APInt(unsigned, uint64_t, bool)
/// constructor.
APInt(unsigned numBits, unsigned numWords, const uint64_t bigVal[]);

/// Construct an APInt from a string representation.
///
/// This constructor interprets the string \p str in the given radix. The
/// interpretation stops when the first character that is not suitable for the
/// radix is encountered, or the end of the string. Acceptable radix values
/// are 2, 8, 10, 16, and 36. It is an error for the value implied by the
/// string to require more bits than numBits.
///
/// \param numBits the bit width of the constructed APInt
/// \param str the string to be interpreted
/// \param radix the radix to use for the conversion
APInt(unsigned numBits, StringRef str, uint8_t radix);

/// Simply makes *this a copy of that.
/// Copy Constructor.
APInt(const APInt &that) : BitWidth(that.BitWidth) {
  if (isSingleWord())
    U.VAL = that.U.VAL;
  else
    initSlowCase(that);
}

/// Move Constructor.
APInt(APInt &&that) : BitWidth(that.BitWidth) {
  memcpy(&U, &that.U, sizeof(U));
  that.BitWidth = 0;
}

/// Destructor.
~APInt() {
  if (needsCleanup())
    delete[] U.pVal;
}

/// Default constructor that creates an uninteresting APInt
/// representing a 1-bit zero value.
///
/// This is useful for object deserialization (pair this with the static
///  method Read).
explicit APInt() : BitWidth(1) { U.VAL = 0; }

/// Returns whether this instance allocated memory.
bool needsCleanup() const { return !isSingleWord(); }

/// Used to insert APInt objects, or objects that contain APInt objects, into
///  FoldingSets.
void Profile(FoldingSetNodeID &id) const;

/// @}
/// \name Value Tests
/// @{

/// Determine sign of this APInt.
///
/// This tests the high bit of this APInt to determine if it is set.
///
/// \returns true if this APInt is negative, false otherwise
bool isNegative() const { return (*this)[BitWidth - 1]; }

/// Determine if this APInt Value is non-negative (>= 0)
///
/// This tests the high bit of the APInt to determine if it is unset.
bool isNonNegative() const { return !isNegative(); }

/// Determine if sign bit of this APInt is set.
///
/// This tests the high bit of this APInt to determine if it is set.
///
/// \returns true if this APInt has its sign bit set, false otherwise.
bool isSignBitSet() const { return (*this)[BitWidth-1]; }

/// Determine if sign bit of this APInt is clear.
///
/// This tests the high bit of this APInt to determine if it is clear.
///
/// \returns true if this APInt has its sign bit clear, false otherwise.
bool isSignBitClear() const { return !isSignBitSet(); }

/// Determine if this APInt Value is positive.
///
/// This tests if the value of this APInt is positive (> 0). Note
/// that 0 is not a positive value.
///
/// \returns true if this APInt is positive.
bool isStrictlyPositive() const { return isNonNegative() && !isNullValue(); }

/// Determine if this APInt Value is non-positive (<= 0).
///
/// \returns true if this APInt is non-positive.
bool isNonPositive() const { return !isStrictlyPositive(); }

/// Determine if all bits are set
///
/// This checks to see if the value has all bits of the APInt are set or not.
bool isAllOnesValue() const {
  if (isSingleWord())
    return U.VAL == WORDTYPE_MAX >> (APINT_BITS_PER_WORD - BitWidth);
  return countTrailingOnesSlowCase() == BitWidth;
}

/// Determine if all bits are clear
///
/// This checks to see if the value has all bits of the APInt are clear or
/// not.
bool isNullValue() const { return !*this; }

/// Determine if this is a value of 1.
///
/// This checks to see if the value of this APInt is one.
bool isOneValue() const {
  if (isSingleWord())
    return U.VAL == 1;
  return countLeadingZerosSlowCase() == BitWidth - 1;
}

/// Determine if this is the largest unsigned value.
///
/// This checks to see if the value of this APInt is the maximum unsigned
/// value for the APInt's bit width.
bool isMaxValue() const { return isAllOnesValue(); }

/// Determine if this is the largest signed value.
///
/// This checks to see if the value of this APInt is the maximum signed
/// value for the APInt's bit width.
bool isMaxSignedValue() const {
  if (isSingleWord())
    return U.VAL == ((WordType(1) << (BitWidth - 1)) - 1);
  return !isNegative() && countTrailingOnesSlowCase() == BitWidth - 1;
}

/// Determine if this is the smallest unsigned value.
///
/// This checks to see if the value of this APInt is the minimum unsigned
/// value for the APInt's bit width.
bool isMinValue() const { return isNullValue(); }

/// Determine if this is the smallest signed value.
///
/// This checks to see if the value of this APInt is the minimum signed
/// value for the APInt's bit width.
bool isMinSignedValue() const {
  if (isSingleWord())
    return U.VAL == (WordType(1) << (BitWidth - 1));
  return isNegative() && countTrailingZerosSlowCase() == BitWidth - 1;
}

/// Check if this APInt has an N-bits unsigned integer value.
bool isIntN(unsigned N) const {
  assert(N && "N == 0 ???")((N && "N == 0 ???") ? static_cast<void> (0) : __assert_fail
 ("N && \"N == 0 ???\"", "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 456, __PRETTY_FUNCTION__));
  return getActiveBits() <= N;
}

/// Check if this APInt has an N-bits signed integer value.
bool isSignedIntN(unsigned N) const {
  assert(N && "N == 0 ???")((N && "N == 0 ???") ? static_cast<void> (0) : __assert_fail
 ("N && \"N == 0 ???\"", "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 462, __PRETTY_FUNCTION__));
  return getMinSignedBits() <= N;
}

/// Check if this APInt's value is a power of two greater than zero.
///
/// \returns true if the argument APInt value is a power of two > 0.
bool isPowerOf2() const {
  if (isSingleWord())
    return isPowerOf2_64(U.VAL);
  return countPopulationSlowCase() == 1;
}

/// Check if the APInt's value is returned by getSignMask.
///
/// \returns true if this is the value returned by getSignMask.
bool isSignMask() const { return isMinSignedValue(); }

/// Convert APInt to a boolean value.
///
/// This converts the APInt to a boolean value as a test against zero.
bool getBoolValue() const { return !!*this; }

/// If this value is smaller than the specified limit, return it, otherwise
/// return the limit value.  This causes the value to saturate to the limit.
uint64_t getLimitedValue(uint64_t Limit = UINT64_MAX(18446744073709551615UL)) const {
  return ugt(Limit) ? Limit : getZExtValue();
21
←
'?' condition is true→
22
←
Returning the value 18446744073709551615→
}

/// Check if the APInt consists of a repeated bit pattern.
///
/// e.g. 0x01010101 satisfies isSplat(8).
/// \param SplatSizeInBits The size of the pattern in bits. Must divide bit
/// width without remainder.
bool isSplat(unsigned SplatSizeInBits) const;

/// \returns true if this APInt value is a sequence of \param numBits ones
/// starting at the least significant bit with the remainder zero.
bool isMask(unsigned numBits) const {
  assert(numBits != 0 && "numBits must be non-zero")((numBits != 0 && "numBits must be non-zero") ? static_cast
<void> (0) : __assert_fail ("numBits != 0 && \"numBits must be non-zero\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 501, __PRETTY_FUNCTION__));
  assert(numBits <= BitWidth && "numBits out of range")((numBits <= BitWidth && "numBits out of range") ?
 static_cast<void> (0) : __assert_fail ("numBits <= BitWidth && \"numBits out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 502, __PRETTY_FUNCTION__));
  if (isSingleWord())
    return U.VAL == (WORDTYPE_MAX >> (APINT_BITS_PER_WORD - numBits));
  unsigned Ones = countTrailingOnesSlowCase();
  return (numBits == Ones) &&
         ((Ones + countLeadingZerosSlowCase()) == BitWidth);
}

/// \returns true if this APInt is a non-empty sequence of ones starting at
/// the least significant bit with the remainder zero.
/// Ex. isMask(0x0000FFFFU) == true.
bool isMask() const {
  if (isSingleWord())
    return isMask_64(U.VAL);
  unsigned Ones = countTrailingOnesSlowCase();
  return (Ones > 0) && ((Ones + countLeadingZerosSlowCase()) == BitWidth);
}

/// Return true if this APInt value contains a sequence of ones with
/// the remainder zero.
bool isShiftedMask() const {
  if (isSingleWord())
    return isShiftedMask_64(U.VAL);
  unsigned Ones = countPopulationSlowCase();
  unsigned LeadZ = countLeadingZerosSlowCase();
  return (Ones + LeadZ + countTrailingZeros()) == BitWidth;
}

/// @}
/// \name Value Generators
/// @{

/// Gets maximum unsigned value of APInt for specific bit width.
static APInt getMaxValue(unsigned numBits) {
  return getAllOnesValue(numBits);
}

/// Gets maximum signed value of APInt for a specific bit width.
static APInt getSignedMaxValue(unsigned numBits) {
  APInt API = getAllOnesValue(numBits);
  API.clearBit(numBits - 1);
  return API;
}

/// Gets minimum unsigned value of APInt for a specific bit width.
static APInt getMinValue(unsigned numBits) { return APInt(numBits, 0); }

/// Gets minimum signed value of APInt for a specific bit width.
static APInt getSignedMinValue(unsigned numBits) {
  APInt API(numBits, 0);
  API.setBit(numBits - 1);
  return API;
}

/// Get the SignMask for a specific bit width.
///
/// This is just a wrapper function of getSignedMinValue(), and it helps code
/// readability when we want to get a SignMask.
static APInt getSignMask(unsigned BitWidth) {
  return getSignedMinValue(BitWidth);
}

/// Get the all-ones value.
///
/// \returns the all-ones value for an APInt of the specified bit-width.
static APInt getAllOnesValue(unsigned numBits) {
  return APInt(numBits, WORDTYPE_MAX, true);
}

/// Get the '0' value.
///
/// \returns the '0' value for an APInt of the specified bit-width.
static APInt getNullValue(unsigned numBits) { return APInt(numBits, 0); }

/// Compute an APInt containing numBits highbits from this APInt.
///
/// Get an APInt with the same BitWidth as this APInt, just zero mask
/// the low bits and right shift to the least significant bit.
///
/// \returns the high "numBits" bits of this APInt.
APInt getHiBits(unsigned numBits) const;

/// Compute an APInt containing numBits lowbits from this APInt.
///
/// Get an APInt with the same BitWidth as this APInt, just zero mask
/// the high bits.
///
/// \returns the low "numBits" bits of this APInt.
APInt getLoBits(unsigned numBits) const;

/// Return an APInt with exactly one bit set in the result.
static APInt getOneBitSet(unsigned numBits, unsigned BitNo) {
  APInt Res(numBits, 0);
  Res.setBit(BitNo);
  return Res;
}

/// Get a value with a block of bits set.
///
/// Constructs an APInt value that has a contiguous range of bits set. The
/// bits from loBit (inclusive) to hiBit (exclusive) will be set. All other
/// bits will be zero. For example, with parameters(32, 0, 16) you would get
/// 0x0000FFFF. Please call getBitsSetWithWrap if \p loBit may be greater than
/// \p hiBit.
///
/// \param numBits the intended bit width of the result
/// \param loBit the index of the lowest bit set.
/// \param hiBit the index of the highest bit set.
///
/// \returns An APInt value with the requested bits set.
static APInt getBitsSet(unsigned numBits, unsigned loBit, unsigned hiBit) {
  assert(loBit <= hiBit && "loBit greater than hiBit")((loBit <= hiBit && "loBit greater than hiBit") ? static_cast
<void> (0) : __assert_fail ("loBit <= hiBit && \"loBit greater than hiBit\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 613, __PRETTY_FUNCTION__));
  APInt Res(numBits, 0);
  Res.setBits(loBit, hiBit);
  return Res;
}

/// Wrap version of getBitsSet.
/// If \p hiBit is bigger than \p loBit, this is same with getBitsSet.
/// If \p hiBit is not bigger than \p loBit, the set bits "wrap". For example,
/// with parameters (32, 28, 4), you would get 0xF000000F.
/// If \p hiBit is equal to \p loBit, you would get a result with all bits
/// set.
static APInt getBitsSetWithWrap(unsigned numBits, unsigned loBit,
                                unsigned hiBit) {
  APInt Res(numBits, 0);
  Res.setBitsWithWrap(loBit, hiBit);
  return Res;
}

/// Get a value with upper bits starting at loBit set.
///
/// Constructs an APInt value that has a contiguous range of bits set. The
/// bits from loBit (inclusive) to numBits (exclusive) will be set. All other
/// bits will be zero. For example, with parameters(32, 12) you would get
/// 0xFFFFF000.
///
/// \param numBits the intended bit width of the result
/// \param loBit the index of the lowest bit to set.
///
/// \returns An APInt value with the requested bits set.
static APInt getBitsSetFrom(unsigned numBits, unsigned loBit) {
  APInt Res(numBits, 0);
  Res.setBitsFrom(loBit);
  return Res;
}

/// Get a value with high bits set
///
/// Constructs an APInt value that has the top hiBitsSet bits set.
///
/// \param numBits the bitwidth of the result
/// \param hiBitsSet the number of high-order bits set in the result.
static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet) {
  APInt Res(numBits, 0);
  Res.setHighBits(hiBitsSet);
  return Res;
}

/// Get a value with low bits set
///
/// Constructs an APInt value that has the bottom loBitsSet bits set.
///
/// \param numBits the bitwidth of the result
/// \param loBitsSet the number of low-order bits set in the result.
static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet) {
  APInt Res(numBits, 0);
  Res.setLowBits(loBitsSet);
  return Res;
}

/// Return a value containing V broadcasted over NewLen bits.
static APInt getSplat(unsigned NewLen, const APInt &V);

/// Determine if two APInts have the same value, after zero-extending
/// one of them (if needed!) to ensure that the bit-widths match.
static bool isSameValue(const APInt &I1, const APInt &I2) {
  if (I1.getBitWidth() == I2.getBitWidth())
    return I1 == I2;

  if (I1.getBitWidth() > I2.getBitWidth())
    return I1 == I2.zext(I1.getBitWidth());

  return I1.zext(I2.getBitWidth()) == I2;
}

/// Overload to compute a hash_code for an APInt value.
friend hash_code hash_value(const APInt &Arg);

/// This function returns a pointer to the internal storage of the APInt.
/// This is useful for writing out the APInt in binary form without any
/// conversions.
const uint64_t *getRawData() const {
  if (isSingleWord())
    return &U.VAL;
  return &U.pVal[0];
}

/// @}
/// \name Unary Operators
/// @{

/// Postfix increment operator.
///
/// Increments *this by 1.
///
/// \returns a new APInt value representing the original value of *this.
const APInt operator++(int) {
  APInt API(*this);
  ++(*this);
  return API;
}

/// Prefix increment operator.
///
/// \returns *this incremented by one
APInt &operator++();

/// Postfix decrement operator.
///
/// Decrements *this by 1.
///
/// \returns a new APInt value representing the original value of *this.
const APInt operator--(int) {
  APInt API(*this);
  --(*this);
  return API;
}

/// Prefix decrement operator.
///
/// \returns *this decremented by one.
APInt &operator--();

/// Logical negation operator.
///
/// Performs logical negation operation on this APInt.
///
/// \returns true if *this is zero, false otherwise.
bool operator!() const {
  if (isSingleWord())
    return U.VAL == 0;
  return countLeadingZerosSlowCase() == BitWidth;
}

/// @}
/// \name Assignment Operators
/// @{

/// Copy assignment operator.
///
/// \returns *this after assignment of RHS.
APInt &operator=(const APInt &RHS) {
  // If the bitwidths are the same, we can avoid mucking with memory
  if (isSingleWord() && RHS.isSingleWord()) {
    U.VAL = RHS.U.VAL;
    BitWidth = RHS.BitWidth;
    return clearUnusedBits();
  }

  AssignSlowCase(RHS);
  return *this;
}

/// Move assignment operator.
APInt &operator=(APInt &&that) {
768#ifdef EXPENSIVE_CHECKS
  // Some std::shuffle implementations still do self-assignment.
  if (this == &that)
    return *this;
772#endif
  assert(this != &that && "Self-move not supported")((this != &that && "Self-move not supported") ? static_cast
<void> (0) : __assert_fail ("this != &that && \"Self-move not supported\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 773, __PRETTY_FUNCTION__));
  if (!isSingleWord())
    delete[] U.pVal;

  // Use memcpy so that type based alias analysis sees both VAL and pVal
  // as modified.
  memcpy(&U, &that.U, sizeof(U));

  BitWidth = that.BitWidth;
  that.BitWidth = 0;

  return *this;
}

/// Assignment operator.
///
/// The RHS value is assigned to *this. If the significant bits in RHS exceed
/// the bit width, the excess bits are truncated. If the bit width is larger
/// than 64, the value is zero filled in the unspecified high order bits.
///
/// \returns *this after assignment of RHS value.
APInt &operator=(uint64_t RHS) {
  if (isSingleWord()) {
    U.VAL = RHS;
    return clearUnusedBits();
  }
  U.pVal[0] = RHS;
  memset(U.pVal + 1, 0, (getNumWords() - 1) * APINT_WORD_SIZE);
  return *this;
}

/// Bitwise AND assignment operator.
///
/// Performs a bitwise AND operation on this APInt and RHS. The result is
/// assigned to *this.
///
/// \returns *this after ANDing with RHS.
APInt &operator&=(const APInt &RHS) {
  assert(BitWidth == RHS.BitWidth && "Bit widths must be the same")((BitWidth == RHS.BitWidth && "Bit widths must be the same"
) ? static_cast<void> (0) : __assert_fail ("BitWidth == RHS.BitWidth && \"Bit widths must be the same\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 811, __PRETTY_FUNCTION__));
  if (isSingleWord())
    U.VAL &= RHS.U.VAL;
  else
    AndAssignSlowCase(RHS);
  return *this;
}

/// Bitwise AND assignment operator.
///
/// Performs a bitwise AND operation on this APInt and RHS. RHS is
/// logically zero-extended or truncated to match the bit-width of
/// the LHS.
APInt &operator&=(uint64_t RHS) {
  if (isSingleWord()) {
    U.VAL &= RHS;
    return *this;
  }
  U.pVal[0] &= RHS;
  memset(U.pVal+1, 0, (getNumWords() - 1) * APINT_WORD_SIZE);
  return *this;
}

/// Bitwise OR assignment operator.
///
/// Performs a bitwise OR operation on this APInt and RHS. The result is
/// assigned *this;
///
/// \returns *this after ORing with RHS.
APInt &operator|=(const APInt &RHS) {
  assert(BitWidth == RHS.BitWidth && "Bit widths must be the same")((BitWidth == RHS.BitWidth && "Bit widths must be the same"
) ? static_cast<void> (0) : __assert_fail ("BitWidth == RHS.BitWidth && \"Bit widths must be the same\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 841, __PRETTY_FUNCTION__));
  if (isSingleWord())
    U.VAL |= RHS.U.VAL;
  else
    OrAssignSlowCase(RHS);
  return *this;
}

/// Bitwise OR assignment operator.
///
/// Performs a bitwise OR operation on this APInt and RHS. RHS is
/// logically zero-extended or truncated to match the bit-width of
/// the LHS.
APInt &operator|=(uint64_t RHS) {
  if (isSingleWord()) {
    U.VAL |= RHS;
    return clearUnusedBits();
  }
  U.pVal[0] |= RHS;
  return *this;
}

/// Bitwise XOR assignment operator.
///
/// Performs a bitwise XOR operation on this APInt and RHS. The result is
/// assigned to *this.
///
/// \returns *this after XORing with RHS.
APInt &operator^=(const APInt &RHS) {
  assert(BitWidth == RHS.BitWidth && "Bit widths must be the same")((BitWidth == RHS.BitWidth && "Bit widths must be the same"
) ? static_cast<void> (0) : __assert_fail ("BitWidth == RHS.BitWidth && \"Bit widths must be the same\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 870, __PRETTY_FUNCTION__));
  if (isSingleWord())
    U.VAL ^= RHS.U.VAL;
  else
    XorAssignSlowCase(RHS);
  return *this;
}

/// Bitwise XOR assignment operator.
///
/// Performs a bitwise XOR operation on this APInt and RHS. RHS is
/// logically zero-extended or truncated to match the bit-width of
/// the LHS.
APInt &operator^=(uint64_t RHS) {
  if (isSingleWord()) {
    U.VAL ^= RHS;
    return clearUnusedBits();
  }
  U.pVal[0] ^= RHS;
  return *this;
}

/// Multiplication assignment operator.
///
/// Multiplies this APInt by RHS and assigns the result to *this.
///
/// \returns *this
APInt &operator*=(const APInt &RHS);
APInt &operator*=(uint64_t RHS);

/// Addition assignment operator.
///
/// Adds RHS to *this and assigns the result to *this.
///
/// \returns *this
APInt &operator+=(const APInt &RHS);
APInt &operator+=(uint64_t RHS);

/// Subtraction assignment operator.
///
/// Subtracts RHS from *this and assigns the result to *this.
///
/// \returns *this
APInt &operator-=(const APInt &RHS);
APInt &operator-=(uint64_t RHS);

/// Left-shift assignment function.
///
/// Shifts *this left by shiftAmt and assigns the result to *this.
///
/// \returns *this after shifting left by ShiftAmt
APInt &operator<<=(unsigned ShiftAmt) {
  assert(ShiftAmt <= BitWidth && "Invalid shift amount")((ShiftAmt <= BitWidth && "Invalid shift amount") ?
 static_cast<void> (0) : __assert_fail ("ShiftAmt <= BitWidth && \"Invalid shift amount\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 922, __PRETTY_FUNCTION__));
26
←
Assuming 'ShiftAmt' is <= field 'BitWidth'→
27
←
'?' condition is true→
  if (isSingleWord()) {
28
←
Assuming the condition is true→
29
←
Taking true branch→
    if (ShiftAmt == BitWidth)
30
←
Assuming 'ShiftAmt' is not equal to field 'BitWidth'→
31
←
Taking false branch→
      U.VAL = 0;
    else
      U.VAL <<= ShiftAmt;
32
←
Assigned value is garbage or undefined
    return clearUnusedBits();
  }
  shlSlowCase(ShiftAmt);
  return *this;
}

/// Left-shift assignment function.
///
/// Shifts *this left by shiftAmt and assigns the result to *this.
///
/// \returns *this after shifting left by ShiftAmt
APInt &operator<<=(const APInt &ShiftAmt);

/// @}
/// \name Binary Operators
/// @{

/// Multiplication operator.
///
/// Multiplies this APInt by RHS and returns the result.
APInt operator*(const APInt &RHS) const;

/// Left logical shift operator.
///
/// Shifts this APInt left by \p Bits and returns the result.
APInt operator<<(unsigned Bits) const { return shl(Bits); }

/// Left logical shift operator.
///
/// Shifts this APInt left by \p Bits and returns the result.
APInt operator<<(const APInt &Bits) const { return shl(Bits); }

/// Arithmetic right-shift function.
///
/// Arithmetic right-shift this APInt by shiftAmt.
APInt ashr(unsigned ShiftAmt) const {
  APInt R(*this);
  R.ashrInPlace(ShiftAmt);
  return R;
}

/// Arithmetic right-shift this APInt by ShiftAmt in place.
void ashrInPlace(unsigned ShiftAmt) {
  assert(ShiftAmt <= BitWidth && "Invalid shift amount")((ShiftAmt <= BitWidth && "Invalid shift amount") ?
 static_cast<void> (0) : __assert_fail ("ShiftAmt <= BitWidth && \"Invalid shift amount\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 971, __PRETTY_FUNCTION__));
  if (isSingleWord()) {
    int64_t SExtVAL = SignExtend64(U.VAL, BitWidth);
    if (ShiftAmt == BitWidth)
      U.VAL = SExtVAL >> (APINT_BITS_PER_WORD - 1); // Fill with sign bit.
    else
      U.VAL = SExtVAL >> ShiftAmt;
    clearUnusedBits();
    return;
  }
  ashrSlowCase(ShiftAmt);
}

/// Logical right-shift function.
///
/// Logical right-shift this APInt by shiftAmt.
APInt lshr(unsigned shiftAmt) const {
  APInt R(*this);
  R.lshrInPlace(shiftAmt);
  return R;
}

/// Logical right-shift this APInt by ShiftAmt in place.
void lshrInPlace(unsigned ShiftAmt) {
  assert(ShiftAmt <= BitWidth && "Invalid shift amount")((ShiftAmt <= BitWidth && "Invalid shift amount") ?
 static_cast<void> (0) : __assert_fail ("ShiftAmt <= BitWidth && \"Invalid shift amount\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 995, __PRETTY_FUNCTION__));
  if (isSingleWord()) {
    if (ShiftAmt == BitWidth)
      U.VAL = 0;
    else
      U.VAL >>= ShiftAmt;
    return;
  }
  lshrSlowCase(ShiftAmt);
}

/// Left-shift function.
///
/// Left-shift this APInt by shiftAmt.
APInt shl(unsigned shiftAmt) const {
  APInt R(*this);
  R <<= shiftAmt;
  return R;
}

/// Rotate left by rotateAmt.
APInt rotl(unsigned rotateAmt) const;

/// Rotate right by rotateAmt.
APInt rotr(unsigned rotateAmt) const;

/// Arithmetic right-shift function.
///
/// Arithmetic right-shift this APInt by shiftAmt.
APInt ashr(const APInt &ShiftAmt) const {
  APInt R(*this);
  R.ashrInPlace(ShiftAmt);
  return R;
}

/// Arithmetic right-shift this APInt by shiftAmt in place.
void ashrInPlace(const APInt &shiftAmt);

/// Logical right-shift function.
///
/// Logical right-shift this APInt by shiftAmt.
APInt lshr(const APInt &ShiftAmt) const {
  APInt R(*this);
  R.lshrInPlace(ShiftAmt);
  return R;
}

/// Logical right-shift this APInt by ShiftAmt in place.
void lshrInPlace(const APInt &ShiftAmt);

/// Left-shift function.
///
/// Left-shift this APInt by shiftAmt.
APInt shl(const APInt &ShiftAmt) const {
  APInt R(*this);
  R <<= ShiftAmt;
  return R;
}

/// Rotate left by rotateAmt.
APInt rotl(const APInt &rotateAmt) const;

/// Rotate right by rotateAmt.
APInt rotr(const APInt &rotateAmt) const;

/// Unsigned division operation.
///
/// Perform an unsigned divide operation on this APInt by RHS. Both this and
/// RHS are treated as unsigned quantities for purposes of this division.
///
/// \returns a new APInt value containing the division result, rounded towards
/// zero.
APInt udiv(const APInt &RHS) const;
APInt udiv(uint64_t RHS) const;

/// Signed division function for APInt.
///
/// Signed divide this APInt by APInt RHS.
///
/// The result is rounded towards zero.
APInt sdiv(const APInt &RHS) const;
APInt sdiv(int64_t RHS) const;

/// Unsigned remainder operation.
///
/// Perform an unsigned remainder operation on this APInt with RHS being the
/// divisor. Both this and RHS are treated as unsigned quantities for purposes
/// of this operation. Note that this is a true remainder operation and not a
/// modulo operation because the sign follows the sign of the dividend which
/// is *this.
///
/// \returns a new APInt value containing the remainder result
APInt urem(const APInt &RHS) const;
uint64_t urem(uint64_t RHS) const;

/// Function for signed remainder operation.
///
/// Signed remainder operation on APInt.
APInt srem(const APInt &RHS) const;
int64_t srem(int64_t RHS) const;

/// Dual division/remainder interface.
///
/// Sometimes it is convenient to divide two APInt values and obtain both the
/// quotient and remainder. This function does both operations in the same
/// computation making it a little more efficient. The pair of input arguments
/// may overlap with the pair of output arguments. It is safe to call
/// udivrem(X, Y, X, Y), for example.
static void udivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
                    APInt &Remainder);
static void udivrem(const APInt &LHS, uint64_t RHS, APInt &Quotient,
                    uint64_t &Remainder);

static void sdivrem(const APInt &LHS, const APInt &RHS, APInt &Quotient,
                    APInt &Remainder);
static void sdivrem(const APInt &LHS, int64_t RHS, APInt &Quotient,
                    int64_t &Remainder);

// Operations that return overflow indicators.
APInt sadd_ov(const APInt &RHS, bool &Overflow) const;
APInt uadd_ov(const APInt &RHS, bool &Overflow) const;
APInt ssub_ov(const APInt &RHS, bool &Overflow) const;
APInt usub_ov(const APInt &RHS, bool &Overflow) const;
APInt sdiv_ov(const APInt &RHS, bool &Overflow) const;
APInt smul_ov(const APInt &RHS, bool &Overflow) const;
APInt umul_ov(const APInt &RHS, bool &Overflow) const;
APInt sshl_ov(const APInt &Amt, bool &Overflow) const;
APInt ushl_ov(const APInt &Amt, bool &Overflow) const;

// Operations that saturate
APInt sadd_sat(const APInt &RHS) const;
APInt uadd_sat(const APInt &RHS) const;
APInt ssub_sat(const APInt &RHS) const;
APInt usub_sat(const APInt &RHS) const;
APInt smul_sat(const APInt &RHS) const;
APInt umul_sat(const APInt &RHS) const;
APInt sshl_sat(const APInt &RHS) const;
APInt ushl_sat(const APInt &RHS) const;

/// Array-indexing support.
///
/// \returns the bit value at bitPosition
bool operator[](unsigned bitPosition) const {
  assert(bitPosition < getBitWidth() && "Bit position out of bounds!")((bitPosition < getBitWidth() && "Bit position out of bounds!"
) ? static_cast<void> (0) : __assert_fail ("bitPosition < getBitWidth() && \"Bit position out of bounds!\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1138, __PRETTY_FUNCTION__));
  return (maskBit(bitPosition) & getWord(bitPosition)) != 0;
}

/// @}
/// \name Comparison Operators
/// @{

/// Equality operator.
///
/// Compares this APInt with RHS for the validity of the equality
/// relationship.
bool operator==(const APInt &RHS) const {
  assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths")((BitWidth == RHS.BitWidth && "Comparison requires equal bit widths"
) ? static_cast<void> (0) : __assert_fail ("BitWidth == RHS.BitWidth && \"Comparison requires equal bit widths\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1151, __PRETTY_FUNCTION__));
  if (isSingleWord())
    return U.VAL == RHS.U.VAL;
  return EqualSlowCase(RHS);
}

/// Equality operator.
///
/// Compares this APInt with a uint64_t for the validity of the equality
/// relationship.
///
/// \returns true if *this == Val
bool operator==(uint64_t Val) const {
  return (isSingleWord() || getActiveBits() <= 64) && getZExtValue() == Val;
}

/// Equality comparison.
///
/// Compares this APInt with RHS for the validity of the equality
/// relationship.
///
/// \returns true if *this == Val
bool eq(const APInt &RHS) const { return (*this) == RHS; }

/// Inequality operator.
///
/// Compares this APInt with RHS for the validity of the inequality
/// relationship.
///
/// \returns true if *this != Val
bool operator!=(const APInt &RHS) const { return !((*this) == RHS); }

/// Inequality operator.
///
/// Compares this APInt with a uint64_t for the validity of the inequality
/// relationship.
///
/// \returns true if *this != Val
bool operator!=(uint64_t Val) const { return !((*this) == Val); }

/// Inequality comparison
///
/// Compares this APInt with RHS for the validity of the inequality
/// relationship.
///
/// \returns true if *this != Val
bool ne(const APInt &RHS) const { return !((*this) == RHS); }

/// Unsigned less than comparison
///
/// Regards both *this and RHS as unsigned quantities and compares them for
/// the validity of the less-than relationship.
///
/// \returns true if *this < RHS when both are considered unsigned.
bool ult(const APInt &RHS) const { return compare(RHS) < 0; }

/// Unsigned less than comparison
///
/// Regards both *this as an unsigned quantity and compares it with RHS for
/// the validity of the less-than relationship.
///
/// \returns true if *this < RHS when considered unsigned.
bool ult(uint64_t RHS) const {
  // Only need to check active bits if not a single word.
  return (isSingleWord() || getActiveBits() <= 64) && getZExtValue() < RHS;
}

/// Signed less than comparison
///
/// Regards both *this and RHS as signed quantities and compares them for
/// validity of the less-than relationship.
///
/// \returns true if *this < RHS when both are considered signed.
bool slt(const APInt &RHS) const { return compareSigned(RHS) < 0; }

/// Signed less than comparison
///
/// Regards both *this as a signed quantity and compares it with RHS for
/// the validity of the less-than relationship.
///
/// \returns true if *this < RHS when considered signed.
bool slt(int64_t RHS) const {
  return (!isSingleWord() && getMinSignedBits() > 64) ? isNegative()
                                                      : getSExtValue() < RHS;
}

/// Unsigned less or equal comparison
///
/// Regards both *this and RHS as unsigned quantities and compares them for
/// validity of the less-or-equal relationship.
///
/// \returns true if *this <= RHS when both are considered unsigned.
bool ule(const APInt &RHS) const { return compare(RHS) <= 0; }

/// Unsigned less or equal comparison
///
/// Regards both *this as an unsigned quantity and compares it with RHS for
/// the validity of the less-or-equal relationship.
///
/// \returns true if *this <= RHS when considered unsigned.
bool ule(uint64_t RHS) const { return !ugt(RHS); }

/// Signed less or equal comparison
///
/// Regards both *this and RHS as signed quantities and compares them for
/// validity of the less-or-equal relationship.
///
/// \returns true if *this <= RHS when both are considered signed.
bool sle(const APInt &RHS) const { return compareSigned(RHS) <= 0; }

/// Signed less or equal comparison
///
/// Regards both *this as a signed quantity and compares it with RHS for the
/// validity of the less-or-equal relationship.
///
/// \returns true if *this <= RHS when considered signed.
bool sle(uint64_t RHS) const { return !sgt(RHS); }

/// Unsigned greater than comparison
///
/// Regards both *this and RHS as unsigned quantities and compares them for
/// the validity of the greater-than relationship.
///
/// \returns true if *this > RHS when both are considered unsigned.
bool ugt(const APInt &RHS) const { return !ule(RHS); }

/// Unsigned greater than comparison
///
/// Regards both *this as an unsigned quantity and compares it with RHS for
/// the validity of the greater-than relationship.
///
/// \returns true if *this > RHS when considered unsigned.
bool ugt(uint64_t RHS) const {
  // Only need to check active bits if not a single word.
  return (!isSingleWord() && getActiveBits() > 64) || getZExtValue() > RHS;
}

/// Signed greater than comparison
///
/// Regards both *this and RHS as signed quantities and compares them for the
/// validity of the greater-than relationship.
///
/// \returns true if *this > RHS when both are considered signed.
bool sgt(const APInt &RHS) const { return !sle(RHS); }

/// Signed greater than comparison
///
/// Regards both *this as a signed quantity and compares it with RHS for
/// the validity of the greater-than relationship.
///
/// \returns true if *this > RHS when considered signed.
bool sgt(int64_t RHS) const {
  return (!isSingleWord() && getMinSignedBits() > 64) ? !isNegative()
                                                      : getSExtValue() > RHS;
}

/// Unsigned greater or equal comparison
///
/// Regards both *this and RHS as unsigned quantities and compares them for
/// validity of the greater-or-equal relationship.
///
/// \returns true if *this >= RHS when both are considered unsigned.
bool uge(const APInt &RHS) const { return !ult(RHS); }

/// Unsigned greater or equal comparison
///
/// Regards both *this as an unsigned quantity and compares it with RHS for
/// the validity of the greater-or-equal relationship.
///
/// \returns true if *this >= RHS when considered unsigned.
bool uge(uint64_t RHS) const { return !ult(RHS); }

/// Signed greater or equal comparison
///
/// Regards both *this and RHS as signed quantities and compares them for
/// validity of the greater-or-equal relationship.
///
/// \returns true if *this >= RHS when both are considered signed.
bool sge(const APInt &RHS) const { return !slt(RHS); }

/// Signed greater or equal comparison
///
/// Regards both *this as a signed quantity and compares it with RHS for
/// the validity of the greater-or-equal relationship.
///
/// \returns true if *this >= RHS when considered signed.
bool sge(int64_t RHS) const { return !slt(RHS); }

/// This operation tests if there are any pairs of corresponding bits
/// between this APInt and RHS that are both set.
bool intersects(const APInt &RHS) const {
  assert(BitWidth == RHS.BitWidth && "Bit widths must be the same")((BitWidth == RHS.BitWidth && "Bit widths must be the same"
) ? static_cast<void> (0) : __assert_fail ("BitWidth == RHS.BitWidth && \"Bit widths must be the same\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1342, __PRETTY_FUNCTION__));
  if (isSingleWord())
    return (U.VAL & RHS.U.VAL) != 0;
  return intersectsSlowCase(RHS);
}

/// This operation checks that all bits set in this APInt are also set in RHS.
bool isSubsetOf(const APInt &RHS) const {
  assert(BitWidth == RHS.BitWidth && "Bit widths must be the same")((BitWidth == RHS.BitWidth && "Bit widths must be the same"
) ? static_cast<void> (0) : __assert_fail ("BitWidth == RHS.BitWidth && \"Bit widths must be the same\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1350, __PRETTY_FUNCTION__));
  if (isSingleWord())
    return (U.VAL & ~RHS.U.VAL) == 0;
  return isSubsetOfSlowCase(RHS);
}

/// @}
/// \name Resizing Operators
/// @{

/// Truncate to new width.
///
/// Truncate the APInt to a specified width. It is an error to specify a width
/// that is greater than or equal to the current width.
APInt trunc(unsigned width) const;

/// Truncate to new width with unsigned saturation.
///
/// If the APInt, treated as unsigned integer, can be losslessly truncated to
/// the new bitwidth, then return truncated APInt. Else, return max value.
APInt truncUSat(unsigned width) const;

/// Truncate to new width with signed saturation.
///
/// If this APInt, treated as signed integer, can be losslessly truncated to
/// the new bitwidth, then return truncated APInt. Else, return either
/// signed min value if the APInt was negative, or signed max value.
APInt truncSSat(unsigned width) const;

/// Sign extend to a new width.
///
/// This operation sign extends the APInt to a new width. If the high order
/// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
/// It is an error to specify a width that is less than or equal to the
/// current width.
APInt sext(unsigned width) const;

/// Zero extend to a new width.
///
/// This operation zero extends the APInt to a new width. The high order bits
/// are filled with 0 bits.  It is an error to specify a width that is less
/// than or equal to the current width.
APInt zext(unsigned width) const;

/// Sign extend or truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is sign
/// extended, truncated, or left alone to make it that width.
APInt sextOrTrunc(unsigned width) const;

/// Zero extend or truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is zero
/// extended, truncated, or left alone to make it that width.
APInt zextOrTrunc(unsigned width) const;

/// Truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is
/// truncated or left alone to make it that width.
APInt truncOrSelf(unsigned width) const;

/// Sign extend or truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is sign
/// extended, or left alone to make it that width.
APInt sextOrSelf(unsigned width) const;

/// Zero extend or truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is zero
/// extended, or left alone to make it that width.
APInt zextOrSelf(unsigned width) const;

/// @}
/// \name Bit Manipulation Operators
/// @{

/// Set every bit to 1.
void setAllBits() {
  if (isSingleWord())
    U.VAL = WORDTYPE_MAX;
  else
    // Set all the bits in all the words.
    memset(U.pVal, -1, getNumWords() * APINT_WORD_SIZE);
  // Clear the unused ones
  clearUnusedBits();
}

/// Set a given bit to 1.
///
/// Set the given bit to 1 whose position is given as "bitPosition".
void setBit(unsigned BitPosition) {
  assert(BitPosition < BitWidth && "BitPosition out of range")((BitPosition < BitWidth && "BitPosition out of range"
) ? static_cast<void> (0) : __assert_fail ("BitPosition < BitWidth && \"BitPosition out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1443, __PRETTY_FUNCTION__));
  WordType Mask = maskBit(BitPosition);
  if (isSingleWord())
    U.VAL |= Mask;
  else
    U.pVal[whichWord(BitPosition)] |= Mask;
}

/// Set the sign bit to 1.
void setSignBit() {
  setBit(BitWidth - 1);
}

/// Set a given bit to a given value.
void setBitVal(unsigned BitPosition, bool BitValue) {
  if (BitValue)
    setBit(BitPosition);
  else
    clearBit(BitPosition);
}

/// Set the bits from loBit (inclusive) to hiBit (exclusive) to 1.
/// This function handles "wrap" case when \p loBit >= \p hiBit, and calls
/// setBits when \p loBit < \p hiBit.
/// For \p loBit == \p hiBit wrap case, set every bit to 1.
void setBitsWithWrap(unsigned loBit, unsigned hiBit) {
  assert(hiBit <= BitWidth && "hiBit out of range")((hiBit <= BitWidth && "hiBit out of range") ? static_cast
<void> (0) : __assert_fail ("hiBit <= BitWidth && \"hiBit out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1469, __PRETTY_FUNCTION__));
  assert(loBit <= BitWidth && "loBit out of range")((loBit <= BitWidth && "loBit out of range") ? static_cast
<void> (0) : __assert_fail ("loBit <= BitWidth && \"loBit out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1470, __PRETTY_FUNCTION__));
  if (loBit < hiBit) {
    setBits(loBit, hiBit);
    return;
  }
  setLowBits(hiBit);
  setHighBits(BitWidth - loBit);
}

/// Set the bits from loBit (inclusive) to hiBit (exclusive) to 1.
/// This function handles case when \p loBit <= \p hiBit.
void setBits(unsigned loBit, unsigned hiBit) {
  assert(hiBit <= BitWidth && "hiBit out of range")((hiBit <= BitWidth && "hiBit out of range") ? static_cast
<void> (0) : __assert_fail ("hiBit <= BitWidth && \"hiBit out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1482, __PRETTY_FUNCTION__));
  assert(loBit <= BitWidth && "loBit out of range")((loBit <= BitWidth && "loBit out of range") ? static_cast
<void> (0) : __assert_fail ("loBit <= BitWidth && \"loBit out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1483, __PRETTY_FUNCTION__));
  assert(loBit <= hiBit && "loBit greater than hiBit")((loBit <= hiBit && "loBit greater than hiBit") ? static_cast
<void> (0) : __assert_fail ("loBit <= hiBit && \"loBit greater than hiBit\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1484, __PRETTY_FUNCTION__));
  if (loBit == hiBit)
    return;
  if (loBit < APINT_BITS_PER_WORD && hiBit <= APINT_BITS_PER_WORD) {
    uint64_t mask = WORDTYPE_MAX >> (APINT_BITS_PER_WORD - (hiBit - loBit));
    mask <<= loBit;
    if (isSingleWord())
      U.VAL |= mask;
    else
      U.pVal[0] |= mask;
  } else {
    setBitsSlowCase(loBit, hiBit);
  }
}

/// Set the top bits starting from loBit.
void setBitsFrom(unsigned loBit) {
  return setBits(loBit, BitWidth);
}

/// Set the bottom loBits bits.
void setLowBits(unsigned loBits) {
  return setBits(0, loBits);
}

/// Set the top hiBits bits.
void setHighBits(unsigned hiBits) {
  return setBits(BitWidth - hiBits, BitWidth);
}

/// Set every bit to 0.
void clearAllBits() {
  if (isSingleWord())
    U.VAL = 0;
  else
    memset(U.pVal, 0, getNumWords() * APINT_WORD_SIZE);
}

/// Set a given bit to 0.
///
/// Set the given bit to 0 whose position is given as "bitPosition".
void clearBit(unsigned BitPosition) {
  assert(BitPosition < BitWidth && "BitPosition out of range")((BitPosition < BitWidth && "BitPosition out of range"
) ? static_cast<void> (0) : __assert_fail ("BitPosition < BitWidth && \"BitPosition out of range\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1526, __PRETTY_FUNCTION__));
  WordType Mask = ~maskBit(BitPosition);
  if (isSingleWord())
    U.VAL &= Mask;
  else
    U.pVal[whichWord(BitPosition)] &= Mask;
}

/// Set bottom loBits bits to 0.
void clearLowBits(unsigned loBits) {
  assert(loBits <= BitWidth && "More bits than bitwidth")((loBits <= BitWidth && "More bits than bitwidth")
 ? static_cast<void> (0) : __assert_fail ("loBits <= BitWidth && \"More bits than bitwidth\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1536, __PRETTY_FUNCTION__));
  APInt Keep = getHighBitsSet(BitWidth, BitWidth - loBits);
  *this &= Keep;
}

/// Set the sign bit to 0.
void clearSignBit() {
  clearBit(BitWidth - 1);
}

/// Toggle every bit to its opposite value.
void flipAllBits() {
  if (isSingleWord()) {
    U.VAL ^= WORDTYPE_MAX;
    clearUnusedBits();
  } else {
    flipAllBitsSlowCase();
  }
}

/// Toggles a given bit to its opposite value.
///
/// Toggle a given bit to its opposite value whose position is given
/// as "bitPosition".
void flipBit(unsigned bitPosition);

/// Negate this APInt in place.
void negate() {
  flipAllBits();
  ++(*this);
}

/// Insert the bits from a smaller APInt starting at bitPosition.
void insertBits(const APInt &SubBits, unsigned bitPosition);
void insertBits(uint64_t SubBits, unsigned bitPosition, unsigned numBits);

/// Return an APInt with the extracted bits [bitPosition,bitPosition+numBits).
APInt extractBits(unsigned numBits, unsigned bitPosition) const;
uint64_t extractBitsAsZExtValue(unsigned numBits, unsigned bitPosition) const;

/// @}
/// \name Value Characterization Functions
/// @{

/// Return the number of bits in the APInt.
unsigned getBitWidth() const { return BitWidth; }

/// Get the number of words.
///
/// Here one word's bitwidth equals to that of uint64_t.
///
/// \returns the number of words to hold the integer value of this APInt.
unsigned getNumWords() const { return getNumWords(BitWidth); }

/// Get the number of words.
///
/// *NOTE* Here one word's bitwidth equals to that of uint64_t.
///
/// \returns the number of words to hold the integer value with a given bit
/// width.
static unsigned getNumWords(unsigned BitWidth) {
  return ((uint64_t)BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
}

/// Compute the number of active bits in the value
///
/// This function returns the number of active bits which is defined as the
/// bit width minus the number of leading zeros. This is used in several
/// computations to see how "wide" the value is.
unsigned getActiveBits() const { return BitWidth - countLeadingZeros(); }

/// Compute the number of active words in the value of this APInt.
///
/// This is used in conjunction with getActiveData to extract the raw value of
/// the APInt.
unsigned getActiveWords() const {
  unsigned numActiveBits = getActiveBits();
  return numActiveBits ? whichWord(numActiveBits - 1) + 1 : 1;
}

/// Get the minimum bit size for this signed APInt
///
/// Computes the minimum bit width for this APInt while considering it to be a
/// signed (and probably negative) value. If the value is not negative, this
/// function returns the same value as getActiveBits()+1. Otherwise, it
/// returns the smallest bit width that will retain the negative value. For
/// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
/// for -1, this function will always return 1.
unsigned getMinSignedBits() const { return BitWidth - getNumSignBits() + 1; }

/// Get zero extended value
///
/// This method attempts to return the value of this APInt as a zero extended
/// uint64_t. The bitwidth must be <= 64 or the value must fit within a
/// uint64_t. Otherwise an assertion will result.
uint64_t getZExtValue() const {
  if (isSingleWord())
    return U.VAL;
  assert(getActiveBits() <= 64 && "Too many bits for uint64_t")((getActiveBits() <= 64 && "Too many bits for uint64_t"
) ? static_cast<void> (0) : __assert_fail ("getActiveBits() <= 64 && \"Too many bits for uint64_t\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1634, __PRETTY_FUNCTION__));
  return U.pVal[0];
}

/// Get sign extended value
///
/// This method attempts to return the value of this APInt as a sign extended
/// int64_t. The bit width must be <= 64 or the value must fit within an
/// int64_t. Otherwise an assertion will result.
int64_t getSExtValue() const {
  if (isSingleWord())
    return SignExtend64(U.VAL, BitWidth);
  assert(getMinSignedBits() <= 64 && "Too many bits for int64_t")((getMinSignedBits() <= 64 && "Too many bits for int64_t"
) ? static_cast<void> (0) : __assert_fail ("getMinSignedBits() <= 64 && \"Too many bits for int64_t\""
, "/build/llvm-toolchain-snapshot-12~++20201205111132+f8afba5f7a2/llvm/include/llvm/ADT/APInt.h"
, 1646, __PRETTY_FUNCTION__));
  return int64_t(U.pVal[0]);
}

/// Get bits required for string value.
///
/// This method determines how many bits are required to hold the APInt
/// equivalent of the string given by \p str.
static unsigned getBitsNeeded(StringRef str, uint8_t radix);

/// The APInt version of the countLeadingZeros functions in
///   MathExtras.h.
///
/// It counts the number of zeros from the most significant bit to the first
/// one bit.
///
/// \returns BitWidth if the value is zero, otherwise returns the number of
///   zeros from the most significant bit to the first one bits.
unsigned countLeadingZeros() const {
  if (isSingleWord()) {
    unsigned unusedBits = APINT_BITS_PER_WORD - BitWidth;
    return llvm::countLeadingZeros(U.VAL) - unusedBits;
  }
  return countLeadingZerosSlowCase();
}

/// Count the number of leading one bits.
///
/// This function is an APInt version of the countLeadingOnes
/// functions in MathExtras.h. It counts the number of ones from the most
/// significant bit to the first zero bit.
///
/// \returns 0 if the high order bit is not set, otherwise returns the number
/// of 1 bits from the most significant to the least
unsigned countLeadingOnes() const {
  if (isSingleWord())
    return llvm::countLeadingOnes(U.VAL << (APINT_BITS_PER_WORD - BitWidth));
  return countLeadingOnesSlowCase();
}

/// Computes the number of leading bits of this APInt that are equal to its
/// sign bit.
unsigned getNumSignBits() const {
  return isNegative() ? countLeadingOnes() : countLeadingZeros();
}

/// Count the number of trailing zero bits.
///
/// This function is an APInt version of the countTrailingZeros
/// functions in MathExtras.h. It counts the number of zeros from the least
/// significant bit to the first set bit.
///
/// \returns BitWidth if the value is zero, otherwise returns the number of
/// zeros from the least significant bit to the first one bit.
unsigned countTrailingZeros() const {
  if (isSingleWord())
    return std::min(unsigned(llvm::countTrailingZeros(U.VAL)), BitWidth);
  return countTrailingZerosSlowCase();
}

/// Count the number of trailing one bits.
///
/// This function is an APInt version of the countTrailingOnes
/// functions in MathExtras.h. It counts the number of ones from the least
/// significant bit to the first zero bit.
///
/// \returns BitWidth if the value is all ones, otherwise returns the number
/// of ones from the least significant bit to the first zero bit.
unsigned countTrailingOnes() const {
  if (isSingleWord())
    return llvm::countTrailingOnes(U.VAL);
  return countTrailingOnesSlowCase();
}

/// Count the number of bits set.
///
/// This function is an APInt version of the countPopulation functions
/// in MathExtras.h. It counts the number of 1 bits in the APInt value.
///
/// \returns 0 if the value is zero, otherwise returns the number of set bits.
unsigned countPopulation() const {
  if (isSingleWord())
    return llvm::countPopulation(U.VAL);
  return countPopulationSlowCase();
}

/// @}
/// \name Conversion Functions
/// @{
void print(raw_ostream &OS, bool isSigned) const;

/// Converts an APInt to a string and append it to Str.  Str is commonly a
/// SmallString.
void toString(SmallVectorImpl<char> &Str, unsigned Radix, bool Signed,
              bool formatAsCLiteral = false) const;

/// Considers the APInt to be unsigned and converts it into a string in the
/// radix given. The radix can be 2, 8, 10 16, or 36.
void toStringUnsigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
  toString(Str, Radix, false, false);
}

/// Considers the APInt to be signed and converts it into a string in the
/// radix given. The radix can be 2, 8, 10, 16, or 36.
void toStringSigned(SmallVectorImpl<char> &Str, unsigned Radix = 10) const {
  toString(Str, Radix, true, false);
}

/// Return the APInt as a std::string.
///
/// Note that this is an inefficient method.  It is better to pass in a
/// SmallVector/SmallString to the methods above to avoid thrashing the heap
/// for the string.
std::string toString(unsigned Radix, bool Signed) const;

/// \returns a byte-swapped representation of this APInt Value.
APInt byteSwap() const;

/// \returns the value with the bit representation reversed of this APInt
/// Value.
APInt reverseBits() const;

/// Converts this APInt to a double value.
double roundToDouble(bool isSigned) const;

/// Converts this unsigned APInt to a double value.
double roundToDouble() const { return roundToDouble(false); }

/// Converts this signed APInt to a double value.
double signedRoundToDouble() const { return roundToDouble(true); }

/// Converts APInt bits to a double
///
/// The conversion does not do a translation from integer to double, it just
/// re-interprets the bits as a double. Note that it is valid to do this on
/// any bit width. Exactly 64 bits will be translated.
double bitsToDouble() const {
  return BitsToDouble(getWord(0));
}

/// Converts APInt bits to a float
///
/// The conversion does not do a translation from integer to float, it just
/// re-interprets the bits as a float. Note that it is valid to do this on
/// any bit width. Exactly 32 bits will be translated.
float bitsToFloat() const {
  return BitsToFloat(static_cast<uint32_t>(getWord(0)));
}

/// Converts a double to APInt bits.
///
/// The conversion does not do a translation from double to integer, it just
/// re-interprets the bits of the double.
static APInt doubleToBits(double V) {
  return APInt(sizeof(double) * CHAR_BIT8, DoubleToBits(V));
}

/// Converts a float to APInt bits.
///
/// The conversion does not do a translation from float to integer, it just
/// re-interprets the bits of the float.
static APInt floatToBits(float V) {
  return APInt(sizeof(float) * CHAR_BIT8, FloatToBits(V));
}

/// @}
/// \name Mathematics Operations
/// @{

/// \returns the floor log base 2 of this APInt.
unsigned logBase2() const { return getActiveBits() -  1; }

/// \returns the ceil log base 2 of this APInt.
unsigned ceilLogBase2() const {
  APInt temp(*this);
  --temp;
  return temp.getActiveBits();
}

/// \returns the nearest log base 2 of this APInt. Ties round up.
///
/// NOTE: When we have a BitWidth of 1, we define:
///
///   log2(0) = UINT32_MAX
///   log2(1) = 0
///
/// to get around any mathematical concerns resulting from
/// referencing 2 in a space where 2 does no exist.
unsigned nearestLogBase2() const {
  // Special case when we have a bitwidth of 1. If VAL is 1, then we
  // get 0. If VAL is 0, we get WORDTYPE_MAX which gets truncated to
  // UINT32_MAX.
  if (BitWidth == 1)
    return U.VAL - 1;

  // Handle the zero case.
  if (isNullValue())
    return UINT32_MAX(4294967295U);

  // The non-zero case is handled by computing:
  //
  //   nearestLogBase2(x) = logBase2(x) + x[logBase2(x)-1].
  //
  // where x[i] is referring to the value of the ith bit of x.
  unsigned lg = logBase2();
  return lg + unsigned((*this)[lg - 1]);
}

/// \returns the log base 2 of this APInt if its an exact power of two, -1
/// otherwise
int32_t exactLogBase2() const {
  if (!isPowerOf2())
    return -1;
  return logBase2();
}

/// Compute the square root
APInt sqrt() const;

/// Get the absolute value;
///
/// If *this is < 0 then return -(*this), otherwise *this;
APInt abs() const {
  if (isNegative())
    return -(*this);
  return *this;
}

/// \returns the multiplicative inverse for a given modulo.
APInt multiplicativeInverse(const APInt &modulo) const;

/// @}
/// \name Support for division by constant
/// @{

/// Calculate the magic number for signed division by a constant.
struct ms;
ms magic() const;

/// Calculate the magic number for unsigned division by a constant.
struct mu;
mu magicu(unsigned LeadingZeros = 0) const;

/// @}
/// \name Building-block Operations for APInt and APFloat
/// @{

// These building block operations operate on a representation of arbitrary
// precision, two's-complement, bignum integer values. They should be
// sufficient to implement APInt and APFloat bignum requirements. Inputs are
// generally a pointer to the base of an array of integer parts, representing
// an unsigned bignum, and a count of how many parts there are.

/// Sets the least significant part of a bignum to the input value, and zeroes
/// out higher parts.
static void tcSet(WordType *, WordType, unsigned);

/// Assign one bignum to another.
static void tcAssign(WordType *, const WordType *, unsigned);

/// Returns true if a bignum is zero, false otherwise.
static bool tcIsZero(const WordType *, unsigned);

/// Extract the given bit of a bignum; returns 0 or 1.  Zero-based.
static int tcExtractBit(const WordType *, unsigned bit);

/// Copy the bit vector of width srcBITS from SRC, starting at bit srcLSB, to
/// DST, of dstCOUNT parts, such that the bit srcLSB becomes the least
/// significant bit of DST.  All high bits above srcBITS in DST are
/// zero-filled.
static void tcExtract(WordType *, unsigned dstCount,
                      const WordType *, unsigned srcBits,
                      unsigned srcLSB);

/// Set the given bit of a bignum.  Zero-based.
static void tcSetBit(WordType *, unsigned bit);

/// Clear the given bit of a bignum.  Zero-based.
static void tcClearBit(WordType *, unsigned bit);

/// Returns the bit number of the least or most significant set bit of a
/// number.  If the input number has no bits set -1U is returned.
static unsigned tcLSB(const WordType *, unsigned n);
static unsigned tcMSB(const WordType *parts, unsigned n);

/// Negate a bignum in-place.
static void tcNegate(WordType *, unsigned);

/// DST += RHS + CARRY where CARRY is zero or one.  Returns the carry flag.
static WordType tcAdd(WordType *, const WordType *,
                      WordType carry, unsigned);
/// DST += RHS.  Returns the carry flag.
static WordType tcAddPart(WordType *, WordType, unsigned);

/// DST -= RHS + CARRY where CARRY is zero or one. Returns the carry flag.
static WordType tcSubtract(WordType *, const WordType *,
                           WordType carry, unsigned);
/// DST -= RHS.  Returns the carry flag.
static WordType tcSubtractPart(WordType *, WordType, unsigned);

/// DST += SRC * MULTIPLIER + PART   if add is true
/// DST  = SRC * MULTIPLIER + PART   if add is false
///
/// Requires 0 <= DSTPARTS <= SRCPARTS + 1.  If DST overlaps SRC they must
/// start at the same point, i.e. DST == SRC.
///
/// If DSTPARTS == SRC_PARTS + 1 no overflow occurs and zero is returned.
/// Otherwise DST is filled with the least significant DSTPARTS parts of the
/// result, and if all of the omitted higher parts were zero return zero,
/// otherwise overflow occurred and return one.
static int tcMultiplyPart(WordType *dst, const WordType *src,
                          WordType multiplier, WordType carry,
                          unsigned srcParts, unsigned dstParts,
                          bool add);

/// DST = LHS * RHS, where DST has the same width as the operands and is
/// filled with the least significant parts of the result.  Returns one if
/// overflow occurred, otherwise zero.  DST must be disjoint from both
/// operands.
static int tcMultiply(WordType *, const WordType *, const WordType *,
                      unsigned);

/// DST = LHS * RHS, where DST has width the sum of the widths of the
/// operands. No overflow occurs. DST must be disjoint from both operands.
static void tcFullMultiply(WordType *, const WordType *,
                           const WordType *, unsigned, unsigned);

/// If RHS is zero LHS and REMAINDER are left unchanged, return one.
/// Otherwise set LHS to LHS / RHS with the fractional part discarded, set
/// REMAINDER to the remainder, return zero.  i.e.
///
///  OLD_LHS = RHS * LHS + REMAINDER
///
/// SCRATCH is a bignum of the same size as the operands and result for use by
/// the routine; its contents need not be initialized and are destroyed.  LHS,
/// REMAINDER and SCRATCH must be distinct.
static int tcDivide(WordType *lhs, const WordType *rhs,
                    WordType *remainder, WordType *scratch,
                    unsigned parts);

/// Shift a bignum left Count bits. Shifted in bits are zero. There are no
/// restrictions on Count.
static void tcShiftLeft(WordType *, unsigned Words, unsigned Count);

/// Shift a bignum right Count bits.  Shifted in bits are zero.  There are no
/// restrictions on Count.
static void tcShiftRight(WordType *, unsigned Words, unsigned Count);

/// The obvious AND, OR and XOR and complement operations.
static void tcAnd(WordType *, const WordType *, unsigned);
static void tcOr(WordType *, const WordType *, unsigned);
static void tcXor(WordType *, const WordType *, unsigned);
static void tcComplement(WordType *, unsigned);

/// Comparison (unsigned) of two bignums.
static int tcCompare(const WordType *, const WordType *, unsigned);

/// Increment a bignum in-place.  Return the carry flag.
static WordType tcIncrement(WordType *dst, unsigned parts) {
  return tcAddPart(dst, 1, parts);
}

/// Decrement a bignum in-place.  Return the borrow flag.
static WordType tcDecrement(WordType *dst, unsigned parts) {
  return tcSubtractPart(dst, 1, parts);
}

/// Set the least significant BITS and clear the rest.
static void tcSetLeastSignificantBits(WordType *, unsigned, unsigned bits);

/// debug method
void dump() const;

/// @}
2020};

2022/// Magic data for optimising signed division by a constant.
2023struct APInt::ms {
APInt m;    ///< magic number
unsigned s; ///< shift amount
2026};

2028/// Magic data for optimising unsigned division by a constant.
2029struct APInt::mu {
APInt m;    ///< magic number
bool a;     ///< add indicator
unsigned s; ///< shift amount
2033};

2035inline bool operator==(uint64_t V1, const APInt &V2) { return V2 == V1; }

2037inline bool operator!=(uint64_t V1, const APInt &V2) { return V2 != V1; }

2039/// Unary bitwise complement operator.
2040///
2041/// \returns an APInt that is the bitwise complement of \p v.
2042inline APInt operator~(APInt v) {
v.flipAllBits();
return v;
2045}

2047inline APInt operator&(APInt a, const APInt &b) {
a &= b;
return a;
2050}

2052inline APInt operator&(const APInt &a, APInt &&b) {
b &= a;
return std::move(b);
2055}

2057inline APInt operator&(APInt a, uint64_t RHS) {
a &= RHS;
return a;
2060}

2062inline APInt operator&(uint64_t LHS, APInt b) {
b &= LHS;
return b;
2065}

2067inline APInt operator|(APInt a, const APInt &b) {
a |= b;
return a;
2070}

2072inline APInt operator|(const APInt &a, APInt &&b) {
b |= a;
return std::move(b);
2075}

2077inline APInt operator|(APInt a, uint64_t RHS) {
a |= RHS;
return a;
2080}

2082inline APInt operator|(uint64_t LHS, APInt b) {
b |= LHS;
return b;
2085}

2087inline APInt operator^(APInt a, const APInt &b) {
a ^= b;
return a;
2090}

2092inline APInt operator^(const APInt &a, APInt &&b) {
b ^= a;
return std::move(b);
2095}

2097inline APInt operator^(APInt a, uint64_t RHS) {
a ^= RHS;
return a;
2100}

2102inline APInt operator^(uint64_t LHS, APInt b) {
b ^= LHS;
return b;
2105}

2107inline raw_ostream &operator<<(raw_ostream &OS, const APInt &I) {
I.print(OS, true);
return OS;
2110}

2112inline APInt operator-(APInt v) {
v.negate();
return v;
2115}

2117inline APInt operator+(APInt a, const APInt &b) {
a += b;
return a;
2120}

2122inline APInt operator+(const APInt &a, APInt &&b) {
b += a;
return std::move(b);
2125}

2127inline APInt operator+(APInt a, uint64_t RHS) {
a += RHS;
return a;
2130}

2132inline APInt operator+(uint64_t LHS, APInt b) {
b += LHS;
return b;
2135}

2137inline APInt operator-(APInt a, const APInt &b) {
a -= b;
return a;
2140}

2142inline APInt operator-(const APInt &a, APInt &&b) {
b.negate();
b += a;
return std::move(b);
2146}

2148inline APInt operator-(APInt a, uint64_t RHS) {
a -= RHS;
return a;
2151}

2153inline APInt operator-(uint64_t LHS, APInt b) {
b.negate();
b += LHS;
return b;
2157}

2159inline APInt operator*(APInt a, uint64_t RHS) {
a *= RHS;
return a;
2162}

2164inline APInt operator*(uint64_t LHS, APInt b) {
b *= LHS;
return b;
2167}


2170namespace APIntOps {

2172/// Determine the smaller of two APInts considered to be signed.
2173inline const APInt &smin(const APInt &A, const APInt &B) {
return A.slt(B) ? A : B;
2175}

2177/// Determine the larger of two APInts considered to be signed.
2178inline const APInt &smax(const APInt &A, const APInt &B) {
return A.sgt(B) ? A : B;
2180}

2182/// Determine the smaller of two APInts considered to be signed.
2183inline const APInt &umin(const APInt &A, const APInt &B) {
return A.ult(B) ? A : B;
2185}

2187/// Determine the larger of two APInts considered to be unsigned.
2188inline const APInt &umax(const APInt &A, const APInt &B) {
return A.ugt(B) ? A : B;
2190}

2192/// Compute GCD of two unsigned APInt values.
2193///
2194/// This function returns the greatest common divisor of the two APInt values
2195/// using Stein's algorithm.
2196///
2197/// \returns the greatest common divisor of A and B.
2198APInt GreatestCommonDivisor(APInt A, APInt B);

2200/// Converts the given APInt to a double value.
2201///
2202/// Treats the APInt as an unsigned value for conversion purposes.
2203inline double RoundAPIntToDouble(const APInt &APIVal) {
return APIVal.roundToDouble();
2205}

2207/// Converts the given APInt to a double value.
2208///
2209/// Treats the APInt as a signed value for conversion purposes.
2210inline double RoundSignedAPIntToDouble(const APInt &APIVal) {
return APIVal.signedRoundToDouble();
2212}

2214/// Converts the given APInt to a float vlalue.
2215inline float RoundAPIntToFloat(const APInt &APIVal) {
return float(RoundAPIntToDouble(APIVal));
2217}

2219/// Converts the given APInt to a float value.
2220///
2221/// Treats the APInt as a signed value for conversion purposes.
2222inline float RoundSignedAPIntToFloat(const APInt &APIVal) {
return float(APIVal.signedRoundToDouble());
2224}

2226/// Converts the given double value into a APInt.
2227///
2228/// This function convert a double value to an APInt value.
2229APInt RoundDoubleToAPInt(double Double, unsigned width);

2231/// Converts a float value into a APInt.
2232///
2233/// Converts a float value into an APInt value.
2234inline APInt RoundFloatToAPInt(float Float, unsigned width) {
return RoundDoubleToAPInt(double(Float), width);
2236}

2238/// Return A unsign-divided by B, rounded by the given rounding mode.
2239APInt RoundingUDiv(const APInt &A, const APInt &B, APInt::Rounding RM);

2241/// Return A sign-divided by B, rounded by the given rounding mode.
2242APInt RoundingSDiv(const APInt &A, const APInt &B, APInt::Rounding RM);

2244/// Let q(n) = An^2 + Bn + C, and BW = bit width of the value range
2245/// (e.g. 32 for i32).
2246/// This function finds the smallest number n, such that
2247/// (a) n >= 0 and q(n) = 0, or
2248/// (b) n >= 1 and q(n-1) and q(n), when evaluated in the set of all
2249///     integers, belong to two different intervals [Rk, Rk+R),
2250///     where R = 2^BW, and k is an integer.
2251/// The idea here is to find when q(n) "overflows" 2^BW, while at the
2252/// same time "allowing" subtraction. In unsigned modulo arithmetic a
2253/// subtraction (treated as addition of negated numbers) would always
2254/// count as an overflow, but here we want to allow values to decrease
2255/// and increase as long as they are within the same interval.
2256/// Specifically, adding of two negative numbers should not cause an
2257/// overflow (as long as the magnitude does not exceed the bit width).
2258/// On the other hand, given a positive number, adding a negative
2259/// number to it can give a negative result, which would cause the
2260/// value to go from [-2^BW, 0) to [0, 2^BW). In that sense, zero is
2261/// treated as a special case of an overflow.
2262///
2263/// This function returns None if after finding k that minimizes the
2264/// positive solution to q(n) = kR, both solutions are contained between
2265/// two consecutive integers.
2266///
2267/// There are cases where q(n) > T, and q(n+1) < T (assuming evaluation
2268/// in arithmetic modulo 2^BW, and treating the values as signed) by the
2269/// virtue of *signed* overflow. This function will *not* find such an n,
2270/// however it may find a value of n satisfying the inequalities due to
2271/// an *unsigned* overflow (if the values are treated as unsigned).
2272/// To find a solution for a signed overflow, treat it as a problem of
2273/// finding an unsigned overflow with a range with of BW-1.
2274///
2275/// The returned value may have a different bit width from the input
2276/// coefficients.
2277Optional<APInt> SolveQuadraticEquationWrap(APInt A, APInt B, APInt C,
                                         unsigned RangeWidth);

2280/// Compare two values, and if they are different, return the position of the
2281/// most significant bit that is different in the values.
2282Optional<unsigned> GetMostSignificantDifferentBit(const APInt &A,
                                                const APInt &B);

2285} // End of APIntOps namespace

2287// See friend declaration above. This additional declaration is required in
2288// order to compile LLVM with IBM xlC compiler.
2289hash_code hash_value(const APInt &Arg);

2291/// StoreIntToMemory - Fills the StoreBytes bytes of memory starting from Dst
2292/// with the integer held in IntVal.
2293void StoreIntToMemory(const APInt &IntVal, uint8_t *Dst, unsigned StoreBytes);

2295/// LoadIntFromMemory - Loads the integer stored in the LoadBytes bytes starting
2296/// from Src into IntVal, which is assumed to be wide enough and to hold zero.
2297void LoadIntFromMemory(APInt &IntVal, const uint8_t *Src, unsigned LoadBytes);

2299} // namespace llvm

2301#endif