Functions
bool	onlyFirstLaneUsed (const VPValue *Def)
	Returns true if only the first lane of `Def` is used.
bool	onlyFirstPartUsed (const VPValue *Def)
	Returns true if only the first part of `Def` is used.
bool	onlyScalarValuesUsed (const VPValue *Def)
	Returns true if only scalar values of `Def` are used by all users.
VPValue *	getOrCreateVPValueForSCEVExpr (VPlan &Plan, const SCEV *Expr)
	Get or create a VPValue that corresponds to the expansion of `Expr`.
const SCEV *	getSCEVExprForVPValue (VPValue *V, ScalarEvolution &SE)
	Return the SCEV expression for `V`.
bool	isSingleScalar (const VPValue *VPV)
	Returns true if `VPV` is a single scalar, either because it produces the same value for all lanes or only has its first lane used.
bool	isHeaderMask (const VPValue *V, VPlan &Plan)
	Return true if `V` is a header mask in `Plan`.
bool	isUniformAcrossVFsAndUFs (VPValue *V)
	Checks if `V` is uniform across all VF lanes and UF parts.
VPBasicBlock *	getFirstLoopHeader (VPlan &Plan, VPDominatorTree &VPDT)
	Returns the header block of the first, top-level loop, or null if none exist.
unsigned	getVFScaleFactor (VPRecipeBase *R)
	Get the VF scaling factor applied to the recipe's output, if the recipe has one.
std::optional< VPValue * >	getRecipesForUncountableExit (VPlan &Plan, SmallVectorImpl< VPRecipeBase * > &Recipes, SmallVectorImpl< VPRecipeBase * > &GEPs)
	Returns the VPValue representing the uncountable exit comparison used by AnyOf if the recipes it depends on can be traced back to live-ins and the addresses (in GEP/PtrAdd form) of any (non-masked) load used in generating the values for the comparison.

Function Documentation

◆ getFirstLoopHeader()

VPBasicBlock * llvm::vputils::getFirstLoopHeader	(	VPlan &	Plan,
		VPDominatorTree &	VPDT )

Returns the header block of the first, top-level loop, or null if none exist.

Definition at line 135 of file VPlanUtils.cpp.

References llvm::cast(), llvm::find_if(), llvm::VPlan::getEntry(), I, llvm::VPBlockUtils::isHeader(), and llvm::vp_depth_first_shallow().

Referenced by llvm::VPlan::execute(), llvm::LoopVectorizationPlanner::executePlan(), and llvm::InnerLoopVectorizer::fixVectorizedLoop().

◆ getOrCreateVPValueForSCEVExpr()

VPValue * llvm::vputils::getOrCreateVPValueForSCEVExpr	(	VPlan &	Plan,
		const SCEV *	Expr )

Get or create a VPValue that corresponds to the expansion of Expr.

If Expr is a SCEVConstant or SCEVUnknown, return a VPValue wrapping the live-in value. Otherwise return a VPExpandSCEVRecipe to expand Expr. If Plan's pre-header already contains a recipe expanding Expr, return it. If not, create a new one.

Definition at line 33 of file VPlanUtils.cpp.

References llvm::VPlan::addSCEVExpansion(), llvm::VPBasicBlock::appendRecipe(), llvm::dyn_cast(), llvm::VPValue::getDefiningRecipe(), llvm::VPlan::getEntry(), llvm::VPlan::getOrAddLiveIn(), llvm::VPlan::getSCEVExpansion(), and llvm::isa().

Referenced by addInitialSkeleton(), createWidenInductionRecipes(), llvm::VPlanTransforms::replaceSymbolicStrides(), and llvm::VPlanTransforms::tryToConvertVPInstructionsToVPRecipes().

◆ getRecipesForUncountableExit()

std::optional< VPValue * > llvm::vputils::getRecipesForUncountableExit	(	VPlan &	Plan,
		SmallVectorImpl< VPRecipeBase * > &	Recipes,
		SmallVectorImpl< VPRecipeBase * > &	GEPs )

Returns the VPValue representing the uncountable exit comparison used by AnyOf if the recipes it depends on can be traced back to live-ins and the addresses (in GEP/PtrAdd form) of any (non-masked) load used in generating the values for the comparison.

The recipes are stored in Recipes, and recipes forming an address for a load are also added to GEPs.

Definition at line 158 of file VPlanUtils.cpp.

