/build/source/llvm/lib/Transforms/Coroutines/CoroSplit.cpp

Bug Summary

File:	build/source/llvm/lib/Transforms/Coroutines/CoroSplit.cpp
Warning:	line 502, 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 -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name CoroSplit.cpp -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -fmath-errno -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/source/build-llvm -resource-dir /usr/lib/llvm-17/lib/clang/17 -I lib/Transforms/Coroutines -I /build/source/llvm/lib/Transforms/Coroutines -I include -I /build/source/llvm/include -D _DEBUG -D _GLIBCXX_ASSERTIONS -D _GNU_SOURCE -D _LIBCPP_ENABLE_ASSERTIONS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -D _FORTIFY_SOURCE=2 -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-17/lib/clang/17/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -fmacro-prefix-map=/build/source/build-llvm=build-llvm -fmacro-prefix-map=/build/source/= -fcoverage-prefix-map=/build/source/build-llvm=build-llvm -fcoverage-prefix-map=/build/source/= -source-date-epoch 1676239811 -O3 -Wno-unused-command-line-argument -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -Wno-misleading-indentation -std=c++17 -fdeprecated-macro -fdebug-compilation-dir=/build/source/build-llvm -fdebug-prefix-map=/build/source/build-llvm=build-llvm -fdebug-prefix-map=/build/source/= -fdebug-prefix-map=/build/source/build-llvm=build-llvm -fdebug-prefix-map=/build/source/= -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2023-02-12-235601-562107-1 -x c++ /build/source/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/PriorityWorklist.h"
26#include "llvm/ADT/SmallPtrSet.h"
27#include "llvm/ADT/SmallVector.h"
28#include "llvm/ADT/StringRef.h"
29#include "llvm/ADT/Twine.h"
30#include "llvm/Analysis/CFG.h"
31#include "llvm/Analysis/CallGraph.h"
32#include "llvm/Analysis/ConstantFolding.h"
33#include "llvm/Analysis/LazyCallGraph.h"
34#include "llvm/Analysis/TargetTransformInfo.h"
35#include "llvm/BinaryFormat/Dwarf.h"
36#include "llvm/IR/Argument.h"
37#include "llvm/IR/Attributes.h"
38#include "llvm/IR/BasicBlock.h"
39#include "llvm/IR/CFG.h"
40#include "llvm/IR/CallingConv.h"
41#include "llvm/IR/Constants.h"
42#include "llvm/IR/DataLayout.h"
43#include "llvm/IR/DerivedTypes.h"
44#include "llvm/IR/Dominators.h"
45#include "llvm/IR/Function.h"
46#include "llvm/IR/GlobalValue.h"
47#include "llvm/IR/GlobalVariable.h"
48#include "llvm/IR/IRBuilder.h"
49#include "llvm/IR/InstIterator.h"
50#include "llvm/IR/InstrTypes.h"
51#include "llvm/IR/Instruction.h"
52#include "llvm/IR/Instructions.h"
53#include "llvm/IR/IntrinsicInst.h"
54#include "llvm/IR/LLVMContext.h"
55#include "llvm/IR/Module.h"
56#include "llvm/IR/Type.h"
57#include "llvm/IR/Value.h"
58#include "llvm/IR/Verifier.h"
59#include "llvm/Support/Casting.h"
60#include "llvm/Support/Debug.h"
61#include "llvm/Support/PrettyStackTrace.h"
62#include "llvm/Support/raw_ostream.h"
63#include "llvm/Transforms/Scalar.h"
64#include "llvm/Transforms/Utils/BasicBlockUtils.h"
65#include "llvm/Transforms/Utils/CallGraphUpdater.h"
66#include "llvm/Transforms/Utils/Cloning.h"
67#include "llvm/Transforms/Utils/Local.h"
68#include "llvm/Transforms/Utils/ValueMapper.h"
69#include <cassert>
70#include <cstddef>
71#include <cstdint>
72#include <initializer_list>
73#include <iterator>

75using namespace llvm;

77#define DEBUG_TYPE"coro-split" "coro-split"

79namespace {

81/// A little helper class for building
82class CoroCloner {
83public:
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,
};

101private:
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;
14
←
Null pointer value stored to 'Cloner.ActiveSuspend'→

115public:
/// 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)(static_cast <bool> (Shape.ABI == coro::ABI::Switch) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 121, __extension__ __PRETTY_FUNCTION__));
15
←
Assuming field 'ABI' is equal to Switch→
16
←
'?' 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 ||(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 131, __extension__
 __PRETTY_FUNCTION__))
         Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async)(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 131, __extension__
 __PRETTY_FUNCTION__));
  assert(NewF && "need existing function for continuation")(static_cast <bool> (NewF && "need existing function for continuation"
) ? void (0) : __assert_fail ("NewF && \"need existing function for continuation\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 132, __extension__
 __PRETTY_FUNCTION__));
  assert(ActiveSuspend && "need active suspend point for continuation")(static_cast <bool> (ActiveSuspend && "need active suspend point for continuation"
) ? void (0) : __assert_fail ("ActiveSuspend && \"need active suspend point for continuation\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 133, __extension__
 __PRETTY_FUNCTION__));
}

Function *getFunction() const {
  assert(NewF != nullptr && "declaration not yet set")(static_cast <bool> (NewF != nullptr && "declaration not yet set"
) ? void (0) : __assert_fail ("NewF != nullptr && \"declaration not yet set\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 137, __extension__
 __PRETTY_FUNCTION__));
  return NewF;
}

void create();

143private:
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"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 154);
}

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

167} // end anonymous namespace

169static void maybeFreeRetconStorage(IRBuilder<> &Builder,
                                 const coro::Shape &Shape, Value *FramePtr,
                                 CallGraph *CG) {
assert(Shape.ABI == coro::ABI::Retcon ||(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 173, __extension__
 __PRETTY_FUNCTION__))
       Shape.ABI == coro::ABI::RetconOnce)(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 173, __extension__
 __PRETTY_FUNCTION__));
