/build/source/llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp

Bug Summary

File:	build/source/llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp
Warning:	line 2487, column 3 Address of stack memory associated with local variable 'BRV' is still referred to by the stack variable 'OCAO' upon returning to the caller. This will be a dangling reference
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 ObjCARCOpts.cpp -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/source/build-llvm/tools/clang/stage2-bins -resource-dir /usr/lib/llvm-17/lib/clang/17 -D _DEBUG -D _GLIBCXX_ASSERTIONS -D _GNU_SOURCE -D _LIBCPP_ENABLE_ASSERTIONS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I lib/Transforms/ObjCARC -I /build/source/llvm/lib/Transforms/ObjCARC -I include -I /build/source/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-17/lib/clang/17/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/source/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fmacro-prefix-map=/build/source/= -fcoverage-prefix-map=/build/source/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fcoverage-prefix-map=/build/source/= -source-date-epoch 1683717183 -O2 -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 -Wno-misleading-indentation -std=c++17 -fdeprecated-macro -fdebug-compilation-dir=/build/source/build-llvm/tools/clang/stage2-bins -fdebug-prefix-map=/build/source/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fdebug-prefix-map=/build/source/= -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-2023-05-10-133810-16478-1 -x c++ /build/source/llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp
1//===- ObjCARCOpts.cpp - ObjC ARC Optimization ----------------------------===//
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 defines ObjC ARC optimizations. ARC stands for Automatic
11/// Reference Counting and is a system for managing reference counts for objects
12/// in Objective C.
13///
14/// The optimizations performed include elimination of redundant, partially
15/// redundant, and inconsequential reference count operations, elimination of
16/// redundant weak pointer operations, and numerous minor simplifications.
17///
18/// WARNING: This file knows about certain library functions. It recognizes them
19/// by name, and hardwires knowledge of their semantics.
20///
21/// WARNING: This file knows about how certain Objective-C library functions are
22/// used. Naive LLVM IR transformations which would otherwise be
23/// behavior-preserving may break these assumptions.
24//
25//===----------------------------------------------------------------------===//

27#include "ARCRuntimeEntryPoints.h"
28#include "BlotMapVector.h"
29#include "DependencyAnalysis.h"
30#include "ObjCARC.h"
31#include "ProvenanceAnalysis.h"
32#include "PtrState.h"
33#include "llvm/ADT/DenseMap.h"
34#include "llvm/ADT/STLExtras.h"
35#include "llvm/ADT/SmallPtrSet.h"
36#include "llvm/ADT/SmallVector.h"
37#include "llvm/ADT/Statistic.h"
38#include "llvm/Analysis/AliasAnalysis.h"
39#include "llvm/Analysis/ObjCARCAliasAnalysis.h"
40#include "llvm/Analysis/ObjCARCAnalysisUtils.h"
41#include "llvm/Analysis/ObjCARCInstKind.h"
42#include "llvm/Analysis/ObjCARCUtil.h"
43#include "llvm/IR/BasicBlock.h"
44#include "llvm/IR/CFG.h"
45#include "llvm/IR/Constant.h"
46#include "llvm/IR/Constants.h"
47#include "llvm/IR/DerivedTypes.h"
48#include "llvm/IR/EHPersonalities.h"
49#include "llvm/IR/Function.h"
50#include "llvm/IR/GlobalVariable.h"
51#include "llvm/IR/InstIterator.h"
52#include "llvm/IR/InstrTypes.h"
53#include "llvm/IR/Instruction.h"
54#include "llvm/IR/Instructions.h"
55#include "llvm/IR/LLVMContext.h"
56#include "llvm/IR/Metadata.h"
57#include "llvm/IR/Type.h"
58#include "llvm/IR/User.h"
59#include "llvm/IR/Value.h"
60#include "llvm/Support/Casting.h"
61#include "llvm/Support/CommandLine.h"
62#include "llvm/Support/Compiler.h"
63#include "llvm/Support/Debug.h"
64#include "llvm/Support/ErrorHandling.h"
65#include "llvm/Support/raw_ostream.h"
66#include "llvm/Transforms/ObjCARC.h"
67#include <cassert>
68#include <iterator>
69#include <utility>

71using namespace llvm;
72using namespace llvm::objcarc;

74#define DEBUG_TYPE"objc-arc-opts" "objc-arc-opts"

76static cl::opt<unsigned> MaxPtrStates("arc-opt-max-ptr-states",
  cl::Hidden,
  cl::desc("Maximum number of ptr states the optimizer keeps track of"),
  cl::init(4095));

81/// \defgroup ARCUtilities Utility declarations/definitions specific to ARC.
82/// @{

84/// This is similar to GetRCIdentityRoot but it stops as soon
85/// as it finds a value with multiple uses.
86static const Value *FindSingleUseIdentifiedObject(const Value *Arg) {
// ConstantData (like ConstantPointerNull and UndefValue) is used across
// modules.  It's never a single-use value.
if (isa<ConstantData>(Arg))
  return nullptr;

if (Arg->hasOneUse()) {
  if (const BitCastInst *BC = dyn_cast<BitCastInst>(Arg))
    return FindSingleUseIdentifiedObject(BC->getOperand(0));
  if (const GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Arg))
    if (GEP->hasAllZeroIndices())
      return FindSingleUseIdentifiedObject(GEP->getPointerOperand());
  if (IsForwarding(GetBasicARCInstKind(Arg)))
    return FindSingleUseIdentifiedObject(
             cast<CallInst>(Arg)->getArgOperand(0));
  if (!IsObjCIdentifiedObject(Arg))
    return nullptr;
  return Arg;
}

// If we found an identifiable object but it has multiple uses, but they are
// trivial uses, we can still consider this to be a single-use value.
if (IsObjCIdentifiedObject(Arg)) {
  for (const User *U : Arg->users())
    if (!U->use_empty() || GetRCIdentityRoot(U) != Arg)
       return nullptr;

  return Arg;
}

return nullptr;
117}

119/// @}
120///
121/// \defgroup ARCOpt ARC Optimization.
122/// @{

124// TODO: On code like this:
125//
126// objc_retain(%x)
127// stuff_that_cannot_release()
128// objc_autorelease(%x)
129// stuff_that_cannot_release()
130// objc_retain(%x)
131// stuff_that_cannot_release()
132// objc_autorelease(%x)
133//
134// The second retain and autorelease can be deleted.

136// TODO: It should be possible to delete
137// objc_autoreleasePoolPush and objc_autoreleasePoolPop
138// pairs if nothing is actually autoreleased between them. Also, autorelease
139// calls followed by objc_autoreleasePoolPop calls (perhaps in ObjC++ code
140// after inlining) can be turned into plain release calls.

142// TODO: Critical-edge splitting. If the optimial insertion point is
143// a critical edge, the current algorithm has to fail, because it doesn't
144// know how to split edges. It should be possible to make the optimizer
145// think in terms of edges, rather than blocks, and then split critical
146// edges on demand.

148// TODO: OptimizeSequences could generalized to be Interprocedural.

150// TODO: Recognize that a bunch of other objc runtime calls have
151// non-escaping arguments and non-releasing arguments, and may be
152// non-autoreleasing.

154// TODO: Sink autorelease calls as far as possible. Unfortunately we
155// usually can't sink them past other calls, which would be the main
156// case where it would be useful.

158// TODO: The pointer returned from objc_loadWeakRetained is retained.

160// TODO: Delete release+retain pairs (rare).

162STATISTIC(NumNoops,       "Number of no-op objc calls eliminated")static llvm::Statistic NumNoops = {"objc-arc-opts", "NumNoops"
, "Number of no-op objc calls eliminated"};
163STATISTIC(NumPartialNoops, "Number of partially no-op objc calls eliminated")static llvm::Statistic NumPartialNoops = {"objc-arc-opts", "NumPartialNoops"
, "Number of partially no-op objc calls eliminated"};
164STATISTIC(NumAutoreleases,"Number of autoreleases converted to releases")static llvm::Statistic NumAutoreleases = {"objc-arc-opts", "NumAutoreleases"
, "Number of autoreleases converted to releases"};
165STATISTIC(NumRets,        "Number of return value forwarding "static llvm::Statistic NumRets = {"objc-arc-opts", "NumRets",
 "Number of return value forwarding " "retain+autoreleases eliminated"
}
                        "retain+autoreleases eliminated")static llvm::Statistic NumRets = {"objc-arc-opts", "NumRets",
 "Number of return value forwarding " "retain+autoreleases eliminated"
};
167STATISTIC(NumRRs,         "Number of retain+release paths eliminated")static llvm::Statistic NumRRs = {"objc-arc-opts", "NumRRs", "Number of retain+release paths eliminated"
};
168STATISTIC(NumPeeps,       "Number of calls peephole-optimized")static llvm::Statistic NumPeeps = {"objc-arc-opts", "NumPeeps"
, "Number of calls peephole-optimized"};
169#ifndef NDEBUG
170STATISTIC(NumRetainsBeforeOpt,static llvm::Statistic NumRetainsBeforeOpt = {"objc-arc-opts"
, "NumRetainsBeforeOpt", "Number of retains before optimization"
}
        "Number of retains before optimization")static llvm::Statistic NumRetainsBeforeOpt = {"objc-arc-opts"
, "NumRetainsBeforeOpt", "Number of retains before optimization"
};
172STATISTIC(NumReleasesBeforeOpt,static llvm::Statistic NumReleasesBeforeOpt = {"objc-arc-opts"
, "NumReleasesBeforeOpt", "Number of releases before optimization"
}
        "Number of releases before optimization")static llvm::Statistic NumReleasesBeforeOpt = {"objc-arc-opts"
, "NumReleasesBeforeOpt", "Number of releases before optimization"
};
174STATISTIC(NumRetainsAfterOpt,static llvm::Statistic NumRetainsAfterOpt = {"objc-arc-opts",
 "NumRetainsAfterOpt", "Number of retains after optimization"
}
        "Number of retains after optimization")static llvm::Statistic NumRetainsAfterOpt = {"objc-arc-opts",
 "NumRetainsAfterOpt", "Number of retains after optimization"
};
176STATISTIC(NumReleasesAfterOpt,static llvm::Statistic NumReleasesAfterOpt = {"objc-arc-opts"
, "NumReleasesAfterOpt", "Number of releases after optimization"
}
        "Number of releases after optimization")static llvm::Statistic NumReleasesAfterOpt = {"objc-arc-opts"
, "NumReleasesAfterOpt", "Number of releases after optimization"
};
178#endif

180namespace {

/// Per-BasicBlock state.
class BBState {
  /// The number of unique control paths from the entry which can reach this
  /// block.
  unsigned TopDownPathCount = 0;

  /// The number of unique control paths to exits from this block.
  unsigned BottomUpPathCount = 0;

  /// The top-down traversal uses this to record information known about a
  /// pointer at the bottom of each block.
  BlotMapVector<const Value *, TopDownPtrState> PerPtrTopDown;

  /// The bottom-up traversal uses this to record information known about a
  /// pointer at the top of each block.
  BlotMapVector<const Value *, BottomUpPtrState> PerPtrBottomUp;

  /// Effective predecessors of the current block ignoring ignorable edges and
  /// ignored backedges.
  SmallVector<BasicBlock *, 2> Preds;

  /// Effective successors of the current block ignoring ignorable edges and
  /// ignored backedges.
  SmallVector<BasicBlock *, 2> Succs;

public:
  static const unsigned OverflowOccurredValue;

  BBState() = default;

  using top_down_ptr_iterator = decltype(PerPtrTopDown)::iterator;
  using const_top_down_ptr_iterator = decltype(PerPtrTopDown)::const_iterator;

  top_down_ptr_iterator top_down_ptr_begin() { return PerPtrTopDown.begin(); }
  top_down_ptr_iterator top_down_ptr_end() { return PerPtrTopDown.end(); }
  const_top_down_ptr_iterator top_down_ptr_begin() const {
    return PerPtrTopDown.begin();
  }
  const_top_down_ptr_iterator top_down_ptr_end() const {
    return PerPtrTopDown.end();
  }
  bool hasTopDownPtrs() const {
    return !PerPtrTopDown.empty();
  }

  unsigned top_down_ptr_list_size() const {
    return std::distance(top_down_ptr_begin(), top_down_ptr_end());
  }

  using bottom_up_ptr_iterator = decltype(PerPtrBottomUp)::iterator;
  using const_bottom_up_ptr_iterator =
      decltype(PerPtrBottomUp)::const_iterator;

  bottom_up_ptr_iterator bottom_up_ptr_begin() {
    return PerPtrBottomUp.begin();
  }
  bottom_up_ptr_iterator bottom_up_ptr_end() { return PerPtrBottomUp.end(); }
  const_bottom_up_ptr_iterator bottom_up_ptr_begin() const {
    return PerPtrBottomUp.begin();
  }
  const_bottom_up_ptr_iterator bottom_up_ptr_end() const {
    return PerPtrBottomUp.end();
  }
  bool hasBottomUpPtrs() const {
    return !PerPtrBottomUp.empty();
  }

  unsigned bottom_up_ptr_list_size() const {
    return std::distance(bottom_up_ptr_begin(), bottom_up_ptr_end());
  }

  /// Mark this block as being an entry block, which has one path from the
  /// entry by definition.
  void SetAsEntry() { TopDownPathCount = 1; }

  /// Mark this block as being an exit block, which has one path to an exit by
  /// definition.
  void SetAsExit()  { BottomUpPathCount = 1; }

  /// Attempt to find the PtrState object describing the top down state for
  /// pointer Arg. Return a new initialized PtrState describing the top down
  /// state for Arg if we do not find one.
  TopDownPtrState &getPtrTopDownState(const Value *Arg) {
    return PerPtrTopDown[Arg];
  }

  /// Attempt to find the PtrState object describing the bottom up state for
  /// pointer Arg. Return a new initialized PtrState describing the bottom up
  /// state for Arg if we do not find one.
  BottomUpPtrState &getPtrBottomUpState(const Value *Arg) {
    return PerPtrBottomUp[Arg];
  }

  /// Attempt to find the PtrState object describing the bottom up state for
  /// pointer Arg.
  bottom_up_ptr_iterator findPtrBottomUpState(const Value *Arg) {
    return PerPtrBottomUp.find(Arg);
  }

  void clearBottomUpPointers() {
    PerPtrBottomUp.clear();
  }

  void clearTopDownPointers() {
    PerPtrTopDown.clear();
  }

  void InitFromPred(const BBState &Other);
  void InitFromSucc(const BBState &Other);
  void MergePred(const BBState &Other);
  void MergeSucc(const BBState &Other);

  /// Compute the number of possible unique paths from an entry to an exit
  /// which pass through this block. This is only valid after both the
  /// top-down and bottom-up traversals are complete.
  ///
  /// Returns true if overflow occurred. Returns false if overflow did not
  /// occur.
  bool GetAllPathCountWithOverflow(unsigned &PathCount) const {
    if (TopDownPathCount == OverflowOccurredValue ||
        BottomUpPathCount == OverflowOccurredValue)
      return true;
    unsigned long long Product =
      (unsigned long long)TopDownPathCount*BottomUpPathCount;
    // Overflow occurred if any of the upper bits of Product are set or if all
    // the lower bits of Product are all set.
    return (Product >> 32) ||
           ((PathCount = Product) == OverflowOccurredValue);
  }

  // Specialized CFG utilities.
  using edge_iterator = SmallVectorImpl<BasicBlock *>::const_iterator;

  edge_iterator pred_begin() const { return Preds.begin(); }
  edge_iterator pred_end() const { return Preds.end(); }
  edge_iterator succ_begin() const { return Succs.begin(); }
  edge_iterator succ_end() const { return Succs.end(); }

  void addSucc(BasicBlock *Succ) { Succs.push_back(Succ); }
  void addPred(BasicBlock *Pred) { Preds.push_back(Pred); }

  bool isExit() const { return Succs.empty(); }
};

326} // end anonymous namespace

