#include "CoroInternal.h"
#include "llvm/ADT/BitVector.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/Analysis/PtrUseVisitor.h"
#include "llvm/Analysis/StackLifetime.h"
#include "llvm/Config/llvm-config.h"
#include "llvm/IR/CFG.h"
#include "llvm/IR/DIBuilder.h"
#include "llvm/IR/Dominators.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/InstIterator.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/MathExtras.h"
#include "llvm/Support/OptimizedStructLayout.h"
#include "llvm/Support/circular_raw_ostream.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
#include "llvm/Transforms/Utils/Local.h"
#include "llvm/Transforms/Utils/PromoteMemToReg.h"
#include <algorithm>

Include dependency graph for CoroFrame.cpp:

Macros
#define	DEBUG_TYPE "coro-suspend-crossing"

#define	DEBUG_TYPE "coro-frame"

Typedefs
typedef SmallPtrSet< BasicBlock *, 8 >	VisitedBlocksSet

Enumerations
enum	{ SmallVectorThreshold = 32 }

Functions
static void	dumpSpills (StringRef Title, const SpillInfo &Spills)

static void	dumpAllocas (const SmallVectorImpl< AllocaInfo > &Allocas)

static void	cacheDIVar (FrameDataInfo &FrameData, DenseMap< Value , DILocalVariable > &DIVarCache)

static StringRef	solveTypeName (Type *Ty)
	Create name for Type. More...

static DIType *	solveDIType (DIBuilder &Builder, Type Ty, DataLayout &Layout, DIScope Scope, unsigned LineNum, DenseMap< Type , DIType > &DITypeCache)

static void	buildFrameDebugInfo (Function &F, coro::Shape &Shape, FrameDataInfo &FrameData)
	Build artificial debug info for C++ coroutine frames to allow users to inspect the contents of the frame directly. More...

static StructType *	buildFrameType (Function &F, coro::Shape &Shape, FrameDataInfo &FrameData)

static Instruction *	splitBeforeCatchSwitch (CatchSwitchInst *CatchSwitch)

static void	createFramePtr (coro::Shape &Shape)

static Instruction *	insertSpills (const FrameDataInfo &FrameData, coro::Shape &Shape)

static void	movePHIValuesToInsertedBlock (BasicBlock SuccBB, BasicBlock InsertedBB, BasicBlock PredBB, PHINode UntilPHI=nullptr)

static void	rewritePHIsForCleanupPad (BasicBlock CleanupPadBB, CleanupPadInst CleanupPad)

static void	cleanupSinglePredPHIs (Function &F)

static void	rewritePHIs (BasicBlock &BB)

static void	rewritePHIs (Function &F)

static bool	materializable (Instruction &V)

static bool	isCoroutineStructureIntrinsic (Instruction &I)

static void	rewriteMaterializableInstructions (IRBuilder<> &IRB, const SpillInfo &Spills)

static BasicBlock *	splitBlockIfNotFirst (Instruction *I, const Twine &Name)

static void	splitAround (Instruction *I, const Twine &Name)

static bool	isSuspendBlock (BasicBlock *BB)

static bool	isSuspendReachableFrom (BasicBlock *From, VisitedBlocksSet &VisitedOrFreeBBs)
	Does control flow starting at the given block ever reach a suspend instruction before reaching a block in VisitedOrFreeBBs? More...

static bool	isLocalAlloca (CoroAllocaAllocInst *AI)
	Is the given alloca "local", i.e. More...

static bool	willLeaveFunctionImmediatelyAfter (BasicBlock *BB, unsigned depth=3)
	After we split the coroutine, will the given basic block be along an obvious exit path for the resumption function? More...

static bool	localAllocaNeedsStackSave (CoroAllocaAllocInst *AI)

static void	lowerLocalAllocas (ArrayRef< CoroAllocaAllocInst * > LocalAllocas, SmallVectorImpl< Instruction * > &DeadInsts)
	Turn each of the given local allocas into a normal (dynamic) alloca instruction. More...

