VPlan models a candidate for vectorization, encoding various decisions take to produce efficient output IR, including which branches, basic-blocks and output IR instructions to generate, and their cost. More...

#include "Transforms/Vectorize/VPlan.h"

Public Member Functions
	VPlan (Loop *L)
	Construct a VPlan for `L`.
	VPlan (BasicBlock *ScalarHeaderBB)
	Construct a VPlan with a new VPBasicBlock as entry, a VPIRBasicBlock wrapping `ScalarHeaderBB` and a trip count of `TC`.
LLVM_ABI_FOR_TEST	~VPlan ()
void	setEntry (VPBasicBlock *VPBB)
void	execute (VPTransformState *State)
	Generate the IR code for this VPlan.
InstructionCost	cost (ElementCount VF, VPCostContext &Ctx)
	Return the cost of this plan.
VPBasicBlock *	getEntry ()
const VPBasicBlock *	getEntry () const
VPBasicBlock *	getVectorPreheader ()
	Returns the preheader of the vector loop region, if one exists, or null otherwise.
LLVM_ABI_FOR_TEST VPRegionBlock *	getVectorLoopRegion ()
	Returns the VPRegionBlock of the vector loop.
LLVM_ABI_FOR_TEST const VPRegionBlock *	getVectorLoopRegion () const
VPBasicBlock *	getMiddleBlock ()
	Returns the 'middle' block of the plan, that is the block that selects whether to execute the scalar tail loop or the exit block from the loop latch.
const VPBasicBlock *	getMiddleBlock () const
VPBasicBlock *	getScalarPreheader () const
	Return the VPBasicBlock for the preheader of the scalar loop.
VPIRBasicBlock *	getScalarHeader () const
	Return the VPIRBasicBlock wrapping the header of the scalar loop.
ArrayRef< VPIRBasicBlock * >	getExitBlocks () const
	Return an ArrayRef containing VPIRBasicBlocks wrapping the exit blocks of the original scalar loop.
VPIRBasicBlock *	getExitBlock (BasicBlock *IRBB) const
	Return the VPIRBasicBlock corresponding to `IRBB`.
bool	isExitBlock (VPBlockBase *VPBB)
	Returns true if `VPBB` is an exit block.
VPValue *	getTripCount () const
	The trip count of the original loop.
void	setTripCount (VPValue *NewTripCount)
	Set the trip count assuming it is currently null; if it is not - use resetTripCount().
void	resetTripCount (VPValue *NewTripCount)
	Resets the trip count for the VPlan.
VPValue *	getOrCreateBackedgeTakenCount ()
	The backedge taken count of the original loop.
VPValue *	getBackedgeTakenCount () const
VPSymbolicValue &	getVectorTripCount ()
	The vector trip count.
VPSymbolicValue &	getVF ()
	Returns the VF of the vector loop region.
const VPSymbolicValue &	getVF () const
VPSymbolicValue &	getUF ()
	Returns the UF of the vector loop region.
VPSymbolicValue &	getVFxUF ()
	Returns VF * UF of the vector loop region.
LLVMContext &	getContext () const
const DataLayout &	getDataLayout () const
void	addVF (ElementCount VF)
void	setVF (ElementCount VF)
void	removeVF (ElementCount VF)
	Remove `VF` from the plan.
bool	hasVF (ElementCount VF) const
bool	hasScalableVF () const
iterator_range< SmallSetVector< ElementCount, 2 >::iterator >	vectorFactors () const
	Returns an iterator range over all VFs of the plan.
bool	hasScalarVFOnly () const
bool	hasUF (unsigned UF) const
unsigned	getConcreteUF () const
	Returns the concrete UF of the plan, after unrolling.
void	setUF (unsigned UF)
bool	isUnrolled () const
	Returns true if the VPlan already has been unrolled, i.e.
std::string	getName () const
	Return a string with the name of the plan and the applicable VFs and UFs.
void	setName (const Twine &newName)
VPIRValue *	getOrAddLiveIn (Value *V)
	Gets the live-in VPIRValue for `V` or adds a new live-in (if none exists yet) for `V`.
VPIRValue *	getOrAddLiveIn (VPIRValue *V)
VPIRValue *	getTrue ()
	Return a VPIRValue wrapping i1 true.
VPIRValue *	getFalse ()
	Return a VPIRValue wrapping i1 false.
VPIRValue *	getZero (Type *Ty)
	Return a VPIRValue wrapping the null value of type `Ty`.
VPIRValue *	getAllOnesValue (Type *Ty)
	Return a VPIRValue wrapping the AllOnes value of type `Ty`.
VPIRValue *	getConstantInt (Type *Ty, uint64_t Val, bool IsSigned=false)
	Return a VPIRValue wrapping a ConstantInt with the given type and value.
VPIRValue *	getConstantInt (unsigned BitWidth, uint64_t Val, bool IsSigned=false)
	Return a VPIRValue wrapping a ConstantInt with the given bitwidth and value.
VPIRValue *	getConstantInt (const APInt &Val)
	Return a VPIRValue wrapping a ConstantInt with the given APInt value.