if (Shape.RetconLowering.IsFrameInlineInStorage)
  return;

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

180/// Replace an llvm.coro.end.async.
181/// Will inline the must tail call function call if there is one.
182/// \returns true if cleanup of the coro.end block is needed, false otherwise.
183static 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")(static_cast <bool> (MustTailCallFuncBlock && "Must have a single predecessor block"
) ? void (0) : __assert_fail ("MustTailCallFuncBlock && \"Must have a single predecessor block\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 201, __extension__
 __PRETTY_FUNCTION__));
auto It = MustTailCallFuncBlock->getTerminator()->getIterator();
auto *MustTailCall = cast<CallInst>(&*std::prev(It));
CoroEndBlock->splice(End->getIterator(), MustTailCallFuncBlock,
                     MustTailCall->getIterator());

// 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")(static_cast <bool> (InlineRes.isSuccess() && "Expected inlining to succeed"
) ? void (0) : __assert_fail ("InlineRes.isSuccess() && \"Expected inlining to succeed\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 218, __extension__
 __PRETTY_FUNCTION__));
(void)InlineRes;

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

225/// Replace a non-unwind call to llvm.coro.end.
226static 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();
281}

283// Mark a coroutine as done, which implies that the coroutine is finished and
284// never get resumed.
285//
286// In resume-switched ABI, the done state is represented by storing zero in
287// ResumeFnAddr.
288//
289// NOTE: We couldn't omit the argument `FramePtr`. It is necessary because the
290// pointer to the frame in splitted function is not stored in `Shape`.
291static void markCoroutineAsDone(IRBuilder<> &Builder, const coro::Shape &Shape,
                              Value *FramePtr) {
assert((static_cast <bool> (Shape.ABI == coro::ABI::Switch &&
 "markCoroutineAsDone is only supported for Switch-Resumed ABI for now."
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch && \"markCoroutineAsDone is only supported for Switch-Resumed ABI for now.\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 295, __extension__
 __PRETTY_FUNCTION__))
    Shape.ABI == coro::ABI::Switch &&(static_cast <bool> (Shape.ABI == coro::ABI::Switch &&
 "markCoroutineAsDone is only supported for Switch-Resumed ABI for now."
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch && \"markCoroutineAsDone is only supported for Switch-Resumed ABI for now.\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 295, __extension__
 __PRETTY_FUNCTION__))
    "markCoroutineAsDone is only supported for Switch-Resumed ABI for now.")(static_cast <bool> (Shape.ABI == coro::ABI::Switch &&
 "markCoroutineAsDone is only supported for Switch-Resumed ABI for now."
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch && \"markCoroutineAsDone is only supported for Switch-Resumed ABI for now.\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 295, __extension__
 __PRETTY_FUNCTION__));
auto *GepIndex = Builder.CreateStructGEP(
    Shape.FrameTy, FramePtr, coro::Shape::SwitchFieldIndex::Resume,
    "ResumeFn.addr");
auto *NullPtr = ConstantPointerNull::get(cast<PointerType>(
    Shape.FrameTy->getTypeAtIndex(coro::Shape::SwitchFieldIndex::Resume)));
Builder.CreateStore(NullPtr, GepIndex);
302}

304/// Replace an unwind call to llvm.coro.end.
305static 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: {
  // In C++'s specification, the coroutine should be marked as done
  // if promise.unhandled_exception() throws.  The frontend will
  // call coro.end(true) along this path.
  //
  // FIXME: We should refactor this once there is other language
  // which uses Switch-Resumed style other than C++.
  markCoroutineAsDone(Builder, Shape, FramePtr);
  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();
}
341}

343static 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();
354}

356// Create an entry block for a resume function with a switch that will jump to
357// suspend points.
358static void createResumeEntryBlock(Function &F, coro::Shape &Shape) {
assert(Shape.ABI == coro::ABI::Switch)(static_cast <bool> (Shape.ABI == coro::ABI::Switch) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 359, __extension__ __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 %IndexVal, i32* %index.addr1
  auto *Save = S->getCoroSave();
  Builder.SetInsertPoint(Save);
  if (S->isFinal()) {
    // The coroutine should be marked done if it reaches the final suspend
    // point.
    markCoroutineAsDone(Builder, Shape, FramePtr);
  }

  // If the coroutine don't have unwind coro end, we could omit the store to
  // the final suspend point since we could infer the coroutine is suspended
  // at the final suspend point by the nullness of ResumeFnAddr.
  // However, we can't skip it if the coroutine have unwind coro end. Since
  // the coroutine reaches unwind coro end is considered suspended at the
  // final suspend point (the ResumeFnAddr is null) but in fact the coroutine
  // didn't complete yet. We need the IndexVal for the final suspend point
  // to make the states clear.
  if (!S->isFinal() || Shape.SwitchLowering.HasUnwindCoroEnd) {
    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;
461}

463// In the resume function, we remove the last case  (when coro::Shape is built,
464// the final suspend point (if present) is always the last element of
465// CoroSuspends array) since it is an undefined behavior to resume a coroutine
466// suspended at the final suspend point.
467// In the destroy function, if it isn't possible that the ResumeFnAddr is NULL
468// and the coroutine doesn't suspend at the final suspend point actually (this
469// is possible since the coroutine is considered suspended at the final suspend
470// point if promise.unhandled_exception() exits via an exception), we can
471// remove the last case.
472void CoroCloner::handleFinalSuspend() {
assert(Shape.ABI == coro::ABI::Switch &&(static_cast <bool> (Shape.ABI == coro::ABI::Switch &&
 Shape.SwitchLowering.HasFinalSuspend) ? void (0) : __assert_fail
 ("Shape.ABI == coro::ABI::Switch && Shape.SwitchLowering.HasFinalSuspend"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 474, __extension__
 __PRETTY_FUNCTION__))
       Shape.SwitchLowering.HasFinalSuspend)(static_cast <bool> (Shape.ABI == coro::ABI::Switch &&
 Shape.SwitchLowering.HasFinalSuspend) ? void (0) : __assert_fail
 ("Shape.ABI == coro::ABI::Switch && Shape.SwitchLowering.HasFinalSuspend"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 474, __extension__
 __PRETTY_FUNCTION__));

if (isSwitchDestroyFunction() && Shape.SwitchLowering.HasUnwindCoroEnd)
  return;

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();
}
496}

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

507static 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)
23
←
Assuming field 'ABI' is equal to Async→
24
←
'?' condition is false→
                 ? Shape.getResumeFunctionType()
                 : getFunctionTypeFromAsyncSuspend(ActiveSuspend);
