/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/lib/Analysis/MemorySSA.cpp

Bug Summary

File:	build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/lib/Analysis/MemorySSA.cpp
Warning:	line 2068, column 5 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name MemorySSA.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 -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/build-llvm -resource-dir /usr/lib/llvm-15/lib/clang/15.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I lib/Analysis -I /build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/lib/Analysis -I include -I /build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/include -D _FORTIFY_SOURCE=2 -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-15/lib/clang/15.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -fmacro-prefix-map=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/build-llvm=build-llvm -fmacro-prefix-map=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/= -fcoverage-prefix-map=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/build-llvm=build-llvm -fcoverage-prefix-map=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/= -O3 -Wno-unused-command-line-argument -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/build-llvm -fdebug-prefix-map=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/build-llvm=build-llvm -fdebug-prefix-map=/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/= -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2022-04-20-140412-16051-1 -x c++ /build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/lib/Analysis/MemorySSA.cpp

/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/lib/Analysis/MemorySSA.cpp

→

1//===- MemorySSA.cpp - Memory SSA Builder ---------------------------------===//
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 implements the MemorySSA class.
10//
11//===----------------------------------------------------------------------===//

13#include "llvm/Analysis/MemorySSA.h"
14#include "llvm/ADT/DenseMap.h"
15#include "llvm/ADT/DenseMapInfo.h"
16#include "llvm/ADT/DenseSet.h"
17#include "llvm/ADT/DepthFirstIterator.h"
18#include "llvm/ADT/Hashing.h"
19#include "llvm/ADT/None.h"
20#include "llvm/ADT/Optional.h"
21#include "llvm/ADT/STLExtras.h"
22#include "llvm/ADT/SmallPtrSet.h"
23#include "llvm/ADT/SmallVector.h"
24#include "llvm/ADT/StringExtras.h"
25#include "llvm/ADT/iterator.h"
26#include "llvm/ADT/iterator_range.h"
27#include "llvm/Analysis/AliasAnalysis.h"
28#include "llvm/Analysis/CFGPrinter.h"
29#include "llvm/Analysis/IteratedDominanceFrontier.h"
30#include "llvm/Analysis/MemoryLocation.h"
31#include "llvm/Config/llvm-config.h"
32#include "llvm/IR/AssemblyAnnotationWriter.h"
33#include "llvm/IR/BasicBlock.h"
34#include "llvm/IR/Dominators.h"
35#include "llvm/IR/Function.h"
36#include "llvm/IR/Instruction.h"
37#include "llvm/IR/Instructions.h"
38#include "llvm/IR/IntrinsicInst.h"
39#include "llvm/IR/LLVMContext.h"
40#include "llvm/IR/Operator.h"
41#include "llvm/IR/PassManager.h"
42#include "llvm/IR/Use.h"
43#include "llvm/InitializePasses.h"
44#include "llvm/Pass.h"
45#include "llvm/Support/AtomicOrdering.h"
46#include "llvm/Support/Casting.h"
47#include "llvm/Support/CommandLine.h"
48#include "llvm/Support/Compiler.h"
49#include "llvm/Support/Debug.h"
50#include "llvm/Support/ErrorHandling.h"
51#include "llvm/Support/FormattedStream.h"
52#include "llvm/Support/GraphWriter.h"
53#include "llvm/Support/raw_ostream.h"
54#include <algorithm>
55#include <cassert>
56#include <iterator>
57#include <memory>
58#include <utility>

60using namespace llvm;

62#define DEBUG_TYPE"memoryssa" "memoryssa"

64static cl::opt<std::string>
  DotCFGMSSA("dot-cfg-mssa",
             cl::value_desc("file name for generated dot file"),
             cl::desc("file name for generated dot file"), cl::init(""));

69INITIALIZE_PASS_BEGIN(MemorySSAWrapperPass, "memoryssa", "Memory SSA", false,static void *initializeMemorySSAWrapperPassPassOnce(PassRegistry
 &Registry) {
                    true)static void *initializeMemorySSAWrapperPassPassOnce(PassRegistry
 &Registry) {
71INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)initializeDominatorTreeWrapperPassPass(Registry);
72INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)initializeAAResultsWrapperPassPass(Registry);
73INITIALIZE_PASS_END(MemorySSAWrapperPass, "memoryssa", "Memory SSA", false,PassInfo *PI = new PassInfo( "Memory SSA", "memoryssa", &
MemorySSAWrapperPass::ID, PassInfo::NormalCtor_t(callDefaultCtor
<MemorySSAWrapperPass>), false, true); Registry.registerPass
(*PI, true); return PI; } static llvm::once_flag InitializeMemorySSAWrapperPassPassFlag
; void llvm::initializeMemorySSAWrapperPassPass(PassRegistry &
Registry) { llvm::call_once(InitializeMemorySSAWrapperPassPassFlag
, initializeMemorySSAWrapperPassPassOnce, std::ref(Registry))
; }
                  true)PassInfo *PI = new PassInfo( "Memory SSA", "memoryssa", &
MemorySSAWrapperPass::ID, PassInfo::NormalCtor_t(callDefaultCtor
<MemorySSAWrapperPass>), false, true); Registry.registerPass
(*PI, true); return PI; } static llvm::once_flag InitializeMemorySSAWrapperPassPassFlag
; void llvm::initializeMemorySSAWrapperPassPass(PassRegistry &
Registry) { llvm::call_once(InitializeMemorySSAWrapperPassPassFlag
, initializeMemorySSAWrapperPassPassOnce, std::ref(Registry))
; }