VPIRValue *	getLiveIn (Value *V) const
	Return the live-in VPIRValue for `V`, if there is one or nullptr otherwise.
auto	getLiveIns () const
	Return the list of live-in VPValues available in the VPlan.
void	printLiveIns (raw_ostream &O) const
	Print the live-ins of this VPlan to `O`.
LLVM_ABI_FOR_TEST void	print (raw_ostream &O) const
	Print this VPlan to `O`.
LLVM_ABI_FOR_TEST void	printDOT (raw_ostream &O) const
	Print this VPlan in DOT format to `O`.
LLVM_DUMP_METHOD void	dump () const
	Dump the plan to stderr (for debugging).
LLVM_ABI_FOR_TEST VPlan *	duplicate ()
	Clone the current VPlan, update all VPValues of the new VPlan and cloned recipes to refer to the clones, and return it.
VPBasicBlock *	createVPBasicBlock (const Twine &Name, VPRecipeBase *Recipe=nullptr)
	Create a new VPBasicBlock with `Name` and containing `Recipe` if present.
VPRegionBlock *	createLoopRegion (const std::string &Name="", VPBlockBase Entry=nullptr, VPBlockBase Exiting=nullptr)
	Create a new loop region with `Name` and entry and exiting blocks set to `Entry` and `Exiting` respectively, if set.
VPRegionBlock *	createReplicateRegion (VPBlockBase Entry, VPBlockBase Exiting, const std::string &Name="")
	Create a new replicate region with `Entry`, `Exiting` and `Name`.
VPIRBasicBlock *	createEmptyVPIRBasicBlock (BasicBlock *IRBB)
	Create a VPIRBasicBlock wrapping `IRBB`, but do not create VPIRInstructions wrapping the instructions in t`IRBB`.
LLVM_ABI_FOR_TEST VPIRBasicBlock *	createVPIRBasicBlock (BasicBlock *IRBB)
	Create a VPIRBasicBlock from `IRBB` containing VPIRInstructions for all instructions in `IRBB`, except its terminator which is managed by the successors of the block in VPlan.
bool	hasEarlyExit () const
	Returns true if the VPlan is based on a loop with an early exit.
bool	hasScalarTail () const
	Returns true if the scalar tail may execute after the vector loop.

Friends
class	VPlanPrinter
class	VPSlotTracker

Detailed Description

VPlan models a candidate for vectorization, encoding various decisions take to produce efficient output IR, including which branches, basic-blocks and output IR instructions to generate, and their cost.

VPlan holds a Hierarchical-CFG of VPBasicBlocks and VPRegionBlocks rooted at an Entry VPBasicBlock.

Definition at line 4587 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPlan() [1/2]

VPlan::VPlan ( Loop * L )

Construct a VPlan for L.

This will create VPIRBasicBlocks wrapping the original preheader and scalar header of L, to be used as entry and scalar header blocks of the new VPlan.

Definition at line 872 of file VPlan.cpp.

References createVPIRBasicBlock(), and setEntry().

◆ VPlan() [2/2]

llvm::VPlan::VPlan ( BasicBlock * ScalarHeaderBB )

inline

Construct a VPlan with a new VPBasicBlock as entry, a VPIRBasicBlock wrapping ScalarHeaderBB and a trip count of TC.

Definition at line 4661 of file VPlan.h.

References createVPBasicBlock(), createVPIRBasicBlock(), and setEntry().

◆ ~VPlan()

VPlan::~VPlan ( )

Definition at line 882 of file VPlan.cpp.

References llvm::dyn_cast(), getLiveIns(), and I.

Member Function Documentation

◆ addVF()

void llvm::VPlan::addVF ( ElementCount VF )

inline

Definition at line 4786 of file VPlan.h.

◆ cost()

InstructionCost VPlan::cost	(	ElementCount	VF,
		VPCostContext &	Ctx )

Return the cost of this plan.

Definition at line 1040 of file VPlan.cpp.

References llvm::any_of(), llvm::VPBlockUtils::blocksOnly(), llvm::VPBasicBlock::cost(), llvm::VPRegionBlock::cost(), getEntry(), llvm::InstructionCost::getInvalid(), getVectorLoopRegion(), llvm::InstructionCost::isValid(), and llvm::vp_depth_first_shallow().

◆ createEmptyVPIRBasicBlock()

VPIRBasicBlock * VPlan::createEmptyVPIRBasicBlock ( BasicBlock * IRBB )

Create a VPIRBasicBlock wrapping IRBB, but do not create VPIRInstructions wrapping the instructions in tIRBB.

The returned block is owned by the VPlan and deleted once the VPlan is destroyed.

Definition at line 1271 of file VPlan.cpp.

Referenced by llvm::VPIRBasicBlock::clone(), and createVPIRBasicBlock().

◆ createLoopRegion()

VPRegionBlock * llvm::VPlan::createLoopRegion	(	const std::string &	Name = "",
		VPBlockBase *	Entry = nullptr,
		VPBlockBase *	Exiting = nullptr )