25
←
Passing null pointer value via 1st parameter 'Suspend'→
26
←
Calling 'getFunctionTypeFromAsyncSuspend'→

Function *NewF =
    Function::Create(FnTy, GlobalValue::LinkageTypes::InternalLinkage,
                     OrigF.getName() + Suffix);

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

return NewF;
523}

525/// Replace uses of the active llvm.coro.suspend.retcon/async call with the
526/// arguments to the continuation function.
527///
528/// This assumes that the builder has a meaningful insertion point.
529void CoroCloner::replaceRetconOrAsyncSuspendUses() {
assert(Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce ||(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 531, __extension__
 __PRETTY_FUNCTION__))
       Shape.ABI == coro::ABI::Async)(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async
) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce || Shape.ABI == coro::ABI::Async"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 531, __extension__
 __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)(static_cast <bool> (Args.size() == 1) ? void (0) : __assert_fail
 ("Args.size() == 1", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 549, __extension__ __PRETTY_FUNCTION__));
  NewS->replaceAllUsesWith(Args.front());
  return;
}

// Try to peephole extracts of an aggregate return.
for (Use &U : llvm::make_early_inc_range(NewS->uses())) {
  auto *EVI = dyn_cast<ExtractValueInst>(U.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);
573}

575void 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();
}
609}

611void 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);
}
618}

620static 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(cast<PointerType>(CachedSlot->getType())(static_cast <bool> (cast<PointerType>(CachedSlot
->getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) &&
 "multiple swifterror slots in function with different types"
) ? void (0) : __assert_fail ("cast<PointerType>(CachedSlot->getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && \"multiple swifterror slots in function with different types\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 629, __extension__
 __PRETTY_FUNCTION__))
               ->isOpaqueOrPointeeTypeMatches(ValueTy) &&(static_cast <bool> (cast<PointerType>(CachedSlot
->getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) &&
 "multiple swifterror slots in function with different types"
) ? void (0) : __assert_fail ("cast<PointerType>(CachedSlot->getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && \"multiple swifterror slots in function with different types\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 629, __extension__
 __PRETTY_FUNCTION__))
           "multiple swifterror slots in function with different types")(static_cast <bool> (cast<PointerType>(CachedSlot
->getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) &&
 "multiple swifterror slots in function with different types"
) ? void (0) : __assert_fail ("cast<PointerType>(CachedSlot->getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && \"multiple swifterror slots in function with different types\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 629, __extension__
 __PRETTY_FUNCTION__));
    return CachedSlot;
  }

  // Check if the function has a swifterror argument.
  for (auto &Arg : F.args()) {
    if (Arg.isSwiftError()) {
      CachedSlot = &Arg;
      assert(cast<PointerType>(Arg.getType())(static_cast <bool> (cast<PointerType>(Arg.getType
()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && "swifterror argument does not have expected type"
) ? void (0) : __assert_fail ("cast<PointerType>(Arg.getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && \"swifterror argument does not have expected type\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 639, __extension__
 __PRETTY_FUNCTION__))
                 ->isOpaqueOrPointeeTypeMatches(ValueTy) &&(static_cast <bool> (cast<PointerType>(Arg.getType
()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && "swifterror argument does not have expected type"
) ? void (0) : __assert_fail ("cast<PointerType>(Arg.getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && \"swifterror argument does not have expected type\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 639, __extension__
 __PRETTY_FUNCTION__))
             "swifterror argument does not have expected type")(static_cast <bool> (cast<PointerType>(Arg.getType
()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && "swifterror argument does not have expected type"
) ? void (0) : __assert_fail ("cast<PointerType>(Arg.getType()) ->isOpaqueOrPointeeTypeMatches(ValueTy) && \"swifterror argument does not have expected type\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 639, __extension__
 __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->arg_empty()) {
    auto ValueTy = Op->getType();
    auto Slot = getSwiftErrorSlot(ValueTy);
    MappedResult = Builder.CreateLoad(ValueTy, Slot);
  } else {
    assert(Op->arg_size() == 1)(static_cast <bool> (Op->arg_size() == 1) ? void (0)
 : __assert_fail ("Op->arg_size() == 1", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 664, __extension__ __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();
}
680}

682void CoroCloner::replaceSwiftErrorOps() {
::replaceSwiftErrorOps(*NewF, Shape, &VMap);
684}

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

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

719void 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())(static_cast <bool> (Entry->hasOneUse()) ? void (0) :
 __assert_fail ("Entry->hasOneUse()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 734, __extension__ __PRETTY_FUNCTION__));
auto BranchToEntry = cast<BranchInst>(Entry->user_back());
assert(BranchToEntry->isUnconditional())(static_cast <bool> (BranchToEntry->isUnconditional(
)) ? void (0) : __assert_fail ("BranchToEntry->isUnconditional()"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 736, __extension__
 __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 &&(static_cast <bool> ((Shape.ABI == coro::ABI::Async &&
 isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI
 == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) &&
 isa<CoroSuspendRetconInst>(ActiveSuspend))) ? 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))"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 762, __extension__
 __PRETTY_FUNCTION__))
          isa<CoroSuspendAsyncInst>(ActiveSuspend)) ||(static_cast <bool> ((Shape.ABI == coro::ABI::Async &&
 isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI
 == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) &&
 isa<CoroSuspendRetconInst>(ActiveSuspend))) ? 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))"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 762, __extension__
 __PRETTY_FUNCTION__))
         ((Shape.ABI == coro::ABI::Retcon ||(static_cast <bool> ((Shape.ABI == coro::ABI::Async &&
 isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI
 == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) &&
 isa<CoroSuspendRetconInst>(ActiveSuspend))) ? 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))"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 762, __extension__
 __PRETTY_FUNCTION__))
           Shape.ABI == coro::ABI::RetconOnce) &&(static_cast <bool> ((Shape.ABI == coro::ABI::Async &&
 isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI
 == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) &&
 isa<CoroSuspendRetconInst>(ActiveSuspend))) ? 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))"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 762, __extension__
 __PRETTY_FUNCTION__))
          isa<CoroSuspendRetconInst>(ActiveSuspend)))(static_cast <bool> ((Shape.ABI == coro::ABI::Async &&
 isa<CoroSuspendAsyncInst>(ActiveSuspend)) || ((Shape.ABI
 == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce) &&
 isa<CoroSuspendRetconInst>(ActiveSuspend))) ? 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))"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 762, __extension__
 __PRETTY_FUNCTION__));
  auto *MappedCS = cast<AnyCoroSuspendInst>(VMap[ActiveSuspend]);
  auto Branch = cast<BranchInst>(MappedCS->getNextNode());
  assert(Branch->isUnconditional())(static_cast <bool> (Branch->isUnconditional()) ? void
 (0) : __assert_fail ("Branch->isUnconditional()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 765, __extension__ __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 (Instruction &I : llvm::make_early_inc_range(instructions(F))) {
  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());
}
784}

