Utility class for extracting code into a new function. More...

#include "llvm/Transforms/Utils/CodeExtractor.h"

Public Member Functions
	CodeExtractor (ArrayRef< BasicBlock > BBs, DominatorTree DT=nullptr, bool AggregateArgs=false, BlockFrequencyInfo BFI=nullptr, BranchProbabilityInfo BPI=nullptr, bool AllowVarArgs=false, bool AllowAlloca=false, std::string Suffix="")
	Create a code extractor for a sequence of blocks. More...

	CodeExtractor (DominatorTree &DT, Loop &L, bool AggregateArgs=false, BlockFrequencyInfo BFI=nullptr, BranchProbabilityInfo BPI=nullptr, std::string Suffix="")
	Create a code extractor for a loop body. More...

Function *	extractCodeRegion ()
	Perform the extraction, returning the new function. More...

bool	isEligible () const
	Test whether this code extractor is eligible. More...

void	findInputsOutputs (ValueSet &Inputs, ValueSet &Outputs, const ValueSet &Allocas) const
	Compute the set of input values and output values for the code. More...

bool	isLegalToShrinkwrapLifetimeMarkers (Instruction *AllocaAddr) const
	Check if life time marker nodes can be hoisted/sunk into the outline region. More...

void	findAllocas (ValueSet &SinkCands, ValueSet &HoistCands, BasicBlock *&ExitBlock) const
	Find the set of allocas whose life ranges are contained within the outlined region. More...

BasicBlock *	findOrCreateBlockForHoisting (BasicBlock *CommonExitBlock)
	Find or create a block within the outline region for placing hoisted code. More...

Detailed Description

Utility class for extracting code into a new function.

This utility provides a simple interface for extracting some sequence of code into its own function, replacing it with a call to that function. It also provides various methods to query about the nature and result of such a transformation.

The rough algorithm used is: 1) Find both the inputs and outputs for the extracted region. 2) Pass the inputs as arguments, remapping them within the extracted function to arguments. 3) Add allocas for any scalar outputs, adding all of the outputs' allocas as arguments, and inserting stores to the arguments for any scalars.

Definition at line 52 of file CodeExtractor.h.

Constructor & Destructor Documentation

◆ CodeExtractor() [1/2]

CodeExtractor::CodeExtractor	(	ArrayRef< BasicBlock *>	BBs,
		DominatorTree *	DT = `nullptr`,
		bool	AggregateArgs = `false`,
		BlockFrequencyInfo *	BFI = `nullptr`,
		BranchProbabilityInfo *	BPI = `nullptr`,
		bool	AllowVarArgs = `false`,
		bool	AllowAlloca = `false`,
		std::string	Suffix = `""`
	)

Create a code extractor for a sequence of blocks.

Given a sequence of basic blocks where the first block in the sequence dominates the rest, prepare a code extractor object for pulling this sequence out into its new function. When a DominatorTree is also given, extra checking and transformations are enabled. If AllowVarArgs is true, vararg functions can be extracted. This is safe, if all vararg handling code is extracted, including vastart. If AllowAlloca is true, then extraction of blocks containing alloca instructions would be possible, however code extractor won't validate whether extraction is legal.

Definition at line 237 of file CodeExtractor.cpp.

◆ CodeExtractor() [2/2]

CodeExtractor::CodeExtractor	(	DominatorTree &	DT,
		Loop &	L,
		bool	AggregateArgs = `false`,
		BlockFrequencyInfo *	BFI = `nullptr`,
		BranchProbabilityInfo *	BPI = `nullptr`,
		std::string	Suffix = `""`
	)

Create a code extractor for a loop body.

Behaves just like the generic code sequence constructor, but uses the block sequence of the loop.

Definition at line 246 of file CodeExtractor.cpp.

Member Function Documentation

◆ extractCodeRegion()

Function * CodeExtractor::extractCodeRegion ( )

Perform the extraction, returning the new function.

Returns zero when called on a CodeExtractor instance where isEligible returns false.

Definition at line 1249 of file CodeExtractor.cpp.

References llvm::any_of(), assert(), llvm::BasicBlock::begin(), llvm::BasicBlock::Create(), llvm::BranchInst::Create(), llvm::SetVector< T, Vector, Set >::empty(), llvm::Instruction::eraseFromParent(), eraseLifetimeMarkersOnInputs(), llvm::errs(), F(), findAllocas(), llvm::findDbgUsers(), findInputsOutputs(), findOrCreateBlockForHoisting(), llvm::BlockFrequencyInfo::getBlockFreq(), llvm::BasicBlock::getContext(), llvm::Instruction::getDebugLoc(), llvm::BranchProbabilityInfo::getEdgeProbability(), llvm::BlockFrequency::getFrequency(), llvm::Function::getFunctionType(), llvm::PHINode::getIncomingBlock(), llvm::PHINode::getNumIncomingValues(), llvm::BasicBlock::getParent(), llvm::GlobalValue::getParent(), llvm::Function::getPersonalityFn(), llvm::BlockFrequencyInfo::getProfileCountFromFreq(), llvm::Function::getSubprogram(), llvm::BasicBlock::getTerminator(), llvm::Function::hasPersonalityFn(), I, llvm::SmallPtrSetImpl< PtrType >::insert(), insertLifetimeMarkersSurroundingCall(), isEligible(), llvm::FunctionType::isVarArg(), LLVM_DEBUG, llvm::none_of(), llvm::Function::PCT_Real, llvm::predecessors(), llvm::report_fatal_error(), llvm::BlockFrequencyInfo::setBlockFreq(), llvm::Function::setEntryCount(), llvm::PHINode::setIncomingBlock(), llvm::Function::setPersonalityFn(), SI, llvm::SmallPtrSetImplBase::size(), llvm::succ_begin(), llvm::succ_end(), llvm::Intrinsic::vaend, llvm::Intrinsic::vastart, and llvm::verifyFunction().

