LLVM 18.0.0git
Classes | Public Member Functions | Public Attributes | List of all members
llvm::coro::Shape Struct Reference

#include "Transforms/Coroutines/CoroInternal.h"

Classes

struct  AsyncLoweringStorage
 
struct  RetconLoweringStorage
 
struct  SwitchFieldIndex
 
struct  SwitchLoweringStorage
 

Public Member Functions

CoroIdInst * getSwitchCoroId () const
 
AnyCoroIdRetconInst * getRetconCoroId () const
 
CoroIdAsyncInst * getAsyncCoroId () const
 
unsigned getSwitchIndexField () 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
 
Instruction * getInsertPtAfterFramePtr () const
 
Value * emitAlloc (IRBuilder<> &Builder, Value *Size, CallGraph *CG) const
 Allocate memory according to the rules of the active lowering.
 
void emitDealloc (IRBuilder<> &Builder, Value *Ptr, CallGraph *CG) const
 Deallocate memory according to the rules of the active lowering.
 
 Shape ()=default
 
 Shape (Function &F, bool OptimizeFrame=false)
 
void buildFrom (Function &F)
 

Public Attributes

CoroBeginInst * CoroBegin
 
SmallVector< AnyCoroEndInst *, 4 > CoroEnds
 
SmallVector< CoroSizeInst *, 2 > CoroSizes
 
SmallVector< CoroAlignInst *, 2 > CoroAligns
 
SmallVector< AnyCoroSuspendInst *, 4 > CoroSuspends
 
SmallVector< CallInst *, 2 > SwiftErrorOps
 
coro::ABI ABI
 
StructType * FrameTy
 
Align FrameAlign
 
uint64_t FrameSize
 
Value * FramePtr
 
BasicBlock * AllocaSpillBlock
 
bool OptimizeFrame
 This would only be true if optimization are enabled.
 
union {
   SwitchLoweringStorage   SwitchLowering
 
   RetconLoweringStorage   RetconLowering
 
   AsyncLoweringStorage   AsyncLowering
 
}; 
 

Detailed Description

Definition at line 76 of file CoroInternal.h.

Constructor & Destructor Documentation

◆ Shape() [1/2]

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

◆ Shape() [2/2]

llvm::coro::Shape::Shape ( Function &  F,
bool  OptimizeFrame = false 
)
inlineexplicit

Definition at line 260 of file CoroInternal.h.

References F.

Member Function Documentation

◆ buildFrom()

void coro::Shape::buildFrom ( Function &  F)

Definition at line 168 of file Coroutines.cpp.

References llvm::coro::Async, llvm::changeToUnreachable(), clear(), createCoroSave(), llvm::Type::dump(), E, F, llvm::PointerType::get(), llvm::UndefValue::get(), I, instructions, llvm::CastInst::isBitCastable(), llvm::Type::isVoidTy(), llvm_unreachable, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::report_fatal_error(), llvm::coro::Retcon, llvm::coro::RetconOnce, llvm::ArrayRef< T >::size(), std::swap(), and llvm::coro::Switch.

◆ 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 449 of file Coroutines.cpp.

References addCallToCallGraph(), llvm::Alloc, llvm::coro::Async, llvm::IRBuilderBase::CreateCall(), llvm::IRBuilderBase::CreateIntCast(), llvm_unreachable, propagateCallAttrsFromCallee(), llvm::coro::Retcon, llvm::coro::RetconOnce, Size, and llvm::coro::Switch.

Referenced by lowerNonLocalAlloca(), and splitRetconCoroutine().

◆ 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 472 of file Coroutines.cpp.

References addCallToCallGraph(), llvm::coro::Async, llvm::IRBuilderBase::CreateBitCast(), llvm::IRBuilderBase::CreateCall(), llvm_unreachable, propagateCallAttrsFromCallee(), Ptr, llvm::coro::Retcon, llvm::coro::RetconOnce, and llvm::coro::Switch.

Referenced by lowerNonLocalAlloca(), and maybeFreeRetconStorage().

◆ getAsyncCoroId()

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

Definition at line 159 of file CoroInternal.h.

References assert(), and llvm::CoroBeginInst::getId().

◆ getIndex()

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

Definition at line 174 of file CoroInternal.h.

Referenced by createResumeEntryBlock(), and markCoroutineAsDone().

◆ getIndexType()

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

Definition at line 169 of file CoroInternal.h.

References assert(), and llvm::StructType::getElementType().

Referenced by createResumeEntryBlock().

◆ getInsertPtAfterFramePtr()

Instruction * llvm::coro::Shape::getInsertPtAfterFramePtr ( ) const
inline

Definition at line 243 of file CoroInternal.h.

References FramePtr, and I.

Referenced by buildFrameDebugInfo(), insertSpills(), and updateCoroFrame().

◆ getPromiseAlloca()

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

Definition at line 237 of file CoroInternal.h.

Referenced by buildFrameDebugInfo(), and buildFrameType().

◆ getResumeFunctionCC()

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

Definition at line 223 of file CoroInternal.h.

References llvm_unreachable.

◆ getResumeFunctionType()

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

Definition at line 184 of file CoroInternal.h.

References llvm::Type::getContext(), and llvm_unreachable.

Referenced by createCloneDeclaration(), and replaceFallthroughCoroEnd().

◆ getRetconCoroId()

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

Definition at line 153 of file CoroInternal.h.

References assert(), and llvm::CoroBeginInst::getId().

Referenced by buildFrameType().

◆ getRetconResultTypes()

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

Definition at line 201 of file CoroInternal.h.

References assert(), llvm::Instruction::getFunction(), and llvm::Function::getFunctionType().