static Instruction *	lowerNonLocalAlloca (CoroAllocaAllocInst AI, coro::Shape &Shape, SmallVectorImpl< Instruction > &DeadInsts)
	Turn the given coro.alloca.alloc call into a dynamic allocation. More...

static Value *	emitGetSwiftErrorValue (IRBuilder<> &Builder, Type *ValueTy, coro::Shape &Shape)
	Get the current swifterror value. More...

static Value *	emitSetSwiftErrorValue (IRBuilder<> &Builder, Value *V, coro::Shape &Shape)
	Set the given value as the current swifterror value. More...

static Value *	emitSetAndGetSwiftErrorValueAround (Instruction Call, AllocaInst Alloca, coro::Shape &Shape)
	Set the swifterror value from the given alloca before a call, then put in back in the alloca afterwards. More...

static void	eliminateSwiftErrorAlloca (Function &F, AllocaInst *Alloca, coro::Shape &Shape)
	Eliminate a formerly-swifterror alloca by inserting the get/set intrinsics and attempting to MemToReg the alloca away. More...

static void	eliminateSwiftErrorArgument (Function &F, Argument &Arg, coro::Shape &Shape, SmallVectorImpl< AllocaInst * > &AllocasToPromote)
	"Eliminate" a swifterror argument by reducing it to the alloca case and then loading and storing in the prologue and epilog. More...

static void	eliminateSwiftError (Function &F, coro::Shape &Shape)
	Eliminate all problematic uses of swifterror arguments and allocas from the function. More...

static void	sinkSpillUsesAfterCoroBegin (Function &F, const FrameDataInfo &FrameData, CoroBeginInst *CoroBegin)
	retcon and retcon.once conventions assume that all spill uses can be sunk after the coro.begin intrinsic. More...

static void	sinkLifetimeStartMarkers (Function &F, coro::Shape &Shape, SuspendCrossingInfo &Checker)
	For each local variable that all of its user are only used inside one of suspended region, we sink their lifetime.start markers to the place where after the suspend block. More...

static void	collectFrameAllocas (Function &F, coro::Shape &Shape, const SuspendCrossingInfo &Checker, SmallVectorImpl< AllocaInfo > &Allocas)

Variables
static cl::opt< bool >	EnableReuseStorageInFrame ("reuse-storage-in-coroutine-frame", cl::Hidden, cl::desc("Enable the optimization which would reuse the storage in the coroutine \ frame for allocas whose liferanges are not overlapped, for testing purposes"), llvm::cl::init(false))

Macro Definition Documentation

◆ DEBUG_TYPE [1/2]

#define DEBUG_TYPE "coro-suspend-crossing"

Definition at line 302 of file CoroFrame.cpp.

◆ DEBUG_TYPE [2/2]

#define DEBUG_TYPE "coro-frame"

Definition at line 302 of file CoroFrame.cpp.

Typedef Documentation

◆ VisitedBlocksSet

typedef SmallPtrSet<BasicBlock*, 8> VisitedBlocksSet

Definition at line 2035 of file CoroFrame.cpp.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
SmallVectorThreshold

Definition at line 52 of file CoroFrame.cpp.

Function Documentation

◆ buildFrameDebugInfo()

static void buildFrameDebugInfo	(	Function &	F,
		coro::Shape &	Shape,
		FrameDataInfo &	FrameData
	)

static

Build artificial debug info for C++ coroutine frames to allow users to inspect the contents of the frame directly.

Create Debug information for coroutine frame with debug name "__coro_frame". The debug information for the fields of coroutine frame is constructed from the following way:

For all the value in the Frame, we search the use of dbg.declare to find the corresponding debug variables for the value. If we can find the debug variable, we can get full and accurate debug information.
If we can't get debug information in step 1 and 2, we could only try to build the DIType by Type. We did this in solveDIType. We only handle integer, float, double, integer type and struct type for now.

