llvm::VPPhi Struct Reference

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPPhi:

Public Member Functions
	VPPhi (ArrayRef< VPValue * > Operands, DebugLoc DL, const Twine &Name="")
VPPhi *	clone () override
	Clone the current recipe.
void	execute (VPTransformState &State) override
	Generate the instruction.
void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the recipe.
Public Member Functions inherited from llvm::VPInstruction
	VPInstruction (unsigned Opcode, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
	VPInstruction (unsigned Opcode, ArrayRef< VPValue * > Operands, const VPIRFlags &Flags, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	clone () override
	Clone the current recipe.
unsigned	getOpcode () const
void	execute (VPTransformState &State) override
	Generate the instruction.
InstructionCost	computeCost (ElementCount VF, VPCostContext &Ctx) const override
	Return the cost of this VPInstruction.
void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the VPInstruction to O.
LLVM_DUMP_METHOD void	dump () const
	Print the VPInstruction to dbgs() (for debugging).
bool	hasResult () const
bool	opcodeMayReadOrWriteFromMemory () const
	Returns true if the underlying opcode may read from or write to memory.
bool	onlyFirstLaneUsed (const VPValue *Op) const override
	Returns true if the recipe only uses the first lane of operand Op.
bool	onlyFirstPartUsed (const VPValue *Op) const override
	Returns true if the recipe only uses the first part of operand Op.
bool	isVectorToScalar () const
	Returns true if this VPInstruction produces a scalar value from a vector, e.g.
bool	isSingleScalar () const
	Returns true if this VPInstruction's operands are single scalars and the result is also a single scalar.
StringRef	getName () const
	Returns the symbolic name assigned to the VPInstruction.
Public Member Functions inherited from llvm::VPRecipeWithIRFlags
	VPRecipeWithIRFlags (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
	VPRecipeWithIRFlags (const unsigned char SC, ArrayRef< VPValue * > Operands, Instruction &I)
	VPRecipeWithIRFlags (const unsigned char SC, ArrayRef< VPValue * > Operands, const VPIRFlags &Flags, DebugLoc DL=DebugLoc::getUnknown())
void	execute (VPTransformState &State) override=0
	The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.
std::optional< InstructionCost >	getCostForRecipeWithOpcode (unsigned Opcode, ElementCount VF, VPCostContext &Ctx) const
	Compute the cost for this recipe for VF, using Opcode and Ctx.
Public Member Functions inherited from llvm::VPSingleDefRecipe
	VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
	VPSingleDefRecipe (const unsigned char SC, ArrayRef< VPValue * > Operands, Value *UV, DebugLoc DL=DebugLoc::getUnknown())
virtual VPSingleDefRecipe *	clone () override=0
	Clone the current recipe.
Instruction *	getUnderlyingInstr ()
	Returns the underlying instruction.
const Instruction *	getUnderlyingInstr () const
LLVM_DUMP_METHOD void	dump () const
	Print this VPSingleDefRecipe to dbgs() (for debugging).
Public Member Functions inherited from llvm::VPRecipeBase
	VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL=DebugLoc::getUnknown())
virtual	~VPRecipeBase ()=default
virtual VPRecipeBase *	clone ()=0
	Clone the current recipe.
VPBasicBlock *	getParent ()
const VPBasicBlock *	getParent () const
virtual void	execute (VPTransformState &State)=0
	The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.
InstructionCost	cost (ElementCount VF, VPCostContext &Ctx)
	Return the cost of this recipe, taking into account if the cost computation should be skipped and the ForceTargetInstructionCost flag.
void	insertBefore (VPRecipeBase *InsertPos)
	Insert an unlinked recipe into a basic block immediately before the specified recipe.
void	insertBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator IP)
	Insert an unlinked recipe into BB immediately before the insertion point IP;.
void	insertAfter (VPRecipeBase *InsertPos)
	Insert an unlinked Recipe into a basic block immediately after the specified Recipe.
void	moveAfter (VPRecipeBase *MovePos)
	Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos.
void	moveBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator I)
	Unlink this recipe and insert into BB before I.
void	removeFromParent ()
	This method unlinks 'this' from the containing basic block, but does not delete it.
iplist< VPRecipeBase >::iterator	eraseFromParent ()
	This method unlinks 'this' from the containing basic block and deletes it.
bool	mayHaveSideEffects () const
	Returns true if the recipe may have side-effects.
bool	isPhi () const
	Returns true for PHI-like recipes.
bool	mayReadFromMemory () const
	Returns true if the recipe may read from memory.
bool	mayWriteToMemory () const
	Returns true if the recipe may write to memory.
bool	mayReadOrWriteMemory () const
	Returns true if the recipe may read from or write to memory.
