#include "Transforms/Coroutines/CoroCloner.h"

Inheritance diagram for llvm::coro::BaseCloner:

Public Member Functions
	BaseCloner (Function &OrigF, const Twine &Suffix, coro::Shape &Shape, CloneKind FKind, TargetTransformInfo &TTI)
virtual	~BaseCloner ()=default
Function *	getFunction () const
virtual void	create ()
	Clone the body of the original function into a resume function of some sort.

Static Public Member Functions
static Function *	createClone (Function &OrigF, const Twine &Suffix, coro::Shape &Shape, Function NewF, AnyCoroSuspendInst ActiveSuspend, TargetTransformInfo &TTI)
	Create a clone for a continuation lowering.

Protected Member Functions
	BaseCloner (Function &OrigF, const Twine &Suffix, coro::Shape &Shape, Function NewF, AnyCoroSuspendInst ActiveSuspend, TargetTransformInfo &TTI)
	Create a cloner for a continuation lowering.
bool	isSwitchDestroyFunction ()
void	replaceEntryBlock ()
Value *	deriveNewFramePointer ()
	Derive the value of the new frame pointer.
void	replaceRetconOrAsyncSuspendUses ()
	Replace uses of the active llvm.coro.suspend.retcon/async call with the arguments to the continuation function.
void	replaceCoroSuspends ()
void	replaceCoroEnds ()
void	replaceCoroIsInRamp ()
void	replaceSwiftErrorOps ()
void	salvageDebugInfo ()
void	handleFinalSuspend ()

Protected Attributes
Function &	OrigF
const Twine &	Suffix
coro::Shape &	Shape
CloneKind	FKind
IRBuilder	Builder
TargetTransformInfo &	TTI
ValueToValueMapTy	VMap
Function *	NewF = nullptr
Value *	NewFramePtr = nullptr
AnyCoroSuspendInst *	ActiveSuspend = nullptr
	The active suspend instruction; meaningful only for continuation and async ABIs.

Detailed Description

Definition at line 42 of file CoroCloner.h.

Constructor & Destructor Documentation

◆ BaseCloner() [1/2]

llvm::coro::BaseCloner::BaseCloner	(	Function &	OrigF,
		const Twine &	Suffix,
		coro::Shape &	Shape,
		Function *	NewF,
		AnyCoroSuspendInst *	ActiveSuspend,
		TargetTransformInfo &	TTI )

inlineprotected

Create a cloner for a continuation lowering.

Definition at line 60 of file CoroCloner.h.

References ActiveSuspend, assert(), llvm::coro::Async, Builder, llvm::coro::Continuation, FKind, getContext(), NewF, OrigF, llvm::coro::Retcon, llvm::coro::RetconOnce, Shape, Suffix, and TTI.

Referenced by createClone(), and llvm::coro::SwitchCloner::SwitchCloner().

◆ BaseCloner() [2/2]

llvm::coro::BaseCloner::BaseCloner	(	Function &	OrigF,
		const Twine &	Suffix,
		coro::Shape &	Shape,
		CloneKind	FKind,
		TargetTransformInfo &	TTI )

inline

Definition at line 75 of file CoroCloner.h.

References Builder, FKind, getContext(), OrigF, Shape, Suffix, and TTI.

◆ ~BaseCloner()

virtual llvm::coro::BaseCloner::~BaseCloner ( )

virtualdefault

Member Function Documentation

◆ create()

void coro::BaseCloner::create ( )

virtual

Clone the body of the original function into a resume function of some sort.

FIXME: Is it really good to add the NoAlias attribute?

Reimplemented in llvm::coro::SwitchCloner.

Definition at line 940 of file CoroSplit.cpp.

References A(), ActiveSuspend, addAsyncContextAttrs(), addFramePointerAttrs(), addSwiftSelfAttrs(), assert(), llvm::coro::Async, llvm::SmallVectorTemplateCommon< T, typename >::back(), Builder, llvm::cast(), llvm::changeToUnreachable(), llvm::CloneFunctionInto(), deriveNewFramePointer(), llvm::Instruction::eraseFromParent(), llvm::GlobalValue::ExternalLinkage, llvm::MDString::get(), llvm::PoisonValue::get(), llvm::BasicBlock::getParent(), llvm::BasicBlock::getTerminator(), llvm::PointerType::getUnqual(), handleFinalSuspend(), llvm::LocalChangesOnly, NewF, NewFramePtr, OrigF, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::Value::replaceAllUsesWith(), replaceCoroEnds(), replaceCoroIsInRamp(), replaceCoroSuspends(), replaceEntryBlock(), replaceRetconOrAsyncSuspendUses(), replaceSwiftErrorOps(), llvm::MDNode::replaceWithUniqued(), llvm::coro::Retcon, llvm::coro::RetconOnce, llvm::coro::salvageDebugInfo(), Shape, llvm::BasicBlock::splitBasicBlock(), llvm::coro::Switch, llvm::CallInst::TCK_MustTail, TTI, updateScopeLine(), and VMap.

Referenced by llvm::coro::SwitchCloner::create(), and createClone().

◆ createClone()