FIXME: If we fill the field SizeInBits with the actual size of __coro_index in bits, then __coro_index wouldn't show in the debugger.

Definition at line 920 of file CoroFrame.cpp.

References llvm::coro::Shape::ABI, assert(), cacheDIVar(), llvm::DIBuilder::createAutoVariable(), llvm::DIBuilder::createBasicType(), llvm::DIBuilder::createExpression(), llvm::DIBuilder::createMemberType(), llvm::DIBuilder::createStructType(), llvm::TinyPtrVector< EltTy >::empty(), llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::end(), F, llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::find(), llvm::FindDbgDeclareUses(), llvm::coro::Shape::FrameAlign, llvm::coro::Shape::FramePtr, llvm::coro::Shape::FrameSize, llvm::coro::Shape::FrameTy, llvm::TinyPtrVector< EltTy >::front(), get, llvm::DebugLoc::get(), llvm::Instruction::getDebugLoc(), llvm::StructType::getElementType(), llvm::DIScope::getFile(), llvm::TypeSize::getFixedSize(), llvm::DIVariable::getLine(), llvm::DIType::getName(), llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getNextNode(), llvm::StructType::getNumElements(), llvm::DIBuilder::getOrCreateArray(), llvm::coro::Shape::getPromiseAlloca(), llvm::DILocalVariable::getScope(), llvm::DataLayout::getTypeSizeInBits(), llvm::DbgVariableIntrinsic::getVariable(), Index, llvm::coro::Shape::SwitchLoweringStorage::IndexAlign, llvm::coro::Shape::SwitchLoweringStorage::IndexField, llvm::coro::Shape::SwitchLoweringStorage::IndexOffset, llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::insert(), llvm::dwarf::isCPlusPlus(), llvm::Type::isSized(), llvm::DIBuilder::replaceArrays(), solveDIType(), llvm::StringRef::str(), llvm::coro::Shape::SwitchLowering, llvm::to_string(), and llvm::Align::value().

◆ buildFrameType()

static StructType* buildFrameType	(	Function &	F,
		coro::Shape &	Shape,
		FrameDataInfo &	FrameData
	)

static

Definition at line 1094 of file CoroFrame.cpp.

◆ cacheDIVar()

static void cacheDIVar	(	FrameDataInfo &	FrameData,
		DenseMap< Value , DILocalVariable > &	DIVarCache
	)

static

Definition at line 778 of file CoroFrame.cpp.

References llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::end(), llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::find(), llvm::find_if(), llvm::FindDbgDeclareUses(), llvm::DbgVariableIntrinsic::getExpression(), I, and llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::insert().

Referenced by buildFrameDebugInfo().

◆ cleanupSinglePredPHIs()

static void cleanupSinglePredPHIs ( Function & F )

static

Definition at line 1860 of file CoroFrame.cpp.

References BB, F, llvm::PHINode::getIncomingValue(), llvm::SmallVectorImpl< T >::pop_back_val(), and llvm::Value::replaceAllUsesWith().

Referenced by llvm::coro::buildCoroutineFrame().

◆ collectFrameAllocas()

static void collectFrameAllocas	(	Function &	F,
		coro::Shape &	Shape,
		const SuspendCrossingInfo &	Checker,
		SmallVectorImpl< AllocaInfo > &	Allocas
	)

static

Definition at line 2478 of file CoroFrame.cpp.

References llvm::coro::Shape::CoroBegin, llvm::SmallVectorImpl< T >::emplace_back(), F, I, instructions, llvm::coro::Shape::SwitchLoweringStorage::PromiseAlloca, and llvm::coro::Shape::SwitchLowering.

Referenced by llvm::coro::buildCoroutineFrame().

◆ createFramePtr()

static void createFramePtr ( coro::Shape & Shape )

static

Definition at line 1484 of file CoroFrame.cpp.