DebugLoc	getDebugLoc () const
	Returns the debug location of the recipe.
bool	isScalarCast () const
	Return true if the recipe is a scalar cast.
void	setDebugLoc (DebugLoc NewDL)
	Set the recipe's debug location to NewDL.
Public Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
VPRecipeBase *	getPrevNode ()
const VPRecipeBase *	getPrevNode () const
	Get the previous node, or nullptr for the list head.
VPRecipeBase *	getNextNode ()
	Get the next node, or nullptr for the list tail.
const VPRecipeBase *	getNextNode () const
	Get the next node, or nullptr for the list tail.
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
self_iterator	getIterator ()
const_self_iterator	getIterator () const
reverse_self_iterator	getReverseIterator ()
const_reverse_self_iterator	getReverseIterator () const
std::enable_if_t< T::is_sentinel_tracking_explicit, bool >	isSentinel () const
	Check whether this is the sentinel node.
Public Member Functions inherited from llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >
const ParentTy *	getParent () const
ParentTy *	getParent ()
void	setParent (ParentTy *Parent)
Public Member Functions inherited from llvm::VPDef
	VPDef (const unsigned char SC)
virtual	~VPDef ()
VPValue *	getVPSingleValue ()
	Returns the only VPValue defined by the VPDef.
const VPValue *	getVPSingleValue () const
VPValue *	getVPValue (unsigned I)
	Returns the VPValue with index I defined by the VPDef.
const VPValue *	getVPValue (unsigned I) const
ArrayRef< VPValue * >	definedValues ()
	Returns an ArrayRef of the values defined by the VPDef.
ArrayRef< VPValue * >	definedValues () const
	Returns an ArrayRef of the values defined by the VPDef.
unsigned	getNumDefinedValues () const
	Returns the number of values defined by the VPDef.
unsigned	getVPDefID () const
void	dump () const
	Dump the VPDef to stderr (for debugging).
virtual void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
	Each concrete VPDef prints itself.
Public Member Functions inherited from llvm::VPUser
	VPUser ()=delete
	VPUser (const VPUser &)=delete
VPUser &	operator= (const VPUser &)=delete
virtual	~VPUser ()
void	addOperand (VPValue *Operand)
unsigned	getNumOperands () const
VPValue *	getOperand (unsigned N) const
void	setOperand (unsigned I, VPValue *New)
void	swapOperands ()
	Swap operands of the VPUser. It must have exactly 2 operands.
void	replaceUsesOfWith (VPValue *From, VPValue *To)
	Replaces all uses of From in the VPUser with To.
operand_iterator	op_begin ()
const_operand_iterator	op_begin () const
operand_iterator	op_end ()
const_operand_iterator	op_end () const
operand_range	operands ()
const_operand_range	operands () const
virtual bool	usesScalars (const VPValue *Op) const
	Returns true if the VPUser uses scalars of operand Op.
virtual bool	onlyFirstLaneUsed (const VPValue *Op) const
	Returns true if the VPUser only uses the first lane of operand Op.
virtual bool	onlyFirstPartUsed (const VPValue *Op) const
	Returns true if the VPUser only uses the first part of operand Op.
Public Member Functions inherited from llvm::VPValue
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 () const
	Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.
bool	isDefinedOutsideLoopRegions () const
	Returns true if the VPValue is defined outside any loop.
void	setUnderlyingValue (Value *Val)
Public Member Functions inherited from llvm::VPIRFlags
	VPIRFlags ()
	VPIRFlags (Instruction &I)
	VPIRFlags (CmpInst::Predicate Pred)
	VPIRFlags (WrapFlagsTy WrapFlags)
	VPIRFlags (FastMathFlags FMFs)
	VPIRFlags (DisjointFlagsTy DisjointFlags)
	VPIRFlags (NonNegFlagsTy NonNegFlags)
	VPIRFlags (GEPNoWrapFlags GEPFlags)
void	transferFlags (VPIRFlags &Other)
void	dropPoisonGeneratingFlags ()
	Drop all poison-generating flags.
void	applyFlags (Instruction &I) const
	Apply the IR flags to I.
CmpInst::Predicate	getPredicate () const
void	setPredicate (CmpInst::Predicate Pred)
GEPNoWrapFlags	getGEPNoWrapFlags () const
bool	hasPredicate () const
	Returns true if the recipe has a comparison predicate.
bool	hasFastMathFlags () const
	Returns true if the recipe has fast-math flags.
LLVM_ABI_FOR_TEST FastMathFlags	getFastMathFlags () const
bool	hasNonNegFlag () const
	Returns true if the recipe has non-negative flag.