References llvm::dyn_cast(), llvm::SmallVectorTemplateCommon< T, typename >::empty(), GEP, llvm::VPlan::getVectorLoopRegion(), llvm::VPlanPatternMatch::m_AnyOf(), llvm::VPlanPatternMatch::m_BranchOnCond(), llvm::VPlanPatternMatch::m_c_BinaryOr(), llvm::VPlanPatternMatch::m_GetElementPtr(), llvm::PatternMatch::m_ICmp(), llvm::VPlanPatternMatch::m_LiveIn(), llvm::MIPatternMatch::m_OneUse(), llvm::VPlanPatternMatch::m_VPValue(), llvm::PatternMatch::match(), llvm::SmallVectorImpl< T >::pop_back_val(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ getSCEVExprForVPValue()

const SCEV * llvm::vputils::getSCEVExprForVPValue	(	VPValue *	V,
		ScalarEvolution &	SE )

Return the SCEV expression for V.

Returns SCEVCouldNotCompute if no SCEV expression could be constructed.

Definition at line 78 of file VPlanUtils.cpp.

References llvm::TypeSwitch< T, ResultT >::Case(), llvm::Default, llvm::ScalarEvolution::getCouldNotCompute(), and llvm::ScalarEvolution::getSCEV().

Referenced by llvm::VPlanTransforms::addMinimumIterationCheck(), getOptimizableIVOf(), isConditionTrueViaVFAndUF(), llvm::LoopVectorizationPlanner::selectEpilogueVectorizationFactor(), and simplifyBranchConditionForVFAndUF().

◆ getVFScaleFactor()

unsigned llvm::vputils::getVFScaleFactor ( VPRecipeBase * R )

Get the VF scaling factor applied to the recipe's output, if the recipe has one.

Definition at line 143 of file VPlanUtils.cpp.

References assert(), llvm::cast(), llvm::dyn_cast(), getOpcode(), llvm::isa(), and llvm::VPInstruction::ReductionStartVector.

Referenced by llvm::calculateRegisterUsageForPlan(), and llvm::VPRecipeBuilder::tryToCreatePartialReduction().

◆ isHeaderMask()

bool llvm::vputils::isHeaderMask	(	const VPValue *	V,
		VPlan &	Plan )

Return true if V is a header mask in Plan.

Definition at line 56 of file VPlanUtils.cpp.

References A(), B(), llvm::cast(), llvm::VPlan::getCanonicalIV(), llvm::VPlan::getOrCreateBackedgeTakenCount(), llvm::VPlan::getTripCount(), llvm::VPlan::getVF(), llvm::isa(), llvm::VPlanPatternMatch::m_ActiveLaneMask(), llvm::VPlanPatternMatch::m_Binary(), llvm::PatternMatch::m_One(), llvm::VPlanPatternMatch::m_ScalarIVSteps(), llvm::PatternMatch::m_Specific(), llvm::VPlanPatternMatch::m_VPValue(), and llvm::PatternMatch::match().

Referenced by findHeaderMask().

◆ isSingleScalar()

bool llvm::vputils::isSingleScalar ( const VPValue * VPV )

inline

Returns true if VPV is a single scalar, either because it produces the same value for all lanes or only has its first lane used.

Definition at line 44 of file VPlanUtils.h.

References llvm::all_of(), llvm::VPInstruction::Broadcast, llvm::dyn_cast(), llvm::VPValue::getDefiningRecipe(), llvm::VPBlockBase::getParent(), llvm::isa(), llvm::Instruction::isBinaryOp(), llvm::Instruction::isCast(), llvm::VPValue::isLiveIn(), llvm::VPRegionBlock::isReplicator(), isSingleScalar(), llvm::VPInstruction::Not, llvm::VPUser::operands(), and llvm::VPInstruction::PtrAdd.

Referenced by cloneForLane(), llvm::VPWidenMemoryRecipe::computeCost(), llvm::VPIRPhi::execute(), llvm::VPTransformState::get(), llvm::VPTransformState::get(), isSingleScalar(), legalizeAndOptimizeInductions(), narrowToSingleScalarRecipes(), planContainsAdditionalSimplifications(), scalarizeInstruction(), and simplifyRecipe().

◆ isUniformAcrossVFsAndUFs()

bool llvm::vputils::isUniformAcrossVFsAndUFs ( VPValue * V )

Checks if V is uniform across all VF lanes and UF parts.

It is considered as such if it is either loop invariant (defined outside the vector region) or its operand is known to be uniform across all VFs and UFs (e.g. VPDerivedIV or VPCanonicalIVPHI).

Definition at line 92 of file VPlanUtils.cpp.

References llvm::all_of(), llvm::TypeSwitch< T, ResultT >::Case(), llvm::Default, llvm::isa(), isUniformAcrossVFsAndUFs(), llvm::VPlanPatternMatch::m_VPInstruction(), and llvm::PatternMatch::match().

Referenced by isUniformAcrossVFsAndUFs().