LLVM: llvm::coro::Shape Struct Reference

LLVM 24.0.0git

#include "llvm/Transforms/Coroutines/CoroShape.h"

Classes
struct	AsyncLoweringStorage
struct	RetconLoweringStorage
struct	SwitchLoweringStorage

Public Member Functions
void	clear ()
LLVM_ABI void	analyze (Function &F, SmallVectorImpl< CoroFrameInst * > &CoroFrames, SmallVectorImpl< CoroSaveInst * > &UnusedCoroSaves)
LLVM_ABI void	invalidateCoroutine (Function &F, SmallVectorImpl< CoroFrameInst * > &CoroFrames)
LLVM_ABI void	initABI ()
LLVM_ABI void	cleanCoroutine (SmallVectorImpl< CoroFrameInst * > &CoroFrames, SmallVectorImpl< CoroSaveInst * > &UnusedCoroSaves)
CoroIdInst *	getSwitchCoroId () const
AnyCoroIdRetconInst *	getRetconCoroId () const
CoroIdAsyncInst *	getAsyncCoroId () const
IntegerType *	getIndexType () const
ConstantInt *	getIndex (uint64_t Value) const
PointerType *	getSwitchResumePointerType () const
FunctionType *	getResumeFunctionType () const
ArrayRef< Type * >	getRetconResultTypes () const
ArrayRef< Type * >	getRetconResumeTypes () const
CallingConv::ID	getResumeFunctionCC () const
AllocaInst *	getPromiseAlloca () const
BasicBlock::iterator	getInsertPtAfterFramePtr () const
LLVM_ABI Value *	emitAlloc (IRBuilder<> &Builder, Value Size, CallGraph CG) const
	Allocate memory according to the rules of the active lowering.
LLVM_ABI void	emitDealloc (IRBuilder<> &Builder, Value Ptr, CallGraph CG) const
	Deallocate memory according to the rules of the active lowering.
	Shape ()=default
	Shape (Function &F)

Public Attributes
CoroBeginInst *	CoroBegin = nullptr
SmallVector< AnyCoroEndInst *, 4 >	CoroEnds
SmallVector< CoroIsInRampInst *, 2 >	CoroIsInRampInsts
SmallVector< CoroSizeInst *, 2 >	CoroSizes
SmallVector< CoroAlignInst *, 2 >	CoroAligns
SmallVector< AnyCoroSuspendInst *, 4 >	CoroSuspends
SmallDenseMap< AnyCoroSuspendInst *, uint64_t, 4 >	SuspendFreqs
std::optional< uint64_t >	ResumeEntryCount
SmallVector< CoroAwaitSuspendInst *, 4 >	CoroAwaitSuspends
SmallVector< CallInst *, 2 >	SymmetricTransfers
SmallVector< CallInst *, 2 >	SwiftErrorOps
coro::ABI	ABI
Align	FrameAlign
uint64_t	FrameSize = 0
Value *	FramePtr = nullptr
BasicBlock *	AllocaSpillBlock = nullptr
union {
SwitchLoweringStorage SwitchLowering
RetconLoweringStorage RetconLowering
AsyncLoweringStorage AsyncLowering
};

Detailed Description

Definition at line 54 of file CoroShape.h.

Constructor & Destructor Documentation

◆ Shape() [1/2]

llvm::coro::Shape::Shape ( )

default

Referenced by doSplitCoroutine().

◆ Shape() [2/2]

llvm::coro::Shape::Shape ( Function & F )

inlineexplicit

Definition at line 265 of file CoroShape.h.

References analyze(), cleanCoroutine(), CoroBegin, F, and invalidateCoroutine().

Member Function Documentation

◆ analyze()

void coro::Shape::analyze	(	Function &	F,
		SmallVectorImpl< CoroFrameInst * > &	CoroFrames,
		SmallVectorImpl< CoroSaveInst * > &	UnusedCoroSaves )

Definition at line 183 of file Coroutines.cpp.

References ABI, llvm::coro::Async, AsyncLowering, llvm::cast(), clear(), CoroAligns, CoroAwaitSuspends, CoroBegin, CoroEnds, CoroIsInRampInsts, CoroSizes, CoroSuspends, llvm::dyn_cast(), F, getAsyncCoroId(), getRetconCoroId(), getSwitchCoroId(), I, II, instructions, llvm::isa(), llvm_unreachable, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::report_fatal_error(), llvm::coro::Retcon, RetconLowering, llvm::coro::RetconOnce, std::swap(), llvm::coro::Switch, and SwitchLowering.

Referenced by Shape().

◆ cleanCoroutine()