Referenced by llvm::createBlockExtractorPass(), and INITIALIZE_PASS().

◆ findAllocas()

void CodeExtractor::findAllocas	(	ValueSet &	SinkCands,
		ValueSet &	HoistCands,
		BasicBlock *&	ExitBlock
	)		const

Find the set of allocas whose life ranges are contained within the outlined region.

Allocas which have life_time markers contained in the outlined region should be pushed to the outlined function. The address bitcasts that are used by the lifetime markers are also candidates for shrink- wrapping. The instructions that need to be sunk are collected in 'Allocas'.

Definition at line 404 of file CodeExtractor.cpp.

References llvm::MCID::Bitcast, definedInRegion(), llvm::dyn_cast(), getCommonExitBlock(), llvm::IntrinsicInst::getIntrinsicID(), getParent(), llvm::SetVector< T, Vector, Set >::insert(), isLegalToShrinkwrapLifetimeMarkers(), llvm::Intrinsic::lifetime_end, llvm::Intrinsic::lifetime_start, and llvm::Value::users().

Referenced by extractCodeRegion(), and isEligible().

◆ findInputsOutputs()

void CodeExtractor::findInputsOutputs	(	ValueSet &	Inputs,
		ValueSet &	Outputs,
		const ValueSet &	Allocas
	)		const

Compute the set of input values and output values for the code.

These can be used either when performing the extraction or to evaluate the expected size of a call to the extracted function. Note that this work cannot be cached between the two as once we decide to extract a code sequence, that sequence is modified, including changing these sets, before extraction occurs. These modifications won't have any significant impact on the cost however.

Definition at line 511 of file CodeExtractor.cpp.