328const unsigned BBState::OverflowOccurredValue = 0xffffffff;

330namespace llvm {

332raw_ostream &operator<<(raw_ostream &OS,
                      BBState &BBState) LLVM_ATTRIBUTE_UNUSED__attribute__((__unused__));

335} // end namespace llvm

337void BBState::InitFromPred(const BBState &Other) {
PerPtrTopDown = Other.PerPtrTopDown;
TopDownPathCount = Other.TopDownPathCount;
340}

342void BBState::InitFromSucc(const BBState &Other) {
PerPtrBottomUp = Other.PerPtrBottomUp;
BottomUpPathCount = Other.BottomUpPathCount;
345}

347/// The top-down traversal uses this to merge information about predecessors to
348/// form the initial state for a new block.
349void BBState::MergePred(const BBState &Other) {
if (TopDownPathCount == OverflowOccurredValue)
  return;

// Other.TopDownPathCount can be 0, in which case it is either dead or a
// loop backedge. Loop backedges are special.
TopDownPathCount += Other.TopDownPathCount;

// In order to be consistent, we clear the top down pointers when by adding
// TopDownPathCount becomes OverflowOccurredValue even though "true" overflow
// has not occurred.
if (TopDownPathCount == OverflowOccurredValue) {
  clearTopDownPointers();
  return;
}

// Check for overflow. If we have overflow, fall back to conservative
// behavior.
if (TopDownPathCount < Other.TopDownPathCount) {
  TopDownPathCount = OverflowOccurredValue;
  clearTopDownPointers();
  return;
}

// For each entry in the other set, if our set has an entry with the same key,
// merge the entries. Otherwise, copy the entry and merge it with an empty
// entry.
for (auto MI = Other.top_down_ptr_begin(), ME = Other.top_down_ptr_end();
     MI != ME; ++MI) {
  auto Pair = PerPtrTopDown.insert(*MI);
  Pair.first->second.Merge(Pair.second ? TopDownPtrState() : MI->second,
                           /*TopDown=*/true);
}

// For each entry in our set, if the other set doesn't have an entry with the
// same key, force it to merge with an empty entry.
for (auto MI = top_down_ptr_begin(), ME = top_down_ptr_end(); MI != ME; ++MI)
  if (Other.PerPtrTopDown.find(MI->first) == Other.PerPtrTopDown.end())
    MI->second.Merge(TopDownPtrState(), /*TopDown=*/true);
388}

390/// The bottom-up traversal uses this to merge information about successors to
391/// form the initial state for a new block.
392void BBState::MergeSucc(const BBState &Other) {
if (BottomUpPathCount == OverflowOccurredValue)
  return;

// Other.BottomUpPathCount can be 0, in which case it is either dead or a
// loop backedge. Loop backedges are special.
BottomUpPathCount += Other.BottomUpPathCount;

// In order to be consistent, we clear the top down pointers when by adding
// BottomUpPathCount becomes OverflowOccurredValue even though "true" overflow
// has not occurred.
if (BottomUpPathCount == OverflowOccurredValue) {
  clearBottomUpPointers();
  return;
}

// Check for overflow. If we have overflow, fall back to conservative
// behavior.
if (BottomUpPathCount < Other.BottomUpPathCount) {
  BottomUpPathCount = OverflowOccurredValue;
  clearBottomUpPointers();
  return;
}

// For each entry in the other set, if our set has an entry with the
// same key, merge the entries. Otherwise, copy the entry and merge
// it with an empty entry.
for (auto MI = Other.bottom_up_ptr_begin(), ME = Other.bottom_up_ptr_end();
     MI != ME; ++MI) {
  auto Pair = PerPtrBottomUp.insert(*MI);
  Pair.first->second.Merge(Pair.second ? BottomUpPtrState() : MI->second,
                           /*TopDown=*/false);
}

// For each entry in our set, if the other set doesn't have an entry
// with the same key, force it to merge with an empty entry.
for (auto MI = bottom_up_ptr_begin(), ME = bottom_up_ptr_end(); MI != ME;
     ++MI)
  if (Other.PerPtrBottomUp.find(MI->first) == Other.PerPtrBottomUp.end())
    MI->second.Merge(BottomUpPtrState(), /*TopDown=*/false);
432}

434raw_ostream &llvm::operator<<(raw_ostream &OS, BBState &BBInfo) {
// Dump the pointers we are tracking.
OS << "    TopDown State:\n";
if (!BBInfo.hasTopDownPtrs()) {
  LLVM_DEBUG(dbgs() << "        NONE!\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "        NONE!\n"; } } while
 (false);
} else {
  for (auto I = BBInfo.top_down_ptr_begin(), E = BBInfo.top_down_ptr_end();
       I != E; ++I) {
    const PtrState &P = I->second;
    OS << "        Ptr: " << *I->first
       << "\n            KnownSafe:        " << (P.IsKnownSafe()?"true":"false")
       << "\n            ImpreciseRelease: "
         << (P.IsTrackingImpreciseReleases()?"true":"false") << "\n"
       << "            HasCFGHazards:    "
         << (P.IsCFGHazardAfflicted()?"true":"false") << "\n"
       << "            KnownPositive:    "
         << (P.HasKnownPositiveRefCount()?"true":"false") << "\n"
       << "            Seq:              "
       << P.GetSeq() << "\n";
  }
}

OS << "    BottomUp State:\n";
if (!BBInfo.hasBottomUpPtrs()) {
  LLVM_DEBUG(dbgs() << "        NONE!\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "        NONE!\n"; } } while
 (false);
} else {
  for (auto I = BBInfo.bottom_up_ptr_begin(), E = BBInfo.bottom_up_ptr_end();
       I != E; ++I) {
    const PtrState &P = I->second;
    OS << "        Ptr: " << *I->first
       << "\n            KnownSafe:        " << (P.IsKnownSafe()?"true":"false")
       << "\n            ImpreciseRelease: "
         << (P.IsTrackingImpreciseReleases()?"true":"false") << "\n"
       << "            HasCFGHazards:    "
         << (P.IsCFGHazardAfflicted()?"true":"false") << "\n"
       << "            KnownPositive:    "
         << (P.HasKnownPositiveRefCount()?"true":"false") << "\n"
       << "            Seq:              "
       << P.GetSeq() << "\n";
  }
}

return OS;
477}

479namespace {

/// The main ARC optimization pass.
482class ObjCARCOpt {
bool Changed = false;
bool CFGChanged = false;
ProvenanceAnalysis PA;

/// A cache of references to runtime entry point constants.
ARCRuntimeEntryPoints EP;

/// A cache of MDKinds that can be passed into other functions to propagate
/// MDKind identifiers.
ARCMDKindCache MDKindCache;

BundledRetainClaimRVs *BundledInsts = nullptr;

/// A flag indicating whether the optimization that removes or moves
/// retain/release pairs should be performed.
bool DisableRetainReleasePairing = false;

/// Flags which determine whether each of the interesting runtime functions
/// is in fact used in the current function.
unsigned UsedInThisFunction;

DenseMap<BasicBlock *, ColorVector> BlockEHColors;

bool OptimizeRetainRVCall(Function &F, Instruction *RetainRV);
void OptimizeAutoreleaseRVCall(Function &F, Instruction *AutoreleaseRV,
                               ARCInstKind &Class);
void OptimizeIndividualCalls(Function &F);

/// Optimize an individual call, optionally passing the
/// GetArgRCIdentityRoot if it has already been computed.
void OptimizeIndividualCallImpl(Function &F, Instruction *Inst,
                                ARCInstKind Class, const Value *Arg);

/// Try to optimize an AutoreleaseRV with a RetainRV or UnsafeClaimRV.  If the
/// optimization occurs, returns true to indicate that the caller should
/// assume the instructions are dead.
bool OptimizeInlinedAutoreleaseRVCall(Function &F, Instruction *Inst,
                                      const Value *&Arg, ARCInstKind Class,
                                      Instruction *AutoreleaseRV,
                                      const Value *&AutoreleaseRVArg);

void CheckForCFGHazards(const BasicBlock *BB,
                        DenseMap<const BasicBlock *, BBState> &BBStates,
                        BBState &MyStates) const;
bool VisitInstructionBottomUp(Instruction *Inst, BasicBlock *BB,
                              BlotMapVector<Value *, RRInfo> &Retains,
                              BBState &MyStates);
bool VisitBottomUp(BasicBlock *BB,
                   DenseMap<const BasicBlock *, BBState> &BBStates,
                   BlotMapVector<Value *, RRInfo> &Retains);
bool VisitInstructionTopDown(
    Instruction *Inst, DenseMap<Value *, RRInfo> &Releases, BBState &MyStates,
    const DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
        &ReleaseInsertPtToRCIdentityRoots);
bool VisitTopDown(
    BasicBlock *BB, DenseMap<const BasicBlock *, BBState> &BBStates,
    DenseMap<Value *, RRInfo> &Releases,
    const DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
        &ReleaseInsertPtToRCIdentityRoots);
bool Visit(Function &F, DenseMap<const BasicBlock *, BBState> &BBStates,
           BlotMapVector<Value *, RRInfo> &Retains,
           DenseMap<Value *, RRInfo> &Releases);

void MoveCalls(Value *Arg, RRInfo &RetainsToMove, RRInfo &ReleasesToMove,
               BlotMapVector<Value *, RRInfo> &Retains,
               DenseMap<Value *, RRInfo> &Releases,
               SmallVectorImpl<Instruction *> &DeadInsts, Module *M);

bool PairUpRetainsAndReleases(DenseMap<const BasicBlock *, BBState> &BBStates,
                              BlotMapVector<Value *, RRInfo> &Retains,
                              DenseMap<Value *, RRInfo> &Releases, Module *M,
                              Instruction *Retain,
                              SmallVectorImpl<Instruction *> &DeadInsts,
                              RRInfo &RetainsToMove, RRInfo &ReleasesToMove,
                              Value *Arg, bool KnownSafe,
                              bool &AnyPairsCompletelyEliminated);

bool PerformCodePlacement(DenseMap<const BasicBlock *, BBState> &BBStates,
                          BlotMapVector<Value *, RRInfo> &Retains,
                          DenseMap<Value *, RRInfo> &Releases, Module *M);

void OptimizeWeakCalls(Function &F);

bool OptimizeSequences(Function &F);

void OptimizeReturns(Function &F);

template <typename PredicateT>
static void cloneOpBundlesIf(CallBase *CI,
                             SmallVectorImpl<OperandBundleDef> &OpBundles,
                             PredicateT Predicate) {
  for (unsigned I = 0, E = CI->getNumOperandBundles(); I != E; ++I) {
    OperandBundleUse B = CI->getOperandBundleAt(I);
    if (Predicate(B))
      OpBundles.emplace_back(B);
  }
}

void addOpBundleForFunclet(BasicBlock *BB,
                           SmallVectorImpl<OperandBundleDef> &OpBundles) {
  if (!BlockEHColors.empty()) {
    const ColorVector &CV = BlockEHColors.find(BB)->second;
    assert(CV.size() > 0 && "Uncolored block")(static_cast <bool> (CV.size() > 0 && "Uncolored block"
) ? void (0) : __assert_fail ("CV.size() > 0 && \"Uncolored block\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 585, __extension__
 __PRETTY_FUNCTION__));
    for (BasicBlock *EHPadBB : CV)
      if (auto *EHPad = dyn_cast<FuncletPadInst>(EHPadBB->getFirstNonPHI())) {
        OpBundles.emplace_back("funclet", EHPad);
        return;
      }
  }
}

594#ifndef NDEBUG
void GatherStatistics(Function &F, bool AfterOptimization = false);
596#endif

public:
  void init(Function &F);
  bool run(Function &F, AAResults &AA);
  bool hasCFGChanged() const { return CFGChanged; }
602};
603} // end anonymous namespace

605/// Turn objc_retainAutoreleasedReturnValue into objc_retain if the operand is
606/// not a return value.
607bool
608ObjCARCOpt::OptimizeRetainRVCall(Function &F, Instruction *RetainRV) {
// Check for the argument being from an immediately preceding call or invoke.
const Value *Arg = GetArgRCIdentityRoot(RetainRV);
if (const Instruction *Call = dyn_cast<CallBase>(Arg)) {
  if (Call->getParent() == RetainRV->getParent()) {
    BasicBlock::const_iterator I(Call);
    ++I;
    while (IsNoopInstruction(&*I))
      ++I;
    if (&*I == RetainRV)
      return false;
  } else if (const InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
    BasicBlock *RetainRVParent = RetainRV->getParent();
    if (II->getNormalDest() == RetainRVParent) {
      BasicBlock::const_iterator I = RetainRVParent->begin();
      while (IsNoopInstruction(&*I))
        ++I;
      if (&*I == RetainRV)
        return false;
    }
  }
}

assert(!BundledInsts->contains(RetainRV) &&(static_cast <bool> (!BundledInsts->contains(RetainRV
) && "a bundled retainRV's argument should be a call"
) ? void (0) : __assert_fail ("!BundledInsts->contains(RetainRV) && \"a bundled retainRV's argument should be a call\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 632, __extension__
 __PRETTY_FUNCTION__))
       "a bundled retainRV's argument should be a call")(static_cast <bool> (!BundledInsts->contains(RetainRV
) && "a bundled retainRV's argument should be a call"
) ? void (0) : __assert_fail ("!BundledInsts->contains(RetainRV) && \"a bundled retainRV's argument should be a call\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 632, __extension__
 __PRETTY_FUNCTION__));

// Turn it to a plain objc_retain.
Changed = true;
++NumPeeps;

LLVM_DEBUG(dbgs() << "Transforming objc_retainAutoreleasedReturnValue => "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_retainAutoreleasedReturnValue => "
 "objc_retain since the operand is not a return value.\n" "Old = "
 << *RetainRV << "\n"; } } while (false)
                     "objc_retain since the operand is not a return value.\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_retainAutoreleasedReturnValue => "
 "objc_retain since the operand is not a return value.\n" "Old = "
 << *RetainRV << "\n"; } } while (false)
                     "Old = "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_retainAutoreleasedReturnValue => "
 "objc_retain since the operand is not a return value.\n" "Old = "
 << *RetainRV << "\n"; } } while (false)
                  << *RetainRV << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_retainAutoreleasedReturnValue => "
 "objc_retain since the operand is not a return value.\n" "Old = "
 << *RetainRV << "\n"; } } while (false);

