#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 ()
	Return the underlying Value attached to this VPValue.

const Value *	getUnderlyingValue () const

	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.

	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 ()
	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	isDefinedOutsideVectorRegions () const
	Returns true if the VPValue is defined outside any vector regions, i.e.

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

void	setUnderlyingValue (Value *Val)

Protected Attributes
Value *	UnderlyingVal

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

Friends
class	VPBuilder

class	VPDef

class	VPInstruction

struct	VPlanTransforms

class	VPBasicBlock

class	VPInterleavedAccessInfo

class	VPSlotTracker

class	VPRecipeBase

class	VPWidenMemoryInstructionRecipe

Detailed Description

Definition at line 44 of file VPlanValue.h.

Member Typedef Documentation

◆ const_user_iterator

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

Definition at line 139 of file VPlanValue.h.

◆ const_user_range

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

Definition at line 141 of file VPlanValue.h.

◆ user_iterator

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

Definition at line 138 of file VPlanValue.h.

◆ user_range

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

Definition at line 140 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 89 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 79 of file VPlan.cpp.

References Def.

◆ VPValue() [2/5]

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

inline

Create a live-in VPValue.

Definition at line 96 of file VPlanValue.h.

◆ VPValue() [3/5]

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

inline

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

Definition at line 98 of file VPlanValue.h.

◆ VPValue() [4/5]

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

inline

Create a VPValue for a Def which defines multiple values.

Definition at line 100 of file VPlanValue.h.

◆ VPValue() [5/5]

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

delete

◆ ~VPValue()

VPValue::~VPValue ( )

virtual

Definition at line 85 of file VPlan.cpp.

References assert(), and Def.

Member Function Documentation

◆ addUser()

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

inline

Definition at line 120 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 99 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 116 of file VPlan.cpp.

References Def.

Referenced by llvm::VPlanTransforms::clearReductionWrapFlags(), createScalarIVSteps(), llvm::VPHeaderPHIRecipe::getBackedgeRecipe(), llvm::vputils::getOrCreateVPValueForSCEVExpr(), llvm::VPWidenCanonicalIVRecipe::getScalarType(), hasDefiningRecipe(), llvm::VPWidenIntOrFpInductionRecipe::isCanonical(), llvm::VPCanonicalIVPHIRecipe::isCanonical(), and llvm::vputils::isUniformAfterVectorization().

◆ getDefiningRecipe() [2/2]

const VPRecipeBase * VPValue::getDefiningRecipe ( ) const

Definition at line 120 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 187 of file VPlanValue.h.

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

Referenced by llvm::VPWidenIntOrFpInductionRecipe::execute(), llvm::VPWidenPointerInductionRecipe::execute(), llvm::VPFirstOrderRecurrencePHIRecipe::execute(), llvm::VPReductionPHIRecipe::execute(), llvm::VPCanonicalIVPHIRecipe::execute(), llvm::VPDerivedIVRecipe::execute(), llvm::InnerLoopVectorizer::fixFixedOrderRecurrence(), llvm::InnerLoopVectorizer::fixupIVUsers(), llvm::VPCanonicalIVPHIRecipe::getScalarType(), llvm::VPDerivedIVRecipe::getScalarType(), llvm::VPWidenIntOrFpInductionRecipe::isCanonical(), llvm::VPCanonicalIVPHIRecipe::isCanonical(), and llvm::VPlanTransforms::optimizeForVFAndUF().

◆ getLiveInIRValue() [2/2]

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

inline

Definition at line 192 of file VPlanValue.h.

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

◆ getNumUsers()

unsigned llvm::VPValue::getNumUsers ( ) const

inline

Definition at line 119 of file VPlanValue.h.

References Users.

Referenced by createReplicateRegion(), llvm::InnerLoopVectorizer::fixFixedOrderRecurrence(), and hasMoreThanOneUniqueUser().

◆ getUnderlyingValue() [1/2]

Value * llvm::VPValue::getUnderlyingValue ( )

inline

Return the underlying Value attached to this VPValue.

Definition at line 84 of file VPlanValue.h.

References UnderlyingVal.

Referenced by llvm::VPWidenRecipe::execute(), llvm::VPWidenCastRecipe::execute(), llvm::VPWidenSelectRecipe::execute(), llvm::VPReductionPHIRecipe::execute(), llvm::VPPredInstPHIRecipe::execute(), llvm::InnerLoopVectorizer::fixFixedOrderRecurrence(), llvm::InnerLoopVectorizer::fixReduction(), getLiveInIRValue(), llvm::VPWidenPHIRecipe::print(), and llvm::VPlanTransforms::VPInstructionsToVPRecipes().

◆ getUnderlyingValue() [2/2]

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

inline

Definition at line 85 of file VPlanValue.h.

References UnderlyingVal.

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

◆ hasDefiningRecipe()

bool llvm::VPValue::hasDefiningRecipe ( ) const

inline

Returns true if this VPValue is defined by a recipe.

Definition at line 179 of file VPlanValue.h.

References getDefiningRecipe().

Referenced by isDefinedOutsideVectorRegions(), and isLiveIn().

◆ hasMoreThanOneUniqueUser()

bool llvm::VPValue::hasMoreThanOneUniqueUser ( )

inline

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