References Builder, llvm::coro::Shape::CoroBegin, llvm::coro::Shape::FramePtr, llvm::coro::Shape::FrameTy, llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getNextNode(), and llvm::Type::getPointerTo().

◆ dumpAllocas()

static void dumpAllocas ( const SmallVectorImpl< AllocaInfo > & Allocas )

static

Definition at line 401 of file CoroFrame.cpp.

References A, and llvm::dbgs().

Referenced by llvm::coro::buildCoroutineFrame().

◆ dumpSpills()

static void dumpSpills	(	StringRef	Title,
		const SpillInfo &	Spills
	)

static

Definition at line 391 of file CoroFrame.cpp.

References llvm::dbgs(), E, and I.

Referenced by llvm::coro::buildCoroutineFrame().

◆ eliminateSwiftError()

static void eliminateSwiftError	(	Function &	F,
		coro::Shape &	Shape
	)

static

Eliminate all problematic uses of swifterror arguments and allocas from the function.

We'll fix them up later when splitting the function.

Definition at line 2313 of file CoroFrame.cpp.

References Arg, eliminateSwiftErrorAlloca(), eliminateSwiftErrorArgument(), F, llvm::AllocaInst::isSwiftError(), llvm::PromoteMemToReg(), and llvm::AllocaInst::setSwiftError().

Referenced by llvm::coro::buildCoroutineFrame().

◆ eliminateSwiftErrorAlloca()

static void eliminateSwiftErrorAlloca	(	Function &	F,
		AllocaInst *	Alloca,
		coro::Shape &	Shape
	)

static

Eliminate a formerly-swifterror alloca by inserting the get/set intrinsics and attempting to MemToReg the alloca away.

Definition at line 2245 of file CoroFrame.cpp.

References Addr, assert(), llvm::MCID::Call, emitSetAndGetSwiftErrorValueAround(), llvm::Use::getUser(), llvm::isAllocaPromotable(), llvm::Use::set(), llvm::Value::use_begin(), and llvm::Value::use_end().

Referenced by eliminateSwiftError().

◆ eliminateSwiftErrorArgument()

static void eliminateSwiftErrorArgument	(	Function &	F,
		Argument &	Arg,
		coro::Shape &	Shape,
		SmallVectorImpl< AllocaInst * > &	AllocasToPromote
	)

static

"Eliminate" a swifterror argument by reducing it to the alloca case and then loading and storing in the prologue and epilog.

The argument keeps the swifterror flag.

Definition at line 2276 of file CoroFrame.cpp.

References Arg, Builder, llvm::coro::Shape::CoroSuspends, emitSetAndGetSwiftErrorValueAround(), and F.

Referenced by eliminateSwiftError().

◆ emitGetSwiftErrorValue()

static Value* emitGetSwiftErrorValue	(	IRBuilder<> &	Builder,
		Type *	ValueTy,
		coro::Shape &	Shape
	)

static

Get the current swifterror value.

Definition at line 2182 of file CoroFrame.cpp.

References Builder, llvm::MCID::Call, get, and llvm::coro::Shape::SwiftErrorOps.

Referenced by emitSetAndGetSwiftErrorValueAround().

◆ emitSetAndGetSwiftErrorValueAround()

static Value* emitSetAndGetSwiftErrorValueAround	(	Instruction *	Call,
		AllocaInst *	Alloca,
		coro::Shape &	Shape
	)

static

Set the swifterror value from the given alloca before a call, then put in back in the alloca afterwards.

Returns an address that will stand in for the swifterror slot until splitting.

Definition at line 2215 of file CoroFrame.cpp.

References Addr, Builder, llvm::MCID::Call, emitGetSwiftErrorValue(), emitSetSwiftErrorValue(), and llvm::AllocaInst::getAllocatedType().

Referenced by eliminateSwiftErrorAlloca(), and eliminateSwiftErrorArgument().

◆ emitSetSwiftErrorValue()