76INITIALIZE_PASS_BEGIN(MemorySSAPrinterLegacyPass, "print-memoryssa",static void *initializeMemorySSAPrinterLegacyPassPassOnce(PassRegistry
 &Registry) {
                    "Memory SSA Printer", false, false)static void *initializeMemorySSAPrinterLegacyPassPassOnce(PassRegistry
 &Registry) {
78INITIALIZE_PASS_DEPENDENCY(MemorySSAWrapperPass)initializeMemorySSAWrapperPassPass(Registry);
79INITIALIZE_PASS_END(MemorySSAPrinterLegacyPass, "print-memoryssa",PassInfo *PI = new PassInfo( "Memory SSA Printer", "print-memoryssa"
, &MemorySSAPrinterLegacyPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<MemorySSAPrinterLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeMemorySSAPrinterLegacyPassPassFlag; void
 llvm::initializeMemorySSAPrinterLegacyPassPass(PassRegistry &
Registry) { llvm::call_once(InitializeMemorySSAPrinterLegacyPassPassFlag
, initializeMemorySSAPrinterLegacyPassPassOnce, std::ref(Registry
)); }
                  "Memory SSA Printer", false, false)PassInfo *PI = new PassInfo( "Memory SSA Printer", "print-memoryssa"
, &MemorySSAPrinterLegacyPass::ID, PassInfo::NormalCtor_t
(callDefaultCtor<MemorySSAPrinterLegacyPass>), false, false
); Registry.registerPass(*PI, true); return PI; } static llvm
::once_flag InitializeMemorySSAPrinterLegacyPassPassFlag; void
 llvm::initializeMemorySSAPrinterLegacyPassPass(PassRegistry &
Registry) { llvm::call_once(InitializeMemorySSAPrinterLegacyPassPassFlag
, initializeMemorySSAPrinterLegacyPassPassOnce, std::ref(Registry
)); }

82static cl::opt<unsigned> MaxCheckLimit(
  "memssa-check-limit", cl::Hidden, cl::init(100),
  cl::desc("The maximum number of stores/phis MemorySSA"
           "will consider trying to walk past (default = 100)"));

87// Always verify MemorySSA if expensive checking is enabled.
88#ifdef EXPENSIVE_CHECKS
89bool llvm::VerifyMemorySSA = true;
90#else
91bool llvm::VerifyMemorySSA = false;
92#endif

94static cl::opt<bool, true>
  VerifyMemorySSAX("verify-memoryssa", cl::location(VerifyMemorySSA),
                   cl::Hidden, cl::desc("Enable verification of MemorySSA."));

98const static char LiveOnEntryStr[] = "liveOnEntry";

100namespace {

102/// An assembly annotator class to print Memory SSA information in
103/// comments.
104class MemorySSAAnnotatedWriter : public AssemblyAnnotationWriter {
const MemorySSA *MSSA;

107public:
MemorySSAAnnotatedWriter(const MemorySSA *M) : MSSA(M) {}

void emitBasicBlockStartAnnot(const BasicBlock *BB,
                              formatted_raw_ostream &OS) override {
  if (MemoryAccess *MA = MSSA->getMemoryAccess(BB))
    OS << "; " << *MA << "\n";
}

void emitInstructionAnnot(const Instruction *I,
                          formatted_raw_ostream &OS) override {
  if (MemoryAccess *MA = MSSA->getMemoryAccess(I))
    OS << "; " << *MA << "\n";
}
121};

123/// An assembly annotator class to print Memory SSA information in
124/// comments.
125class MemorySSAWalkerAnnotatedWriter : public AssemblyAnnotationWriter {
MemorySSA *MSSA;
MemorySSAWalker *Walker;

129public:
MemorySSAWalkerAnnotatedWriter(MemorySSA *M)
    : MSSA(M), Walker(M->getWalker()) {}

void emitBasicBlockStartAnnot(const BasicBlock *BB,
                              formatted_raw_ostream &OS) override {
  if (MemoryAccess *MA = MSSA->getMemoryAccess(BB))
    OS << "; " << *MA << "\n";
}

void emitInstructionAnnot(const Instruction *I,
                          formatted_raw_ostream &OS) override {
  if (MemoryAccess *MA = MSSA->getMemoryAccess(I)) {
    MemoryAccess *Clobber = Walker->getClobberingMemoryAccess(MA);
    OS << "; " << *MA;
    if (Clobber) {
      OS << " - clobbered by ";
      if (MSSA->isLiveOnEntryDef(Clobber))
        OS << LiveOnEntryStr;
      else
        OS << *Clobber;
    }
    OS << "\n";
  }
}
154};

156} // namespace

158namespace {

160/// Our current alias analysis API differentiates heavily between calls and
161/// non-calls, and functions called on one usually assert on the other.
162/// This class encapsulates the distinction to simplify other code that wants
163/// "Memory affecting instructions and related data" to use as a key.
164/// For example, this class is used as a densemap key in the use optimizer.
165class MemoryLocOrCall {
166public:
bool IsCall = false;

MemoryLocOrCall(MemoryUseOrDef *MUD)
    : MemoryLocOrCall(MUD->getMemoryInst()) {}
MemoryLocOrCall(const MemoryUseOrDef *MUD)
    : MemoryLocOrCall(MUD->getMemoryInst()) {}

MemoryLocOrCall(Instruction *Inst) {
  if (auto *C = dyn_cast<CallBase>(Inst)) {
    IsCall = true;
    Call = C;
  } else {
    IsCall = false;
    // There is no such thing as a memorylocation for a fence inst, and it is
    // unique in that regard.
    if (!isa<FenceInst>(Inst))
      Loc = MemoryLocation::get(Inst);
  }
}

explicit MemoryLocOrCall(const MemoryLocation &Loc) : Loc(Loc) {}

const CallBase *getCall() const {
  assert(IsCall)(static_cast <bool> (IsCall) ? void (0) : __assert_fail
 ("IsCall", "llvm/lib/Analysis/MemorySSA.cpp", 190, __extension__
 __PRETTY_FUNCTION__));
  return Call;
}

MemoryLocation getLoc() const {
  assert(!IsCall)(static_cast <bool> (!IsCall) ? void (0) : __assert_fail
 ("!IsCall", "llvm/lib/Analysis/MemorySSA.cpp", 195, __extension__
 __PRETTY_FUNCTION__));
  return Loc;
}

bool operator==(const MemoryLocOrCall &Other) const {
  if (IsCall != Other.IsCall)
    return false;

  if (!IsCall)
    return Loc == Other.Loc;

  if (Call->getCalledOperand() != Other.Call->getCalledOperand())
    return false;

  return Call->arg_size() == Other.Call->arg_size() &&
         std::equal(Call->arg_begin(), Call->arg_end(),
                    Other.Call->arg_begin());
}

214private:
union {
  const CallBase *Call;
  MemoryLocation Loc;
};
219};

221} // end anonymous namespace

223namespace llvm {

225template <> struct DenseMapInfo<MemoryLocOrCall> {
static inline MemoryLocOrCall getEmptyKey() {
  return MemoryLocOrCall(DenseMapInfo<MemoryLocation>::getEmptyKey());
}

static inline MemoryLocOrCall getTombstoneKey() {
  return MemoryLocOrCall(DenseMapInfo<MemoryLocation>::getTombstoneKey());
}

static unsigned getHashValue(const MemoryLocOrCall &MLOC) {
  if (!MLOC.IsCall)
    return hash_combine(
        MLOC.IsCall,
        DenseMapInfo<MemoryLocation>::getHashValue(MLOC.getLoc()));

  hash_code hash =
      hash_combine(MLOC.IsCall, DenseMapInfo<const Value *>::getHashValue(
                                    MLOC.getCall()->getCalledOperand()));

  for (const Value *Arg : MLOC.getCall()->args())
    hash = hash_combine(hash, DenseMapInfo<const Value *>::getHashValue(Arg));
  return hash;
}

static bool isEqual(const MemoryLocOrCall &LHS, const MemoryLocOrCall &RHS) {
  return LHS == RHS;
}
252};

254} // end namespace llvm

256/// This does one-way checks to see if Use could theoretically be hoisted above
257/// MayClobber. This will not check the other way around.
258///
259/// This assumes that, for the purposes of MemorySSA, Use comes directly after
260/// MayClobber, with no potentially clobbering operations in between them.
261/// (Where potentially clobbering ops are memory barriers, aliased stores, etc.)
262static bool areLoadsReorderable(const LoadInst *Use,
                              const LoadInst *MayClobber) {
bool VolatileUse = Use->isVolatile();
bool VolatileClobber = MayClobber->isVolatile();
// Volatile operations may never be reordered with other volatile operations.
if (VolatileUse && VolatileClobber)
  return false;
// Otherwise, volatile doesn't matter here. From the language reference:
// 'optimizers may change the order of volatile operations relative to
// non-volatile operations.'"

// If a load is seq_cst, it cannot be moved above other loads. If its ordering
// is weaker, it can be moved above other loads. We just need to be sure that
// MayClobber isn't an acquire load, because loads can't be moved above
// acquire loads.
//
// Note that this explicitly *does* allow the free reordering of monotonic (or
// weaker) loads of the same address.
bool SeqCstUse = Use->getOrdering() == AtomicOrdering::SequentiallyConsistent;
bool MayClobberIsAcquire = isAtLeastOrStrongerThan(MayClobber->getOrdering(),
                                                   AtomicOrdering::Acquire);
return !(SeqCstUse || MayClobberIsAcquire);
284}

286namespace {

288struct ClobberAlias {
bool IsClobber;
Optional<AliasResult> AR;
291};

293} // end anonymous namespace

295// Return a pair of {IsClobber (bool), AR (AliasResult)}. It relies on AR being
296// ignored if IsClobber = false.
297template <typename AliasAnalysisType>
298static ClobberAlias
299instructionClobbersQuery(const MemoryDef *MD, const MemoryLocation &UseLoc,
                       const Instruction *UseInst, AliasAnalysisType &AA) {
Instruction *DefInst = MD->getMemoryInst();
assert(DefInst && "Defining instruction not actually an instruction")(static_cast <bool> (DefInst && "Defining instruction not actually an instruction"
) ? void (0) : __assert_fail ("DefInst && \"Defining instruction not actually an instruction\""
, "llvm/lib/Analysis/MemorySSA.cpp", 302, __extension__ __PRETTY_FUNCTION__
));
Optional<AliasResult> AR;

if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(DefInst)) {
  // These intrinsics will show up as affecting memory, but they are just
  // markers, mostly.
  //
  // FIXME: We probably don't actually want MemorySSA to model these at all
  // (including creating MemoryAccesses for them): we just end up inventing
  // clobbers where they don't really exist at all. Please see D43269 for
  // context.
  switch (II->getIntrinsicID()) {
  case Intrinsic::invariant_start:
  case Intrinsic::invariant_end:
  case Intrinsic::assume:
  case Intrinsic::experimental_noalias_scope_decl:
  case Intrinsic::pseudoprobe:
    return {false, AliasResult(AliasResult::NoAlias)};
  case Intrinsic::dbg_addr:
  case Intrinsic::dbg_declare:
  case Intrinsic::dbg_label:
  case Intrinsic::dbg_value:
    llvm_unreachable("debuginfo shouldn't have associated defs!")::llvm::llvm_unreachable_internal("debuginfo shouldn't have associated defs!"
, "llvm/lib/Analysis/MemorySSA.cpp", 324);
  default:
    break;
  }
}

if (auto *CB = dyn_cast_or_null<CallBase>(UseInst)) {
  ModRefInfo I = AA.getModRefInfo(DefInst, CB);
  AR = isMustSet(I) ? AliasResult::MustAlias : AliasResult::MayAlias;
  return {isModOrRefSet(I), AR};
}

if (auto *DefLoad = dyn_cast<LoadInst>(DefInst))
  if (auto *UseLoad = dyn_cast_or_null<LoadInst>(UseInst))
    return {!areLoadsReorderable(UseLoad, DefLoad),
            AliasResult(AliasResult::MayAlias)};

ModRefInfo I = AA.getModRefInfo(DefInst, UseLoc);
AR = isMustSet(I) ? AliasResult::MustAlias : AliasResult::MayAlias;
return {isModSet(I), AR};
344}

346template <typename AliasAnalysisType>
347static ClobberAlias instructionClobbersQuery(MemoryDef *MD,
                                           const MemoryUseOrDef *MU,
                                           const MemoryLocOrCall &UseMLOC,
                                           AliasAnalysisType &AA) {
// FIXME: This is a temporary hack to allow a single instructionClobbersQuery
// to exist while MemoryLocOrCall is pushed through places.
if (UseMLOC.IsCall)
  return instructionClobbersQuery(MD, MemoryLocation(), MU->getMemoryInst(),
                                  AA);
return instructionClobbersQuery(MD, UseMLOC.getLoc(), MU->getMemoryInst(),
                                AA);
358}

360// Return true when MD may alias MU, return false otherwise.
361bool MemorySSAUtil::defClobbersUseOrDef(MemoryDef *MD, const MemoryUseOrDef *MU,
                                      AliasAnalysis &AA) {
return instructionClobbersQuery(MD, MU, MemoryLocOrCall(MU), AA).IsClobber;
364}

366namespace {

368struct UpwardsMemoryQuery {
// True if our original query started off as a call
bool IsCall = false;
// The pointer location we started the query with. This will be empty if
// IsCall is true.
MemoryLocation StartingLoc;
// This is the instruction we were querying about.
const Instruction *Inst = nullptr;
// The MemoryAccess we actually got called with, used to test local domination
const MemoryAccess *OriginalAccess = nullptr;
Optional<AliasResult> AR = AliasResult(AliasResult::MayAlias);
bool SkipSelfAccess = false;

UpwardsMemoryQuery() = default;

UpwardsMemoryQuery(const Instruction *Inst, const MemoryAccess *Access)
    : IsCall(isa<CallBase>(Inst)), Inst(Inst), OriginalAccess(Access) {
  if (!IsCall)
    StartingLoc = MemoryLocation::get(Inst);
}
388};

390} // end anonymous namespace

392template <typename AliasAnalysisType>
393static bool isUseTriviallyOptimizableToLiveOnEntry(AliasAnalysisType &AA,
                                                 const Instruction *I) {
// If the memory can't be changed, then loads of the memory can't be
// clobbered.
if (auto *LI = dyn_cast<LoadInst>(I))
  return I->hasMetadata(LLVMContext::MD_invariant_load) ||
         AA.pointsToConstantMemory(MemoryLocation::get(LI));
return false;
401}

403/// Verifies that `Start` is clobbered by `ClobberAt`, and that nothing
404/// inbetween `Start` and `ClobberAt` can clobbers `Start`.
405///
406/// This is meant to be as simple and self-contained as possible. Because it
407/// uses no cache, etc., it can be relatively expensive.
408///
409/// \param Start     The MemoryAccess that we want to walk from.
410/// \param ClobberAt A clobber for Start.
411/// \param StartLoc  The MemoryLocation for Start.
412/// \param MSSA      The MemorySSA instance that Start and ClobberAt belong to.
413/// \param Query     The UpwardsMemoryQuery we used for our search.
414/// \param AA        The AliasAnalysis we used for our search.
415/// \param AllowImpreciseClobber Always false, unless we do relaxed verify.

417template <typename AliasAnalysisType>
418LLVM_ATTRIBUTE_UNUSED__attribute__((__unused__)) static void
419checkClobberSanity(const MemoryAccess *Start, MemoryAccess *ClobberAt,
                 const MemoryLocation &StartLoc, const MemorySSA &MSSA,
                 const UpwardsMemoryQuery &Query, AliasAnalysisType &AA,
                 bool AllowImpreciseClobber = false) {
assert(MSSA.dominates(ClobberAt, Start) && "Clobber doesn't dominate start?")(static_cast <bool> (MSSA.dominates(ClobberAt, Start) &&
 "Clobber doesn't dominate start?") ? void (0) : __assert_fail
 ("MSSA.dominates(ClobberAt, Start) && \"Clobber doesn't dominate start?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 423, __extension__ __PRETTY_FUNCTION__
));

if (MSSA.isLiveOnEntryDef(Start)) {
  assert(MSSA.isLiveOnEntryDef(ClobberAt) &&(static_cast <bool> (MSSA.isLiveOnEntryDef(ClobberAt) &&
 "liveOnEntry must clobber itself") ? void (0) : __assert_fail
 ("MSSA.isLiveOnEntryDef(ClobberAt) && \"liveOnEntry must clobber itself\""
, "llvm/lib/Analysis/MemorySSA.cpp", 427, __extension__ __PRETTY_FUNCTION__
))
         "liveOnEntry must clobber itself")(static_cast <bool> (MSSA.isLiveOnEntryDef(ClobberAt) &&
 "liveOnEntry must clobber itself") ? void (0) : __assert_fail
 ("MSSA.isLiveOnEntryDef(ClobberAt) && \"liveOnEntry must clobber itself\""
, "llvm/lib/Analysis/MemorySSA.cpp", 427, __extension__ __PRETTY_FUNCTION__
));
  return;
}

bool FoundClobber = false;
DenseSet<ConstMemoryAccessPair> VisitedPhis;
SmallVector<ConstMemoryAccessPair, 8> Worklist;
Worklist.emplace_back(Start, StartLoc);
// Walk all paths from Start to ClobberAt, while looking for clobbers. If one
// is found, complain.
while (!Worklist.empty()) {
  auto MAP = Worklist.pop_back_val();
  // All we care about is that nothing from Start to ClobberAt clobbers Start.
  // We learn nothing from revisiting nodes.
  if (!VisitedPhis.insert(MAP).second)
    continue;

  for (const auto *MA : def_chain(MAP.first)) {
    if (MA == ClobberAt) {
      if (const auto *MD = dyn_cast<MemoryDef>(MA)) {
        // instructionClobbersQuery isn't essentially free, so don't use `|=`,
        // since it won't let us short-circuit.
        //
        // Also, note that this can't be hoisted out of the `Worklist` loop,
        // since MD may only act as a clobber for 1 of N MemoryLocations.
        FoundClobber = FoundClobber || MSSA.isLiveOnEntryDef(MD);
        if (!FoundClobber) {
          ClobberAlias CA =
              instructionClobbersQuery(MD, MAP.second, Query.Inst, AA);
          if (CA.IsClobber) {
            FoundClobber = true;
            // Not used: CA.AR;
          }
        }
      }
      break;
    }

    // We should never hit liveOnEntry, unless it's the clobber.
    assert(!MSSA.isLiveOnEntryDef(MA) && "Hit liveOnEntry before clobber?")(static_cast <bool> (!MSSA.isLiveOnEntryDef(MA) &&
 "Hit liveOnEntry before clobber?") ? void (0) : __assert_fail
 ("!MSSA.isLiveOnEntryDef(MA) && \"Hit liveOnEntry before clobber?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 466, __extension__ __PRETTY_FUNCTION__
));

    if (const auto *MD = dyn_cast<MemoryDef>(MA)) {
      // If Start is a Def, skip self.
      if (MD == Start)
        continue;

      assert(!instructionClobbersQuery(MD, MAP.second, Query.Inst, AA)(static_cast <bool> (!instructionClobbersQuery(MD, MAP.
second, Query.Inst, AA) .IsClobber && "Found clobber before reaching ClobberAt!"
) ? void (0) : __assert_fail ("!instructionClobbersQuery(MD, MAP.second, Query.Inst, AA) .IsClobber && \"Found clobber before reaching ClobberAt!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 475, __extension__ __PRETTY_FUNCTION__
))
                  .IsClobber &&(static_cast <bool> (!instructionClobbersQuery(MD, MAP.
second, Query.Inst, AA) .IsClobber && "Found clobber before reaching ClobberAt!"
) ? void (0) : __assert_fail ("!instructionClobbersQuery(MD, MAP.second, Query.Inst, AA) .IsClobber && \"Found clobber before reaching ClobberAt!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 475, __extension__ __PRETTY_FUNCTION__
))
             "Found clobber before reaching ClobberAt!")(static_cast <bool> (!instructionClobbersQuery(MD, MAP.
second, Query.Inst, AA) .IsClobber && "Found clobber before reaching ClobberAt!"
) ? void (0) : __assert_fail ("!instructionClobbersQuery(MD, MAP.second, Query.Inst, AA) .IsClobber && \"Found clobber before reaching ClobberAt!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 475, __extension__ __PRETTY_FUNCTION__
));
      continue;
    }

    if (const auto *MU = dyn_cast<MemoryUse>(MA)) {
      (void)MU;
      assert (MU == Start &&(static_cast <bool> (MU == Start && "Can only find use in def chain if Start is a use"
) ? void (0) : __assert_fail ("MU == Start && \"Can only find use in def chain if Start is a use\""
, "llvm/lib/Analysis/MemorySSA.cpp", 482, __extension__ __PRETTY_FUNCTION__
))
              "Can only find use in def chain if Start is a use")(static_cast <bool> (MU == Start && "Can only find use in def chain if Start is a use"
) ? void (0) : __assert_fail ("MU == Start && \"Can only find use in def chain if Start is a use\""
, "llvm/lib/Analysis/MemorySSA.cpp", 482, __extension__ __PRETTY_FUNCTION__
));
      continue;
    }

    assert(isa<MemoryPhi>(MA))(static_cast <bool> (isa<MemoryPhi>(MA)) ? void (
0) : __assert_fail ("isa<MemoryPhi>(MA)", "llvm/lib/Analysis/MemorySSA.cpp"
, 486, __extension__ __PRETTY_FUNCTION__));

    // Add reachable phi predecessors
    for (auto ItB = upward_defs_begin(
                  {const_cast<MemoryAccess *>(MA), MAP.second},
                  MSSA.getDomTree()),
              ItE = upward_defs_end();
         ItB != ItE; ++ItB)
      if (MSSA.getDomTree().isReachableFromEntry(ItB.getPhiArgBlock()))
        Worklist.emplace_back(*ItB);
  }
}

// If the verify is done following an optimization, it's possible that
// ClobberAt was a conservative clobbering, that we can now infer is not a
// true clobbering access. Don't fail the verify if that's the case.
// We do have accesses that claim they're optimized, but could be optimized
// further. Updating all these can be expensive, so allow it for now (FIXME).
if (AllowImpreciseClobber)
  return;

// If ClobberAt is a MemoryPhi, we can assume something above it acted as a
// clobber. Otherwise, `ClobberAt` should've acted as a clobber at some point.
assert((isa<MemoryPhi>(ClobberAt) || FoundClobber) &&(static_cast <bool> ((isa<MemoryPhi>(ClobberAt) ||
 FoundClobber) && "ClobberAt never acted as a clobber"
) ? void (0) : __assert_fail ("(isa<MemoryPhi>(ClobberAt) || FoundClobber) && \"ClobberAt never acted as a clobber\""
, "llvm/lib/Analysis/MemorySSA.cpp", 510, __extension__ __PRETTY_FUNCTION__
))
       "ClobberAt never acted as a clobber")(static_cast <bool> ((isa<MemoryPhi>(ClobberAt) ||
 FoundClobber) && "ClobberAt never acted as a clobber"
) ? void (0) : __assert_fail ("(isa<MemoryPhi>(ClobberAt) || FoundClobber) && \"ClobberAt never acted as a clobber\""
, "llvm/lib/Analysis/MemorySSA.cpp", 510, __extension__ __PRETTY_FUNCTION__
));
511}

513namespace {

515/// Our algorithm for walking (and trying to optimize) clobbers, all wrapped up
516/// in one class.
517template <class AliasAnalysisType> class ClobberWalker {
/// Save a few bytes by using unsigned instead of size_t.
using ListIndex = unsigned;

/// Represents a span of contiguous MemoryDefs, potentially ending in a
/// MemoryPhi.
struct DefPath {
  MemoryLocation Loc;
  // Note that, because we always walk in reverse, Last will always dominate
  // First. Also note that First and Last are inclusive.
  MemoryAccess *First;
  MemoryAccess *Last;
  Optional<ListIndex> Previous;

  DefPath(const MemoryLocation &Loc, MemoryAccess *First, MemoryAccess *Last,
          Optional<ListIndex> Previous)
      : Loc(Loc), First(First), Last(Last), Previous(Previous) {}

  DefPath(const MemoryLocation &Loc, MemoryAccess *Init,
          Optional<ListIndex> Previous)
      : DefPath(Loc, Init, Init, Previous) {}
};

const MemorySSA &MSSA;
AliasAnalysisType &AA;
DominatorTree &DT;
UpwardsMemoryQuery *Query;
unsigned *UpwardWalkLimit;

// Phi optimization bookkeeping:
// List of DefPath to process during the current phi optimization walk.
SmallVector<DefPath, 32> Paths;
// List of visited <Access, Location> pairs; we can skip paths already
// visited with the same memory location.
DenseSet<ConstMemoryAccessPair> VisitedPhis;
// Record if phi translation has been performed during the current phi
// optimization walk, as merging alias results after phi translation can
// yield incorrect results. Context in PR46156.
bool PerformedPhiTranslation = false;

/// Find the nearest def or phi that `From` can legally be optimized to.
const MemoryAccess *getWalkTarget(const MemoryPhi *From) const {
  assert(From->getNumOperands() && "Phi with no operands?")(static_cast <bool> (From->getNumOperands() &&
 "Phi with no operands?") ? void (0) : __assert_fail ("From->getNumOperands() && \"Phi with no operands?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 559, __extension__ __PRETTY_FUNCTION__
));

  BasicBlock *BB = From->getBlock();
  MemoryAccess *Result = MSSA.getLiveOnEntryDef();
  DomTreeNode *Node = DT.getNode(BB);
  while ((Node = Node->getIDom())) {
    auto *Defs = MSSA.getBlockDefs(Node->getBlock());
    if (Defs)
      return &*Defs->rbegin();
  }
  return Result;
}

/// Result of calling walkToPhiOrClobber.
struct UpwardsWalkResult {
  /// The "Result" of the walk. Either a clobber, the last thing we walked, or
  /// both. Include alias info when clobber found.
  MemoryAccess *Result;
  bool IsKnownClobber;
  Optional<AliasResult> AR;
};

/// Walk to the next Phi or Clobber in the def chain starting at Desc.Last.
/// This will update Desc.Last as it walks. It will (optionally) also stop at
/// StopAt.
///
/// This does not test for whether StopAt is a clobber
UpwardsWalkResult
walkToPhiOrClobber(DefPath &Desc, const MemoryAccess *StopAt = nullptr,
                   const MemoryAccess *SkipStopAt = nullptr) const {
  assert(!isa<MemoryUse>(Desc.Last) && "Uses don't exist in my world")(static_cast <bool> (!isa<MemoryUse>(Desc.Last) &&
 "Uses don't exist in my world") ? void (0) : __assert_fail (
"!isa<MemoryUse>(Desc.Last) && \"Uses don't exist in my world\""
, "llvm/lib/Analysis/MemorySSA.cpp", 589, __extension__ __PRETTY_FUNCTION__
));
  assert(UpwardWalkLimit && "Need a valid walk limit")(static_cast <bool> (UpwardWalkLimit && "Need a valid walk limit"
) ? void (0) : __assert_fail ("UpwardWalkLimit && \"Need a valid walk limit\""
, "llvm/lib/Analysis/MemorySSA.cpp", 590, __extension__ __PRETTY_FUNCTION__
));
  bool LimitAlreadyReached = false;
  // (*UpwardWalkLimit) may be 0 here, due to the loop in tryOptimizePhi. Set
  // it to 1. This will not do any alias() calls. It either returns in the
  // first iteration in the loop below, or is set back to 0 if all def chains
  // are free of MemoryDefs.
  if (!*UpwardWalkLimit) {
    *UpwardWalkLimit = 1;
    LimitAlreadyReached = true;
  }

  for (MemoryAccess *Current : def_chain(Desc.Last)) {
    Desc.Last = Current;
    if (Current == StopAt || Current == SkipStopAt)
      return {Current, false, AliasResult(AliasResult::MayAlias)};

    if (auto *MD = dyn_cast<MemoryDef>(Current)) {
      if (MSSA.isLiveOnEntryDef(MD))
        return {MD, true, AliasResult(AliasResult::MustAlias)};

      if (!--*UpwardWalkLimit)
        return {Current, true, AliasResult(AliasResult::MayAlias)};

      ClobberAlias CA =
          instructionClobbersQuery(MD, Desc.Loc, Query->Inst, AA);
      if (CA.IsClobber)
        return {MD, true, CA.AR};
    }
  }

  if (LimitAlreadyReached)
    *UpwardWalkLimit = 0;

  assert(isa<MemoryPhi>(Desc.Last) &&(static_cast <bool> (isa<MemoryPhi>(Desc.Last) &&
 "Ended at a non-clobber that's not a phi?") ? void (0) : __assert_fail
 ("isa<MemoryPhi>(Desc.Last) && \"Ended at a non-clobber that's not a phi?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 624, __extension__ __PRETTY_FUNCTION__
))
         "Ended at a non-clobber that's not a phi?")(static_cast <bool> (isa<MemoryPhi>(Desc.Last) &&
 "Ended at a non-clobber that's not a phi?") ? void (0) : __assert_fail
 ("isa<MemoryPhi>(Desc.Last) && \"Ended at a non-clobber that's not a phi?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 624, __extension__ __PRETTY_FUNCTION__
));
  return {Desc.Last, false, AliasResult(AliasResult::MayAlias)};
}

void addSearches(MemoryPhi *Phi, SmallVectorImpl<ListIndex> &PausedSearches,
                 ListIndex PriorNode) {
  auto UpwardDefsBegin = upward_defs_begin({Phi, Paths[PriorNode].Loc}, DT,
                                           &PerformedPhiTranslation);
  auto UpwardDefs = make_range(UpwardDefsBegin, upward_defs_end());
  for (const MemoryAccessPair &P : UpwardDefs) {
    PausedSearches.push_back(Paths.size());
    Paths.emplace_back(P.second, P.first, PriorNode);
  }
}

/// Represents a search that terminated after finding a clobber. This clobber
/// may or may not be present in the path of defs from LastNode..SearchStart,
/// since it may have been retrieved from cache.
struct TerminatedPath {
  MemoryAccess *Clobber;
  ListIndex LastNode;
};

/// Get an access that keeps us from optimizing to the given phi.
///
/// PausedSearches is an array of indices into the Paths array. Its incoming
/// value is the indices of searches that stopped at the last phi optimization
/// target. It's left in an unspecified state.
///
/// If this returns None, NewPaused is a vector of searches that terminated
/// at StopWhere. Otherwise, NewPaused is left in an unspecified state.
Optional<TerminatedPath>
getBlockingAccess(const MemoryAccess *StopWhere,
                  SmallVectorImpl<ListIndex> &PausedSearches,
                  SmallVectorImpl<ListIndex> &NewPaused,
                  SmallVectorImpl<TerminatedPath> &Terminated) {
  assert(!PausedSearches.empty() && "No searches to continue?")(static_cast <bool> (!PausedSearches.empty() &&
 "No searches to continue?") ? void (0) : __assert_fail ("!PausedSearches.empty() && \"No searches to continue?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 660, __extension__ __PRETTY_FUNCTION__
));

  // BFS vs DFS really doesn't make a difference here, so just do a DFS with
  // PausedSearches as our stack.
  while (!PausedSearches.empty()) {
    ListIndex PathIndex = PausedSearches.pop_back_val();
    DefPath &Node = Paths[PathIndex];

    // If we've already visited this path with this MemoryLocation, we don't
    // need to do so again.
    //
    // NOTE: That we just drop these paths on the ground makes caching
    // behavior sporadic. e.g. given a diamond:
    //  A
    // B C
    //  D
    //
    // ...If we walk D, B, A, C, we'll only cache the result of phi
    // optimization for A, B, and D; C will be skipped because it dies here.
    // This arguably isn't the worst thing ever, since:
    //   - We generally query things in a top-down order, so if we got below D
    //     without needing cache entries for {C, MemLoc}, then chances are
    //     that those cache entries would end up ultimately unused.
    //   - We still cache things for A, so C only needs to walk up a bit.
    // If this behavior becomes problematic, we can fix without a ton of extra
    // work.
    if (!VisitedPhis.insert({Node.Last, Node.Loc}).second) {
      if (PerformedPhiTranslation) {
        // If visiting this path performed Phi translation, don't continue,
        // since it may not be correct to merge results from two paths if one
        // relies on the phi translation.
        TerminatedPath Term{Node.Last, PathIndex};
        return Term;
      }
      continue;
    }

    const MemoryAccess *SkipStopWhere = nullptr;
    if (Query->SkipSelfAccess && Node.Loc == Query->StartingLoc) {
      assert(isa<MemoryDef>(Query->OriginalAccess))(static_cast <bool> (isa<MemoryDef>(Query->OriginalAccess
)) ? void (0) : __assert_fail ("isa<MemoryDef>(Query->OriginalAccess)"
, "llvm/lib/Analysis/MemorySSA.cpp", 699, __extension__ __PRETTY_FUNCTION__
));
      SkipStopWhere = Query->OriginalAccess;
    }

    UpwardsWalkResult Res = walkToPhiOrClobber(Node,
                                               /*StopAt=*/StopWhere,
                                               /*SkipStopAt=*/SkipStopWhere);
    if (Res.IsKnownClobber) {
      assert(Res.Result != StopWhere && Res.Result != SkipStopWhere)(static_cast <bool> (Res.Result != StopWhere &&
 Res.Result != SkipStopWhere) ? void (0) : __assert_fail ("Res.Result != StopWhere && Res.Result != SkipStopWhere"
, "llvm/lib/Analysis/MemorySSA.cpp", 707, __extension__ __PRETTY_FUNCTION__
));

      // If this wasn't a cache hit, we hit a clobber when walking. That's a
      // failure.
      TerminatedPath Term{Res.Result, PathIndex};
      if (!MSSA.dominates(Res.Result, StopWhere))
        return Term;

      // Otherwise, it's a valid thing to potentially optimize to.
      Terminated.push_back(Term);
      continue;
    }

    if (Res.Result == StopWhere || Res.Result == SkipStopWhere) {
      // We've hit our target. Save this path off for if we want to continue
      // walking. If we are in the mode of skipping the OriginalAccess, and
      // we've reached back to the OriginalAccess, do not save path, we've
      // just looped back to self.
      if (Res.Result != SkipStopWhere)
        NewPaused.push_back(PathIndex);
      continue;
    }

    assert(!MSSA.isLiveOnEntryDef(Res.Result) && "liveOnEntry is a clobber")(static_cast <bool> (!MSSA.isLiveOnEntryDef(Res.Result)
 && "liveOnEntry is a clobber") ? void (0) : __assert_fail
 ("!MSSA.isLiveOnEntryDef(Res.Result) && \"liveOnEntry is a clobber\""
, "llvm/lib/Analysis/MemorySSA.cpp", 730, __extension__ __PRETTY_FUNCTION__
));
    addSearches(cast<MemoryPhi>(Res.Result), PausedSearches, PathIndex);
  }

  return None;
}

template <typename T, typename Walker>
struct generic_def_path_iterator
    : public iterator_facade_base<generic_def_path_iterator<T, Walker>,
                                  std::forward_iterator_tag, T *> {
  generic_def_path_iterator() = default;
  generic_def_path_iterator(Walker *W, ListIndex N) : W(W), N(N) {}

  T &operator*() const { return curNode(); }

  generic_def_path_iterator &operator++() {
    N = curNode().Previous;
    return *this;
  }

  bool operator==(const generic_def_path_iterator &O) const {
    if (N.hasValue() != O.N.hasValue())
      return false;
    return !N.hasValue() || *N == *O.N;
  }

private:
  T &curNode() const { return W->Paths[*N]; }

  Walker *W = nullptr;
  Optional<ListIndex> N = None;
};

using def_path_iterator = generic_def_path_iterator<DefPath, ClobberWalker>;
using const_def_path_iterator =
    generic_def_path_iterator<const DefPath, const ClobberWalker>;

iterator_range<def_path_iterator> def_path(ListIndex From) {
  return make_range(def_path_iterator(this, From), def_path_iterator());
}

iterator_range<const_def_path_iterator> const_def_path(ListIndex From) const {
  return make_range(const_def_path_iterator(this, From),
                    const_def_path_iterator());
}

struct OptznResult {
  /// The path that contains our result.
  TerminatedPath PrimaryClobber;
  /// The paths that we can legally cache back from, but that aren't
  /// necessarily the result of the Phi optimization.
  SmallVector<TerminatedPath, 4> OtherClobbers;
};

ListIndex defPathIndex(const DefPath &N) const {
  // The assert looks nicer if we don't need to do &N
  const DefPath *NP = &N;
  assert(!Paths.empty() && NP >= &Paths.front() && NP <= &Paths.back() &&(static_cast <bool> (!Paths.empty() && NP >=
 &Paths.front() && NP <= &Paths.back() &&
 "Out of bounds DefPath!") ? void (0) : __assert_fail ("!Paths.empty() && NP >= &Paths.front() && NP <= &Paths.back() && \"Out of bounds DefPath!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 789, __extension__ __PRETTY_FUNCTION__
))
         "Out of bounds DefPath!")(static_cast <bool> (!Paths.empty() && NP >=
 &Paths.front() && NP <= &Paths.back() &&
 "Out of bounds DefPath!") ? void (0) : __assert_fail ("!Paths.empty() && NP >= &Paths.front() && NP <= &Paths.back() && \"Out of bounds DefPath!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 789, __extension__ __PRETTY_FUNCTION__
));
  return NP - &Paths.front();
}

/// Try to optimize a phi as best as we can. Returns a SmallVector of Paths
/// that act as legal clobbers. Note that this won't return *all* clobbers.
///
/// Phi optimization algorithm tl;dr:
///   - Find the earliest def/phi, A, we can optimize to
///   - Find if all paths from the starting memory access ultimately reach A
///     - If not, optimization isn't possible.
///     - Otherwise, walk from A to another clobber or phi, A'.
///       - If A' is a def, we're done.
///       - If A' is a phi, try to optimize it.
///
/// A path is a series of {MemoryAccess, MemoryLocation} pairs. A path
/// terminates when a MemoryAccess that clobbers said MemoryLocation is found.
OptznResult tryOptimizePhi(MemoryPhi *Phi, MemoryAccess *Start,
                           const MemoryLocation &Loc) {
  assert(Paths.empty() && VisitedPhis.empty() && !PerformedPhiTranslation &&(static_cast <bool> (Paths.empty() && VisitedPhis
.empty() && !PerformedPhiTranslation && "Reset the optimization state."
) ? void (0) : __assert_fail ("Paths.empty() && VisitedPhis.empty() && !PerformedPhiTranslation && \"Reset the optimization state.\""
, "llvm/lib/Analysis/MemorySSA.cpp", 809, __extension__ __PRETTY_FUNCTION__
))
         "Reset the optimization state.")(static_cast <bool> (Paths.empty() && VisitedPhis
.empty() && !PerformedPhiTranslation && "Reset the optimization state."
) ? void (0) : __assert_fail ("Paths.empty() && VisitedPhis.empty() && !PerformedPhiTranslation && \"Reset the optimization state.\""
, "llvm/lib/Analysis/MemorySSA.cpp", 809, __extension__ __PRETTY_FUNCTION__
));

  Paths.emplace_back(Loc, Start, Phi, None);
  // Stores how many "valid" optimization nodes we had prior to calling
  // addSearches/getBlockingAccess. Necessary for caching if we had a blocker.
  auto PriorPathsSize = Paths.size();

  SmallVector<ListIndex, 16> PausedSearches;
  SmallVector<ListIndex, 8> NewPaused;
  SmallVector<TerminatedPath, 4> TerminatedPaths;

  addSearches(Phi, PausedSearches, 0);

  // Moves the TerminatedPath with the "most dominated" Clobber to the end of
  // Paths.
  auto MoveDominatedPathToEnd = [&](SmallVectorImpl<TerminatedPath> &Paths) {
    assert(!Paths.empty() && "Need a path to move")(static_cast <bool> (!Paths.empty() && "Need a path to move"
) ? void (0) : __assert_fail ("!Paths.empty() && \"Need a path to move\""
, "llvm/lib/Analysis/MemorySSA.cpp", 825, __extension__ __PRETTY_FUNCTION__
));
    auto Dom = Paths.begin();
    for (auto I = std::next(Dom), E = Paths.end(); I != E; ++I)
      if (!MSSA.dominates(I->Clobber, Dom->Clobber))
        Dom = I;
    auto Last = Paths.end() - 1;
    if (Last != Dom)
      std::iter_swap(Last, Dom);
  };

  MemoryPhi *Current = Phi;
  while (true) {
    assert(!MSSA.isLiveOnEntryDef(Current) &&(static_cast <bool> (!MSSA.isLiveOnEntryDef(Current) &&
 "liveOnEntry wasn't treated as a clobber?") ? void (0) : __assert_fail
 ("!MSSA.isLiveOnEntryDef(Current) && \"liveOnEntry wasn't treated as a clobber?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 838, __extension__ __PRETTY_FUNCTION__
))
           "liveOnEntry wasn't treated as a clobber?")(static_cast <bool> (!MSSA.isLiveOnEntryDef(Current) &&
 "liveOnEntry wasn't treated as a clobber?") ? void (0) : __assert_fail
 ("!MSSA.isLiveOnEntryDef(Current) && \"liveOnEntry wasn't treated as a clobber?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 838, __extension__ __PRETTY_FUNCTION__
));

    const auto *Target = getWalkTarget(Current);
    // If a TerminatedPath doesn't dominate Target, then it wasn't a legal
    // optimization for the prior phi.
    assert(all_of(TerminatedPaths, [&](const TerminatedPath &P) {(static_cast <bool> (all_of(TerminatedPaths, [&](const
 TerminatedPath &P) { return MSSA.dominates(P.Clobber, Target
); })) ? void (0) : __assert_fail ("all_of(TerminatedPaths, [&](const TerminatedPath &P) { return MSSA.dominates(P.Clobber, Target); })"
, "llvm/lib/Analysis/MemorySSA.cpp", 845, __extension__ __PRETTY_FUNCTION__
))
      return MSSA.dominates(P.Clobber, Target);(static_cast <bool> (all_of(TerminatedPaths, [&](const
 TerminatedPath &P) { return MSSA.dominates(P.Clobber, Target
); })) ? void (0) : __assert_fail ("all_of(TerminatedPaths, [&](const TerminatedPath &P) { return MSSA.dominates(P.Clobber, Target); })"
, "llvm/lib/Analysis/MemorySSA.cpp", 845, __extension__ __PRETTY_FUNCTION__
))
    }))(static_cast <bool> (all_of(TerminatedPaths, [&](const
 TerminatedPath &P) { return MSSA.dominates(P.Clobber, Target
); })) ? void (0) : __assert_fail ("all_of(TerminatedPaths, [&](const TerminatedPath &P) { return MSSA.dominates(P.Clobber, Target); })"
, "llvm/lib/Analysis/MemorySSA.cpp", 845, __extension__ __PRETTY_FUNCTION__
));

    // FIXME: This is broken, because the Blocker may be reported to be
    // liveOnEntry, and we'll happily wait for that to disappear (read: never)
    // For the moment, this is fine, since we do nothing with blocker info.
    if (Optional<TerminatedPath> Blocker = getBlockingAccess(
            Target, PausedSearches, NewPaused, TerminatedPaths)) {

      // Find the node we started at. We can't search based on N->Last, since
      // we may have gone around a loop with a different MemoryLocation.
      auto Iter = find_if(def_path(Blocker->LastNode), [&](const DefPath &N) {
        return defPathIndex(N) < PriorPathsSize;
      });
      assert(Iter != def_path_iterator())(static_cast <bool> (Iter != def_path_iterator()) ? void
 (0) : __assert_fail ("Iter != def_path_iterator()", "llvm/lib/Analysis/MemorySSA.cpp"
, 858, __extension__ __PRETTY_FUNCTION__));

      DefPath &CurNode = *Iter;
      assert(CurNode.Last == Current)(static_cast <bool> (CurNode.Last == Current) ? void (0
) : __assert_fail ("CurNode.Last == Current", "llvm/lib/Analysis/MemorySSA.cpp"
, 861, __extension__ __PRETTY_FUNCTION__));

      // Two things:
      // A. We can't reliably cache all of NewPaused back. Consider a case
      //    where we have two paths in NewPaused; one of which can't optimize
      //    above this phi, whereas the other can. If we cache the second path
      //    back, we'll end up with suboptimal cache entries. We can handle
      //    cases like this a bit better when we either try to find all
      //    clobbers that block phi optimization, or when our cache starts
      //    supporting unfinished searches.
      // B. We can't reliably cache TerminatedPaths back here without doing
      //    extra checks; consider a case like:
      //       T
      //      / \
      //     D   C
      //      \ /
      //       S
      //    Where T is our target, C is a node with a clobber on it, D is a
      //    diamond (with a clobber *only* on the left or right node, N), and
      //    S is our start. Say we walk to D, through the node opposite N
      //    (read: ignoring the clobber), and see a cache entry in the top
      //    node of D. That cache entry gets put into TerminatedPaths. We then
      //    walk up to C (N is later in our worklist), find the clobber, and
      //    quit. If we append TerminatedPaths to OtherClobbers, we'll cache
      //    the bottom part of D to the cached clobber, ignoring the clobber
      //    in N. Again, this problem goes away if we start tracking all
      //    blockers for a given phi optimization.
      TerminatedPath Result{CurNode.Last, defPathIndex(CurNode)};
      return {Result, {}};
    }

    // If there's nothing left to search, then all paths led to valid clobbers
    // that we got from our cache; pick the nearest to the start, and allow
    // the rest to be cached back.
    if (NewPaused.empty()) {
      MoveDominatedPathToEnd(TerminatedPaths);
      TerminatedPath Result = TerminatedPaths.pop_back_val();
      return {Result, std::move(TerminatedPaths)};
    }

    MemoryAccess *DefChainEnd = nullptr;
    SmallVector<TerminatedPath, 4> Clobbers;
    for (ListIndex Paused : NewPaused) {
      UpwardsWalkResult WR = walkToPhiOrClobber(Paths[Paused]);
      if (WR.IsKnownClobber)
        Clobbers.push_back({WR.Result, Paused});
      else
        // Micro-opt: If we hit the end of the chain, save it.
        DefChainEnd = WR.Result;
    }

    if (!TerminatedPaths.empty()) {
      // If we couldn't find the dominating phi/liveOnEntry in the above loop,
      // do it now.
      if (!DefChainEnd)
        for (auto *MA : def_chain(const_cast<MemoryAccess *>(Target)))
          DefChainEnd = MA;
      assert(DefChainEnd && "Failed to find dominating phi/liveOnEntry")(static_cast <bool> (DefChainEnd && "Failed to find dominating phi/liveOnEntry"
) ? void (0) : __assert_fail ("DefChainEnd && \"Failed to find dominating phi/liveOnEntry\""
, "llvm/lib/Analysis/MemorySSA.cpp", 918, __extension__ __PRETTY_FUNCTION__
));

      // If any of the terminated paths don't dominate the phi we'll try to
      // optimize, we need to figure out what they are and quit.
      const BasicBlock *ChainBB = DefChainEnd->getBlock();
      for (const TerminatedPath &TP : TerminatedPaths) {
        // Because we know that DefChainEnd is as "high" as we can go, we
        // don't need local dominance checks; BB dominance is sufficient.
        if (DT.dominates(ChainBB, TP.Clobber->getBlock()))
          Clobbers.push_back(TP);
      }
    }

    // If we have clobbers in the def chain, find the one closest to Current
    // and quit.
    if (!Clobbers.empty()) {
      MoveDominatedPathToEnd(Clobbers);
      TerminatedPath Result = Clobbers.pop_back_val();
      return {Result, std::move(Clobbers)};
    }

    assert(all_of(NewPaused,(static_cast <bool> (all_of(NewPaused, [&](ListIndex
 I) { return Paths[I].Last == DefChainEnd; })) ? void (0) : __assert_fail
 ("all_of(NewPaused, [&](ListIndex I) { return Paths[I].Last == DefChainEnd; })"
, "llvm/lib/Analysis/MemorySSA.cpp", 940, __extension__ __PRETTY_FUNCTION__
))
                  [&](ListIndex I) { return Paths[I].Last == DefChainEnd; }))(static_cast <bool> (all_of(NewPaused, [&](ListIndex
 I) { return Paths[I].Last == DefChainEnd; })) ? void (0) : __assert_fail
 ("all_of(NewPaused, [&](ListIndex I) { return Paths[I].Last == DefChainEnd; })"
, "llvm/lib/Analysis/MemorySSA.cpp", 940, __extension__ __PRETTY_FUNCTION__
));

    // Because liveOnEntry is a clobber, this must be a phi.
    auto *DefChainPhi = cast<MemoryPhi>(DefChainEnd);

    PriorPathsSize = Paths.size();
    PausedSearches.clear();
    for (ListIndex I : NewPaused)
      addSearches(DefChainPhi, PausedSearches, I);
    NewPaused.clear();

    Current = DefChainPhi;
  }
}

void verifyOptResult(const OptznResult &R) const {
  assert(all_of(R.OtherClobbers, [&](const TerminatedPath &P) {(static_cast <bool> (all_of(R.OtherClobbers, [&](const
 TerminatedPath &P) { return MSSA.dominates(P.Clobber, R.
PrimaryClobber.Clobber); })) ? void (0) : __assert_fail ("all_of(R.OtherClobbers, [&](const TerminatedPath &P) { return MSSA.dominates(P.Clobber, R.PrimaryClobber.Clobber); })"
, "llvm/lib/Analysis/MemorySSA.cpp", 958, __extension__ __PRETTY_FUNCTION__
))
    return MSSA.dominates(P.Clobber, R.PrimaryClobber.Clobber);(static_cast <bool> (all_of(R.OtherClobbers, [&](const
 TerminatedPath &P) { return MSSA.dominates(P.Clobber, R.
PrimaryClobber.Clobber); })) ? void (0) : __assert_fail ("all_of(R.OtherClobbers, [&](const TerminatedPath &P) { return MSSA.dominates(P.Clobber, R.PrimaryClobber.Clobber); })"
, "llvm/lib/Analysis/MemorySSA.cpp", 958, __extension__ __PRETTY_FUNCTION__
))
  }))(static_cast <bool> (all_of(R.OtherClobbers, [&](const
 TerminatedPath &P) { return MSSA.dominates(P.Clobber, R.
PrimaryClobber.Clobber); })) ? void (0) : __assert_fail ("all_of(R.OtherClobbers, [&](const TerminatedPath &P) { return MSSA.dominates(P.Clobber, R.PrimaryClobber.Clobber); })"
, "llvm/lib/Analysis/MemorySSA.cpp", 958, __extension__ __PRETTY_FUNCTION__
));
}

void resetPhiOptznState() {
  Paths.clear();
  VisitedPhis.clear();
  PerformedPhiTranslation = false;
}

967public:
ClobberWalker(const MemorySSA &MSSA, AliasAnalysisType &AA, DominatorTree &DT)
    : MSSA(MSSA), AA(AA), DT(DT) {}

AliasAnalysisType *getAA() { return &AA; }
/// Finds the nearest clobber for the given query, optimizing phis if
/// possible.
MemoryAccess *findClobber(MemoryAccess *Start, UpwardsMemoryQuery &Q,
                          unsigned &UpWalkLimit) {
  Query = &Q;
  UpwardWalkLimit = &UpWalkLimit;
  // Starting limit must be > 0.
  if (!UpWalkLimit)
    UpWalkLimit++;

  MemoryAccess *Current = Start;
  // This walker pretends uses don't exist. If we're handed one, silently grab
  // its def. (This has the nice side-effect of ensuring we never cache uses)
  if (auto *MU = dyn_cast<MemoryUse>(Start))
    Current = MU->getDefiningAccess();

  DefPath FirstDesc(Q.StartingLoc, Current, Current, None);
  // Fast path for the overly-common case (no crazy phi optimization
  // necessary)
  UpwardsWalkResult WalkResult = walkToPhiOrClobber(FirstDesc);
  MemoryAccess *Result;
  if (WalkResult.IsKnownClobber) {
    Result = WalkResult.Result;
    Q.AR = WalkResult.AR;
  } else {
    OptznResult OptRes = tryOptimizePhi(cast<MemoryPhi>(FirstDesc.Last),
                                        Current, Q.StartingLoc);
    verifyOptResult(OptRes);
    resetPhiOptznState();
    Result = OptRes.PrimaryClobber.Clobber;
  }

1004#ifdef EXPENSIVE_CHECKS
  if (!Q.SkipSelfAccess && *UpwardWalkLimit > 0)
    checkClobberSanity(Current, Result, Q.StartingLoc, MSSA, Q, AA);
1007#endif
  return Result;
}
1010};

1012struct RenamePassData {
DomTreeNode *DTN;
DomTreeNode::const_iterator ChildIt;
MemoryAccess *IncomingVal;

RenamePassData(DomTreeNode *D, DomTreeNode::const_iterator It,
               MemoryAccess *M)
    : DTN(D), ChildIt(It), IncomingVal(M) {}

void swap(RenamePassData &RHS) {
  std::swap(DTN, RHS.DTN);
  std::swap(ChildIt, RHS.ChildIt);
  std::swap(IncomingVal, RHS.IncomingVal);
}
1026};

1028} // end anonymous namespace

1030namespace llvm {

1032template <class AliasAnalysisType> class MemorySSA::ClobberWalkerBase {
ClobberWalker<AliasAnalysisType> Walker;
MemorySSA *MSSA;

1036public:
ClobberWalkerBase(MemorySSA *M, AliasAnalysisType *A, DominatorTree *D)
    : Walker(*M, *A, *D), MSSA(M) {}

MemoryAccess *getClobberingMemoryAccessBase(MemoryAccess *,
                                            const MemoryLocation &,
                                            unsigned &);
// Third argument (bool), defines whether the clobber search should skip the
// original queried access. If true, there will be a follow-up query searching
// for a clobber access past "self". Note that the Optimized access is not
// updated if a new clobber is found by this SkipSelf search. If this
// additional query becomes heavily used we may decide to cache the result.
// Walker instantiations will decide how to set the SkipSelf bool.
MemoryAccess *getClobberingMemoryAccessBase(MemoryAccess *, unsigned &, bool,
                                            bool UseInvariantGroup = true);
1051};

1053/// A MemorySSAWalker that does AA walks to disambiguate accesses. It no
1054/// longer does caching on its own, but the name has been retained for the
1055/// moment.
1056template <class AliasAnalysisType>
1057class MemorySSA::CachingWalker final : public MemorySSAWalker {
ClobberWalkerBase<AliasAnalysisType> *Walker;

1060public:
CachingWalker(MemorySSA *M, ClobberWalkerBase<AliasAnalysisType> *W)
    : MemorySSAWalker(M), Walker(W) {}
~CachingWalker() override = default;

using MemorySSAWalker::getClobberingMemoryAccess;

MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA, unsigned &UWL) {
  return Walker->getClobberingMemoryAccessBase(MA, UWL, false);
}
MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA,
                                        const MemoryLocation &Loc,
                                        unsigned &UWL) {
  return Walker->getClobberingMemoryAccessBase(MA, Loc, UWL);
}
// This method is not accessible outside of this file.
MemoryAccess *getClobberingMemoryAccessWithoutInvariantGroup(MemoryAccess *MA,
                                                             unsigned &UWL) {
  return Walker->getClobberingMemoryAccessBase(MA, UWL, false, false);
}

MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA) override {
  unsigned UpwardWalkLimit = MaxCheckLimit;
  return getClobberingMemoryAccess(MA, UpwardWalkLimit);
}
MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA,
                                        const MemoryLocation &Loc) override {
  unsigned UpwardWalkLimit = MaxCheckLimit;
  return getClobberingMemoryAccess(MA, Loc, UpwardWalkLimit);
}