786/// Derive the value of the new frame pointer.
787Value *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 ContextIdx = ActiveAsyncSuspend->getStorageArgumentIndex() & 0xff;
  auto *CalleeContext = NewF->getArg(ContextIdx);
  auto *FramePtrTy = Shape.FrameTy->getPointerTo();
  auto *ProjectionFunc =
      ActiveAsyncSuspend->getAsyncContextProjectionFunction();
  auto DbgLoc =
      cast<CoroSuspendAsyncInst>(VMap[ActiveSuspend])->getDebugLoc();
  // Calling i8* (i8*)
  auto *CallerContext = Builder.CreateCall(ProjectionFunc->getFunctionType(),
                                           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())(static_cast <bool> (InlineRes.isSuccess()) ? void (0) :
 __assert_fail ("InlineRes.isSuccess()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 821, __extension__ __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", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 841);
842}

844static void addFramePointerAttrs(AttributeList &Attrs, LLVMContext &Context,
                               unsigned ParamIndex, uint64_t Size,
                               Align Alignment, bool NoAlias) {
AttrBuilder ParamAttrs(Context);
ParamAttrs.addAttribute(Attribute::NonNull);
ParamAttrs.addAttribute(Attribute::NoUndef);

if (NoAlias)
  ParamAttrs.addAttribute(Attribute::NoAlias);

ParamAttrs.addAlignmentAttr(Alignment);
ParamAttrs.addDereferenceableAttr(Size);
Attrs = Attrs.addParamAttributes(Context, ParamIndex, ParamAttrs);
857}

859static void addAsyncContextAttrs(AttributeList &Attrs, LLVMContext &Context,
                               unsigned ParamIndex) {
AttrBuilder ParamAttrs(Context);
ParamAttrs.addAttribute(Attribute::SwiftAsync);
Attrs = Attrs.addParamAttributes(Context, ParamIndex, ParamAttrs);
864}

866static void addSwiftSelfAttrs(AttributeList &Attrs, LLVMContext &Context,
                            unsigned ParamIndex) {
AttrBuilder ParamAttrs(Context);
ParamAttrs.addAttribute(Attribute::SwiftSelf);
Attrs = Attrs.addParamAttributes(Context, ParamIndex, ParamAttrs);
871}

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

// Replace all args with dummy instructions. If an argument is the old frame
// pointer, the dummy will be replaced by the new frame pointer once it is
// computed below. Uses of all other arguments should have already been
// rewritten by buildCoroutineFrame() to use loads/stores on the coroutine
// frame.
SmallVector<Instruction *> DummyArgs;
for (Argument &A : OrigF.args()) {
  DummyArgs.push_back(new FreezeInst(UndefValue::get(A.getType())));
  VMap[&A] = DummyArgs.back();
}

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);

auto &Context = NewF->getContext();

// For async functions / continuations, adjust the scope line of the
// clone to the line number of the suspend point. However, only
// adjust the scope line when the files are the same. This ensures
// line number and file name belong together. 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())(static_cast <bool> (SP != OrigF.getSubprogram() &&
 SP->isDistinct()) ? void (0) : __assert_fail ("SP != OrigF.getSubprogram() && SP->isDistinct()"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 919, __extension__
 __PRETTY_FUNCTION__));
  if (ActiveSuspend)
    if (auto DL = ActiveSuspend->getDebugLoc())
      if (SP->getFile() == DL->getFile())
        SP->setScopeLine(DL->getLine());
  // Update the linkage name to reflect the modified symbol name. It
  // is necessary to update the linkage name in Swift, since the
  // mangling changes for resume functions. It might also be the
  // right thing to do in C++, but due to a limitation in LLVM's
  // AsmPrinter we can only do this if the function doesn't have an
  // abstract specification, since the DWARF backend expects the
  // abstract specification to contain the linkage name and asserts
  // that they are identical.
  if (!SP->getDeclaration() && SP->getUnit() &&
      SP->getUnit()->getSourceLanguage() == dwarf::DW_LANG_Swift)
    SP->replaceLinkageName(MDString::get(Context, NewF->getName()));
}