Function *NewDecl = EP.get(ARCRuntimeEntryPointKind::Retain);
cast<CallInst>(RetainRV)->setCalledFunction(NewDecl);

LLVM_DEBUG(dbgs() << "New = " << *RetainRV << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "New = " << *RetainRV
 << "\n"; } } while (false);

return false;
649}

651bool ObjCARCOpt::OptimizeInlinedAutoreleaseRVCall(
  Function &F, Instruction *Inst, const Value *&Arg, ARCInstKind Class,
  Instruction *AutoreleaseRV, const Value *&AutoreleaseRVArg) {
if (BundledInsts->contains(Inst))
  return false;

// Must be in the same basic block.
assert(Inst->getParent() == AutoreleaseRV->getParent())(static_cast <bool> (Inst->getParent() == AutoreleaseRV
->getParent()) ? void (0) : __assert_fail ("Inst->getParent() == AutoreleaseRV->getParent()"
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 658, __extension__
 __PRETTY_FUNCTION__));

// Must operate on the same root.
Arg = GetArgRCIdentityRoot(Inst);
AutoreleaseRVArg = GetArgRCIdentityRoot(AutoreleaseRV);
if (Arg != AutoreleaseRVArg) {
  // If there isn't an exact match, check if we have equivalent PHIs.
  const PHINode *PN = dyn_cast<PHINode>(Arg);
  if (!PN)
    return false;

  SmallVector<const Value *, 4> ArgUsers;
  getEquivalentPHIs(*PN, ArgUsers);
  if (!llvm::is_contained(ArgUsers, AutoreleaseRVArg))
    return false;
}

// Okay, this is a match.  Merge them.
++NumPeeps;
LLVM_DEBUG(dbgs() << "Found inlined objc_autoreleaseReturnValue '"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Found inlined objc_autoreleaseReturnValue '"
 << *AutoreleaseRV << "' paired with '" << *
Inst << "'\n"; } } while (false)
                  << *AutoreleaseRV << "' paired with '" << *Inst << "'\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Found inlined objc_autoreleaseReturnValue '"
 << *AutoreleaseRV << "' paired with '" << *
Inst << "'\n"; } } while (false);

// Delete the RV pair, starting with the AutoreleaseRV.
AutoreleaseRV->replaceAllUsesWith(
    cast<CallInst>(AutoreleaseRV)->getArgOperand(0));
Changed = true;
EraseInstruction(AutoreleaseRV);
if (Class == ARCInstKind::RetainRV) {
  // AutoreleaseRV and RetainRV cancel out.  Delete the RetainRV.
  Inst->replaceAllUsesWith(cast<CallInst>(Inst)->getArgOperand(0));
  EraseInstruction(Inst);
  return true;
}

// UnsafeClaimRV is a frontend peephole for RetainRV + Release.  Since the
// AutoreleaseRV and RetainRV cancel out, replace UnsafeClaimRV with Release.
assert(Class == ARCInstKind::UnsafeClaimRV)(static_cast <bool> (Class == ARCInstKind::UnsafeClaimRV
) ? void (0) : __assert_fail ("Class == ARCInstKind::UnsafeClaimRV"
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 694, __extension__
 __PRETTY_FUNCTION__));
Value *CallArg = cast<CallInst>(Inst)->getArgOperand(0);
CallInst *Release = CallInst::Create(
    EP.get(ARCRuntimeEntryPointKind::Release), CallArg, "", Inst);
assert(IsAlwaysTail(ARCInstKind::UnsafeClaimRV) &&(static_cast <bool> (IsAlwaysTail(ARCInstKind::UnsafeClaimRV
) && "Expected UnsafeClaimRV to be safe to tail call"
) ? void (0) : __assert_fail ("IsAlwaysTail(ARCInstKind::UnsafeClaimRV) && \"Expected UnsafeClaimRV to be safe to tail call\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 699, __extension__
 __PRETTY_FUNCTION__))
       "Expected UnsafeClaimRV to be safe to tail call")(static_cast <bool> (IsAlwaysTail(ARCInstKind::UnsafeClaimRV
) && "Expected UnsafeClaimRV to be safe to tail call"
) ? void (0) : __assert_fail ("IsAlwaysTail(ARCInstKind::UnsafeClaimRV) && \"Expected UnsafeClaimRV to be safe to tail call\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 699, __extension__
 __PRETTY_FUNCTION__));
Release->setTailCall();
Inst->replaceAllUsesWith(CallArg);
EraseInstruction(Inst);

// Run the normal optimizations on Release.
OptimizeIndividualCallImpl(F, Release, ARCInstKind::Release, Arg);
return true;
707}

709/// Turn objc_autoreleaseReturnValue into objc_autorelease if the result is not
710/// used as a return value.
711void ObjCARCOpt::OptimizeAutoreleaseRVCall(Function &F,
                                         Instruction *AutoreleaseRV,
                                         ARCInstKind &Class) {
// Check for a return of the pointer value.
const Value *Ptr = GetArgRCIdentityRoot(AutoreleaseRV);

// If the argument is ConstantPointerNull or UndefValue, its other users
// aren't actually interesting to look at.
if (isa<ConstantData>(Ptr))
  return;

SmallVector<const Value *, 2> Users;
Users.push_back(Ptr);

// Add PHIs that are equivalent to Ptr to Users.
if (const PHINode *PN = dyn_cast<PHINode>(Ptr))
  getEquivalentPHIs(*PN, Users);

do {
  Ptr = Users.pop_back_val();
  for (const User *U : Ptr->users()) {
    if (isa<ReturnInst>(U) || GetBasicARCInstKind(U) == ARCInstKind::RetainRV)
      return;
    if (isa<BitCastInst>(U))
      Users.push_back(U);
  }
} while (!Users.empty());

Changed = true;
++NumPeeps;

LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_autoreleaseReturnValue => "
 "objc_autorelease since its operand is not used as a return "
 "value.\n" "Old = " << *AutoreleaseRV << "\n"; }
 } while (false)
    dbgs() << "Transforming objc_autoreleaseReturnValue => "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_autoreleaseReturnValue => "
 "objc_autorelease since its operand is not used as a return "
 "value.\n" "Old = " << *AutoreleaseRV << "\n"; }
 } while (false)
              "objc_autorelease since its operand is not used as a return "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_autoreleaseReturnValue => "
 "objc_autorelease since its operand is not used as a return "
 "value.\n" "Old = " << *AutoreleaseRV << "\n"; }
 } while (false)
              "value.\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_autoreleaseReturnValue => "
 "objc_autorelease since its operand is not used as a return "
 "value.\n" "Old = " << *AutoreleaseRV << "\n"; }
 } while (false)
              "Old = "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_autoreleaseReturnValue => "
 "objc_autorelease since its operand is not used as a return "
 "value.\n" "Old = " << *AutoreleaseRV << "\n"; }
 } while (false)
           << *AutoreleaseRV << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Transforming objc_autoreleaseReturnValue => "
 "objc_autorelease since its operand is not used as a return "
 "value.\n" "Old = " << *AutoreleaseRV << "\n"; }
 } while (false);

CallInst *AutoreleaseRVCI = cast<CallInst>(AutoreleaseRV);
Function *NewDecl = EP.get(ARCRuntimeEntryPointKind::Autorelease);
AutoreleaseRVCI->setCalledFunction(NewDecl);
AutoreleaseRVCI->setTailCall(false); // Never tail call objc_autorelease.
Class = ARCInstKind::Autorelease;

LLVM_DEBUG(dbgs() << "New: " << *AutoreleaseRV << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "New: " << *AutoreleaseRV
 << "\n"; } } while (false);
756}

758/// Visit each call, one at a time, and make simplifications without doing any
759/// additional analysis.
760void ObjCARCOpt::OptimizeIndividualCalls(Function &F) {
LLVM_DEBUG(dbgs() << "\n== ObjCARCOpt::OptimizeIndividualCalls ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n== ObjCARCOpt::OptimizeIndividualCalls ==\n"
; } } while (false);
// Reset all the flags in preparation for recomputing them.
UsedInThisFunction = 0;

// Store any delayed AutoreleaseRV intrinsics, so they can be easily paired
// with RetainRV and UnsafeClaimRV.
Instruction *DelayedAutoreleaseRV = nullptr;
const Value *DelayedAutoreleaseRVArg = nullptr;
auto setDelayedAutoreleaseRV = [&](Instruction *AutoreleaseRV) {
  assert(!DelayedAutoreleaseRV || !AutoreleaseRV)(static_cast <bool> (!DelayedAutoreleaseRV || !AutoreleaseRV
) ? void (0) : __assert_fail ("!DelayedAutoreleaseRV || !AutoreleaseRV"
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 770, __extension__
 __PRETTY_FUNCTION__));
  DelayedAutoreleaseRV = AutoreleaseRV;
  DelayedAutoreleaseRVArg = nullptr;
};
auto optimizeDelayedAutoreleaseRV = [&]() {
  if (!DelayedAutoreleaseRV)
    return;
  OptimizeIndividualCallImpl(F, DelayedAutoreleaseRV,
                             ARCInstKind::AutoreleaseRV,
                             DelayedAutoreleaseRVArg);
  setDelayedAutoreleaseRV(nullptr);
};
auto shouldDelayAutoreleaseRV = [&](Instruction *NonARCInst) {
  // Nothing to delay, but we may as well skip the logic below.
  if (!DelayedAutoreleaseRV)
    return true;

  // If we hit the end of the basic block we're not going to find an RV-pair.
  // Stop delaying.
  if (NonARCInst->isTerminator())
    return false;

  // Given the frontend rules for emitting AutoreleaseRV, RetainRV, and
  // UnsafeClaimRV, it's probably safe to skip over even opaque function calls
  // here since OptimizeInlinedAutoreleaseRVCall will confirm that they
  // have the same RCIdentityRoot.  However, what really matters is
  // skipping instructions or intrinsics that the inliner could leave behind;
  // be conservative for now and don't skip over opaque calls, which could
  // potentially include other ARC calls.
  auto *CB = dyn_cast<CallBase>(NonARCInst);
  if (!CB)
    return true;
  return CB->getIntrinsicID() != Intrinsic::not_intrinsic;
};

// Visit all objc_* calls in F.
for (inst_iterator I = inst_begin(&F), E = inst_end(&F); I != E; ) {
  Instruction *Inst = &*I++;

  if (auto *CI = dyn_cast<CallInst>(Inst))
    if (objcarc::hasAttachedCallOpBundle(CI)) {
      BundledInsts->insertRVCall(&*I, CI);
      Changed = true;
    }

  ARCInstKind Class = GetBasicARCInstKind(Inst);

  // Skip this loop if this instruction isn't itself an ARC intrinsic.
  const Value *Arg = nullptr;
  switch (Class) {
  default:
    optimizeDelayedAutoreleaseRV();
    break;
  case ARCInstKind::CallOrUser:
  case ARCInstKind::User:
  case ARCInstKind::None:
    // This is a non-ARC instruction.  If we're delaying an AutoreleaseRV,
    // check if it's safe to skip over it; if not, optimize the AutoreleaseRV
    // now.
    if (!shouldDelayAutoreleaseRV(Inst))
      optimizeDelayedAutoreleaseRV();
    continue;
  case ARCInstKind::AutoreleaseRV:
    optimizeDelayedAutoreleaseRV();
    setDelayedAutoreleaseRV(Inst);
    continue;
  case ARCInstKind::RetainRV:
  case ARCInstKind::UnsafeClaimRV:
    if (DelayedAutoreleaseRV) {
      // We have a potential RV pair.  Check if they cancel out.
      if (OptimizeInlinedAutoreleaseRVCall(F, Inst, Arg, Class,
                                           DelayedAutoreleaseRV,
                                           DelayedAutoreleaseRVArg)) {
        setDelayedAutoreleaseRV(nullptr);
        continue;
      }
      optimizeDelayedAutoreleaseRV();
    }
    break;
  }

  OptimizeIndividualCallImpl(F, Inst, Class, Arg);
}

// Catch the final delayed AutoreleaseRV.
optimizeDelayedAutoreleaseRV();
856}

858/// This function returns true if the value is inert. An ObjC ARC runtime call
859/// taking an inert operand can be safely deleted.
860static bool isInertARCValue(Value *V, SmallPtrSet<Value *, 1> &VisitedPhis) {
V = V->stripPointerCasts();

if (IsNullOrUndef(V))
  return true;

// See if this is a global attribute annotated with an 'objc_arc_inert'.
if (auto *GV = dyn_cast<GlobalVariable>(V))
  if (GV->hasAttribute("objc_arc_inert"))
    return true;

if (auto PN = dyn_cast<PHINode>(V)) {
  // Ignore this phi if it has already been discovered.
  if (!VisitedPhis.insert(PN).second)
    return true;
  // Look through phis's operands.
  for (Value *Opnd : PN->incoming_values())
    if (!isInertARCValue(Opnd, VisitedPhis))
      return false;
  return true;
}

return false;
883}

885void ObjCARCOpt::OptimizeIndividualCallImpl(Function &F, Instruction *Inst,
                                          ARCInstKind Class,
                                          const Value *Arg) {
LLVM_DEBUG(dbgs() << "Visiting: Class: " << Class << "; " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Visiting: Class: " <<
 Class << "; " << *Inst << "\n"; } } while (
false);

// We can delete this call if it takes an inert value.
SmallPtrSet<Value *, 1> VisitedPhis;

if (BundledInsts->contains(Inst)) {
  UsedInThisFunction |= 1 << unsigned(Class);
  return;
}