void invalidateInfo(MemoryAccess *MA) override {
  if (auto *MUD = dyn_cast<MemoryUseOrDef>(MA))
    MUD->resetOptimized();
}
1095};

1097template <class AliasAnalysisType>
1098class MemorySSA::SkipSelfWalker final : public MemorySSAWalker {
ClobberWalkerBase<AliasAnalysisType> *Walker;

1101public:
SkipSelfWalker(MemorySSA *M, ClobberWalkerBase<AliasAnalysisType> *W)
    : MemorySSAWalker(M), Walker(W) {}
~SkipSelfWalker() override = default;

using MemorySSAWalker::getClobberingMemoryAccess;

MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA, unsigned &UWL) {
  return Walker->getClobberingMemoryAccessBase(MA, UWL, true);
}
MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA,
                                        const MemoryLocation &Loc,
                                        unsigned &UWL) {
  return Walker->getClobberingMemoryAccessBase(MA, Loc, UWL);
}

MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA) override {
  unsigned UpwardWalkLimit = MaxCheckLimit;
  return getClobberingMemoryAccess(MA, UpwardWalkLimit);
}
MemoryAccess *getClobberingMemoryAccess(MemoryAccess *MA,
                                        const MemoryLocation &Loc) override {
  unsigned UpwardWalkLimit = MaxCheckLimit;
  return getClobberingMemoryAccess(MA, Loc, UpwardWalkLimit);
}

void invalidateInfo(MemoryAccess *MA) override {
  if (auto *MUD = dyn_cast<MemoryUseOrDef>(MA))
    MUD->resetOptimized();
}
1131};

1133} // end namespace llvm

1135void MemorySSA::renameSuccessorPhis(BasicBlock *BB, MemoryAccess *IncomingVal,
                                  bool RenameAllUses) {
// Pass through values to our successors
for (const BasicBlock *S : successors(BB)) {
  auto It = PerBlockAccesses.find(S);
  // Rename the phi nodes in our successor block
  if (It == PerBlockAccesses.end() || !isa<MemoryPhi>(It->second->front()))
    continue;
  AccessList *Accesses = It->second.get();
  auto *Phi = cast<MemoryPhi>(&Accesses->front());
  if (RenameAllUses) {
    bool ReplacementDone = false;
    for (unsigned I = 0, E = Phi->getNumIncomingValues(); I != E; ++I)
      if (Phi->getIncomingBlock(I) == BB) {
        Phi->setIncomingValue(I, IncomingVal);
        ReplacementDone = true;
      }
    (void) ReplacementDone;
    assert(ReplacementDone && "Incomplete phi during partial rename")(static_cast <bool> (ReplacementDone && "Incomplete phi during partial rename"
) ? void (0) : __assert_fail ("ReplacementDone && \"Incomplete phi during partial rename\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1153, __extension__ __PRETTY_FUNCTION__
));
  } else
    Phi->addIncoming(IncomingVal, BB);
}
1157}

1159/// Rename a single basic block into MemorySSA form.
1160/// Uses the standard SSA renaming algorithm.
1161/// \returns The new incoming value.
1162MemoryAccess *MemorySSA::renameBlock(BasicBlock *BB, MemoryAccess *IncomingVal,
                                   bool RenameAllUses) {
auto It = PerBlockAccesses.find(BB);
// Skip most processing if the list is empty.
if (It != PerBlockAccesses.end()) {
  AccessList *Accesses = It->second.get();
  for (MemoryAccess &L : *Accesses) {
    if (MemoryUseOrDef *MUD = dyn_cast<MemoryUseOrDef>(&L)) {
      if (MUD->getDefiningAccess() == nullptr || RenameAllUses)
        MUD->setDefiningAccess(IncomingVal);
      if (isa<MemoryDef>(&L))
        IncomingVal = &L;
    } else {
      IncomingVal = &L;
    }
  }
}
return IncomingVal;
1180}

1182/// This is the standard SSA renaming algorithm.
1183///
1184/// We walk the dominator tree in preorder, renaming accesses, and then filling
1185/// in phi nodes in our successors.
1186void MemorySSA::renamePass(DomTreeNode *Root, MemoryAccess *IncomingVal,
                         SmallPtrSetImpl<BasicBlock *> &Visited,
                         bool SkipVisited, bool RenameAllUses) {
assert(Root && "Trying to rename accesses in an unreachable block")(static_cast <bool> (Root && "Trying to rename accesses in an unreachable block"
) ? void (0) : __assert_fail ("Root && \"Trying to rename accesses in an unreachable block\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1189, __extension__ __PRETTY_FUNCTION__
));

SmallVector<RenamePassData, 32> WorkStack;
// Skip everything if we already renamed this block and we are skipping.
// Note: You can't sink this into the if, because we need it to occur
// regardless of whether we skip blocks or not.
bool AlreadyVisited = !Visited.insert(Root->getBlock()).second;
if (SkipVisited && AlreadyVisited)
  return;

IncomingVal = renameBlock(Root->getBlock(), IncomingVal, RenameAllUses);
renameSuccessorPhis(Root->getBlock(), IncomingVal, RenameAllUses);
WorkStack.push_back({Root, Root->begin(), IncomingVal});

while (!WorkStack.empty()) {
  DomTreeNode *Node = WorkStack.back().DTN;
  DomTreeNode::const_iterator ChildIt = WorkStack.back().ChildIt;
  IncomingVal = WorkStack.back().IncomingVal;

  if (ChildIt == Node->end()) {
    WorkStack.pop_back();
  } else {
    DomTreeNode *Child = *ChildIt;
    ++WorkStack.back().ChildIt;
    BasicBlock *BB = Child->getBlock();
    // Note: You can't sink this into the if, because we need it to occur
    // regardless of whether we skip blocks or not.
    AlreadyVisited = !Visited.insert(BB).second;
    if (SkipVisited && AlreadyVisited) {
      // We already visited this during our renaming, which can happen when
      // being asked to rename multiple blocks. Figure out the incoming val,
      // which is the last def.
      // Incoming value can only change if there is a block def, and in that
      // case, it's the last block def in the list.
      if (auto *BlockDefs = getWritableBlockDefs(BB))
        IncomingVal = &*BlockDefs->rbegin();
    } else
      IncomingVal = renameBlock(BB, IncomingVal, RenameAllUses);
    renameSuccessorPhis(BB, IncomingVal, RenameAllUses);
    WorkStack.push_back({Child, Child->begin(), IncomingVal});
  }
}
1231}

1233/// This handles unreachable block accesses by deleting phi nodes in
1234/// unreachable blocks, and marking all other unreachable MemoryAccess's as
1235/// being uses of the live on entry definition.
1236void MemorySSA::markUnreachableAsLiveOnEntry(BasicBlock *BB) {
assert(!DT->isReachableFromEntry(BB) &&(static_cast <bool> (!DT->isReachableFromEntry(BB) &&
 "Reachable block found while handling unreachable blocks") ?
 void (0) : __assert_fail ("!DT->isReachableFromEntry(BB) && \"Reachable block found while handling unreachable blocks\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1238, __extension__ __PRETTY_FUNCTION__
))
       "Reachable block found while handling unreachable blocks")(static_cast <bool> (!DT->isReachableFromEntry(BB) &&
 "Reachable block found while handling unreachable blocks") ?
 void (0) : __assert_fail ("!DT->isReachableFromEntry(BB) && \"Reachable block found while handling unreachable blocks\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1238, __extension__ __PRETTY_FUNCTION__
));

// Make sure phi nodes in our reachable successors end up with a
// LiveOnEntryDef for our incoming edge, even though our block is forward
// unreachable.  We could just disconnect these blocks from the CFG fully,
// but we do not right now.
for (const BasicBlock *S : successors(BB)) {
  if (!DT->isReachableFromEntry(S))
    continue;
  auto It = PerBlockAccesses.find(S);
  // Rename the phi nodes in our successor block
  if (It == PerBlockAccesses.end() || !isa<MemoryPhi>(It->second->front()))
    continue;
  AccessList *Accesses = It->second.get();
  auto *Phi = cast<MemoryPhi>(&Accesses->front());
  Phi->addIncoming(LiveOnEntryDef.get(), BB);
}

auto It = PerBlockAccesses.find(BB);
if (It == PerBlockAccesses.end())
  return;

auto &Accesses = It->second;
for (auto AI = Accesses->begin(), AE = Accesses->end(); AI != AE;) {
  auto Next = std::next(AI);
  // If we have a phi, just remove it. We are going to replace all
  // users with live on entry.
  if (auto *UseOrDef = dyn_cast<MemoryUseOrDef>(AI))
    UseOrDef->setDefiningAccess(LiveOnEntryDef.get());
  else
    Accesses->erase(AI);
  AI = Next;
}
1271}

1273MemorySSA::MemorySSA(Function &Func, AliasAnalysis *AA, DominatorTree *DT)
  : DT(DT), F(Func), LiveOnEntryDef(nullptr), Walker(nullptr),
    SkipWalker(nullptr) {
// Build MemorySSA using a batch alias analysis. This reuses the internal
// state that AA collects during an alias()/getModRefInfo() call. This is
// safe because there are no CFG changes while building MemorySSA and can
// significantly reduce the time spent by the compiler in AA, because we will
// make queries about all the instructions in the Function.
assert(AA && "No alias analysis?")(static_cast <bool> (AA && "No alias analysis?"
) ? void (0) : __assert_fail ("AA && \"No alias analysis?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1281, __extension__ __PRETTY_FUNCTION__
));
BatchAAResults BatchAA(*AA);
buildMemorySSA(BatchAA);
// Intentionally leave AA to nullptr while building so we don't accidently
// use non-batch AliasAnalysis.
this->AA = AA;
// Also create the walker here.
getWalker();
1289}

1291MemorySSA::~MemorySSA() {
// Drop all our references
for (const auto &Pair : PerBlockAccesses)
  for (MemoryAccess &MA : *Pair.second)
    MA.dropAllReferences();
1296}

1298MemorySSA::AccessList *MemorySSA::getOrCreateAccessList(const BasicBlock *BB) {
auto Res = PerBlockAccesses.insert(std::make_pair(BB, nullptr));

if (Res.second)
  Res.first->second = std::make_unique<AccessList>();
return Res.first->second.get();
1304}

1306MemorySSA::DefsList *MemorySSA::getOrCreateDefsList(const BasicBlock *BB) {
auto Res = PerBlockDefs.insert(std::make_pair(BB, nullptr));

if (Res.second)
  Res.first->second = std::make_unique<DefsList>();
return Res.first->second.get();
1312}

1314namespace llvm {

1316/// This class is a batch walker of all MemoryUse's in the program, and points
1317/// their defining access at the thing that actually clobbers them.  Because it
1318/// is a batch walker that touches everything, it does not operate like the
1319/// other walkers.  This walker is basically performing a top-down SSA renaming
1320/// pass, where the version stack is used as the cache.  This enables it to be
1321/// significantly more time and memory efficient than using the regular walker,
1322/// which is walking bottom-up.
1323class MemorySSA::OptimizeUses {
1324public:
OptimizeUses(MemorySSA *MSSA, CachingWalker<BatchAAResults> *Walker,
             BatchAAResults *BAA, DominatorTree *DT)
    : MSSA(MSSA), Walker(Walker), AA(BAA), DT(DT) {}

void optimizeUses();

1331private:
/// This represents where a given memorylocation is in the stack.
struct MemlocStackInfo {
  // This essentially is keeping track of versions of the stack. Whenever
  // the stack changes due to pushes or pops, these versions increase.
  unsigned long StackEpoch;
  unsigned long PopEpoch;
  // This is the lower bound of places on the stack to check. It is equal to
  // the place the last stack walk ended.
  // Note: Correctness depends on this being initialized to 0, which densemap
  // does
  unsigned long LowerBound;
  const BasicBlock *LowerBoundBlock;
  // This is where the last walk for this memory location ended.
  unsigned long LastKill;
  bool LastKillValid;
  Optional<AliasResult> AR;
};

void optimizeUsesInBlock(const BasicBlock *, unsigned long &, unsigned long &,
                         SmallVectorImpl<MemoryAccess *> &,
                         DenseMap<MemoryLocOrCall, MemlocStackInfo> &);

MemorySSA *MSSA;
CachingWalker<BatchAAResults> *Walker;
BatchAAResults *AA;
DominatorTree *DT;
1358};

1360} // end namespace llvm

1362/// Optimize the uses in a given block This is basically the SSA renaming
1363/// algorithm, with one caveat: We are able to use a single stack for all
1364/// MemoryUses.  This is because the set of *possible* reaching MemoryDefs is
1365/// the same for every MemoryUse.  The *actual* clobbering MemoryDef is just
1366/// going to be some position in that stack of possible ones.
1367///
1368/// We track the stack positions that each MemoryLocation needs
1369/// to check, and last ended at.  This is because we only want to check the
1370/// things that changed since last time.  The same MemoryLocation should
1371/// get clobbered by the same store (getModRefInfo does not use invariantness or
1372/// things like this, and if they start, we can modify MemoryLocOrCall to
1373/// include relevant data)
1374void MemorySSA::OptimizeUses::optimizeUsesInBlock(
  const BasicBlock *BB, unsigned long &StackEpoch, unsigned long &PopEpoch,
  SmallVectorImpl<MemoryAccess *> &VersionStack,
  DenseMap<MemoryLocOrCall, MemlocStackInfo> &LocStackInfo) {

/// If no accesses, nothing to do.
MemorySSA::AccessList *Accesses = MSSA->getWritableBlockAccesses(BB);
if (Accesses == nullptr)
  return;

// Pop everything that doesn't dominate the current block off the stack,
// increment the PopEpoch to account for this.
while (true) {
  assert((static_cast <bool> (!VersionStack.empty() && "Version stack should have liveOnEntry sentinel dominating everything"
) ? void (0) : __assert_fail ("!VersionStack.empty() && \"Version stack should have liveOnEntry sentinel dominating everything\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1389, __extension__ __PRETTY_FUNCTION__
))
      !VersionStack.empty() &&(static_cast <bool> (!VersionStack.empty() && "Version stack should have liveOnEntry sentinel dominating everything"
) ? void (0) : __assert_fail ("!VersionStack.empty() && \"Version stack should have liveOnEntry sentinel dominating everything\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1389, __extension__ __PRETTY_FUNCTION__
))
      "Version stack should have liveOnEntry sentinel dominating everything")(static_cast <bool> (!VersionStack.empty() && "Version stack should have liveOnEntry sentinel dominating everything"
) ? void (0) : __assert_fail ("!VersionStack.empty() && \"Version stack should have liveOnEntry sentinel dominating everything\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1389, __extension__ __PRETTY_FUNCTION__
));
  BasicBlock *BackBlock = VersionStack.back()->getBlock();
  if (DT->dominates(BackBlock, BB))
    break;
  while (VersionStack.back()->getBlock() == BackBlock)
    VersionStack.pop_back();
  ++PopEpoch;
}

for (MemoryAccess &MA : *Accesses) {
  auto *MU = dyn_cast<MemoryUse>(&MA);
  if (!MU) {
    VersionStack.push_back(&MA);
    ++StackEpoch;
    continue;
  }

  if (MU->isOptimized())
    continue;

  if (isUseTriviallyOptimizableToLiveOnEntry(*AA, MU->getMemoryInst())) {
    MU->setDefiningAccess(MSSA->getLiveOnEntryDef(), true, None);
    continue;
  }

  MemoryLocOrCall UseMLOC(MU);
  auto &LocInfo = LocStackInfo[UseMLOC];
  // If the pop epoch changed, it means we've removed stuff from top of
  // stack due to changing blocks. We may have to reset the lower bound or
  // last kill info.
  if (LocInfo.PopEpoch != PopEpoch) {
    LocInfo.PopEpoch = PopEpoch;
    LocInfo.StackEpoch = StackEpoch;
    // If the lower bound was in something that no longer dominates us, we
    // have to reset it.
    // We can't simply track stack size, because the stack may have had
    // pushes/pops in the meantime.
    // XXX: This is non-optimal, but only is slower cases with heavily
    // branching dominator trees.  To get the optimal number of queries would
    // be to make lowerbound and lastkill a per-loc stack, and pop it until
    // the top of that stack dominates us.  This does not seem worth it ATM.
    // A much cheaper optimization would be to always explore the deepest
    // branch of the dominator tree first. This will guarantee this resets on
    // the smallest set of blocks.
    if (LocInfo.LowerBoundBlock && LocInfo.LowerBoundBlock != BB &&
        !DT->dominates(LocInfo.LowerBoundBlock, BB)) {
      // Reset the lower bound of things to check.
      // TODO: Some day we should be able to reset to last kill, rather than
      // 0.
      LocInfo.LowerBound = 0;
      LocInfo.LowerBoundBlock = VersionStack[0]->getBlock();
      LocInfo.LastKillValid = false;
    }
  } else if (LocInfo.StackEpoch != StackEpoch) {
    // If all that has changed is the StackEpoch, we only have to check the
    // new things on the stack, because we've checked everything before.  In
    // this case, the lower bound of things to check remains the same.
    LocInfo.PopEpoch = PopEpoch;
    LocInfo.StackEpoch = StackEpoch;
  }
  if (!LocInfo.LastKillValid) {
    LocInfo.LastKill = VersionStack.size() - 1;
    LocInfo.LastKillValid = true;
    LocInfo.AR = AliasResult::MayAlias;
  }

  // At this point, we should have corrected last kill and LowerBound to be
  // in bounds.
  assert(LocInfo.LowerBound < VersionStack.size() &&(static_cast <bool> (LocInfo.LowerBound < VersionStack
.size() && "Lower bound out of range") ? void (0) : __assert_fail
 ("LocInfo.LowerBound < VersionStack.size() && \"Lower bound out of range\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1458, __extension__ __PRETTY_FUNCTION__
))
         "Lower bound out of range")(static_cast <bool> (LocInfo.LowerBound < VersionStack
.size() && "Lower bound out of range") ? void (0) : __assert_fail
 ("LocInfo.LowerBound < VersionStack.size() && \"Lower bound out of range\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1458, __extension__ __PRETTY_FUNCTION__
));
  assert(LocInfo.LastKill < VersionStack.size() &&(static_cast <bool> (LocInfo.LastKill < VersionStack
.size() && "Last kill info out of range") ? void (0) :
 __assert_fail ("LocInfo.LastKill < VersionStack.size() && \"Last kill info out of range\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1460, __extension__ __PRETTY_FUNCTION__
))
         "Last kill info out of range")(static_cast <bool> (LocInfo.LastKill < VersionStack
.size() && "Last kill info out of range") ? void (0) :
 __assert_fail ("LocInfo.LastKill < VersionStack.size() && \"Last kill info out of range\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1460, __extension__ __PRETTY_FUNCTION__
));
  // In any case, the new upper bound is the top of the stack.
  unsigned long UpperBound = VersionStack.size() - 1;

  if (UpperBound - LocInfo.LowerBound > MaxCheckLimit) {
    LLVM_DEBUG(dbgs() << "MemorySSA skipping optimization of " << *MU << " ("do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "MemorySSA skipping optimization of "
 << *MU << " (" << *(MU->getMemoryInst()
) << ")" << " because there are " << UpperBound
 - LocInfo.LowerBound << " stores to disambiguate\n"; }
 } while (false)
                      << *(MU->getMemoryInst()) << ")"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "MemorySSA skipping optimization of "
 << *MU << " (" << *(MU->getMemoryInst()
) << ")" << " because there are " << UpperBound
 - LocInfo.LowerBound << " stores to disambiguate\n"; }
 } while (false)
                      << " because there are "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "MemorySSA skipping optimization of "
 << *MU << " (" << *(MU->getMemoryInst()
) << ")" << " because there are " << UpperBound
 - LocInfo.LowerBound << " stores to disambiguate\n"; }
 } while (false)
                      << UpperBound - LocInfo.LowerBounddo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "MemorySSA skipping optimization of "
 << *MU << " (" << *(MU->getMemoryInst()
) << ")" << " because there are " << UpperBound
 - LocInfo.LowerBound << " stores to disambiguate\n"; }
 } while (false)
                      << " stores to disambiguate\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "MemorySSA skipping optimization of "
 << *MU << " (" << *(MU->getMemoryInst()
) << ")" << " because there are " << UpperBound
 - LocInfo.LowerBound << " stores to disambiguate\n"; }
 } while (false);
    // Because we did not walk, LastKill is no longer valid, as this may
    // have been a kill.
    LocInfo.LastKillValid = false;
    continue;
  }
  bool FoundClobberResult = false;
  unsigned UpwardWalkLimit = MaxCheckLimit;
  while (UpperBound > LocInfo.LowerBound) {
    if (isa<MemoryPhi>(VersionStack[UpperBound])) {
      // For phis, use the walker, see where we ended up, go there.
      // The invariant.group handling in MemorySSA is ad-hoc and doesn't
      // support updates, so don't use it to optimize uses.
      MemoryAccess *Result =
          Walker->getClobberingMemoryAccessWithoutInvariantGroup(
              MU, UpwardWalkLimit);
      // We are guaranteed to find it or something is wrong.
      while (VersionStack[UpperBound] != Result) {
        assert(UpperBound != 0)(static_cast <bool> (UpperBound != 0) ? void (0) : __assert_fail
 ("UpperBound != 0", "llvm/lib/Analysis/MemorySSA.cpp", 1487,
 __extension__ __PRETTY_FUNCTION__));
        --UpperBound;
      }
      FoundClobberResult = true;
      break;
    }

    MemoryDef *MD = cast<MemoryDef>(VersionStack[UpperBound]);
    ClobberAlias CA = instructionClobbersQuery(MD, MU, UseMLOC, *AA);
    if (CA.IsClobber) {
      FoundClobberResult = true;
      LocInfo.AR = CA.AR;
      break;
    }
    --UpperBound;
  }

  // Note: Phis always have AliasResult AR set to MayAlias ATM.

  // At the end of this loop, UpperBound is either a clobber, or lower bound
  // PHI walking may cause it to be < LowerBound, and in fact, < LastKill.
  if (FoundClobberResult || UpperBound < LocInfo.LastKill) {
    // We were last killed now by where we got to
    if (MSSA->isLiveOnEntryDef(VersionStack[UpperBound]))
      LocInfo.AR = None;
    MU->setDefiningAccess(VersionStack[UpperBound], true, LocInfo.AR);
    LocInfo.LastKill = UpperBound;
  } else {
    // Otherwise, we checked all the new ones, and now we know we can get to
    // LastKill.
    MU->setDefiningAccess(VersionStack[LocInfo.LastKill], true, LocInfo.AR);
  }
  LocInfo.LowerBound = VersionStack.size() - 1;
  LocInfo.LowerBoundBlock = BB;
}
1522}

1524/// Optimize uses to point to their actual clobbering definitions.
1525void MemorySSA::OptimizeUses::optimizeUses() {
SmallVector<MemoryAccess *, 16> VersionStack;
DenseMap<MemoryLocOrCall, MemlocStackInfo> LocStackInfo;
VersionStack.push_back(MSSA->getLiveOnEntryDef());

unsigned long StackEpoch = 1;
unsigned long PopEpoch = 1;
// We perform a non-recursive top-down dominator tree walk.
for (const auto *DomNode : depth_first(DT->getRootNode()))
  optimizeUsesInBlock(DomNode->getBlock(), StackEpoch, PopEpoch, VersionStack,
                      LocStackInfo);
1536}

