This is the base class of the VPlan Def/Use graph, used for modeling the data flow into, within and out of the VPlan. More...

#include "Transforms/Vectorize/VPlanValue.h"

Inheritance diagram for llvm::VPValue:

[legend]

Public Types
enum	{ VPVIRValueSC , VPVSymbolicSC , VPVSingleDefValueSC , VPVMultiDefValueSC , VPRegionValueSC }
	An enumeration for keeping track of the concrete subclass of VPValue that are actually instantiated. More...
typedef SmallVectorImpl< VPUser * >::iterator	user_iterator
typedef SmallVectorImpl< VPUser * >::const_iterator	const_user_iterator
typedef iterator_range< user_iterator >	user_range
typedef iterator_range< const_user_iterator >	const_user_range

Public Member Functions
Value *	getUnderlyingValue () const
	Return the underlying Value attached to this VPValue.
Value *	getLiveInIRValue () const
	Return the underlying IR value for a VPIRValue.
	VPValue (const VPValue &)=delete
VPValue &	operator= (const VPValue &)=delete
virtual	~VPValue ()
unsigned	getVPValueID () const
void	printAsOperand (raw_ostream &OS, VPSlotTracker &Tracker) const
void	print (raw_ostream &OS, VPSlotTracker &Tracker) const
void	dump () const
	Dump the value to stderr (for debugging).
void	assertNotMaterialized () const
	Assert that this VPValue has not been materialized, if it is a VPSymbolicValue.
unsigned	getNumUsers () const
void	addUser (VPUser &User)
void	removeUser (VPUser &User)
	Remove a single `User` from the list of users.
user_iterator	user_begin ()
const_user_iterator	user_begin () const
user_iterator	user_end ()
const_user_iterator	user_end () const
user_range	users ()
const_user_range	users () const
bool	hasMoreThanOneUniqueUser () const
	Returns true if the value has more than one unique user.
bool	hasOneUse () const
VPUser *	getSingleUser ()
	Return the single user of this value, or nullptr if there is not exactly one user.
const VPUser *	getSingleUser () const
void	replaceAllUsesWith (VPValue *New)
void	replaceUsesWithIf (VPValue *New, llvm::function_ref< bool(VPUser &U, unsigned Idx)> ShouldReplace)
	Go through the uses list for this VPValue and make each use point to `New` if the callback ShouldReplace returns true for the given use specified by a pair of (VPUser, the use index).
VPRecipeBase *	getDefiningRecipe ()
	Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe, i.e.
const VPRecipeBase *	getDefiningRecipe () const
bool	hasDefiningRecipe () const
	Returns true if this VPValue is defined by a recipe.
bool	isDefinedOutsideLoopRegions () const
	Returns true if the VPValue is defined outside any loop.
void	setUnderlyingValue (Value *Val)

Friends
struct	VPIRValue
struct	VPSymbolicValue
class	VPRecipeValue
class	VPRegionValue

Detailed Description

This is the base class of the VPlan Def/Use graph, used for modeling the data flow into, within and out of the VPlan.

VPValues can stand for live-ins coming from the input IR, symbolic values and values defined by recipes.

Definition at line 50 of file VPlanValue.h.

Member Typedef Documentation

◆ const_user_iterator

typedef SmallVectorImpl<VPUser*>::const_iterator llvm::VPValue::const_user_iterator

Definition at line 137 of file VPlanValue.h.

◆ const_user_range

typedef iterator_range<const_user_iterator> llvm::VPValue::const_user_range

Definition at line 139 of file VPlanValue.h.

◆ user_iterator

typedef SmallVectorImpl<VPUser*>::iterator llvm::VPValue::user_iterator

Definition at line 136 of file VPlanValue.h.

◆ user_range

typedef iterator_range<user_iterator> llvm::VPValue::user_range

Definition at line 138 of file VPlanValue.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

An enumeration for keeping track of the concrete subclass of VPValue that are actually instantiated.

Enumerator
VPVIRValueSC
VPVSymbolicSC	A live-in VPValue wrapping an IR Value.
VPVSingleDefValueSC	A symbolic live-in VPValue without IR backing.
VPVMultiDefValueSC	A VPValue defined by a VPSingleDefRecipe.
VPRegionValueSC	A VPValue defined by a multi-def recipe.

Definition at line 82 of file VPlanValue.h.

Constructor & Destructor Documentation

◆ VPValue()

llvm::VPValue::VPValue ( const VPValue & )

delete

◆ ~VPValue()

virtual llvm::VPValue::~VPValue ( )

inlinevirtual

Definition at line 94 of file VPlanValue.h.

References assert().

Member Function Documentation

◆ addUser()

void llvm::VPValue::addUser ( VPUser & User )