if (IsNoopOnGlobal(Class))
  if (isInertARCValue(Inst->getOperand(0), VisitedPhis)) {
    if (!Inst->getType()->isVoidTy())
      Inst->replaceAllUsesWith(Inst->getOperand(0));
    Inst->eraseFromParent();
    Changed = true;
    return;
  }

switch (Class) {
default:
  break;

// Delete no-op casts. These function calls have special semantics, but
// the semantics are entirely implemented via lowering in the front-end,
// so by the time they reach the optimizer, they are just no-op calls
// which return their argument.
//
// There are gray areas here, as the ability to cast reference-counted
// pointers to raw void* and back allows code to break ARC assumptions,
// however these are currently considered to be unimportant.
case ARCInstKind::NoopCast:
  Changed = true;
  ++NumNoops;
  LLVM_DEBUG(dbgs() << "Erasing no-op cast: " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Erasing no-op cast: " <<
 *Inst << "\n"; } } while (false);
  EraseInstruction(Inst);
  return;

// If the pointer-to-weak-pointer is null, it's undefined behavior.
case ARCInstKind::StoreWeak:
case ARCInstKind::LoadWeak:
case ARCInstKind::LoadWeakRetained:
case ARCInstKind::InitWeak:
case ARCInstKind::DestroyWeak: {
  CallInst *CI = cast<CallInst>(Inst);
  if (IsNullOrUndef(CI->getArgOperand(0))) {
    Changed = true;
    new StoreInst(ConstantInt::getTrue(CI->getContext()),
                  UndefValue::get(Type::getInt1PtrTy(CI->getContext())), CI);
    Value *NewValue = UndefValue::get(CI->getType());
    LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false)
        dbgs() << "A null pointer-to-weak-pointer is undefined behavior."do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false)
                  "\nOld = "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false)
               << *CI << "\nNew = " << *NewValue << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false);
    CI->replaceAllUsesWith(NewValue);
    CI->eraseFromParent();
    return;
  }
  break;
}
case ARCInstKind::CopyWeak:
case ARCInstKind::MoveWeak: {
  CallInst *CI = cast<CallInst>(Inst);
  if (IsNullOrUndef(CI->getArgOperand(0)) ||
      IsNullOrUndef(CI->getArgOperand(1))) {
    Changed = true;
    new StoreInst(ConstantInt::getTrue(CI->getContext()),
                  UndefValue::get(Type::getInt1PtrTy(CI->getContext())), CI);

    Value *NewValue = UndefValue::get(CI->getType());
    LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false)
        dbgs() << "A null pointer-to-weak-pointer is undefined behavior."do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false)
                  "\nOld = "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false)
               << *CI << "\nNew = " << *NewValue << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "A null pointer-to-weak-pointer is undefined behavior."
 "\nOld = " << *CI << "\nNew = " << *NewValue
 << "\n"; } } while (false);

    CI->replaceAllUsesWith(NewValue);
    CI->eraseFromParent();
    return;
  }
  break;
}
case ARCInstKind::RetainRV:
  if (OptimizeRetainRVCall(F, Inst))
    return;
  break;
case ARCInstKind::AutoreleaseRV:
  OptimizeAutoreleaseRVCall(F, Inst, Class);
  break;
}

// objc_autorelease(x) -> objc_release(x) if x is otherwise unused.
if (IsAutorelease(Class) && Inst->use_empty()) {
  CallInst *Call = cast<CallInst>(Inst);
  const Value *Arg = Call->getArgOperand(0);
  Arg = FindSingleUseIdentifiedObject(Arg);
  if (Arg) {
    Changed = true;
    ++NumAutoreleases;

    // Create the declaration lazily.
    LLVMContext &C = Inst->getContext();

    Function *Decl = EP.get(ARCRuntimeEntryPointKind::Release);
    CallInst *NewCall =
        CallInst::Create(Decl, Call->getArgOperand(0), "", Call);
    NewCall->setMetadata(MDKindCache.get(ARCMDKindID::ImpreciseRelease),
                         MDNode::get(C, std::nullopt));

    LLVM_DEBUG(dbgs() << "Replacing autorelease{,RV}(x) with objc_release(x) "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Replacing autorelease{,RV}(x) with objc_release(x) "
 "since x is otherwise unused.\nOld: " << *Call <<
 "\nNew: " << *NewCall << "\n"; } } while (false)
                         "since x is otherwise unused.\nOld: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Replacing autorelease{,RV}(x) with objc_release(x) "
 "since x is otherwise unused.\nOld: " << *Call <<
 "\nNew: " << *NewCall << "\n"; } } while (false)
                      << *Call << "\nNew: " << *NewCall << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Replacing autorelease{,RV}(x) with objc_release(x) "
 "since x is otherwise unused.\nOld: " << *Call <<
 "\nNew: " << *NewCall << "\n"; } } while (false);

    EraseInstruction(Call);
    Inst = NewCall;
    Class = ARCInstKind::Release;
  }
}

// For functions which can never be passed stack arguments, add
// a tail keyword.
if (IsAlwaysTail(Class) && !cast<CallInst>(Inst)->isNoTailCall()) {
  Changed = true;
  LLVM_DEBUG(do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Adding tail keyword to function since it can never be "
 "passed stack args: " << *Inst << "\n"; } } while
 (false)
      dbgs() << "Adding tail keyword to function since it can never be "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Adding tail keyword to function since it can never be "
 "passed stack args: " << *Inst << "\n"; } } while
 (false)
                "passed stack args: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Adding tail keyword to function since it can never be "
 "passed stack args: " << *Inst << "\n"; } } while
 (false)
             << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Adding tail keyword to function since it can never be "
 "passed stack args: " << *Inst << "\n"; } } while
 (false);
  cast<CallInst>(Inst)->setTailCall();
}

// Ensure that functions that can never have a "tail" keyword due to the
// semantics of ARC truly do not do so.
if (IsNeverTail(Class)) {
  Changed = true;
  LLVM_DEBUG(dbgs() << "Removing tail keyword from function: " << *Instdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Removing tail keyword from function: "
 << *Inst << "\n"; } } while (false)
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Removing tail keyword from function: "
 << *Inst << "\n"; } } while (false);
  cast<CallInst>(Inst)->setTailCall(false);
}

// Set nounwind as needed.
if (IsNoThrow(Class)) {
  Changed = true;
  LLVM_DEBUG(dbgs() << "Found no throw class. Setting nounwind on: " << *Instdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Found no throw class. Setting nounwind on: "
 << *Inst << "\n"; } } while (false)
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Found no throw class. Setting nounwind on: "
 << *Inst << "\n"; } } while (false);
  cast<CallInst>(Inst)->setDoesNotThrow();
}

// Note: This catches instructions unrelated to ARC.
if (!IsNoopOnNull(Class)) {
  UsedInThisFunction |= 1 << unsigned(Class);
  return;
}

// If we haven't already looked up the root, look it up now.
if (!Arg)
  Arg = GetArgRCIdentityRoot(Inst);

// ARC calls with null are no-ops. Delete them.
if (IsNullOrUndef(Arg)) {
  Changed = true;
  ++NumNoops;
  LLVM_DEBUG(dbgs() << "ARC calls with  null are no-ops. Erasing: " << *Instdo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "ARC calls with  null are no-ops. Erasing: "
 << *Inst << "\n"; } } while (false)
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "ARC calls with  null are no-ops. Erasing: "
 << *Inst << "\n"; } } while (false);
  EraseInstruction(Inst);
  return;
}

// Keep track of which of retain, release, autorelease, and retain_block
// are actually present in this function.
UsedInThisFunction |= 1 << unsigned(Class);

// If Arg is a PHI, and one or more incoming values to the
// PHI are null, and the call is control-equivalent to the PHI, and there
// are no relevant side effects between the PHI and the call, and the call
// is not a release that doesn't have the clang.imprecise_release tag, the
// call could be pushed up to just those paths with non-null incoming
// values. For now, don't bother splitting critical edges for this.
if (Class == ARCInstKind::Release &&
    !Inst->getMetadata(MDKindCache.get(ARCMDKindID::ImpreciseRelease)))
  return;

SmallVector<std::pair<Instruction *, const Value *>, 4> Worklist;
Worklist.push_back(std::make_pair(Inst, Arg));
do {
  std::pair<Instruction *, const Value *> Pair = Worklist.pop_back_val();
  Inst = Pair.first;
  Arg = Pair.second;

  const PHINode *PN = dyn_cast<PHINode>(Arg);
  if (!PN)
    continue;

  // Determine if the PHI has any null operands, or any incoming
  // critical edges.
  bool HasNull = false;
  bool HasCriticalEdges = false;
  for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
    Value *Incoming = GetRCIdentityRoot(PN->getIncomingValue(i));
    if (IsNullOrUndef(Incoming))
      HasNull = true;
    else if (PN->getIncomingBlock(i)->getTerminator()->getNumSuccessors() !=
             1) {
      HasCriticalEdges = true;
      break;
    }
  }
  // If we have null operands and no critical edges, optimize.
  if (HasCriticalEdges)
    continue;
  if (!HasNull)
    continue;

  Instruction *DepInst = nullptr;

  // Check that there is nothing that cares about the reference
  // count between the call and the phi.
  switch (Class) {
  case ARCInstKind::Retain:
  case ARCInstKind::RetainBlock:
    // These can always be moved up.
    break;
  case ARCInstKind::Release:
    // These can't be moved across things that care about the retain
    // count.
    DepInst = findSingleDependency(NeedsPositiveRetainCount, Arg,
                                   Inst->getParent(), Inst, PA);
    break;
  case ARCInstKind::Autorelease:
    // These can't be moved across autorelease pool scope boundaries.
    DepInst = findSingleDependency(AutoreleasePoolBoundary, Arg,
                                   Inst->getParent(), Inst, PA);
    break;
  case ARCInstKind::UnsafeClaimRV:
  case ARCInstKind::RetainRV:
  case ARCInstKind::AutoreleaseRV:
    // Don't move these; the RV optimization depends on the autoreleaseRV
    // being tail called, and the retainRV being immediately after a call
    // (which might still happen if we get lucky with codegen layout, but
    // it's not worth taking the chance).
    continue;
  default:
    llvm_unreachable("Invalid dependence flavor")::llvm::llvm_unreachable_internal("Invalid dependence flavor"
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1128);
  }

  if (DepInst != PN)
    continue;

  Changed = true;
  ++NumPartialNoops;
  // Clone the call into each predecessor that has a non-null value.
  CallInst *CInst = cast<CallInst>(Inst);
  Type *ParamTy = CInst->getArgOperand(0)->getType();
  for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
    Value *Incoming = GetRCIdentityRoot(PN->getIncomingValue(i));
    if (IsNullOrUndef(Incoming))
      continue;
    Value *Op = PN->getIncomingValue(i);
    Instruction *InsertPos = &PN->getIncomingBlock(i)->back();
    SmallVector<OperandBundleDef, 1> OpBundles;
    cloneOpBundlesIf(CInst, OpBundles, [](const OperandBundleUse &B) {
      return B.getTagID() != LLVMContext::OB_funclet;
    });
    addOpBundleForFunclet(InsertPos->getParent(), OpBundles);
    CallInst *Clone = CallInst::Create(CInst, OpBundles);
    if (Op->getType() != ParamTy)
      Op = new BitCastInst(Op, ParamTy, "", InsertPos);
    Clone->setArgOperand(0, Op);
    Clone->insertBefore(InsertPos);

    LLVM_DEBUG(dbgs() << "Cloning " << *CInst << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Cloning " << *CInst
 << "\n" "And inserting clone at " << *InsertPos <<
 "\n"; } } while (false)
                                                 "And inserting clone at "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Cloning " << *CInst
 << "\n" "And inserting clone at " << *InsertPos <<
 "\n"; } } while (false)
                      << *InsertPos << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Cloning " << *CInst
 << "\n" "And inserting clone at " << *InsertPos <<
 "\n"; } } while (false);
    Worklist.push_back(std::make_pair(Clone, Incoming));
  }
  // Erase the original call.
  LLVM_DEBUG(dbgs() << "Erasing: " << *CInst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Erasing: " << *CInst
 << "\n"; } } while (false);
  EraseInstruction(CInst);
} while (!Worklist.empty());
1165}

1167/// If we have a top down pointer in the S_Use state, make sure that there are
1168/// no CFG hazards by checking the states of various bottom up pointers.
1169static void CheckForUseCFGHazard(const Sequence SuccSSeq,
                               const bool SuccSRRIKnownSafe,
                               TopDownPtrState &S,
                               bool &SomeSuccHasSame,
                               bool &AllSuccsHaveSame,
                               bool &NotAllSeqEqualButKnownSafe,
                               bool &ShouldContinue) {
switch (SuccSSeq) {
case S_CanRelease: {
  if (!S.IsKnownSafe() && !SuccSRRIKnownSafe) {
    S.ClearSequenceProgress();
    break;
  }
  S.SetCFGHazardAfflicted(true);
  ShouldContinue = true;
  break;
}
case S_Use:
  SomeSuccHasSame = true;
  break;
case S_Stop:
case S_MovableRelease:
  if (!S.IsKnownSafe() && !SuccSRRIKnownSafe)
    AllSuccsHaveSame = false;
  else
    NotAllSeqEqualButKnownSafe = true;
  break;
case S_Retain:
  llvm_unreachable("bottom-up pointer in retain state!")::llvm::llvm_unreachable_internal("bottom-up pointer in retain state!"
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1197);
case S_None:
  llvm_unreachable("This should have been handled earlier.")::llvm::llvm_unreachable_internal("This should have been handled earlier."
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1199);
}
1201}

1203/// If we have a Top Down pointer in the S_CanRelease state, make sure that
1204/// there are no CFG hazards by checking the states of various bottom up
1205/// pointers.
1206static void CheckForCanReleaseCFGHazard(const Sequence SuccSSeq,
                                      const bool SuccSRRIKnownSafe,
                                      TopDownPtrState &S,
                                      bool &SomeSuccHasSame,
                                      bool &AllSuccsHaveSame,
                                      bool &NotAllSeqEqualButKnownSafe) {
switch (SuccSSeq) {
case S_CanRelease:
  SomeSuccHasSame = true;
  break;
case S_Stop:
case S_MovableRelease:
case S_Use:
  if (!S.IsKnownSafe() && !SuccSRRIKnownSafe)
    AllSuccsHaveSame = false;
  else
    NotAllSeqEqualButKnownSafe = true;
  break;
case S_Retain:
  llvm_unreachable("bottom-up pointer in retain state!")::llvm::llvm_unreachable_internal("bottom-up pointer in retain state!"
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1225);
case S_None:
  llvm_unreachable("This should have been handled earlier.")::llvm::llvm_unreachable_internal("This should have been handled earlier."
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1227);
}
1229}