1538void MemorySSA::placePHINodes(
  const SmallPtrSetImpl<BasicBlock *> &DefiningBlocks) {
// Determine where our MemoryPhi's should go
ForwardIDFCalculator IDFs(*DT);
IDFs.setDefiningBlocks(DefiningBlocks);
SmallVector<BasicBlock *, 32> IDFBlocks;
IDFs.calculate(IDFBlocks);

// Now place MemoryPhi nodes.
for (auto &BB : IDFBlocks)
  createMemoryPhi(BB);
1549}

1551void MemorySSA::buildMemorySSA(BatchAAResults &BAA) {
// We create an access to represent "live on entry", for things like
// arguments or users of globals, where the memory they use is defined before
// the beginning of the function. We do not actually insert it into the IR.
// We do not define a live on exit for the immediate uses, and thus our
// semantics do *not* imply that something with no immediate uses can simply
// be removed.
BasicBlock &StartingPoint = F.getEntryBlock();
LiveOnEntryDef.reset(new MemoryDef(F.getContext(), nullptr, nullptr,
                                   &StartingPoint, NextID++));

// We maintain lists of memory accesses per-block, trading memory for time. We
// could just look up the memory access for every possible instruction in the
// stream.
SmallPtrSet<BasicBlock *, 32> DefiningBlocks;
// Go through each block, figure out where defs occur, and chain together all
// the accesses.
for (BasicBlock &B : F) {
  bool InsertIntoDef = false;
  AccessList *Accesses = nullptr;
  DefsList *Defs = nullptr;
  for (Instruction &I : B) {
    MemoryUseOrDef *MUD = createNewAccess(&I, &BAA);
    if (!MUD)
      continue;

    if (!Accesses)
      Accesses = getOrCreateAccessList(&B);
    Accesses->push_back(MUD);
    if (isa<MemoryDef>(MUD)) {
      InsertIntoDef = true;
      if (!Defs)
        Defs = getOrCreateDefsList(&B);
      Defs->push_back(*MUD);
    }
  }
  if (InsertIntoDef)
    DefiningBlocks.insert(&B);
}
placePHINodes(DefiningBlocks);

// Now do regular SSA renaming on the MemoryDef/MemoryUse. Visited will get
// filled in with all blocks.
SmallPtrSet<BasicBlock *, 16> Visited;
renamePass(DT->getRootNode(), LiveOnEntryDef.get(), Visited);

// Mark the uses in unreachable blocks as live on entry, so that they go
// somewhere.
for (auto &BB : F)
  if (!Visited.count(&BB))
    markUnreachableAsLiveOnEntry(&BB);
1602}

1604MemorySSAWalker *MemorySSA::getWalker() { return getWalkerImpl(); }

1606MemorySSA::CachingWalker<AliasAnalysis> *MemorySSA::getWalkerImpl() {
if (Walker)
  return Walker.get();

if (!WalkerBase)
  WalkerBase =
      std::make_unique<ClobberWalkerBase<AliasAnalysis>>(this, AA, DT);

Walker =
    std::make_unique<CachingWalker<AliasAnalysis>>(this, WalkerBase.get());
return Walker.get();
1617}

1619MemorySSAWalker *MemorySSA::getSkipSelfWalker() {
if (SkipWalker)
  return SkipWalker.get();

if (!WalkerBase)
  WalkerBase =
      std::make_unique<ClobberWalkerBase<AliasAnalysis>>(this, AA, DT);

SkipWalker =
    std::make_unique<SkipSelfWalker<AliasAnalysis>>(this, WalkerBase.get());
return SkipWalker.get();
}


1633// This is a helper function used by the creation routines. It places NewAccess
1634// into the access and defs lists for a given basic block, at the given
1635// insertion point.
1636void MemorySSA::insertIntoListsForBlock(MemoryAccess *NewAccess,
                                      const BasicBlock *BB,
                                      InsertionPlace Point) {
auto *Accesses = getOrCreateAccessList(BB);
if (Point == Beginning) {
  // If it's a phi node, it goes first, otherwise, it goes after any phi
  // nodes.
  if (isa<MemoryPhi>(NewAccess)) {
    Accesses->push_front(NewAccess);
    auto *Defs = getOrCreateDefsList(BB);
    Defs->push_front(*NewAccess);
  } else {
    auto AI = find_if_not(
        *Accesses, [](const MemoryAccess &MA) { return isa<MemoryPhi>(MA); });
    Accesses->insert(AI, NewAccess);
    if (!isa<MemoryUse>(NewAccess)) {
      auto *Defs = getOrCreateDefsList(BB);
      auto DI = find_if_not(
          *Defs, [](const MemoryAccess &MA) { return isa<MemoryPhi>(MA); });
      Defs->insert(DI, *NewAccess);
    }
  }
} else {
  Accesses->push_back(NewAccess);
  if (!isa<MemoryUse>(NewAccess)) {
    auto *Defs = getOrCreateDefsList(BB);
    Defs->push_back(*NewAccess);
  }
}
BlockNumberingValid.erase(BB);
1666}

1668void MemorySSA::insertIntoListsBefore(MemoryAccess *What, const BasicBlock *BB,
                                    AccessList::iterator InsertPt) {
auto *Accesses = getWritableBlockAccesses(BB);
bool WasEnd = InsertPt == Accesses->end();
Accesses->insert(AccessList::iterator(InsertPt), What);
if (!isa<MemoryUse>(What)) {
  auto *Defs = getOrCreateDefsList(BB);
  // If we got asked to insert at the end, we have an easy job, just shove it
  // at the end. If we got asked to insert before an existing def, we also get
  // an iterator. If we got asked to insert before a use, we have to hunt for
  // the next def.
  if (WasEnd) {
    Defs->push_back(*What);
  } else if (isa<MemoryDef>(InsertPt)) {
    Defs->insert(InsertPt->getDefsIterator(), *What);
  } else {
    while (InsertPt != Accesses->end() && !isa<MemoryDef>(InsertPt))
      ++InsertPt;
    // Either we found a def, or we are inserting at the end
    if (InsertPt == Accesses->end())
      Defs->push_back(*What);
    else
      Defs->insert(InsertPt->getDefsIterator(), *What);
  }
}
BlockNumberingValid.erase(BB);
1694}

1696void MemorySSA::prepareForMoveTo(MemoryAccess *What, BasicBlock *BB) {
// Keep it in the lookup tables, remove from the lists
removeFromLists(What, false);

// Note that moving should implicitly invalidate the optimized state of a
// MemoryUse (and Phis can't be optimized). However, it doesn't do so for a
// MemoryDef.
if (auto *MD = dyn_cast<MemoryDef>(What))
  MD->resetOptimized();
What->setBlock(BB);
1706}

1708// Move What before Where in the IR.  The end result is that What will belong to
1709// the right lists and have the right Block set, but will not otherwise be
1710// correct. It will not have the right defining access, and if it is a def,
1711// things below it will not properly be updated.
1712void MemorySSA::moveTo(MemoryUseOrDef *What, BasicBlock *BB,
                     AccessList::iterator Where) {
prepareForMoveTo(What, BB);
insertIntoListsBefore(What, BB, Where);
1716}

1718void MemorySSA::moveTo(MemoryAccess *What, BasicBlock *BB,
                     InsertionPlace Point) {
if (isa<MemoryPhi>(What)) {
  assert(Point == Beginning &&(static_cast <bool> (Point == Beginning && "Can only move a Phi at the beginning of the block"
) ? void (0) : __assert_fail ("Point == Beginning && \"Can only move a Phi at the beginning of the block\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1722, __extension__ __PRETTY_FUNCTION__
))
         "Can only move a Phi at the beginning of the block")(static_cast <bool> (Point == Beginning && "Can only move a Phi at the beginning of the block"
) ? void (0) : __assert_fail ("Point == Beginning && \"Can only move a Phi at the beginning of the block\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1722, __extension__ __PRETTY_FUNCTION__
));
  // Update lookup table entry
  ValueToMemoryAccess.erase(What->getBlock());
  bool Inserted = ValueToMemoryAccess.insert({BB, What}).second;
  (void)Inserted;
  assert(Inserted && "Cannot move a Phi to a block that already has one")(static_cast <bool> (Inserted && "Cannot move a Phi to a block that already has one"
) ? void (0) : __assert_fail ("Inserted && \"Cannot move a Phi to a block that already has one\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1727, __extension__ __PRETTY_FUNCTION__
));
}

prepareForMoveTo(What, BB);
insertIntoListsForBlock(What, BB, Point);
1732}

1734MemoryPhi *MemorySSA::createMemoryPhi(BasicBlock *BB) {
assert(!getMemoryAccess(BB) && "MemoryPhi already exists for this BB")(static_cast <bool> (!getMemoryAccess(BB) && "MemoryPhi already exists for this BB"
) ? void (0) : __assert_fail ("!getMemoryAccess(BB) && \"MemoryPhi already exists for this BB\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1735, __extension__ __PRETTY_FUNCTION__
));
MemoryPhi *Phi = new MemoryPhi(BB->getContext(), BB, NextID++);
// Phi's always are placed at the front of the block.
insertIntoListsForBlock(Phi, BB, Beginning);
ValueToMemoryAccess[BB] = Phi;
return Phi;
1741}

1743MemoryUseOrDef *MemorySSA::createDefinedAccess(Instruction *I,
                                             MemoryAccess *Definition,
                                             const MemoryUseOrDef *Template,
                                             bool CreationMustSucceed) {
assert(!isa<PHINode>(I) && "Cannot create a defined access for a PHI")(static_cast <bool> (!isa<PHINode>(I) && "Cannot create a defined access for a PHI"
) ? void (0) : __assert_fail ("!isa<PHINode>(I) && \"Cannot create a defined access for a PHI\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1747, __extension__ __PRETTY_FUNCTION__
));
MemoryUseOrDef *NewAccess = createNewAccess(I, AA, Template);
if (CreationMustSucceed)
  assert(NewAccess != nullptr && "Tried to create a memory access for a "(static_cast <bool> (NewAccess != nullptr && "Tried to create a memory access for a "
 "non-memory touching instruction") ? void (0) : __assert_fail
 ("NewAccess != nullptr && \"Tried to create a memory access for a \" \"non-memory touching instruction\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1751, __extension__ __PRETTY_FUNCTION__
))
                                 "non-memory touching instruction")(static_cast <bool> (NewAccess != nullptr && "Tried to create a memory access for a "
 "non-memory touching instruction") ? void (0) : __assert_fail
 ("NewAccess != nullptr && \"Tried to create a memory access for a \" \"non-memory touching instruction\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1751, __extension__ __PRETTY_FUNCTION__
));
if (NewAccess) {
  assert((!Definition || !isa<MemoryUse>(Definition)) &&(static_cast <bool> ((!Definition || !isa<MemoryUse>
(Definition)) && "A use cannot be a defining access")
 ? void (0) : __assert_fail ("(!Definition || !isa<MemoryUse>(Definition)) && \"A use cannot be a defining access\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1754, __extension__ __PRETTY_FUNCTION__
))
         "A use cannot be a defining access")(static_cast <bool> ((!Definition || !isa<MemoryUse>
(Definition)) && "A use cannot be a defining access")
 ? void (0) : __assert_fail ("(!Definition || !isa<MemoryUse>(Definition)) && \"A use cannot be a defining access\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1754, __extension__ __PRETTY_FUNCTION__
));
  NewAccess->setDefiningAccess(Definition);
}
return NewAccess;
1758}

1760// Return true if the instruction has ordering constraints.
1761// Note specifically that this only considers stores and loads
1762// because others are still considered ModRef by getModRefInfo.
1763static inline bool isOrdered(const Instruction *I) {
if (auto *SI = dyn_cast<StoreInst>(I)) {
  if (!SI->isUnordered())
    return true;
} else if (auto *LI = dyn_cast<LoadInst>(I)) {
  if (!LI->isUnordered())
    return true;
}
return false;
1772}

1774/// Helper function to create new memory accesses
1775template <typename AliasAnalysisType>
1776MemoryUseOrDef *MemorySSA::createNewAccess(Instruction *I,
                                         AliasAnalysisType *AAP,
                                         const MemoryUseOrDef *Template) {
// The assume intrinsic has a control dependency which we model by claiming
// that it writes arbitrarily. Debuginfo intrinsics may be considered
// clobbers when we have a nonstandard AA pipeline. Ignore these fake memory
// dependencies here.
// FIXME: Replace this special casing with a more accurate modelling of
// assume's control dependency.
if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
  switch (II->getIntrinsicID()) {
  default:
    break;
  case Intrinsic::assume:
  case Intrinsic::experimental_noalias_scope_decl:
  case Intrinsic::pseudoprobe:
    return nullptr;
  }
}

// Using a nonstandard AA pipelines might leave us with unexpected modref
// results for I, so add a check to not model instructions that may not read
// from or write to memory. This is necessary for correctness.
if (!I->mayReadFromMemory() && !I->mayWriteToMemory())
  return nullptr;

bool Def, Use;
if (Template) {
  Def = isa<MemoryDef>(Template);
  Use = isa<MemoryUse>(Template);
1806#if !defined(NDEBUG)
  ModRefInfo ModRef = AAP->getModRefInfo(I, None);
  bool DefCheck, UseCheck;
  DefCheck = isModSet(ModRef) || isOrdered(I);
  UseCheck = isRefSet(ModRef);
  assert(Def == DefCheck && (Def || Use == UseCheck) && "Invalid template")(static_cast <bool> (Def == DefCheck && (Def ||
 Use == UseCheck) && "Invalid template") ? void (0) :
 __assert_fail ("Def == DefCheck && (Def || Use == UseCheck) && \"Invalid template\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1811, __extension__ __PRETTY_FUNCTION__
));
1812#endif
} else {
  // Find out what affect this instruction has on memory.
  ModRefInfo ModRef = AAP->getModRefInfo(I, None);
  // The isOrdered check is used to ensure that volatiles end up as defs
  // (atomics end up as ModRef right now anyway).  Until we separate the
  // ordering chain from the memory chain, this enables people to see at least
  // some relative ordering to volatiles.  Note that getClobberingMemoryAccess
  // will still give an answer that bypasses other volatile loads.  TODO:
  // Separate memory aliasing and ordering into two different chains so that
  // we can precisely represent both "what memory will this read/write/is
  // clobbered by" and "what instructions can I move this past".
  Def = isModSet(ModRef) || isOrdered(I);
  Use = isRefSet(ModRef);
}

// It's possible for an instruction to not modify memory at all. During
// construction, we ignore them.
if (!Def && !Use)
  return nullptr;

MemoryUseOrDef *MUD;
if (Def)
  MUD = new MemoryDef(I->getContext(), nullptr, I, I->getParent(), NextID++);
else
  MUD = new MemoryUse(I->getContext(), nullptr, I, I->getParent());
ValueToMemoryAccess[I] = MUD;
return MUD;
1840}

1842/// Properly remove \p MA from all of MemorySSA's lookup tables.
1843void MemorySSA::removeFromLookups(MemoryAccess *MA) {
assert(MA->use_empty() &&(static_cast <bool> (MA->use_empty() && "Trying to remove memory access that still has uses"
) ? void (0) : __assert_fail ("MA->use_empty() && \"Trying to remove memory access that still has uses\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1845, __extension__ __PRETTY_FUNCTION__
))
       "Trying to remove memory access that still has uses")(static_cast <bool> (MA->use_empty() && "Trying to remove memory access that still has uses"
) ? void (0) : __assert_fail ("MA->use_empty() && \"Trying to remove memory access that still has uses\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1845, __extension__ __PRETTY_FUNCTION__
));
BlockNumbering.erase(MA);
if (auto *MUD = dyn_cast<MemoryUseOrDef>(MA))
  MUD->setDefiningAccess(nullptr);
// Invalidate our walker's cache if necessary
if (!isa<MemoryUse>(MA))
  getWalker()->invalidateInfo(MA);

Value *MemoryInst;
if (const auto *MUD = dyn_cast<MemoryUseOrDef>(MA))
  MemoryInst = MUD->getMemoryInst();
else
  MemoryInst = MA->getBlock();

auto VMA = ValueToMemoryAccess.find(MemoryInst);
if (VMA->second == MA)
  ValueToMemoryAccess.erase(VMA);
1862}

1864/// Properly remove \p MA from all of MemorySSA's lists.
1865///
1866/// Because of the way the intrusive list and use lists work, it is important to
1867/// do removal in the right order.
1868/// ShouldDelete defaults to true, and will cause the memory access to also be
1869/// deleted, not just removed.
1870void MemorySSA::removeFromLists(MemoryAccess *MA, bool ShouldDelete) {
BasicBlock *BB = MA->getBlock();
// The access list owns the reference, so we erase it from the non-owning list
// first.
if (!isa<MemoryUse>(MA)) {
  auto DefsIt = PerBlockDefs.find(BB);
  std::unique_ptr<DefsList> &Defs = DefsIt->second;
  Defs->remove(*MA);
  if (Defs->empty())
    PerBlockDefs.erase(DefsIt);
}

// The erase call here will delete it. If we don't want it deleted, we call
// remove instead.
auto AccessIt = PerBlockAccesses.find(BB);
std::unique_ptr<AccessList> &Accesses = AccessIt->second;
if (ShouldDelete)
  Accesses->erase(MA);
else
  Accesses->remove(MA);

if (Accesses->empty()) {
  PerBlockAccesses.erase(AccessIt);
  BlockNumberingValid.erase(BB);
}
1895}

1897void MemorySSA::print(raw_ostream &OS) const {
MemorySSAAnnotatedWriter Writer(this);
F.print(OS, &Writer);
1900}

1902#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1903LLVM_DUMP_METHOD__attribute__((noinline)) __attribute__((__used__)) void MemorySSA::dump() const { print(dbgs()); }
1904#endif

1906void MemorySSA::verifyMemorySSA(VerificationLevel VL) const {
1907#if !defined(NDEBUG) && defined(EXPENSIVE_CHECKS)
VL = VerificationLevel::Full;
1909#endif

1911#ifndef NDEBUG
verifyOrderingDominationAndDefUses(F, VL);
4
←
Calling 'MemorySSA::verifyOrderingDominationAndDefUses'→
verifyDominationNumbers(F);
if (VL == VerificationLevel::Full)
  verifyPrevDefInPhis(F);
1916#endif
// Previously, the verification used to also verify that the clobberingAccess
// cached by MemorySSA is the same as the clobberingAccess found at a later
// query to AA. This does not hold true in general due to the current fragility
// of BasicAA which has arbitrary caps on the things it analyzes before giving
// up. As a result, transformations that are correct, will lead to BasicAA
// returning different Alias answers before and after that transformation.
// Invalidating MemorySSA is not an option, as the results in BasicAA can be so
// random, in the worst case we'd need to rebuild MemorySSA from scratch after
// every transformation, which defeats the purpose of using it. For such an
// example, see test4 added in D51960.
1927}

1929void MemorySSA::verifyPrevDefInPhis(Function &F) const {
for (const BasicBlock &BB : F) {
  if (MemoryPhi *Phi = getMemoryAccess(&BB)) {
    for (unsigned I = 0, E = Phi->getNumIncomingValues(); I != E; ++I) {
      auto *Pred = Phi->getIncomingBlock(I);
      auto *IncAcc = Phi->getIncomingValue(I);
      // If Pred has no unreachable predecessors, get last def looking at
      // IDoms. If, while walkings IDoms, any of these has an unreachable
      // predecessor, then the incoming def can be any access.
      if (auto *DTNode = DT->getNode(Pred)) {
        while (DTNode) {
          if (auto *DefList = getBlockDefs(DTNode->getBlock())) {
            auto *LastAcc = &*(--DefList->end());
            assert(LastAcc == IncAcc &&(static_cast <bool> (LastAcc == IncAcc && "Incorrect incoming access into phi."
) ? void (0) : __assert_fail ("LastAcc == IncAcc && \"Incorrect incoming access into phi.\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1943, __extension__ __PRETTY_FUNCTION__
))
                   "Incorrect incoming access into phi.")(static_cast <bool> (LastAcc == IncAcc && "Incorrect incoming access into phi."
) ? void (0) : __assert_fail ("LastAcc == IncAcc && \"Incorrect incoming access into phi.\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1943, __extension__ __PRETTY_FUNCTION__
));
            (void)IncAcc;
            (void)LastAcc;
            break;
          }
          DTNode = DTNode->getIDom();
        }
      } else {
        // If Pred has unreachable predecessors, but has at least a Def, the
        // incoming access can be the last Def in Pred, or it could have been
        // optimized to LoE. After an update, though, the LoE may have been
        // replaced by another access, so IncAcc may be any access.
        // If Pred has unreachable predecessors and no Defs, incoming access
        // should be LoE; However, after an update, it may be any access.
      }
    }
  }
}
1961}

1963/// Verify that all of the blocks we believe to have valid domination numbers
1964/// actually have valid domination numbers.
1965void MemorySSA::verifyDominationNumbers(const Function &F) const {
if (BlockNumberingValid.empty())
  return;

SmallPtrSet<const BasicBlock *, 16> ValidBlocks = BlockNumberingValid;
for (const BasicBlock &BB : F) {
  if (!ValidBlocks.count(&BB))
    continue;

  ValidBlocks.erase(&BB);

  const AccessList *Accesses = getBlockAccesses(&BB);
  // It's correct to say an empty block has valid numbering.
  if (!Accesses)
    continue;

  // Block numbering starts at 1.
  unsigned long LastNumber = 0;
  for (const MemoryAccess &MA : *Accesses) {
    auto ThisNumberIter = BlockNumbering.find(&MA);
    assert(ThisNumberIter != BlockNumbering.end() &&(static_cast <bool> (ThisNumberIter != BlockNumbering.end
() && "MemoryAccess has no domination number in a valid block!"
) ? void (0) : __assert_fail ("ThisNumberIter != BlockNumbering.end() && \"MemoryAccess has no domination number in a valid block!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1986, __extension__ __PRETTY_FUNCTION__
))
           "MemoryAccess has no domination number in a valid block!")(static_cast <bool> (ThisNumberIter != BlockNumbering.end
() && "MemoryAccess has no domination number in a valid block!"
) ? void (0) : __assert_fail ("ThisNumberIter != BlockNumbering.end() && \"MemoryAccess has no domination number in a valid block!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1986, __extension__ __PRETTY_FUNCTION__
));

    unsigned long ThisNumber = ThisNumberIter->second;
    assert(ThisNumber > LastNumber &&(static_cast <bool> (ThisNumber > LastNumber &&
 "Domination numbers should be strictly increasing!") ? void (
0) : __assert_fail ("ThisNumber > LastNumber && \"Domination numbers should be strictly increasing!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1990, __extension__ __PRETTY_FUNCTION__
))
           "Domination numbers should be strictly increasing!")(static_cast <bool> (ThisNumber > LastNumber &&
 "Domination numbers should be strictly increasing!") ? void (
0) : __assert_fail ("ThisNumber > LastNumber && \"Domination numbers should be strictly increasing!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1990, __extension__ __PRETTY_FUNCTION__
));
    (void)LastNumber;
    LastNumber = ThisNumber;
  }
}

assert(ValidBlocks.empty() &&(static_cast <bool> (ValidBlocks.empty() && "All valid BasicBlocks should exist in F -- dangling pointers?"
) ? void (0) : __assert_fail ("ValidBlocks.empty() && \"All valid BasicBlocks should exist in F -- dangling pointers?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1997, __extension__ __PRETTY_FUNCTION__
))
       "All valid BasicBlocks should exist in F -- dangling pointers?")(static_cast <bool> (ValidBlocks.empty() && "All valid BasicBlocks should exist in F -- dangling pointers?"
) ? void (0) : __assert_fail ("ValidBlocks.empty() && \"All valid BasicBlocks should exist in F -- dangling pointers?\""
, "llvm/lib/Analysis/MemorySSA.cpp", 1997, __extension__ __PRETTY_FUNCTION__
));
1998}