static Value* emitSetSwiftErrorValue	(	IRBuilder<> &	Builder,
		Value *	V,
		coro::Shape &	Shape
	)

static

Set the given value as the current swifterror value.

Returns a slot that can be used as a swifterror slot.

Definition at line 2197 of file CoroFrame.cpp.

References Builder, llvm::MCID::Call, get, llvm::Type::getPointerTo(), llvm::Value::getType(), and llvm::coro::Shape::SwiftErrorOps.

Referenced by emitSetAndGetSwiftErrorValueAround().

◆ insertSpills()

static Instruction* insertSpills	(	const FrameDataInfo &	FrameData,
		coro::Shape &	Shape
	)

static

Definition at line 1515 of file CoroFrame.cpp.

References A, llvm::coro::Shape::ABI, Align, llvm::coro::Shape::AllocaSpillBlock, Arg, assert(), Builder, llvm::SmallVectorImpl< T >::clear(), llvm::coro::Shape::CoroBegin, llvm::tgtok::Def, llvm::DominatorTree::dominates(), E, llvm::Instruction::eraseFromParent(), llvm::FindDbgDeclareUses(), llvm::findDbgUsers(), FramePtr, llvm::coro::Shape::FramePtr, llvm::coro::Shape::FrameTy, llvm::BasicBlock::front(), G, GEP, get, llvm::AllocaInst::getAllocatedType(), llvm::AllocaInst::getArraySize(), llvm::Value::getContext(), llvm::StructType::getElementType(), llvm::BasicBlock::getFirstInsertionPt(), llvm::BasicBlock::getFirstNonPHI(), llvm::Instruction::getFunction(), llvm::Value::getName(), llvm::Instruction::getParent(), llvm::BasicBlock::getParent(), llvm::GlobalValue::getParent(), llvm::BasicBlock::getSingleSuccessor(), llvm::BasicBlock::getTerminator(), I, Index, llvm::AllocaInst::isArrayAllocation(), P, llvm::Value::replaceAllUsesWith(), llvm::User::replaceUsesOfWith(), llvm::report_fatal_error(), llvm::coro::Shape::ReuseFrameSlot, llvm::salvageDebugInfo(), llvm::BasicBlock::splitBasicBlock(), splitBeforeCatchSwitch(), llvm::SplitEdge(), and llvm::Value::users().

◆ isCoroutineStructureIntrinsic()

static bool isCoroutineStructureIntrinsic ( Instruction & I )

static

Definition at line 1968 of file CoroFrame.cpp.

References I.

Referenced by llvm::coro::buildCoroutineFrame().

◆ isLocalAlloca()

static bool isLocalAlloca ( CoroAllocaAllocInst * AI )

static

Is the given alloca "local", i.e.

bounded in lifetime to not cross a suspend point?

Definition at line 2062 of file CoroFrame.cpp.

References llvm::Instruction::getParent(), llvm::SmallPtrSetImpl< PtrType >::insert(), isSuspendReachableFrom(), and llvm::Value::users().

Referenced by llvm::coro::buildCoroutineFrame().

◆ isSuspendBlock()

static bool isSuspendBlock ( BasicBlock * BB )

static

Definition at line 2031 of file CoroFrame.cpp.

References BB.

Referenced by isSuspendReachableFrom(), sinkLifetimeStartMarkers(), and willLeaveFunctionImmediatelyAfter().

◆ isSuspendReachableFrom()

static bool isSuspendReachableFrom	(	BasicBlock *	From,
		VisitedBlocksSet &	VisitedOrFreeBBs
	)

static

Does control flow starting at the given block ever reach a suspend instruction before reaching a block in VisitedOrFreeBBs?

Definition at line 2039 of file CoroFrame.cpp.

References From, llvm::SmallPtrSetImpl< PtrType >::insert(), isSuspendBlock(), and llvm::successors().

Referenced by isLocalAlloca().

◆ localAllocaNeedsStackSave()

static bool localAllocaNeedsStackSave ( CoroAllocaAllocInst * AI )