void coro::Shape::cleanCoroutine	(	SmallVectorImpl< CoroFrameInst * > &	CoroFrames,
		SmallVectorImpl< CoroSaveInst * > &	UnusedCoroSaves )

Definition at line 472 of file Coroutines.cpp.

References llvm::SmallVectorImpl< T >::clear(), and CoroBegin.

Referenced by Shape().

◆ clear()

void llvm::coro::Shape::clear ( )

inline

Definition at line 72 of file CoroShape.h.

References AllocaSpillBlock, CoroAligns, CoroAwaitSuspends, CoroBegin, CoroEnds, CoroIsInRampInsts, CoroSizes, CoroSuspends, FramePtr, ResumeEntryCount, SuspendFreqs, SwiftErrorOps, and SymmetricTransfers.

Referenced by analyze().

◆ emitAlloc()

Value * coro::Shape::emitAlloc	(	IRBuilder<> &	Builder,
		Value *	Size,
		CallGraph *	CG ) const

Allocate memory according to the rules of the active lowering.

Parameters

CG	- if non-null, will be updated for the new call

Definition at line 498 of file Coroutines.cpp.

References ABI, addCallToCallGraph(), llvm::Alloc, llvm::coro::Async, Call, llvm_unreachable, propagateCallAttrsFromCallee(), llvm::coro::Retcon, RetconLowering, llvm::coro::RetconOnce, Size, and llvm::coro::Switch.

Referenced by lowerNonLocalAlloca().

◆ emitDealloc()

void coro::Shape::emitDealloc	(	IRBuilder<> &	Builder,
		Value *	Ptr,
		CallGraph *	CG ) const

Deallocate memory according to the rules of the active lowering.

Parameters

CG	- if non-null, will be updated for the new call

Definition at line 521 of file Coroutines.cpp.

References ABI, addCallToCallGraph(), llvm::coro::Async, Call, llvm_unreachable, propagateCallAttrsFromCallee(), llvm::coro::Retcon, RetconLowering, llvm::coro::RetconOnce, and llvm::coro::Switch.

Referenced by lowerNonLocalAlloca(), and maybeFreeRetconStorage().

◆ getAsyncCoroId()

CoroIdAsyncInst * llvm::coro::Shape::getAsyncCoroId ( ) const

inline

Definition at line 163 of file CoroShape.h.

References ABI, assert(), llvm::coro::Async, llvm::cast(), and CoroBegin.

Referenced by analyze().

◆ getIndex()

ConstantInt * llvm::coro::Shape::getIndex ( uint64_t Value ) const

inline

Definition at line 173 of file CoroShape.h.

References getIndexType().

Referenced by markCoroutineAsDone().

◆ getIndexType()

IntegerType * llvm::coro::Shape::getIndexType ( ) const

inline

Definition at line 168 of file CoroShape.h.

References ABI, assert(), llvm::coro::Switch, and SwitchLowering.

Referenced by buildFrameDebugInfo(), and getIndex().

◆ getInsertPtAfterFramePtr()

BasicBlock::iterator llvm::coro::Shape::getInsertPtAfterFramePtr ( ) const

inline

Definition at line 243 of file CoroShape.h.

References llvm::cast(), llvm::dyn_cast(), FramePtr, and I.

Referenced by buildFrameDebugInfo(), llvm::coro::getSpillInsertionPt(), and insertSpills().

◆ getPromiseAlloca()

AllocaInst * llvm::coro::Shape::getPromiseAlloca ( ) const

inline

Definition at line 237 of file CoroShape.h.

References ABI, llvm::coro::Switch, and SwitchLowering.

Referenced by buildFrameLayout().

◆ getResumeFunctionCC()

CallingConv::ID llvm::coro::Shape::getResumeFunctionCC ( ) const

inline

Definition at line 220 of file CoroShape.h.

References ABI, llvm::coro::Async, AsyncLowering, llvm::CallingConv::C, llvm_unreachable, llvm::coro::Retcon, RetconLowering, llvm::coro::RetconOnce, and llvm::coro::Switch.

◆ getResumeFunctionType()

FunctionType * llvm::coro::Shape::getResumeFunctionType ( ) const

inline

Definition at line 183 of file CoroShape.h.

References ABI, llvm::coro::Async, CoroBegin, llvm::FunctionType::get(), llvm::PointerType::getUnqual(), llvm::Type::getVoidTy(), llvm_unreachable, llvm::coro::Retcon, RetconLowering, llvm::coro::RetconOnce, and llvm::coro::Switch.

Referenced by createCloneDeclaration(), and replaceFallthroughCoroEnd().

◆ getRetconCoroId()

AnyCoroIdRetconInst * llvm::coro::Shape::getRetconCoroId ( ) const

inline

Definition at line 158 of file CoroShape.h.