2000/// Verify ordering: the order and existence of MemoryAccesses matches the
2001/// order and existence of memory affecting instructions.
2002/// Verify domination: each definition dominates all of its uses.
2003/// Verify def-uses: the immediate use information - walk all the memory
2004/// accesses and verifying that, for each use, it appears in the appropriate
2005/// def's use list
2006void MemorySSA::verifyOrderingDominationAndDefUses(Function &F,
                                                 VerificationLevel VL) const {
// Walk all the blocks, comparing what the lookups think and what the access
// lists think, as well as the order in the blocks vs the order in the access
// lists.
SmallVector<MemoryAccess *, 32> ActualAccesses;
SmallVector<MemoryAccess *, 32> ActualDefs;
for (BasicBlock &B : F) {
  const AccessList *AL = getBlockAccesses(&B);
5
←
Calling 'MemorySSA::getBlockAccesses'→
13
←
Returning from 'MemorySSA::getBlockAccesses'→
14
←
'AL' initialized here→
  const auto *DL = getBlockDefs(&B);
15
←
Calling 'MemorySSA::getBlockDefs'→
21
←
Returning from 'MemorySSA::getBlockDefs'→
  MemoryPhi *Phi = getMemoryAccess(&B);
22
←
Calling 'MemorySSA::getMemoryAccess'→
26
←
Returning from 'MemorySSA::getMemoryAccess'→
  if (Phi26.1
'Phi' is null
1
'Phi' is null
) {
27
←
Taking false branch→
    // Verify ordering.
    ActualAccesses.push_back(Phi);
    ActualDefs.push_back(Phi);
    // Verify domination
    for (const Use &U : Phi->uses()) {
      assert(dominates(Phi, U) && "Memory PHI does not dominate it's uses")(static_cast <bool> (dominates(Phi, U) && "Memory PHI does not dominate it's uses"
) ? void (0) : __assert_fail ("dominates(Phi, U) && \"Memory PHI does not dominate it's uses\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2023, __extension__ __PRETTY_FUNCTION__
));
      (void)U;
    }
    // Verify def-uses for full verify.
    if (VL == VerificationLevel::Full) {
      assert(Phi->getNumOperands() == static_cast<unsigned>(std::distance((static_cast <bool> (Phi->getNumOperands() == static_cast
<unsigned>(std::distance( pred_begin(&B), pred_end(
&B))) && "Incomplete MemoryPhi Node") ? void (0) :
 __assert_fail ("Phi->getNumOperands() == static_cast<unsigned>(std::distance( pred_begin(&B), pred_end(&B))) && \"Incomplete MemoryPhi Node\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2030, __extension__ __PRETTY_FUNCTION__
))
                                          pred_begin(&B), pred_end(&B))) &&(static_cast <bool> (Phi->getNumOperands() == static_cast
<unsigned>(std::distance( pred_begin(&B), pred_end(
&B))) && "Incomplete MemoryPhi Node") ? void (0) :
 __assert_fail ("Phi->getNumOperands() == static_cast<unsigned>(std::distance( pred_begin(&B), pred_end(&B))) && \"Incomplete MemoryPhi Node\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2030, __extension__ __PRETTY_FUNCTION__
))
             "Incomplete MemoryPhi Node")(static_cast <bool> (Phi->getNumOperands() == static_cast
<unsigned>(std::distance( pred_begin(&B), pred_end(
&B))) && "Incomplete MemoryPhi Node") ? void (0) :
 __assert_fail ("Phi->getNumOperands() == static_cast<unsigned>(std::distance( pred_begin(&B), pred_end(&B))) && \"Incomplete MemoryPhi Node\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2030, __extension__ __PRETTY_FUNCTION__
));
      for (unsigned I = 0, E = Phi->getNumIncomingValues(); I != E; ++I) {
        verifyUseInDefs(Phi->getIncomingValue(I), Phi);
        assert(is_contained(predecessors(&B), Phi->getIncomingBlock(I)) &&(static_cast <bool> (is_contained(predecessors(&B),
 Phi->getIncomingBlock(I)) && "Incoming phi block not a block predecessor"
) ? void (0) : __assert_fail ("is_contained(predecessors(&B), Phi->getIncomingBlock(I)) && \"Incoming phi block not a block predecessor\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2034, __extension__ __PRETTY_FUNCTION__
))
               "Incoming phi block not a block predecessor")(static_cast <bool> (is_contained(predecessors(&B),
 Phi->getIncomingBlock(I)) && "Incoming phi block not a block predecessor"
) ? void (0) : __assert_fail ("is_contained(predecessors(&B), Phi->getIncomingBlock(I)) && \"Incoming phi block not a block predecessor\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2034, __extension__ __PRETTY_FUNCTION__
));
      }
    }
  }

  for (Instruction &I : B) {
    MemoryUseOrDef *MA = getMemoryAccess(&I);
    assert((!MA || (AL && (isa<MemoryUse>(MA) || DL))) &&(static_cast <bool> ((!MA || (AL && (isa<MemoryUse
>(MA) || DL))) && "We have memory affecting instructions "
 "in this block but they are not in the " "access list or defs list"
) ? void (0) : __assert_fail ("(!MA || (AL && (isa<MemoryUse>(MA) || DL))) && \"We have memory affecting instructions \" \"in this block but they are not in the \" \"access list or defs list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2044, __extension__ __PRETTY_FUNCTION__
))
           "We have memory affecting instructions "(static_cast <bool> ((!MA || (AL && (isa<MemoryUse
>(MA) || DL))) && "We have memory affecting instructions "
 "in this block but they are not in the " "access list or defs list"
) ? void (0) : __assert_fail ("(!MA || (AL && (isa<MemoryUse>(MA) || DL))) && \"We have memory affecting instructions \" \"in this block but they are not in the \" \"access list or defs list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2044, __extension__ __PRETTY_FUNCTION__
))
           "in this block but they are not in the "(static_cast <bool> ((!MA || (AL && (isa<MemoryUse
>(MA) || DL))) && "We have memory affecting instructions "
 "in this block but they are not in the " "access list or defs list"
) ? void (0) : __assert_fail ("(!MA || (AL && (isa<MemoryUse>(MA) || DL))) && \"We have memory affecting instructions \" \"in this block but they are not in the \" \"access list or defs list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2044, __extension__ __PRETTY_FUNCTION__
))
           "access list or defs list")(static_cast <bool> ((!MA || (AL && (isa<MemoryUse
>(MA) || DL))) && "We have memory affecting instructions "
 "in this block but they are not in the " "access list or defs list"
) ? void (0) : __assert_fail ("(!MA || (AL && (isa<MemoryUse>(MA) || DL))) && \"We have memory affecting instructions \" \"in this block but they are not in the \" \"access list or defs list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2044, __extension__ __PRETTY_FUNCTION__
));
    if (MA) {
      // Verify ordering.
      ActualAccesses.push_back(MA);
      if (MemoryAccess *MD = dyn_cast<MemoryDef>(MA)) {
        // Verify ordering.
        ActualDefs.push_back(MA);
        // Verify domination.
        for (const Use &U : MD->uses()) {
          assert(dominates(MD, U) &&(static_cast <bool> (dominates(MD, U) && "Memory Def does not dominate it's uses"
) ? void (0) : __assert_fail ("dominates(MD, U) && \"Memory Def does not dominate it's uses\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2054, __extension__ __PRETTY_FUNCTION__
))
                 "Memory Def does not dominate it's uses")(static_cast <bool> (dominates(MD, U) && "Memory Def does not dominate it's uses"
) ? void (0) : __assert_fail ("dominates(MD, U) && \"Memory Def does not dominate it's uses\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2054, __extension__ __PRETTY_FUNCTION__
));
          (void)U;
        }
      }
      // Verify def-uses for full verify.
      if (VL == VerificationLevel::Full)
        verifyUseInDefs(MA->getDefiningAccess(), MA);
    }
  }
  // Either we hit the assert, really have no accesses, or we have both
  // accesses and an access list. Same with defs.
  if (!AL && !DL)
28
←
Assuming 'AL' is null→
29
←
Assuming 'DL' is non-null→
    continue;
  // Verify ordering.
  assert(AL->size() == ActualAccesses.size() &&(static_cast <bool> (AL->size() == ActualAccesses.size
() && "We don't have the same number of accesses in the block as on the "
 "access list") ? void (0) : __assert_fail ("AL->size() == ActualAccesses.size() && \"We don't have the same number of accesses in the block as on the \" \"access list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2070, __extension__ __PRETTY_FUNCTION__
))
30
←
Taking false branch→
31
←
Called C++ object pointer is null
         "We don't have the same number of accesses in the block as on the "(static_cast <bool> (AL->size() == ActualAccesses.size
() && "We don't have the same number of accesses in the block as on the "
 "access list") ? void (0) : __assert_fail ("AL->size() == ActualAccesses.size() && \"We don't have the same number of accesses in the block as on the \" \"access list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2070, __extension__ __PRETTY_FUNCTION__
))
         "access list")(static_cast <bool> (AL->size() == ActualAccesses.size
() && "We don't have the same number of accesses in the block as on the "
 "access list") ? void (0) : __assert_fail ("AL->size() == ActualAccesses.size() && \"We don't have the same number of accesses in the block as on the \" \"access list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2070, __extension__ __PRETTY_FUNCTION__
));
  assert((DL || ActualDefs.size() == 0) &&(static_cast <bool> ((DL || ActualDefs.size() == 0) &&
 "Either we should have a defs list, or we should have no defs"
) ? void (0) : __assert_fail ("(DL || ActualDefs.size() == 0) && \"Either we should have a defs list, or we should have no defs\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2072, __extension__ __PRETTY_FUNCTION__
))
         "Either we should have a defs list, or we should have no defs")(static_cast <bool> ((DL || ActualDefs.size() == 0) &&
 "Either we should have a defs list, or we should have no defs"
) ? void (0) : __assert_fail ("(DL || ActualDefs.size() == 0) && \"Either we should have a defs list, or we should have no defs\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2072, __extension__ __PRETTY_FUNCTION__
));
  assert((!DL || DL->size() == ActualDefs.size()) &&(static_cast <bool> ((!DL || DL->size() == ActualDefs
.size()) && "We don't have the same number of defs in the block as on the "
 "def list") ? void (0) : __assert_fail ("(!DL || DL->size() == ActualDefs.size()) && \"We don't have the same number of defs in the block as on the \" \"def list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2075, __extension__ __PRETTY_FUNCTION__
))
         "We don't have the same number of defs in the block as on the "(static_cast <bool> ((!DL || DL->size() == ActualDefs
.size()) && "We don't have the same number of defs in the block as on the "
 "def list") ? void (0) : __assert_fail ("(!DL || DL->size() == ActualDefs.size()) && \"We don't have the same number of defs in the block as on the \" \"def list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2075, __extension__ __PRETTY_FUNCTION__
))
         "def list")(static_cast <bool> ((!DL || DL->size() == ActualDefs
.size()) && "We don't have the same number of defs in the block as on the "
 "def list") ? void (0) : __assert_fail ("(!DL || DL->size() == ActualDefs.size()) && \"We don't have the same number of defs in the block as on the \" \"def list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2075, __extension__ __PRETTY_FUNCTION__
));
  auto ALI = AL->begin();
  auto AAI = ActualAccesses.begin();
  while (ALI != AL->end() && AAI != ActualAccesses.end()) {
    assert(&*ALI == *AAI && "Not the same accesses in the same order")(static_cast <bool> (&*ALI == *AAI && "Not the same accesses in the same order"
) ? void (0) : __assert_fail ("&*ALI == *AAI && \"Not the same accesses in the same order\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2079, __extension__ __PRETTY_FUNCTION__
));
    ++ALI;
    ++AAI;
  }
  ActualAccesses.clear();
  if (DL) {
    auto DLI = DL->begin();
    auto ADI = ActualDefs.begin();
    while (DLI != DL->end() && ADI != ActualDefs.end()) {
      assert(&*DLI == *ADI && "Not the same defs in the same order")(static_cast <bool> (&*DLI == *ADI && "Not the same defs in the same order"
) ? void (0) : __assert_fail ("&*DLI == *ADI && \"Not the same defs in the same order\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2088, __extension__ __PRETTY_FUNCTION__
));
      ++DLI;
      ++ADI;
    }
  }
  ActualDefs.clear();
}
2095}

2097/// Verify the def-use lists in MemorySSA, by verifying that \p Use
2098/// appears in the use list of \p Def.
2099void MemorySSA::verifyUseInDefs(MemoryAccess *Def, MemoryAccess *Use) const {
// The live on entry use may cause us to get a NULL def here
if (!Def)
  assert(isLiveOnEntryDef(Use) &&(static_cast <bool> (isLiveOnEntryDef(Use) && "Null def but use not point to live on entry def"
) ? void (0) : __assert_fail ("isLiveOnEntryDef(Use) && \"Null def but use not point to live on entry def\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2103, __extension__ __PRETTY_FUNCTION__
))
         "Null def but use not point to live on entry def")(static_cast <bool> (isLiveOnEntryDef(Use) && "Null def but use not point to live on entry def"
) ? void (0) : __assert_fail ("isLiveOnEntryDef(Use) && \"Null def but use not point to live on entry def\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2103, __extension__ __PRETTY_FUNCTION__
));
else
  assert(is_contained(Def->users(), Use) &&(static_cast <bool> (is_contained(Def->users(), Use)
 && "Did not find use in def's use list") ? void (0) :
 __assert_fail ("is_contained(Def->users(), Use) && \"Did not find use in def's use list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2106, __extension__ __PRETTY_FUNCTION__
))
         "Did not find use in def's use list")(static_cast <bool> (is_contained(Def->users(), Use)
 && "Did not find use in def's use list") ? void (0) :
 __assert_fail ("is_contained(Def->users(), Use) && \"Did not find use in def's use list\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2106, __extension__ __PRETTY_FUNCTION__
));
2107}

2109/// Perform a local numbering on blocks so that instruction ordering can be
2110/// determined in constant time.
2111/// TODO: We currently just number in order.  If we numbered by N, we could
2112/// allow at least N-1 sequences of insertBefore or insertAfter (and at least
2113/// log2(N) sequences of mixed before and after) without needing to invalidate
2114/// the numbering.
2115void MemorySSA::renumberBlock(const BasicBlock *B) const {
// The pre-increment ensures the numbers really start at 1.
unsigned long CurrentNumber = 0;
const AccessList *AL = getBlockAccesses(B);
assert(AL != nullptr && "Asking to renumber an empty block")(static_cast <bool> (AL != nullptr && "Asking to renumber an empty block"
) ? void (0) : __assert_fail ("AL != nullptr && \"Asking to renumber an empty block\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2119, __extension__ __PRETTY_FUNCTION__
));
for (const auto &I : *AL)
  BlockNumbering[&I] = ++CurrentNumber;
BlockNumberingValid.insert(B);
2123}

2125/// Determine, for two memory accesses in the same block,
2126/// whether \p Dominator dominates \p Dominatee.
2127/// \returns True if \p Dominator dominates \p Dominatee.
2128bool MemorySSA::locallyDominates(const MemoryAccess *Dominator,
                               const MemoryAccess *Dominatee) const {
const BasicBlock *DominatorBlock = Dominator->getBlock();

assert((DominatorBlock == Dominatee->getBlock()) &&(static_cast <bool> ((DominatorBlock == Dominatee->getBlock
()) && "Asking for local domination when accesses are in different blocks!"
) ? void (0) : __assert_fail ("(DominatorBlock == Dominatee->getBlock()) && \"Asking for local domination when accesses are in different blocks!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2133, __extension__ __PRETTY_FUNCTION__
))
       "Asking for local domination when accesses are in different blocks!")(static_cast <bool> ((DominatorBlock == Dominatee->getBlock
()) && "Asking for local domination when accesses are in different blocks!"
) ? void (0) : __assert_fail ("(DominatorBlock == Dominatee->getBlock()) && \"Asking for local domination when accesses are in different blocks!\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2133, __extension__ __PRETTY_FUNCTION__
));
// A node dominates itself.
if (Dominatee == Dominator)
  return true;

// When Dominatee is defined on function entry, it is not dominated by another
// memory access.
if (isLiveOnEntryDef(Dominatee))
  return false;

// When Dominator is defined on function entry, it dominates the other memory
// access.
if (isLiveOnEntryDef(Dominator))
  return true;

if (!BlockNumberingValid.count(DominatorBlock))
  renumberBlock(DominatorBlock);

unsigned long DominatorNum = BlockNumbering.lookup(Dominator);
// All numbers start with 1
assert(DominatorNum != 0 && "Block was not numbered properly")(static_cast <bool> (DominatorNum != 0 && "Block was not numbered properly"
) ? void (0) : __assert_fail ("DominatorNum != 0 && \"Block was not numbered properly\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2153, __extension__ __PRETTY_FUNCTION__
));
unsigned long DominateeNum = BlockNumbering.lookup(Dominatee);
assert(DominateeNum != 0 && "Block was not numbered properly")(static_cast <bool> (DominateeNum != 0 && "Block was not numbered properly"
) ? void (0) : __assert_fail ("DominateeNum != 0 && \"Block was not numbered properly\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2155, __extension__ __PRETTY_FUNCTION__
));
return DominatorNum < DominateeNum;
2157}

2159bool MemorySSA::dominates(const MemoryAccess *Dominator,
                        const MemoryAccess *Dominatee) const {
if (Dominator == Dominatee)
  return true;

if (isLiveOnEntryDef(Dominatee))
  return false;

if (Dominator->getBlock() != Dominatee->getBlock())
  return DT->dominates(Dominator->getBlock(), Dominatee->getBlock());
return locallyDominates(Dominator, Dominatee);
2170}

2172bool MemorySSA::dominates(const MemoryAccess *Dominator,
                        const Use &Dominatee) const {
if (MemoryPhi *MP = dyn_cast<MemoryPhi>(Dominatee.getUser())) {
  BasicBlock *UseBB = MP->getIncomingBlock(Dominatee);
  // The def must dominate the incoming block of the phi.
  if (UseBB != Dominator->getBlock())
    return DT->dominates(Dominator->getBlock(), UseBB);
  // If the UseBB and the DefBB are the same, compare locally.
  return locallyDominates(Dominator, cast<MemoryAccess>(Dominatee));
}
// If it's not a PHI node use, the normal dominates can already handle it.
return dominates(Dominator, cast<MemoryAccess>(Dominatee.getUser()));
2184}

2186void MemorySSA::ensureOptimizedUses() {
if (IsOptimized)
  return;

BatchAAResults BatchAA(*AA);
ClobberWalkerBase<BatchAAResults> WalkerBase(this, &BatchAA, DT);
CachingWalker<BatchAAResults> WalkerLocal(this, &WalkerBase);
OptimizeUses(this, &WalkerLocal, &BatchAA, DT).optimizeUses();
IsOptimized = true;
2195}

2197void MemoryAccess::print(raw_ostream &OS) const {
switch (getValueID()) {
case MemoryPhiVal: return static_cast<const MemoryPhi *>(this)->print(OS);
case MemoryDefVal: return static_cast<const MemoryDef *>(this)->print(OS);
case MemoryUseVal: return static_cast<const MemoryUse *>(this)->print(OS);
}
llvm_unreachable("invalid value id")::llvm::llvm_unreachable_internal("invalid value id", "llvm/lib/Analysis/MemorySSA.cpp"
, 2203);
2204}

2206void MemoryDef::print(raw_ostream &OS) const {
MemoryAccess *UO = getDefiningAccess();

auto printID = [&OS](MemoryAccess *A) {
  if (A && A->getID())
    OS << A->getID();
  else
    OS << LiveOnEntryStr;
};

OS << getID() << " = MemoryDef(";
printID(UO);
OS << ")";

if (isOptimized()) {
  OS << "->";
  printID(getOptimized());

  if (Optional<AliasResult> AR = getOptimizedAccessType())
    OS << " " << *AR;
}
2227}

2229void MemoryPhi::print(raw_ostream &OS) const {
ListSeparator LS(",");
OS << getID() << " = MemoryPhi(";
for (const auto &Op : operands()) {
  BasicBlock *BB = getIncomingBlock(Op);
  MemoryAccess *MA = cast<MemoryAccess>(Op);

  OS << LS << '{';
  if (BB->hasName())
    OS << BB->getName();
  else
    BB->printAsOperand(OS, false);
  OS << ',';
  if (unsigned ID = MA->getID())
    OS << ID;
  else
    OS << LiveOnEntryStr;
  OS << '}';
}
OS << ')';
2249}

2251void MemoryUse::print(raw_ostream &OS) const {
MemoryAccess *UO = getDefiningAccess();
OS << "MemoryUse(";
if (UO && UO->getID())
  OS << UO->getID();
else
  OS << LiveOnEntryStr;
OS << ')';

if (Optional<AliasResult> AR = getOptimizedAccessType())
  OS << " " << *AR;
2262}

2264void MemoryAccess::dump() const {
2265// Cannot completely remove virtual function even in release mode.
2266#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
print(dbgs());
dbgs() << "\n";
2269#endif
2270}

2272char MemorySSAPrinterLegacyPass::ID = 0;

2274MemorySSAPrinterLegacyPass::MemorySSAPrinterLegacyPass() : FunctionPass(ID) {
initializeMemorySSAPrinterLegacyPassPass(*PassRegistry::getPassRegistry());
2276}

2278void MemorySSAPrinterLegacyPass::getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequired<MemorySSAWrapperPass>();
2281}

2283class DOTFuncMSSAInfo {
2284private:
const Function &F;
MemorySSAAnnotatedWriter MSSAWriter;

2288public:
DOTFuncMSSAInfo(const Function &F, MemorySSA &MSSA)
    : F(F), MSSAWriter(&MSSA) {}

const Function *getFunction() { return &F; }
MemorySSAAnnotatedWriter &getWriter() { return MSSAWriter; }
2294};

2296namespace llvm {

2298template <>
2299struct GraphTraits<DOTFuncMSSAInfo *> : public GraphTraits<const BasicBlock *> {
static NodeRef getEntryNode(DOTFuncMSSAInfo *CFGInfo) {
  return &(CFGInfo->getFunction()->getEntryBlock());
}

// nodes_iterator/begin/end - Allow iteration over all nodes in the graph
using nodes_iterator = pointer_iterator<Function::const_iterator>;

static nodes_iterator nodes_begin(DOTFuncMSSAInfo *CFGInfo) {
  return nodes_iterator(CFGInfo->getFunction()->begin());
}

static nodes_iterator nodes_end(DOTFuncMSSAInfo *CFGInfo) {
  return nodes_iterator(CFGInfo->getFunction()->end());
}

static size_t size(DOTFuncMSSAInfo *CFGInfo) {
  return CFGInfo->getFunction()->size();
}
2318};

2320template <>
2321struct DOTGraphTraits<DOTFuncMSSAInfo *> : public DefaultDOTGraphTraits {

DOTGraphTraits(bool IsSimple = false) : DefaultDOTGraphTraits(IsSimple) {}

static std::string getGraphName(DOTFuncMSSAInfo *CFGInfo) {
  return "MSSA CFG for '" + CFGInfo->getFunction()->getName().str() +
         "' function";
}

std::string getNodeLabel(const BasicBlock *Node, DOTFuncMSSAInfo *CFGInfo) {
  return DOTGraphTraits<DOTFuncInfo *>::getCompleteNodeLabel(
      Node, nullptr,
      [CFGInfo](raw_string_ostream &OS, const BasicBlock &BB) -> void {
        BB.print(OS, &CFGInfo->getWriter(), true, true);
      },
      [](std::string &S, unsigned &I, unsigned Idx) -> void {
        std::string Str = S.substr(I, Idx - I);
        StringRef SR = Str;
        if (SR.count(" = MemoryDef(") || SR.count(" = MemoryPhi(") ||
            SR.count("MemoryUse("))
          return;
        DOTGraphTraits<DOTFuncInfo *>::eraseComment(S, I, Idx);
      });
}

static std::string getEdgeSourceLabel(const BasicBlock *Node,
                                      const_succ_iterator I) {
  return DOTGraphTraits<DOTFuncInfo *>::getEdgeSourceLabel(Node, I);
}

/// Display the raw branch weights from PGO.
std::string getEdgeAttributes(const BasicBlock *Node, const_succ_iterator I,
                              DOTFuncMSSAInfo *CFGInfo) {
  return "";
}

std::string getNodeAttributes(const BasicBlock *Node,
                              DOTFuncMSSAInfo *CFGInfo) {
  return getNodeLabel(Node, CFGInfo).find(';') != std::string::npos
             ? "style=filled, fillcolor=lightpink"
             : "";
}
2363};

2365} // namespace llvm

2367bool MemorySSAPrinterLegacyPass::runOnFunction(Function &F) {
auto &MSSA = getAnalysis<MemorySSAWrapperPass>().getMSSA();
MSSA.ensureOptimizedUses();
if (DotCFGMSSA != "") {
  DOTFuncMSSAInfo CFGInfo(F, MSSA);
  WriteGraph(&CFGInfo, "", false, "MSSA", DotCFGMSSA);
} else
  MSSA.print(dbgs());

if (VerifyMemorySSA)
  MSSA.verifyMemorySSA();
return false;
2379}

2381AnalysisKey MemorySSAAnalysis::Key;

2383MemorySSAAnalysis::Result MemorySSAAnalysis::run(Function &F,
                                               FunctionAnalysisManager &AM) {
auto &DT = AM.getResult<DominatorTreeAnalysis>(F);
auto &AA = AM.getResult<AAManager>(F);
return MemorySSAAnalysis::Result(std::make_unique<MemorySSA>(F, &AA, &DT));
2388}

2390bool MemorySSAAnalysis::Result::invalidate(
  Function &F, const PreservedAnalyses &PA,
  FunctionAnalysisManager::Invalidator &Inv) {
auto PAC = PA.getChecker<MemorySSAAnalysis>();
return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) ||
       Inv.invalidate<AAManager>(F, PA) ||
       Inv.invalidate<DominatorTreeAnalysis>(F, PA);
2397}

2399PreservedAnalyses MemorySSAPrinterPass::run(Function &F,
                                          FunctionAnalysisManager &AM) {
auto &MSSA = AM.getResult<MemorySSAAnalysis>(F).getMSSA();
MSSA.ensureOptimizedUses();
if (DotCFGMSSA != "") {
  DOTFuncMSSAInfo CFGInfo(F, MSSA);
  WriteGraph(&CFGInfo, "", false, "MSSA", DotCFGMSSA);
} else {
  OS << "MemorySSA for function: " << F.getName() << "\n";
  MSSA.print(OS);
}

return PreservedAnalyses::all();
2412}

2414PreservedAnalyses MemorySSAWalkerPrinterPass::run(Function &F,
                                                FunctionAnalysisManager &AM) {
auto &MSSA = AM.getResult<MemorySSAAnalysis>(F).getMSSA();
OS << "MemorySSA (walker) for function: " << F.getName() << "\n";
MemorySSAWalkerAnnotatedWriter Writer(&MSSA);
F.print(OS, &Writer);

return PreservedAnalyses::all();
2422}

2424PreservedAnalyses MemorySSAVerifierPass::run(Function &F,
                                           FunctionAnalysisManager &AM) {
AM.getResult<MemorySSAAnalysis>(F).getMSSA().verifyMemorySSA();

return PreservedAnalyses::all();
2429}

2431char MemorySSAWrapperPass::ID = 0;

2433MemorySSAWrapperPass::MemorySSAWrapperPass() : FunctionPass(ID) {
initializeMemorySSAWrapperPassPass(*PassRegistry::getPassRegistry());
2435}

2437void MemorySSAWrapperPass::releaseMemory() { MSSA.reset(); }

2439void MemorySSAWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequiredTransitive<DominatorTreeWrapperPass>();
AU.addRequiredTransitive<AAResultsWrapperPass>();
2443}

2445bool MemorySSAWrapperPass::runOnFunction(Function &F) {
auto &DT = getAnalysis<DominatorTreeWrapperPass>().getDomTree();
auto &AA = getAnalysis<AAResultsWrapperPass>().getAAResults();
MSSA.reset(new MemorySSA(F, &AA, &DT));
return false;
2450}

2452void MemorySSAWrapperPass::verifyAnalysis() const {
if (VerifyMemorySSA)
1
Assuming 'VerifyMemorySSA' is true→
2
←
Taking true branch→
  MSSA->verifyMemorySSA();
3
←
Calling 'MemorySSA::verifyMemorySSA'→
2455}

2457void MemorySSAWrapperPass::print(raw_ostream &OS, const Module *M) const {
MSSA->print(OS);
2459}

2461MemorySSAWalker::MemorySSAWalker(MemorySSA *M) : MSSA(M) {}

2463/// Walk the use-def chains starting at \p StartingAccess and find
2464/// the MemoryAccess that actually clobbers Loc.
2465///
2466/// \returns our clobbering memory access
2467template <typename AliasAnalysisType>
2468MemoryAccess *
2469MemorySSA::ClobberWalkerBase<AliasAnalysisType>::getClobberingMemoryAccessBase(
  MemoryAccess *StartingAccess, const MemoryLocation &Loc,
  unsigned &UpwardWalkLimit) {
assert(!isa<MemoryUse>(StartingAccess) && "Use cannot be defining access")(static_cast <bool> (!isa<MemoryUse>(StartingAccess
) && "Use cannot be defining access") ? void (0) : __assert_fail
 ("!isa<MemoryUse>(StartingAccess) && \"Use cannot be defining access\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2472, __extension__ __PRETTY_FUNCTION__
));

Instruction *I = nullptr;
if (auto *StartingUseOrDef = dyn_cast<MemoryUseOrDef>(StartingAccess)) {
  if (MSSA->isLiveOnEntryDef(StartingUseOrDef))
    return StartingUseOrDef;

  I = StartingUseOrDef->getMemoryInst();

  // Conservatively, fences are always clobbers, so don't perform the walk if
  // we hit a fence.
  if (!isa<CallBase>(I) && I->isFenceLike())
    return StartingUseOrDef;
}

UpwardsMemoryQuery Q;
Q.OriginalAccess = StartingAccess;
Q.StartingLoc = Loc;
Q.Inst = nullptr;
Q.IsCall = false;

// Unlike the other function, do not walk to the def of a def, because we are
// handed something we already believe is the clobbering access.
// We never set SkipSelf to true in Q in this method.
MemoryAccess *Clobber =
    Walker.findClobber(StartingAccess, Q, UpwardWalkLimit);
LLVM_DEBUG({do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { { dbgs() << "Clobber starting at access "
 << *StartingAccess << "\n"; if (I) dbgs() <<
 "  for instruction " << *I << "\n"; dbgs() <<
 "  is " << *Clobber << "\n"; }; } } while (false
)
  dbgs() << "Clobber starting at access " << *StartingAccess << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { { dbgs() << "Clobber starting at access "
 << *StartingAccess << "\n"; if (I) dbgs() <<
 "  for instruction " << *I << "\n"; dbgs() <<
 "  is " << *Clobber << "\n"; }; } } while (false
)
  if (I)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { { dbgs() << "Clobber starting at access "
 << *StartingAccess << "\n"; if (I) dbgs() <<
 "  for instruction " << *I << "\n"; dbgs() <<
 "  is " << *Clobber << "\n"; }; } } while (false
)
    dbgs() << "  for instruction " << *I << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { { dbgs() << "Clobber starting at access "
 << *StartingAccess << "\n"; if (I) dbgs() <<
 "  for instruction " << *I << "\n"; dbgs() <<
 "  is " << *Clobber << "\n"; }; } } while (false
)
  dbgs() << "  is " << *Clobber << "\n";do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { { dbgs() << "Clobber starting at access "
 << *StartingAccess << "\n"; if (I) dbgs() <<
 "  for instruction " << *I << "\n"; dbgs() <<
 "  is " << *Clobber << "\n"; }; } } while (false
)
})do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { { dbgs() << "Clobber starting at access "
 << *StartingAccess << "\n"; if (I) dbgs() <<
 "  for instruction " << *I << "\n"; dbgs() <<
 "  is " << *Clobber << "\n"; }; } } while (false
);
return Clobber;
2505}