inline

Definition at line 121 of file VPlanValue.h.

References assertNotMaterialized().

Referenced by llvm::VPUser::addOperand().

◆ assertNotMaterialized()

void llvm::VPValue::assertNotMaterialized ( ) const

inline

Assert that this VPValue has not been materialized, if it is a VPSymbolicValue.

Definition at line 548 of file VPlanValue.h.

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

Referenced by addUser(), getNumUsers(), removeUser(), replaceUsesWithIf(), user_begin(), user_begin(), user_end(), and user_end().

◆ dump()

void VPValue::dump ( ) const

Dump the value to stderr (for debugging).

Definition at line 109 of file VPlan.cpp.

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

◆ getDefiningRecipe() [1/2]

VPRecipeBase * VPValue::getDefiningRecipe ( )

Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe, i.e.

is a live-in.

Definition at line 130 of file VPlan.cpp.

References llvm::dyn_cast().

Referenced by canNarrowLoad(), llvm::VPReductionRecipe::classof(), cloneBinOpForScalarIV(), llvm::VPlanTransforms::createInterleaveGroups(), createReplicateRegion(), createWidenInductionRecipe(), dump(), expandVPWidenIntOrFpInduction(), llvm::vputils::findRecipe(), fixupVFUsersForEVL(), llvm::VPRecipeWithIRFlags::getCostForRecipeWithOpcode(), getDefiningRecipe(), getOptimizableIVOf(), llvm::vputils::getRecipesForUncountableExit(), llvm::VPlanTransforms::handleFindLastReductions(), handleFirstArgMinOrMax(), llvm::VPlanTransforms::handleUncountableEarlyExits(), hasDefiningRecipe(), isDefinedInsideLoopRegions(), llvm::vputils::isSingleScalar(), llvm::VPlanTransforms::materializeVectorTripCount(), llvm::VPlanTransforms::optimizeFindIVReductions(), print(), recursivelyDeleteDeadRecipes(), removeCommonBlendMask(), llvm::VPlanTransforms::removeDeadRecipes(), tryToMatchAndCreateMulAccumulateReduction(), and llvm::VPRecipeValue::~VPRecipeValue().

◆ getDefiningRecipe() [2/2]

const VPRecipeBase * VPValue::getDefiningRecipe ( ) const

Definition at line 139 of file VPlan.cpp.

References getDefiningRecipe().

◆ getLiveInIRValue()

Value * VPValue::getLiveInIRValue ( ) const

Return the underlying IR value for a VPIRValue.

Definition at line 143 of file VPlan.cpp.

References llvm::cast().

Referenced by llvm::VPlanTransforms::addMinimumVectorEpilogueIterationCheck(), llvm::VPReplicateRecipe::computeCost(), createLoopRegion(), decideCallWidening(), llvm::VPFirstOrderRecurrencePHIRecipe::execute(), llvm::VPWidenCallRecipe::getCalledScalarFunction(), llvm::VPlanTransforms::materializeConstantVectorTripCount(), preparePlanForEpilogueVectorLoop(), and preparePlanForMainVectorLoop().

◆ getNumUsers()

unsigned llvm::VPValue::getNumUsers ( ) const

inline

Definition at line 115 of file VPlanValue.h.

References assertNotMaterialized().

Referenced by llvm::calculateRegisterUsageForPlan(), createReplicateRegion(), llvm::VPlanTransforms::handleMultiUseReductions(), hasMoreThanOneUniqueUser(), hasOneUse(), llvm::VPlanTransforms::materializeBackedgeTakenCount(), llvm::VPlanTransforms::materializeConstantVectorTripCount(), llvm::VPlanTransforms::materializeFactors(), llvm::VPlanTransforms::materializeVectorTripCount(), llvm::VPlanTransforms::removeDeadRecipes(), replaceUsesWithIf(), llvm::VPlan::resetTripCount(), and simplifyBlends().

◆ getSingleUser() [1/2]

VPUser * llvm::VPValue::getSingleUser ( )

inline

Return the single user of this value, or nullptr if there is not exactly one user.

Definition at line 178 of file VPlanValue.h.

References hasOneUse(), and user_begin().

◆ getSingleUser() [2/2]

const VPUser * llvm::VPValue::getSingleUser ( ) const

inline

Definition at line 179 of file VPlanValue.h.

References hasOneUse(), and user_begin().

◆ getUnderlyingValue()

Value * llvm::VPValue::getUnderlyingValue ( ) const

inline

Return the underlying Value attached to this VPValue.

Definition at line 75 of file VPlanValue.h.