static

Definition at line 2095 of file CoroFrame.cpp.

References llvm::Value::users(), and willLeaveFunctionImmediatelyAfter().

Referenced by lowerLocalAllocas().

◆ lowerLocalAllocas()

static void lowerLocalAllocas	(	ArrayRef< CoroAllocaAllocInst * >	LocalAllocas,
		SmallVectorImpl< Instruction * > &	DeadInsts
	)

static

Turn each of the given local allocas into a normal (dynamic) alloca instruction.

Definition at line 2113 of file CoroFrame.cpp.

References Align, Builder, llvm::AllocaInst::getAlignment(), llvm::Intrinsic::getDeclaration(), llvm::Instruction::getModule(), localAllocaNeedsStackSave(), M, llvm::Value::replaceAllUsesWith(), llvm::AllocaInst::setAlignment(), and llvm::Value::users().

◆ lowerNonLocalAlloca()

static Instruction* lowerNonLocalAlloca	(	CoroAllocaAllocInst *	AI,
		coro::Shape &	Shape,
		SmallVectorImpl< Instruction * > &	DeadInsts
	)

static

Turn the given coro.alloca.alloc call into a dynamic allocation.

This happens during the all-instructions iteration, so it must not delete the call.

Definition at line 2157 of file CoroFrame.cpp.

References Builder.

◆ materializable()

static bool materializable ( Instruction & V )

static

Definition at line 1961 of file CoroFrame.cpp.

Referenced by llvm::coro::buildCoroutineFrame().

◆ movePHIValuesToInsertedBlock()

static void movePHIValuesToInsertedBlock	(	BasicBlock *	SuccBB,
		BasicBlock *	InsertedBB,
		BasicBlock *	PredBB,
		PHINode *	UntilPHI = `nullptr`
	)

static

Definition at line 1767 of file CoroFrame.cpp.

References llvm::PHINode::addIncoming(), llvm::BasicBlock::front(), llvm::Value::getName(), llvm::Value::getType(), and Index.

Referenced by rewritePHIs(), and rewritePHIsForCleanupPad().

◆ rewriteMaterializableInstructions()

static void rewriteMaterializableInstructions	(	IRBuilder<> &	IRB,
		const SpillInfo &	Spills
	)

static

Definition at line 1975 of file CoroFrame.cpp.

References assert(), llvm::Instruction::clone(), llvm::tgtok::Def, E, llvm::Instruction::getParent(), llvm::BasicBlock::getSinglePredecessor(), llvm::Instruction::insertBefore(), llvm::User::replaceUsesOfWith(), and llvm::Value::setName().

Referenced by llvm::coro::buildCoroutineFrame().

◆ rewritePHIs() [1/2]

static void rewritePHIs ( BasicBlock & BB )

static

Definition at line 1877 of file CoroFrame.cpp.

References assert(), BB, llvm::ehAwareSplitEdge(), llvm::Instruction::eraseFromParent(), llvm::Value::getType(), movePHIValuesToInsertedBlock(), llvm::predecessors(), llvm::Value::replaceAllUsesWith(), rewritePHIsForCleanupPad(), and llvm::Value::takeName().

Referenced by llvm::coro::buildCoroutineFrame(), and rewritePHIs().

◆ rewritePHIs() [2/2]

static void rewritePHIs ( Function & F )

static

Definition at line 1947 of file CoroFrame.cpp.

References BB, F, and rewritePHIs().

◆ rewritePHIsForCleanupPad()

static void rewritePHIsForCleanupPad	(	BasicBlock *	CleanupPadBB,
		CleanupPadInst *	CleanupPad
	)

static

Definition at line 1785 of file CoroFrame.cpp.

References Builder, get, llvm::BasicBlock::getContext(), llvm::Value::getName(), llvm::BasicBlock::getParent(), llvm::Instruction::insertAfter(), movePHIValuesToInsertedBlock(), llvm::pred_size(), llvm::predecessors(), llvm::Instruction::removeFromParent(), llvm::setUnwindEdgeTo(), and llvm::updatePhiNodes().

