/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp

Bug Summary

File:	llvm/lib/Transforms/Coroutines/CoroSplit.cpp
Warning:	line 461, column 19 Called C++ object pointer is null
Annotated Source Code

Press '?' to see keyboard shortcuts
Show analyzer invocation
clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name CoroSplit.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -fhalf-no-semantic-interposition -mframe-pointer=none -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/build-llvm/lib/Transforms/Coroutines -resource-dir /usr/lib/llvm-13/lib/clang/13.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/build-llvm/lib/Transforms/Coroutines -I /build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines -I /build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/build-llvm/include -I /build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-13/lib/clang/13.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/build-llvm/lib/Transforms/Coroutines -fdebug-prefix-map=/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c=. -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2021-03-08-182450-10039-1 -x c++ /build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp
1//===- CoroSplit.cpp - Converts a coroutine into a state machine ----------===//
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// This pass builds the coroutine frame and outlines resume and destroy parts
9// of the coroutine into separate functions.
10//
11// We present a coroutine to an LLVM as an ordinary function with suspension
12// points marked up with intrinsics. We let the optimizer party on the coroutine
13// as a single function for as long as possible. Shortly before the coroutine is
14// eligible to be inlined into its callers, we split up the coroutine into parts
15// corresponding to an initial, resume and destroy invocations of the coroutine,
16// add them to the current SCC and restart the IPO pipeline to optimize the
17// coroutine subfunctions we extracted before proceeding to the caller of the
18// coroutine.
19//===----------------------------------------------------------------------===//

21#include "llvm/Transforms/Coroutines/CoroSplit.h"
22#include "CoroInstr.h"
23#include "CoroInternal.h"
24#include "llvm/ADT/DenseMap.h"
25#include "llvm/ADT/SmallPtrSet.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/ADT/StringRef.h"
28#include "llvm/ADT/Twine.h"
29#include "llvm/Analysis/CallGraph.h"
30#include "llvm/Analysis/CallGraphSCCPass.h"
31#include "llvm/Analysis/LazyCallGraph.h"
32#include "llvm/IR/Argument.h"
33#include "llvm/IR/Attributes.h"
34#include "llvm/IR/BasicBlock.h"
35#include "llvm/IR/CFG.h"
36#include "llvm/IR/CallingConv.h"
37#include "llvm/IR/Constants.h"
38#include "llvm/IR/DataLayout.h"
39#include "llvm/IR/DerivedTypes.h"
40#include "llvm/IR/Function.h"
41#include "llvm/IR/GlobalValue.h"
42#include "llvm/IR/GlobalVariable.h"
43#include "llvm/IR/IRBuilder.h"
44#include "llvm/IR/InstIterator.h"
45#include "llvm/IR/InstrTypes.h"
46#include "llvm/IR/Instruction.h"
47#include "llvm/IR/Instructions.h"
48#include "llvm/IR/IntrinsicInst.h"
49#include "llvm/IR/LLVMContext.h"
50#include "llvm/IR/LegacyPassManager.h"
51#include "llvm/IR/Module.h"
52#include "llvm/IR/Type.h"
53#include "llvm/IR/Value.h"
54#include "llvm/IR/Verifier.h"
55#include "llvm/InitializePasses.h"
56#include "llvm/Pass.h"
57#include "llvm/Support/Casting.h"
58#include "llvm/Support/Debug.h"
59#include "llvm/Support/PrettyStackTrace.h"
60#include "llvm/Support/raw_ostream.h"
61#include "llvm/Transforms/Scalar.h"
62#include "llvm/Transforms/Utils/BasicBlockUtils.h"
63#include "llvm/Transforms/Utils/CallGraphUpdater.h"
64#include "llvm/Transforms/Utils/Cloning.h"
65#include "llvm/Transforms/Utils/Local.h"
66#include "llvm/Transforms/Utils/ValueMapper.h"
67#include <cassert>
68#include <cstddef>
69#include <cstdint>
70#include <initializer_list>
71#include <iterator>

73using namespace llvm;

75#define DEBUG_TYPE"coro-split" "coro-split"