bool	isNonNeg () const
bool	hasNoUnsignedWrap () const
bool	hasNoSignedWrap () const
bool	isDisjoint () const
bool	flagsValidForOpcode (unsigned Opcode) const
	Returns true if the set flags are valid for Opcode.
void	printFlags (raw_ostream &O) const
Public Member Functions inherited from llvm::VPIRMetadata
	VPIRMetadata ()
	VPIRMetadata (Instruction &I)
	Adds metatadata that can be preserved from the original instruction I.
	VPIRMetadata (Instruction &I, LoopVersioning *LVer)
	Adds metatadata that can be preserved from the original instruction I and noalias metadata guaranteed by runtime checks using LVer.
	VPIRMetadata (const VPIRMetadata &Other)
	Copy constructor for cloning.
VPIRMetadata &	operator= (const VPIRMetadata &Other)
void	applyMetadata (Instruction &I) const
	Add all metadata to I.
void	addMetadata (unsigned Kind, MDNode *Node)
	Add metadata with kind Kind and Node.
void	intersect (const VPIRMetadata &MD)
	Intersect this VPIRMetada object with MD, keeping only metadata nodes that are common to both.
Public Member Functions inherited from llvm::VPPhiAccessors
virtual	~VPPhiAccessors ()=default
VPValue *	getIncomingValue (unsigned Idx) const
	Returns the incoming VPValue with index Idx.
const VPBasicBlock *	getIncomingBlock (unsigned Idx) const
	Returns the incoming block with index Idx.
virtual unsigned	getNumIncoming () const
	Returns the number of incoming values, also number of incoming blocks.
VPUser::const_operand_range	incoming_values () const
	Returns an interator range over the incoming values.
const_incoming_blocks_range	incoming_blocks () const
	Returns an iterator range over the incoming blocks.
detail::zippy< llvm::detail::zip_first, VPUser::const_operand_range, const_incoming_blocks_range >	incoming_values_and_blocks () const
	Returns an iterator range over pairs of incoming values and corresponding incoming blocks.
void	removeIncomingValueFor (VPBlockBase *IncomingBlock) const
	Removes the incoming value for IncomingBlock, which must be a predecessor.
void	printPhiOperands (raw_ostream &O, VPSlotTracker &SlotTracker) const
	Print the recipe.

Static Public Member Functions
static bool	classof (const VPUser *U)
static bool	classof (const VPValue *V)
static bool	classof (const VPSingleDefRecipe *SDR)
Static Public Member Functions inherited from llvm::VPRecipeWithIRFlags
static bool	classof (const VPRecipeBase *R)
static bool	classof (const VPUser *U)
static bool	classof (const VPValue *V)
Static Public Member Functions inherited from llvm::VPSingleDefRecipe
static bool	classof (const VPRecipeBase *R)
static bool	classof (const VPUser *U)
Static Public Member Functions inherited from llvm::VPRecipeBase
static bool	classof (const VPDef *D)
	Method to support type inquiry through isa, cast, and dyn_cast.
static bool	classof (const VPUser *U)

Protected Member Functions
const VPRecipeBase *	getAsRecipe () const override
	Return a VPRecipeBase* to the current object.
virtual InstructionCost	computeCost (ElementCount VF, VPCostContext &Ctx) const
	Compute the cost of this recipe either using a recipe's specialized implementation or using the legacy cost model and the underlying instructions.
Protected Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
	ilist_node_with_parent ()=default
Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
	ilist_node_impl ()=default
Protected Member Functions inherited from llvm::VPUser
void	printOperands (raw_ostream &O, VPSlotTracker &SlotTracker) const
	Print the operands to O.
	VPUser (ArrayRef< VPValue * > Operands)
Protected Member Functions inherited from llvm::VPValue
	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 Member Functions inherited from llvm::VPUnrollPartAccessor< 1 >
VPValue *	getUnrollPartOperand (const VPUser &U) const
	Return the VPValue operand containing the unroll part or null if there is no such operand.
unsigned	getUnrollPart (const VPUser &U) const
	Return the unroll part.
virtual const VPRecipeBase *	getAsRecipe () const =0
	Return a VPRecipeBase* to the current object.