References llvm::SwitchInst::addCase(), llvm::Function::addFnAttr(), llvm::PHINode::addIncoming(), llvm::DominatorTreeBase< NodeT, IsPostDom >::addNewBlock(), llvm::Attribute::Alignment, llvm::Attribute::AllocSize, llvm::Attribute::AlwaysInline, llvm::Function::arg_begin(), llvm::Function::arg_end(), llvm::Attribute::ArgMemOnly, assert(), llvm::DomTreeNodeBase< NodeT >::begin(), llvm::BasicBlock::begin(), llvm::Function::begin(), llvm::Attribute::Builtin, llvm::Attribute::ByVal, llvm::DominatorTreeBase< NodeT, IsPostDom >::changeImmediateDominator(), llvm::Attribute::Cold, Context, llvm::Attribute::Convergent, llvm::SetVector< T, Vector, Set >::count(), llvm::BasicBlock::Create(), llvm::Function::Create(), llvm::GetElementPtrInst::Create(), llvm::CallInst::Create(), llvm::PHINode::Create(), llvm::ReturnInst::Create(), llvm::BranchInst::Create(), llvm::SwitchInst::Create(), llvm::dbgs(), definedInCaller(), definedInRegion(), llvm::Attribute::Dereferenceable, llvm::Attribute::DereferenceableOrNull, llvm::Function::doesNotThrow(), llvm::dyn_cast(), E, llvm::StringRef::empty(), llvm::DomTreeNodeBase< NodeT >::end(), llvm::Attribute::EndAttrKinds, llvm::Instruction::eraseFromParent(), llvm::BasicBlock::front(), llvm::Function::front(), GEP, llvm::ConstantInt::get(), llvm::FunctionType::get(), llvm::StructType::get(), llvm::GlobalValue::getAddressSpace(), llvm::DataLayout::getAllocaAddrSpace(), llvm::Function::getAttributes(), llvm::Function::getBasicBlockList(), llvm::SwitchInst::getCondition(), llvm::BasicBlock::getContext(), llvm::Function::getContext(), llvm::Module::getContext(), llvm::Value::getContext(), llvm::Module::getDataLayout(), llvm::Instruction::getDebugLoc(), llvm::Function::getEntryBlock(), llvm::BasicBlock::getFirstNonPHI(), llvm::AttributeList::getFnAttributes(), llvm::PHINode::getIncomingBlock(), llvm::PHINode::getIncomingValue(), llvm::BasicBlock::getInstList(), llvm::Type::getInt16Ty(), llvm::Type::getInt1Ty(), llvm::Type::getInt32Ty(), getName(), llvm::Value::getName(), llvm::DominatorTreeBase< NodeT, IsPostDom >::getNode(), llvm::Constant::getNullValue(), llvm::PHINode::getNumIncomingValues(), llvm::Instruction::getNumSuccessors(), llvm::Instruction::getParent(), llvm::BasicBlock::getParent(), llvm::GlobalValue::getParent(), getParent(), llvm::Function::getReturnType(), llvm::Function::getSubprogram(), llvm::Instruction::getSuccessor(), llvm::SwitchInst::getSuccessor(), llvm::BasicBlock::getTerminator(), llvm::Value::getType(), llvm::PointerType::getUnqual(), llvm::Type::getVoidTy(), llvm::BranchProbability::getZero(), llvm::Function::hasUWTable(), I, llvm::Attribute::InaccessibleMemOnly, llvm::Attribute::InaccessibleMemOrArgMemOnly, llvm::Attribute::InAlloca, llvm::Attribute::InlineHint, llvm::Attribute::InReg, llvm::SetVector< T, Vector, Set >::insert(), llvm::GlobalValue::InternalLinkage, llvm::Function::isVarArg(), llvm::Type::isVoidTy(), llvm::Attribute::JumpTable, LLVM_DEBUG, llvm::LLVMContext::MD_prof, llvm::Attribute::MinSize, llvm::Attribute::Naked, llvm::Attribute::Nest, llvm::Attribute::NoAlias, llvm::Attribute::NoBuiltin, llvm::Attribute::NoCapture, llvm::Attribute::NoCfCheck, llvm::Attribute::NoDuplicate, llvm::Attribute::NoImplicitFloat, llvm::Attribute::NoInline, llvm::Attribute::None, llvm::Attribute::NonLazyBind, llvm::Attribute::NonNull, llvm::Attribute::NoRecurse, llvm::Attribute::NoRedZone, llvm::Attribute::NoReturn, llvm::Attribute::NoUnwind, llvm::Attribute::OptForFuzzing, llvm::Attribute::OptimizeForSize, llvm::Attribute::OptimizeNone, llvm::pred_begin(), llvm::pred_end(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::iplist_impl< IntrusiveListT, TraitsT >::push_back(), llvm::Attribute::ReadNone, llvm::Attribute::ReadOnly, llvm::iplist_impl< IntrusiveListT, TraitsT >::remove(), llvm::SwitchInst::removeCase(), llvm::PHINode::removeIncomingValue(), llvm::Value::replaceAllUsesWith(), llvm::User::replaceUsesOfWith(), llvm::Attribute::Returned, llvm::Attribute::ReturnsTwice, llvm::reverse(), llvm::Attribute::SafeStack, llvm::Attribute::SanitizeAddress, llvm::Attribute::SanitizeHWAddress, llvm::Attribute::SanitizeMemory, llvm::Attribute::SanitizeThread, llvm::SwitchInst::setCondition(), llvm::Instruction::setDebugLoc(), llvm::SwitchInst::setDefaultDest(), llvm::Function::setDoesNotThrow(), llvm::BranchProbabilityInfo::setEdgeProbability(), llvm::Function::setHasUWTable(), llvm::Instruction::setMetadata(), llvm::Value::setName(), llvm::Instruction::setSuccessor(), llvm::Attribute::SExt, llvm::Attribute::ShadowCallStack, SI, llvm::SmallVectorBase::size(), llvm::SetVector< T, Vector, Set >::size(), llvm::Attribute::Speculatable, llvm::Attribute::SpeculativeLoadHardening, llvm::SplitBlock(), llvm::Attribute::StackAlignment, llvm::Attribute::StackProtect, llvm::Attribute::StackProtectReq, llvm::Attribute::StackProtectStrong, llvm::StringRef::str(), llvm::Attribute::StrictFP, llvm::Attribute::StructRet, llvm::Attribute::SwiftError, llvm::Attribute::SwiftSelf, use, llvm::Value::user_begin(), llvm::Value::user_end(), Users, llvm::Value::users(), llvm::Attribute::UWTable, llvm::Attribute::WriteOnly, and llvm::Attribute::ZExt.

Referenced by extractCodeRegion(), and isEligible().

◆ findOrCreateBlockForHoisting()

BasicBlock * CodeExtractor::findOrCreateBlockForHoisting ( BasicBlock * CommonExitBlock )

Find or create a block within the outline region for placing hoisted code.

CommonExitBlock is block outside the outline region. It is the common successor of blocks inside the region. If there exists a single block inside the region that is the predecessor of CommonExitBlock, that block will be returned. Otherwise CommonExitBlock will be split and the original block will be added to the outline region.

Definition at line 351 of file CodeExtractor.cpp.

References assert(), llvm::dyn_cast(), llvm::BasicBlock::getFirstNonPHI(), llvm::ilist_node_impl< OptionsT >::getIterator(), llvm::BasicBlock::getTerminator(), I, llvm::pred_begin(), llvm::pred_end(), llvm::predecessors(), llvm::User::replaceUsesOfWith(), and llvm::BasicBlock::splitBasicBlock().