Function * llvm::coro::BaseCloner::createClone	(	Function &	OrigF,
		const Twine &	Suffix,
		coro::Shape &	Shape,
		Function *	NewF,
		AnyCoroSuspendInst *	ActiveSuspend,
		TargetTransformInfo &	TTI )

inlinestatic

Create a clone for a continuation lowering.

Definition at line 83 of file CoroCloner.h.

References ActiveSuspend, assert(), llvm::coro::Async, BaseCloner(), create(), getFunction(), NewF, OrigF, llvm::coro::Retcon, llvm::coro::RetconOnce, Shape, Suffix, and TTI.

Referenced by llvm::coro::AnyRetconABI::splitCoroutine(), and llvm::coro::AsyncABI::splitCoroutine().

◆ deriveNewFramePointer()

Value * coro::BaseCloner::deriveNewFramePointer ( )

protected

Derive the value of the new frame pointer.

Definition at line 800 of file CoroSplit.cpp.

References ActiveSuspend, assert(), llvm::coro::Async, Builder, llvm::cast(), llvm::Type::getInt64Ty(), llvm::PointerType::getUnqual(), llvm::InlineFunction(), InlineInfo, llvm_unreachable, NewF, llvm::coro::Retcon, llvm::coro::RetconOnce, Shape, llvm::coro::Switch, and VMap.

Referenced by create().

◆ getFunction()

Function * llvm::coro::BaseCloner::getFunction ( ) const

inline

Definition at line 96 of file CoroCloner.h.

References assert(), and NewF.

Referenced by createClone(), and llvm::coro::SwitchCloner::createClone().

◆ handleFinalSuspend()

void coro::BaseCloner::handleFinalSuspend ( )

protected

◆ isSwitchDestroyFunction()

bool llvm::coro::BaseCloner::isSwitchDestroyFunction ( )

inlineprotected

Definition at line 104 of file CoroCloner.h.

References llvm::coro::Async, llvm::coro::Continuation, FKind, llvm_unreachable, llvm::coro::SwitchCleanup, llvm::coro::SwitchResume, and llvm::coro::SwitchUnwind.

Referenced by handleFinalSuspend(), and replaceCoroSuspends().

◆ replaceCoroEnds()

void coro::BaseCloner::replaceCoroEnds ( )

protected

Definition at line 611 of file CoroSplit.cpp.

References llvm::cast(), NewFramePtr, replaceCoroEnd(), Shape, and VMap.

Referenced by create().

◆ replaceCoroIsInRamp()

void coro::BaseCloner::replaceCoroIsInRamp ( )

protected

Definition at line 620 of file CoroSplit.cpp.

References llvm::cast(), llvm::ConstantInt::getFalse(), II, OrigF, Shape, and VMap.

Referenced by create().

◆ replaceCoroSuspends()

void coro::BaseCloner::replaceCoroSuspends ( )

protected

Definition at line 574 of file CoroSplit.cpp.

References ActiveSuspend, llvm::coro::Async, Builder, llvm::cast(), isSwitchDestroyFunction(), llvm::coro::Retcon, llvm::coro::RetconOnce, Shape, llvm::coro::Switch, and VMap.

Referenced by create().

◆ replaceEntryBlock()

void coro::BaseCloner::replaceEntryBlock ( )

protected

Definition at line 733 of file CoroSplit.cpp.

References ActiveSuspend, assert(), llvm::coro::Async, Builder, llvm::cast(), llvm::dyn_cast(), F, I, instructions, llvm::isa(), llvm::DominatorTree::isReachableFromEntry(), llvm::make_early_inc_range(), NewF, llvm::coro::Retcon, llvm::coro::RetconOnce, Shape, Suffix, llvm::coro::Switch, and VMap.

Referenced by create().

◆ replaceRetconOrAsyncSuspendUses()

void coro::BaseCloner::replaceRetconOrAsyncSuspendUses ( )

protected

Replace uses of the active llvm.coro.suspend.retcon/async call with the arguments to the continuation function.

This assumes that the builder has a meaningful insertion point.

Definition at line 526 of file CoroSplit.cpp.

References ActiveSuspend, assert(), llvm::coro::Async, Builder, llvm::dyn_cast(), llvm::enumerate(), llvm::PoisonValue::get(), I, llvm::isa(), llvm::make_early_inc_range(), NewF, llvm::coro::Retcon, llvm::coro::RetconOnce, Shape, and VMap.

Referenced by create().

◆ replaceSwiftErrorOps()

void coro::BaseCloner::replaceSwiftErrorOps ( )

protected

Definition at line 696 of file CoroSplit.cpp.

References NewF, replaceSwiftErrorOps(), Shape, and VMap.

◆ salvageDebugInfo()

void coro::BaseCloner::salvageDebugInfo ( )

protected

Definition at line 700 of file CoroSplit.cpp.

References collectDbgVariableRecords(), llvm::dyn_cast(), llvm::for_each(), I, llvm::isa(), llvm::isa_and_nonnull(), llvm::isPotentiallyReachable(), NewF, OrigF, llvm::coro::salvageDebugInfo(), llvm::Value::users(), and Uses.

Member Data Documentation

◆ ActiveSuspend