NewF->setLinkage(savedLinkage);
NewF->setVisibility(savedVisibility);
NewF->setUnnamedAddr(savedUnnamedAddr);
NewF->setDLLStorageClass(savedDLLStorageClass);
// The function sanitizer metadata needs to match the signature of the
// function it is being attached to. However this does not hold for split
// functions here. Thus remove the metadata for split functions.
if (Shape.ABI == coro::ABI::Switch &&
    NewF->hasMetadata(LLVMContext::MD_func_sanitize))
  NewF->eraseMetadata(LLVMContext::MD_func_sanitize);

// 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.addFnAttributes(
      Context, AttrBuilder(Context, OrigAttrs.getFnAttrs()));

  addFramePointerAttrs(NewAttrs, Context, 0, Shape.FrameSize,
                       Shape.FrameAlign, /*NoAlias=*/false);
  break;
case coro::ABI::Async: {
  auto *ActiveAsyncSuspend = cast<CoroSuspendAsyncInst>(ActiveSuspend);
  if (OrigF.hasParamAttribute(Shape.AsyncLowering.ContextArgNo,
                              Attribute::SwiftAsync)) {
    uint32_t ArgAttributeIndices =
        ActiveAsyncSuspend->getStorageArgumentIndex();
    auto ContextArgIndex = ArgAttributeIndices & 0xff;
    addAsyncContextAttrs(NewAttrs, Context, ContextArgIndex);

    // `swiftasync` must preceed `swiftself` so 0 is not a valid index for
    // `swiftself`.
    auto SwiftSelfIndex = ArgAttributeIndices >> 8;
    if (SwiftSelfIndex)
      addSwiftSelfAttrs(NewAttrs, Context, SwiftSelfIndex);
  }

  // Transfer the original function's attributes.
  auto FnAttrs = OrigF.getAttributes().getFnAttrs();
  NewAttrs = NewAttrs.addFnAttributes(Context, AttrBuilder(Context, FnAttrs));
  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();

  /// FIXME: Is it really good to add the NoAlias attribute?
  addFramePointerAttrs(NewAttrs, Context, 0,
                       Shape.getRetconCoroId()->getStorageSize(),
                       Shape.getRetconCoroId()->getStorageAlignment(),
                       /*NoAlias=*/true);

  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);
  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]);
if (OldVFrame != NewVFrame)
  OldVFrame->replaceAllUsesWith(NewVFrame);

// All uses of the arguments should have been resolved by this point,
// so we can safely remove the dummy values.
for (Instruction *DummyArg : DummyArgs) {
  DummyArg->replaceAllUsesWith(UndefValue::get(DummyArg->getType()));
  DummyArg->deleteValue();
}

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 &&(static_cast <bool> (ActiveSuspend != nullptr &&
 "no active suspend when lowering a continuation-style coroutine"
) ? void (0) : __assert_fail ("ActiveSuspend != nullptr && \"no active suspend when lowering a continuation-style coroutine\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1065, __extension__
 __PRETTY_FUNCTION__))
         "no active suspend when lowering a continuation-style coroutine")(static_cast <bool> (ActiveSuspend != nullptr &&
 "no active suspend when lowering a continuation-style coroutine"
) ? void (0) : __assert_fail ("ActiveSuspend != nullptr && \"no active suspend when lowering a continuation-style coroutine\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1065, __extension__
 __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);
1087}

1089// Create a resume clone by cloning the body of the original function, setting
1090// new entry block and replacing coro.suspend an appropriate value to force
1091// resume or cleanup pass for every suspend point.
1092static Function *createClone(Function &F, const Twine &Suffix,
                           coro::Shape &Shape, CoroCloner::Kind FKind) {
CoroCloner Cloner(F, Suffix, Shape, FKind);
13
←
Calling constructor for 'CoroCloner'→
17
←
Returning from constructor for 'CoroCloner'→
Cloner.create();
18
←
Calling 'CoroCloner::create'→
return Cloner.getFunction();
1097}

1099static void updateAsyncFuncPointerContextSize(coro::Shape &Shape) {
assert(Shape.ABI == coro::ABI::Async)(static_cast <bool> (Shape.ABI == coro::ABI::Async) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Async", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1100, __extension__ __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);
1112}

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

for (CoroAlignInst *CA : Shape.CoroAligns) {
  CA->replaceAllUsesWith(
      ConstantInt::get(CA->getType(), Shape.FrameAlign.value()));
  CA->eraseFromParent();
}

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();
}
1138}

1140// Create a global constant array containing pointers to functions provided and
1141// set Info parameter of CoroBegin to point at this constant. Example:
1142//
1143//   @f.resumers = internal constant [2 x void(%f.frame*)*]
1144//                    [void(%f.frame*)* @f.resume, void(%f.frame*)* @f.destroy]
1145//   define void @f() {
1146//     ...
1147//     call i8* @llvm.coro.begin(i8* null, i32 0, i8* null,
1148//                    i8* bitcast([2 x void(%f.frame*)*] * @f.resumers to i8*))
1149//
1150// Assumes that all the functions have the same signature.
1151static 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)(static_cast <bool> (Shape.ABI == coro::ABI::Switch) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1155, __extension__ __PRETTY_FUNCTION__));

SmallVector<Constant *, 4> Args(Fns.begin(), Fns.end());
assert(!Args.empty())(static_cast <bool> (!Args.empty()) ? void (0) : __assert_fail
 ("!Args.empty()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1158, __extension__ __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);
1172}

1174// Store addresses of Resume/Destroy/Cleanup functions in the coroutine frame.
1175static void updateCoroFrame(coro::Shape &Shape, Function *ResumeFn,
                          Function *DestroyFn, Function *CleanupFn) {
assert(Shape.ABI == coro::ABI::Switch)(static_cast <bool> (Shape.ABI == coro::ABI::Switch) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1177, __extension__ __PRETTY_FUNCTION__));

IRBuilder<> Builder(Shape.getInsertPtAfterFramePtr());

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);
1199}

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