1231/// Check for critical edges, loop boundaries, irreducible control flow, or
1232/// other CFG structures where moving code across the edge would result in it
1233/// being executed more.
1234void
1235ObjCARCOpt::CheckForCFGHazards(const BasicBlock *BB,
                             DenseMap<const BasicBlock *, BBState> &BBStates,
                             BBState &MyStates) const {
// If any top-down local-use or possible-dec has a succ which is earlier in
// the sequence, forget it.
for (auto I = MyStates.top_down_ptr_begin(), E = MyStates.top_down_ptr_end();
     I != E; ++I) {
  TopDownPtrState &S = I->second;
  const Sequence Seq = I->second.GetSeq();

  // We only care about S_Retain, S_CanRelease, and S_Use.
  if (Seq == S_None)
    continue;

  // Make sure that if extra top down states are added in the future that this
  // code is updated to handle it.
  assert((Seq == S_Retain || Seq == S_CanRelease || Seq == S_Use) &&(static_cast <bool> ((Seq == S_Retain || Seq == S_CanRelease
 || Seq == S_Use) && "Unknown top down sequence state."
) ? void (0) : __assert_fail ("(Seq == S_Retain || Seq == S_CanRelease || Seq == S_Use) && \"Unknown top down sequence state.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1252, __extension__
 __PRETTY_FUNCTION__))
         "Unknown top down sequence state.")(static_cast <bool> ((Seq == S_Retain || Seq == S_CanRelease
 || Seq == S_Use) && "Unknown top down sequence state."
) ? void (0) : __assert_fail ("(Seq == S_Retain || Seq == S_CanRelease || Seq == S_Use) && \"Unknown top down sequence state.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1252, __extension__
 __PRETTY_FUNCTION__));

  const Value *Arg = I->first;
  bool SomeSuccHasSame = false;
  bool AllSuccsHaveSame = true;
  bool NotAllSeqEqualButKnownSafe = false;

  for (const BasicBlock *Succ : successors(BB)) {
    // If VisitBottomUp has pointer information for this successor, take
    // what we know about it.
    const DenseMap<const BasicBlock *, BBState>::iterator BBI =
        BBStates.find(Succ);
    assert(BBI != BBStates.end())(static_cast <bool> (BBI != BBStates.end()) ? void (0) :
 __assert_fail ("BBI != BBStates.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1264, __extension__ __PRETTY_FUNCTION__));
    const BottomUpPtrState &SuccS = BBI->second.getPtrBottomUpState(Arg);
    const Sequence SuccSSeq = SuccS.GetSeq();

    // If bottom up, the pointer is in an S_None state, clear the sequence
    // progress since the sequence in the bottom up state finished
    // suggesting a mismatch in between retains/releases. This is true for
    // all three cases that we are handling here: S_Retain, S_Use, and
    // S_CanRelease.
    if (SuccSSeq == S_None) {
      S.ClearSequenceProgress();
      continue;
    }

    // If we have S_Use or S_CanRelease, perform our check for cfg hazard
    // checks.
    const bool SuccSRRIKnownSafe = SuccS.IsKnownSafe();

    // *NOTE* We do not use Seq from above here since we are allowing for
    // S.GetSeq() to change while we are visiting basic blocks.
    switch(S.GetSeq()) {
    case S_Use: {
      bool ShouldContinue = false;
      CheckForUseCFGHazard(SuccSSeq, SuccSRRIKnownSafe, S, SomeSuccHasSame,
                           AllSuccsHaveSame, NotAllSeqEqualButKnownSafe,
                           ShouldContinue);
      if (ShouldContinue)
        continue;
      break;
    }
    case S_CanRelease:
      CheckForCanReleaseCFGHazard(SuccSSeq, SuccSRRIKnownSafe, S,
                                  SomeSuccHasSame, AllSuccsHaveSame,
                                  NotAllSeqEqualButKnownSafe);
      break;
    case S_Retain:
    case S_None:
    case S_Stop:
    case S_MovableRelease:
      break;
    }
  }

  // If the state at the other end of any of the successor edges
  // matches the current state, require all edges to match. This
  // guards against loops in the middle of a sequence.
  if (SomeSuccHasSame && !AllSuccsHaveSame) {
    S.ClearSequenceProgress();
  } else if (NotAllSeqEqualButKnownSafe) {
    // If we would have cleared the state foregoing the fact that we are known
    // safe, stop code motion. This is because whether or not it is safe to
    // remove RR pairs via KnownSafe is an orthogonal concept to whether we
    // are allowed to perform code motion.
    S.SetCFGHazardAfflicted(true);
  }
}
1320}

1322bool ObjCARCOpt::VisitInstructionBottomUp(
  Instruction *Inst, BasicBlock *BB, BlotMapVector<Value *, RRInfo> &Retains,
  BBState &MyStates) {
bool NestingDetected = false;
ARCInstKind Class = GetARCInstKind(Inst);
const Value *Arg = nullptr;

LLVM_DEBUG(dbgs() << "        Class: " << Class << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "        Class: " <<
 Class << "\n"; } } while (false);

switch (Class) {
case ARCInstKind::Release: {
  Arg = GetArgRCIdentityRoot(Inst);

  BottomUpPtrState &S = MyStates.getPtrBottomUpState(Arg);
  NestingDetected |= S.InitBottomUp(MDKindCache, Inst);
  break;
}
case ARCInstKind::RetainBlock:
  // In OptimizeIndividualCalls, we have strength reduced all optimizable
  // objc_retainBlocks to objc_retains. Thus at this point any
  // objc_retainBlocks that we see are not optimizable.
  break;
case ARCInstKind::Retain:
case ARCInstKind::RetainRV: {
  Arg = GetArgRCIdentityRoot(Inst);
  BottomUpPtrState &S = MyStates.getPtrBottomUpState(Arg);
  if (S.MatchWithRetain()) {
    // Don't do retain+release tracking for ARCInstKind::RetainRV, because
    // it's better to let it remain as the first instruction after a call.
    if (Class != ARCInstKind::RetainRV) {
      LLVM_DEBUG(dbgs() << "        Matching with: " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "        Matching with: "
 << *Inst << "\n"; } } while (false);
      Retains[Inst] = S.GetRRInfo();
    }
    S.ClearSequenceProgress();
  }
  // A retain moving bottom up can be a use.
  break;
}
case ARCInstKind::AutoreleasepoolPop:
  // Conservatively, clear MyStates for all known pointers.
  MyStates.clearBottomUpPointers();
  return NestingDetected;
case ARCInstKind::AutoreleasepoolPush:
case ARCInstKind::None:
  // These are irrelevant.
  return NestingDetected;
default:
  break;
}

// Consider any other possible effects of this instruction on each
// pointer being tracked.
for (auto MI = MyStates.bottom_up_ptr_begin(),
          ME = MyStates.bottom_up_ptr_end();
     MI != ME; ++MI) {
  const Value *Ptr = MI->first;
  if (Ptr == Arg)
    continue; // Handled above.
  BottomUpPtrState &S = MI->second;

  if (S.HandlePotentialAlterRefCount(Inst, Ptr, PA, Class))
    continue;

  S.HandlePotentialUse(BB, Inst, Ptr, PA, Class);
}

return NestingDetected;
1389}

1391bool ObjCARCOpt::VisitBottomUp(BasicBlock *BB,
                             DenseMap<const BasicBlock *, BBState> &BBStates,
                             BlotMapVector<Value *, RRInfo> &Retains) {
LLVM_DEBUG(dbgs() << "\n== ObjCARCOpt::VisitBottomUp ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n== ObjCARCOpt::VisitBottomUp ==\n"
; } } while (false);

bool NestingDetected = false;
BBState &MyStates = BBStates[BB];

// Merge the states from each successor to compute the initial state
// for the current block.
BBState::edge_iterator SI(MyStates.succ_begin()),
                       SE(MyStates.succ_end());
if (SI != SE) {
  const BasicBlock *Succ = *SI;
  DenseMap<const BasicBlock *, BBState>::iterator I = BBStates.find(Succ);
  assert(I != BBStates.end())(static_cast <bool> (I != BBStates.end()) ? void (0) : __assert_fail
 ("I != BBStates.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1406, __extension__ __PRETTY_FUNCTION__));
  MyStates.InitFromSucc(I->second);
  ++SI;
  for (; SI != SE; ++SI) {
    Succ = *SI;
    I = BBStates.find(Succ);
    assert(I != BBStates.end())(static_cast <bool> (I != BBStates.end()) ? void (0) : __assert_fail
 ("I != BBStates.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1412, __extension__ __PRETTY_FUNCTION__));
    MyStates.MergeSucc(I->second);
  }
}

LLVM_DEBUG(dbgs() << "Before:\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Before:\n" << BBStates
[BB] << "\n" << "Performing Dataflow:\n"; } } while
 (false)
                  << BBStates[BB] << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Before:\n" << BBStates
[BB] << "\n" << "Performing Dataflow:\n"; } } while
 (false)
                  << "Performing Dataflow:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Before:\n" << BBStates
[BB] << "\n" << "Performing Dataflow:\n"; } } while
 (false);

// Visit all the instructions, bottom-up.
for (BasicBlock::iterator I = BB->end(), E = BB->begin(); I != E; --I) {
  Instruction *Inst = &*std::prev(I);

  // Invoke instructions are visited as part of their successors (below).
  if (isa<InvokeInst>(Inst))
    continue;

  LLVM_DEBUG(dbgs() << "    Visiting " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "    Visiting " <<
 *Inst << "\n"; } } while (false);

  NestingDetected |= VisitInstructionBottomUp(Inst, BB, Retains, MyStates);

  // Bail out if the number of pointers being tracked becomes too large so
  // that this pass can complete in a reasonable amount of time.
  if (MyStates.bottom_up_ptr_list_size() > MaxPtrStates) {
    DisableRetainReleasePairing = true;
    return false;
  }
}

// If there's a predecessor with an invoke, visit the invoke as if it were
// part of this block, since we can't insert code after an invoke in its own
// block, and we don't want to split critical edges.
for (BBState::edge_iterator PI(MyStates.pred_begin()),
     PE(MyStates.pred_end()); PI != PE; ++PI) {
  BasicBlock *Pred = *PI;
  if (InvokeInst *II = dyn_cast<InvokeInst>(&Pred->back()))
    NestingDetected |= VisitInstructionBottomUp(II, BB, Retains, MyStates);
}

LLVM_DEBUG(dbgs() << "\nFinal State:\n" << BBStates[BB] << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\nFinal State:\n" <<
 BBStates[BB] << "\n"; } } while (false);

return NestingDetected;
1454}

1456// Fill ReleaseInsertPtToRCIdentityRoots, which is a map from insertion points
1457// to the set of RC identity roots that would be released by the release calls
1458// moved to the insertion points.
1459static void collectReleaseInsertPts(
  const BlotMapVector<Value *, RRInfo> &Retains,
  DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
      &ReleaseInsertPtToRCIdentityRoots) {
for (const auto &P : Retains) {
  // Retains is a map from an objc_retain call to a RRInfo of the RC identity
  // root of the call. Get the RC identity root of the objc_retain call.
  Instruction *Retain = cast<Instruction>(P.first);
  Value *Root = GetRCIdentityRoot(Retain->getOperand(0));
  // Collect all the insertion points of the objc_release calls that release
  // the RC identity root of the objc_retain call.
  for (const Instruction *InsertPt : P.second.ReverseInsertPts)
    ReleaseInsertPtToRCIdentityRoots[InsertPt].insert(Root);
}
1473}

1475// Get the RC identity roots from an insertion point of an objc_release call.
1476// Return nullptr if the passed instruction isn't an insertion point.
1477static const SmallPtrSet<const Value *, 2> *
1478getRCIdentityRootsFromReleaseInsertPt(
  const Instruction *InsertPt,
  const DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
      &ReleaseInsertPtToRCIdentityRoots) {
auto I = ReleaseInsertPtToRCIdentityRoots.find(InsertPt);
if (I == ReleaseInsertPtToRCIdentityRoots.end())
  return nullptr;
return &I->second;
1486}

1488bool ObjCARCOpt::VisitInstructionTopDown(
  Instruction *Inst, DenseMap<Value *, RRInfo> &Releases, BBState &MyStates,
  const DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
      &ReleaseInsertPtToRCIdentityRoots) {
bool NestingDetected = false;
ARCInstKind Class = GetARCInstKind(Inst);
const Value *Arg = nullptr;

// Make sure a call to objc_retain isn't moved past insertion points of calls
// to objc_release.
if (const SmallPtrSet<const Value *, 2> *Roots =
        getRCIdentityRootsFromReleaseInsertPt(
            Inst, ReleaseInsertPtToRCIdentityRoots))
  for (const auto *Root : *Roots) {
    TopDownPtrState &S = MyStates.getPtrTopDownState(Root);
    // Disable code motion if the current position is S_Retain to prevent
    // moving the objc_retain call past objc_release calls. If it's
    // S_CanRelease or larger, it's not necessary to disable code motion as
    // the insertion points that prevent the objc_retain call from moving down
    // should have been set already.
    if (S.GetSeq() == S_Retain)
      S.SetCFGHazardAfflicted(true);
  }

LLVM_DEBUG(dbgs() << "        Class: " << Class << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "        Class: " <<
 Class << "\n"; } } while (false);

switch (Class) {
case ARCInstKind::RetainBlock:
  // In OptimizeIndividualCalls, we have strength reduced all optimizable
  // objc_retainBlocks to objc_retains. Thus at this point any
  // objc_retainBlocks that we see are not optimizable. We need to break since
  // a retain can be a potential use.
  break;
case ARCInstKind::Retain:
case ARCInstKind::RetainRV: {
  Arg = GetArgRCIdentityRoot(Inst);
  TopDownPtrState &S = MyStates.getPtrTopDownState(Arg);
  NestingDetected |= S.InitTopDown(Class, Inst);
  // A retain can be a potential use; proceed to the generic checking
  // code below.
  break;
}
case ARCInstKind::Release: {
  Arg = GetArgRCIdentityRoot(Inst);
  TopDownPtrState &S = MyStates.getPtrTopDownState(Arg);
  // Try to form a tentative pair in between this release instruction and the
  // top down pointers that we are tracking.
  if (S.MatchWithRelease(MDKindCache, Inst)) {
    // If we succeed, copy S's RRInfo into the Release -> {Retain Set
    // Map}. Then we clear S.
    LLVM_DEBUG(dbgs() << "        Matching with: " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "        Matching with: "
 << *Inst << "\n"; } } while (false);
    Releases[Inst] = S.GetRRInfo();
    S.ClearSequenceProgress();
  }
  break;
}
case ARCInstKind::AutoreleasepoolPop:
  // Conservatively, clear MyStates for all known pointers.
  MyStates.clearTopDownPointers();
  return false;