Referenced by llvm::VPBlendRecipe::clone(), llvm::VPInstruction::clone(), llvm::VPInstructionWithType::clone(), llvm::VPPhi::clone(), llvm::VPReductionPHIRecipe::clone(), llvm::VPWidenCallRecipe::clone(), llvm::VPWidenCastRecipe::clone(), llvm::VPWidenIntrinsicRecipe::clone(), llvm::VPWidenRecipe::clone(), llvm::VPInstruction::computeCost(), llvm::VPReplicateRecipe::computeCost(), llvm::VPlanTransforms::dropPoisonGeneratingRecipes(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenIntrinsicRecipe::execute(), llvm::VPRecipeWithIRFlags::getCostForRecipeWithOpcode(), llvm::VPWidenInductionRecipe::getPHINode(), llvm::VPIRValue::getType(), llvm::VPSingleDefRecipe::getUnderlyingInstr(), llvm::VPSingleDefRecipe::getUnderlyingInstr(), llvm::VPIRValue::getValue(), llvm::VPlanTransforms::materializeVectorTripCount(), preparePlanForEpilogueVectorLoop(), llvm::VPlanTransforms::truncateToMinimalBitwidths(), llvm::VPlanTransforms::tryToConvertVPInstructionsToVPRecipes(), and llvm::VPReductionEVLRecipe::VPReductionEVLRecipe().

◆ getVPValueID()

unsigned llvm::VPValue::getVPValueID ( ) const

inline

Returns: an ID for the concrete type of this object. This is used to implement the classof checks. This should not be used for any other purpose, as the values may change as LLVM evolves.

Definition at line 101 of file VPlanValue.h.

◆ hasDefiningRecipe()

bool llvm::VPValue::hasDefiningRecipe ( ) const

inline

Returns true if this VPValue is defined by a recipe.

Definition at line 198 of file VPlanValue.h.

References getDefiningRecipe().

◆ hasMoreThanOneUniqueUser()

bool llvm::VPValue::hasMoreThanOneUniqueUser ( ) const

inline

Returns true if the value has more than one unique user.

Definition at line 163 of file VPlanValue.h.

References getNumUsers(), user_begin(), and user_end().

◆ hasOneUse()

bool llvm::VPValue::hasOneUse ( ) const

inline

Definition at line 174 of file VPlanValue.h.

References getNumUsers().

Referenced by getSingleUser(), and getSingleUser().

◆ isDefinedOutsideLoopRegions()

bool VPValue::isDefinedOutsideLoopRegions ( ) const

Returns true if the VPValue is defined outside any loop.

Definition at line 1486 of file VPlan.cpp.

References isDefinedInsideLoopRegions().

Referenced by llvm::VPReplicateRecipe::computeCost(), llvm::VPRecipeWithIRFlags::getCostForRecipeWithOpcode(), and getExpressionIV().

◆ operator=()

VPValue & llvm::VPValue::operator= ( const VPValue & )

delete

◆ print()

void VPValue::print	(	raw_ostream &	OS,
		VPSlotTracker &	Tracker ) const

Definition at line 102 of file VPlan.cpp.

References getDefiningRecipe(), and printAsOperand().

Referenced by dump().

◆ printAsOperand()

void VPValue::printAsOperand	(	raw_ostream &	OS,
		VPSlotTracker &	Tracker ) const

Definition at line 1531 of file VPlan.cpp.

References llvm::VPSlotTracker::getOrCreateName().

◆ removeUser()

void llvm::VPValue::removeUser ( VPUser & User )

inline

Remove a single User from the list of users.

Definition at line 127 of file VPlanValue.h.

References assertNotMaterialized(), find(), and I.

◆ replaceAllUsesWith()

void VPValue::replaceAllUsesWith ( VPValue * New )

Definition at line 1489 of file VPlan.cpp.

References llvm::dyn_cast(), and replaceUsesWithIf().

◆ replaceUsesWithIf()

void VPValue::replaceUsesWithIf	(	VPValue *	New,
		llvm::function_ref< bool(VPUser &U, unsigned Idx)>	ShouldReplace )

Go through the uses list for this VPValue and make each use point to New if the callback ShouldReplace returns true for the given use specified by a pair of (VPUser, the use index).

Definition at line 1495 of file VPlan.cpp.

References assertNotMaterialized(), llvm::User::getNumOperands(), getNumUsers(), llvm::User::getOperand(), I, and llvm::User::setOperand().

Referenced by fixupVFUsersForEVL(), llvm::VPlanTransforms::materializeFactors(), mergeReplicateRegionsIntoSuccessors(), preparePlanForMainVectorLoop(), replaceAllUsesWith(), llvm::VPlanTransforms::replaceSymbolicStrides(), sinkScalarOperands(), and tryToSinkOrHoistRecurrenceUsers().