1204#ifndef NDEBUG
// 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");
1210#endif
1211}

1213// Assuming we arrived at the block NewBlock from Prev instruction, store
1214// PHI's incoming values in the ResolvedValues map.
1215static void
1216scanPHIsAndUpdateValueMap(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;
}
1228}

1230// Replace a sequence of branches leading to a ret, with a clone of a ret
1231// instruction. Suspend instruction represented by a switch, track the PHI
1232// values and select the correct case successor when possible.
1233static bool simplifyTerminatorLeadingToRet(Instruction *InitialInst) {
DenseMap<Value *, Value *> ResolvedValues;
BasicBlock *UnconditionalSucc = nullptr;
assert(InitialInst->getModule())(static_cast <bool> (InitialInst->getModule()) ? void
 (0) : __assert_fail ("InitialInst->getModule()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1236, __extension__ __PRETTY_FUNCTION__));
const DataLayout &DL = InitialInst->getModule()->getDataLayout();

auto GetFirstValidInstruction = [](Instruction *I) {
  while (I) {
    // BitCastInst wouldn't generate actual code so that we could skip it.
    if (isa<BitCastInst>(I) || I->isDebugOrPseudoInst() ||
        I->isLifetimeStartOrEnd())
      I = I->getNextNode();
    else if (isInstructionTriviallyDead(I))
      // Duing we are in the middle of the transformation, we need to erase
      // the dead instruction manually.
      I = &*I->eraseFromParent();
    else
      break;
  }
  return I;
};

auto TryResolveConstant = [&ResolvedValues](Value *V) {
  auto It = ResolvedValues.find(V);
  if (It != ResolvedValues.end())
    V = It->second;
  return dyn_cast<ConstantInt>(V);
};

Instruction *I = InitialInst;
while (I->isTerminator() || isa<CmpInst>(I)) {
  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 *Succ = BR->getSuccessor(0);
      if (I == InitialInst)
        UnconditionalSucc = Succ;
      scanPHIsAndUpdateValueMap(I, Succ, ResolvedValues);
      I = GetFirstValidInstruction(Succ->getFirstNonPHIOrDbgOrLifetime());
      continue;
    }

    BasicBlock *BB = BR->getParent();
    // Handle the case the condition of the conditional branch is constant.
    // e.g.,
    //
    //     br i1 false, label %cleanup, label %CoroEnd
    //
    // It is possible during the transformation. We could continue the
    // simplifying in this case.
    if (ConstantFoldTerminator(BB, /*DeleteDeadConditions=*/true)) {
      // Handle this branch in next iteration.
      I = BB->getTerminator();
      continue;
    }
  } else if (auto *CondCmp = dyn_cast<CmpInst>(I)) {
    // If the case number of suspended switch instruction is reduced to
    // 1, then it is simplified to CmpInst in llvm::ConstantFoldTerminator.
    auto *BR = dyn_cast<BranchInst>(
        GetFirstValidInstruction(CondCmp->getNextNode()));
    if (!BR || !BR->isConditional() || CondCmp != BR->getCondition())
      return false;

    // And the comparsion looks like : %cond = icmp eq i8 %V, constant.
    // So we try to resolve constant for the first operand only since the
    // second operand should be literal constant by design.
    ConstantInt *Cond0 = TryResolveConstant(CondCmp->getOperand(0));
    auto *Cond1 = dyn_cast<ConstantInt>(CondCmp->getOperand(1));
    if (!Cond0 || !Cond1)
      return false;

    // Both operands of the CmpInst are Constant. So that we could evaluate
    // it immediately to get the destination.
    auto *ConstResult =
        dyn_cast_or_null<ConstantInt>(ConstantFoldCompareInstOperands(
            CondCmp->getPredicate(), Cond0, Cond1, DL));
    if (!ConstResult)
      return false;

    CondCmp->replaceAllUsesWith(ConstResult);
    CondCmp->eraseFromParent();

    // Handle this branch in next iteration.
    I = BR;
    continue;
  } else if (auto *SI = dyn_cast<SwitchInst>(I)) {
    ConstantInt *Cond = TryResolveConstant(SI->getCondition());
    if (!Cond)
      return false;

    BasicBlock *BB = SI->findCaseValue(Cond)->getCaseSuccessor();
    scanPHIsAndUpdateValueMap(I, BB, ResolvedValues);
    I = GetFirstValidInstruction(BB->getFirstNonPHIOrDbgOrLifetime());
    continue;
  }

  return false;
}
return false;
1341}

1343// Check whether CI obeys the rules of musttail attribute.
1344static 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.hasParamAttr(0, AK))
    return false;

return true;
1372}

1374// Add musttail to any resume instructions that is immediately followed by a
1375// suspend (i.e. ret). We do this even in -O0 to support guaranteed tail call
1376// for symmetrical coroutine control transfer (C++ Coroutines TS extension).
1377// This transformation is done only in the resume part of the coroutine that has
1378// identical signature and calling convention as the coro.resume call.
1379static void addMustTailToCoroResumes(Function &F, TargetTransformInfo &TTI) {
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)
  // Skip targets which don't support tail call on the specific case.
  if (TTI.supportsTailCallFor(Call) &&
      simplifyTerminatorLeadingToRet(Call->getNextNode())) {
    Call->setTailCallKind(CallInst::TCK_MustTail);
    changed = true;
  }

if (changed)
  removeUnreachableBlocks(F);
1400}

1402// Coroutine has no suspend points. Remove heap allocation for the coroutine
1403// frame if possible.
1404static 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();
1434}

1436// SimplifySuspendPoint needs to check that there is no calls between
1437// coro_save and coro_suspend, since any of the calls may potentially resume
1438// the coroutine and if that is the case we cannot eliminate the suspend point.
1439static 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;
1449}

1451static 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.contains(Pred))
      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;
1478}

1480static 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;
1501}