case ARCInstKind::AutoreleasepoolPush:
case ARCInstKind::None:
  // These can not be uses of
  return false;
default:
  break;
}

// Consider any other possible effects of this instruction on each
// pointer being tracked.
for (auto MI = MyStates.top_down_ptr_begin(),
          ME = MyStates.top_down_ptr_end();
     MI != ME; ++MI) {
  const Value *Ptr = MI->first;
  if (Ptr == Arg)
    continue; // Handled above.
  TopDownPtrState &S = MI->second;
  if (S.HandlePotentialAlterRefCount(Inst, Ptr, PA, Class, *BundledInsts))
    continue;

  S.HandlePotentialUse(Inst, Ptr, PA, Class);
}

return NestingDetected;
1572}

1574bool ObjCARCOpt::VisitTopDown(
  BasicBlock *BB, DenseMap<const BasicBlock *, BBState> &BBStates,
  DenseMap<Value *, RRInfo> &Releases,
  const DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
      &ReleaseInsertPtToRCIdentityRoots) {
LLVM_DEBUG(dbgs() << "\n== ObjCARCOpt::VisitTopDown ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n== ObjCARCOpt::VisitTopDown ==\n"
; } } while (false);
bool NestingDetected = false;
BBState &MyStates = BBStates[BB];

// Merge the states from each predecessor to compute the initial state
// for the current block.
BBState::edge_iterator PI(MyStates.pred_begin()),
                       PE(MyStates.pred_end());
if (PI != PE) {
  const BasicBlock *Pred = *PI;
  DenseMap<const BasicBlock *, BBState>::iterator I = BBStates.find(Pred);
  assert(I != BBStates.end())(static_cast <bool> (I != BBStates.end()) ? void (0) : __assert_fail
 ("I != BBStates.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1590, __extension__ __PRETTY_FUNCTION__));
  MyStates.InitFromPred(I->second);
  ++PI;
  for (; PI != PE; ++PI) {
    Pred = *PI;
    I = BBStates.find(Pred);
    assert(I != BBStates.end())(static_cast <bool> (I != BBStates.end()) ? void (0) : __assert_fail
 ("I != BBStates.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1596, __extension__ __PRETTY_FUNCTION__));
    MyStates.MergePred(I->second);
  }
}

// Check that BB and MyStates have the same number of predecessors. This
// prevents retain calls that live outside a loop from being moved into the
// loop.
if (!BB->hasNPredecessors(MyStates.pred_end() - MyStates.pred_begin()))
  for (auto I = MyStates.top_down_ptr_begin(),
            E = MyStates.top_down_ptr_end();
       I != E; ++I)
    I->second.SetCFGHazardAfflicted(true);

LLVM_DEBUG(dbgs() << "Before:\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Before:\n" << BBStates
[BB] << "\n" << "Performing Dataflow:\n"; } } while
 (false)
                  << BBStates[BB] << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Before:\n" << BBStates
[BB] << "\n" << "Performing Dataflow:\n"; } } while
 (false)
                  << "Performing Dataflow:\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Before:\n" << BBStates
[BB] << "\n" << "Performing Dataflow:\n"; } } while
 (false);

// Visit all the instructions, top-down.
for (Instruction &Inst : *BB) {
  LLVM_DEBUG(dbgs() << "    Visiting " << Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "    Visiting " <<
 Inst << "\n"; } } while (false);

  NestingDetected |= VisitInstructionTopDown(
      &Inst, Releases, MyStates, ReleaseInsertPtToRCIdentityRoots);

  // Bail out if the number of pointers being tracked becomes too large so
  // that this pass can complete in a reasonable amount of time.
  if (MyStates.top_down_ptr_list_size() > MaxPtrStates) {
    DisableRetainReleasePairing = true;
    return false;
  }
}

LLVM_DEBUG(dbgs() << "\nState Before Checking for CFG Hazards:\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\nState Before Checking for CFG Hazards:\n"
 << BBStates[BB] << "\n\n"; } } while (false)
                  << BBStates[BB] << "\n\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\nState Before Checking for CFG Hazards:\n"
 << BBStates[BB] << "\n\n"; } } while (false);
CheckForCFGHazards(BB, BBStates, MyStates);
LLVM_DEBUG(dbgs() << "Final State:\n" << BBStates[BB] << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Final State:\n" <<
 BBStates[BB] << "\n"; } } while (false);
return NestingDetected;
1634}

1636static void
1637ComputePostOrders(Function &F,
                SmallVectorImpl<BasicBlock *> &PostOrder,
                SmallVectorImpl<BasicBlock *> &ReverseCFGPostOrder,
                unsigned NoObjCARCExceptionsMDKind,
                DenseMap<const BasicBlock *, BBState> &BBStates) {
/// The visited set, for doing DFS walks.
SmallPtrSet<BasicBlock *, 16> Visited;

// Do DFS, computing the PostOrder.
SmallPtrSet<BasicBlock *, 16> OnStack;
SmallVector<std::pair<BasicBlock *, succ_iterator>, 16> SuccStack;

// Functions always have exactly one entry block, and we don't have
// any other block that we treat like an entry block.
BasicBlock *EntryBB = &F.getEntryBlock();
BBState &MyStates = BBStates[EntryBB];
MyStates.SetAsEntry();
Instruction *EntryTI = EntryBB->getTerminator();
SuccStack.push_back(std::make_pair(EntryBB, succ_iterator(EntryTI)));
Visited.insert(EntryBB);
OnStack.insert(EntryBB);
do {
dfs_next_succ:
  BasicBlock *CurrBB = SuccStack.back().first;
  succ_iterator SE(CurrBB->getTerminator(), false);

  while (SuccStack.back().second != SE) {
    BasicBlock *SuccBB = *SuccStack.back().second++;
    if (Visited.insert(SuccBB).second) {
      SuccStack.push_back(
          std::make_pair(SuccBB, succ_iterator(SuccBB->getTerminator())));
      BBStates[CurrBB].addSucc(SuccBB);
      BBState &SuccStates = BBStates[SuccBB];
      SuccStates.addPred(CurrBB);
      OnStack.insert(SuccBB);
      goto dfs_next_succ;
    }

    if (!OnStack.count(SuccBB)) {
      BBStates[CurrBB].addSucc(SuccBB);
      BBStates[SuccBB].addPred(CurrBB);
    }
  }
  OnStack.erase(CurrBB);
  PostOrder.push_back(CurrBB);
  SuccStack.pop_back();
} while (!SuccStack.empty());

Visited.clear();

// Do reverse-CFG DFS, computing the reverse-CFG PostOrder.
// Functions may have many exits, and there also blocks which we treat
// as exits due to ignored edges.
SmallVector<std::pair<BasicBlock *, BBState::edge_iterator>, 16> PredStack;
for (BasicBlock &ExitBB : F) {
  BBState &MyStates = BBStates[&ExitBB];
  if (!MyStates.isExit())
    continue;

  MyStates.SetAsExit();

  PredStack.push_back(std::make_pair(&ExitBB, MyStates.pred_begin()));
  Visited.insert(&ExitBB);
  while (!PredStack.empty()) {
  reverse_dfs_next_succ:
    BBState::edge_iterator PE = BBStates[PredStack.back().first].pred_end();
    while (PredStack.back().second != PE) {
      BasicBlock *BB = *PredStack.back().second++;
      if (Visited.insert(BB).second) {
        PredStack.push_back(std::make_pair(BB, BBStates[BB].pred_begin()));
        goto reverse_dfs_next_succ;
      }
    }
    ReverseCFGPostOrder.push_back(PredStack.pop_back_val().first);
  }
}
1713}

1715// Visit the function both top-down and bottom-up.
1716bool ObjCARCOpt::Visit(Function &F,
                     DenseMap<const BasicBlock *, BBState> &BBStates,
                     BlotMapVector<Value *, RRInfo> &Retains,
                     DenseMap<Value *, RRInfo> &Releases) {
// Use reverse-postorder traversals, because we magically know that loops
// will be well behaved, i.e. they won't repeatedly call retain on a single
// pointer without doing a release. We can't use the ReversePostOrderTraversal
// class here because we want the reverse-CFG postorder to consider each
// function exit point, and we want to ignore selected cycle edges.
SmallVector<BasicBlock *, 16> PostOrder;
SmallVector<BasicBlock *, 16> ReverseCFGPostOrder;
ComputePostOrders(F, PostOrder, ReverseCFGPostOrder,
                  MDKindCache.get(ARCMDKindID::NoObjCARCExceptions),
                  BBStates);

// Use reverse-postorder on the reverse CFG for bottom-up.
bool BottomUpNestingDetected = false;
for (BasicBlock *BB : llvm::reverse(ReverseCFGPostOrder)) {
  BottomUpNestingDetected |= VisitBottomUp(BB, BBStates, Retains);
  if (DisableRetainReleasePairing)
    return false;
}

DenseMap<const Instruction *, SmallPtrSet<const Value *, 2>>
    ReleaseInsertPtToRCIdentityRoots;
collectReleaseInsertPts(Retains, ReleaseInsertPtToRCIdentityRoots);

// Use reverse-postorder for top-down.
bool TopDownNestingDetected = false;
for (BasicBlock *BB : llvm::reverse(PostOrder)) {
  TopDownNestingDetected |=
      VisitTopDown(BB, BBStates, Releases, ReleaseInsertPtToRCIdentityRoots);
  if (DisableRetainReleasePairing)
    return false;
}

return TopDownNestingDetected && BottomUpNestingDetected;
1753}

1755/// Move the calls in RetainsToMove and ReleasesToMove.
1756void ObjCARCOpt::MoveCalls(Value *Arg, RRInfo &RetainsToMove,
                         RRInfo &ReleasesToMove,
                         BlotMapVector<Value *, RRInfo> &Retains,
                         DenseMap<Value *, RRInfo> &Releases,
                         SmallVectorImpl<Instruction *> &DeadInsts,
                         Module *M) {
Type *ArgTy = Arg->getType();
Type *ParamTy = PointerType::getUnqual(Type::getInt8Ty(ArgTy->getContext()));

LLVM_DEBUG(dbgs() << "== ObjCARCOpt::MoveCalls ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "== ObjCARCOpt::MoveCalls ==\n"
; } } while (false);

// Insert the new retain and release calls.
for (Instruction *InsertPt : ReleasesToMove.ReverseInsertPts) {
  Value *MyArg = ArgTy == ParamTy ? Arg :
                 new BitCastInst(Arg, ParamTy, "", InsertPt);
  Function *Decl = EP.get(ARCRuntimeEntryPointKind::Retain);
  SmallVector<OperandBundleDef, 1> BundleList;
  addOpBundleForFunclet(InsertPt->getParent(), BundleList);
  CallInst *Call = CallInst::Create(Decl, MyArg, BundleList, "", InsertPt);
  Call->setDoesNotThrow();
  Call->setTailCall();

  LLVM_DEBUG(dbgs() << "Inserting new Retain: " << *Calldo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Retain: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false)
                    << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Retain: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false)
                       "At insertion point: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Retain: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false)
                    << *InsertPt << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Retain: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false);
}
for (Instruction *InsertPt : RetainsToMove.ReverseInsertPts) {
  Value *MyArg = ArgTy == ParamTy ? Arg :
                 new BitCastInst(Arg, ParamTy, "", InsertPt);
  Function *Decl = EP.get(ARCRuntimeEntryPointKind::Release);
  SmallVector<OperandBundleDef, 1> BundleList;
  addOpBundleForFunclet(InsertPt->getParent(), BundleList);
  CallInst *Call = CallInst::Create(Decl, MyArg, BundleList, "", InsertPt);
  // Attach a clang.imprecise_release metadata tag, if appropriate.
  if (MDNode *M = ReleasesToMove.ReleaseMetadata)
    Call->setMetadata(MDKindCache.get(ARCMDKindID::ImpreciseRelease), M);
  Call->setDoesNotThrow();
  if (ReleasesToMove.IsTailCallRelease)
    Call->setTailCall();

  LLVM_DEBUG(dbgs() << "Inserting new Release: " << *Calldo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Release: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false)
                    << "\n"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Release: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false)
                       "At insertion point: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Release: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false)
                    << *InsertPt << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Inserting new Release: "
 << *Call << "\n" "At insertion point: " <<
 *InsertPt << "\n"; } } while (false);
}

// Delete the original retain and release calls.
for (Instruction *OrigRetain : RetainsToMove.Calls) {
  Retains.blot(OrigRetain);
  DeadInsts.push_back(OrigRetain);
  LLVM_DEBUG(dbgs() << "Deleting retain: " << *OrigRetain << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Deleting retain: " <<
 *OrigRetain << "\n"; } } while (false);
}
for (Instruction *OrigRelease : ReleasesToMove.Calls) {
  Releases.erase(OrigRelease);
  DeadInsts.push_back(OrigRelease);
  LLVM_DEBUG(dbgs() << "Deleting release: " << *OrigRelease << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Deleting release: " <<
 *OrigRelease << "\n"; } } while (false);
}
1814}