inline

Create a new loop region with Name and entry and exiting blocks set to Entry and Exiting respectively, if set.

The returned block is owned by the VPlan and deleted once the VPlan is destroyed.

Definition at line 4931 of file VPlan.h.

Referenced by createLoopRegion().

◆ createReplicateRegion()

VPRegionBlock * llvm::VPlan::createReplicateRegion	(	VPBlockBase *	Entry,
		VPBlockBase *	Exiting,
		const std::string &	Name = "" )

inline

Create a new replicate region with Entry, Exiting and Name.

The returned block is owned by the VPlan and deleted once the VPlan is destroyed.

Definition at line 4942 of file VPlan.h.

Referenced by createReplicateRegion().

◆ createVPBasicBlock()

VPBasicBlock * llvm::VPlan::createVPBasicBlock	(	const Twine &	Name,
		VPRecipeBase *	Recipe = nullptr )

inline

Create a new VPBasicBlock with Name and containing Recipe if present.

The returned block is owned by the VPlan and deleted once the VPlan is destroyed.

Definition at line 4921 of file VPlan.h.

Referenced by addInitialSkeleton(), llvm::VPBasicBlock::clone(), createReplicateRegion(), llvm::VPlanTransforms::expandBranchOnTwoConds(), llvm::VPlanTransforms::handleUncountableEarlyExits(), llvm::VPBasicBlock::splitAt(), and VPlan().

◆ createVPIRBasicBlock()

VPIRBasicBlock * VPlan::createVPIRBasicBlock ( BasicBlock * IRBB )

Create a VPIRBasicBlock from IRBB containing VPIRInstructions for all instructions in IRBB, except its terminator which is managed by the successors of the block in VPlan.

The returned block is owned by the VPlan and deleted once the VPlan is destroyed.

Definition at line 1277 of file VPlan.cpp.

References llvm::BasicBlock::begin(), llvm::VPIRInstruction::create(), createEmptyVPIRBasicBlock(), llvm::ilist_node_impl< OptionsT >::getIterator(), llvm::BasicBlock::getTerminator(), I, and llvm::make_range().

Referenced by llvm::VPlanTransforms::attachCheckBlock(), duplicate(), VPlan(), and VPlan().

◆ dump()

LLVM_DUMP_METHOD void VPlan::dump ( ) const

Dump the plan to stderr (for debugging).

Definition at line 1165 of file VPlan.cpp.

References llvm::dbgs(), and print().

Referenced by execute().

◆ duplicate()

VPlan * VPlan::duplicate ( )

Clone the current VPlan, update all VPValues of the new VPlan and cloned recipes to refer to the clones, and return it.

Definition at line 1206 of file VPlan.cpp.