1503// If a SuspendIntrin is preceded by Resume or Destroy, we can eliminate the
1504// suspend point and replace it with nornal control flow.
1505static 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;
1562}

1564// Remove suspend points that are simplified.
1565static 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;

size_t ChangedFinalIndex = std::numeric_limits<size_t>::max();
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]);

    if (cast<CoroSuspendInst>(S[I])->isFinal()) {
      assert(Shape.SwitchLowering.HasFinalSuspend)(static_cast <bool> (Shape.SwitchLowering.HasFinalSuspend
) ? void (0) : __assert_fail ("Shape.SwitchLowering.HasFinalSuspend"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1587, __extension__
 __PRETTY_FUNCTION__));
      ChangedFinalIndex = I;
    }

    continue;
  }
  if (++I == N)
    break;
}
S.resize(N);

// Maintain final.suspend in case final suspend was swapped.
// Due to we requrie the final suspend to be the last element of CoroSuspends.
if (ChangedFinalIndex < N) {
  assert(cast<CoroSuspendInst>(S[ChangedFinalIndex])->isFinal())(static_cast <bool> (cast<CoroSuspendInst>(S[ChangedFinalIndex
])->isFinal()) ? void (0) : __assert_fail ("cast<CoroSuspendInst>(S[ChangedFinalIndex])->isFinal()"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1601, __extension__
 __PRETTY_FUNCTION__));
  std::swap(S[ChangedFinalIndex], S.back());
}
1604}

1606static void splitSwitchCoroutine(Function &F, coro::Shape &Shape,
                               SmallVectorImpl<Function *> &Clones,
                               TargetTransformInfo &TTI) {
assert(Shape.ABI == coro::ABI::Switch)(static_cast <bool> (Shape.ABI == coro::ABI::Switch) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Switch", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1609, __extension__ __PRETTY_FUNCTION__));
11
←
'?' condition is true→

createResumeEntryBlock(F, Shape);
auto ResumeClone = createClone(F, ".resume", Shape,
12
←
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);

// Adding musttail call to support symmetric transfer.
// Skip targets which don't support tail call.
//
// FIXME: Could we support symmetric transfer effectively without musttail
// call?
if (TTI.supportsTailCalls())
  addMustTailToCoroResumes(*ResumeClone, TTI);

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

assert(Clones.empty())(static_cast <bool> (Clones.empty()) ? void (0) : __assert_fail
 ("Clones.empty()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1634, __extension__ __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);
1643}

1645static 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));
1657}

1659/// Coerce the arguments in \p FnArgs according to \p FnTy in \p CallArgs.
1660static 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())(static_cast <bool> (ArgIdx < FnArgs.size()) ? void (
0) : __assert_fail ("ArgIdx < FnArgs.size()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1665, __extension__ __PRETTY_FUNCTION__));
  if (paramTy != FnArgs[ArgIdx]->getType())
    CallArgs.push_back(
        Builder.CreateBitOrPointerCast(FnArgs[ArgIdx], paramTy));
  else
    CallArgs.push_back(FnArgs[ArgIdx]);
  ++ArgIdx;
}
1673}

1675CallInst *coro::createMustTailCall(DebugLoc Loc, Function *MustTailCallFn,
                                 ArrayRef<Value *> Arguments,
                                 IRBuilder<> &Builder) {
auto *FnTy = MustTailCallFn->getFunctionType();
// 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;
1689}