References ABI, assert(), llvm::cast(), CoroBegin, llvm::coro::Retcon, and llvm::coro::RetconOnce.

Referenced by analyze(), and buildFrameLayout().

◆ getRetconResultTypes()

ArrayRef< Type * > llvm::coro::Shape::getRetconResultTypes ( ) const

inline

Definition at line 200 of file CoroShape.h.

References ABI, llvm::ArrayRef(), assert(), CoroBegin, llvm::dyn_cast(), llvm::coro::Retcon, and llvm::coro::RetconOnce.

◆ getRetconResumeTypes()

ArrayRef< Type * > llvm::coro::Shape::getRetconResumeTypes ( ) const

inline

Definition at line 212 of file CoroShape.h.

References ABI, assert(), llvm::coro::Retcon, RetconLowering, and llvm::coro::RetconOnce.

◆ getSwitchCoroId()

CoroIdInst * llvm::coro::Shape::getSwitchCoroId ( ) const

inline

Definition at line 153 of file CoroShape.h.

References ABI, assert(), llvm::cast(), CoroBegin, and llvm::coro::Switch.

Referenced by analyze(), handleNoSuspendCoroutine(), and llvm::coro::normalizeCoroutine().

◆ getSwitchResumePointerType()

PointerType * llvm::coro::Shape::getSwitchResumePointerType ( ) const

inline

Definition at line 177 of file CoroShape.h.

References ABI, assert(), CoroBegin, llvm::PointerType::getUnqual(), and llvm::coro::Switch.

Referenced by buildFrameDebugInfo(), buildFrameLayout(), markCoroutineAsDone(), and replaceSwitchResumeCoroFree().

◆ initABI()

LLVM_ABI void llvm::coro::Shape::initABI ( )

References LLVM_ABI.

◆ invalidateCoroutine()

void coro::Shape::invalidateCoroutine	(	Function &	F,
		SmallVectorImpl< CoroFrameInst * > &	CoroFrames )

Definition at line 342 of file Coroutines.cpp.

References assert(), llvm::changeToUnreachable(), CoroBegin, CoroEnds, CoroSuspends, llvm::sampleprof::CS, F, llvm::PointerType::get(), llvm::PoisonValue::get(), and Poison.

Referenced by Shape().

Member Data Documentation

◆ [union]

union { ... } llvm::coro::Shape

◆ ABI

coro::ABI llvm::coro::Shape::ABI

Definition at line 105 of file CoroShape.h.

Referenced by analyze(), buildFrameDebugInfo(), buildFrameLayout(), collectFrameAlloca(), createCloneDeclaration(), CreateNewABI(), doSplitCoroutine(), emitAlloc(), emitDealloc(), getAsyncCoroId(), getIndexType(), getPromiseAlloca(), getResumeFunctionCC(), getResumeFunctionType(), getRetconCoroId(), getRetconResultTypes(), getRetconResumeTypes(), getSwitchCoroId(), getSwitchResumePointerType(), handleNoSuspendCoroutine(), insertSpills(), markCoroutineAsDone(), maybeFreeRetconStorage(), llvm::coro::normalizeCoroutine(), removeCoroEndsFromRampFunction(), replaceFallthroughCoroEnd(), replaceFrameSizeAndAlignment(), replaceSwiftErrorOps(), replaceUnwindCoroEnd(), llvm::CoroSplitPass::run(), simplifySuspendPoints(), updateAsyncFuncPointerContextSize(), and updateCallGraphAfterCoroutineSplit().

◆ AllocaSpillBlock

BasicBlock* llvm::coro::Shape::AllocaSpillBlock = nullptr

Definition at line 110 of file CoroShape.h.

Referenced by clear(), and insertSpills().

◆ AsyncLowering

AsyncLoweringStorage llvm::coro::Shape::AsyncLowering

Definition at line 150 of file CoroShape.h.

Referenced by analyze(), buildFrameLayout(), getResumeFunctionCC(), and updateAsyncFuncPointerContextSize().

◆ CoroAligns

SmallVector<CoroAlignInst *, 2> llvm::coro::Shape::CoroAligns

Definition at line 59 of file CoroShape.h.

Referenced by analyze(), clear(), and replaceFrameSizeAndAlignment().

◆ CoroAwaitSuspends

SmallVector<CoroAwaitSuspendInst *, 4> llvm::coro::Shape::CoroAwaitSuspends

Definition at line 66 of file CoroShape.h.

Referenced by analyze(), clear(), and lowerAwaitSuspends().

◆ CoroBegin

CoroBeginInst* llvm::coro::Shape::CoroBegin = nullptr

◆ CoroEnds

SmallVector<AnyCoroEndInst *, 4> llvm::coro::Shape::CoroEnds