Additional Inherited Members
Public Types inherited from llvm::VPInstruction
enum	{   FirstOrderRecurrenceSplice , Not , SLPLoad , SLPStore ,   ActiveLaneMask , ExplicitVectorLength , CalculateTripCountMinusVF , CanonicalIVIncrementForPart ,   BranchOnCount , BranchOnCond , Broadcast , BuildStructVector ,   BuildVector , ComputeAnyOfResult , ComputeFindIVResult , ComputeReductionResult ,   ExtractLastElement , ExtractPenultimateElement , LogicalAnd , PtrAdd ,   WidePtrAdd , AnyOf , FirstActiveLane , WideIVStep ,   ReductionStartVector , StepVector , ExtractLane , ResumeForEpilogue ,   VScale }
	VPlan opcodes, extending LLVM IR with idiomatics instructions. More...
Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPExpressionSC, VPIRInstructionSC, VPInstructionSC, VPInterleaveSC, VPReductionEVLSC, VPReductionSC, VPPartialReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPVectorPointerSC, VPVectorEndPointerSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenIntrinsicSC, VPWidenLoadEVLSC, VPWidenLoadSC, VPWidenStoreEVLSC, VPWidenStoreSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPHistogramSC, VPWidenPHISC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPEVLBasedIVPHISC, VPFirstOrderRecurrencePHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPWidenPHISC, VPFirstHeaderPHISC=VPCanonicalIVPHISC, VPLastHeaderPHISC=VPReductionPHISC, VPLastPHISC=VPReductionPHISC, }
	An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.
Public Types inherited from llvm::VPUser
typedef SmallVectorImpl< VPValue * >::iterator	operand_iterator
typedef SmallVectorImpl< VPValue * >::const_iterator	const_operand_iterator
typedef iterator_range< operand_iterator >	operand_range
typedef iterator_range< const_operand_iterator >	const_operand_range
Public Types inherited from llvm::VPValue
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 Types inherited from llvm::VPPhiAccessors
using	const_incoming_blocks_range = iterator_range< mapped_iterator< detail::index_iterator, std::function< const VPBasicBlock *(size_t)> > >
Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using	self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, false >::type
using	const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, false, true >::type
using	reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, false >::type
using	const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, ilist_detail::compute_node_options< T, Options... >::type, true, true >::type
Protected Attributes inherited from llvm::VPValue
Value *	UnderlyingVal
VPDef *	Def
	Pointer to the VPDef that defines this VPValue.

Detailed Description

Definition at line 1289 of file VPlan.h.

Constructor & Destructor Documentation

VPPhi()

llvm::VPPhi::VPPhi ( ArrayRef< VPValue * >  Operands, DebugLoc  DL, const Twine &  Name = ""  )

inline

Definition at line 1290 of file VPlan.h.

Member Function Documentation

classof() [1/3]

static bool llvm::VPPhi::classof ( const VPSingleDefRecipe *  SDR )

inlinestatic

Definition at line 1303 of file VPlan.h.

classof() [2/3]

static bool llvm::VPPhi::classof ( const VPUser *  U )

inlinestatic

Definition at line 1293 of file VPlan.h.

classof() [3/3]

static bool llvm::VPPhi::classof ( const VPValue *  V )

inlinestatic

Definition at line 1298 of file VPlan.h.

clone()

VPPhi * llvm::VPPhi::clone ( )

inlineoverridevirtual

Clone the current recipe.

Reimplemented from llvm::VPInstruction.

Definition at line 1308 of file VPlan.h.

References getDebugLoc(), and getName().

execute()

void VPPhi::execute ( VPTransformState &  State )

overridevirtual

Generate the instruction.

TODO: We currently execute only per-part unless a specific instance is provided.

Reimplemented from llvm::VPInstruction.

Definition at line 1442 of file VPlanRecipes.cpp.

References llvm::PHINode::addIncoming(), llvm::VPTransformState::Builder, llvm::VPTransformState::CFG, llvm::IRBuilderBase::CreatePHI(), llvm::VPTransformState::get(), llvm::VPRecipeBase::getDebugLoc(), llvm::VPPhiAccessors::getIncomingBlock(), llvm::VPPhiAccessors::getIncomingValue(), llvm::VPInstruction::getName(), llvm::VPPhiAccessors::getNumIncoming(), llvm::VPRecipeBase::getParent(), Idx, llvm::VPTypeAnalysis::inferScalarType(), llvm::VPTransformState::set(), llvm::VPTransformState::setDebugLocFrom(), llvm::VPTransformState::TypeAnalysis, and llvm::VPTransformState::CFGState::VPBB2IRBB.

getAsRecipe()

const VPRecipeBase * llvm::VPPhi::getAsRecipe ( ) const

inlineoverrideprotectedvirtual

Return a VPRecipeBase* to the current object.

Implements llvm::VPPhiAccessors.

Definition at line 1323 of file VPlan.h.

print()

void VPPhi::print ( raw_ostream &  O, const Twine &  Indent, VPSlotTracker &  SlotTracker  ) const

overridevirtual

Print the recipe.

Reimplemented from llvm::VPInstruction.

Definition at line 1461 of file VPlanRecipes.cpp.

References llvm::VPInstruction::isSingleScalar(), llvm::VPValue::printAsOperand(), and llvm::VPPhiAccessors::printPhiOperands().

---

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

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