2507static const Instruction *
2508getInvariantGroupClobberingInstruction(Instruction &I, DominatorTree &DT) {
if (!I.hasMetadata(LLVMContext::MD_invariant_group) || I.isVolatile())
  return nullptr;

// We consider bitcasts and zero GEPs to be the same pointer value. Start by
// stripping bitcasts and zero GEPs, then we will recursively look at loads
// and stores through bitcasts and zero GEPs.
Value *PointerOperand = getLoadStorePointerOperand(&I)->stripPointerCasts();

// It's not safe to walk the use list of a global value because function
// passes aren't allowed to look outside their functions.
// FIXME: this could be fixed by filtering instructions from outside of
// current function.
if (isa<Constant>(PointerOperand))
  return nullptr;

// Queue to process all pointers that are equivalent to load operand.
SmallVector<const Value *, 8> PointerUsesQueue;
PointerUsesQueue.push_back(PointerOperand);

const Instruction *MostDominatingInstruction = &I;

// FIXME: This loop is O(n^2) because dominates can be O(n) and in worst case
// we will see all the instructions. It may not matter in practice. If it
// does, we will have to support MemorySSA construction and updates.
while (!PointerUsesQueue.empty()) {
  const Value *Ptr = PointerUsesQueue.pop_back_val();
  assert(Ptr && !isa<GlobalValue>(Ptr) &&(static_cast <bool> (Ptr && !isa<GlobalValue
>(Ptr) && "Null or GlobalValue should not be inserted"
) ? void (0) : __assert_fail ("Ptr && !isa<GlobalValue>(Ptr) && \"Null or GlobalValue should not be inserted\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2536, __extension__ __PRETTY_FUNCTION__
))
         "Null or GlobalValue should not be inserted")(static_cast <bool> (Ptr && !isa<GlobalValue
>(Ptr) && "Null or GlobalValue should not be inserted"
) ? void (0) : __assert_fail ("Ptr && !isa<GlobalValue>(Ptr) && \"Null or GlobalValue should not be inserted\""
, "llvm/lib/Analysis/MemorySSA.cpp", 2536, __extension__ __PRETTY_FUNCTION__
));

  for (const User *Us : Ptr->users()) {
    auto *U = dyn_cast<Instruction>(Us);
    if (!U || U == &I || !DT.dominates(U, MostDominatingInstruction))
      continue;

    // Add bitcasts and zero GEPs to queue.
    if (isa<BitCastInst>(U)) {
      PointerUsesQueue.push_back(U);
      continue;
    }
    if (auto *GEP = dyn_cast<GetElementPtrInst>(U)) {
      if (GEP->hasAllZeroIndices())
        PointerUsesQueue.push_back(U);
      continue;
    }

    // If we hit a load/store with an invariant.group metadata and the same
    // pointer operand, we can assume that value pointed to by the pointer
    // operand didn't change.
    if (U->hasMetadata(LLVMContext::MD_invariant_group) &&
        getLoadStorePointerOperand(U) == Ptr && !U->isVolatile()) {
      MostDominatingInstruction = U;
    }
  }
}
return MostDominatingInstruction == &I ? nullptr : MostDominatingInstruction;
2564}

2566template <typename AliasAnalysisType>
2567MemoryAccess *
2568MemorySSA::ClobberWalkerBase<AliasAnalysisType>::getClobberingMemoryAccessBase(
  MemoryAccess *MA, unsigned &UpwardWalkLimit, bool SkipSelf,
  bool UseInvariantGroup) {
auto *StartingAccess = dyn_cast<MemoryUseOrDef>(MA);
// If this is a MemoryPhi, we can't do anything.
if (!StartingAccess)
  return MA;

if (UseInvariantGroup) {
  if (auto *I = getInvariantGroupClobberingInstruction(
          *StartingAccess->getMemoryInst(), MSSA->getDomTree())) {
    assert(isa<LoadInst>(I) || isa<StoreInst>(I))(static_cast <bool> (isa<LoadInst>(I) || isa<StoreInst
>(I)) ? void (0) : __assert_fail ("isa<LoadInst>(I) || isa<StoreInst>(I)"
, "llvm/lib/Analysis/MemorySSA.cpp", 2579, __extension__ __PRETTY_FUNCTION__
));

    auto *ClobberMA = MSSA->getMemoryAccess(I);
    assert(ClobberMA)(static_cast <bool> (ClobberMA) ? void (0) : __assert_fail
 ("ClobberMA", "llvm/lib/Analysis/MemorySSA.cpp", 2582, __extension__
 __PRETTY_FUNCTION__));
    if (isa<MemoryUse>(ClobberMA))
      return ClobberMA->getDefiningAccess();
    return ClobberMA;
  }
}

bool IsOptimized = false;

// If this is an already optimized use or def, return the optimized result.
// Note: Currently, we store the optimized def result in a separate field,
// since we can't use the defining access.
if (StartingAccess->isOptimized()) {
  if (!SkipSelf || !isa<MemoryDef>(StartingAccess))
    return StartingAccess->getOptimized();
  IsOptimized = true;
}

const Instruction *I = StartingAccess->getMemoryInst();
// We can't sanely do anything with a fence, since they conservatively clobber
// all memory, and have no locations to get pointers from to try to
// disambiguate.
if (!isa<CallBase>(I) && I->isFenceLike())
  return StartingAccess;

UpwardsMemoryQuery Q(I, StartingAccess);

if (isUseTriviallyOptimizableToLiveOnEntry(*Walker.getAA(), I)) {
  MemoryAccess *LiveOnEntry = MSSA->getLiveOnEntryDef();
  StartingAccess->setOptimized(LiveOnEntry);
  StartingAccess->setOptimizedAccessType(None);
  return LiveOnEntry;
}

MemoryAccess *OptimizedAccess;
if (!IsOptimized) {
  // Start with the thing we already think clobbers this location
  MemoryAccess *DefiningAccess = StartingAccess->getDefiningAccess();

  // At this point, DefiningAccess may be the live on entry def.
  // If it is, we will not get a better result.
  if (MSSA->isLiveOnEntryDef(DefiningAccess)) {
    StartingAccess->setOptimized(DefiningAccess);
    StartingAccess->setOptimizedAccessType(None);
    return DefiningAccess;
  }

  OptimizedAccess = Walker.findClobber(DefiningAccess, Q, UpwardWalkLimit);
  StartingAccess->setOptimized(OptimizedAccess);
  if (MSSA->isLiveOnEntryDef(OptimizedAccess))
    StartingAccess->setOptimizedAccessType(None);
  else if (Q.AR && *Q.AR == AliasResult::MustAlias)
    StartingAccess->setOptimizedAccessType(
        AliasResult(AliasResult::MustAlias));
} else
  OptimizedAccess = StartingAccess->getOptimized();

LLVM_DEBUG(dbgs() << "Starting Memory SSA clobber for " << *I << " is ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "Starting Memory SSA clobber for "
 << *I << " is "; } } while (false);
LLVM_DEBUG(dbgs() << *StartingAccess << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << *StartingAccess << "\n"
; } } while (false);
LLVM_DEBUG(dbgs() << "Optimized Memory SSA clobber for " << *I << " is ")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "Optimized Memory SSA clobber for "
 << *I << " is "; } } while (false);
LLVM_DEBUG(dbgs() << *OptimizedAccess << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << *OptimizedAccess << "\n"
; } } while (false);

MemoryAccess *Result;
if (SkipSelf && isa<MemoryPhi>(OptimizedAccess) &&
    isa<MemoryDef>(StartingAccess) && UpwardWalkLimit) {
  assert(isa<MemoryDef>(Q.OriginalAccess))(static_cast <bool> (isa<MemoryDef>(Q.OriginalAccess
)) ? void (0) : __assert_fail ("isa<MemoryDef>(Q.OriginalAccess)"
, "llvm/lib/Analysis/MemorySSA.cpp", 2647, __extension__ __PRETTY_FUNCTION__
));
  Q.SkipSelfAccess = true;
  Result = Walker.findClobber(OptimizedAccess, Q, UpwardWalkLimit);
} else
  Result = OptimizedAccess;

LLVM_DEBUG(dbgs() << "Result Memory SSA clobber [SkipSelf = " << SkipSelf)do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "Result Memory SSA clobber [SkipSelf = "
 << SkipSelf; } } while (false);
LLVM_DEBUG(dbgs() << "] for " << *I << " is " << *Result << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("memoryssa")) { dbgs() << "] for " << *I <<
 " is " << *Result << "\n"; } } while (false);

return Result;
2657}

2659MemoryAccess *
2660DoNothingMemorySSAWalker::getClobberingMemoryAccess(MemoryAccess *MA) {
if (auto *Use = dyn_cast<MemoryUseOrDef>(MA))
  return Use->getDefiningAccess();
return MA;
2664}

2666MemoryAccess *DoNothingMemorySSAWalker::getClobberingMemoryAccess(
  MemoryAccess *StartingAccess, const MemoryLocation &) {
if (auto *Use = dyn_cast<MemoryUseOrDef>(StartingAccess))
  return Use->getDefiningAccess();
return StartingAccess;
2671}

2673void MemoryPhi::deleteMe(DerivedUser *Self) {
delete static_cast<MemoryPhi *>(Self);
2675}

2677void MemoryDef::deleteMe(DerivedUser *Self) {
delete static_cast<MemoryDef *>(Self);
2679}

2681void MemoryUse::deleteMe(DerivedUser *Self) {
delete static_cast<MemoryUse *>(Self);
2683}

2685bool upward_defs_iterator::IsGuaranteedLoopInvariant(Value *Ptr) const {
auto IsGuaranteedLoopInvariantBase = [](Value *Ptr) {
  Ptr = Ptr->stripPointerCasts();
  if (!isa<Instruction>(Ptr))
    return true;
  return isa<AllocaInst>(Ptr);
};

Ptr = Ptr->stripPointerCasts();
if (auto *I = dyn_cast<Instruction>(Ptr)) {
  if (I->getParent()->isEntryBlock())
    return true;
}
if (auto *GEP = dyn_cast<GEPOperator>(Ptr)) {
  return IsGuaranteedLoopInvariantBase(GEP->getPointerOperand()) &&
         GEP->hasAllConstantIndices();
}
return IsGuaranteedLoopInvariantBase(Ptr);
2703}

←

/build/llvm-toolchain-snapshot-15~++20220420111733+e13d2efed663/llvm/include/llvm/Analysis/MemorySSA.h

