#include "Transforms/Vectorize/VPlanValue.h"

Inheritance diagram for llvm::VPValue:

[legend]

Public Types
enum	{ VPValueSC , VPVRecipeSC }
	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.

	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).

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.

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	isLiveIn () const
	Returns true if this VPValue is a live-in, i.e. defined outside the VPlan.

Value *	getLiveInIRValue ()
	Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.

const Value *	getLiveInIRValue () const

bool	isDefinedOutsideLoopRegions () const
	Returns true if the VPValue is defined outside any loop region.

void	setUnderlyingValue (Value *Val)

Protected Member Functions
	VPValue (const unsigned char SC, Value UV=nullptr, VPDef Def=nullptr)

	VPValue (Value *UV=nullptr)
	Create a live-in VPValue.

	VPValue (VPDef Def, Value UV=nullptr)
	Create a VPValue for a `Def` which is a subclass of VPValue.

	VPValue (Value UV, VPDef Def)
	Create a VPValue for a `Def` which defines multiple values.

Protected Attributes
Value *	UnderlyingVal

VPDef *	Def
	Pointer to the VPDef that defines this VPValue.

Friends
class	VPBuilder

class	VPDef

struct	VPDoubleValueDef

class	VPInstruction

class	VPInterleaveRecipe

struct	VPlanTransforms

class	VPBasicBlock

class	VPInterleavedAccessInfo

class	VPSlotTracker

class	VPRecipeBase

class	VPlan

Detailed Description

Definition at line 46 of file VPlanValue.h.

Member Typedef Documentation

◆ const_user_iterator

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

Definition at line 130 of file VPlanValue.h.

◆ const_user_range

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

Definition at line 132 of file VPlanValue.h.

◆ user_iterator

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

Definition at line 129 of file VPlanValue.h.

◆ user_range

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

Definition at line 131 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

VPValueSC

VPVRecipeSC

A generic VPValue, like live-in values or defined by a recipe that defines multiple values.

A VPValue sub-class that is a VPRecipeBase.

Definition at line 93 of file VPlanValue.h.

Constructor & Destructor Documentation

◆ VPValue() [1/5]

VPValue::VPValue	(	const unsigned char	SC,
		Value *	UV = `nullptr`,
		VPDef *	Def = `nullptr`
	)

protected

Definition at line 86 of file VPlan.cpp.

References Def.

◆ VPValue() [2/5]

llvm::VPValue::VPValue ( Value * UV = nullptr )

inlineprotected

Create a live-in VPValue.

Definition at line 74 of file VPlanValue.h.

◆ VPValue() [3/5]

llvm::VPValue::VPValue	(	VPDef *	Def,
		Value *	UV = `nullptr`
	)

inlineprotected

Create a VPValue for a Def which is a subclass of VPValue.

Definition at line 76 of file VPlanValue.h.

◆ VPValue() [4/5]

llvm::VPValue::VPValue	(	Value *	UV,
		VPDef *	Def
	)

inlineprotected

Create a VPValue for a Def which defines multiple values.

Definition at line 78 of file VPlanValue.h.

◆ VPValue() [5/5]

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

delete

◆ ~VPValue()

VPValue::~VPValue ( )

virtual

Definition at line 92 of file VPlan.cpp.

References assert(), and Def.

Member Function Documentation

◆ addUser()

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

inline

Definition at line 118 of file VPlanValue.h.

References Users.

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

◆ dump()

void VPValue::dump ( ) const

Dump the value to stderr (for debugging).

Definition at line 106 of file VPlan.cpp.

References llvm::dbgs(), Def, 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 123 of file VPlan.cpp.

References Def.