Definition at line 56 of file CoroShape.h.

Referenced by analyze(), clear(), eliminateSwiftErrorArgument(), invalidateCoroutine(), llvm::coro::normalizeCoroutine(), removeCoroEndsFromRampFunction(), and llvm::SuspendCrossingInfo::SuspendCrossingInfo().

◆ CoroIsInRampInsts

SmallVector<CoroIsInRampInst *, 2> llvm::coro::Shape::CoroIsInRampInsts

Definition at line 57 of file CoroShape.h.

Referenced by analyze(), clear(), removeCoroIsInRampFromRampFunction(), and llvm::SuspendCrossingInfo::SuspendCrossingInfo().

◆ CoroSizes

SmallVector<CoroSizeInst *, 2> llvm::coro::Shape::CoroSizes

Definition at line 58 of file CoroShape.h.

Referenced by analyze(), clear(), and replaceFrameSizeAndAlignment().

◆ CoroSuspends

SmallVector<AnyCoroSuspendInst *, 4> llvm::coro::Shape::CoroSuspends

Definition at line 60 of file CoroShape.h.

Referenced by analyze(), buildFrameLayout(), clear(), collectFrameAlloca(), doSplitCoroutine(), eliminateSwiftErrorArgument(), invalidateCoroutine(), markCoroutineAsDone(), llvm::coro::normalizeCoroutine(), replaceSwiftErrorOps(), llvm::CoroSplitPass::run(), simplifySuspendPoints(), sinkLifetimeStartMarkers(), and llvm::SuspendCrossingInfo::SuspendCrossingInfo().

◆ FrameAlign

Align llvm::coro::Shape::FrameAlign

Definition at line 107 of file CoroShape.h.

Referenced by buildFrameDebugInfo(), buildFrameLayout(), handleNoSuspendCoroutine(), replaceFrameSizeAndAlignment(), and llvm::CoroSplitPass::run().

◆ FramePtr

Value* llvm::coro::Shape::FramePtr = nullptr

Definition at line 109 of file CoroShape.h.

Referenced by buildFrameDebugInfo(), clear(), createGEPToFramePointer(), createStoreIntoFrame(), getInsertPtAfterFramePtr(), and removeCoroEndsFromRampFunction().

◆ FrameSize

uint64_t llvm::coro::Shape::FrameSize = 0

Definition at line 108 of file CoroShape.h.

Referenced by buildFrameDebugInfo(), buildFrameLayout(), handleNoSuspendCoroutine(), replaceFrameSizeAndAlignment(), and llvm::CoroSplitPass::run().

◆ ResumeEntryCount

std::optional<uint64_t> llvm::coro::Shape::ResumeEntryCount

Definition at line 65 of file CoroShape.h.

Referenced by clear(), and llvm::CoroSplitPass::run().

◆ RetconLowering

RetconLoweringStorage llvm::coro::Shape::RetconLowering

Definition at line 149 of file CoroShape.h.

Referenced by analyze(), buildFrameLayout(), emitAlloc(), emitDealloc(), getResumeFunctionCC(), getResumeFunctionType(), getRetconResumeTypes(), and maybeFreeRetconStorage().

◆ SuspendFreqs

SmallDenseMap<AnyCoroSuspendInst *, uint64_t, 4> llvm::coro::Shape::SuspendFreqs

Definition at line 63 of file CoroShape.h.

Referenced by clear(), and llvm::CoroSplitPass::run().

◆ SwiftErrorOps

SmallVector<CallInst *, 2> llvm::coro::Shape::SwiftErrorOps

Definition at line 70 of file CoroShape.h.

Referenced by clear(), emitGetSwiftErrorValue(), emitSetSwiftErrorValue(), and replaceSwiftErrorOps().

◆ SwitchLowering

SwitchLoweringStorage llvm::coro::Shape::SwitchLowering

Definition at line 148 of file CoroShape.h.

Referenced by analyze(), buildFrameDebugInfo(), buildFrameLayout(), collectFrameAlloca(), createSwitchDestroyPtr(), createSwitchIndexPtr(), doSplitCoroutine(), getIndexType(), getPromiseAlloca(), hasAccessingPromiseBeforeCB(), markCoroutineAsDone(), llvm::coro::normalizeCoroutine(), simplifySuspendPoints(), and updateCallGraphAfterCoroutineSplit().

◆ SymmetricTransfers

SmallVector<CallInst *, 2> llvm::coro::Shape::SymmetricTransfers

Definition at line 67 of file CoroShape.h.

Referenced by clear(), and lowerAwaitSuspend().

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

include/llvm/Transforms/Coroutines/CoroShape.h
lib/Transforms/Coroutines/Coroutines.cpp