1691static void splitAsyncCoroutine(Function &F, coro::Shape &Shape,
                              SmallVectorImpl<Function *> &Clones) {
assert(Shape.ABI == coro::ABI::Async)(static_cast <bool> (Shape.ABI == coro::ABI::Async) ? void
 (0) : __assert_fail ("Shape.ABI == coro::ABI::Async", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1693, __extension__ __PRETTY_FUNCTION__));
assert(Clones.empty())(static_cast <bool> (Clones.empty()) ? void (0) : __assert_fail
 ("Clones.empty()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1694, __extension__ __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.removeRetAttr(Attribute::NoAlias);
F.removeRetAttr(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<Value> 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 ResumeNameSuffix = ".resume.";
  auto ProjectionFunctionName =
      Suspend->getAsyncContextProjectionFunction()->getName();
  bool UseSwiftMangling = false;
  if (ProjectionFunctionName.equals("__swift_async_resume_project_context")) {
    ResumeNameSuffix = "TQ";
    UseSwiftMangling = true;
  } else if (ProjectionFunctionName.equals(
                 "__swift_async_resume_get_context")) {
    ResumeNameSuffix = "TY";
    UseSwiftMangling = true;
  }
  auto *Continuation = createCloneDeclaration(
      F, Shape,
      UseSwiftMangling ? ResumeNameSuffix + Twine(Idx) + "_"
                       : ResumeNameSuffix + 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")(static_cast <bool> (InlineRes.isSuccess() && "Expected inlining to succeed"
) ? void (0) : __assert_fail ("InlineRes.isSuccess() && \"Expected inlining to succeed\""
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1772, __extension__
 __PRETTY_FUNCTION__));
  (void)InlineRes;

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

assert(Clones.size() == Shape.CoroSuspends.size())(static_cast <bool> (Clones.size() == Shape.CoroSuspends
.size()) ? void (0) : __assert_fail ("Clones.size() == Shape.CoroSuspends.size()"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1779, __extension__
 __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();
}
1786}

1788static void splitRetconCoroutine(Function &F, coro::Shape &Shape,
                               SmallVectorImpl<Function *> &Clones) {
assert(Shape.ABI == coro::ABI::Retcon ||(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1791, __extension__
 __PRETTY_FUNCTION__))
       Shape.ABI == coro::ABI::RetconOnce)(static_cast <bool> (Shape.ABI == coro::ABI::Retcon || Shape
.ABI == coro::ABI::RetconOnce) ? void (0) : __assert_fail ("Shape.ABI == coro::ABI::Retcon || Shape.ABI == coro::ABI::RetconOnce"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1791, __extension__
 __PRETTY_FUNCTION__));
assert(Clones.empty())(static_cast <bool> (Clones.empty()) ? void (0) : __assert_fail
 ("Clones.empty()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1792, __extension__ __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.removeRetAttr(Attribute::NoAlias);
F.removeRetAttr(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<Value> 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())(static_cast <bool> (ReturnPHIs.empty()) ? void (0) : __assert_fail
 ("ReturnPHIs.empty()", "llvm/lib/Transforms/Coroutines/CoroSplit.cpp"
, 1866, __extension__ __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())(static_cast <bool> (NextPHIIndex == ReturnPHIs.size())
 ? void (0) : __assert_fail ("NextPHIIndex == ReturnPHIs.size()"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1907, __extension__
 __PRETTY_FUNCTION__));
}

assert(Clones.size() == Shape.CoroSuspends.size())(static_cast <bool> (Clones.size() == Shape.CoroSuspends
.size()) ? void (0) : __assert_fail ("Clones.size() == Shape.CoroSuspends.size()"
, "llvm/lib/Transforms/Coroutines/CoroSplit.cpp", 1910, __extension__
 __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();
}
1917}

1919namespace {
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";
  }
};
1930}

1932static coro::Shape splitCoroutine(Function &F,
                                SmallVectorImpl<Function *> &Clones,
                                TargetTransformInfo &TTI,
                                bool OptimizeFrame) {
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, OptimizeFrame);
if (!Shape.CoroBegin)
6
←
Assuming field 'CoroBegin' is non-null→
7
←
Taking false branch→
  return Shape;

simplifySuspendPoints(Shape);
buildCoroutineFrame(F, Shape);
replaceFrameSizeAndAlignment(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()) {
8
←
Taking false branch→
  handleNoSuspendCoroutine(Shape);
} else {
  switch (Shape.ABI) {
9
←
Control jumps to 'case Switch:'  at line 1956→
  case coro::ABI::Switch:
    splitSwitchCoroutine(F, Shape, Clones, TTI);
10
←
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);

// Finally, salvage the llvm.dbg.{declare,addr} in our original function that
// point into the coroutine frame. We only do this for the current function
// since the Cloner salvaged debug info for us in the new coroutine funclets.
SmallVector<DbgVariableIntrinsic *, 8> Worklist;
SmallDenseMap<llvm::Value *, llvm::AllocaInst *, 4> DbgPtrAllocaCache;
for (auto &BB : F) {
  for (auto &I : BB) {
    if (auto *DDI = dyn_cast<DbgDeclareInst>(&I)) {
      Worklist.push_back(DDI);
      continue;
    }
    if (auto *DDI = dyn_cast<DbgAddrIntrinsic>(&I)) {
      Worklist.push_back(DDI);
      continue;
    }
  }
}
for (auto *DDI : Worklist)
  coro::salvageDebugInfo(DbgPtrAllocaCache, DDI, Shape.OptimizeFrame);

return Shape;
1994}

1996/// Remove calls to llvm.coro.end in the original function.
1997static void removeCoroEnds(const coro::Shape &Shape) {
for (auto *End : Shape.CoroEnds) {
  replaceCoroEnd(End, Shape, Shape.FramePtr, /*in resume*/ false, nullptr);
}
2001}

2003static 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;

if (Shape.ABI != coro::ABI::Switch)
  removeCoroEnds(Shape);
else {
  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);
2047}

2049/// Replace a call to llvm.coro.prepare.retcon.
2050static 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 (Use &U : llvm::make_early_inc_range(Prepare->uses())) {
  // Look for bitcasts back to the original function type.
  auto *Cast = dyn_cast<BitCastInst>(U.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();
}
2084}

2086static bool replaceAllPrepares(Function *PrepareFn, LazyCallGraph &CG,
                             LazyCallGraph::SCC &C) {
bool Changed = false;
for (Use &P : llvm::make_early_inc_range(PrepareFn->uses())) {
  // Intrinsics can only be used in calls.
  auto *Prepare = cast<CallInst>(P.getUser());
  replacePrepare(Prepare, CG, C);
  Changed = true;
}

return Changed;
2097}

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

2107PreservedAnalyses 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();

// 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 *> Coroutines;
for (LazyCallGraph::Node &N : C)
  if (N.getFunction().isPresplitCoroutine())
    Coroutines.push_back(&N);

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

if (Coroutines.empty()) {
1
Taking false branch→
  for (auto *PrepareFn : PrepareFns) {
    replaceAllPrepares(PrepareFn, CG, C);
  }
}

// Split all the coroutines.
for (LazyCallGraph::Node *N : Coroutines) {
2
←
Assuming '__begin1' is not equal to '__end1'→
  Function &F = N->getFunction();
  LLVM_DEBUG(dbgs() << "CoroSplit: Processing coroutine '" << F.getName()do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("coro-split")) { dbgs() << "CoroSplit: Processing coroutine '"
 << F.getName() << "\n"; } } while (false)
3
←
Assuming 'DebugFlag' is false→
4
←
Loop condition is false.  Exiting loop→
                    << "\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("coro-split")) { dbgs() << "CoroSplit: Processing coroutine '"
 << F.getName() << "\n"; } } while (false);
  F.setSplittedCoroutine();

  SmallVector<Function *, 4> Clones;
  const coro::Shape Shape = splitCoroutine(
5
←
Calling 'splitCoroutine'→
      F, Clones, FAM.getResult<TargetIRAnalysis>(F), OptimizeFrame);
  updateCallGraphAfterCoroutineSplit(*N, Shape, Clones, C, CG, AM, UR, FAM);

  if (!Shape.CoroSuspends.empty()) {
    // Run the CGSCC pipeline on the original and newly split functions.
    UR.CWorklist.insert(&C);
    for (Function *Clone : Clones)
      UR.CWorklist.insert(CG.lookupSCC(CG.get(*Clone)));
  }
}

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

return PreservedAnalyses::none();
2164}