Referenced by llvm::VPWidenCastRecipe::computeCost(), llvm::VPPartialReductionRecipe::computeCost(), llvm::VPHeaderPHIRecipe::getBackedgeRecipe(), getOptimizableIVOf(), llvm::vputils::getOrCreateVPValueForSCEVExpr(), hasDefiningRecipe(), llvm::VPWidenIntOrFpInductionRecipe::isCanonical(), isDefinedInsideLoopRegions(), llvm::vputils::isUniformAfterVectorization(), preparePlanForMainVectorLoop(), recursivelyDeleteDeadRecipes(), and llvm::VPRecipeBuilder::tryToCreatePartialReduction().

◆ getDefiningRecipe() [2/2]

const VPRecipeBase * VPValue::getDefiningRecipe ( ) const

Definition at line 127 of file VPlan.cpp.

References Def.

◆ getLiveInIRValue() [1/2]

Value * llvm::VPValue::getLiveInIRValue ( )

inline

Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.

Returns nullptr if the VPValue is defined by a VPDef inside a VPlan.

Definition at line 178 of file VPlanValue.h.

References assert(), getUnderlyingValue(), and isLiveIn().

Referenced by llvm::VPWidenIntOrFpInductionRecipe::execute(), llvm::VPWidenPointerInductionRecipe::execute(), llvm::VPFirstOrderRecurrencePHIRecipe::execute(), llvm::VPReductionPHIRecipe::execute(), llvm::VPDerivedIVRecipe::execute(), llvm::VPWidenCallRecipe::getCalledScalarFunction(), getOptimizableIVOf(), llvm::VPCanonicalIVPHIRecipe::getScalarType(), llvm::VPDerivedIVRecipe::getScalarType(), llvm::VPWidenIntOrFpInductionRecipe::isCanonical(), llvm::VPlanPatternMatch::specific_intval< BitWidth >::match(), and llvm::VPlanTransforms::optimizeInductionExitUsers().

◆ getLiveInIRValue() [2/2]

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

inline

Definition at line 183 of file VPlanValue.h.

References assert(), getUnderlyingValue(), and isLiveIn().

◆ getNumUsers()

unsigned llvm::VPValue::getNumUsers ( ) const

inline

Definition at line 117 of file VPlanValue.h.

References Users.

Referenced by llvm::VPWidenCastRecipe::computeCost(), createReplicateRegion(), hasMoreThanOneUniqueUser(), and llvm::VPlan::resetTripCount().

◆ getUnderlyingValue()

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

inline

Return the underlying Value attached to this VPValue.

Definition at line 89 of file VPlanValue.h.

References UnderlyingVal.

Referenced by llvm::VPWidenCastRecipe::clone(), llvm::VPWidenIntrinsicRecipe::clone(), llvm::VPWidenCallRecipe::clone(), llvm::VPBlendRecipe::clone(), llvm::VPWidenRecipe::computeCost(), llvm::VPWidenCastRecipe::computeCost(), llvm::VPWidenIntrinsicRecipe::computeCost(), llvm::VPWidenSelectRecipe::computeCost(), llvm::VPReplicateRecipe::computeCost(), llvm::VPWidenRecipe::execute(), llvm::VPWidenCastRecipe::execute(), llvm::VPWidenIntrinsicRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenSelectRecipe::execute(), llvm::VPPredInstPHIRecipe::execute(), llvm::VPWidenEVLRecipe::execute(), getLiveInIRValue(), llvm::VPWidenInductionRecipe::getPHINode(), llvm::VPSingleDefRecipe::getUnderlyingInstr(), llvm::VPWidenPHIRecipe::print(), llvm::VPlanTransforms::truncateToMinimalBitwidths(), and llvm::VPlanTransforms::VPInstructionsToVPRecipes().

◆ 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 107 of file VPlanValue.h.

◆ hasDefiningRecipe()

bool llvm::VPValue::hasDefiningRecipe ( ) const

inline

Returns true if this VPValue is defined by a recipe.

Definition at line 170 of file VPlanValue.h.

References getDefiningRecipe().

Referenced by isLiveIn().

◆ hasMoreThanOneUniqueUser()

bool llvm::VPValue::hasMoreThanOneUniqueUser ( ) const