Referenced by rewritePHIs().

◆ sinkLifetimeStartMarkers()

static void sinkLifetimeStartMarkers	(	Function &	F,
		coro::Shape &	Shape,
		SuspendCrossingInfo &	Checker
	)

static

For each local variable that all of its user are only used inside one of suspended region, we sink their lifetime.start markers to the place where after the suspend block.

Doing so minimizes the lifetime of each variable, hence minimizing the amount of data we end up putting on the frame.

Definition at line 2393 of file CoroFrame.cpp.

References assert(), llvm::coro::Shape::CoroSuspends, llvm::DominatorTree::dominates(), F, llvm::IntrinsicInst::getIntrinsicID(), llvm::Instruction::getParent(), llvm::BasicBlock::getParent(), llvm::BasicBlock::getSingleSuccessor(), llvm::Value::hasOneUse(), I, llvm::SmallPtrSetImpl< PtrType >::insert(), instructions, isLifetimeStart(), isSuspendBlock(), S, llvm::Value::stripPointerCasts(), llvm::Instruction::user_back(), and llvm::Value::users().

Referenced by llvm::coro::buildCoroutineFrame().

◆ sinkSpillUsesAfterCoroBegin()

static void sinkSpillUsesAfterCoroBegin	(	Function &	F,
		const FrameDataInfo &	FrameData,
		CoroBeginInst *	CoroBegin
	)

static

retcon and retcon.once conventions assume that all spill uses can be sunk after the coro.begin intrinsic.

Definition at line 2346 of file CoroFrame.cpp.

References A, B, llvm::SetVector< T, SmallVector< T, N >, SmallDenseSet< T, N > >::begin(), llvm::tgtok::Def, llvm::DominatorTree::dominates(), llvm::SetVector< T, SmallVector< T, N >, SmallDenseSet< T, N > >::end(), F, llvm::ilist_node_with_parent< NodeTy, ParentTy, Options >::getNextNode(), llvm::Instruction::getParent(), llvm::SetVector< T, SmallVector< T, N >, SmallDenseSet< T, N > >::insert(), llvm::Instruction::moveBefore(), llvm::SmallVectorImpl< T >::pop_back_val(), and llvm::sort().

◆ solveDIType()

static DIType* solveDIType	(	DIBuilder &	Builder,
		Type *	Ty,
		DataLayout &	Layout,
		DIScope *	Scope,
		unsigned	LineNum,
		DenseMap< Type , DIType > &	DITypeCache
	)

static

Definition at line 843 of file CoroFrame.cpp.

References assert(), llvm::BitWidth, Builder, llvm::dbgs(), llvm::DIType::getAlignInBits(), llvm::StructLayout::getElementOffsetInBits(), llvm::DIType::getName(), llvm::DataLayout::getPrefTypeAlignment(), llvm::DIType::getSizeInBits(), llvm::DataLayout::getStructLayout(), llvm::DataLayout::getTypeSizeInBits(), I, llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::insert(), llvm::Type::isFloatingPointTy(), llvm::Type::isIntegerTy(), llvm::Type::isPointerTy(), llvm::Type::isStructTy(), LLVM_DEBUG, llvm::DenseMapBase< DenseMap< KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >, KeyT, ValueT, DenseMapInfo< KeyT >, llvm::detail::DenseMapPair< KeyT, ValueT > >::lookup(), solveTypeName(), and llvm::raw_svector_ostream::str().

Referenced by buildFrameDebugInfo().

◆ solveTypeName()

static StringRef solveTypeName ( Type * Ty )

static

Create name for Type.

It uses MDString to store new created string to avoid memory leak.

Definition at line 795 of file CoroFrame.cpp.