1816bool ObjCARCOpt::PairUpRetainsAndReleases(
  DenseMap<const BasicBlock *, BBState> &BBStates,
  BlotMapVector<Value *, RRInfo> &Retains,
  DenseMap<Value *, RRInfo> &Releases, Module *M,
  Instruction *Retain,
  SmallVectorImpl<Instruction *> &DeadInsts, RRInfo &RetainsToMove,
  RRInfo &ReleasesToMove, Value *Arg, bool KnownSafe,
  bool &AnyPairsCompletelyEliminated) {
// If a pair happens in a region where it is known that the reference count
// is already incremented, we can similarly ignore possible decrements unless
// we are dealing with a retainable object with multiple provenance sources.
bool KnownSafeTD = true, KnownSafeBU = true;
bool CFGHazardAfflicted = false;

// Connect the dots between the top-down-collected RetainsToMove and
// bottom-up-collected ReleasesToMove to form sets of related calls.
// This is an iterative process so that we connect multiple releases
// to multiple retains if needed.
unsigned OldDelta = 0;
unsigned NewDelta = 0;
unsigned OldCount = 0;
unsigned NewCount = 0;
bool FirstRelease = true;
for (SmallVector<Instruction *, 4> NewRetains{Retain};;) {
  SmallVector<Instruction *, 4> NewReleases;
  for (Instruction *NewRetain : NewRetains) {
    auto It = Retains.find(NewRetain);
    assert(It != Retains.end())(static_cast <bool> (It != Retains.end()) ? void (0) : __assert_fail
 ("It != Retains.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1843, __extension__ __PRETTY_FUNCTION__));
    const RRInfo &NewRetainRRI = It->second;
    KnownSafeTD &= NewRetainRRI.KnownSafe;
    CFGHazardAfflicted |= NewRetainRRI.CFGHazardAfflicted;
    for (Instruction *NewRetainRelease : NewRetainRRI.Calls) {
      auto Jt = Releases.find(NewRetainRelease);
      if (Jt == Releases.end())
        return false;
      const RRInfo &NewRetainReleaseRRI = Jt->second;

      // If the release does not have a reference to the retain as well,
      // something happened which is unaccounted for. Do not do anything.
      //
      // This can happen if we catch an additive overflow during path count
      // merging.
      if (!NewRetainReleaseRRI.Calls.count(NewRetain))
        return false;

      if (ReleasesToMove.Calls.insert(NewRetainRelease).second) {
        // If we overflow when we compute the path count, don't remove/move
        // anything.
        const BBState &NRRBBState = BBStates[NewRetainRelease->getParent()];
        unsigned PathCount = BBState::OverflowOccurredValue;
        if (NRRBBState.GetAllPathCountWithOverflow(PathCount))
          return false;
        assert(PathCount != BBState::OverflowOccurredValue &&(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1870, __extension__
 __PRETTY_FUNCTION__))
               "PathCount at this point can not be "(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1870, __extension__
 __PRETTY_FUNCTION__))
               "OverflowOccurredValue.")(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1870, __extension__
 __PRETTY_FUNCTION__));
        OldDelta -= PathCount;

        // Merge the ReleaseMetadata and IsTailCallRelease values.
        if (FirstRelease) {
          ReleasesToMove.ReleaseMetadata =
            NewRetainReleaseRRI.ReleaseMetadata;
          ReleasesToMove.IsTailCallRelease =
            NewRetainReleaseRRI.IsTailCallRelease;
          FirstRelease = false;
        } else {
          if (ReleasesToMove.ReleaseMetadata !=
              NewRetainReleaseRRI.ReleaseMetadata)
            ReleasesToMove.ReleaseMetadata = nullptr;
          if (ReleasesToMove.IsTailCallRelease !=
              NewRetainReleaseRRI.IsTailCallRelease)
            ReleasesToMove.IsTailCallRelease = false;
        }

        // Collect the optimal insertion points.
        if (!KnownSafe)
          for (Instruction *RIP : NewRetainReleaseRRI.ReverseInsertPts) {
            if (ReleasesToMove.ReverseInsertPts.insert(RIP).second) {
              // If we overflow when we compute the path count, don't
              // remove/move anything.
              const BBState &RIPBBState = BBStates[RIP->getParent()];
              PathCount = BBState::OverflowOccurredValue;
              if (RIPBBState.GetAllPathCountWithOverflow(PathCount))
                return false;
              assert(PathCount != BBState::OverflowOccurredValue &&(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1901, __extension__
 __PRETTY_FUNCTION__))
                     "PathCount at this point can not be "(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1901, __extension__
 __PRETTY_FUNCTION__))
                     "OverflowOccurredValue.")(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1901, __extension__
 __PRETTY_FUNCTION__));
              NewDelta -= PathCount;
            }
          }
        NewReleases.push_back(NewRetainRelease);
      }
    }
  }
  NewRetains.clear();
  if (NewReleases.empty()) break;

  // Back the other way.
  for (Instruction *NewRelease : NewReleases) {
    auto It = Releases.find(NewRelease);
    assert(It != Releases.end())(static_cast <bool> (It != Releases.end()) ? void (0) :
 __assert_fail ("It != Releases.end()", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 1915, __extension__ __PRETTY_FUNCTION__));
    const RRInfo &NewReleaseRRI = It->second;
    KnownSafeBU &= NewReleaseRRI.KnownSafe;
    CFGHazardAfflicted |= NewReleaseRRI.CFGHazardAfflicted;
    for (Instruction *NewReleaseRetain : NewReleaseRRI.Calls) {
      auto Jt = Retains.find(NewReleaseRetain);
      if (Jt == Retains.end())
        return false;
      const RRInfo &NewReleaseRetainRRI = Jt->second;

      // If the retain does not have a reference to the release as well,
      // something happened which is unaccounted for. Do not do anything.
      //
      // This can happen if we catch an additive overflow during path count
      // merging.
      if (!NewReleaseRetainRRI.Calls.count(NewRelease))
        return false;

      if (RetainsToMove.Calls.insert(NewReleaseRetain).second) {
        // If we overflow when we compute the path count, don't remove/move
        // anything.
        const BBState &NRRBBState = BBStates[NewReleaseRetain->getParent()];
        unsigned PathCount = BBState::OverflowOccurredValue;
        if (NRRBBState.GetAllPathCountWithOverflow(PathCount))
          return false;
        assert(PathCount != BBState::OverflowOccurredValue &&(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1942, __extension__
 __PRETTY_FUNCTION__))
               "PathCount at this point can not be "(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1942, __extension__
 __PRETTY_FUNCTION__))
               "OverflowOccurredValue.")(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1942, __extension__
 __PRETTY_FUNCTION__));
        OldDelta += PathCount;
        OldCount += PathCount;

        // Collect the optimal insertion points.
        if (!KnownSafe)
          for (Instruction *RIP : NewReleaseRetainRRI.ReverseInsertPts) {
            if (RetainsToMove.ReverseInsertPts.insert(RIP).second) {
              // If we overflow when we compute the path count, don't
              // remove/move anything.
              const BBState &RIPBBState = BBStates[RIP->getParent()];

              PathCount = BBState::OverflowOccurredValue;
              if (RIPBBState.GetAllPathCountWithOverflow(PathCount))
                return false;
              assert(PathCount != BBState::OverflowOccurredValue &&(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1959, __extension__
 __PRETTY_FUNCTION__))
                     "PathCount at this point can not be "(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1959, __extension__
 __PRETTY_FUNCTION__))
                     "OverflowOccurredValue.")(static_cast <bool> (PathCount != BBState::OverflowOccurredValue
 && "PathCount at this point can not be " "OverflowOccurredValue."
) ? void (0) : __assert_fail ("PathCount != BBState::OverflowOccurredValue && \"PathCount at this point can not be \" \"OverflowOccurredValue.\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 1959, __extension__
 __PRETTY_FUNCTION__));
              NewDelta += PathCount;
              NewCount += PathCount;
            }
          }
        NewRetains.push_back(NewReleaseRetain);
      }
    }
  }
  if (NewRetains.empty()) break;
}

// We can only remove pointers if we are known safe in both directions.
bool UnconditionallySafe = KnownSafeTD && KnownSafeBU;
if (UnconditionallySafe) {
  RetainsToMove.ReverseInsertPts.clear();
  ReleasesToMove.ReverseInsertPts.clear();
  NewCount = 0;
} else {
  // Determine whether the new insertion points we computed preserve the
  // balance of retain and release calls through the program.
  // TODO: If the fully aggressive solution isn't valid, try to find a
  // less aggressive solution which is.
  if (NewDelta != 0)
    return false;

  // At this point, we are not going to remove any RR pairs, but we still are
  // able to move RR pairs. If one of our pointers is afflicted with
  // CFGHazards, we cannot perform such code motion so exit early.
  const bool WillPerformCodeMotion =
      !RetainsToMove.ReverseInsertPts.empty() ||
      !ReleasesToMove.ReverseInsertPts.empty();
  if (CFGHazardAfflicted && WillPerformCodeMotion)
    return false;
}

// Determine whether the original call points are balanced in the retain and
// release calls through the program. If not, conservatively don't touch
// them.
// TODO: It's theoretically possible to do code motion in this case, as
// long as the existing imbalances are maintained.
if (OldDelta != 0)
  return false;

Changed = true;
assert(OldCount != 0 && "Unreachable code?")(static_cast <bool> (OldCount != 0 && "Unreachable code?"
) ? void (0) : __assert_fail ("OldCount != 0 && \"Unreachable code?\""
, "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp", 2004, __extension__
 __PRETTY_FUNCTION__));
NumRRs += OldCount - NewCount;
// Set to true if we completely removed any RR pairs.
AnyPairsCompletelyEliminated = NewCount == 0;

// We can move calls!
return true;
2011}

2013/// Identify pairings between the retains and releases, and delete and/or move
2014/// them.
2015bool ObjCARCOpt::PerformCodePlacement(
  DenseMap<const BasicBlock *, BBState> &BBStates,
  BlotMapVector<Value *, RRInfo> &Retains,
  DenseMap<Value *, RRInfo> &Releases, Module *M) {
LLVM_DEBUG(dbgs() << "\n== ObjCARCOpt::PerformCodePlacement ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n== ObjCARCOpt::PerformCodePlacement ==\n"
; } } while (false);

bool AnyPairsCompletelyEliminated = false;
SmallVector<Instruction *, 8> DeadInsts;

// Visit each retain.
for (BlotMapVector<Value *, RRInfo>::const_iterator I = Retains.begin(),
                                                    E = Retains.end();
     I != E; ++I) {
  Value *V = I->first;
  if (!V) continue; // blotted

  Instruction *Retain = cast<Instruction>(V);

  LLVM_DEBUG(dbgs() << "Visiting: " << *Retain << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Visiting: " << *Retain
 << "\n"; } } while (false);

  Value *Arg = GetArgRCIdentityRoot(Retain);

  // If the object being released is in static or stack storage, we know it's
  // not being managed by ObjC reference counting, so we can delete pairs
  // regardless of what possible decrements or uses lie between them.
  bool KnownSafe = isa<Constant>(Arg) || isa<AllocaInst>(Arg);

  // A constant pointer can't be pointing to an object on the heap. It may
  // be reference-counted, but it won't be deleted.
  if (const LoadInst *LI = dyn_cast<LoadInst>(Arg))
    if (const GlobalVariable *GV =
          dyn_cast<GlobalVariable>(
            GetRCIdentityRoot(LI->getPointerOperand())))
      if (GV->isConstant())
        KnownSafe = true;

  // Connect the dots between the top-down-collected RetainsToMove and
  // bottom-up-collected ReleasesToMove to form sets of related calls.
  RRInfo RetainsToMove, ReleasesToMove;

  bool PerformMoveCalls = PairUpRetainsAndReleases(
      BBStates, Retains, Releases, M, Retain, DeadInsts,
      RetainsToMove, ReleasesToMove, Arg, KnownSafe,
      AnyPairsCompletelyEliminated);

  if (PerformMoveCalls) {
    // Ok, everything checks out and we're all set. Let's move/delete some
    // code!
    MoveCalls(Arg, RetainsToMove, ReleasesToMove,
              Retains, Releases, DeadInsts, M);
  }
}

// Now that we're done moving everything, we can delete the newly dead
// instructions, as we no longer need them as insert points.
while (!DeadInsts.empty())
  EraseInstruction(DeadInsts.pop_back_val());

return AnyPairsCompletelyEliminated;
2074}

2076/// Weak pointer optimizations.
2077void ObjCARCOpt::OptimizeWeakCalls(Function &F) {
LLVM_DEBUG(dbgs() << "\n== ObjCARCOpt::OptimizeWeakCalls ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n== ObjCARCOpt::OptimizeWeakCalls ==\n"
; } } while (false);

// First, do memdep-style RLE and S2L optimizations. We can't use memdep
// itself because it uses AliasAnalysis and we need to do provenance
// queries instead.
for (inst_iterator I = inst_begin(&F), E = inst_end(&F); I != E; ) {
  Instruction *Inst = &*I++;

  LLVM_DEBUG(dbgs() << "Visiting: " << *Inst << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Visiting: " << *Inst
 << "\n"; } } while (false);

  ARCInstKind Class = GetBasicARCInstKind(Inst);
  if (Class != ARCInstKind::LoadWeak &&
      Class != ARCInstKind::LoadWeakRetained)
    continue;

  // Delete objc_loadWeak calls with no users.
  if (Class == ARCInstKind::LoadWeak && Inst->use_empty()) {
    Inst->eraseFromParent();
    Changed = true;
    continue;
  }

  // TODO: For now, just look for an earlier available version of this value
  // within the same block. Theoretically, we could do memdep-style non-local
  // analysis too, but that would want caching. A better approach would be to
  // use the technique that EarlyCSE uses.
  inst_iterator Current = std::prev(I);
  BasicBlock *CurrentBB = &*Current.getBasicBlockIterator();
  for (BasicBlock::iterator B = CurrentBB->begin(),
                            J = Current.getInstructionIterator();
       J != B; --J) {
    Instruction *EarlierInst = &*std::prev(J);
    ARCInstKind EarlierClass = GetARCInstKind(EarlierInst);
    switch (EarlierClass) {
    case ARCInstKind::LoadWeak:
    case ARCInstKind::LoadWeakRetained: {
      // If this is loading from the same pointer, replace this load's value
      // with that one.
      CallInst *Call = cast<CallInst>(Inst);
      CallInst *EarlierCall = cast<CallInst>(EarlierInst);
      Value *Arg = Call->getArgOperand(0);
      Value *EarlierArg = EarlierCall->getArgOperand(0);
      switch (PA.getAA()->alias(Arg, EarlierArg)) {
      case AliasResult::MustAlias:
        Changed = true;
        // If the load has a builtin retain, insert a plain retain for it.
        if (Class == ARCInstKind::LoadWeakRetained) {
          Function *Decl = EP.get(ARCRuntimeEntryPointKind::Retain);
          CallInst *CI = CallInst::Create(Decl, EarlierCall, "", Call);
          CI->setTailCall();
        }
        // Zap the fully redundant load.
        Call->replaceAllUsesWith(EarlierCall);
        Call->eraseFromParent();
        goto clobbered;
      case AliasResult::MayAlias:
      case AliasResult::PartialAlias:
        goto clobbered;
      case AliasResult::NoAlias:
        break;
      }
      break;
    }
    case ARCInstKind::StoreWeak:
    case ARCInstKind::InitWeak: {
      // If this is storing to the same pointer and has the same size etc.
      // replace this load's value with the stored value.
      CallInst *Call = cast<CallInst>(Inst);
      CallInst *EarlierCall = cast<CallInst>(EarlierInst);
      Value *Arg = Call->getArgOperand(0);
      Value *EarlierArg = EarlierCall->getArgOperand(0);
      switch (PA.getAA()->alias(Arg, EarlierArg)) {
      case AliasResult::MustAlias:
        Changed = true;
        // If the load has a builtin retain, insert a plain retain for it.
        if (Class == ARCInstKind::LoadWeakRetained) {
          Function *Decl = EP.get(ARCRuntimeEntryPointKind::Retain);
          CallInst *CI = CallInst::Create(Decl, EarlierCall, "", Call);
          CI->setTailCall();
        }
        // Zap the fully redundant load.
        Call->replaceAllUsesWith(EarlierCall->getArgOperand(1));
        Call->eraseFromParent();
        goto clobbered;
      case AliasResult::MayAlias:
      case AliasResult::PartialAlias:
        goto clobbered;
      case AliasResult::NoAlias:
        break;
      }
      break;
    }
    case ARCInstKind::MoveWeak:
    case ARCInstKind::CopyWeak:
      // TOOD: Grab the copied value.
      goto clobbered;
    case ARCInstKind::AutoreleasepoolPush:
    case ARCInstKind::None:
    case ARCInstKind::IntrinsicUser:
    case ARCInstKind::User:
      // Weak pointers are only modified through the weak entry points
      // (and arbitrary calls, which could call the weak entry points).
      break;
    default:
      // Anything else could modify the weak pointer.
      goto clobbered;
    }
  }