Definition at line 153 of file VPlanValue.h.

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

◆ isDefinedOutsideVectorRegions()

bool llvm::VPValue::isDefinedOutsideVectorRegions ( ) const

inline

Returns true if the VPValue is defined outside any vector regions, i.e.

it is a live-in value. TODO: Also handle recipes defined in pre-header blocks.

Definition at line 201 of file VPlanValue.h.

References hasDefiningRecipe().

Referenced by 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 182 of file VPlanValue.h.

References hasDefiningRecipe().

Referenced by llvm::VPlan::addVPValue(), llvm::InnerLoopVectorizer::fixupIVUsers(), and getLiveInIRValue().

◆ operator=()

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

delete

◆ print()

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

Definition at line 92 of file VPlan.cpp.

References Def, OS, and printAsOperand().

Referenced by llvm::VPlanPrinter::dump(), and dump().

◆ printAsOperand()

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

Definition at line 1148 of file VPlan.cpp.

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

◆ removeUser()

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

inline

Remove a single User from the list of users.

Definition at line 123 of file VPlanValue.h.

References llvm::erase_if(), llvm::Other, and Users.

◆ replaceAllUsesWith()

void VPValue::replaceAllUsesWith ( VPValue * New )

Definition at line 1112 of file VPlan.cpp.

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

Referenced by createReplicateRegion(), llvm::LoopVectorizePass::processLoop(), simplifyRecipe(), 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 1127 of file VPlan.cpp.

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

Referenced by mergeReplicateRegionsIntoSuccessors(), and sinkScalarOperands().

◆ setUnderlyingValue()

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

inlineprotected

Definition at line 77 of file VPlanValue.h.

References assert(), and UnderlyingVal.

Referenced by llvm::VPBuilder::createNaryOp(), and llvm::VPInstruction::setUnderlyingInstr().

◆ user_begin() [1/2]

user_iterator llvm::VPValue::user_begin ( )

inline

Definition at line 143 of file VPlanValue.h.

References Users.

Referenced by llvm::VPReplicateRecipe::execute(), llvm::InnerLoopVectorizer::fixFixedOrderRecurrence(), hasMoreThanOneUniqueUser(), and users().

◆ user_begin() [2/2]

const_user_iterator llvm::VPValue::user_begin ( ) const

inline

Definition at line 144 of file VPlanValue.h.

References Users.

◆ user_end() [1/2]

user_iterator llvm::VPValue::user_end ( )

inline

Definition at line 145 of file VPlanValue.h.

References Users.

Referenced by llvm::VPReplicateRecipe::execute(), hasMoreThanOneUniqueUser(), and users().

◆ user_end() [2/2]

const_user_iterator llvm::VPValue::user_end ( ) const

inline

Definition at line 146 of file VPlanValue.h.

References Users.

◆ users() [1/2]

user_range llvm::VPValue::users ( )

inline

Definition at line 147 of file VPlanValue.h.

References user_begin(), and user_end().

Referenced by llvm::VPlanTransforms::addActiveLaneMask(), llvm::VPlanTransforms::clearReductionWrapFlags(), llvm::InnerLoopVectorizer::fixReduction(), llvm::VPBlendRecipe::onlyFirstLaneUsed(), llvm::VPReplicateRecipe::shouldPack(), sinkRecurrenceUsersAfterPrevious(), and sinkScalarOperands().

◆ users() [2/2]

const_user_range llvm::VPValue::users ( ) const

inline

Definition at line 148 of file VPlanValue.h.

References user_begin(), and user_end().

Friends And Related Function Documentation

◆ VPBasicBlock

friend class VPBasicBlock

friend

Definition at line 49 of file VPlanValue.h.

◆ VPBuilder

friend class VPBuilder

friend

Definition at line 45 of file VPlanValue.h.

◆ VPDef

friend class VPDef

friend

Definition at line 46 of file VPlanValue.h.

◆ VPInstruction

friend class VPInstruction

friend

Definition at line 47 of file VPlanValue.h.

◆ VPInterleavedAccessInfo

friend class VPInterleavedAccessInfo

friend

Definition at line 50 of file VPlanValue.h.

◆ VPlanTransforms

friend struct VPlanTransforms

friend

Definition at line 48 of file VPlanValue.h.

◆ VPRecipeBase

friend class VPRecipeBase

friend

Definition at line 52 of file VPlanValue.h.

◆ VPSlotTracker

friend class VPSlotTracker

friend

Definition at line 51 of file VPlanValue.h.

◆ VPWidenMemoryInstructionRecipe

friend class VPWidenMemoryInstructionRecipe

friend

Definition at line 53 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 65 of file VPlanValue.h.

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

◆ UnderlyingVal

Value* llvm::VPValue::UnderlyingVal

protected

Definition at line 61 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() [1/2]

◆ getUnderlyingValue() [2/2]

◆ getVPValueID()

◆ hasDefiningRecipe()

◆ hasMoreThanOneUniqueUser()

◆ isDefinedOutsideVectorRegions()

◆ 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

◆ VPInstruction

◆ VPInterleavedAccessInfo

◆ VPlanTransforms

◆ VPRecipeBase

◆ VPSlotTracker

◆ VPWidenMemoryInstructionRecipe

Member Data Documentation

◆ Def

◆ UnderlyingVal