inline

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

Definition at line 144 of file VPlanValue.h.

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

Referenced by llvm::VPWidenCastRecipe::computeCost().

◆ isDefinedOutsideLoopRegions()

bool VPValue::isDefinedOutsideLoopRegions ( ) const

Returns true if the VPValue is defined outside any loop region.

Definition at line 1417 of file VPlan.cpp.

References isDefinedInsideLoopRegions().

Referenced by llvm::VPWidenRecipe::computeCost(), llvm::VPWidenSelectRecipe::computeCost(), llvm::VPWidenSelectRecipe::isInvariantCond(), and llvm::vputils::isUniformAfterVectorization().

◆ isLiveIn()

bool llvm::VPValue::isLiveIn ( ) const

inline

Returns true if this VPValue is a live-in, i.e. defined outside the VPlan.

Definition at line 173 of file VPlanValue.h.

References hasDefiningRecipe().

Referenced by llvm::VPWidenCastRecipe::computeCost(), getLiveInIRValue(), getOptimizableIVOf(), llvm::VPlan::getOrAddLiveIn(), and llvm::VPlanPatternMatch::specific_intval< BitWidth >::match().

◆ operator=()

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

delete

◆ print()

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

Definition at line 99 of file VPlan.cpp.

References Def, OS, and printAsOperand().

Referenced by dump().

◆ printAsOperand()

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

Definition at line 1452 of file VPlan.cpp.

References llvm::VPSlotTracker::getOrCreateName(), and OS.

◆ removeUser()

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

inline

Remove a single User from the list of users.

Definition at line 121 of file VPlanValue.h.

References llvm::find(), I, and Users.

◆ replaceAllUsesWith()

void VPValue::replaceAllUsesWith ( VPValue * New )

Definition at line 1420 of file VPlan.cpp.

Referenced by llvm::VPlanTransforms::createInterleaveGroups(), createReplicateRegion(), legalizeAndOptimizeInductions(), preparePlanForEpilogueVectorLoop(), removeRedundantCanonicalIVs(), removeRedundantInductionCasts(), simplifyRecipe(), transformRecipestoEVLRecipes(), llvm::VPlanTransforms::truncateToMinimalBitwidths(), and llvm::VPlanTransforms::VPInstructionsToVPRecipes().

◆ 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 1424 of file VPlan.cpp.

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

Referenced by mergeReplicateRegionsIntoSuccessors(), and sinkScalarOperands().

◆ setUnderlyingValue()

void llvm::VPValue::setUnderlyingValue ( Value * Val )

inline

Definition at line 193 of file VPlanValue.h.

References assert(), and UnderlyingVal.

Referenced by llvm::VPBuilder::createNaryOp().

◆ user_begin() [1/2]

user_iterator llvm::VPValue::user_begin ( )

inline

Definition at line 134 of file VPlanValue.h.

References Users.

Referenced by llvm::VPWidenCastRecipe::computeCost(), hasMoreThanOneUniqueUser(), and users().

◆ user_begin() [2/2]

const_user_iterator llvm::VPValue::user_begin ( ) const

inline

Definition at line 135 of file VPlanValue.h.

References Users.

◆ user_end() [1/2]

user_iterator llvm::VPValue::user_end ( )

inline

Definition at line 136 of file VPlanValue.h.

References Users.

Referenced by hasMoreThanOneUniqueUser(), and users().

◆ user_end() [2/2]

const_user_iterator llvm::VPValue::user_end ( ) const

inline

Definition at line 137 of file VPlanValue.h.

References Users.

◆ users() [1/2]

user_range llvm::VPValue::users ( )

inline

Definition at line 138 of file VPlanValue.h.

References user_begin(), and user_end().