References assert(), llvm::cast(), llvm::VPBlockUtils::cloneFrom(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::contains(), createVPIRBasicBlock(), llvm::dyn_cast(), llvm::dyn_cast_or_null(), llvm::find_if(), llvm::VPIRBasicBlock::getIRBasicBlock(), getLiveIns(), llvm::VPBlockBase::getNumSuccessors(), getScalarHeader(), I, llvm::isa(), remapOperands(), llvm::seq(), and llvm::vp_depth_first_shallow().

Referenced by llvm::VPlanTransforms::narrowInterleaveGroups(), and llvm::LoopVectorizePass::processLoop().

◆ execute()

void VPlan::execute ( VPTransformState * State )

Generate the IR code for this VPlan.

Generate the code inside the preheader and body of the vectorized loop.

Assumes a single pre-header basic-block was created for this. Introduce additional basic-blocks as needed, and fill them all.

Definition at line 922 of file VPlan.cpp.

References llvm::any_of(), llvm::Block, llvm::cast(), llvm::dbgs(), llvm::DominatorTreeBase< BasicBlock, false >::Delete, llvm::DeleteDeadBlocks(), llvm::drop_begin(), dump(), llvm::dyn_cast(), llvm::LoopBase< BlockT, LoopT >::getBlocksVector(), getConcreteUF(), getExitBlocks(), llvm::vputils::getFirstLoopHeader(), getScalarHeader(), getScalarPreheader(), llvm::BasicBlock::getSingleSuccessor(), llvm::BasicBlock::getTerminator(), hasEarlyExit(), llvm::VPBlockBase::hasPredecessors(), llvm::isa(), LLVM_DEBUG, llvm::make_early_inc_range(), printFinalVPlan(), llvm::reverse(), RUN_VPLAN_PASS, setName(), llvm::succ_begin(), and llvm::successors().

Referenced by llvm::LoopVectorizationPlanner::executePlan().

◆ getAllOnesValue()

VPIRValue * llvm::VPlan::getAllOnesValue ( Type * Ty )

inline

Return a VPIRValue wrapping the AllOnes value of type Ty.

Definition at line 4872 of file VPlan.h.

References llvm::APInt::getAllOnes(), and getConstantInt().

Referenced by simplifyRecipe().

◆ getBackedgeTakenCount()

VPValue * llvm::VPlan::getBackedgeTakenCount ( ) const

inline

Definition at line 4763 of file VPlan.h.

Referenced by llvm::vputils::isHeaderMask().

◆ getConcreteUF()

unsigned llvm::VPlan::getConcreteUF ( ) const

inline

Returns the concrete UF of the plan, after unrolling.

Definition at line 4821 of file VPlan.h.

References assert().

Referenced by llvm::VPlanTransforms::addBranchWeightToMiddleTerminator(), llvm::VPlanTransforms::convertToConcreteRecipes(), execute(), llvm::VPlanTransforms::materializeFactors(), llvm::VPlanTransforms::optimizeForVFAndUF(), and simplifyRecipe().

◆ getConstantInt() [1/3]

VPIRValue * llvm::VPlan::getConstantInt ( const APInt & Val )

inline

Return a VPIRValue wrapping a ConstantInt with the given APInt value.

Definition at line 4889 of file VPlan.h.

References getContext(), and getOrAddLiveIn().

◆ getConstantInt() [2/3]

VPIRValue * llvm::VPlan::getConstantInt	(	Type *	Ty,
		uint64_t	Val,
		bool	IsSigned = false )

inline

Return a VPIRValue wrapping a ConstantInt with the given type and value.

Definition at line 4877 of file VPlan.h.

References getOrAddLiveIn().

◆ getConstantInt() [3/3]

VPIRValue * llvm::VPlan::getConstantInt	(	unsigned	BitWidth,
		uint64_t	Val,
		bool	IsSigned = false )

inline

Return a VPIRValue wrapping a ConstantInt with the given bitwidth and value.

Definition at line 4883 of file VPlan.h.

References llvm::BitWidth, and getConstantInt().

◆ getContext()

LLVMContext & llvm::VPlan::getContext ( ) const

inline

Definition at line 4778 of file VPlan.h.

References llvm::BasicBlock::getContext(), llvm::VPIRBasicBlock::getIRBasicBlock(), and getScalarHeader().

Referenced by llvm::VPlanTransforms::addBranchWeightToMiddleTerminator(), addBypassBranch(), llvm::VPlanTransforms::addExplicitVectorLength(), llvm::VPlanTransforms::addMinimumIterationCheck(), llvm::VPlanTransforms::addMinimumVectorEpilogueIterationCheck(), expandVPWidenIntOrFpInduction(), fixupVFUsersForEVL(), getConstantInt(), optimizeVectorInductionWidthForTCAndVFUF(), llvm::VPlanTransforms::simplifyKnownEVL(), llvm::VPlanTransforms::truncateToMinimalBitwidths(), and tryToReplaceALMWithWideALM().

◆ getDataLayout()

const DataLayout & llvm::VPlan::getDataLayout ( ) const

inline

Definition at line 4782 of file VPlan.h.

References llvm::BasicBlock::getDataLayout(), llvm::VPIRBasicBlock::getIRBasicBlock(), and getScalarHeader().

Referenced by llvm::VPVectorEndPointerRecipe::materializeOffset(), llvm::VPlanTransforms::simplifyKnownEVL(), and simplifyRecipe().

◆ getEntry() [1/2]

VPBasicBlock * llvm::VPlan::getEntry ( )

inline

Definition at line 4679 of file VPlan.h.

◆ getEntry() [2/2]

const VPBasicBlock * llvm::VPlan::getEntry ( ) const

inline

Definition at line 4680 of file VPlan.h.

◆ getExitBlock()

VPIRBasicBlock * VPlan::getExitBlock ( BasicBlock * IRBB ) const

Return the VPIRBasicBlock corresponding to IRBB.

IRBB must be an exit block.

Definition at line 904 of file VPlan.cpp.

References assert(), llvm::find_if(), getExitBlocks(), and llvm::VPIRBasicBlock::getIRBasicBlock().

◆ getExitBlocks()

ArrayRef< VPIRBasicBlock * > llvm::VPlan::getExitBlocks ( ) const

inline

Return an ArrayRef containing VPIRBasicBlocks wrapping the exit blocks of the original scalar loop.

Definition at line 4727 of file VPlan.h.

Referenced by calculateEarlyExitCost(), createExtractsForLiveOuts(), execute(), llvm::LoopVectorizationPlanner::executePlan(), llvm::VPlanTransforms::foldTailByMasking(), getExitBlock(), llvm::VPlanTransforms::handleEarlyExits(), llvm::VPlanTransforms::handleUncountableEarlyExits(), and llvm::VPlanTransforms::optimizeInductionLiveOutUsers().

◆ getFalse()

VPIRValue * llvm::VPlan::getFalse ( )

inline

Return a VPIRValue wrapping i1 false.

Definition at line 4866 of file VPlan.h.

References getConstantInt().

Referenced by llvm::VPlanTransforms::addMinimumIterationCheck(), llvm::VPlanTransforms::handleFindLastReductions(), llvm::VPlanTransforms::optimizeEVLMasks(), llvm::VPlanTransforms::optimizeFindIVReductions(), and simplifyRecipe().

◆ getLiveIn()

VPIRValue * llvm::VPlan::getLiveIn ( Value * V ) const

inline

Return the live-in VPIRValue for V, if there is one or nullptr otherwise.

Definition at line 4895 of file VPlan.h.

Referenced by createWidenInductionRecipe(), and llvm::VPlanTransforms::replaceSymbolicStrides().

◆ getLiveIns()

auto llvm::VPlan::getLiveIns ( ) const

inline

Return the list of live-in VPValues available in the VPlan.

Definition at line 4898 of file VPlan.h.

Referenced by duplicate(), llvm::VPlanTransforms::materializeBroadcasts(), simplifyLiveInsWithSCEV(), and ~VPlan().

◆ getMiddleBlock() [1/2]

VPBasicBlock * llvm::VPlan::getMiddleBlock ( )

inline

Returns the 'middle' block of the plan, that is the block that selects whether to execute the scalar tail loop or the exit block from the loop latch.

If there is an early exit from the vector loop, the middle block conceptully has the early exit block as third successor, split accross 2 VPBBs. In that case, the second VPBB selects whether to execute the scalar tail loop or the exit block. If the scalar tail loop or exit block are known to always execute, the middle block may branch directly to that block. This function cannot be called once the vector loop region has been removed.

Definition at line 4704 of file VPlan.h.

References assert(), llvm::SmallVectorTemplateCommon< T, typename >::back(), llvm::cast(), llvm::VPBlockBase::getSuccessors(), and getVectorLoopRegion().

Referenced by llvm::VPlanTransforms::addBranchWeightToMiddleTerminator(), llvm::VPlanTransforms::addExitUsersForFirstOrderRecurrences(), calculateEarlyExitCost(), llvm::VPlanTransforms::createInLoopReductionRecipes(), llvm::VPlanTransforms::foldTailByMasking(), getMiddleBlock(), llvm::VPlanTransforms::handleMaxMinNumReductions(), isOutsideLoopWorkProfitable(), llvm::VPlanTransforms::materializeConstantVectorTripCount(), llvm::VPlanTransforms::narrowInterleaveGroups(), llvm::VPlanTransforms::optimizeInductionLiveOutUsers(), planContainsAdditionalSimplifications(), preparePlanForMainVectorLoop(), and llvm::LoopVectorizePass::processLoop().

◆ getMiddleBlock() [2/2]

const VPBasicBlock * llvm::VPlan::getMiddleBlock ( ) const

inline

Definition at line 4713 of file VPlan.h.

References getMiddleBlock().

◆ getName()

std::string VPlan::getName ( ) const

Return a string with the name of the plan and the applicable VFs and UFs.

Definition at line 1135 of file VPlan.cpp.

References llvm::drop_begin().

Referenced by print().

◆ getOrAddLiveIn() [1/2]

VPIRValue * llvm::VPlan::getOrAddLiveIn ( Value * V )

inline

Gets the live-in VPIRValue for V or adds a new live-in (if none exists yet) for V.

Definition at line 4843 of file VPlan.h.

References assert(), llvm::dyn_cast(), and llvm::isa().

Referenced by addLaneToStartIndex(), llvm::VPlanTransforms::addMinimumVectorEpilogueIterationCheck(), llvm::VPlanTransforms::attachCheckBlock(), convertRecipesInRegionBlocksToSingleScalar(), llvm::VPlanTransforms::expandSCEVs(), fixupVFUsersForEVL(), llvm::VPlanTransforms::foldTailByMasking(), getConstantInt(), getConstantInt(), getOrAddLiveIn(), llvm::vputils::getOrCreateVPValueForSCEVExpr(), handleFirstArgMinOrMax(), llvm::VPlanTransforms::optimizeFindIVReductions(), preparePlanForEpilogueVectorLoop(), and simplifyLiveInsWithSCEV().

◆ getOrAddLiveIn() [2/2]

VPIRValue * llvm::VPlan::getOrAddLiveIn ( VPIRValue * V )

inline

Definition at line 4857 of file VPlan.h.

References assert(), and getOrAddLiveIn().

◆ getOrCreateBackedgeTakenCount()

VPValue * llvm::VPlan::getOrCreateBackedgeTakenCount ( )

inline

The backedge taken count of the original loop.

Definition at line 4758 of file VPlan.h.

Referenced by llvm::VPlanTransforms::foldTailByMasking(), llvm::VPlanTransforms::materializeBackedgeTakenCount(), llvm::VPlanTransforms::materializeBroadcasts(), and optimizeVectorInductionWidthForTCAndVFUF().

◆ getScalarHeader()

VPIRBasicBlock * llvm::VPlan::getScalarHeader ( ) const

inline

Return the VPIRBasicBlock wrapping the header of the scalar loop.

Definition at line 4723 of file VPlan.h.

Referenced by addInitialSkeleton(), llvm::VPlanTransforms::addMiddleCheck(), duplicate(), execute(), fixScalarResumeValuesFromBypass(), getContext(), getDataLayout(), getScalarPreheader(), llvm::VPlanTransforms::handleEarlyExits(), preparePlanForMainVectorLoop(), llvm::VPlanTransforms::replicateByVF(), llvm::VPlanTransforms::runPass(), and llvm::VPSlotTracker::VPSlotTracker().

◆ getScalarPreheader()

VPBasicBlock * llvm::VPlan::getScalarPreheader ( ) const

inline

◆ getTripCount()

VPValue * llvm::VPlan::getTripCount ( ) const

inline

The trip count of the original loop.

Definition at line 4737 of file VPlan.h.

References assert().

◆ getTrue()

VPIRValue * llvm::VPlan::getTrue ( )

inline

Return a VPIRValue wrapping i1 true.

Definition at line 4863 of file VPlan.h.

References getConstantInt().

Referenced by llvm::VPlanTransforms::addMiddleCheck(), llvm::VPlanTransforms::addMinimumIterationCheck(), fixupVFUsersForEVL(), llvm::VPlanTransforms::optimizeEVLMasks(), optimizeMaskToEVL(), and simplifyBranchConditionForVFAndUF().

◆ getUF()

VPSymbolicValue & llvm::VPlan::getUF ( )

inline

Returns the UF of the vector loop region.

Definition at line 4773 of file VPlan.h.

Referenced by llvm::VPlanTransforms::narrowInterleaveGroups(), llvm::LoopVectorizationPlanner::selectEpilogueVectorizationFactor(), and llvm::VPlanTransforms::unrollByUF().

◆ getVectorLoopRegion() [1/2]

VPRegionBlock * VPlan::getVectorLoopRegion ( )

Returns the VPRegionBlock of the vector loop.

Definition at line 1058 of file VPlan.cpp.

References B(), llvm::dyn_cast(), getEntry(), and llvm::vp_depth_first_shallow().

◆ getVectorLoopRegion() [2/2]

const VPRegionBlock * VPlan::getVectorLoopRegion ( ) const

Definition at line 1066 of file VPlan.cpp.

References B(), llvm::dyn_cast(), getEntry(), and llvm::vp_depth_first_shallow().

◆ getVectorPreheader()

VPBasicBlock * llvm::VPlan::getVectorPreheader ( )

inline

Returns the preheader of the vector loop region, if one exists, or null otherwise.

Definition at line 4684 of file VPlan.h.

References llvm::cast(), llvm::VPBlockBase::getSinglePredecessor(), and getVectorLoopRegion().

Referenced by addVPLaneMaskPhiAndUpdateExitBranch(), llvm::LoopVectorizationPlanner::executePlan(), expandVPWidenIntOrFpInduction(), llvm::VPlanTransforms::hoistInvariantLoads(), insertCheckBlockBeforeVectorLoop(), llvm::vputils::isUniformAcrossVFsAndUFs(), licm(), llvm::VPlanTransforms::materializeBroadcasts(), llvm::VPlanTransforms::narrowInterleaveGroups(), optimizeVectorInductionWidthForTCAndVFUF(), planContainsAdditionalSimplifications(), llvm::LoopVectorizePass::processLoop(), and llvm::VPlanTransforms::truncateToMinimalBitwidths().

◆ getVectorTripCount()

VPSymbolicValue & llvm::VPlan::getVectorTripCount ( )

inline

The vector trip count.

Definition at line 4766 of file VPlan.h.

◆ getVF() [1/2]

VPSymbolicValue & llvm::VPlan::getVF ( )

inline

Returns the VF of the vector loop region.

Definition at line 4769 of file VPlan.h.

Referenced by addVPLaneMaskPhiAndUpdateExitBranch(), llvm::VPlanTransforms::createInterleaveGroups(), createScalarIVSteps(), createWidenInductionRecipe(), fixupVFUsersForEVL(), llvm::vputils::isHeaderMask(), llvm::VPlanTransforms::materializeFactors(), llvm::VPlanTransforms::narrowInterleaveGroups(), optimizeMaskToEVL(), and llvm::VPlanTransforms::unrollByUF().

◆ getVF() [2/2]

const VPSymbolicValue & llvm::VPlan::getVF ( ) const

inline

Definition at line 4770 of file VPlan.h.

◆ getVFxUF()

VPSymbolicValue & llvm::VPlan::getVFxUF ( )

inline

Returns VF * UF of the vector loop region.

Definition at line 4776 of file VPlan.h.

Referenced by addCanonicalIVRecipes(), llvm::VPlanTransforms::convertToVariableLengthStep(), createWidenInductionRecipe(), llvm::LoopVectorizationPlanner::executePlan(), fixupVFUsersForEVL(), llvm::VPlanTransforms::foldTailByMasking(), llvm::VPlanTransforms::materializeFactors(), llvm::VPlanTransforms::narrowInterleaveGroups(), and simplifyBranchConditionForVFAndUF().

◆ getZero()

VPIRValue * llvm::VPlan::getZero ( Type * Ty )

inline

Return a VPIRValue wrapping the null value of type Ty.

Definition at line 4869 of file VPlan.h.

References getConstantInt().

Referenced by llvm::VPlanTransforms::convertEVLExitCond(), convertRecipesInRegionBlocksToSingleScalar(), llvm::VPlanTransforms::materializeVectorTripCount(), optimizeLatchExitInductionUser(), optimizeVectorInductionWidthForTCAndVFUF(), preparePlanForMainVectorLoop(), scalarizeVPWidenPointerInduction(), and simplifyRecipe().

◆ hasEarlyExit()

bool llvm::VPlan::hasEarlyExit ( ) const

inline

Returns true if the VPlan is based on a loop with an early exit.

That is the case if the VPlan has either more than one exit block or a single exit block with multiple predecessors (one for the exit via the latch and one via the other early exit).

Definition at line 4964 of file VPlan.h.

References llvm::count_if(), and llvm::VPBlockBase::hasPredecessors().

Referenced by execute(), llvm::LoopVectorizationPlanner::executePlan(), and llvm::LoopVectorizationPlanner::selectInterleaveCount().

◆ hasScalableVF()

bool llvm::VPlan::hasScalableVF ( ) const

inline

Definition at line 4801 of file VPlan.h.

References llvm::any_of().

Referenced by llvm::VPlanTransforms::convertToConcreteRecipes(), expandVPWidenPointerInduction(), and legalizeAndOptimizeInductions().

◆ hasScalarTail()

bool llvm::VPlan::hasScalarTail ( ) const

inline

Returns true if the scalar tail may execute after the vector loop.

Note that this relies on unneeded branches to the scalar tail loop being removed.

Definition at line 4974 of file VPlan.h.

References getEntry(), getScalarPreheader(), llvm::VPBlockBase::getSinglePredecessor(), and llvm::VPBlockBase::hasPredecessors().

Referenced by llvm::VPlanTransforms::handleMaxMinNumReductions(), and llvm::VPlanTransforms::materializeConstantVectorTripCount().

◆ hasScalarVFOnly()

bool llvm::VPlan::hasScalarVFOnly ( ) const

inline

Definition at line 4811 of file VPlan.h.

References assert(), llvm::ElementCount::getFixed(), and hasVF().

Referenced by llvm::VPlanTransforms::addExplicitVectorLength(), llvm::VPlanTransforms::handleFindLastReductions(), llvm::vputils::isHeaderMask(), legalizeAndOptimizeInductions(), llvm::VPlanTransforms::materializeBroadcasts(), llvm::VPlanTransforms::materializePacksAndUnpacks(), narrowToSingleScalarRecipes(), removeRedundantCanonicalIVs(), llvm::VPlanTransforms::replicateByVF(), simplifyRecipe(), sinkScalarOperands(), and llvm::VPlanTransforms::truncateToMinimalBitwidths().

◆ hasUF()

bool llvm::VPlan::hasUF ( unsigned UF ) const

inline

Definition at line 4818 of file VPlan.h.

Referenced by llvm::LoopVectorizationPlanner::executePlan(), llvm::VPlanTransforms::materializeConstantVectorTripCount(), llvm::VPlanTransforms::optimizeForVFAndUF(), and setUF().

◆ hasVF()

bool llvm::VPlan::hasVF ( ElementCount VF ) const

inline

Definition at line 4800 of file VPlan.h.

Referenced by llvm::LoopVectorizationPlanner::executePlan(), hasScalarVFOnly(), llvm::VPlanTransforms::materializeConstantVectorTripCount(), llvm::VPlanTransforms::optimizeForVFAndUF(), removeVF(), and setVF().

◆ isExitBlock()

bool VPlan::isExitBlock ( VPBlockBase * VPBB )

Returns true if VPBB is an exit block.

Definition at line 912 of file VPlan.cpp.

References llvm::is_contained().

◆ isUnrolled()

bool llvm::VPlan::isUnrolled ( ) const

inline

Returns true if the VPlan already has been unrolled, i.e.

it has a single concrete UF.

Definition at line 4834 of file VPlan.h.

Referenced by simplifyRecipe().

◆ print()

LLVM_DUMP_METHOD void VPlan::print ( raw_ostream & O ) const

Print this VPlan to O.

Definition at line 1118 of file VPlan.cpp.

References llvm::Block, getEntry(), getName(), printLiveIns(), and VPSlotTracker.

Referenced by dump(), llvm::operator<<(), and llvm::LoopVectorizationPlanner::printPlans().

◆ printDOT()

LLVM_DUMP_METHOD void VPlan::printDOT ( raw_ostream & O ) const

Print this VPlan in DOT format to O.

Definition at line 1159 of file VPlan.cpp.

References Printer, and VPlanPrinter.

Referenced by llvm::LoopVectorizationPlanner::printPlans().

◆ printLiveIns()

void VPlan::printLiveIns ( raw_ostream & O ) const

Print the live-ins of this VPlan to O.

Definition at line 1074 of file VPlan.cpp.

References llvm::isa(), and VPSlotTracker.

Referenced by print().

◆ removeVF()

void llvm::VPlan::removeVF ( ElementCount VF )

inline

Remove VF from the plan.

Definition at line 4795 of file VPlan.h.

References assert(), and hasVF().

◆ resetTripCount()

void llvm::VPlan::resetTripCount ( VPValue * NewTripCount )

inline

Resets the trip count for the VPlan.

The caller must make sure all uses of the original trip count have been replaced.

Definition at line 4751 of file VPlan.h.

References assert(), and llvm::VPValue::getNumUsers().

Referenced by llvm::VPlanTransforms::expandSCEVs(), preparePlanForEpilogueVectorLoop(), and llvm::VPlanTransforms::replaceSymbolicStrides().

◆ setEntry()

void llvm::VPlan::setEntry ( VPBasicBlock * VPBB )

inline

Definition at line 4668 of file VPlan.h.

References llvm::VPBlockBase::setPlan().

Referenced by VPlan(), and VPlan().

◆ setName()

void llvm::VPlan::setName ( const Twine & newName )

inline

Definition at line 4839 of file VPlan.h.

References llvm::Twine::str().

Referenced by execute().

◆ setTripCount()

void llvm::VPlan::setTripCount ( VPValue * NewTripCount )

inline

Set the trip count assuming it is currently null; if it is not - use resetTripCount().

Definition at line 4744 of file VPlan.h.

References assert().

Referenced by addInitialSkeleton().

◆ setUF()

void llvm::VPlan::setUF ( unsigned UF )

inline

Definition at line 4826 of file VPlan.h.

References assert(), and hasUF().

Referenced by llvm::VPlanTransforms::addExplicitVectorLength(), and llvm::VPlanTransforms::unrollByUF().

◆ setVF()

void llvm::VPlan::setVF ( ElementCount VF )

inline

Definition at line 4788 of file VPlan.h.

References assert(), and hasVF().

Referenced by llvm::VPlanTransforms::narrowInterleaveGroups(), and llvm::VPlanTransforms::optimizeForVFAndUF().

◆ vectorFactors()

iterator_range< SmallSetVector< ElementCount, 2 >::iterator > llvm::VPlan::vectorFactors ( ) const

inline

Returns an iterator range over all VFs of the plan.

Definition at line 4807 of file VPlan.h.

Referenced by llvm::LoopVectorizationPlanner::computeBestVF(), and llvm::VPlanTransforms::narrowInterleaveGroups().

◆ VPlanPrinter

friend class VPlanPrinter

friend

Definition at line 4588 of file VPlan.h.

References VPlanPrinter.

Referenced by printDOT(), and VPlanPrinter.

◆ VPSlotTracker

friend class VPSlotTracker

friend

Definition at line 4589 of file VPlan.h.

References VPSlotTracker.

Referenced by print(), printLiveIns(), and VPSlotTracker.

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

lib/Transforms/Vectorize/VPlan.h
lib/Transforms/Vectorize/VPlan.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ VPlan() [1/2]

◆ VPlan() [2/2]

◆ ~VPlan()

Member Function Documentation

◆ addVF()

◆ cost()

◆ createEmptyVPIRBasicBlock()

◆ createLoopRegion()

◆ createReplicateRegion()

◆ createVPBasicBlock()

◆ createVPIRBasicBlock()

◆ dump()

◆ duplicate()

◆ execute()

◆ getAllOnesValue()

◆ getBackedgeTakenCount()

◆ getConcreteUF()

◆ getConstantInt() [1/3]

◆ getConstantInt() [2/3]

◆ getConstantInt() [3/3]

◆ getContext()

◆ getDataLayout()

◆ getEntry() [1/2]

◆ getEntry() [2/2]

◆ getExitBlock()

◆ getExitBlocks()

◆ getFalse()

◆ getLiveIn()

◆ getLiveIns()

◆ getMiddleBlock() [1/2]

◆ getMiddleBlock() [2/2]

◆ getName()

◆ getOrAddLiveIn() [1/2]

◆ getOrAddLiveIn() [2/2]

◆ getOrCreateBackedgeTakenCount()

◆ getScalarHeader()

◆ getScalarPreheader()

◆ getTripCount()

◆ getTrue()

◆ getUF()

◆ getVectorLoopRegion() [1/2]

◆ getVectorLoopRegion() [2/2]

◆ getVectorPreheader()

◆ getVectorTripCount()

◆ getVF() [1/2]

◆ getVF() [2/2]

◆ getVFxUF()

◆ getZero()

◆ hasEarlyExit()

◆ hasScalableVF()

◆ hasScalarTail()

◆ hasScalarVFOnly()

◆ hasUF()

◆ hasVF()

◆ isExitBlock()

◆ isUnrolled()

◆ print()

◆ printDOT()

◆ printLiveIns()

◆ removeVF()

◆ resetTripCount()

◆ setEntry()

◆ setName()

◆ setTripCount()

◆ setUF()

◆ setVF()

◆ vectorFactors()

Friends And Related Symbol Documentation

◆ VPlanPrinter

◆ VPSlotTracker