clobbered:;
}

// Then, for each destroyWeak with an alloca operand, check to see if
// the alloca and all its users can be zapped.
for (Instruction &Inst : llvm::make_early_inc_range(instructions(F))) {
  ARCInstKind Class = GetBasicARCInstKind(&Inst);
  if (Class != ARCInstKind::DestroyWeak)
    continue;

  CallInst *Call = cast<CallInst>(&Inst);
  Value *Arg = Call->getArgOperand(0);
  if (AllocaInst *Alloca = dyn_cast<AllocaInst>(Arg)) {
    for (User *U : Alloca->users()) {
      const Instruction *UserInst = cast<Instruction>(U);
      switch (GetBasicARCInstKind(UserInst)) {
      case ARCInstKind::InitWeak:
      case ARCInstKind::StoreWeak:
      case ARCInstKind::DestroyWeak:
        continue;
      default:
        goto done;
      }
    }
    Changed = true;
    for (User *U : llvm::make_early_inc_range(Alloca->users())) {
      CallInst *UserInst = cast<CallInst>(U);
      switch (GetBasicARCInstKind(UserInst)) {
      case ARCInstKind::InitWeak:
      case ARCInstKind::StoreWeak:
        // These functions return their second argument.
        UserInst->replaceAllUsesWith(UserInst->getArgOperand(1));
        break;
      case ARCInstKind::DestroyWeak:
        // No return value.
        break;
      default:
        llvm_unreachable("alloca really is used!")::llvm::llvm_unreachable_internal("alloca really is used!", "llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp"
, 2223);
      }
      UserInst->eraseFromParent();
    }
    Alloca->eraseFromParent();
  done:;
  }
}
2231}

2233/// Identify program paths which execute sequences of retains and releases which
2234/// can be eliminated.
2235bool ObjCARCOpt::OptimizeSequences(Function &F) {
// Releases, Retains - These are used to store the results of the main flow
// analysis. These use Value* as the key instead of Instruction* so that the
// map stays valid when we get around to rewriting code and calls get
// replaced by arguments.
DenseMap<Value *, RRInfo> Releases;
BlotMapVector<Value *, RRInfo> Retains;

// This is used during the traversal of the function to track the
// states for each identified object at each block.
DenseMap<const BasicBlock *, BBState> BBStates;

// Analyze the CFG of the function, and all instructions.
bool NestingDetected = Visit(F, BBStates, Retains, Releases);

if (DisableRetainReleasePairing)
  return false;

// Transform.
bool AnyPairsCompletelyEliminated = PerformCodePlacement(BBStates, Retains,
                                                         Releases,
                                                         F.getParent());

return AnyPairsCompletelyEliminated && NestingDetected;
2259}

2261/// Check if there is a dependent call earlier that does not have anything in
2262/// between the Retain and the call that can affect the reference count of their
2263/// shared pointer argument. Note that Retain need not be in BB.
2264static CallInst *HasSafePathToPredecessorCall(const Value *Arg,
                                            Instruction *Retain,
                                            ProvenanceAnalysis &PA) {
auto *Call = dyn_cast_or_null<CallInst>(findSingleDependency(
    CanChangeRetainCount, Arg, Retain->getParent(), Retain, PA));

// Check that the pointer is the return value of the call.
if (!Call || Arg != Call)
  return nullptr;

// Check that the call is a regular call.
ARCInstKind Class = GetBasicARCInstKind(Call);
return Class == ARCInstKind::CallOrUser || Class == ARCInstKind::Call
           ? Call
           : nullptr;
2279}

2281/// Find a dependent retain that precedes the given autorelease for which there
2282/// is nothing in between the two instructions that can affect the ref count of
2283/// Arg.
2284static CallInst *
2285FindPredecessorRetainWithSafePath(const Value *Arg, BasicBlock *BB,
                                Instruction *Autorelease,
                                ProvenanceAnalysis &PA) {
auto *Retain = dyn_cast_or_null<CallInst>(
    findSingleDependency(CanChangeRetainCount, Arg, BB, Autorelease, PA));

// Check that we found a retain with the same argument.
if (!Retain || !IsRetain(GetBasicARCInstKind(Retain)) ||
    GetArgRCIdentityRoot(Retain) != Arg) {
  return nullptr;
}

return Retain;
2298}

2300/// Look for an ``autorelease'' instruction dependent on Arg such that there are
2301/// no instructions dependent on Arg that need a positive ref count in between
2302/// the autorelease and the ret.
2303static CallInst *
2304FindPredecessorAutoreleaseWithSafePath(const Value *Arg, BasicBlock *BB,
                                     ReturnInst *Ret,
                                     ProvenanceAnalysis &PA) {
SmallPtrSet<Instruction *, 4> DepInsts;
auto *Autorelease = dyn_cast_or_null<CallInst>(
    findSingleDependency(NeedsPositiveRetainCount, Arg, BB, Ret, PA));

if (!Autorelease)
  return nullptr;
ARCInstKind AutoreleaseClass = GetBasicARCInstKind(Autorelease);
if (!IsAutorelease(AutoreleaseClass))
  return nullptr;
if (GetArgRCIdentityRoot(Autorelease) != Arg)
  return nullptr;

return Autorelease;
2320}

2322/// Look for this pattern:
2323/// \code
2324///    %call = call i8* @something(...)
2325///    %2 = call i8* @objc_retain(i8* %call)
2326///    %3 = call i8* @objc_autorelease(i8* %2)
2327///    ret i8* %3
2328/// \endcode
2329/// And delete the retain and autorelease.
2330void ObjCARCOpt::OptimizeReturns(Function &F) {
if (!F.getReturnType()->isPointerTy())
  return;

LLVM_DEBUG(dbgs() << "\n== ObjCARCOpt::OptimizeReturns ==\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n== ObjCARCOpt::OptimizeReturns ==\n"
; } } while (false);

for (BasicBlock &BB: F) {
  ReturnInst *Ret = dyn_cast<ReturnInst>(&BB.back());
  if (!Ret)
    continue;

  LLVM_DEBUG(dbgs() << "Visiting: " << *Ret << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Visiting: " << *Ret
 << "\n"; } } while (false);

  const Value *Arg = GetRCIdentityRoot(Ret->getOperand(0));

  // Look for an ``autorelease'' instruction that is a predecessor of Ret and
  // dependent on Arg such that there are no instructions dependent on Arg
  // that need a positive ref count in between the autorelease and Ret.
  CallInst *Autorelease =
      FindPredecessorAutoreleaseWithSafePath(Arg, &BB, Ret, PA);

  if (!Autorelease)
    continue;

  CallInst *Retain = FindPredecessorRetainWithSafePath(
      Arg, Autorelease->getParent(), Autorelease, PA);

  if (!Retain)
    continue;

  // Check that there is nothing that can affect the reference count
  // between the retain and the call.  Note that Retain need not be in BB.
  CallInst *Call = HasSafePathToPredecessorCall(Arg, Retain, PA);

  // Don't remove retainRV/autoreleaseRV pairs if the call isn't a tail call.
  if (!Call ||
      (!Call->isTailCall() &&
       GetBasicARCInstKind(Retain) == ARCInstKind::RetainRV &&
       GetBasicARCInstKind(Autorelease) == ARCInstKind::AutoreleaseRV))
    continue;

  // If so, we can zap the retain and autorelease.
  Changed = true;
  ++NumRets;
  LLVM_DEBUG(dbgs() << "Erasing: " << *Retain << "\nErasing: " << *Autoreleasedo { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Erasing: " << *Retain
 << "\nErasing: " << *Autorelease << "\n"; }
 } while (false)
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "Erasing: " << *Retain
 << "\nErasing: " << *Autorelease << "\n"; }
 } while (false);
  BundledInsts->eraseInst(Retain);
  EraseInstruction(Autorelease);
}
2379}

2381#ifndef NDEBUG
2382void
2383ObjCARCOpt::GatherStatistics(Function &F, bool AfterOptimization) {
Statistic &NumRetains =
    AfterOptimization ? NumRetainsAfterOpt : NumRetainsBeforeOpt;
Statistic &NumReleases =
    AfterOptimization ? NumReleasesAfterOpt : NumReleasesBeforeOpt;

for (inst_iterator I = inst_begin(&F), E = inst_end(&F); I != E; ) {
  Instruction *Inst = &*I++;
  switch (GetBasicARCInstKind(Inst)) {
  default:
    break;
  case ARCInstKind::Retain:
    ++NumRetains;
    break;
  case ARCInstKind::Release:
    ++NumReleases;
    break;
  }
}
2402}
2403#endif

2405void ObjCARCOpt::init(Function &F) {
if (!EnableARCOpts)
  return;

// Intuitively, objc_retain and others are nocapture, however in practice
// they are not, because they return their argument value. And objc_release
// calls finalizers which can have arbitrary side effects.
MDKindCache.init(F.getParent());

// Initialize our runtime entry point cache.
EP.init(F.getParent());

// Compute which blocks are in which funclet.
if (F.hasPersonalityFn() &&
    isScopedEHPersonality(classifyEHPersonality(F.getPersonalityFn())))
  BlockEHColors = colorEHFunclets(F);
2421}

2423bool ObjCARCOpt::run(Function &F, AAResults &AA) {
if (!EnableARCOpts)
2
←
Assuming 'EnableARCOpts' is true→
3
←
Taking false branch→
  return false;

Changed = CFGChanged = false;
BundledRetainClaimRVs BRV(/*ContractPass=*/false);
BundledInsts = &BRV;

LLVM_DEBUG(dbgs() << "<<< ObjCARCOpt: Visiting Function: " << F.getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "<<< ObjCARCOpt: Visiting Function: "
 << F.getName() << " >>>" "\n"; } } while
 (false)
4
←
Assuming 'DebugFlag' is false→
5
←
Loop condition is false.  Exiting loop→
                  << " >>>"do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "<<< ObjCARCOpt: Visiting Function: "
 << F.getName() << " >>>" "\n"; } } while
 (false)
                     "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "<<< ObjCARCOpt: Visiting Function: "
 << F.getName() << " >>>" "\n"; } } while
 (false);

std::pair<bool, bool> R = BundledInsts->insertAfterInvokes(F, nullptr);
Changed |= R.first;
CFGChanged |= R.second;

PA.setAA(&AA);

2441#ifndef NDEBUG
if (AreStatisticsEnabled()) {
6
←
Assuming the condition is false→
7
←
Taking false branch→
  GatherStatistics(F, false);
}
2445#endif

// This pass performs several distinct transformations. As a compile-time aid
// when compiling code that isn't ObjC, skip these if the relevant ObjC
// library functions aren't declared.

// Preliminary optimizations. This also computes UsedInThisFunction.
OptimizeIndividualCalls(F);

// Optimizations for weak pointers.
if (UsedInThisFunction & ((1 << unsigned(ARCInstKind::LoadWeak)) |
8
←
Taking false branch→
                          (1 << unsigned(ARCInstKind::LoadWeakRetained)) |
                          (1 << unsigned(ARCInstKind::StoreWeak)) |
                          (1 << unsigned(ARCInstKind::InitWeak)) |
                          (1 << unsigned(ARCInstKind::CopyWeak)) |
                          (1 << unsigned(ARCInstKind::MoveWeak)) |
                          (1 << unsigned(ARCInstKind::DestroyWeak))))
  OptimizeWeakCalls(F);

// Optimizations for retain+release pairs.
if (UsedInThisFunction & ((1 << unsigned(ARCInstKind::Retain)) |
9
←
Taking false branch→
                          (1 << unsigned(ARCInstKind::RetainRV)) |
                          (1 << unsigned(ARCInstKind::RetainBlock))))
  if (UsedInThisFunction & (1 << unsigned(ARCInstKind::Release)))
    // Run OptimizeSequences until it either stops making changes or
    // no retain+release pair nesting is detected.
    while (OptimizeSequences(F)) {}

// Optimizations if objc_autorelease is used.
if (UsedInThisFunction & ((1 << unsigned(ARCInstKind::Autorelease)) |
10
←
Taking false branch→
                          (1 << unsigned(ARCInstKind::AutoreleaseRV))))
  OptimizeReturns(F);

// Gather statistics after optimization.
2479#ifndef NDEBUG
if (AreStatisticsEnabled()) {
11
←
Assuming the condition is false→
  GatherStatistics(F, true);
}
2483#endif

LLVM_DEBUG(dbgs() << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("objc-arc-opts")) { dbgs() << "\n"; } } while (false);
12
←
Taking false branch→
13
←
Assuming 'DebugFlag' is false→
14
←
Loop condition is false.  Exiting loop→

return Changed;
15
←
Address of stack memory associated with local variable 'BRV' is still referred to by the stack variable 'OCAO' upon returning to the caller.  This will be a dangling reference
2488}

2490/// @}
2491///

2493PreservedAnalyses ObjCARCOptPass::run(Function &F,
                                    FunctionAnalysisManager &AM) {
ObjCARCOpt OCAO;
OCAO.init(F);

bool Changed = OCAO.run(F, AM.getResult<AAManager>(F));
1
Calling 'ObjCARCOpt::run'→
bool CFGChanged = OCAO.hasCFGChanged();
if (Changed) {
  PreservedAnalyses PA;
  if (!CFGChanged)
    PA.preserveSet<CFGAnalyses>();
  return PA;
}
return PreservedAnalyses::all();
2507}