Referenced by splitRetconCoroutine().

◆ getRetconResumeTypes()

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

Definition at line 214 of file CoroInternal.h.

References assert().

◆ getSwitchCoroId()

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

Definition at line 148 of file CoroInternal.h.

References assert(), and llvm::CoroBeginInst::getId().

Referenced by llvm::coro::buildCoroutineFrame(), setCoroInfo(), and updateCoroFrame().

◆ getSwitchIndexField()

unsigned llvm::coro::Shape::getSwitchIndexField ( ) const
inline

Definition at line 164 of file CoroInternal.h.

References assert().

Referenced by createResumeEntryBlock(), and markCoroutineAsDone().

◆ getSwitchResumePointerType()

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

Definition at line 178 of file CoroInternal.h.

References assert(), and llvm::StructType::getElementType().

Member Data Documentation

◆ 

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

◆ ABI

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

Definition at line 99 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), buildFrameDebugInfo(), buildFrameType(), collectFrameAlloca(), createCloneDeclaration(), createResumeEntryBlock(), handleNoSuspendCoroutine(), insertSpills(), markCoroutineAsDone(), maybeFreeRetconStorage(), replaceFallthroughCoroEnd(), replaceFrameSizeAndAlignment(), replaceSwiftErrorOps(), replaceUnwindCoroEnd(), setCoroInfo(), simplifySuspendPoints(), splitAsyncCoroutine(), splitCoroutine(), splitRetconCoroutine(), splitSwitchCoroutine(), updateAsyncFuncPointerContextSize(), updateCallGraphAfterCoroutineSplit(), and updateCoroFrame().

◆ AllocaSpillBlock

BasicBlock* llvm::coro::Shape::AllocaSpillBlock

Definition at line 105 of file CoroInternal.h.

Referenced by clear(), and insertSpills().

◆ AsyncLowering

AsyncLoweringStorage llvm::coro::Shape::AsyncLowering

Definition at line 145 of file CoroInternal.h.

Referenced by buildFrameType(), splitAsyncCoroutine(), and updateAsyncFuncPointerContextSize().

◆ CoroAligns

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

Definition at line 80 of file CoroInternal.h.

Referenced by replaceFrameSizeAndAlignment().

◆ CoroBegin

CoroBeginInst* llvm::coro::Shape::CoroBegin

Definition at line 77 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), clear(), collectFrameAlloca(), handleNoSuspendCoroutine(), insertSpills(), simplifySuspendPoints(), splitAsyncCoroutine(), splitCoroutine(), splitRetconCoroutine(), and updateCallGraphAfterCoroutineSplit().

◆ CoroEnds

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

Definition at line 78 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), clear(), eliminateSwiftErrorArgument(), removeCoroEnds(), and updateCallGraphAfterCoroutineSplit().

◆ CoroSizes

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

Definition at line 79 of file CoroInternal.h.

Referenced by clear(), and replaceFrameSizeAndAlignment().

◆ CoroSuspends

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

Definition at line 81 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), buildFrameType(), clear(), collectFrameAlloca(), createResumeEntryBlock(), eliminateSwiftErrorArgument(), markCoroutineAsDone(), replaceSwiftErrorOps(), simplifySuspendPoints(), sinkLifetimeStartMarkers(), splitAsyncCoroutine(), splitCoroutine(), and splitRetconCoroutine().

◆ FrameAlign

Align llvm::coro::Shape::FrameAlign

Definition at line 102 of file CoroInternal.h.

Referenced by buildFrameDebugInfo(), buildFrameType(), handleNoSuspendCoroutine(), and replaceFrameSizeAndAlignment().

◆ FramePtr

Value* llvm::coro::Shape::FramePtr

Definition at line 104 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), buildFrameDebugInfo(), clear(), createResumeEntryBlock(), insertSpills(), removeCoroEnds(), splitAsyncCoroutine(), splitRetconCoroutine(), and updateCoroFrame().

◆ FrameSize

uint64_t llvm::coro::Shape::FrameSize

Definition at line 103 of file CoroInternal.h.

Referenced by buildFrameDebugInfo(), and buildFrameType().

◆ FrameTy

StructType* llvm::coro::Shape::FrameTy

Definition at line 101 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), buildFrameDebugInfo(), clear(), createResumeEntryBlock(), handleNoSuspendCoroutine(), insertSpills(), markCoroutineAsDone(), replaceFrameSizeAndAlignment(), splitRetconCoroutine(), and updateCoroFrame().

◆ OptimizeFrame

bool llvm::coro::Shape::OptimizeFrame

This would only be true if optimization are enabled.

Definition at line 108 of file CoroInternal.h.

Referenced by insertSpills(), and splitCoroutine().

◆ RetconLowering

RetconLoweringStorage llvm::coro::Shape::RetconLowering

Definition at line 144 of file CoroInternal.h.

Referenced by buildFrameType(), maybeFreeRetconStorage(), and splitRetconCoroutine().

◆ SwiftErrorOps

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

Definition at line 82 of file CoroInternal.h.

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

◆ SwitchLowering

SwitchLoweringStorage llvm::coro::Shape::SwitchLowering

Definition at line 143 of file CoroInternal.h.

Referenced by llvm::coro::buildCoroutineFrame(), buildFrameDebugInfo(), buildFrameType(), collectFrameAlloca(), createResumeEntryBlock(), insertSpills(), markCoroutineAsDone(), and simplifySuspendPoints().

The documentation for this struct was generated from the following files:
Generated on Wed Dec 6 2023 23:23:50 for LLVM by doxygen 1.9.6