1//===- MemorySSA.h - Build Memory SSA ---------------------------*- 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 exposes an interface to building/using memory SSA to
11/// walk memory instructions using a use/def graph.
12///
13/// Memory SSA class builds an SSA form that links together memory access
14/// instructions such as loads, stores, atomics, and calls. Additionally, it
15/// does a trivial form of "heap versioning" Every time the memory state changes
16/// in the program, we generate a new heap version. It generates
17/// MemoryDef/Uses/Phis that are overlayed on top of the existing instructions.
18///
19/// As a trivial example,
20/// define i32 @main() #0 {
21/// entry:
22///   %call = call noalias i8* @_Znwm(i64 4) #2
23///   %0 = bitcast i8* %call to i32*
24///   %call1 = call noalias i8* @_Znwm(i64 4) #2
25///   %1 = bitcast i8* %call1 to i32*
26///   store i32 5, i32* %0, align 4
27///   store i32 7, i32* %1, align 4
28///   %2 = load i32* %0, align 4
29///   %3 = load i32* %1, align 4
30///   %add = add nsw i32 %2, %3
31///   ret i32 %add
32/// }
33///
34/// Will become
35/// define i32 @main() #0 {
36/// entry:
37///   ; 1 = MemoryDef(0)
38///   %call = call noalias i8* @_Znwm(i64 4) #3
39///   %2 = bitcast i8* %call to i32*
40///   ; 2 = MemoryDef(1)
41///   %call1 = call noalias i8* @_Znwm(i64 4) #3
42///   %4 = bitcast i8* %call1 to i32*
43///   ; 3 = MemoryDef(2)
44///   store i32 5, i32* %2, align 4
45///   ; 4 = MemoryDef(3)
46///   store i32 7, i32* %4, align 4
47///   ; MemoryUse(3)
48///   %7 = load i32* %2, align 4
49///   ; MemoryUse(4)
50///   %8 = load i32* %4, align 4
51///   %add = add nsw i32 %7, %8
52///   ret i32 %add
53/// }
54///
55/// Given this form, all the stores that could ever effect the load at %8 can be
56/// gotten by using the MemoryUse associated with it, and walking from use to
57/// def until you hit the top of the function.
58///
59/// Each def also has a list of users associated with it, so you can walk from
60/// both def to users, and users to defs. Note that we disambiguate MemoryUses,
61/// but not the RHS of MemoryDefs. You can see this above at %7, which would
62/// otherwise be a MemoryUse(4). Being disambiguated means that for a given
63/// store, all the MemoryUses on its use lists are may-aliases of that store
64/// (but the MemoryDefs on its use list may not be).
65///
66/// MemoryDefs are not disambiguated because it would require multiple reaching
67/// definitions, which would require multiple phis, and multiple memoryaccesses
68/// per instruction.
69///
70/// In addition to the def/use graph described above, MemoryDefs also contain
71/// an "optimized" definition use.  The "optimized" use points to some def
72/// reachable through the memory def chain.  The optimized def *may* (but is
73/// not required to) alias the original MemoryDef, but no def *closer* to the
74/// source def may alias it.  As the name implies, the purpose of the optimized
75/// use is to allow caching of clobber searches for memory defs.  The optimized
76/// def may be nullptr, in which case clients must walk the defining access
77/// chain.
78///
79/// When iterating the uses of a MemoryDef, both defining uses and optimized
80/// uses will be encountered.  If only one type is needed, the client must
81/// filter the use walk.
82//
83//===----------------------------------------------------------------------===//
84 
85#ifndef LLVM_ANALYSIS_MEMORYSSA_H
86#define LLVM_ANALYSIS_MEMORYSSA_H
87 
88#include "llvm/ADT/DenseMap.h"
89#include "llvm/ADT/SmallPtrSet.h"
90#include "llvm/ADT/SmallVector.h"
91#include "llvm/ADT/ilist_node.h"
92#include "llvm/ADT/iterator_range.h"
93#include "llvm/Analysis/AliasAnalysis.h"
94#include "llvm/Analysis/MemoryLocation.h"
95#include "llvm/Analysis/PHITransAddr.h"
96#include "llvm/IR/DerivedUser.h"
97#include "llvm/IR/Dominators.h"
98#include "llvm/IR/Type.h"
99#include "llvm/IR/User.h"
100#include "llvm/Pass.h"
101#include <algorithm>
102#include <cassert>
103#include <cstddef>
104#include <iterator>
105#include <memory>
106#include <utility>
107 
108namespace llvm {
109 
110template <class GraphType> struct GraphTraits;
111class BasicBlock;
112class Function;
113class Instruction;
114class LLVMContext;
115class MemoryAccess;
116class MemorySSAWalker;
117class Module;
118class Use;
119class Value;
120class raw_ostream;
121 
122namespace MSSAHelpers {
123 
124struct AllAccessTag {};
125struct DefsOnlyTag {};
126 
127} // end namespace MSSAHelpers
128 
129enum : unsigned {
130  // Used to signify what the default invalid ID is for MemoryAccess's
131  // getID()
132  INVALID_MEMORYACCESS_ID = -1U
133};
134 
135template <class T> class memoryaccess_def_iterator_base;
136using memoryaccess_def_iterator = memoryaccess_def_iterator_base<MemoryAccess>;
137using const_memoryaccess_def_iterator =
138    memoryaccess_def_iterator_base<const MemoryAccess>;
139 
140// The base for all memory accesses. All memory accesses in a block are
141// linked together using an intrusive list.
142class MemoryAccess
143    : public DerivedUser,
144      public ilist_node<MemoryAccess, ilist_tag<MSSAHelpers::AllAccessTag>>,
145      public ilist_node<MemoryAccess, ilist_tag<MSSAHelpers::DefsOnlyTag>> {
146public:
147  using AllAccessType =
148      ilist_node<MemoryAccess, ilist_tag<MSSAHelpers::AllAccessTag>>;
149  using DefsOnlyType =
150      ilist_node<MemoryAccess, ilist_tag<MSSAHelpers::DefsOnlyTag>>;
151 
152  MemoryAccess(const MemoryAccess &) = delete;
153  MemoryAccess &operator=(const MemoryAccess &) = delete;
154 
155  void *operator new(size_t) = delete;
156 
157  // Methods for support type inquiry through isa, cast, and
158  // dyn_cast
159  static bool classof(const Value *V) {
160    unsigned ID = V->getValueID();
161    return ID == MemoryUseVal || ID == MemoryPhiVal || ID == MemoryDefVal;
162  }
163 
164  BasicBlock *getBlock() const { return Block; }
165 
166  void print(raw_ostream &OS) const;
167  void dump() const;
168 
169  /// The user iterators for a memory access
170  using iterator = user_iterator;
171  using const_iterator = const_user_iterator;
172 
173  /// This iterator walks over all of the defs in a given
174  /// MemoryAccess. For MemoryPhi nodes, this walks arguments. For
175  /// MemoryUse/MemoryDef, this walks the defining access.
176  memoryaccess_def_iterator defs_begin();
177  const_memoryaccess_def_iterator defs_begin() const;
178  memoryaccess_def_iterator defs_end();
179  const_memoryaccess_def_iterator defs_end() const;
180 
181  /// Get the iterators for the all access list and the defs only list
182  /// We default to the all access list.
183  AllAccessType::self_iterator getIterator() {
184    return this->AllAccessType::getIterator();
185  }
186  AllAccessType::const_self_iterator getIterator() const {
187    return this->AllAccessType::getIterator();
188  }
189  AllAccessType::reverse_self_iterator getReverseIterator() {
190    return this->AllAccessType::getReverseIterator();
191  }
192  AllAccessType::const_reverse_self_iterator getReverseIterator() const {
193    return this->AllAccessType::getReverseIterator();
194  }
195  DefsOnlyType::self_iterator getDefsIterator() {
196    return this->DefsOnlyType::getIterator();
197  }
198  DefsOnlyType::const_self_iterator getDefsIterator() const {
199    return this->DefsOnlyType::getIterator();
200  }
201  DefsOnlyType::reverse_self_iterator getReverseDefsIterator() {
202    return this->DefsOnlyType::getReverseIterator();
203  }
204  DefsOnlyType::const_reverse_self_iterator getReverseDefsIterator() const {
205    return this->DefsOnlyType::getReverseIterator();
206  }
207 
208protected:
209  friend class MemoryDef;
210  friend class MemoryPhi;
211  friend class MemorySSA;
212  friend class MemoryUse;
213  friend class MemoryUseOrDef;
214 
215  /// Used by MemorySSA to change the block of a MemoryAccess when it is
216  /// moved.
217  void setBlock(BasicBlock *BB) { Block = BB; }
218 
219  /// Used for debugging and tracking things about MemoryAccesses.
220  /// Guaranteed unique among MemoryAccesses, no guarantees otherwise.
221  inline unsigned getID() const;
222 
223  MemoryAccess(LLVMContext &C, unsigned Vty, DeleteValueTy DeleteValue,
224               BasicBlock *BB, unsigned NumOperands)
225      : DerivedUser(Type::getVoidTy(C), Vty, nullptr, NumOperands, DeleteValue),
226        Block(BB) {}
227 
228  // Use deleteValue() to delete a generic MemoryAccess.
229  ~MemoryAccess() = default;
230 
231private:
232  BasicBlock *Block;
233};
234 
235template <>
236struct ilist_alloc_traits<MemoryAccess> {
237  static void deleteNode(MemoryAccess *MA) { MA->deleteValue(); }
238};
239 
240inline raw_ostream &operator<<(raw_ostream &OS, const MemoryAccess &MA) {
241  MA.print(OS);
242  return OS;
243}
244 
245/// Class that has the common methods + fields of memory uses/defs. It's
246/// a little awkward to have, but there are many cases where we want either a
247/// use or def, and there are many cases where uses are needed (defs aren't
248/// acceptable), and vice-versa.
249///
250/// This class should never be instantiated directly; make a MemoryUse or
251/// MemoryDef instead.
252class MemoryUseOrDef : public MemoryAccess {
253public:
254  void *operator new(size_t) = delete;
255 
256  DECLARE_TRANSPARENT_OPERAND_ACCESSORS(MemoryAccess)public: inline MemoryAccess *getOperand(unsigned) const; inline
 void setOperand(unsigned, MemoryAccess*); inline op_iterator
 op_begin(); inline const_op_iterator op_begin() const; inline
 op_iterator op_end(); inline const_op_iterator op_end() const
; protected: template <int> inline Use &Op(); template
 <int> inline const Use &Op() const; public: inline
 unsigned getNumOperands() const;
257 
258  /// Get the instruction that this MemoryUse represents.
259  Instruction *getMemoryInst() const { return MemoryInstruction; }
260 
261  /// Get the access that produces the memory state used by this Use.
262  MemoryAccess *getDefiningAccess() const { return getOperand(0); }
263 
264  static bool classof(const Value *MA) {
265    return MA->getValueID() == MemoryUseVal || MA->getValueID() == MemoryDefVal;
266  }
267 
268  /// Do we have an optimized use?
269  inline bool isOptimized() const;
270  /// Return the MemoryAccess associated with the optimized use, or nullptr.
271  inline MemoryAccess *getOptimized() const;
272  /// Sets the optimized use for a MemoryDef.
273  inline void setOptimized(MemoryAccess *);
274 
275  // Retrieve AliasResult type of the optimized access. Ideally this would be
276  // returned by the caching walker and may go away in the future.
277  Optional<AliasResult> getOptimizedAccessType() const {
278    return isOptimized() ? OptimizedAccessAlias : None;
279  }
280 
281  /// Reset the ID of what this MemoryUse was optimized to, causing it to
282  /// be rewalked by the walker if necessary.
283  /// This really should only be called by tests.
284  inline void resetOptimized();
285 
286protected:
287  friend class MemorySSA;
288  friend class MemorySSAUpdater;
289 
290  MemoryUseOrDef(LLVMContext &C, MemoryAccess *DMA, unsigned Vty,
291                 DeleteValueTy DeleteValue, Instruction *MI, BasicBlock *BB,
292                 unsigned NumOperands)
293      : MemoryAccess(C, Vty, DeleteValue, BB, NumOperands),
294        MemoryInstruction(MI), OptimizedAccessAlias(AliasResult::MayAlias) {
295    setDefiningAccess(DMA);
296  }
297 
298  // Use deleteValue() to delete a generic MemoryUseOrDef.
299  ~MemoryUseOrDef() = default;
300 
301  void setOptimizedAccessType(Optional<AliasResult> AR) {
302    OptimizedAccessAlias = AR;
303  }
304 
305  void setDefiningAccess(
306      MemoryAccess *DMA, bool Optimized = false,
307      Optional<AliasResult> AR = AliasResult(AliasResult::MayAlias)) {
308    if (!Optimized) {
309      setOperand(0, DMA);
310      return;
311    }
312    setOptimized(DMA);
313    setOptimizedAccessType(AR);
314  }
315 
316private:
317  Instruction *MemoryInstruction;
318  Optional<AliasResult> OptimizedAccessAlias;
319};
320 
321/// Represents read-only accesses to memory
322///
323/// In particular, the set of Instructions that will be represented by
324/// MemoryUse's is exactly the set of Instructions for which
325/// AliasAnalysis::getModRefInfo returns "Ref".
326class MemoryUse final : public MemoryUseOrDef {
327public:
328  DECLARE_TRANSPARENT_OPERAND_ACCESSORS(MemoryAccess)public: inline MemoryAccess *getOperand(unsigned) const; inline
 void setOperand(unsigned, MemoryAccess*); inline op_iterator
 op_begin(); inline const_op_iterator op_begin() const; inline
 op_iterator op_end(); inline const_op_iterator op_end() const
; protected: template <int> inline Use &Op(); template
 <int> inline const Use &Op() const; public: inline
 unsigned getNumOperands() const;
329 
330  MemoryUse(LLVMContext &C, MemoryAccess *DMA, Instruction *MI, BasicBlock *BB)
331      : MemoryUseOrDef(C, DMA, MemoryUseVal, deleteMe, MI, BB,
332                       /*NumOperands=*/1) {}
333 
334  // allocate space for exactly one operand
335  void *operator new(size_t S) { return User::operator new(S, 1); }
336  void operator delete(void *Ptr) { User::operator delete(Ptr); }
337 
338  static bool classof(const Value *MA) {
339    return MA->getValueID() == MemoryUseVal;
340  }
341 
342  void print(raw_ostream &OS) const;
343 
344  void setOptimized(MemoryAccess *DMA) {
345    OptimizedID = DMA->getID();
346    setOperand(0, DMA);
347  }
348 
349  /// Whether the MemoryUse is optimized. If ensureOptimizedUses() was called,
350  /// uses will usually be optimized, but this is not guaranteed (e.g. due to
351  /// invalidation and optimization limits.)
352  bool isOptimized() const {
353    return getDefiningAccess() && OptimizedID == getDefiningAccess()->getID();
354  }
355 
356  MemoryAccess *getOptimized() const {
357    return getDefiningAccess();
358  }
359 
360  void resetOptimized() {
361    OptimizedID = INVALID_MEMORYACCESS_ID;
362  }
363 
364protected:
365  friend class MemorySSA;
366 
367private:
368  static void deleteMe(DerivedUser *Self);
369 
370  unsigned OptimizedID = INVALID_MEMORYACCESS_ID;
371};
372 
373template <>
374struct OperandTraits<MemoryUse> : public FixedNumOperandTraits<MemoryUse, 1> {};
375DEFINE_TRANSPARENT_OPERAND_ACCESSORS(MemoryUse, MemoryAccess)MemoryUse::op_iterator MemoryUse::op_begin() { return OperandTraits
<MemoryUse>::op_begin(this); } MemoryUse::const_op_iterator
 MemoryUse::op_begin() const { return OperandTraits<MemoryUse
>::op_begin(const_cast<MemoryUse*>(this)); } MemoryUse
::op_iterator MemoryUse::op_end() { return OperandTraits<MemoryUse
>::op_end(this); } MemoryUse::const_op_iterator MemoryUse::
op_end() const { return OperandTraits<MemoryUse>::op_end
(const_cast<MemoryUse*>(this)); } MemoryAccess *MemoryUse
::getOperand(unsigned i_nocapture) const { (static_cast <bool
> (i_nocapture < OperandTraits<MemoryUse>::operands
(this) && "getOperand() out of range!") ? void (0) : __assert_fail
 ("i_nocapture < OperandTraits<MemoryUse>::operands(this) && \"getOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 375, __extension__
 __PRETTY_FUNCTION__)); return cast_or_null<MemoryAccess>
( OperandTraits<MemoryUse>::op_begin(const_cast<MemoryUse
*>(this))[i_nocapture].get()); } void MemoryUse::setOperand
(unsigned i_nocapture, MemoryAccess *Val_nocapture) { (static_cast
 <bool> (i_nocapture < OperandTraits<MemoryUse>
::operands(this) && "setOperand() out of range!") ? void
 (0) : __assert_fail ("i_nocapture < OperandTraits<MemoryUse>::operands(this) && \"setOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 375, __extension__
 __PRETTY_FUNCTION__)); OperandTraits<MemoryUse>::op_begin
(this)[i_nocapture] = Val_nocapture; } unsigned MemoryUse::getNumOperands
() const { return OperandTraits<MemoryUse>::operands(this
); } template <int Idx_nocapture> Use &MemoryUse::Op
() { return this->OpFrom<Idx_nocapture>(this); } template
 <int Idx_nocapture> const Use &MemoryUse::Op() const
 { return this->OpFrom<Idx_nocapture>(this); }
376 
377/// Represents a read-write access to memory, whether it is a must-alias,
378/// or a may-alias.
379///
380/// In particular, the set of Instructions that will be represented by
381/// MemoryDef's is exactly the set of Instructions for which
382/// AliasAnalysis::getModRefInfo returns "Mod" or "ModRef".
383/// Note that, in order to provide def-def chains, all defs also have a use
384/// associated with them. This use points to the nearest reaching
385/// MemoryDef/MemoryPhi.
386class MemoryDef final : public MemoryUseOrDef {
387public:
388  friend class MemorySSA;
389 
390  DECLARE_TRANSPARENT_OPERAND_ACCESSORS(MemoryAccess)public: inline MemoryAccess *getOperand(unsigned) const; inline
 void setOperand(unsigned, MemoryAccess*); inline op_iterator
 op_begin(); inline const_op_iterator op_begin() const; inline
 op_iterator op_end(); inline const_op_iterator op_end() const
; protected: template <int> inline Use &Op(); template
 <int> inline const Use &Op() const; public: inline
 unsigned getNumOperands() const;
391 
392  MemoryDef(LLVMContext &C, MemoryAccess *DMA, Instruction *MI, BasicBlock *BB,
393            unsigned Ver)
394      : MemoryUseOrDef(C, DMA, MemoryDefVal, deleteMe, MI, BB,
395                       /*NumOperands=*/2),
396        ID(Ver) {}
397 
398  // allocate space for exactly two operands
399  void *operator new(size_t S) { return User::operator new(S, 2); }
400  void operator delete(void *Ptr) { User::operator delete(Ptr); }
401 
402  static bool classof(const Value *MA) {
403    return MA->getValueID() == MemoryDefVal;
404  }
405 
406  void setOptimized(MemoryAccess *MA) {
407    setOperand(1, MA);
408    OptimizedID = MA->getID();
409  }
410 
411  MemoryAccess *getOptimized() const {
412    return cast_or_null<MemoryAccess>(getOperand(1));
413  }
414 
415  bool isOptimized() const {
416    return getOptimized() && OptimizedID == getOptimized()->getID();
417  }
418 
419  void resetOptimized() {
420    OptimizedID = INVALID_MEMORYACCESS_ID;
421    setOperand(1, nullptr);
422  }
423 
424  void print(raw_ostream &OS) const;
425 
426  unsigned getID() const { return ID; }
427 
428private:
429  static void deleteMe(DerivedUser *Self);
430 
431  const unsigned ID;
432  unsigned OptimizedID = INVALID_MEMORYACCESS_ID;
433};
434 
435template <>
436struct OperandTraits<MemoryDef> : public FixedNumOperandTraits<MemoryDef, 2> {};
437DEFINE_TRANSPARENT_OPERAND_ACCESSORS(MemoryDef, MemoryAccess)MemoryDef::op_iterator MemoryDef::op_begin() { return OperandTraits
<MemoryDef>::op_begin(this); } MemoryDef::const_op_iterator
 MemoryDef::op_begin() const { return OperandTraits<MemoryDef
>::op_begin(const_cast<MemoryDef*>(this)); } MemoryDef
::op_iterator MemoryDef::op_end() { return OperandTraits<MemoryDef
>::op_end(this); } MemoryDef::const_op_iterator MemoryDef::
op_end() const { return OperandTraits<MemoryDef>::op_end
(const_cast<MemoryDef*>(this)); } MemoryAccess *MemoryDef
::getOperand(unsigned i_nocapture) const { (static_cast <bool
> (i_nocapture < OperandTraits<MemoryDef>::operands
(this) && "getOperand() out of range!") ? void (0) : __assert_fail
 ("i_nocapture < OperandTraits<MemoryDef>::operands(this) && \"getOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 437, __extension__
 __PRETTY_FUNCTION__)); return cast_or_null<MemoryAccess>
( OperandTraits<MemoryDef>::op_begin(const_cast<MemoryDef
*>(this))[i_nocapture].get()); } void MemoryDef::setOperand
(unsigned i_nocapture, MemoryAccess *Val_nocapture) { (static_cast
 <bool> (i_nocapture < OperandTraits<MemoryDef>
::operands(this) && "setOperand() out of range!") ? void
 (0) : __assert_fail ("i_nocapture < OperandTraits<MemoryDef>::operands(this) && \"setOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 437, __extension__
 __PRETTY_FUNCTION__)); OperandTraits<MemoryDef>::op_begin
(this)[i_nocapture] = Val_nocapture; } unsigned MemoryDef::getNumOperands
() const { return OperandTraits<MemoryDef>::operands(this
); } template <int Idx_nocapture> Use &MemoryDef::Op
() { return this->OpFrom<Idx_nocapture>(this); } template
 <int Idx_nocapture> const Use &MemoryDef::Op() const
 { return this->OpFrom<Idx_nocapture>(this); }
438 
439template <>
440struct OperandTraits<MemoryUseOrDef> {
441  static Use *op_begin(MemoryUseOrDef *MUD) {
442    if (auto *MU = dyn_cast<MemoryUse>(MUD))
443      return OperandTraits<MemoryUse>::op_begin(MU);
444    return OperandTraits<MemoryDef>::op_begin(cast<MemoryDef>(MUD));
445  }
446 
447  static Use *op_end(MemoryUseOrDef *MUD) {
448    if (auto *MU = dyn_cast<MemoryUse>(MUD))
449      return OperandTraits<MemoryUse>::op_end(MU);
450    return OperandTraits<MemoryDef>::op_end(cast<MemoryDef>(MUD));
451  }
452 
453  static unsigned operands(const MemoryUseOrDef *MUD) {
454    if (const auto *MU = dyn_cast<MemoryUse>(MUD))
455      return OperandTraits<MemoryUse>::operands(MU);
456    return OperandTraits<MemoryDef>::operands(cast<MemoryDef>(MUD));
457  }
458};
459DEFINE_TRANSPARENT_OPERAND_ACCESSORS(MemoryUseOrDef, MemoryAccess)MemoryUseOrDef::op_iterator MemoryUseOrDef::op_begin() { return
 OperandTraits<MemoryUseOrDef>::op_begin(this); } MemoryUseOrDef
::const_op_iterator MemoryUseOrDef::op_begin() const { return
 OperandTraits<MemoryUseOrDef>::op_begin(const_cast<
MemoryUseOrDef*>(this)); } MemoryUseOrDef::op_iterator MemoryUseOrDef
::op_end() { return OperandTraits<MemoryUseOrDef>::op_end
(this); } MemoryUseOrDef::const_op_iterator MemoryUseOrDef::op_end
() const { return OperandTraits<MemoryUseOrDef>::op_end
(const_cast<MemoryUseOrDef*>(this)); } MemoryAccess *MemoryUseOrDef
::getOperand(unsigned i_nocapture) const { (static_cast <bool
> (i_nocapture < OperandTraits<MemoryUseOrDef>::operands
(this) && "getOperand() out of range!") ? void (0) : __assert_fail
 ("i_nocapture < OperandTraits<MemoryUseOrDef>::operands(this) && \"getOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 459, __extension__
 __PRETTY_FUNCTION__)); return cast_or_null<MemoryAccess>
( OperandTraits<MemoryUseOrDef>::op_begin(const_cast<
MemoryUseOrDef*>(this))[i_nocapture].get()); } void MemoryUseOrDef
::setOperand(unsigned i_nocapture, MemoryAccess *Val_nocapture
) { (static_cast <bool> (i_nocapture < OperandTraits
<MemoryUseOrDef>::operands(this) && "setOperand() out of range!"
) ? void (0) : __assert_fail ("i_nocapture < OperandTraits<MemoryUseOrDef>::operands(this) && \"setOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 459, __extension__
 __PRETTY_FUNCTION__)); OperandTraits<MemoryUseOrDef>::
op_begin(this)[i_nocapture] = Val_nocapture; } unsigned MemoryUseOrDef
::getNumOperands() const { return OperandTraits<MemoryUseOrDef
>::operands(this); } template <int Idx_nocapture> Use
 &MemoryUseOrDef::Op() { return this->OpFrom<Idx_nocapture
>(this); } template <int Idx_nocapture> const Use &
MemoryUseOrDef::Op() const { return this->OpFrom<Idx_nocapture
>(this); }
460 
461/// Represents phi nodes for memory accesses.
462///
463/// These have the same semantic as regular phi nodes, with the exception that
464/// only one phi will ever exist in a given basic block.
465/// Guaranteeing one phi per block means guaranteeing there is only ever one
466/// valid reaching MemoryDef/MemoryPHI along each path to the phi node.
467/// This is ensured by not allowing disambiguation of the RHS of a MemoryDef or
468/// a MemoryPhi's operands.
469/// That is, given
470/// if (a) {
471///   store %a
472///   store %b
473/// }
474/// it *must* be transformed into
475/// if (a) {
476///    1 = MemoryDef(liveOnEntry)
477///    store %a
478///    2 = MemoryDef(1)
479///    store %b
480/// }
481/// and *not*
482/// if (a) {
483///    1 = MemoryDef(liveOnEntry)
484///    store %a
485///    2 = MemoryDef(liveOnEntry)
486///    store %b
487/// }
488/// even if the two stores do not conflict. Otherwise, both 1 and 2 reach the
489/// end of the branch, and if there are not two phi nodes, one will be
490/// disconnected completely from the SSA graph below that point.
491/// Because MemoryUse's do not generate new definitions, they do not have this
492/// issue.
493class MemoryPhi final : public MemoryAccess {
494  // allocate space for exactly zero operands
495  void *operator new(size_t S) { return User::operator new(S); }
496 
497public:
498  void operator delete(void *Ptr) { User::operator delete(Ptr); }
499 
500  /// Provide fast operand accessors
501  DECLARE_TRANSPARENT_OPERAND_ACCESSORS(MemoryAccess)public: inline MemoryAccess *getOperand(unsigned) const; inline
 void setOperand(unsigned, MemoryAccess*); inline op_iterator
 op_begin(); inline const_op_iterator op_begin() const; inline
 op_iterator op_end(); inline const_op_iterator op_end() const
; protected: template <int> inline Use &Op(); template
 <int> inline const Use &Op() const; public: inline
 unsigned getNumOperands() const;
502 
503  MemoryPhi(LLVMContext &C, BasicBlock *BB, unsigned Ver, unsigned NumPreds = 0)
504      : MemoryAccess(C, MemoryPhiVal, deleteMe, BB, 0), ID(Ver),
505        ReservedSpace(NumPreds) {
506    allocHungoffUses(ReservedSpace);
507  }
508 
509  // Block iterator interface. This provides access to the list of incoming
510  // basic blocks, which parallels the list of incoming values.
511  using block_iterator = BasicBlock **;
512  using const_block_iterator = BasicBlock *const *;
513 
514  block_iterator block_begin() {
515    return reinterpret_cast<block_iterator>(op_begin() + ReservedSpace);
516  }
517 
518  const_block_iterator block_begin() const {
519    return reinterpret_cast<const_block_iterator>(op_begin() + ReservedSpace);
520  }
521 
522  block_iterator block_end() { return block_begin() + getNumOperands(); }
523 
524  const_block_iterator block_end() const {
525    return block_begin() + getNumOperands();
526  }
527 
528  iterator_range<block_iterator> blocks() {
529    return make_range(block_begin(), block_end());
530  }
531 
532  iterator_range<const_block_iterator> blocks() const {
533    return make_range(block_begin(), block_end());
534  }
535 
536  op_range incoming_values() { return operands(); }
537 
538  const_op_range incoming_values() const { return operands(); }
539 
540  /// Return the number of incoming edges
541  unsigned getNumIncomingValues() const { return getNumOperands(); }
542 
543  /// Return incoming value number x
544  MemoryAccess *getIncomingValue(unsigned I) const { return getOperand(I); }
545  void setIncomingValue(unsigned I, MemoryAccess *V) {
546    assert(V && "PHI node got a null value!")(static_cast <bool> (V && "PHI node got a null value!"
) ? void (0) : __assert_fail ("V && \"PHI node got a null value!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 546, __extension__
 __PRETTY_FUNCTION__));
547    setOperand(I, V);
548  }
549 
550  static unsigned getOperandNumForIncomingValue(unsigned I) { return I; }
551  static unsigned getIncomingValueNumForOperand(unsigned I) { return I; }
552 
553  /// Return incoming basic block number @p i.
554  BasicBlock *getIncomingBlock(unsigned I) const { return block_begin()[I]; }
555 
556  /// Return incoming basic block corresponding
557  /// to an operand of the PHI.
558  BasicBlock *getIncomingBlock(const Use &U) const {
559    assert(this == U.getUser() && "Iterator doesn't point to PHI's Uses?")(static_cast <bool> (this == U.getUser() && "Iterator doesn't point to PHI's Uses?"
) ? void (0) : __assert_fail ("this == U.getUser() && \"Iterator doesn't point to PHI's Uses?\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 559, __extension__
 __PRETTY_FUNCTION__));
560    return getIncomingBlock(unsigned(&U - op_begin()));
561  }
562 
563  /// Return incoming basic block corresponding
564  /// to value use iterator.
565  BasicBlock *getIncomingBlock(MemoryAccess::const_user_iterator I) const {
566    return getIncomingBlock(I.getUse());
567  }
568 
569  void setIncomingBlock(unsigned I, BasicBlock *BB) {
570    assert(BB && "PHI node got a null basic block!")(static_cast <bool> (BB && "PHI node got a null basic block!"
) ? void (0) : __assert_fail ("BB && \"PHI node got a null basic block!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 570, __extension__
 __PRETTY_FUNCTION__));
571    block_begin()[I] = BB;
572  }
573 
574  /// Add an incoming value to the end of the PHI list
575  void addIncoming(MemoryAccess *V, BasicBlock *BB) {
576    if (getNumOperands() == ReservedSpace)
577      growOperands(); // Get more space!
578    // Initialize some new operands.
579    setNumHungOffUseOperands(getNumOperands() + 1);
580    setIncomingValue(getNumOperands() - 1, V);
581    setIncomingBlock(getNumOperands() - 1, BB);
582  }
583 
584  /// Return the first index of the specified basic
585  /// block in the value list for this PHI.  Returns -1 if no instance.
586  int getBasicBlockIndex(const BasicBlock *BB) const {
587    for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
588      if (block_begin()[I] == BB)
589        return I;
590    return -1;
591  }
592 
593  MemoryAccess *getIncomingValueForBlock(const BasicBlock *BB) const {
594    int Idx = getBasicBlockIndex(BB);
595    assert(Idx >= 0 && "Invalid basic block argument!")(static_cast <bool> (Idx >= 0 && "Invalid basic block argument!"
) ? void (0) : __assert_fail ("Idx >= 0 && \"Invalid basic block argument!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 595, __extension__
 __PRETTY_FUNCTION__));
596    return getIncomingValue(Idx);
597  }
598 
599  // After deleting incoming position I, the order of incoming may be changed.
600  void unorderedDeleteIncoming(unsigned I) {
601    unsigned E = getNumOperands();
602    assert(I < E && "Cannot remove out of bounds Phi entry.")(static_cast <bool> (I < E && "Cannot remove out of bounds Phi entry."
) ? void (0) : __assert_fail ("I < E && \"Cannot remove out of bounds Phi entry.\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 602, __extension__
 __PRETTY_FUNCTION__));
603    // MemoryPhi must have at least two incoming values, otherwise the MemoryPhi
604    // itself should be deleted.
605    assert(E >= 2 && "Cannot only remove incoming values in MemoryPhis with "(static_cast <bool> (E >= 2 && "Cannot only remove incoming values in MemoryPhis with "
 "at least 2 values.") ? void (0) : __assert_fail ("E >= 2 && \"Cannot only remove incoming values in MemoryPhis with \" \"at least 2 values.\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 606, __extension__
 __PRETTY_FUNCTION__))
606                     "at least 2 values.")(static_cast <bool> (E >= 2 && "Cannot only remove incoming values in MemoryPhis with "
 "at least 2 values.") ? void (0) : __assert_fail ("E >= 2 && \"Cannot only remove incoming values in MemoryPhis with \" \"at least 2 values.\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 606, __extension__
 __PRETTY_FUNCTION__));
607    setIncomingValue(I, getIncomingValue(E - 1));
608    setIncomingBlock(I, block_begin()[E - 1]);
609    setOperand(E - 1, nullptr);
610    block_begin()[E - 1] = nullptr;
611    setNumHungOffUseOperands(getNumOperands() - 1);
612  }
613 
614  // After deleting entries that satisfy Pred, remaining entries may have
615  // changed order.
616  template <typename Fn> void unorderedDeleteIncomingIf(Fn &&Pred) {
617    for (unsigned I = 0, E = getNumOperands(); I != E; ++I)
618      if (Pred(getIncomingValue(I), getIncomingBlock(I))) {
619        unorderedDeleteIncoming(I);
620        E = getNumOperands();
621        --I;
622      }
623    assert(getNumOperands() >= 1 &&(static_cast <bool> (getNumOperands() >= 1 &&
 "Cannot remove all incoming blocks in a MemoryPhi.") ? void (
0) : __assert_fail ("getNumOperands() >= 1 && \"Cannot remove all incoming blocks in a MemoryPhi.\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 624, __extension__
 __PRETTY_FUNCTION__))
624           "Cannot remove all incoming blocks in a MemoryPhi.")(static_cast <bool> (getNumOperands() >= 1 &&
 "Cannot remove all incoming blocks in a MemoryPhi.") ? void (
0) : __assert_fail ("getNumOperands() >= 1 && \"Cannot remove all incoming blocks in a MemoryPhi.\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 624, __extension__
 __PRETTY_FUNCTION__));
625  }
626 
627  // After deleting incoming block BB, the incoming blocks order may be changed.
628  void unorderedDeleteIncomingBlock(const BasicBlock *BB) {
629    unorderedDeleteIncomingIf(
630        [&](const MemoryAccess *, const BasicBlock *B) { return BB == B; });
631  }
632 
633  // After deleting incoming memory access MA, the incoming accesses order may
634  // be changed.
635  void unorderedDeleteIncomingValue(const MemoryAccess *MA) {
636    unorderedDeleteIncomingIf(
637        [&](const MemoryAccess *M, const BasicBlock *) { return MA == M; });
638  }
639 
640  static bool classof(const Value *V) {
641    return V->getValueID() == MemoryPhiVal;
642  }
643 
644  void print(raw_ostream &OS) const;
645 
646  unsigned getID() const { return ID; }
647 
648protected:
649  friend class MemorySSA;
650 
651  /// this is more complicated than the generic
652  /// User::allocHungoffUses, because we have to allocate Uses for the incoming
653  /// values and pointers to the incoming blocks, all in one allocation.
654  void allocHungoffUses(unsigned N) {
655    User::allocHungoffUses(N, /* IsPhi */ true);
656  }
657 
658private:
659  // For debugging only
660  const unsigned ID;
661  unsigned ReservedSpace;
662 
663  /// This grows the operand list in response to a push_back style of
664  /// operation.  This grows the number of ops by 1.5 times.
665  void growOperands() {
666    unsigned E = getNumOperands();
667    // 2 op PHI nodes are VERY common, so reserve at least enough for that.
668    ReservedSpace = std::max(E + E / 2, 2u);
669    growHungoffUses(ReservedSpace, /* IsPhi */ true);
670  }
671 
672  static void deleteMe(DerivedUser *Self);
673};
674 
675inline unsigned MemoryAccess::getID() const {
676  assert((isa<MemoryDef>(this) || isa<MemoryPhi>(this)) &&(static_cast <bool> ((isa<MemoryDef>(this) || isa
<MemoryPhi>(this)) && "only memory defs and phis have ids"
) ? void (0) : __assert_fail ("(isa<MemoryDef>(this) || isa<MemoryPhi>(this)) && \"only memory defs and phis have ids\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 677, __extension__
 __PRETTY_FUNCTION__))
677         "only memory defs and phis have ids")(static_cast <bool> ((isa<MemoryDef>(this) || isa
<MemoryPhi>(this)) && "only memory defs and phis have ids"
) ? void (0) : __assert_fail ("(isa<MemoryDef>(this) || isa<MemoryPhi>(this)) && \"only memory defs and phis have ids\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 677, __extension__
 __PRETTY_FUNCTION__));
678  if (const auto *MD = dyn_cast<MemoryDef>(this))
679    return MD->getID();
680  return cast<MemoryPhi>(this)->getID();
681}
682 
683inline bool MemoryUseOrDef::isOptimized() const {
684  if (const auto *MD = dyn_cast<MemoryDef>(this))
685    return MD->isOptimized();
686  return cast<MemoryUse>(this)->isOptimized();
687}
688 
689inline MemoryAccess *MemoryUseOrDef::getOptimized() const {
690  if (const auto *MD = dyn_cast<MemoryDef>(this))
691    return MD->getOptimized();
692  return cast<MemoryUse>(this)->getOptimized();
693}
694 
695inline void MemoryUseOrDef::setOptimized(MemoryAccess *MA) {
696  if (auto *MD = dyn_cast<MemoryDef>(this))
697    MD->setOptimized(MA);
698  else
699    cast<MemoryUse>(this)->setOptimized(MA);
700}
701 
702inline void MemoryUseOrDef::resetOptimized() {
703  if (auto *MD = dyn_cast<MemoryDef>(this))
704    MD->resetOptimized();
705  else
706    cast<MemoryUse>(this)->resetOptimized();
707}
708 
709template <> struct OperandTraits<MemoryPhi> : public HungoffOperandTraits<2> {};
710DEFINE_TRANSPARENT_OPERAND_ACCESSORS(MemoryPhi, MemoryAccess)MemoryPhi::op_iterator MemoryPhi::op_begin() { return OperandTraits
<MemoryPhi>::op_begin(this); } MemoryPhi::const_op_iterator
 MemoryPhi::op_begin() const { return OperandTraits<MemoryPhi
>::op_begin(const_cast<MemoryPhi*>(this)); } MemoryPhi
::op_iterator MemoryPhi::op_end() { return OperandTraits<MemoryPhi
>::op_end(this); } MemoryPhi::const_op_iterator MemoryPhi::
op_end() const { return OperandTraits<MemoryPhi>::op_end
(const_cast<MemoryPhi*>(this)); } MemoryAccess *MemoryPhi
::getOperand(unsigned i_nocapture) const { (static_cast <bool
> (i_nocapture < OperandTraits<MemoryPhi>::operands
(this) && "getOperand() out of range!") ? void (0) : __assert_fail
 ("i_nocapture < OperandTraits<MemoryPhi>::operands(this) && \"getOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 710, __extension__
 __PRETTY_FUNCTION__)); return cast_or_null<MemoryAccess>
( OperandTraits<MemoryPhi>::op_begin(const_cast<MemoryPhi
*>(this))[i_nocapture].get()); } void MemoryPhi::setOperand
(unsigned i_nocapture, MemoryAccess *Val_nocapture) { (static_cast
 <bool> (i_nocapture < OperandTraits<MemoryPhi>
::operands(this) && "setOperand() out of range!") ? void
 (0) : __assert_fail ("i_nocapture < OperandTraits<MemoryPhi>::operands(this) && \"setOperand() out of range!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 710, __extension__
 __PRETTY_FUNCTION__)); OperandTraits<MemoryPhi>::op_begin
(this)[i_nocapture] = Val_nocapture; } unsigned MemoryPhi::getNumOperands
() const { return OperandTraits<MemoryPhi>::operands(this
); } template <int Idx_nocapture> Use &MemoryPhi::Op
() { return this->OpFrom<Idx_nocapture>(this); } template
 <int Idx_nocapture> const Use &MemoryPhi::Op() const
 { return this->OpFrom<Idx_nocapture>(this); }
711 
712/// Encapsulates MemorySSA, including all data associated with memory
713/// accesses.
714class MemorySSA {
715public:
716  MemorySSA(Function &, AliasAnalysis *, DominatorTree *);
717 
718  // MemorySSA must remain where it's constructed; Walkers it creates store
719  // pointers to it.
720  MemorySSA(MemorySSA &&) = delete;
721 
722  ~MemorySSA();
723 
724  MemorySSAWalker *getWalker();
725  MemorySSAWalker *getSkipSelfWalker();
726 
727  /// Given a memory Mod/Ref'ing instruction, get the MemorySSA
728  /// access associated with it. If passed a basic block gets the memory phi
729  /// node that exists for that block, if there is one. Otherwise, this will get
730  /// a MemoryUseOrDef.
731  MemoryUseOrDef *getMemoryAccess(const Instruction *I) const {
732    return cast_or_null<MemoryUseOrDef>(ValueToMemoryAccess.lookup(I));
733  }
734 
735  MemoryPhi *getMemoryAccess(const BasicBlock *BB) const {
736    return cast_or_null<MemoryPhi>(ValueToMemoryAccess.lookup(cast<Value>(BB)));
23
←
'BB' is a 'Value'→
24
←
Assuming null pointer is passed into cast→
25
←
Returning null pointer, which participates in a condition later→
737  }
738 
739  DominatorTree &getDomTree() const { return *DT; }
740 
741  void dump() const;
742  void print(raw_ostream &) const;
743 
744  /// Return true if \p MA represents the live on entry value
745  ///
746  /// Loads and stores from pointer arguments and other global values may be
747  /// defined by memory operations that do not occur in the current function, so
748  /// they may be live on entry to the function. MemorySSA represents such
749  /// memory state by the live on entry definition, which is guaranteed to occur
750  /// before any other memory access in the function.
751  inline bool isLiveOnEntryDef(const MemoryAccess *MA) const {
752    return MA == LiveOnEntryDef.get();
753  }
754 
755  inline MemoryAccess *getLiveOnEntryDef() const {
756    return LiveOnEntryDef.get();
757  }
758 
759  // Sadly, iplists, by default, owns and deletes pointers added to the
760  // list. It's not currently possible to have two iplists for the same type,
761  // where one owns the pointers, and one does not. This is because the traits
762  // are per-type, not per-tag.  If this ever changes, we should make the
763  // DefList an iplist.
764  using AccessList = iplist<MemoryAccess, ilist_tag<MSSAHelpers::AllAccessTag>>;
765  using DefsList =
766      simple_ilist<MemoryAccess, ilist_tag<MSSAHelpers::DefsOnlyTag>>;
767 
768  /// Return the list of MemoryAccess's for a given basic block.
769  ///
770  /// This list is not modifiable by the user.
771  const AccessList *getBlockAccesses(const BasicBlock *BB) const {
772    return getWritableBlockAccesses(BB);
6
←
Calling 'MemorySSA::getWritableBlockAccesses'→
10
←
Returning from 'MemorySSA::getWritableBlockAccesses'→
11
←
Returning pointer, which participates in a condition later→
12
←
Returning pointer→
773  }
774 
775  /// Return the list of MemoryDef's and MemoryPhi's for a given basic
776  /// block.
777  ///
778  /// This list is not modifiable by the user.
779  const DefsList *getBlockDefs(const BasicBlock *BB) const {
780    return getWritableBlockDefs(BB);
16
←
Calling 'MemorySSA::getWritableBlockDefs'→
19
←
Returning from 'MemorySSA::getWritableBlockDefs'→
20
←
Returning pointer, which participates in a condition later→
781  }
782 
783  /// Given two memory accesses in the same basic block, determine
784  /// whether MemoryAccess \p A dominates MemoryAccess \p B.
785  bool locallyDominates(const MemoryAccess *A, const MemoryAccess *B) const;
786 
787  /// Given two memory accesses in potentially different blocks,
788  /// determine whether MemoryAccess \p A dominates MemoryAccess \p B.
789  bool dominates(const MemoryAccess *A, const MemoryAccess *B) const;
790 
791  /// Given a MemoryAccess and a Use, determine whether MemoryAccess \p A
792  /// dominates Use \p B.
793  bool dominates(const MemoryAccess *A, const Use &B) const;
794 
795  enum class VerificationLevel { Fast, Full };
796  /// Verify that MemorySSA is self consistent (IE definitions dominate
797  /// all uses, uses appear in the right places).  This is used by unit tests.
798  void verifyMemorySSA(VerificationLevel = VerificationLevel::Fast) const;
799 
800  /// Used in various insertion functions to specify whether we are talking
801  /// about the beginning or end of a block.
802  enum InsertionPlace { Beginning, End, BeforeTerminator };
803 
804  /// By default, uses are *not* optimized during MemorySSA construction.
805  /// Calling this method will attempt to optimize all MemoryUses, if this has
806  /// not happened yet for this MemorySSA instance. This should be done if you
807  /// plan to query the clobbering access for most uses, or if you walk the
808  /// def-use chain of uses.
809  void ensureOptimizedUses();
810 
811protected:
812  // Used by Memory SSA dumpers and wrapper pass
813  friend class MemorySSAPrinterLegacyPass;
814  friend class MemorySSAUpdater;
815 
816  void verifyOrderingDominationAndDefUses(
817      Function &F, VerificationLevel = VerificationLevel::Fast) const;
818  void verifyDominationNumbers(const Function &F) const;
819  void verifyPrevDefInPhis(Function &F) const;
820 
821  // This is used by the use optimizer and updater.
822  AccessList *getWritableBlockAccesses(const BasicBlock *BB) const {
823    auto It = PerBlockAccesses.find(BB);
824    return It == PerBlockAccesses.end() ? nullptr : It->second.get();
7
←
'?' condition is false→
8
←
Returning pointer, which participates in a condition later→
9
←
Returning pointer→
825  }
826 
827  // This is used by the use optimizer and updater.
828  DefsList *getWritableBlockDefs(const BasicBlock *BB) const {
829    auto It = PerBlockDefs.find(BB);
830    return It == PerBlockDefs.end() ? nullptr : It->second.get();
17
←
'?' condition is false→
18
←
Returning pointer, which participates in a condition later→
831  }
832 
833  // These is used by the updater to perform various internal MemorySSA
834  // machinsations.  They do not always leave the IR in a correct state, and
835  // relies on the updater to fixup what it breaks, so it is not public.
836 
837  void moveTo(MemoryUseOrDef *What, BasicBlock *BB, AccessList::iterator Where);
838  void moveTo(MemoryAccess *What, BasicBlock *BB, InsertionPlace Point);
839 
840  // Rename the dominator tree branch rooted at BB.
841  void renamePass(BasicBlock *BB, MemoryAccess *IncomingVal,
842                  SmallPtrSetImpl<BasicBlock *> &Visited) {
843    renamePass(DT->getNode(BB), IncomingVal, Visited, true, true);
844  }
845 
846  void removeFromLookups(MemoryAccess *);
847  void removeFromLists(MemoryAccess *, bool ShouldDelete = true);
848  void insertIntoListsForBlock(MemoryAccess *, const BasicBlock *,
849                               InsertionPlace);
850  void insertIntoListsBefore(MemoryAccess *, const BasicBlock *,
851                             AccessList::iterator);
852  MemoryUseOrDef *createDefinedAccess(Instruction *, MemoryAccess *,
853                                      const MemoryUseOrDef *Template = nullptr,
854                                      bool CreationMustSucceed = true);
855 
856private:
857  template <class AliasAnalysisType> class ClobberWalkerBase;
858  template <class AliasAnalysisType> class CachingWalker;
859  template <class AliasAnalysisType> class SkipSelfWalker;
860  class OptimizeUses;
861 
862  CachingWalker<AliasAnalysis> *getWalkerImpl();
863  void buildMemorySSA(BatchAAResults &BAA);
864 
865  void prepareForMoveTo(MemoryAccess *, BasicBlock *);
866  void verifyUseInDefs(MemoryAccess *, MemoryAccess *) const;
867 
868  using AccessMap = DenseMap<const BasicBlock *, std::unique_ptr<AccessList>>;
869  using DefsMap = DenseMap<const BasicBlock *, std::unique_ptr<DefsList>>;
870 
871  void markUnreachableAsLiveOnEntry(BasicBlock *BB);
872  MemoryPhi *createMemoryPhi(BasicBlock *BB);
873  template <typename AliasAnalysisType>
874  MemoryUseOrDef *createNewAccess(Instruction *, AliasAnalysisType *,
875                                  const MemoryUseOrDef *Template = nullptr);
876  void placePHINodes(const SmallPtrSetImpl<BasicBlock *> &);
877  MemoryAccess *renameBlock(BasicBlock *, MemoryAccess *, bool);
878  void renameSuccessorPhis(BasicBlock *, MemoryAccess *, bool);
879  void renamePass(DomTreeNode *, MemoryAccess *IncomingVal,
880                  SmallPtrSetImpl<BasicBlock *> &Visited,
881                  bool SkipVisited = false, bool RenameAllUses = false);
882  AccessList *getOrCreateAccessList(const BasicBlock *);
883  DefsList *getOrCreateDefsList(const BasicBlock *);
884  void renumberBlock(const BasicBlock *) const;
885  AliasAnalysis *AA = nullptr;
886  DominatorTree *DT;
887  Function &F;
888 
889  // Memory SSA mappings
890  DenseMap<const Value *, MemoryAccess *> ValueToMemoryAccess;
891 
892  // These two mappings contain the main block to access/def mappings for
893  // MemorySSA. The list contained in PerBlockAccesses really owns all the
894  // MemoryAccesses.
895  // Both maps maintain the invariant that if a block is found in them, the
896  // corresponding list is not empty, and if a block is not found in them, the
897  // corresponding list is empty.
898  AccessMap PerBlockAccesses;
899  DefsMap PerBlockDefs;
900  std::unique_ptr<MemoryAccess, ValueDeleter> LiveOnEntryDef;
901 
902  // Domination mappings
903  // Note that the numbering is local to a block, even though the map is
904  // global.
905  mutable SmallPtrSet<const BasicBlock *, 16> BlockNumberingValid;
906  mutable DenseMap<const MemoryAccess *, unsigned long> BlockNumbering;
907 
908  // Memory SSA building info
909  std::unique_ptr<ClobberWalkerBase<AliasAnalysis>> WalkerBase;
910  std::unique_ptr<CachingWalker<AliasAnalysis>> Walker;
911  std::unique_ptr<SkipSelfWalker<AliasAnalysis>> SkipWalker;
912  unsigned NextID = 0;
913  bool IsOptimized = false;
914};
915 
916/// Enables verification of MemorySSA.
917///
918/// The checks which this flag enables is exensive and disabled by default
919/// unless `EXPENSIVE_CHECKS` is defined.  The flag `-verify-memoryssa` can be
920/// used to selectively enable the verification without re-compilation.
921extern bool VerifyMemorySSA;
922 
923// Internal MemorySSA utils, for use by MemorySSA classes and walkers
924class MemorySSAUtil {
925protected:
926  friend class GVNHoist;
927  friend class MemorySSAWalker;
928 
929  // This function should not be used by new passes.
930  static bool defClobbersUseOrDef(MemoryDef *MD, const MemoryUseOrDef *MU,
931                                  AliasAnalysis &AA);
932};
933 
934// This pass does eager building and then printing of MemorySSA. It is used by
935// the tests to be able to build, dump, and verify Memory SSA.
936class MemorySSAPrinterLegacyPass : public FunctionPass {
937public:
938  MemorySSAPrinterLegacyPass();
939 
940  bool runOnFunction(Function &) override;
941  void getAnalysisUsage(AnalysisUsage &AU) const override;
942 
943  static char ID;
944};
945 
946/// An analysis that produces \c MemorySSA for a function.
947///
948class MemorySSAAnalysis : public AnalysisInfoMixin<MemorySSAAnalysis> {
949  friend AnalysisInfoMixin<MemorySSAAnalysis>;
950 
951  static AnalysisKey Key;
952 
953public:
954  // Wrap MemorySSA result to ensure address stability of internal MemorySSA
955  // pointers after construction.  Use a wrapper class instead of plain
956  // unique_ptr<MemorySSA> to avoid build breakage on MSVC.
957  struct Result {
958    Result(std::unique_ptr<MemorySSA> &&MSSA) : MSSA(std::move(MSSA)) {}
959 
960    MemorySSA &getMSSA() { return *MSSA.get(); }
961 
962    std::unique_ptr<MemorySSA> MSSA;
963 
964    bool invalidate(Function &F, const PreservedAnalyses &PA,
965                    FunctionAnalysisManager::Invalidator &Inv);
966  };
967 
968  Result run(Function &F, FunctionAnalysisManager &AM);
969};
970 
971/// Printer pass for \c MemorySSA.
972class MemorySSAPrinterPass : public PassInfoMixin<MemorySSAPrinterPass> {
973  raw_ostream &OS;
974 
975public:
976  explicit MemorySSAPrinterPass(raw_ostream &OS) : OS(OS) {}
977 
978  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
979};
980 
981/// Printer pass for \c MemorySSA via the walker.
982class MemorySSAWalkerPrinterPass
983    : public PassInfoMixin<MemorySSAWalkerPrinterPass> {
984  raw_ostream &OS;
985 
986public:
987  explicit MemorySSAWalkerPrinterPass(raw_ostream &OS) : OS(OS) {}
988 
989  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
990};
991 
992/// Verifier pass for \c MemorySSA.
993struct MemorySSAVerifierPass : PassInfoMixin<MemorySSAVerifierPass> {
994  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
995};
996 
997/// Legacy analysis pass which computes \c MemorySSA.
998class MemorySSAWrapperPass : public FunctionPass {
999public:
1000  MemorySSAWrapperPass();
1001 
1002  static char ID;
1003 
1004  bool runOnFunction(Function &) override;
1005  void releaseMemory() override;
1006  MemorySSA &getMSSA() { return *MSSA; }
1007  const MemorySSA &getMSSA() const { return *MSSA; }
1008 
1009  void getAnalysisUsage(AnalysisUsage &AU) const override;
1010 
1011  void verifyAnalysis() const override;
1012  void print(raw_ostream &OS, const Module *M = nullptr) const override;
1013 
1014private:
1015  std::unique_ptr<MemorySSA> MSSA;
1016};
1017 
1018/// This is the generic walker interface for walkers of MemorySSA.
1019/// Walkers are used to be able to further disambiguate the def-use chains
1020/// MemorySSA gives you, or otherwise produce better info than MemorySSA gives
1021/// you.
1022/// In particular, while the def-use chains provide basic information, and are
1023/// guaranteed to give, for example, the nearest may-aliasing MemoryDef for a
1024/// MemoryUse as AliasAnalysis considers it, a user mant want better or other
1025/// information. In particular, they may want to use SCEV info to further
1026/// disambiguate memory accesses, or they may want the nearest dominating
1027/// may-aliasing MemoryDef for a call or a store. This API enables a
1028/// standardized interface to getting and using that info.
1029class MemorySSAWalker {
1030public:
1031  MemorySSAWalker(MemorySSA *);
1032  virtual ~MemorySSAWalker() = default;
1033 
1034  using MemoryAccessSet = SmallVector<MemoryAccess *, 8>;
1035 
1036  /// Given a memory Mod/Ref/ModRef'ing instruction, calling this
1037  /// will give you the nearest dominating MemoryAccess that Mod's the location
1038  /// the instruction accesses (by skipping any def which AA can prove does not
1039  /// alias the location(s) accessed by the instruction given).
1040  ///
1041  /// Note that this will return a single access, and it must dominate the
1042  /// Instruction, so if an operand of a MemoryPhi node Mod's the instruction,
1043  /// this will return the MemoryPhi, not the operand. This means that
1044  /// given:
1045  /// if (a) {
1046  ///   1 = MemoryDef(liveOnEntry)
1047  ///   store %a
1048  /// } else {
1049  ///   2 = MemoryDef(liveOnEntry)
1050  ///   store %b
1051  /// }
1052  /// 3 = MemoryPhi(2, 1)
1053  /// MemoryUse(3)
1054  /// load %a
1055  ///
1056  /// calling this API on load(%a) will return the MemoryPhi, not the MemoryDef
1057  /// in the if (a) branch.
1058  MemoryAccess *getClobberingMemoryAccess(const Instruction *I) {
1059    MemoryAccess *MA = MSSA->getMemoryAccess(I);
1060    assert(MA && "Handed an instruction that MemorySSA doesn't recognize?")(static_cast <bool> (MA && "Handed an instruction that MemorySSA doesn't recognize?"
) ? void (0) : __assert_fail ("MA && \"Handed an instruction that MemorySSA doesn't recognize?\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1060, __extension__
 __PRETTY_FUNCTION__));
1061    return getClobberingMemoryAccess(MA);
1062  }
1063 
1064  /// Does the same thing as getClobberingMemoryAccess(const Instruction *I),
1065  /// but takes a MemoryAccess instead of an Instruction.
1066  virtual MemoryAccess *getClobberingMemoryAccess(MemoryAccess *) = 0;
1067 
1068  /// Given a potentially clobbering memory access and a new location,
1069  /// calling this will give you the nearest dominating clobbering MemoryAccess
1070  /// (by skipping non-aliasing def links).
1071  ///
1072  /// This version of the function is mainly used to disambiguate phi translated
1073  /// pointers, where the value of a pointer may have changed from the initial
1074  /// memory access. Note that this expects to be handed either a MemoryUse,
1075  /// or an already potentially clobbering access. Unlike the above API, if
1076  /// given a MemoryDef that clobbers the pointer as the starting access, it
1077  /// will return that MemoryDef, whereas the above would return the clobber
1078  /// starting from the use side of  the memory def.
1079  virtual MemoryAccess *getClobberingMemoryAccess(MemoryAccess *,
1080                                                  const MemoryLocation &) = 0;
1081 
1082  /// Given a memory access, invalidate anything this walker knows about
1083  /// that access.
1084  /// This API is used by walkers that store information to perform basic cache
1085  /// invalidation.  This will be called by MemorySSA at appropriate times for
1086  /// the walker it uses or returns.
1087  virtual void invalidateInfo(MemoryAccess *) {}
1088 
1089protected:
1090  friend class MemorySSA; // For updating MSSA pointer in MemorySSA move
1091                          // constructor.
1092  MemorySSA *MSSA;
1093};
1094 
1095/// A MemorySSAWalker that does no alias queries, or anything else. It
1096/// simply returns the links as they were constructed by the builder.
1097class DoNothingMemorySSAWalker final : public MemorySSAWalker {
1098public:
1099  // Keep the overrides below from hiding the Instruction overload of
1100  // getClobberingMemoryAccess.
1101  using MemorySSAWalker::getClobberingMemoryAccess;
1102 
1103  MemoryAccess *getClobberingMemoryAccess(MemoryAccess *) override;
1104  MemoryAccess *getClobberingMemoryAccess(MemoryAccess *,
1105                                          const MemoryLocation &) override;
1106};
1107 
1108using MemoryAccessPair = std::pair<MemoryAccess *, MemoryLocation>;
1109using ConstMemoryAccessPair = std::pair<const MemoryAccess *, MemoryLocation>;
1110 
1111/// Iterator base class used to implement const and non-const iterators
1112/// over the defining accesses of a MemoryAccess.
1113template <class T>
1114class memoryaccess_def_iterator_base
1115    : public iterator_facade_base<memoryaccess_def_iterator_base<T>,
1116                                  std::forward_iterator_tag, T, ptrdiff_t, T *,
1117                                  T *> {
1118  using BaseT = typename memoryaccess_def_iterator_base::iterator_facade_base;
1119 
1120public:
1121  memoryaccess_def_iterator_base(T *Start) : Access(Start) {}
1122  memoryaccess_def_iterator_base() = default;
1123 
1124  bool operator==(const memoryaccess_def_iterator_base &Other) const {
1125    return Access == Other.Access && (!Access || ArgNo == Other.ArgNo);
1126  }
1127 
1128  // This is a bit ugly, but for MemoryPHI's, unlike PHINodes, you can't get the
1129  // block from the operand in constant time (In a PHINode, the uselist has
1130  // both, so it's just subtraction). We provide it as part of the
1131  // iterator to avoid callers having to linear walk to get the block.
1132  // If the operation becomes constant time on MemoryPHI's, this bit of
1133  // abstraction breaking should be removed.
1134  BasicBlock *getPhiArgBlock() const {
1135    MemoryPhi *MP = dyn_cast<MemoryPhi>(Access);
1136    assert(MP && "Tried to get phi arg block when not iterating over a PHI")(static_cast <bool> (MP && "Tried to get phi arg block when not iterating over a PHI"
) ? void (0) : __assert_fail ("MP && \"Tried to get phi arg block when not iterating over a PHI\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1136, __extension__
 __PRETTY_FUNCTION__));
1137    return MP->getIncomingBlock(ArgNo);
1138  }
1139 
1140  typename std::iterator_traits<BaseT>::pointer operator*() const {
1141    assert(Access && "Tried to access past the end of our iterator")(static_cast <bool> (Access && "Tried to access past the end of our iterator"
) ? void (0) : __assert_fail ("Access && \"Tried to access past the end of our iterator\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1141, __extension__
 __PRETTY_FUNCTION__));
1142    // Go to the first argument for phis, and the defining access for everything
1143    // else.
1144    if (const MemoryPhi *MP = dyn_cast<MemoryPhi>(Access))
1145      return MP->getIncomingValue(ArgNo);
1146    return cast<MemoryUseOrDef>(Access)->getDefiningAccess();
1147  }
1148 
1149  using BaseT::operator++;
1150  memoryaccess_def_iterator_base &operator++() {
1151    assert(Access && "Hit end of iterator")(static_cast <bool> (Access && "Hit end of iterator"
) ? void (0) : __assert_fail ("Access && \"Hit end of iterator\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1151, __extension__
 __PRETTY_FUNCTION__));
1152    if (const MemoryPhi *MP = dyn_cast<MemoryPhi>(Access)) {
1153      if (++ArgNo >= MP->getNumIncomingValues()) {
1154        ArgNo = 0;
1155        Access = nullptr;
1156      }
1157    } else {
1158      Access = nullptr;
1159    }
1160    return *this;
1161  }
1162 
1163private:
1164  T *Access = nullptr;
1165  unsigned ArgNo = 0;
1166};
1167 
1168inline memoryaccess_def_iterator MemoryAccess::defs_begin() {
1169  return memoryaccess_def_iterator(this);
1170}
1171 
1172inline const_memoryaccess_def_iterator MemoryAccess::defs_begin() const {
1173  return const_memoryaccess_def_iterator(this);
1174}
1175 
1176inline memoryaccess_def_iterator MemoryAccess::defs_end() {
1177  return memoryaccess_def_iterator();
1178}
1179 
1180inline const_memoryaccess_def_iterator MemoryAccess::defs_end() const {
1181  return const_memoryaccess_def_iterator();
1182}
1183 
1184/// GraphTraits for a MemoryAccess, which walks defs in the normal case,
1185/// and uses in the inverse case.
1186template <> struct GraphTraits<MemoryAccess *> {
1187  using NodeRef = MemoryAccess *;
1188  using ChildIteratorType = memoryaccess_def_iterator;
1189 
1190  static NodeRef getEntryNode(NodeRef N) { return N; }
1191  static ChildIteratorType child_begin(NodeRef N) { return N->defs_begin(); }
1192  static ChildIteratorType child_end(NodeRef N) { return N->defs_end(); }
1193};
1194 
1195template <> struct GraphTraits<Inverse<MemoryAccess *>> {
1196  using NodeRef = MemoryAccess *;
1197  using ChildIteratorType = MemoryAccess::iterator;
1198 
1199  static NodeRef getEntryNode(NodeRef N) { return N; }
1200  static ChildIteratorType child_begin(NodeRef N) { return N->user_begin(); }
1201  static ChildIteratorType child_end(NodeRef N) { return N->user_end(); }
1202};
1203 
1204/// Provide an iterator that walks defs, giving both the memory access,
1205/// and the current pointer location, updating the pointer location as it
1206/// changes due to phi node translation.
1207///
1208/// This iterator, while somewhat specialized, is what most clients actually
1209/// want when walking upwards through MemorySSA def chains. It takes a pair of
1210/// <MemoryAccess,MemoryLocation>, and walks defs, properly translating the
1211/// memory location through phi nodes for the user.
1212class upward_defs_iterator
1213    : public iterator_facade_base<upward_defs_iterator,
1214                                  std::forward_iterator_tag,
1215                                  const MemoryAccessPair> {
1216  using BaseT = upward_defs_iterator::iterator_facade_base;
1217 
1218public:
1219  upward_defs_iterator(const MemoryAccessPair &Info, DominatorTree *DT,
1220                       bool *PerformedPhiTranslation = nullptr)
1221      : DefIterator(Info.first), Location(Info.second),
1222        OriginalAccess(Info.first), DT(DT),
1223        PerformedPhiTranslation(PerformedPhiTranslation) {
1224    CurrentPair.first = nullptr;
1225 
1226    WalkingPhi = Info.first && isa<MemoryPhi>(Info.first);
1227    fillInCurrentPair();
1228  }
1229 
1230  upward_defs_iterator() { CurrentPair.first = nullptr; }
1231 
1232  bool operator==(const upward_defs_iterator &Other) const {
1233    return DefIterator == Other.DefIterator;
1234  }
1235 
1236  typename std::iterator_traits<BaseT>::reference operator*() const {
1237    assert(DefIterator != OriginalAccess->defs_end() &&(static_cast <bool> (DefIterator != OriginalAccess->
defs_end() && "Tried to access past the end of our iterator"
) ? void (0) : __assert_fail ("DefIterator != OriginalAccess->defs_end() && \"Tried to access past the end of our iterator\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1238, __extension__
 __PRETTY_FUNCTION__))
1238           "Tried to access past the end of our iterator")(static_cast <bool> (DefIterator != OriginalAccess->
defs_end() && "Tried to access past the end of our iterator"
) ? void (0) : __assert_fail ("DefIterator != OriginalAccess->defs_end() && \"Tried to access past the end of our iterator\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1238, __extension__
 __PRETTY_FUNCTION__));
1239    return CurrentPair;
1240  }
1241 
1242  using BaseT::operator++;
1243  upward_defs_iterator &operator++() {
1244    assert(DefIterator != OriginalAccess->defs_end() &&(static_cast <bool> (DefIterator != OriginalAccess->
defs_end() && "Tried to access past the end of the iterator"
) ? void (0) : __assert_fail ("DefIterator != OriginalAccess->defs_end() && \"Tried to access past the end of the iterator\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1245, __extension__
 __PRETTY_FUNCTION__))
1245           "Tried to access past the end of the iterator")(static_cast <bool> (DefIterator != OriginalAccess->
defs_end() && "Tried to access past the end of the iterator"
) ? void (0) : __assert_fail ("DefIterator != OriginalAccess->defs_end() && \"Tried to access past the end of the iterator\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1245, __extension__
 __PRETTY_FUNCTION__));
1246    ++DefIterator;
1247    if (DefIterator != OriginalAccess->defs_end())
1248      fillInCurrentPair();
1249    return *this;
1250  }
1251 
1252  BasicBlock *getPhiArgBlock() const { return DefIterator.getPhiArgBlock(); }
1253 
1254private:
1255  /// Returns true if \p Ptr is guaranteed to be loop invariant for any possible
1256  /// loop. In particular, this guarantees that it only references a single
1257  /// MemoryLocation during execution of the containing function.
1258  bool IsGuaranteedLoopInvariant(Value *Ptr) const;
1259 
1260  void fillInCurrentPair() {
1261    CurrentPair.first = *DefIterator;
1262    CurrentPair.second = Location;
1263    if (WalkingPhi && Location.Ptr) {
1264      // Mark size as unknown, if the location is not guaranteed to be
1265      // loop-invariant for any possible loop in the function. Setting the size
1266      // to unknown guarantees that any memory accesses that access locations
1267      // after the pointer are considered as clobbers, which is important to
1268      // catch loop carried dependences.
1269      if (Location.Ptr &&
1270          !IsGuaranteedLoopInvariant(const_cast<Value *>(Location.Ptr)))
1271        CurrentPair.second =
1272            Location.getWithNewSize(LocationSize::beforeOrAfterPointer());
1273      PHITransAddr Translator(
1274          const_cast<Value *>(Location.Ptr),
1275          OriginalAccess->getBlock()->getModule()->getDataLayout(), nullptr);
1276 
1277      if (!Translator.PHITranslateValue(OriginalAccess->getBlock(),
1278                                        DefIterator.getPhiArgBlock(), DT,
1279                                        true)) {
1280        Value *TransAddr = Translator.getAddr();
1281        if (TransAddr != Location.Ptr) {
1282          CurrentPair.second = CurrentPair.second.getWithNewPtr(TransAddr);
1283 
1284          if (TransAddr &&
1285              !IsGuaranteedLoopInvariant(const_cast<Value *>(TransAddr)))
1286            CurrentPair.second = CurrentPair.second.getWithNewSize(
1287                LocationSize::beforeOrAfterPointer());
1288 
1289          if (PerformedPhiTranslation)
1290            *PerformedPhiTranslation = true;
1291        }
1292      }
1293    }
1294  }
1295 
1296  MemoryAccessPair CurrentPair;
1297  memoryaccess_def_iterator DefIterator;
1298  MemoryLocation Location;
1299  MemoryAccess *OriginalAccess = nullptr;
1300  DominatorTree *DT = nullptr;
1301  bool WalkingPhi = false;
1302  bool *PerformedPhiTranslation = nullptr;
1303};
1304 
1305inline upward_defs_iterator
1306upward_defs_begin(const MemoryAccessPair &Pair, DominatorTree &DT,
1307                  bool *PerformedPhiTranslation = nullptr) {
1308  return upward_defs_iterator(Pair, &DT, PerformedPhiTranslation);
1309}
1310 
1311inline upward_defs_iterator upward_defs_end() { return upward_defs_iterator(); }
1312 
1313inline iterator_range<upward_defs_iterator>
1314upward_defs(const MemoryAccessPair &Pair, DominatorTree &DT) {
1315  return make_range(upward_defs_begin(Pair, DT), upward_defs_end());
1316}
1317 
1318/// Walks the defining accesses of MemoryDefs. Stops after we hit something that
1319/// has no defining use (e.g. a MemoryPhi or liveOnEntry). Note that, when
1320/// comparing against a null def_chain_iterator, this will compare equal only
1321/// after walking said Phi/liveOnEntry.
1322///
1323/// The UseOptimizedChain flag specifies whether to walk the clobbering
1324/// access chain, or all the accesses.
1325///
1326/// Normally, MemoryDef are all just def/use linked together, so a def_chain on
1327/// a MemoryDef will walk all MemoryDefs above it in the program until it hits
1328/// a phi node.  The optimized chain walks the clobbering access of a store.
1329/// So if you are just trying to find, given a store, what the next
1330/// thing that would clobber the same memory is, you want the optimized chain.
1331template <class T, bool UseOptimizedChain = false>
1332struct def_chain_iterator
1333    : public iterator_facade_base<def_chain_iterator<T, UseOptimizedChain>,
1334                                  std::forward_iterator_tag, MemoryAccess *> {
1335  def_chain_iterator() : MA(nullptr) {}
1336  def_chain_iterator(T MA) : MA(MA) {}
1337 
1338  T operator*() const { return MA; }
1339 
1340  def_chain_iterator &operator++() {
1341    // N.B. liveOnEntry has a null defining access.
1342    if (auto *MUD = dyn_cast<MemoryUseOrDef>(MA)) {
1343      if (UseOptimizedChain && MUD->isOptimized())
1344        MA = MUD->getOptimized();
1345      else
1346        MA = MUD->getDefiningAccess();
1347    } else {
1348      MA = nullptr;
1349    }
1350 
1351    return *this;
1352  }
1353 
1354  bool operator==(const def_chain_iterator &O) const { return MA == O.MA; }
1355 
1356private:
1357  T MA;
1358};
1359 
1360template <class T>
1361inline iterator_range<def_chain_iterator<T>>
1362def_chain(T MA, MemoryAccess *UpTo = nullptr) {
1363#ifdef EXPENSIVE_CHECKS
1364  assert((!UpTo || find(def_chain(MA), UpTo) != def_chain_iterator<T>()) &&(static_cast <bool> ((!UpTo || find(def_chain(MA), UpTo
) != def_chain_iterator<T>()) && "UpTo isn't in the def chain!"
) ? void (0) : __assert_fail ("(!UpTo || find(def_chain(MA), UpTo) != def_chain_iterator<T>()) && \"UpTo isn't in the def chain!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1365, __extension__
 __PRETTY_FUNCTION__))
1365         "UpTo isn't in the def chain!")(static_cast <bool> ((!UpTo || find(def_chain(MA), UpTo
) != def_chain_iterator<T>()) && "UpTo isn't in the def chain!"
) ? void (0) : __assert_fail ("(!UpTo || find(def_chain(MA), UpTo) != def_chain_iterator<T>()) && \"UpTo isn't in the def chain!\""
, "llvm/include/llvm/Analysis/MemorySSA.h", 1365, __extension__
 __PRETTY_FUNCTION__));
1366#endif
1367  return make_range(def_chain_iterator<T>(MA), def_chain_iterator<T>(UpTo));
1368}
1369 
1370template <class T>
1371inline iterator_range<def_chain_iterator<T, true>> optimized_def_chain(T MA) {
1372  return make_range(def_chain_iterator<T, true>(MA),
1373                    def_chain_iterator<T, true>(nullptr));
1374}
1375 
1376} // end namespace llvm
1377 
1378#endif // LLVM_ANALYSIS_MEMORYSSA_H