AnyCoroSuspendInst* llvm::coro::BaseCloner::ActiveSuspend = nullptr

protected

The active suspend instruction; meaningful only for continuation and async ABIs.

Definition at line 57 of file CoroCloner.h.

Referenced by BaseCloner(), create(), llvm::coro::SwitchCloner::create(), createClone(), deriveNewFramePointer(), replaceCoroSuspends(), replaceEntryBlock(), and replaceRetconOrAsyncSuspendUses().

◆ Builder

IRBuilder llvm::coro::BaseCloner::Builder

protected

Definition at line 48 of file CoroCloner.h.

Referenced by BaseCloner(), BaseCloner(), create(), deriveNewFramePointer(), handleFinalSuspend(), replaceCoroSuspends(), replaceEntryBlock(), and replaceRetconOrAsyncSuspendUses().

◆ FKind

CloneKind llvm::coro::BaseCloner::FKind

protected

Definition at line 47 of file CoroCloner.h.

Referenced by BaseCloner(), BaseCloner(), llvm::coro::SwitchCloner::create(), llvm::coro::SwitchCloner::createClone(), isSwitchDestroyFunction(), and llvm::coro::SwitchCloner::SwitchCloner().

◆ NewF

Function* llvm::coro::BaseCloner::NewF = nullptr

protected

Definition at line 52 of file CoroCloner.h.

Referenced by BaseCloner(), create(), llvm::coro::SwitchCloner::create(), createClone(), deriveNewFramePointer(), getFunction(), handleFinalSuspend(), replaceEntryBlock(), replaceRetconOrAsyncSuspendUses(), replaceSwiftErrorOps(), and salvageDebugInfo().

◆ NewFramePtr

Value* llvm::coro::BaseCloner::NewFramePtr = nullptr

protected

Definition at line 53 of file CoroCloner.h.

Referenced by create(), llvm::coro::SwitchCloner::create(), handleFinalSuspend(), and replaceCoroEnds().

◆ OrigF

Function& llvm::coro::BaseCloner::OrigF

protected

Definition at line 44 of file CoroCloner.h.

Referenced by BaseCloner(), BaseCloner(), create(), llvm::coro::SwitchCloner::create(), createClone(), llvm::coro::SwitchCloner::createClone(), replaceCoroIsInRamp(), salvageDebugInfo(), and llvm::coro::SwitchCloner::SwitchCloner().

◆ Shape

coro::Shape& llvm::coro::BaseCloner::Shape

protected

Definition at line 46 of file CoroCloner.h.

Referenced by BaseCloner(), BaseCloner(), create(), llvm::coro::SwitchCloner::create(), createClone(), llvm::coro::SwitchCloner::createClone(), deriveNewFramePointer(), handleFinalSuspend(), replaceCoroEnds(), replaceCoroIsInRamp(), replaceCoroSuspends(), replaceEntryBlock(), replaceRetconOrAsyncSuspendUses(), replaceSwiftErrorOps(), and llvm::coro::SwitchCloner::SwitchCloner().

◆ Suffix

const Twine& llvm::coro::BaseCloner::Suffix

protected

Definition at line 45 of file CoroCloner.h.

Referenced by BaseCloner(), BaseCloner(), llvm::coro::SwitchCloner::create(), createClone(), llvm::coro::SwitchCloner::createClone(), replaceEntryBlock(), and llvm::coro::SwitchCloner::SwitchCloner().

◆ TTI

TargetTransformInfo& llvm::coro::BaseCloner::TTI

protected

Definition at line 49 of file CoroCloner.h.

Referenced by BaseCloner(), BaseCloner(), create(), createClone(), llvm::coro::SwitchCloner::createClone(), and llvm::coro::SwitchCloner::SwitchCloner().

◆ VMap

ValueToValueMapTy llvm::coro::BaseCloner::VMap

protected

Definition at line 51 of file CoroCloner.h.

Referenced by create(), deriveNewFramePointer(), handleFinalSuspend(), replaceCoroEnds(), replaceCoroIsInRamp(), replaceCoroSuspends(), replaceEntryBlock(), replaceRetconOrAsyncSuspendUses(), and replaceSwiftErrorOps().

The documentation for this class was generated from the following files:

lib/Transforms/Coroutines/CoroCloner.h
lib/Transforms/Coroutines/CoroSplit.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BaseCloner() [1/2]

◆ BaseCloner() [2/2]

◆ ~BaseCloner()

Member Function Documentation

◆ create()

◆ createClone()

◆ deriveNewFramePointer()

◆ getFunction()

◆ handleFinalSuspend()

◆ isSwitchDestroyFunction()

◆ replaceCoroEnds()

◆ replaceCoroIsInRamp()

◆ replaceCoroSuspends()

◆ replaceEntryBlock()

◆ replaceRetconOrAsyncSuspendUses()

◆ replaceSwiftErrorOps()

◆ salvageDebugInfo()

Member Data Documentation

◆ ActiveSuspend

◆ Builder

◆ FKind

◆ NewF

◆ NewFramePtr

◆ OrigF

◆ Shape

◆ Suffix

◆ TTI

◆ VMap