LLVM  13.0.0git
Macros | Typedefs | Enumerations | Functions | Variables
CoroFrame.cpp File Reference
#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:

Go to the source code of this file.

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 DITypesolveDIType (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 StructTypebuildFrameType (Function &F, coro::Shape &Shape, FrameDataInfo &FrameData)
 
static InstructionsplitBeforeCatchSwitch (CatchSwitchInst *CatchSwitch)
 
static void createFramePtr (coro::Shape &Shape)
 
static InstructioninsertSpills (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 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 BasicBlocksplitBlockIfNotFirst (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 InstructionlowerNonLocalAlloca (CoroAllocaAllocInst *AI, coro::Shape &Shape, SmallVectorImpl< Instruction * > &DeadInsts)
 Turn the given coro.alloca.alloc call into a dynamic allocation. More...
 
static ValueemitGetSwiftErrorValue (IRBuilder<> &Builder, Type *ValueTy, coro::Shape &Shape)
 Get the current swifterror value. More...
 
static ValueemitSetSwiftErrorValue (IRBuilder<> &Builder, Value *V, coro::Shape &Shape)
 Set the given value as the current swifterror value. More...
 
static ValueemitSetAndGetSwiftErrorValueAround (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

Definition at line 1974 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:

  1. 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.
  2. 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 908 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

◆ cacheDIVar()

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

◆ collectFrameAllocas()

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

◆ createFramePtr()

static void createFramePtr ( coro::Shape Shape)
static

◆ 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 2252 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 2184 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 2215 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 2121 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 2154 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 2136 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

◆ isCoroutineStructureIntrinsic()

static bool isCoroutineStructureIntrinsic ( Instruction I)
static

Definition at line 1913 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 2001 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

◆ 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 1978 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 2034 of file CoroFrame.cpp.

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

Referenced by lowerLocalAllocas().

◆ lowerLocalAllocas()

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

◆ 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 2096 of file CoroFrame.cpp.

References Builder.

◆ materializable()

static bool materializable ( Instruction V)
static

Definition at line 1906 of file CoroFrame.cpp.

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

◆ movePHIValuesToInsertedBlock()

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

◆ rewriteMaterializableInstructions()

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

◆ rewritePHIs() [1/2]

static void rewritePHIs ( BasicBlock BB)
static

◆ rewritePHIs() [2/2]

static void rewritePHIs ( Function F)
static

Definition at line 1892 of file CoroFrame.cpp.

References BB, F, and rewritePHIs().

◆ rewritePHIsForCleanupPad()

static void rewritePHIsForCleanupPad ( BasicBlock CleanupPadBB,
CleanupPadInst CleanupPad 
)
static

◆ 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 2332 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

◆ solveDIType()

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

◆ solveTypeName()

static StringRef solveTypeName ( Type Ty)
static

◆ splitAround()

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

Definition at line 1965 of file CoroFrame.cpp.

References I, and splitBlockIfNotFirst().

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

◆ splitBeforeCatchSwitch()

static Instruction* splitBeforeCatchSwitch ( CatchSwitchInst CatchSwitch)
static

◆ splitBlockIfNotFirst()

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

Definition at line 1952 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 2015 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