Referenced by llvm::VPlanTransforms::addActiveLaneMask(), collectAllHeaderMasks(), llvm::VPBlendRecipe::onlyFirstLaneUsed(), removeRedundantCanonicalIVs(), removeRedundantInductionCasts(), llvm::VPReplicateRecipe::shouldPack(), sinkRecurrenceUsersAfterPrevious(), sinkScalarOperands(), and transformRecipestoEVLRecipes().

◆ users() [2/2]

const_user_range llvm::VPValue::users ( ) const

inline

Definition at line 139 of file VPlanValue.h.

References user_begin(), and user_end().

Friends And Related Function Documentation

◆ VPBasicBlock

friend class VPBasicBlock

friend

Definition at line 53 of file VPlanValue.h.

◆ VPBuilder

friend class VPBuilder

friend

Definition at line 47 of file VPlanValue.h.

◆ VPDef

friend class VPDef

friend

Definition at line 48 of file VPlanValue.h.

◆ VPDoubleValueDef

friend struct VPDoubleValueDef

friend

Definition at line 49 of file VPlanValue.h.

◆ VPInstruction

friend class VPInstruction

friend

Definition at line 50 of file VPlanValue.h.

◆ VPInterleavedAccessInfo

friend class VPInterleavedAccessInfo

friend

Definition at line 54 of file VPlanValue.h.

◆ VPInterleaveRecipe

friend class VPInterleaveRecipe

friend

Definition at line 51 of file VPlanValue.h.

◆ VPlan

friend class VPlan

friend

Definition at line 57 of file VPlanValue.h.

◆ VPlanTransforms

friend struct VPlanTransforms

friend

Definition at line 52 of file VPlanValue.h.

◆ VPRecipeBase

friend class VPRecipeBase

friend

Definition at line 56 of file VPlanValue.h.

◆ VPSlotTracker

friend class VPSlotTracker

friend

Definition at line 55 of file VPlanValue.h.

Member Data Documentation

◆ Def

VPDef* llvm::VPValue::Def

protected

Pointer to the VPDef that defines this VPValue.

If it is nullptr, the VPValue is not defined by any recipe modeled in VPlan.

Definition at line 69 of file VPlanValue.h.

Referenced by dump(), getDefiningRecipe(), print(), VPValue(), and ~VPValue().

◆ UnderlyingVal

Value* llvm::VPValue::UnderlyingVal

protected

Definition at line 65 of file VPlanValue.h.

Referenced by getUnderlyingValue(), and setUnderlyingValue().

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_user_iterator

◆ const_user_range

◆ user_iterator

◆ user_range

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ VPValue() [1/5]

◆ VPValue() [2/5]

◆ VPValue() [3/5]

◆ VPValue() [4/5]

◆ VPValue() [5/5]

◆ ~VPValue()

Member Function Documentation

◆ addUser()

◆ dump()

◆ getDefiningRecipe() [1/2]

◆ getDefiningRecipe() [2/2]

◆ getLiveInIRValue() [1/2]

◆ getLiveInIRValue() [2/2]

◆ getNumUsers()

◆ getUnderlyingValue()

◆ getVPValueID()

◆ hasDefiningRecipe()

◆ hasMoreThanOneUniqueUser()

◆ isDefinedOutsideLoopRegions()

◆ isLiveIn()

◆ operator=()

◆ print()

◆ printAsOperand()

◆ removeUser()

◆ replaceAllUsesWith()

◆ replaceUsesWithIf()

◆ setUnderlyingValue()

◆ user_begin() [1/2]

◆ user_begin() [2/2]

◆ user_end() [1/2]

◆ user_end() [2/2]

◆ users() [1/2]

◆ users() [2/2]

Friends And Related Function Documentation

◆ VPBasicBlock

◆ VPBuilder

◆ VPDef

◆ VPDoubleValueDef

◆ VPInstruction

◆ VPInterleavedAccessInfo

◆ VPInterleaveRecipe

◆ VPlan

◆ VPlanTransforms

◆ VPRecipeBase

◆ VPSlotTracker

Member Data Documentation

◆ Def

◆ UnderlyingVal