77namespace {

79/// A little helper class for building
80class CoroCloner {
81public:
enum class Kind {
  /// The shared resume function for a switch lowering.
  SwitchResume,

  /// The shared unwind function for a switch lowering.
  SwitchUnwind,

  /// The shared cleanup function for a switch lowering.
  SwitchCleanup,

  /// An individual continuation function.
  Continuation,

  /// An async resume function.
  Async,
};

99private:
Function &OrigF;
Function *NewF;
const Twine &Suffix;
coro::Shape &Shape;
Kind FKind;
ValueToValueMapTy VMap;
IRBuilder<> Builder;
Value *NewFramePtr = nullptr;

/// The active suspend instruction; meaningful only for continuation and async
/// ABIs.
AnyCoroSuspendInst *ActiveSuspend = nullptr;
20
←
Null pointer value stored to 'Cloner.ActiveSuspend'→

113public:
/// Create a cloner for a switch lowering.
CoroCloner(Function &OrigF, const Twine &Suffix, coro::Shape &Shape,
           Kind FKind)
  : OrigF(OrigF), NewF(nullptr), Suffix(Suffix), Shape(Shape),
    FKind(FKind), Builder(OrigF.getContext()) {
  assert(Shape.ABI == coro::ABI::Switch)((Shape.ABI == coro::ABI::Switch) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 119, __PRETTY_FUNCTION__));
21
←
Assuming field 'ABI' is equal to Switch→
22
←
'?' condition is true→
}

/// Create a cloner for a continuation lowering.
CoroCloner(Function &OrigF, const Twine &Suffix, coro::Shape &Shape,
           Function *NewF, AnyCoroSuspendInst *ActiveSuspend)
    : OrigF(OrigF), NewF(NewF), Suffix(Suffix), Shape(Shape),
      FKind(Shape.ABI == coro::ABI::Async ? Kind::Async : Kind::Continuation),
      Builder(OrigF.getContext()), ActiveSuspend(ActiveSuspend) {
  assert(Shape.ABI == coro::ABI::Retcon ||((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
 || Shape.ABI == coro::ABI::Async) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 129, __PRETTY_FUNCTION__))
         Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async)((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
 || Shape.ABI == coro::ABI::Async) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 129, __PRETTY_FUNCTION__));
  assert(NewF && "need existing function for continuation")((NewF && "need existing function for continuation") ?
 static_cast<void> (0) : __assert_fail ("NewF && \"need existing function for continuation\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 130, __PRETTY_FUNCTION__));
  assert(ActiveSuspend && "need active suspend point for continuation")((ActiveSuspend && "need active suspend point for continuation"
) ? static_cast<void> (0) : __assert_fail ("ActiveSuspend && \"need active suspend point for continuation\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 131, __PRETTY_FUNCTION__));
}

Function *getFunction() const {
  assert(NewF != nullptr && "declaration not yet set")((NewF != nullptr && "declaration not yet set") ? static_cast
<void> (0) : __assert_fail ("NewF != nullptr && \"declaration not yet set\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 135, __PRETTY_FUNCTION__));
  return NewF;
}

void create();

141private:
bool isSwitchDestroyFunction() {
  switch (FKind) {
  case Kind::Async:
  case Kind::Continuation:
  case Kind::SwitchResume:
    return false;
  case Kind::SwitchUnwind:
  case Kind::SwitchCleanup:
    return true;
  }
  llvm_unreachable("Unknown CoroCloner::Kind enum")::llvm::llvm_unreachable_internal("Unknown CoroCloner::Kind enum"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 152);
}

void replaceEntryBlock();
Value *deriveNewFramePointer();
void replaceRetconOrAsyncSuspendUses();
void replaceCoroSuspends();
void replaceCoroEnds();
void replaceSwiftErrorOps();
void salvageDebugInfo();
void handleFinalSuspend();
163};

165} // end anonymous namespace

167static void maybeFreeRetconStorage(IRBuilder<> &Builder,
                                 const coro::Shape &Shape, Value *FramePtr,
                                 CallGraph *CG) {
assert(Shape.ABI == coro::ABI::Retcon ||((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
) ? static_cast<void> (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 171, __PRETTY_FUNCTION__))
       Shape.ABI == coro::ABI::RetconOnce)((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
) ? static_cast<void> (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 171, __PRETTY_FUNCTION__));
if (Shape.RetconLowering.IsFrameInlineInStorage)
  return;

Shape.emitDealloc(Builder, FramePtr, CG);
176}

178/// Replace an llvm.coro.end.async.
179/// Will inline the must tail call function call if there is one.
180/// \returns true if cleanup of the coro.end block is needed, false otherwise.
181static bool replaceCoroEndAsync(AnyCoroEndInst *End) {
IRBuilder<> Builder(End);

auto *EndAsync = dyn_cast<CoroAsyncEndInst>(End);
if (!EndAsync) {
  Builder.CreateRetVoid();
  return true /*needs cleanup of coro.end block*/;
}

auto *MustTailCallFunc = EndAsync->getMustTailCallFunction();
if (!MustTailCallFunc) {
  Builder.CreateRetVoid();
  return true /*needs cleanup of coro.end block*/;
}

// Move the must tail call from the predecessor block into the end block.
auto *CoroEndBlock = End->getParent();
auto *MustTailCallFuncBlock = CoroEndBlock->getSinglePredecessor();
assert(MustTailCallFuncBlock && "Must have a single predecessor block")((MustTailCallFuncBlock && "Must have a single predecessor block"
) ? static_cast<void> (0) : __assert_fail ("MustTailCallFuncBlock && \"Must have a single predecessor block\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 199, __PRETTY_FUNCTION__));
auto It = MustTailCallFuncBlock->getTerminator()->getIterator();
auto *MustTailCall = cast<CallInst>(&*std::prev(It));
CoroEndBlock->getInstList().splice(
    End->getIterator(), MustTailCallFuncBlock->getInstList(), MustTailCall);

// Insert the return instruction.
Builder.SetInsertPoint(End);
Builder.CreateRetVoid();
InlineFunctionInfo FnInfo;

// Remove the rest of the block, by splitting it into an unreachable block.
auto *BB = End->getParent();
BB->splitBasicBlock(End);
BB->getTerminator()->eraseFromParent();

auto InlineRes = InlineFunction(*MustTailCall, FnInfo);
assert(InlineRes.isSuccess() && "Expected inlining to succeed")((InlineRes.isSuccess() && "Expected inlining to succeed"
) ? static_cast<void> (0) : __assert_fail ("InlineRes.isSuccess() && \"Expected inlining to succeed\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 216, __PRETTY_FUNCTION__));
(void)InlineRes;

// We have cleaned up the coro.end block above.
return false;
221}

223/// Replace a non-unwind call to llvm.coro.end.
224static void replaceFallthroughCoroEnd(AnyCoroEndInst *End,
                                    const coro::Shape &Shape, Value *FramePtr,
                                    bool InResume, CallGraph *CG) {
// Start inserting right before the coro.end.
IRBuilder<> Builder(End);

// Create the return instruction.
switch (Shape.ABI) {
// The cloned functions in switch-lowering always return void.
case coro::ABI::Switch:
  // coro.end doesn't immediately end the coroutine in the main function
  // in this lowering, because we need to deallocate the coroutine.
  if (!InResume)
    return;
  Builder.CreateRetVoid();
  break;

// In async lowering this returns.
case coro::ABI::Async: {
  bool CoroEndBlockNeedsCleanup = replaceCoroEndAsync(End);
  if (!CoroEndBlockNeedsCleanup)
    return;
  break;
}

// In unique continuation lowering, the continuations always return void.
// But we may have implicitly allocated storage.
case coro::ABI::RetconOnce:
  maybeFreeRetconStorage(Builder, Shape, FramePtr, CG);
  Builder.CreateRetVoid();
  break;

// In non-unique continuation lowering, we signal completion by returning
// a null continuation.
case coro::ABI::Retcon: {
  maybeFreeRetconStorage(Builder, Shape, FramePtr, CG);
  auto RetTy = Shape.getResumeFunctionType()->getReturnType();
  auto RetStructTy = dyn_cast<StructType>(RetTy);
  PointerType *ContinuationTy =
    cast<PointerType>(RetStructTy ? RetStructTy->getElementType(0) : RetTy);

  Value *ReturnValue = ConstantPointerNull::get(ContinuationTy);
  if (RetStructTy) {
    ReturnValue = Builder.CreateInsertValue(UndefValue::get(RetStructTy),
                                            ReturnValue, 0);
  }
  Builder.CreateRet(ReturnValue);
  break;
}
}

// Remove the rest of the block, by splitting it into an unreachable block.
auto *BB = End->getParent();
BB->splitBasicBlock(End);
BB->getTerminator()->eraseFromParent();
279}

281/// Replace an unwind call to llvm.coro.end.
282static void replaceUnwindCoroEnd(AnyCoroEndInst *End, const coro::Shape &Shape,
                               Value *FramePtr, bool InResume,
                               CallGraph *CG) {
IRBuilder<> Builder(End);

switch (Shape.ABI) {
// In switch-lowering, this does nothing in the main function.
case coro::ABI::Switch:
  if (!InResume)
    return;
  break;
// In async lowering this does nothing.
case coro::ABI::Async:
  break;
// In continuation-lowering, this frees the continuation storage.
case coro::ABI::Retcon:
case coro::ABI::RetconOnce:
  maybeFreeRetconStorage(Builder, Shape, FramePtr, CG);
  break;
}

// If coro.end has an associated bundle, add cleanupret instruction.
if (auto Bundle = End->getOperandBundle(LLVMContext::OB_funclet)) {
  auto *FromPad = cast<CleanupPadInst>(Bundle->Inputs[0]);
  auto *CleanupRet = Builder.CreateCleanupRet(FromPad, nullptr);
  End->getParent()->splitBasicBlock(End);
  CleanupRet->getParent()->getTerminator()->eraseFromParent();
}
310}

312static void replaceCoroEnd(AnyCoroEndInst *End, const coro::Shape &Shape,
                         Value *FramePtr, bool InResume, CallGraph *CG) {
if (End->isUnwind())
  replaceUnwindCoroEnd(End, Shape, FramePtr, InResume, CG);
else
  replaceFallthroughCoroEnd(End, Shape, FramePtr, InResume, CG);

auto &Context = End->getContext();
End->replaceAllUsesWith(InResume ? ConstantInt::getTrue(Context)
                                 : ConstantInt::getFalse(Context));
End->eraseFromParent();
323}

325// Create an entry block for a resume function with a switch that will jump to
326// suspend points.
327static void createResumeEntryBlock(Function &F, coro::Shape &Shape) {
assert(Shape.ABI == coro::ABI::Switch)((Shape.ABI == coro::ABI::Switch) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 328, __PRETTY_FUNCTION__));
LLVMContext &C = F.getContext();

// resume.entry:
//  %index.addr = getelementptr inbounds %f.Frame, %f.Frame* %FramePtr, i32 0,
//  i32 2
//  % index = load i32, i32* %index.addr
//  switch i32 %index, label %unreachable [
//    i32 0, label %resume.0
//    i32 1, label %resume.1
//    ...
//  ]

auto *NewEntry = BasicBlock::Create(C, "resume.entry", &F);
auto *UnreachBB = BasicBlock::Create(C, "unreachable", &F);

IRBuilder<> Builder(NewEntry);
auto *FramePtr = Shape.FramePtr;
auto *FrameTy = Shape.FrameTy;
auto *GepIndex = Builder.CreateStructGEP(
    FrameTy, FramePtr, Shape.getSwitchIndexField(), "index.addr");
auto *Index = Builder.CreateLoad(Shape.getIndexType(), GepIndex, "index");
auto *Switch =
    Builder.CreateSwitch(Index, UnreachBB, Shape.CoroSuspends.size());
Shape.SwitchLowering.ResumeSwitch = Switch;

size_t SuspendIndex = 0;
for (auto *AnyS : Shape.CoroSuspends) {
  auto *S = cast<CoroSuspendInst>(AnyS);
  ConstantInt *IndexVal = Shape.getIndex(SuspendIndex);

  // Replace CoroSave with a store to Index:
  //    %index.addr = getelementptr %f.frame... (index field number)
  //    store i32 0, i32* %index.addr1
  auto *Save = S->getCoroSave();
  Builder.SetInsertPoint(Save);
  if (S->isFinal()) {
    // Final suspend point is represented by storing zero in ResumeFnAddr.
    auto *GepIndex = Builder.CreateStructGEP(FrameTy, FramePtr,
                               coro::Shape::SwitchFieldIndex::Resume,
                                "ResumeFn.addr");
    auto *NullPtr = ConstantPointerNull::get(cast<PointerType>(
        cast<PointerType>(GepIndex->getType())->getElementType()));
    Builder.CreateStore(NullPtr, GepIndex);
  } else {
    auto *GepIndex = Builder.CreateStructGEP(
        FrameTy, FramePtr, Shape.getSwitchIndexField(), "index.addr");
    Builder.CreateStore(IndexVal, GepIndex);
  }
  Save->replaceAllUsesWith(ConstantTokenNone::get(C));
  Save->eraseFromParent();

  // Split block before and after coro.suspend and add a jump from an entry
  // switch:
  //
  //  whateverBB:
  //    whatever
  //    %0 = call i8 @llvm.coro.suspend(token none, i1 false)
  //    switch i8 %0, label %suspend[i8 0, label %resume
  //                                 i8 1, label %cleanup]
  // becomes:
  //
  //  whateverBB:
  //     whatever
  //     br label %resume.0.landing
  //
  //  resume.0: ; <--- jump from the switch in the resume.entry
  //     %0 = tail call i8 @llvm.coro.suspend(token none, i1 false)
  //     br label %resume.0.landing
  //
  //  resume.0.landing:
  //     %1 = phi i8[-1, %whateverBB], [%0, %resume.0]
  //     switch i8 % 1, label %suspend [i8 0, label %resume
  //                                    i8 1, label %cleanup]

  auto *SuspendBB = S->getParent();
  auto *ResumeBB =
      SuspendBB->splitBasicBlock(S, "resume." + Twine(SuspendIndex));
  auto *LandingBB = ResumeBB->splitBasicBlock(
      S->getNextNode(), ResumeBB->getName() + Twine(".landing"));
  Switch->addCase(IndexVal, ResumeBB);

  cast<BranchInst>(SuspendBB->getTerminator())->setSuccessor(0, LandingBB);
  auto *PN = PHINode::Create(Builder.getInt8Ty(), 2, "", &LandingBB->front());
  S->replaceAllUsesWith(PN);
  PN->addIncoming(Builder.getInt8(-1), SuspendBB);
  PN->addIncoming(S, ResumeBB);

  ++SuspendIndex;
}

Builder.SetInsertPoint(UnreachBB);
Builder.CreateUnreachable();

Shape.SwitchLowering.ResumeEntryBlock = NewEntry;
423}


426// Rewrite final suspend point handling. We do not use suspend index to
427// represent the final suspend point. Instead we zero-out ResumeFnAddr in the
428// coroutine frame, since it is undefined behavior to resume a coroutine
429// suspended at the final suspend point. Thus, in the resume function, we can
430// simply remove the last case (when coro::Shape is built, the final suspend
431// point (if present) is always the last element of CoroSuspends array).
432// In the destroy function, we add a code sequence to check if ResumeFnAddress
433// is Null, and if so, jump to the appropriate label to handle cleanup from the
434// final suspend point.
435void CoroCloner::handleFinalSuspend() {
assert(Shape.ABI == coro::ABI::Switch &&((Shape.ABI == coro::ABI::Switch && Shape.SwitchLowering
.HasFinalSuspend) ? static_cast<void> (0) : __assert_fail
 ("Shape.ABI == coro::ABI::Switch && Shape.SwitchLowering.HasFinalSuspend"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 437, __PRETTY_FUNCTION__))
       Shape.SwitchLowering.HasFinalSuspend)((Shape.ABI == coro::ABI::Switch && Shape.SwitchLowering
.HasFinalSuspend) ? static_cast<void> (0) : __assert_fail
 ("Shape.ABI == coro::ABI::Switch && Shape.SwitchLowering.HasFinalSuspend"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 437, __PRETTY_FUNCTION__));
auto *Switch = cast<SwitchInst>(VMap[Shape.SwitchLowering.ResumeSwitch]);
auto FinalCaseIt = std::prev(Switch->case_end());
BasicBlock *ResumeBB = FinalCaseIt->getCaseSuccessor();
Switch->removeCase(FinalCaseIt);
if (isSwitchDestroyFunction()) {
  BasicBlock *OldSwitchBB = Switch->getParent();
  auto *NewSwitchBB = OldSwitchBB->splitBasicBlock(Switch, "Switch");
  Builder.SetInsertPoint(OldSwitchBB->getTerminator());
  auto *GepIndex = Builder.CreateStructGEP(Shape.FrameTy, NewFramePtr,
                                     coro::Shape::SwitchFieldIndex::Resume,
                                           "ResumeFn.addr");
  auto *Load = Builder.CreateLoad(Shape.getSwitchResumePointerType(),
                                  GepIndex);
  auto *Cond = Builder.CreateIsNull(Load);
  Builder.CreateCondBr(Cond, ResumeBB, NewSwitchBB);
  OldSwitchBB->getTerminator()->eraseFromParent();
}
455}

457static FunctionType *
458getFunctionTypeFromAsyncSuspend(AnyCoroSuspendInst *Suspend) {
auto *AsyncSuspend = cast<CoroSuspendAsyncInst>(Suspend);
auto *StructTy = cast<StructType>(AsyncSuspend->getType());
33
←
The object is a 'StructType'→
auto &Context = Suspend->getParent()->getParent()->getContext();
34
←
Called C++ object pointer is null
auto *VoidTy = Type::getVoidTy(Context);
return FunctionType::get(VoidTy, StructTy->elements(), false);
464}

466static Function *createCloneDeclaration(Function &OrigF, coro::Shape &Shape,
                                      const Twine &Suffix,
                                      Module::iterator InsertBefore,
                                      AnyCoroSuspendInst *ActiveSuspend) {
Module *M = OrigF.getParent();
auto *FnTy = (Shape.ABI != coro::ABI::Async)
29
←
Assuming field 'ABI' is equal to Async→
30
←
'?' condition is false→
                 ? Shape.getResumeFunctionType()
                 : getFunctionTypeFromAsyncSuspend(ActiveSuspend);
31
←
Passing null pointer value via 1st parameter 'Suspend'→
32
←
Calling 'getFunctionTypeFromAsyncSuspend'→

Function *NewF =
    Function::Create(FnTy, GlobalValue::LinkageTypes::InternalLinkage,
                     OrigF.getName() + Suffix);
NewF->addParamAttr(0, Attribute::NonNull);

// For the async lowering ABI we can't guarantee that the context argument is
// not access via a different pointer not based on the argument.
if (Shape.ABI != coro::ABI::Async)
  NewF->addParamAttr(0, Attribute::NoAlias);

M->getFunctionList().insert(InsertBefore, NewF);

return NewF;
488}

490/// Replace uses of the active llvm.coro.suspend.retcon/async call with the
491/// arguments to the continuation function.
492///
493/// This assumes that the builder has a meaningful insertion point.
494void CoroCloner::replaceRetconOrAsyncSuspendUses() {
assert(Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce ||((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
 || Shape.ABI == coro::ABI::Async) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 496, __PRETTY_FUNCTION__))
       Shape.ABI == coro::ABI::Async)((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
 || Shape.ABI == coro::ABI::Async) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 496, __PRETTY_FUNCTION__));

auto NewS = VMap[ActiveSuspend];
if (NewS->use_empty()) return;

// Copy out all the continuation arguments after the buffer pointer into
// an easily-indexed data structure for convenience.
SmallVector<Value*, 8> Args;
// The async ABI includes all arguments -- including the first argument.
bool IsAsyncABI = Shape.ABI == coro::ABI::Async;
for (auto I = IsAsyncABI ? NewF->arg_begin() : std::next(NewF->arg_begin()),
          E = NewF->arg_end();
     I != E; ++I)
  Args.push_back(&*I);

// If the suspend returns a single scalar value, we can just do a simple
// replacement.
if (!isa<StructType>(NewS->getType())) {
  assert(Args.size() == 1)((Args.size() == 1) ? static_cast<void> (0) : __assert_fail
 ("Args.size() == 1", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 514, __PRETTY_FUNCTION__));
  NewS->replaceAllUsesWith(Args.front());
  return;
}

// Try to peephole extracts of an aggregate return.
for (auto UI = NewS->use_begin(), UE = NewS->use_end(); UI != UE; ) {
  auto EVI = dyn_cast<ExtractValueInst>((UI++)->getUser());
  if (!EVI || EVI->getNumIndices() != 1)
    continue;

  EVI->replaceAllUsesWith(Args[EVI->getIndices().front()]);
  EVI->eraseFromParent();
}

// If we have no remaining uses, we're done.
if (NewS->use_empty()) return;

// Otherwise, we need to create an aggregate.
Value *Agg = UndefValue::get(NewS->getType());
for (size_t I = 0, E = Args.size(); I != E; ++I)
  Agg = Builder.CreateInsertValue(Agg, Args[I], I);

NewS->replaceAllUsesWith(Agg);
538}

540void CoroCloner::replaceCoroSuspends() {
Value *SuspendResult;

switch (Shape.ABI) {
// In switch lowering, replace coro.suspend with the appropriate value
// for the type of function we're extracting.
// Replacing coro.suspend with (0) will result in control flow proceeding to
// a resume label associated with a suspend point, replacing it with (1) will
// result in control flow proceeding to a cleanup label associated with this
// suspend point.
case coro::ABI::Switch:
  SuspendResult = Builder.getInt8(isSwitchDestroyFunction() ? 1 : 0);
  break;

// In async lowering there are no uses of the result.
case coro::ABI::Async:
  return;

// In returned-continuation lowering, the arguments from earlier
// continuations are theoretically arbitrary, and they should have been
// spilled.
case coro::ABI::RetconOnce:
case coro::ABI::Retcon:
  return;
}

for (AnyCoroSuspendInst *CS : Shape.CoroSuspends) {
  // The active suspend was handled earlier.
  if (CS == ActiveSuspend) continue;

  auto *MappedCS = cast<AnyCoroSuspendInst>(VMap[CS]);
  MappedCS->replaceAllUsesWith(SuspendResult);
  MappedCS->eraseFromParent();
}
574}

576void CoroCloner::replaceCoroEnds() {
for (AnyCoroEndInst *CE : Shape.CoroEnds) {
  // We use a null call graph because there's no call graph node for
  // the cloned function yet.  We'll just be rebuilding that later.
  auto *NewCE = cast<AnyCoroEndInst>(VMap[CE]);
  replaceCoroEnd(NewCE, Shape, NewFramePtr, /*in resume*/ true, nullptr);
}
583}

585static void replaceSwiftErrorOps(Function &F, coro::Shape &Shape,
                               ValueToValueMapTy *VMap) {
if (Shape.ABI == coro::ABI::Async && Shape.CoroSuspends.empty())
  return;
Value *CachedSlot = nullptr;
auto getSwiftErrorSlot = [&](Type *ValueTy) -> Value * {
  if (CachedSlot) {
    assert(CachedSlot->getType()->getPointerElementType() == ValueTy &&((CachedSlot->getType()->getPointerElementType() == ValueTy
 && "multiple swifterror slots in function with different types"
) ? static_cast<void> (0) : __assert_fail ("CachedSlot->getType()->getPointerElementType() == ValueTy && \"multiple swifterror slots in function with different types\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 593, __PRETTY_FUNCTION__))
           "multiple swifterror slots in function with different types")((CachedSlot->getType()->getPointerElementType() == ValueTy
 && "multiple swifterror slots in function with different types"
) ? static_cast<void> (0) : __assert_fail ("CachedSlot->getType()->getPointerElementType() == ValueTy && \"multiple swifterror slots in function with different types\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 593, __PRETTY_FUNCTION__));
    return CachedSlot;
  }

  // Check if the function has a swifterror argument.
  for (auto &Arg : F.args()) {
    if (Arg.isSwiftError()) {
      CachedSlot = &Arg;
      assert(Arg.getType()->getPointerElementType() == ValueTy &&((Arg.getType()->getPointerElementType() == ValueTy &&
 "swifterror argument does not have expected type") ? static_cast
<void> (0) : __assert_fail ("Arg.getType()->getPointerElementType() == ValueTy && \"swifterror argument does not have expected type\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 602, __PRETTY_FUNCTION__))
             "swifterror argument does not have expected type")((Arg.getType()->getPointerElementType() == ValueTy &&
 "swifterror argument does not have expected type") ? static_cast
<void> (0) : __assert_fail ("Arg.getType()->getPointerElementType() == ValueTy && \"swifterror argument does not have expected type\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 602, __PRETTY_FUNCTION__));
      return &Arg;
    }
  }

  // Create a swifterror alloca.
  IRBuilder<> Builder(F.getEntryBlock().getFirstNonPHIOrDbg());
  auto Alloca = Builder.CreateAlloca(ValueTy);
  Alloca->setSwiftError(true);

  CachedSlot = Alloca;
  return Alloca;
};

for (CallInst *Op : Shape.SwiftErrorOps) {
  auto MappedOp = VMap ? cast<CallInst>((*VMap)[Op]) : Op;
  IRBuilder<> Builder(MappedOp);

  // If there are no arguments, this is a 'get' operation.
  Value *MappedResult;
  if (Op->getNumArgOperands() == 0) {
    auto ValueTy = Op->getType();
    auto Slot = getSwiftErrorSlot(ValueTy);
    MappedResult = Builder.CreateLoad(ValueTy, Slot);
  } else {
    assert(Op->getNumArgOperands() == 1)((Op->getNumArgOperands() == 1) ? static_cast<void> (
0) : __assert_fail ("Op->getNumArgOperands() == 1", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 627, __PRETTY_FUNCTION__));
    auto Value = MappedOp->getArgOperand(0);
    auto ValueTy = Value->getType();
    auto Slot = getSwiftErrorSlot(ValueTy);
    Builder.CreateStore(Value, Slot);
    MappedResult = Slot;
  }

  MappedOp->replaceAllUsesWith(MappedResult);
  MappedOp->eraseFromParent();
}

// If we're updating the original function, we've invalidated SwiftErrorOps.
if (VMap == nullptr) {
  Shape.SwiftErrorOps.clear();
}
643}

645void CoroCloner::replaceSwiftErrorOps() {
::replaceSwiftErrorOps(*NewF, Shape, &VMap);
647}

649void CoroCloner::salvageDebugInfo() {
SmallVector<DbgDeclareInst *, 8> Worklist;
SmallDenseMap<llvm::Value *, llvm::AllocaInst *, 4> DbgPtrAllocaCache;
for (auto &BB : *NewF)
  for (auto &I : BB)
    if (auto *DDI = dyn_cast<DbgDeclareInst>(&I))
      Worklist.push_back(DDI);
for (DbgDeclareInst *DDI : Worklist)
  coro::salvageDebugInfo(DbgPtrAllocaCache, DDI);

// Remove all salvaged dbg.declare intrinsics that became
// either unreachable or stale due to the CoroSplit transformation.
auto IsUnreachableBlock = [&](BasicBlock *BB) {
  return BB->hasNPredecessors(0) && BB != &NewF->getEntryBlock();
};
for (DbgDeclareInst *DDI : Worklist) {
  if (IsUnreachableBlock(DDI->getParent()))
    DDI->eraseFromParent();
  else if (dyn_cast_or_null<AllocaInst>(DDI->getAddress())) {
    // Count all non-debuginfo uses in reachable blocks.
    unsigned Uses = 0;
    for (auto *User : DDI->getAddress()->users())
      if (auto *I = dyn_cast<Instruction>(User))
        if (!isa<AllocaInst>(I) && !IsUnreachableBlock(I->getParent()))
          ++Uses;
    if (!Uses)
      DDI->eraseFromParent();
  }
}
678}

680void CoroCloner::replaceEntryBlock() {
// In the original function, the AllocaSpillBlock is a block immediately
// following the allocation of the frame object which defines GEPs for
// all the allocas that have been moved into the frame, and it ends by
// branching to the original beginning of the coroutine.  Make this
// the entry block of the cloned function.
auto *Entry = cast<BasicBlock>(VMap[Shape.AllocaSpillBlock]);
auto *OldEntry = &NewF->getEntryBlock();
Entry->setName("entry" + Suffix);
Entry->moveBefore(OldEntry);
Entry->getTerminator()->eraseFromParent();

// Clear all predecessors of the new entry block.  There should be
// exactly one predecessor, which we created when splitting out
// AllocaSpillBlock to begin with.
assert(Entry->hasOneUse())((Entry->hasOneUse()) ? static_cast<void> (0) : __assert_fail
 ("Entry->hasOneUse()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 695, __PRETTY_FUNCTION__));
auto BranchToEntry = cast<BranchInst>(Entry->user_back());
assert(BranchToEntry->isUnconditional())((BranchToEntry->isUnconditional()) ? static_cast<void>
 (0) : __assert_fail ("BranchToEntry->isUnconditional()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 697, __PRETTY_FUNCTION__));
Builder.SetInsertPoint(BranchToEntry);
Builder.CreateUnreachable();
BranchToEntry->eraseFromParent();

// Branch from the entry to the appropriate place.
Builder.SetInsertPoint(Entry);
switch (Shape.ABI) {
case coro::ABI::Switch: {
  // In switch-lowering, we built a resume-entry block in the original
  // function.  Make the entry block branch to this.
  auto *SwitchBB =
    cast<BasicBlock>(VMap[Shape.SwitchLowering.ResumeEntryBlock]);
  Builder.CreateBr(SwitchBB);
  break;
}
case coro::ABI::Async:
case coro::ABI::Retcon:
case coro::ABI::RetconOnce: {
  // In continuation ABIs, we want to branch to immediately after the
  // active suspend point.  Earlier phases will have put the suspend in its
  // own basic block, so just thread our jump directly to its successor.
  assert((Shape.ABI == coro::ABI::Async &&(((Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst
>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst
>(ActiveSuspend))) ? static_cast<void> (0) : __assert_fail
 ("(Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst>(ActiveSuspend))"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 723, __PRETTY_FUNCTION__))
          isa<CoroSuspendAsyncInst>(ActiveSuspend)) ||(((Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst
>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst
>(ActiveSuspend))) ? static_cast<void> (0) : __assert_fail
 ("(Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst>(ActiveSuspend))"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 723, __PRETTY_FUNCTION__))
         ((Shape.ABI == coro::ABI::Retcon ||(((Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst
>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst
>(ActiveSuspend))) ? static_cast<void> (0) : __assert_fail
 ("(Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst>(ActiveSuspend))"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 723, __PRETTY_FUNCTION__))
           Shape.ABI == coro::ABI::RetconOnce) &&(((Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst
>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst
>(ActiveSuspend))) ? static_cast<void> (0) : __assert_fail
 ("(Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst>(ActiveSuspend))"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 723, __PRETTY_FUNCTION__))
          isa<CoroSuspendRetconInst>(ActiveSuspend)))(((Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst
>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst
>(ActiveSuspend))) ? static_cast<void> (0) : __assert_fail
 ("(Shape.ABI == coro::ABI::Async && isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) && isa<CoroSuspendRetconInst>(ActiveSuspend))"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 723, __PRETTY_FUNCTION__));
  auto *MappedCS = cast<AnyCoroSuspendInst>(VMap[ActiveSuspend]);
  auto Branch = cast<BranchInst>(MappedCS->getNextNode());
  assert(Branch->isUnconditional())((Branch->isUnconditional()) ? static_cast<void> (0)
 : __assert_fail ("Branch->isUnconditional()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 726, __PRETTY_FUNCTION__));
  Builder.CreateBr(Branch->getSuccessor(0));
  break;
}
}

// Any static alloca that's still being used but not reachable from the new
// entry needs to be moved to the new entry.
Function *F = OldEntry->getParent();
DominatorTree DT{*F};
for (auto IT = inst_begin(F), End = inst_end(F); IT != End;) {
  Instruction &I = *IT++;
  auto *Alloca = dyn_cast<AllocaInst>(&I);
  if (!Alloca || I.use_empty())
    continue;
  if (DT.isReachableFromEntry(I.getParent()) ||
      !isa<ConstantInt>(Alloca->getArraySize()))
    continue;
  I.moveBefore(*Entry, Entry->getFirstInsertionPt());
}
746}

748/// Derive the value of the new frame pointer.
749Value *CoroCloner::deriveNewFramePointer() {
// Builder should be inserting to the front of the new entry block.

switch (Shape.ABI) {
// In switch-lowering, the argument is the frame pointer.
case coro::ABI::Switch:
  return &*NewF->arg_begin();
// In async-lowering, one of the arguments is an async context as determined
// by the `llvm.coro.id.async` intrinsic. We can retrieve the async context of
// the resume function from the async context projection function associated
// with the active suspend. The frame is located as a tail to the async
// context header.
case coro::ABI::Async: {
  auto *ActiveAsyncSuspend = cast<CoroSuspendAsyncInst>(ActiveSuspend);
  auto *CalleeContext =
      NewF->getArg(ActiveAsyncSuspend->getStorageArgumentIndex());
  auto *FramePtrTy = Shape.FrameTy->getPointerTo();
  auto *ProjectionFunc =
      ActiveAsyncSuspend->getAsyncContextProjectionFunction();
  auto DbgLoc =
      cast<CoroSuspendAsyncInst>(VMap[ActiveSuspend])->getDebugLoc();
  // Calling i8* (i8*)
  auto *CallerContext = Builder.CreateCall(
      cast<FunctionType>(ProjectionFunc->getType()->getPointerElementType()),
      ProjectionFunc, CalleeContext);
  CallerContext->setCallingConv(ProjectionFunc->getCallingConv());
  CallerContext->setDebugLoc(DbgLoc);
  // The frame is located after the async_context header.
  auto &Context = Builder.getContext();
  auto *FramePtrAddr = Builder.CreateConstInBoundsGEP1_32(
      Type::getInt8Ty(Context), CallerContext,
      Shape.AsyncLowering.FrameOffset, "async.ctx.frameptr");
  // Inline the projection function.
  InlineFunctionInfo InlineInfo;
  auto InlineRes = InlineFunction(*CallerContext, InlineInfo);
  assert(InlineRes.isSuccess())((InlineRes.isSuccess()) ? static_cast<void> (0) : __assert_fail
 ("InlineRes.isSuccess()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 784, __PRETTY_FUNCTION__));
  (void)InlineRes;
  return Builder.CreateBitCast(FramePtrAddr, FramePtrTy);
}
// In continuation-lowering, the argument is the opaque storage.
case coro::ABI::Retcon:
case coro::ABI::RetconOnce: {
  Argument *NewStorage = &*NewF->arg_begin();
  auto FramePtrTy = Shape.FrameTy->getPointerTo();

  // If the storage is inline, just bitcast to the storage to the frame type.
  if (Shape.RetconLowering.IsFrameInlineInStorage)
    return Builder.CreateBitCast(NewStorage, FramePtrTy);

  // Otherwise, load the real frame from the opaque storage.
  auto FramePtrPtr =
    Builder.CreateBitCast(NewStorage, FramePtrTy->getPointerTo());
  return Builder.CreateLoad(FramePtrTy, FramePtrPtr);
}
}
llvm_unreachable("bad ABI")::llvm::llvm_unreachable_internal("bad ABI", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 804);
805}

807static void addFramePointerAttrs(AttributeList &Attrs, LLVMContext &Context,
                               unsigned ParamIndex,
                               uint64_t Size, Align Alignment) {
AttrBuilder ParamAttrs;
ParamAttrs.addAttribute(Attribute::NonNull);
ParamAttrs.addAttribute(Attribute::NoAlias);
ParamAttrs.addAlignmentAttr(Alignment);
ParamAttrs.addDereferenceableAttr(Size);
Attrs = Attrs.addParamAttributes(Context, ParamIndex, ParamAttrs);
816}

818/// Clone the body of the original function into a resume function of
819/// some sort.
820void CoroCloner::create() {
// Create the new function if we don't already have one.
if (!NewF) {
25
←
Assuming field 'NewF' is null→
26
←
Taking true branch→
  NewF = createCloneDeclaration(OrigF, Shape, Suffix,
28
←
Calling 'createCloneDeclaration'→
                                OrigF.getParent()->end(), ActiveSuspend);
27
←
Passing null pointer value via 5th parameter 'ActiveSuspend'→
}

// Replace all args with undefs. The buildCoroutineFrame algorithm already
// rewritten access to the args that occurs after suspend points with loads
// and stores to/from the coroutine frame.
for (Argument &A : OrigF.args())
  VMap[&A] = UndefValue::get(A.getType());

SmallVector<ReturnInst *, 4> Returns;

// Ignore attempts to change certain attributes of the function.
// TODO: maybe there should be a way to suppress this during cloning?
auto savedVisibility = NewF->getVisibility();
auto savedUnnamedAddr = NewF->getUnnamedAddr();
auto savedDLLStorageClass = NewF->getDLLStorageClass();

// NewF's linkage (which CloneFunctionInto does *not* change) might not
// be compatible with the visibility of OrigF (which it *does* change),
// so protect against that.
auto savedLinkage = NewF->getLinkage();
NewF->setLinkage(llvm::GlobalValue::ExternalLinkage);

CloneFunctionInto(NewF, &OrigF, VMap,
                  CloneFunctionChangeType::LocalChangesOnly, Returns);
// For async functions / continuations, adjust the scope line of the
// clone to the line number of the suspend point. The scope line is
// associated with all pre-prologue instructions. This avoids a jump
// in the linetable from the function declaration to the suspend point.
if (DISubprogram *SP = NewF->getSubprogram()) {
  assert(SP != OrigF.getSubprogram() && SP->isDistinct())((SP != OrigF.getSubprogram() && SP->isDistinct())
 ? static_cast<void> (0) : __assert_fail ("SP != OrigF.getSubprogram() && SP->isDistinct()"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 854, __PRETTY_FUNCTION__));
  if (ActiveSuspend)
    if (auto DL = ActiveSuspend->getDebugLoc())
      SP->setScopeLine(DL->getLine());
}

NewF->setLinkage(savedLinkage);
NewF->setVisibility(savedVisibility);
NewF->setUnnamedAddr(savedUnnamedAddr);
NewF->setDLLStorageClass(savedDLLStorageClass);

auto &Context = NewF->getContext();

// Replace the attributes of the new function:
auto OrigAttrs = NewF->getAttributes();
auto NewAttrs = AttributeList();

switch (Shape.ABI) {
case coro::ABI::Switch:
  // Bootstrap attributes by copying function attributes from the
  // original function.  This should include optimization settings and so on.
  NewAttrs = NewAttrs.addAttributes(Context, AttributeList::FunctionIndex,
                                    OrigAttrs.getFnAttributes());

  addFramePointerAttrs(NewAttrs, Context, 0,
                       Shape.FrameSize, Shape.FrameAlign);
  break;
case coro::ABI::Async:
  break;
case coro::ABI::Retcon:
case coro::ABI::RetconOnce:
  // If we have a continuation prototype, just use its attributes,
  // full-stop.
  NewAttrs = Shape.RetconLowering.ResumePrototype->getAttributes();

  addFramePointerAttrs(NewAttrs, Context, 0,
                       Shape.getRetconCoroId()->getStorageSize(),
                       Shape.getRetconCoroId()->getStorageAlignment());
  break;
}

switch (Shape.ABI) {
// In these ABIs, the cloned functions always return 'void', and the
// existing return sites are meaningless.  Note that for unique
// continuations, this includes the returns associated with suspends;
// this is fine because we can't suspend twice.
case coro::ABI::Switch:
case coro::ABI::RetconOnce:
  // Remove old returns.
  for (ReturnInst *Return : Returns)
    changeToUnreachable(Return, /*UseLLVMTrap=*/false);
  break;

// With multi-suspend continuations, we'll already have eliminated the
// original returns and inserted returns before all the suspend points,
// so we want to leave any returns in place.
case coro::ABI::Retcon:
  break;
// Async lowering will insert musttail call functions at all suspend points
// followed by a return.
// Don't change returns to unreachable because that will trip up the verifier.
// These returns should be unreachable from the clone.
case coro::ABI::Async:
  break;
}

NewF->setAttributes(NewAttrs);
NewF->setCallingConv(Shape.getResumeFunctionCC());

// Set up the new entry block.
replaceEntryBlock();

Builder.SetInsertPoint(&NewF->getEntryBlock().front());
NewFramePtr = deriveNewFramePointer();

// Remap frame pointer.
Value *OldFramePtr = VMap[Shape.FramePtr];
NewFramePtr->takeName(OldFramePtr);
OldFramePtr->replaceAllUsesWith(NewFramePtr);

// Remap vFrame pointer.
auto *NewVFrame = Builder.CreateBitCast(
    NewFramePtr, Type::getInt8PtrTy(Builder.getContext()), "vFrame");
Value *OldVFrame = cast<Value>(VMap[Shape.CoroBegin]);
OldVFrame->replaceAllUsesWith(NewVFrame);

switch (Shape.ABI) {
case coro::ABI::Switch:
  // Rewrite final suspend handling as it is not done via switch (allows to
  // remove final case from the switch, since it is undefined behavior to
  // resume the coroutine suspended at the final suspend point.
  if (Shape.SwitchLowering.HasFinalSuspend)
    handleFinalSuspend();
  break;
case coro::ABI::Async:
case coro::ABI::Retcon:
case coro::ABI::RetconOnce:
  // Replace uses of the active suspend with the corresponding
  // continuation-function arguments.
  assert(ActiveSuspend != nullptr &&((ActiveSuspend != nullptr && "no active suspend when lowering a continuation-style coroutine"
) ? static_cast<void> (0) : __assert_fail ("ActiveSuspend != nullptr && \"no active suspend when lowering a continuation-style coroutine\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 954, __PRETTY_FUNCTION__))
         "no active suspend when lowering a continuation-style coroutine")((ActiveSuspend != nullptr && "no active suspend when lowering a continuation-style coroutine"
) ? static_cast<void> (0) : __assert_fail ("ActiveSuspend != nullptr && \"no active suspend when lowering a continuation-style coroutine\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 954, __PRETTY_FUNCTION__));
  replaceRetconOrAsyncSuspendUses();
  break;
}

// Handle suspends.
replaceCoroSuspends();

// Handle swifterror.
replaceSwiftErrorOps();

// Remove coro.end intrinsics.
replaceCoroEnds();

// Salvage debug info that points into the coroutine frame.
salvageDebugInfo();

// Eliminate coro.free from the clones, replacing it with 'null' in cleanup,
// to suppress deallocation code.
if (Shape.ABI == coro::ABI::Switch)
  coro::replaceCoroFree(cast<CoroIdInst>(VMap[Shape.CoroBegin->getId()]),
                        /*Elide=*/ FKind == CoroCloner::Kind::SwitchCleanup);
976}

978// Create a resume clone by cloning the body of the original function, setting
979// new entry block and replacing coro.suspend an appropriate value to force
980// resume or cleanup pass for every suspend point.
981static Function *createClone(Function &F, const Twine &Suffix,
                           coro::Shape &Shape, CoroCloner::Kind FKind) {
CoroCloner Cloner(F, Suffix, Shape, FKind);
19
←
Calling constructor for 'CoroCloner'→
23
←
Returning from constructor for 'CoroCloner'→
Cloner.create();
24
←
Calling 'CoroCloner::create'→
return Cloner.getFunction();
986}

988/// Remove calls to llvm.coro.end in the original function.
989static void removeCoroEnds(const coro::Shape &Shape, CallGraph *CG) {
for (auto End : Shape.CoroEnds) {
  replaceCoroEnd(End, Shape, Shape.FramePtr, /*in resume*/ false, CG);
}
993}

995static void updateAsyncFuncPointerContextSize(coro::Shape &Shape) {
assert(Shape.ABI == coro::ABI::Async)((Shape.ABI == coro::ABI::Async) ? static_cast<void> (0
) : __assert_fail ("Shape.ABI == coro::ABI::Async", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 996, __PRETTY_FUNCTION__));

auto *FuncPtrStruct = cast<ConstantStruct>(
    Shape.AsyncLowering.AsyncFuncPointer->getInitializer());
auto *OrigRelativeFunOffset = FuncPtrStruct->getOperand(0);
auto *OrigContextSize = FuncPtrStruct->getOperand(1);
auto *NewContextSize = ConstantInt::get(OrigContextSize->getType(),
                                        Shape.AsyncLowering.ContextSize);
auto *NewFuncPtrStruct = ConstantStruct::get(
    FuncPtrStruct->getType(), OrigRelativeFunOffset, NewContextSize);

Shape.AsyncLowering.AsyncFuncPointer->setInitializer(NewFuncPtrStruct);
1008}

1010static void replaceFrameSize(coro::Shape &Shape) {
if (Shape.ABI == coro::ABI::Async)
  updateAsyncFuncPointerContextSize(Shape);

if (Shape.CoroSizes.empty())
  return;

// In the same function all coro.sizes should have the same result type.
auto *SizeIntrin = Shape.CoroSizes.back();
Module *M = SizeIntrin->getModule();
const DataLayout &DL = M->getDataLayout();
auto Size = DL.getTypeAllocSize(Shape.FrameTy);
auto *SizeConstant = ConstantInt::get(SizeIntrin->getType(), Size);

for (CoroSizeInst *CS : Shape.CoroSizes) {
  CS->replaceAllUsesWith(SizeConstant);
  CS->eraseFromParent();
}
1028}

1030// Create a global constant array containing pointers to functions provided and
1031// set Info parameter of CoroBegin to point at this constant. Example:
1032//
1033//   @f.resumers = internal constant [2 x void(%f.frame*)*]
1034//                    [void(%f.frame*)* @f.resume, void(%f.frame*)* @f.destroy]
1035//   define void @f() {
1036//     ...
1037//     call i8* @llvm.coro.begin(i8* null, i32 0, i8* null,
1038//                    i8* bitcast([2 x void(%f.frame*)*] * @f.resumers to i8*))
1039//
1040// Assumes that all the functions have the same signature.
1041static void setCoroInfo(Function &F, coro::Shape &Shape,
                      ArrayRef<Function *> Fns) {
// This only works under the switch-lowering ABI because coro elision
// only works on the switch-lowering ABI.
assert(Shape.ABI == coro::ABI::Switch)((Shape.ABI == coro::ABI::Switch) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1045, __PRETTY_FUNCTION__));

SmallVector<Constant *, 4> Args(Fns.begin(), Fns.end());
assert(!Args.empty())((!Args.empty()) ? static_cast<void> (0) : __assert_fail
 ("!Args.empty()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1048, __PRETTY_FUNCTION__));
Function *Part = *Fns.begin();
Module *M = Part->getParent();
auto *ArrTy = ArrayType::get(Part->getType(), Args.size());

auto *ConstVal = ConstantArray::get(ArrTy, Args);
auto *GV = new GlobalVariable(*M, ConstVal->getType(), /*isConstant=*/true,
                              GlobalVariable::PrivateLinkage, ConstVal,
                              F.getName() + Twine(".resumers"));

// Update coro.begin instruction to refer to this constant.
LLVMContext &C = F.getContext();
auto *BC = ConstantExpr::getPointerCast(GV, Type::getInt8PtrTy(C));
Shape.getSwitchCoroId()->setInfo(BC);
1062}

1064// Store addresses of Resume/Destroy/Cleanup functions in the coroutine frame.
1065static void updateCoroFrame(coro::Shape &Shape, Function *ResumeFn,
                          Function *DestroyFn, Function *CleanupFn) {
assert(Shape.ABI == coro::ABI::Switch)((Shape.ABI == coro::ABI::Switch) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1067, __PRETTY_FUNCTION__));

IRBuilder<> Builder(Shape.FramePtr->getNextNode());
auto *ResumeAddr = Builder.CreateStructGEP(
    Shape.FrameTy, Shape.FramePtr, coro::Shape::SwitchFieldIndex::Resume,
    "resume.addr");
Builder.CreateStore(ResumeFn, ResumeAddr);

Value *DestroyOrCleanupFn = DestroyFn;

CoroIdInst *CoroId = Shape.getSwitchCoroId();
if (CoroAllocInst *CA = CoroId->getCoroAlloc()) {
  // If there is a CoroAlloc and it returns false (meaning we elide the
  // allocation, use CleanupFn instead of DestroyFn).
  DestroyOrCleanupFn = Builder.CreateSelect(CA, DestroyFn, CleanupFn);
}

auto *DestroyAddr = Builder.CreateStructGEP(
    Shape.FrameTy, Shape.FramePtr, coro::Shape::SwitchFieldIndex::Destroy,
    "destroy.addr");
Builder.CreateStore(DestroyOrCleanupFn, DestroyAddr);
1088}

1090static void postSplitCleanup(Function &F) {
removeUnreachableBlocks(F);

// For now, we do a mandatory verification step because we don't
// entirely trust this pass.  Note that we don't want to add a verifier
// pass to FPM below because it will also verify all the global data.
if (verifyFunction(F, &errs()))
  report_fatal_error("Broken function");

legacy::FunctionPassManager FPM(F.getParent());

FPM.add(createSCCPPass());
FPM.add(createCFGSimplificationPass());
FPM.add(createEarlyCSEPass());
FPM.add(createCFGSimplificationPass());

FPM.doInitialization();
FPM.run(F);
FPM.doFinalization();
1109}

1111// Assuming we arrived at the block NewBlock from Prev instruction, store
1112// PHI's incoming values in the ResolvedValues map.
1113static void
1114scanPHIsAndUpdateValueMap(Instruction *Prev, BasicBlock *NewBlock,
                        DenseMap<Value *, Value *> &ResolvedValues) {
auto *PrevBB = Prev->getParent();
for (PHINode &PN : NewBlock->phis()) {
  auto V = PN.getIncomingValueForBlock(PrevBB);
  // See if we already resolved it.
  auto VI = ResolvedValues.find(V);
  if (VI != ResolvedValues.end())
    V = VI->second;
  // Remember the value.
  ResolvedValues[&PN] = V;
}
1126}

1128// Replace a sequence of branches leading to a ret, with a clone of a ret
1129// instruction. Suspend instruction represented by a switch, track the PHI
1130// values and select the correct case successor when possible.
1131static bool simplifyTerminatorLeadingToRet(Instruction *InitialInst) {
DenseMap<Value *, Value *> ResolvedValues;
BasicBlock *UnconditionalSucc = nullptr;

Instruction *I = InitialInst;
while (I->isTerminator() ||
       (isa<CmpInst>(I) && I->getNextNode()->isTerminator())) {
  if (isa<ReturnInst>(I)) {
    if (I != InitialInst) {
      // If InitialInst is an unconditional branch,
      // remove PHI values that come from basic block of InitialInst
      if (UnconditionalSucc)
        UnconditionalSucc->removePredecessor(InitialInst->getParent(), true);
      ReplaceInstWithInst(InitialInst, I->clone());
    }
    return true;
  }
  if (auto *BR = dyn_cast<BranchInst>(I)) {
    if (BR->isUnconditional()) {
      BasicBlock *BB = BR->getSuccessor(0);
      if (I == InitialInst)
        UnconditionalSucc = BB;
      scanPHIsAndUpdateValueMap(I, BB, ResolvedValues);
      I = BB->getFirstNonPHIOrDbgOrLifetime();
      continue;
    }
  } else if (auto *CondCmp = dyn_cast<CmpInst>(I)) {
    auto *BR = dyn_cast<BranchInst>(I->getNextNode());
    if (BR && BR->isConditional() && CondCmp == BR->getCondition()) {
      // If the case number of suspended switch instruction is reduced to
      // 1, then it is simplified to CmpInst in llvm::ConstantFoldTerminator.
      // And the comparsion looks like : %cond = icmp eq i8 %V, constant.
      ConstantInt *CondConst = dyn_cast<ConstantInt>(CondCmp->getOperand(1));
      if (CondConst && CondCmp->getPredicate() == CmpInst::ICMP_EQ) {
        Value *V = CondCmp->getOperand(0);
        auto it = ResolvedValues.find(V);
        if (it != ResolvedValues.end())
          V = it->second;

        if (ConstantInt *Cond0 = dyn_cast<ConstantInt>(V)) {
          BasicBlock *BB = Cond0->equalsInt(CondConst->getZExtValue())
                               ? BR->getSuccessor(0)
                               : BR->getSuccessor(1);
          scanPHIsAndUpdateValueMap(I, BB, ResolvedValues);
          I = BB->getFirstNonPHIOrDbgOrLifetime();
          continue;
        }
      }
    }
  } else if (auto *SI = dyn_cast<SwitchInst>(I)) {
    Value *V = SI->getCondition();
    auto it = ResolvedValues.find(V);
    if (it != ResolvedValues.end())
      V = it->second;
    if (ConstantInt *Cond = dyn_cast<ConstantInt>(V)) {
      BasicBlock *BB = SI->findCaseValue(Cond)->getCaseSuccessor();
      scanPHIsAndUpdateValueMap(I, BB, ResolvedValues);
      I = BB->getFirstNonPHIOrDbgOrLifetime();
      continue;
    }
  }
  return false;
}
return false;
1195}

1197// Check whether CI obeys the rules of musttail attribute.
1198static bool shouldBeMustTail(const CallInst &CI, const Function &F) {
if (CI.isInlineAsm())
  return false;

// Match prototypes and calling conventions of resume function.
FunctionType *CalleeTy = CI.getFunctionType();
if (!CalleeTy->getReturnType()->isVoidTy() || (CalleeTy->getNumParams() != 1))
  return false;

Type *CalleeParmTy = CalleeTy->getParamType(0);
if (!CalleeParmTy->isPointerTy() ||
    (CalleeParmTy->getPointerAddressSpace() != 0))
  return false;

if (CI.getCallingConv() != F.getCallingConv())
  return false;

// CI should not has any ABI-impacting function attributes.
static const Attribute::AttrKind ABIAttrs[] = {
    Attribute::StructRet,    Attribute::ByVal,     Attribute::InAlloca,
    Attribute::Preallocated, Attribute::InReg,     Attribute::Returned,
    Attribute::SwiftSelf,    Attribute::SwiftError};
AttributeList Attrs = CI.getAttributes();
for (auto AK : ABIAttrs)
  if (Attrs.hasParamAttribute(0, AK))
    return false;

return true;
1226}

1228// Add musttail to any resume instructions that is immediately followed by a
1229// suspend (i.e. ret). We do this even in -O0 to support guaranteed tail call
1230// for symmetrical coroutine control transfer (C++ Coroutines TS extension).
1231// This transformation is done only in the resume part of the coroutine that has
1232// identical signature and calling convention as the coro.resume call.
1233static void addMustTailToCoroResumes(Function &F) {
bool changed = false;

// Collect potential resume instructions.
SmallVector<CallInst *, 4> Resumes;
for (auto &I : instructions(F))
  if (auto *Call = dyn_cast<CallInst>(&I))
    if (shouldBeMustTail(*Call, F))
      Resumes.push_back(Call);

// Set musttail on those that are followed by a ret instruction.
for (CallInst *Call : Resumes)
  if (simplifyTerminatorLeadingToRet(Call->getNextNode())) {
    Call->setTailCallKind(CallInst::TCK_MustTail);
    changed = true;
  }

if (changed)
  removeUnreachableBlocks(F);
1252}

1254// Coroutine has no suspend points. Remove heap allocation for the coroutine
1255// frame if possible.
1256static void handleNoSuspendCoroutine(coro::Shape &Shape) {
auto *CoroBegin = Shape.CoroBegin;
auto *CoroId = CoroBegin->getId();
auto *AllocInst = CoroId->getCoroAlloc();
switch (Shape.ABI) {
case coro::ABI::Switch: {
  auto SwitchId = cast<CoroIdInst>(CoroId);
  coro::replaceCoroFree(SwitchId, /*Elide=*/AllocInst != nullptr);
  if (AllocInst) {
    IRBuilder<> Builder(AllocInst);
    auto *Frame = Builder.CreateAlloca(Shape.FrameTy);
    Frame->setAlignment(Shape.FrameAlign);
    auto *VFrame = Builder.CreateBitCast(Frame, Builder.getInt8PtrTy());
    AllocInst->replaceAllUsesWith(Builder.getFalse());
    AllocInst->eraseFromParent();
    CoroBegin->replaceAllUsesWith(VFrame);
  } else {
    CoroBegin->replaceAllUsesWith(CoroBegin->getMem());
  }
  break;
}
case coro::ABI::Async:
case coro::ABI::Retcon:
case coro::ABI::RetconOnce:
  CoroBegin->replaceAllUsesWith(UndefValue::get(CoroBegin->getType()));
  break;
}

CoroBegin->eraseFromParent();
1285}

1287// SimplifySuspendPoint needs to check that there is no calls between
1288// coro_save and coro_suspend, since any of the calls may potentially resume
1289// the coroutine and if that is the case we cannot eliminate the suspend point.
1290static bool hasCallsInBlockBetween(Instruction *From, Instruction *To) {
for (Instruction *I = From; I != To; I = I->getNextNode()) {
  // Assume that no intrinsic can resume the coroutine.
  if (isa<IntrinsicInst>(I))
    continue;

  if (isa<CallBase>(I))
    return true;
}
return false;
1300}

1302static bool hasCallsInBlocksBetween(BasicBlock *SaveBB, BasicBlock *ResDesBB) {
SmallPtrSet<BasicBlock *, 8> Set;
SmallVector<BasicBlock *, 8> Worklist;

Set.insert(SaveBB);
Worklist.push_back(ResDesBB);

// Accumulate all blocks between SaveBB and ResDesBB. Because CoroSaveIntr
// returns a token consumed by suspend instruction, all blocks in between
// will have to eventually hit SaveBB when going backwards from ResDesBB.
while (!Worklist.empty()) {
  auto *BB = Worklist.pop_back_val();
  Set.insert(BB);
  for (auto *Pred : predecessors(BB))
    if (Set.count(Pred) == 0)
      Worklist.push_back(Pred);
}

// SaveBB and ResDesBB are checked separately in hasCallsBetween.
Set.erase(SaveBB);
Set.erase(ResDesBB);

for (auto *BB : Set)
  if (hasCallsInBlockBetween(BB->getFirstNonPHI(), nullptr))
    return true;

return false;
1329}

1331static bool hasCallsBetween(Instruction *Save, Instruction *ResumeOrDestroy) {
auto *SaveBB = Save->getParent();
auto *ResumeOrDestroyBB = ResumeOrDestroy->getParent();

if (SaveBB == ResumeOrDestroyBB)
  return hasCallsInBlockBetween(Save->getNextNode(), ResumeOrDestroy);

// Any calls from Save to the end of the block?
if (hasCallsInBlockBetween(Save->getNextNode(), nullptr))
  return true;

// Any calls from begging of the block up to ResumeOrDestroy?
if (hasCallsInBlockBetween(ResumeOrDestroyBB->getFirstNonPHI(),
                           ResumeOrDestroy))
  return true;

// Any calls in all of the blocks between SaveBB and ResumeOrDestroyBB?
if (hasCallsInBlocksBetween(SaveBB, ResumeOrDestroyBB))
  return true;

return false;
1352}

1354// If a SuspendIntrin is preceded by Resume or Destroy, we can eliminate the
1355// suspend point and replace it with nornal control flow.
1356static bool simplifySuspendPoint(CoroSuspendInst *Suspend,
                               CoroBeginInst *CoroBegin) {
Instruction *Prev = Suspend->getPrevNode();
if (!Prev) {
  auto *Pred = Suspend->getParent()->getSinglePredecessor();
  if (!Pred)
    return false;
  Prev = Pred->getTerminator();
}

CallBase *CB = dyn_cast<CallBase>(Prev);
if (!CB)
  return false;

auto *Callee = CB->getCalledOperand()->stripPointerCasts();

// See if the callsite is for resumption or destruction of the coroutine.
auto *SubFn = dyn_cast<CoroSubFnInst>(Callee);
if (!SubFn)
  return false;

// Does not refer to the current coroutine, we cannot do anything with it.
if (SubFn->getFrame() != CoroBegin)
  return false;

// See if the transformation is safe. Specifically, see if there are any
// calls in between Save and CallInstr. They can potenitally resume the
// coroutine rendering this optimization unsafe.
auto *Save = Suspend->getCoroSave();
if (hasCallsBetween(Save, CB))
  return false;

// Replace llvm.coro.suspend with the value that results in resumption over
// the resume or cleanup path.
Suspend->replaceAllUsesWith(SubFn->getRawIndex());
Suspend->eraseFromParent();
Save->eraseFromParent();

// No longer need a call to coro.resume or coro.destroy.
if (auto *Invoke = dyn_cast<InvokeInst>(CB)) {
  BranchInst::Create(Invoke->getNormalDest(), Invoke);
}

// Grab the CalledValue from CB before erasing the CallInstr.
auto *CalledValue = CB->getCalledOperand();
CB->eraseFromParent();

// If no more users remove it. Usually it is a bitcast of SubFn.
if (CalledValue != SubFn && CalledValue->user_empty())
  if (auto *I = dyn_cast<Instruction>(CalledValue))
    I->eraseFromParent();

// Now we are good to remove SubFn.
if (SubFn->user_empty())
  SubFn->eraseFromParent();

return true;
1413}

1415// Remove suspend points that are simplified.
1416static void simplifySuspendPoints(coro::Shape &Shape) {
// Currently, the only simplification we do is switch-lowering-specific.
if (Shape.ABI != coro::ABI::Switch)
  return;

auto &S = Shape.CoroSuspends;
size_t I = 0, N = S.size();
if (N == 0)
  return;
while (true) {
  auto SI = cast<CoroSuspendInst>(S[I]);
  // Leave final.suspend to handleFinalSuspend since it is undefined behavior
  // to resume a coroutine suspended at the final suspend point.
  if (!SI->isFinal() && simplifySuspendPoint(SI, Shape.CoroBegin)) {
    if (--N == I)
      break;
    std::swap(S[I], S[N]);
    continue;
  }
  if (++I == N)
    break;
}
S.resize(N);
1439}

1441static void splitSwitchCoroutine(Function &F, coro::Shape &Shape,
                               SmallVectorImpl<Function *> &Clones) {
assert(Shape.ABI == coro::ABI::Switch)((Shape.ABI == coro::ABI::Switch) ? static_cast<void> (
0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1443, __PRETTY_FUNCTION__));
17
←
'?' condition is true→

createResumeEntryBlock(F, Shape);
auto ResumeClone = createClone(F, ".resume", Shape,
18
←
Calling 'createClone'→
                               CoroCloner::Kind::SwitchResume);
auto DestroyClone = createClone(F, ".destroy", Shape,
                                CoroCloner::Kind::SwitchUnwind);
auto CleanupClone = createClone(F, ".cleanup", Shape,
                                CoroCloner::Kind::SwitchCleanup);

postSplitCleanup(*ResumeClone);
postSplitCleanup(*DestroyClone);
postSplitCleanup(*CleanupClone);

addMustTailToCoroResumes(*ResumeClone);

// Store addresses resume/destroy/cleanup functions in the coroutine frame.
updateCoroFrame(Shape, ResumeClone, DestroyClone, CleanupClone);

assert(Clones.empty())((Clones.empty()) ? static_cast<void> (0) : __assert_fail
 ("Clones.empty()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1462, __PRETTY_FUNCTION__));
Clones.push_back(ResumeClone);
Clones.push_back(DestroyClone);
Clones.push_back(CleanupClone);

// Create a constant array referring to resume/destroy/clone functions pointed
// by the last argument of @llvm.coro.info, so that CoroElide pass can
// determined correct function to call.
setCoroInfo(F, Shape, Clones);
1471}

1473static void replaceAsyncResumeFunction(CoroSuspendAsyncInst *Suspend,
                                     Value *Continuation) {
auto *ResumeIntrinsic = Suspend->getResumeFunction();
auto &Context = Suspend->getParent()->getParent()->getContext();
auto *Int8PtrTy = Type::getInt8PtrTy(Context);

IRBuilder<> Builder(ResumeIntrinsic);
auto *Val = Builder.CreateBitOrPointerCast(Continuation, Int8PtrTy);
ResumeIntrinsic->replaceAllUsesWith(Val);
ResumeIntrinsic->eraseFromParent();
Suspend->setOperand(CoroSuspendAsyncInst::ResumeFunctionArg,
                    UndefValue::get(Int8PtrTy));
1485}

1487/// Coerce the arguments in \p FnArgs according to \p FnTy in \p CallArgs.
1488static void coerceArguments(IRBuilder<> &Builder, FunctionType *FnTy,
                          ArrayRef<Value *> FnArgs,
                          SmallVectorImpl<Value *> &CallArgs) {
size_t ArgIdx = 0;
for (auto paramTy : FnTy->params()) {
  assert(ArgIdx < FnArgs.size())((ArgIdx < FnArgs.size()) ? static_cast<void> (0) : __assert_fail
 ("ArgIdx < FnArgs.size()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1493, __PRETTY_FUNCTION__));
  if (paramTy != FnArgs[ArgIdx]->getType())
    CallArgs.push_back(
        Builder.CreateBitOrPointerCast(FnArgs[ArgIdx], paramTy));
  else
    CallArgs.push_back(FnArgs[ArgIdx]);
  ++ArgIdx;
}
1501}

1503CallInst *coro::createMustTailCall(DebugLoc Loc, Function *MustTailCallFn,
                                 ArrayRef<Value *> Arguments,
                                 IRBuilder<> &Builder) {
auto *FnTy =
    cast<FunctionType>(MustTailCallFn->getType()->getPointerElementType());
// Coerce the arguments, llvm optimizations seem to ignore the types in
// vaarg functions and throws away casts in optimized mode.
SmallVector<Value *, 8> CallArgs;
coerceArguments(Builder, FnTy, Arguments, CallArgs);

auto *TailCall = Builder.CreateCall(FnTy, MustTailCallFn, CallArgs);
TailCall->setTailCallKind(CallInst::TCK_MustTail);
TailCall->setDebugLoc(Loc);
TailCall->setCallingConv(MustTailCallFn->getCallingConv());
return TailCall;
1518}

1520static void splitAsyncCoroutine(Function &F, coro::Shape &Shape,
                              SmallVectorImpl<Function *> &Clones) {
assert(Shape.ABI == coro::ABI::Async)((Shape.ABI == coro::ABI::Async) ? static_cast<void> (0
) : __assert_fail ("Shape.ABI == coro::ABI::Async", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1522, __PRETTY_FUNCTION__));
assert(Clones.empty())((Clones.empty()) ? static_cast<void> (0) : __assert_fail
 ("Clones.empty()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1523, __PRETTY_FUNCTION__));
// Reset various things that the optimizer might have decided it
// "knows" about the coroutine function due to not seeing a return.
F.removeFnAttr(Attribute::NoReturn);
F.removeAttribute(AttributeList::ReturnIndex, Attribute::NoAlias);
F.removeAttribute(AttributeList::ReturnIndex, Attribute::NonNull);

auto &Context = F.getContext();
auto *Int8PtrTy = Type::getInt8PtrTy(Context);

auto *Id = cast<CoroIdAsyncInst>(Shape.CoroBegin->getId());
IRBuilder<> Builder(Id);

auto *FramePtr = Id->getStorage();
FramePtr = Builder.CreateBitOrPointerCast(FramePtr, Int8PtrTy);
FramePtr = Builder.CreateConstInBoundsGEP1_32(
    Type::getInt8Ty(Context), FramePtr, Shape.AsyncLowering.FrameOffset,
    "async.ctx.frameptr");

// Map all uses of llvm.coro.begin to the allocated frame pointer.
{
  // Make sure we don't invalidate Shape.FramePtr.
  TrackingVH<Instruction> Handle(Shape.FramePtr);
  Shape.CoroBegin->replaceAllUsesWith(FramePtr);
  Shape.FramePtr = Handle.getValPtr();
}

// Create all the functions in order after the main function.
auto NextF = std::next(F.getIterator());

// Create a continuation function for each of the suspend points.
Clones.reserve(Shape.CoroSuspends.size());
for (size_t Idx = 0, End = Shape.CoroSuspends.size(); Idx != End; ++Idx) {
  auto *Suspend = cast<CoroSuspendAsyncInst>(Shape.CoroSuspends[Idx]);

  // Create the clone declaration.
  auto *Continuation = createCloneDeclaration(
      F, Shape, ".resume." + Twine(Idx), NextF, Suspend);
  Clones.push_back(Continuation);

  // Insert a branch to a new return block immediately before the suspend
  // point.
  auto *SuspendBB = Suspend->getParent();
  auto *NewSuspendBB = SuspendBB->splitBasicBlock(Suspend);
  auto *Branch = cast<BranchInst>(SuspendBB->getTerminator());

  // Place it before the first suspend.
  auto *ReturnBB =
      BasicBlock::Create(F.getContext(), "coro.return", &F, NewSuspendBB);
  Branch->setSuccessor(0, ReturnBB);

  IRBuilder<> Builder(ReturnBB);

  // Insert the call to the tail call function and inline it.
  auto *Fn = Suspend->getMustTailCallFunction();
  SmallVector<Value *, 8> Args(Suspend->args());
  auto FnArgs = ArrayRef<Value *>(Args).drop_front(
      CoroSuspendAsyncInst::MustTailCallFuncArg + 1);
  auto *TailCall =
      coro::createMustTailCall(Suspend->getDebugLoc(), Fn, FnArgs, Builder);
  Builder.CreateRetVoid();
  InlineFunctionInfo FnInfo;
  auto InlineRes = InlineFunction(*TailCall, FnInfo);
  assert(InlineRes.isSuccess() && "Expected inlining to succeed")((InlineRes.isSuccess() && "Expected inlining to succeed"
) ? static_cast<void> (0) : __assert_fail ("InlineRes.isSuccess() && \"Expected inlining to succeed\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1586, __PRETTY_FUNCTION__));
  (void)InlineRes;

  // Replace the lvm.coro.async.resume intrisic call.
  replaceAsyncResumeFunction(Suspend, Continuation);
}

assert(Clones.size() == Shape.CoroSuspends.size())((Clones.size() == Shape.CoroSuspends.size()) ? static_cast<
void> (0) : __assert_fail ("Clones.size() == Shape.CoroSuspends.size()"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1593, __PRETTY_FUNCTION__));
for (size_t Idx = 0, End = Shape.CoroSuspends.size(); Idx != End; ++Idx) {
  auto *Suspend = Shape.CoroSuspends[Idx];
  auto *Clone = Clones[Idx];

  CoroCloner(F, "resume." + Twine(Idx), Shape, Clone, Suspend).create();
}
1600}

1602static void splitRetconCoroutine(Function &F, coro::Shape &Shape,
                               SmallVectorImpl<Function *> &Clones) {
assert(Shape.ABI == coro::ABI::Retcon ||((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
) ? static_cast<void> (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1605, __PRETTY_FUNCTION__))
       Shape.ABI == coro::ABI::RetconOnce)((Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce
) ? static_cast<void> (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1605, __PRETTY_FUNCTION__));
assert(Clones.empty())((Clones.empty()) ? static_cast<void> (0) : __assert_fail
 ("Clones.empty()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1606, __PRETTY_FUNCTION__));

// Reset various things that the optimizer might have decided it
// "knows" about the coroutine function due to not seeing a return.
F.removeFnAttr(Attribute::NoReturn);
F.removeAttribute(AttributeList::ReturnIndex, Attribute::NoAlias);
F.removeAttribute(AttributeList::ReturnIndex, Attribute::NonNull);

// Allocate the frame.
auto *Id = cast<AnyCoroIdRetconInst>(Shape.CoroBegin->getId());
Value *RawFramePtr;
if (Shape.RetconLowering.IsFrameInlineInStorage) {
  RawFramePtr = Id->getStorage();
} else {
  IRBuilder<> Builder(Id);

  // Determine the size of the frame.
  const DataLayout &DL = F.getParent()->getDataLayout();
  auto Size = DL.getTypeAllocSize(Shape.FrameTy);

  // Allocate.  We don't need to update the call graph node because we're
  // going to recompute it from scratch after splitting.
  // FIXME: pass the required alignment
  RawFramePtr = Shape.emitAlloc(Builder, Builder.getInt64(Size), nullptr);
  RawFramePtr =
    Builder.CreateBitCast(RawFramePtr, Shape.CoroBegin->getType());

  // Stash the allocated frame pointer in the continuation storage.
  auto Dest = Builder.CreateBitCast(Id->getStorage(),
                                    RawFramePtr->getType()->getPointerTo());
  Builder.CreateStore(RawFramePtr, Dest);
}

// Map all uses of llvm.coro.begin to the allocated frame pointer.
{
  // Make sure we don't invalidate Shape.FramePtr.
  TrackingVH<Instruction> Handle(Shape.FramePtr);
  Shape.CoroBegin->replaceAllUsesWith(RawFramePtr);
  Shape.FramePtr = Handle.getValPtr();
}

// Create a unique return block.
BasicBlock *ReturnBB = nullptr;
SmallVector<PHINode *, 4> ReturnPHIs;

// Create all the functions in order after the main function.
auto NextF = std::next(F.getIterator());

// Create a continuation function for each of the suspend points.
Clones.reserve(Shape.CoroSuspends.size());
for (size_t i = 0, e = Shape.CoroSuspends.size(); i != e; ++i) {
  auto Suspend = cast<CoroSuspendRetconInst>(Shape.CoroSuspends[i]);

  // Create the clone declaration.
  auto Continuation =
      createCloneDeclaration(F, Shape, ".resume." + Twine(i), NextF, nullptr);
  Clones.push_back(Continuation);

  // Insert a branch to the unified return block immediately before
  // the suspend point.
  auto SuspendBB = Suspend->getParent();
  auto NewSuspendBB = SuspendBB->splitBasicBlock(Suspend);
  auto Branch = cast<BranchInst>(SuspendBB->getTerminator());

  // Create the unified return block.
  if (!ReturnBB) {
    // Place it before the first suspend.
    ReturnBB = BasicBlock::Create(F.getContext(), "coro.return", &F,
                                  NewSuspendBB);
    Shape.RetconLowering.ReturnBlock = ReturnBB;

    IRBuilder<> Builder(ReturnBB);

    // Create PHIs for all the return values.
    assert(ReturnPHIs.empty())((ReturnPHIs.empty()) ? static_cast<void> (0) : __assert_fail
 ("ReturnPHIs.empty()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1680, __PRETTY_FUNCTION__));

    // First, the continuation.
    ReturnPHIs.push_back(Builder.CreatePHI(Continuation->getType(),
                                           Shape.CoroSuspends.size()));

    // Next, all the directly-yielded values.
    for (auto ResultTy : Shape.getRetconResultTypes())
      ReturnPHIs.push_back(Builder.CreatePHI(ResultTy,
                                             Shape.CoroSuspends.size()));

    // Build the return value.
    auto RetTy = F.getReturnType();

    // Cast the continuation value if necessary.
    // We can't rely on the types matching up because that type would
    // have to be infinite.
    auto CastedContinuationTy =
      (ReturnPHIs.size() == 1 ? RetTy : RetTy->getStructElementType(0));
    auto *CastedContinuation =
      Builder.CreateBitCast(ReturnPHIs[0], CastedContinuationTy);

    Value *RetV;
    if (ReturnPHIs.size() == 1) {
      RetV = CastedContinuation;
    } else {
      RetV = UndefValue::get(RetTy);
      RetV = Builder.CreateInsertValue(RetV, CastedContinuation, 0);
      for (size_t I = 1, E = ReturnPHIs.size(); I != E; ++I)
        RetV = Builder.CreateInsertValue(RetV, ReturnPHIs[I], I);
    }

    Builder.CreateRet(RetV);
  }

  // Branch to the return block.
  Branch->setSuccessor(0, ReturnBB);
  ReturnPHIs[0]->addIncoming(Continuation, SuspendBB);
  size_t NextPHIIndex = 1;
  for (auto &VUse : Suspend->value_operands())
    ReturnPHIs[NextPHIIndex++]->addIncoming(&*VUse, SuspendBB);
  assert(NextPHIIndex == ReturnPHIs.size())((NextPHIIndex == ReturnPHIs.size()) ? static_cast<void>
 (0) : __assert_fail ("NextPHIIndex == ReturnPHIs.size()", "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1721, __PRETTY_FUNCTION__));
}

assert(Clones.size() == Shape.CoroSuspends.size())((Clones.size() == Shape.CoroSuspends.size()) ? static_cast<
void> (0) : __assert_fail ("Clones.size() == Shape.CoroSuspends.size()"
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1724, __PRETTY_FUNCTION__));
for (size_t i = 0, e = Shape.CoroSuspends.size(); i != e; ++i) {
  auto Suspend = Shape.CoroSuspends[i];
  auto Clone = Clones[i];

  CoroCloner(F, "resume." + Twine(i), Shape, Clone, Suspend).create();
}
1731}

1733namespace {
class PrettyStackTraceFunction : public PrettyStackTraceEntry {
  Function &F;
public:
  PrettyStackTraceFunction(Function &F) : F(F) {}
  void print(raw_ostream &OS) const override {
    OS << "While splitting coroutine ";
    F.printAsOperand(OS, /*print type*/ false, F.getParent());
    OS << "\n";
  }
};
1744}

1746static coro::Shape splitCoroutine(Function &F,
                                SmallVectorImpl<Function *> &Clones,
                                bool ReuseFrameSlot) {
PrettyStackTraceFunction prettyStackTrace(F);

// The suspend-crossing algorithm in buildCoroutineFrame get tripped
// up by uses in unreachable blocks, so remove them as a first pass.
removeUnreachableBlocks(F);

coro::Shape Shape(F, ReuseFrameSlot);
if (!Shape.CoroBegin)
12
←
Assuming field 'CoroBegin' is non-null→
13
←
Taking false branch→
  return Shape;

simplifySuspendPoints(Shape);
buildCoroutineFrame(F, Shape);
replaceFrameSize(Shape);

// If there are no suspend points, no split required, just remove
// the allocation and deallocation blocks, they are not needed.
if (Shape.CoroSuspends.empty()) {
14
←
Taking false branch→
  handleNoSuspendCoroutine(Shape);
} else {
  switch (Shape.ABI) {
15
←
Control jumps to 'case Switch:'  at line 1769→
  case coro::ABI::Switch:
    splitSwitchCoroutine(F, Shape, Clones);
16
←
Calling 'splitSwitchCoroutine'→
    break;
  case coro::ABI::Async:
    splitAsyncCoroutine(F, Shape, Clones);
    break;
  case coro::ABI::Retcon:
  case coro::ABI::RetconOnce:
    splitRetconCoroutine(F, Shape, Clones);
    break;
  }
}

// Replace all the swifterror operations in the original function.
// This invalidates SwiftErrorOps in the Shape.
replaceSwiftErrorOps(F, Shape, nullptr);

return Shape;
1787}

1789static void
1790updateCallGraphAfterCoroutineSplit(Function &F, const coro::Shape &Shape,
                                 const SmallVectorImpl<Function *> &Clones,
                                 CallGraph &CG, CallGraphSCC &SCC) {
if (!Shape.CoroBegin)
  return;

removeCoroEnds(Shape, &CG);
postSplitCleanup(F);

// Update call graph and add the functions we created to the SCC.
coro::updateCallGraph(F, Clones, CG, SCC);
1801}

1803static void updateCallGraphAfterCoroutineSplit(
  LazyCallGraph::Node &N, const coro::Shape &Shape,
  const SmallVectorImpl<Function *> &Clones, LazyCallGraph::SCC &C,
  LazyCallGraph &CG, CGSCCAnalysisManager &AM, CGSCCUpdateResult &UR,
  FunctionAnalysisManager &FAM) {
if (!Shape.CoroBegin)
  return;

for (llvm::AnyCoroEndInst *End : Shape.CoroEnds) {
  auto &Context = End->getContext();
  End->replaceAllUsesWith(ConstantInt::getFalse(Context));
  End->eraseFromParent();
}

if (!Clones.empty()) {
  switch (Shape.ABI) {
  case coro::ABI::Switch:
    // Each clone in the Switch lowering is independent of the other clones.
    // Let the LazyCallGraph know about each one separately.
    for (Function *Clone : Clones)
      CG.addSplitFunction(N.getFunction(), *Clone);
    break;
  case coro::ABI::Async:
  case coro::ABI::Retcon:
  case coro::ABI::RetconOnce:
    // Each clone in the Async/Retcon lowering references of the other clones.
    // Let the LazyCallGraph know about all of them at once.
    if (!Clones.empty())
      CG.addSplitRefRecursiveFunctions(N.getFunction(), Clones);
    break;
  }

  // Let the CGSCC infra handle the changes to the original function.
  updateCGAndAnalysisManagerForCGSCCPass(CG, C, N, AM, UR, FAM);
}

// Do some cleanup and let the CGSCC infra see if we've cleaned up any edges
// to the split functions.
postSplitCleanup(N.getFunction());
updateCGAndAnalysisManagerForFunctionPass(CG, C, N, AM, UR, FAM);
1843}

1845// When we see the coroutine the first time, we insert an indirect call to a
1846// devirt trigger function and mark the coroutine that it is now ready for
1847// split.
1848// Async lowering uses this after it has split the function to restart the
1849// pipeline.
1850static void prepareForSplit(Function &F, CallGraph &CG,
                          bool MarkForAsyncRestart = false) {
Module &M = *F.getParent();
LLVMContext &Context = F.getContext();
1854#ifndef NDEBUG
Function *DevirtFn = M.getFunction(CORO_DEVIRT_TRIGGER_FN"coro.devirt.trigger");
assert(DevirtFn && "coro.devirt.trigger function not found")((DevirtFn && "coro.devirt.trigger function not found"
) ? static_cast<void> (0) : __assert_fail ("DevirtFn && \"coro.devirt.trigger function not found\""
, "/build/llvm-toolchain-snapshot-13~++20210308111132+66e3a4abe99c/llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1856, __PRETTY_FUNCTION__));
1857#endif

F.addFnAttr(CORO_PRESPLIT_ATTR"coroutine.presplit", MarkForAsyncRestart
                                    ? ASYNC_RESTART_AFTER_SPLIT"2"
                                    : PREPARED_FOR_SPLIT"1");

// Insert an indirect call sequence that will be devirtualized by CoroElide
// pass:
//    %0 = call i8* @llvm.coro.subfn.addr(i8* null, i8 -1)
//    %1 = bitcast i8* %0 to void(i8*)*
//    call void %1(i8* null)
coro::LowererBase Lowerer(M);
Instruction *InsertPt =
    MarkForAsyncRestart ? F.getEntryBlock().getFirstNonPHIOrDbgOrLifetime()
                        : F.getEntryBlock().getTerminator();
auto *Null = ConstantPointerNull::get(Type::getInt8PtrTy(Context));
auto *DevirtFnAddr =
    Lowerer.makeSubFnCall(Null, CoroSubFnInst::RestartTrigger, InsertPt);
FunctionType *FnTy = FunctionType::get(Type::getVoidTy(Context),
                                       {Type::getInt8PtrTy(Context)}, false);
auto *IndirectCall = CallInst::Create(FnTy, DevirtFnAddr, Null, "", InsertPt);

// Update CG graph with an indirect call we just added.
CG[&F]->addCalledFunction(IndirectCall, CG.getCallsExternalNode());
1881}

1883// Make sure that there is a devirtualization trigger function that the
1884// coro-split pass uses to force a restart of the CGSCC pipeline. If the devirt
1885// trigger function is not found, we will create one and add it to the current
1886// SCC.
1887static void createDevirtTriggerFunc(CallGraph &CG, CallGraphSCC &SCC) {
Module &M = CG.getModule();
if (M.getFunction(CORO_DEVIRT_TRIGGER_FN"coro.devirt.trigger"))
  return;

LLVMContext &C = M.getContext();
auto *FnTy = FunctionType::get(Type::getVoidTy(C), Type::getInt8PtrTy(C),
                               /*isVarArg=*/false);
Function *DevirtFn =
    Function::Create(FnTy, GlobalValue::LinkageTypes::PrivateLinkage,
                     CORO_DEVIRT_TRIGGER_FN"coro.devirt.trigger", &M);
DevirtFn->addFnAttr(Attribute::AlwaysInline);
auto *Entry = BasicBlock::Create(C, "entry", DevirtFn);
ReturnInst::Create(C, Entry);

auto *Node = CG.getOrInsertFunction(DevirtFn);

SmallVector<CallGraphNode *, 8> Nodes(SCC.begin(), SCC.end());
Nodes.push_back(Node);
SCC.initialize(Nodes);
1907}

1909/// Replace a call to llvm.coro.prepare.retcon.
1910static void replacePrepare(CallInst *Prepare, LazyCallGraph &CG,
                         LazyCallGraph::SCC &C) {
auto CastFn = Prepare->getArgOperand(0); // as an i8*
auto Fn = CastFn->stripPointerCasts();   // as its original type

// Attempt to peephole this pattern:
//    %0 = bitcast [[TYPE]] @some_function to i8*
//    %1 = call @llvm.coro.prepare.retcon(i8* %0)
//    %2 = bitcast %1 to [[TYPE]]
// ==>
//    %2 = @some_function
for (auto UI = Prepare->use_begin(), UE = Prepare->use_end(); UI != UE;) {
  // Look for bitcasts back to the original function type.
  auto *Cast = dyn_cast<BitCastInst>((UI++)->getUser());
  if (!Cast || Cast->getType() != Fn->getType())
    continue;

  // Replace and remove the cast.
  Cast->replaceAllUsesWith(Fn);
  Cast->eraseFromParent();
}

// Replace any remaining uses with the function as an i8*.
// This can never directly be a callee, so we don't need to update CG.
Prepare->replaceAllUsesWith(CastFn);
Prepare->eraseFromParent();

// Kill dead bitcasts.
while (auto *Cast = dyn_cast<BitCastInst>(CastFn)) {
  if (!Cast->use_empty())
    break;
  CastFn = Cast->getOperand(0);
  Cast->eraseFromParent();
}
1944}
1945/// Replace a call to llvm.coro.prepare.retcon.
1946static void replacePrepare(CallInst *Prepare, CallGraph &CG) {
auto CastFn = Prepare->getArgOperand(0); // as an i8*
auto Fn = CastFn->stripPointerCasts(); // as its original type

// Find call graph nodes for the preparation.
CallGraphNode *PrepareUserNode = nullptr, *FnNode = nullptr;
if (auto ConcreteFn = dyn_cast<Function>(Fn)) {
  PrepareUserNode = CG[Prepare->getFunction()];
  FnNode = CG[ConcreteFn];
}

// Attempt to peephole this pattern:
//    %0 = bitcast [[TYPE]] @some_function to i8*
//    %1 = call @llvm.coro.prepare.retcon(i8* %0)
//    %2 = bitcast %1 to [[TYPE]]
// ==>
//    %2 = @some_function
for (auto UI = Prepare->use_begin(), UE = Prepare->use_end();
       UI != UE; ) {
  // Look for bitcasts back to the original function type.
  auto *Cast = dyn_cast<BitCastInst>((UI++)->getUser());
  if (!Cast || Cast->getType() != Fn->getType()) continue;

  // Check whether the replacement will introduce new direct calls.
  // If so, we'll need to update the call graph.
  if (PrepareUserNode) {
    for (auto &Use : Cast->uses()) {
      if (auto *CB = dyn_cast<CallBase>(Use.getUser())) {
        if (!CB->isCallee(&Use))
          continue;
        PrepareUserNode->removeCallEdgeFor(*CB);
        PrepareUserNode->addCalledFunction(CB, FnNode);
      }
    }
  }

  // Replace and remove the cast.
  Cast->replaceAllUsesWith(Fn);
  Cast->eraseFromParent();
}

// Replace any remaining uses with the function as an i8*.
// This can never directly be a callee, so we don't need to update CG.
Prepare->replaceAllUsesWith(CastFn);
Prepare->eraseFromParent();

// Kill dead bitcasts.
while (auto *Cast = dyn_cast<BitCastInst>(CastFn)) {
  if (!Cast->use_empty()) break;
  CastFn = Cast->getOperand(0);
  Cast->eraseFromParent();
}
1998}

2000static bool replaceAllPrepares(Function *PrepareFn, LazyCallGraph &CG,
                             LazyCallGraph::SCC &C) {
bool Changed = false;
for (auto PI = PrepareFn->use_begin(), PE = PrepareFn->use_end(); PI != PE;) {
  // Intrinsics can only be used in calls.
  auto *Prepare = cast<CallInst>((PI++)->getUser());
  replacePrepare(Prepare, CG, C);
  Changed = true;
}

return Changed;
2011}

2013/// Remove calls to llvm.coro.prepare.retcon, a barrier meant to prevent
2014/// IPO from operating on calls to a retcon coroutine before it's been
2015/// split.  This is only safe to do after we've split all retcon
2016/// coroutines in the module.  We can do that this in this pass because
2017/// this pass does promise to split all retcon coroutines (as opposed to
2018/// switch coroutines, which are lowered in multiple stages).
2019static bool replaceAllPrepares(Function *PrepareFn, CallGraph &CG) {
bool Changed = false;
for (auto PI = PrepareFn->use_begin(), PE = PrepareFn->use_end();
       PI != PE; ) {
  // Intrinsics can only be used in calls.
  auto *Prepare = cast<CallInst>((PI++)->getUser());
  replacePrepare(Prepare, CG);
  Changed = true;
}

return Changed;
2030}

2032static bool declaresCoroSplitIntrinsics(const Module &M) {
return coro::declaresIntrinsics(M, {"llvm.coro.begin",
                                    "llvm.coro.prepare.retcon",
                                    "llvm.coro.prepare.async"});
2036}

2038static void addPrepareFunction(const Module &M,
                             SmallVectorImpl<Function *> &Fns,
                             StringRef Name) {
auto *PrepareFn = M.getFunction(Name);
if (PrepareFn && !PrepareFn->use_empty())
  Fns.push_back(PrepareFn);
2044}

2046PreservedAnalyses CoroSplitPass::run(LazyCallGraph::SCC &C,
                                   CGSCCAnalysisManager &AM,
                                   LazyCallGraph &CG, CGSCCUpdateResult &UR) {
// NB: One invariant of a valid LazyCallGraph::SCC is that it must contain a
//     non-zero number of nodes, so we assume that here and grab the first
//     node's function's module.
Module &M = *C.begin()->getFunction().getParent();
auto &FAM =
    AM.getResult<FunctionAnalysisManagerCGSCCProxy>(C, CG).getManager();

if (!declaresCoroSplitIntrinsics(M))
  return PreservedAnalyses::all();

// Check for uses of llvm.coro.prepare.retcon/async.
SmallVector<Function *, 2> PrepareFns;
addPrepareFunction(M, PrepareFns, "llvm.coro.prepare.retcon");
addPrepareFunction(M, PrepareFns, "llvm.coro.prepare.async");

// Find coroutines for processing.
SmallVector<LazyCallGraph::Node *, 4> Coroutines;
for (LazyCallGraph::Node &N : C)
  if (N.getFunction().hasFnAttribute(CORO_PRESPLIT_ATTR"coroutine.presplit"))
    Coroutines.push_back(&N);

if (Coroutines.empty() && PrepareFns.empty())
  return PreservedAnalyses::all();

if (Coroutines.empty()) {
  for (auto *PrepareFn : PrepareFns) {
    replaceAllPrepares(PrepareFn, CG, C);
  }
}

// Split all the coroutines.
for (LazyCallGraph::Node *N : Coroutines) {
  Function &F = N->getFunction();
  Attribute Attr = F.getFnAttribute(CORO_PRESPLIT_ATTR"coroutine.presplit");
  StringRef Value = Attr.getValueAsString();
  LLVM_DEBUG(dbgs() << "CoroSplit: Processing coroutine '" << F.getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("coro-split")) { dbgs() << "CoroSplit: Processing coroutine '"
 << F.getName() << "' state: " << Value <<
 "\n"; } } while (false)
                    << "' state: " << Value << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("coro-split")) { dbgs() << "CoroSplit: Processing coroutine '"
 << F.getName() << "' state: " << Value <<
 "\n"; } } while (false);
  if (Value == UNPREPARED_FOR_SPLIT"0") {
    // Enqueue a second iteration of the CGSCC pipeline on this SCC.
    UR.CWorklist.insert(&C);
    F.addFnAttr(CORO_PRESPLIT_ATTR"coroutine.presplit", PREPARED_FOR_SPLIT"1");
    continue;
  }
  F.removeFnAttr(CORO_PRESPLIT_ATTR"coroutine.presplit");

  SmallVector<Function *, 4> Clones;
  const coro::Shape Shape = splitCoroutine(F, Clones, ReuseFrameSlot);
  updateCallGraphAfterCoroutineSplit(*N, Shape, Clones, C, CG, AM, UR, FAM);

  if ((Shape.ABI == coro::ABI::Async || Shape.ABI == coro::ABI::Retcon ||
       Shape.ABI == coro::ABI::RetconOnce) &&
      !Shape.CoroSuspends.empty()) {
    // Run the CGSCC pipeline on the newly split functions.
    // All clones will be in the same RefSCC, so choose a random clone.
    UR.RCWorklist.insert(CG.lookupRefSCC(CG.get(*Clones[0])));
  }
}

if (!PrepareFns.empty()) {
  for (auto *PrepareFn : PrepareFns) {
    replaceAllPrepares(PrepareFn, CG, C);
  }
}

return PreservedAnalyses::none();
2114}

2116namespace {

2118// We present a coroutine to LLVM as an ordinary function with suspension
2119// points marked up with intrinsics. We let the optimizer party on the coroutine
2120// as a single function for as long as possible. Shortly before the coroutine is
2121// eligible to be inlined into its callers, we split up the coroutine into parts
2122// corresponding to initial, resume and destroy invocations of the coroutine,
2123// add them to the current SCC and restart the IPO pipeline to optimize the
2124// coroutine subfunctions we extracted before proceeding to the caller of the
2125// coroutine.
2126struct CoroSplitLegacy : public CallGraphSCCPass {
static char ID; // Pass identification, replacement for typeid

CoroSplitLegacy(bool ReuseFrameSlot = false)
    : CallGraphSCCPass(ID), ReuseFrameSlot(ReuseFrameSlot) {
  initializeCoroSplitLegacyPass(*PassRegistry::getPassRegistry());
}

bool Run = false;
bool ReuseFrameSlot;

// A coroutine is identified by the presence of coro.begin intrinsic, if
// we don't have any, this pass has nothing to do.
bool doInitialization(CallGraph &CG) override {
  Run = declaresCoroSplitIntrinsics(CG.getModule());
  return CallGraphSCCPass::doInitialization(CG);
}

bool runOnSCC(CallGraphSCC &SCC) override {
  if (!Run)
1
Assuming field 'Run' is true→
2
←
Taking false branch→
    return false;

  // Check for uses of llvm.coro.prepare.retcon.
  SmallVector<Function *, 2> PrepareFns;
  auto &M = SCC.getCallGraph().getModule();
  addPrepareFunction(M, PrepareFns, "llvm.coro.prepare.retcon");
  addPrepareFunction(M, PrepareFns, "llvm.coro.prepare.async");

  // Find coroutines for processing.
  SmallVector<Function *, 4> Coroutines;
  for (CallGraphNode *CGN : SCC)
    if (auto *F = CGN->getFunction())
      if (F->hasFnAttribute(CORO_PRESPLIT_ATTR"coroutine.presplit"))
        Coroutines.push_back(F);

  if (Coroutines.empty() && PrepareFns.empty())
    return false;

  CallGraph &CG = getAnalysis<CallGraphWrapperPass>().getCallGraph();

  if (Coroutines.empty()) {
3
←
Taking false branch→
    bool Changed = false;
    for (auto *PrepareFn : PrepareFns)
      Changed |= replaceAllPrepares(PrepareFn, CG);
    return Changed;
  }

  createDevirtTriggerFunc(CG, SCC);

  // Split all the coroutines.
  for (Function *F : Coroutines) {
4
←
Assuming '__begin2' is not equal to '__end2'→
    Attribute Attr = F->getFnAttribute(CORO_PRESPLIT_ATTR"coroutine.presplit");
    StringRef Value = Attr.getValueAsString();
    LLVM_DEBUG(dbgs() << "CoroSplit: Processing coroutine '" << F->getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("coro-split")) { dbgs() << "CoroSplit: Processing coroutine '"
 << F->getName() << "' state: " << Value
 << "\n"; } } while (false)
5
←
Assuming 'DebugFlag' is false→
6
←
Loop condition is false.  Exiting loop→
                      << "' state: " << Value << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("coro-split")) { dbgs() << "CoroSplit: Processing coroutine '"
 << F->getName() << "' state: " << Value
 << "\n"; } } while (false);
    // Async lowering marks coroutines to trigger a restart of the pipeline
    // after it has split them.
    if (Value == ASYNC_RESTART_AFTER_SPLIT"2") {
7
←
Assuming the condition is false→
8
←
Taking false branch→
      F->removeFnAttr(CORO_PRESPLIT_ATTR"coroutine.presplit");
      continue;
    }
    if (Value == UNPREPARED_FOR_SPLIT"0") {
9
←
Assuming the condition is false→
10
←
Taking false branch→
      prepareForSplit(*F, CG);
      continue;
    }
    F->removeFnAttr(CORO_PRESPLIT_ATTR"coroutine.presplit");

    SmallVector<Function *, 4> Clones;
    const coro::Shape Shape = splitCoroutine(*F, Clones, ReuseFrameSlot);
11
←
Calling 'splitCoroutine'→
    updateCallGraphAfterCoroutineSplit(*F, Shape, Clones, CG, SCC);
    if (Shape.ABI == coro::ABI::Async) {
      // Restart SCC passes.
      // Mark function for CoroElide pass. It will devirtualize causing a
      // restart of the SCC pipeline.
      prepareForSplit(*F, CG, true /*MarkForAsyncRestart*/);
    }
  }

  for (auto *PrepareFn : PrepareFns)
    replaceAllPrepares(PrepareFn, CG);

  return true;
}

void getAnalysisUsage(AnalysisUsage &AU) const override {
  CallGraphSCCPass::getAnalysisUsage(AU);
}

StringRef getPassName() const override { return "Coroutine Splitting"; }
2215};

2217} // end anonymous namespace

2219char CoroSplitLegacy::ID = 0;

2221INITIALIZE_PASS_BEGIN(static void *initializeCoroSplitLegacyPassOnce(PassRegistry &
Registry) {
  CoroSplitLegacy, "coro-split",static void *initializeCoroSplitLegacyPassOnce(PassRegistry &
Registry) {
  "Split coroutine into a set of functions driving its state machine", false,static void *initializeCoroSplitLegacyPassOnce(PassRegistry &
Registry) {
  false)static void *initializeCoroSplitLegacyPassOnce(PassRegistry &
Registry) {
2225INITIALIZE_PASS_DEPENDENCY(CallGraphWrapperPass)initializeCallGraphWrapperPassPass(Registry);
2226INITIALIZE_PASS_END(PassInfo *PI = new PassInfo( "Split coroutine into a set of functions driving its state machine"
, "coro-split", &CoroSplitLegacy::ID, PassInfo::NormalCtor_t
(callDefaultCtor<CoroSplitLegacy>), false, false); Registry
.registerPass(*PI, true); return PI; } static llvm::once_flag
 InitializeCoroSplitLegacyPassFlag; void llvm::initializeCoroSplitLegacyPass
(PassRegistry &Registry) { llvm::call_once(InitializeCoroSplitLegacyPassFlag
, initializeCoroSplitLegacyPassOnce, std::ref(Registry)); }
  CoroSplitLegacy, "coro-split",PassInfo *PI = new PassInfo( "Split coroutine into a set of functions driving its state machine"
, "coro-split", &CoroSplitLegacy::ID, PassInfo::NormalCtor_t
(callDefaultCtor<CoroSplitLegacy>), false, false); Registry
.registerPass(*PI, true); return PI; } static llvm::once_flag
 InitializeCoroSplitLegacyPassFlag; void llvm::initializeCoroSplitLegacyPass
(PassRegistry &Registry) { llvm::call_once(InitializeCoroSplitLegacyPassFlag
, initializeCoroSplitLegacyPassOnce, std::ref(Registry)); }
  "Split coroutine into a set of functions driving its state machine", false,PassInfo *PI = new PassInfo( "Split coroutine into a set of functions driving its state machine"
, "coro-split", &CoroSplitLegacy::ID, PassInfo::NormalCtor_t
(callDefaultCtor<CoroSplitLegacy>), false, false); Registry
.registerPass(*PI, true); return PI; } static llvm::once_flag
 InitializeCoroSplitLegacyPassFlag; void llvm::initializeCoroSplitLegacyPass
(PassRegistry &Registry) { llvm::call_once(InitializeCoroSplitLegacyPassFlag
, initializeCoroSplitLegacyPassOnce, std::ref(Registry)); }
  false)PassInfo *PI = new PassInfo( "Split coroutine into a set of functions driving its state machine"
, "coro-split", &CoroSplitLegacy::ID, PassInfo::NormalCtor_t
(callDefaultCtor<CoroSplitLegacy>), false, false); Registry
.registerPass(*PI, true); return PI; } static llvm::once_flag
 InitializeCoroSplitLegacyPassFlag; void llvm::initializeCoroSplitLegacyPass
(PassRegistry &Registry) { llvm::call_once(InitializeCoroSplitLegacyPassFlag
, initializeCoroSplitLegacyPassOnce, std::ref(Registry)); }

2231Pass *llvm::createCoroSplitLegacyPass(bool ReuseFrameSlot) {
return new CoroSplitLegacy(ReuseFrameSlot);
2233}