References llvm::for_each(), get, llvm::Type::getContext(), llvm::Type::getStructName(), llvm::Type::isDoubleTy(), llvm::Type::isFloatingPointTy(), llvm::Type::isFloatTy(), llvm::Type::isIntegerTy(), llvm::Type::isPointerTy(), llvm::Type::isStructTy(), llvm::SmallString< InternalLen >::str(), llvm::raw_svector_ostream::str(), and llvm::Twine::toStringRef().

Referenced by solveDIType().

◆ splitAround()

static void splitAround	(	Instruction *	I,
		const Twine &	Name
	)

static

Definition at line 2026 of file CoroFrame.cpp.

References I, and splitBlockIfNotFirst().

Referenced by llvm::coro::buildCoroutineFrame().

◆ splitBeforeCatchSwitch()

static Instruction* splitBeforeCatchSwitch ( CatchSwitchInst * CatchSwitch )

static

Definition at line 1472 of file CoroFrame.cpp.

References llvm::Instruction::eraseFromParent(), llvm::Instruction::getParent(), llvm::CatchSwitchInst::getParentPad(), llvm::BasicBlock::getTerminator(), and llvm::BasicBlock::splitBasicBlock().

Referenced by insertSpills().

◆ splitBlockIfNotFirst()

static BasicBlock* splitBlockIfNotFirst	(	Instruction *	I,
		const Twine &	Name
	)

static

Definition at line 2013 of file CoroFrame.cpp.

References BB, and I.

Referenced by splitAround().

◆ willLeaveFunctionImmediatelyAfter()

static bool willLeaveFunctionImmediatelyAfter	(	BasicBlock *	BB,
		unsigned	depth = `3`
	)

static

After we split the coroutine, will the given basic block be along an obvious exit path for the resumption function?

Definition at line 2076 of file CoroFrame.cpp.

References BB, isSuspendBlock(), and llvm::successors().

Referenced by localAllocaNeedsStackSave().

Variable Documentation

◆ EnableReuseStorageInFrame

cl::opt<bool> EnableReuseStorageInFrame("reuse-storage-in-coroutine-frame", cl::Hidden, cl::desc( "Enable the optimization which would reuse the storage in the coroutine \ frame for allocas whose liferanges are not overlapped, for testing purposes"), llvm::cl::init(false))

static

Referenced by llvm::coro::salvageDebugInfo().

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ DEBUG_TYPE [1/2]

◆ DEBUG_TYPE [2/2]

Typedef Documentation

◆ VisitedBlocksSet

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ buildFrameDebugInfo()

◆ buildFrameType()

◆ cacheDIVar()

◆ cleanupSinglePredPHIs()

◆ collectFrameAllocas()

◆ createFramePtr()

◆ dumpAllocas()

◆ dumpSpills()

◆ eliminateSwiftError()

◆ eliminateSwiftErrorAlloca()

◆ eliminateSwiftErrorArgument()

◆ emitGetSwiftErrorValue()

◆ emitSetAndGetSwiftErrorValueAround()

◆ emitSetSwiftErrorValue()

◆ insertSpills()

◆ isCoroutineStructureIntrinsic()

◆ isLocalAlloca()

◆ isSuspendBlock()

◆ isSuspendReachableFrom()

◆ localAllocaNeedsStackSave()

◆ lowerLocalAllocas()

◆ lowerNonLocalAlloca()

◆ materializable()

◆ movePHIValuesToInsertedBlock()

◆ rewriteMaterializableInstructions()

◆ rewritePHIs() [1/2]

◆ rewritePHIs() [2/2]

◆ rewritePHIsForCleanupPad()

◆ sinkLifetimeStartMarkers()

◆ sinkSpillUsesAfterCoroBegin()

◆ solveDIType()

◆ solveTypeName()

◆ splitAround()

◆ splitBeforeCatchSwitch()

◆ splitBlockIfNotFirst()

◆ willLeaveFunctionImmediatelyAfter()

Variable Documentation

◆ EnableReuseStorageInFrame