LLVM 17.0.0git
Public Types | Public Member Functions | Protected Member Functions | List of all members
llvm::VPUser Class Reference

This class augments VPValue with operands which provide the inverse def-use edges from VPValue's users to their defs. More...

#include "Transforms/Vectorize/VPlanValue.h"

Inheritance diagram for llvm::VPUser:
Inheritance graph
[legend]

Public Types

enum class  VPUserID { Recipe , LiveOut }
 Subclass identifier (for isa/dyn_cast). More...
 
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 Member Functions

 VPUser ()=delete
 
 VPUser (const VPUser &)=delete
 
VPUser & operator= (const VPUser &)=delete
 
virtual ~VPUser ()
 
VPUserID getVPUserID () const
 
void addOperand (VPValue *Operand)
 
unsigned getNumOperands () const
 
VPValue * getOperand (unsigned N) const
 
void setOperand (unsigned I, VPValue *New)
 
void removeLastOperand ()
 
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.
 

Protected Member Functions

void printOperands (raw_ostream &O, VPSlotTracker &SlotTracker) const
 Print the operands to O.
 
 VPUser (ArrayRef< VPValue * > Operands, VPUserID ID)
 
 VPUser (std::initializer_list< VPValue * > Operands, VPUserID ID)
 
template<typename IterT >
 VPUser (iterator_range< IterT > Operands, VPUserID ID)
 

Detailed Description

This class augments VPValue with operands which provide the inverse def-use edges from VPValue's users to their defs.

Definition at line 204 of file VPlanValue.h.

Member Typedef Documentation

◆ const_operand_iterator

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

Definition at line 271 of file VPlanValue.h.

◆ const_operand_range

typedef iterator_range<const_operand_iterator> llvm::VPUser::const_operand_range

Definition at line 273 of file VPlanValue.h.

◆ operand_iterator

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

Definition at line 270 of file VPlanValue.h.

◆ operand_range

typedef iterator_range<operand_iterator> llvm::VPUser::operand_range

Definition at line 272 of file VPlanValue.h.

Member Enumeration Documentation

◆ VPUserID

enum class llvm::VPUser::VPUserID
strong

Subclass identifier (for isa/dyn_cast).

Enumerator
Recipe 
LiveOut 

Definition at line 207 of file VPlanValue.h.

Constructor & Destructor Documentation

◆ VPUser() [1/5]

llvm::VPUser::VPUser ( ArrayRef< VPValue * >  Operands,
VPUserID  ID 
)
inlineprotected

Definition at line 223 of file VPlanValue.h.

References addOperand(), and Operands.

◆ VPUser() [2/5]

llvm::VPUser::VPUser ( std::initializer_list< VPValue * >  Operands,
VPUserID  ID 
)
inlineprotected

Definition at line 228 of file VPlanValue.h.

References Operands.

◆ VPUser() [3/5]

template<typename IterT >
llvm::VPUser::VPUser ( iterator_range< IterT >  Operands,
VPUserID  ID 
)
inlineprotected

Definition at line 232 of file VPlanValue.h.

References addOperand(), and Operands.

◆ VPUser() [4/5]

llvm::VPUser::VPUser ( )
delete

◆ VPUser() [5/5]

llvm::VPUser::VPUser ( const VPUser &  )
delete

◆ ~VPUser()

virtual llvm::VPUser::~VPUser ( )
inlinevirtual

Definition at line 241 of file VPlanValue.h.

References operands().

Member Function Documentation

◆ addOperand()

void llvm::VPUser::addOperand ( VPValue *  Operand)
inline

Definition at line 248 of file VPlanValue.h.

References llvm::VPValue::addUser(), and Operands.

Referenced by addCanonicalIVRecipes(), llvm::VPWidenPHIRecipe::addIncoming(), llvm::VPReplicateRecipe::VPReplicateRecipe(), VPUser(), llvm::VPWidenIntOrFpInductionRecipe::VPWidenIntOrFpInductionRecipe(), llvm::VPWidenPHIRecipe::VPWidenPHIRecipe(), and llvm::VPWidenPointerInductionRecipe::VPWidenPointerInductionRecipe().

◆ getNumOperands()

unsigned llvm::VPUser::getNumOperands ( ) const
inline

Definition at line 253 of file VPlanValue.h.

References Operands.

Referenced by llvm::VPWidenGEPRecipe::execute(), llvm::VPWidenPHIRecipe::execute(), llvm::InnerLoopVectorizer::fixNonInductionPHIs(), llvm::VPReductionRecipe::getCondOp(), llvm::VPReplicateRecipe::getMask(), llvm::VPInterleaveRecipe::getMask(), llvm::VPBranchOnMaskRecipe::getMask(), llvm::VPWidenMemoryInstructionRecipe::getMask(), llvm::VPBlendRecipe::getNumIncomingValues(), llvm::VPInterleaveRecipe::getNumStoreOperands(), llvm::VPHeaderPHIRecipe::getStartValue(), llvm::VPInterleaveRecipe::getStoredValues(), llvm::VPWidenGEPRecipe::print(), llvm::VPWidenPHIRecipe::print(), and llvm::VPReplicateRecipe::print().

◆ getOperand()

VPValue * llvm::VPUser::getOperand ( unsigned  N) const
inline

Definition at line 254 of file VPlanValue.h.

References assert(), N, and Operands.

Referenced by canSimplifyBranchOnCond(), llvm::VPWidenRecipe::execute(), llvm::VPWidenCastRecipe::execute(), llvm::VPWidenSelectRecipe::execute(), llvm::VPWidenGEPRecipe::execute(), llvm::VPWidenPointerInductionRecipe::execute(), llvm::VPWidenPHIRecipe::execute(), llvm::VPReplicateRecipe::execute(), llvm::VPPredInstPHIRecipe::execute(), llvm::VPActiveLaneMaskPHIRecipe::execute(), llvm::VPWidenCanonicalIVRecipe::execute(), llvm::VPScalarIVStepsRecipe::execute(), llvm::VPLiveOut::fixPhi(), llvm::VPInterleaveRecipe::getAddr(), llvm::VPWidenMemoryInstructionRecipe::getAddr(), llvm::VPHeaderPHIRecipe::getBackedgeValue(), llvm::VPDerivedIVRecipe::getCanonicalIV(), llvm::VPReductionRecipe::getChainOp(), llvm::VPWidenSelectRecipe::getCond(), llvm::VPReductionRecipe::getCondOp(), llvm::VPWidenPHIRecipe::getIncomingValue(), llvm::VPBlendRecipe::getIncomingValue(), llvm::VPReplicateRecipe::getMask(), llvm::VPInterleaveRecipe::getMask(), llvm::VPBranchOnMaskRecipe::getMask(), llvm::VPWidenMemoryInstructionRecipe::getMask(), llvm::VPBlendRecipe::getMask(), llvm::VPCanonicalIVPHIRecipe::getScalarType(), llvm::VPWidenCanonicalIVRecipe::getScalarType(), llvm::VPHeaderPHIRecipe::getStartValue(), llvm::VPDerivedIVRecipe::getStartValue(), llvm::VPWidenIntOrFpInductionRecipe::getStepValue(), llvm::VPDerivedIVRecipe::getStepValue(), llvm::VPScalarIVStepsRecipe::getStepValue(), llvm::VPWidenMemoryInstructionRecipe::getStoredValue(), llvm::VPReductionRecipe::getVecOp(), llvm::VPInstruction::onlyFirstLaneUsed(), llvm::VPWidenSelectRecipe::print(), llvm::VPInterleaveRecipe::print(), and llvm::VPLiveOut::print().

◆ getVPUserID()

VPUserID llvm::VPUser::getVPUserID ( ) const
inline

Definition at line 246 of file VPlanValue.h.

◆ onlyFirstLaneUsed()

virtual bool llvm::VPUser::onlyFirstLaneUsed ( const VPValue *  Op) const
inlinevirtual

Returns true if the VPUser only uses the first lane of operand Op.

Conservatively returns false.

Reimplemented in llvm::VPInstruction, llvm::VPBlendRecipe, llvm::VPInterleaveRecipe, llvm::VPReplicateRecipe, llvm::VPWidenMemoryInstructionRecipe, llvm::VPCanonicalIVPHIRecipe, llvm::VPDerivedIVRecipe, and llvm::VPScalarIVStepsRecipe.

Definition at line 294 of file VPlanValue.h.

References assert(), llvm::is_contained(), and operands().

Referenced by usesScalars().

◆ op_begin() [1/2]

operand_iterator llvm::VPUser::op_begin ( )
inline

Definition at line 275 of file VPlanValue.h.

References Operands.

Referenced by createReplicateRegion(), llvm::VPInterleaveRecipe::getStoredValues(), operands(), and llvm::VPReplicateRecipe::print().

◆ op_begin() [2/2]

const_operand_iterator llvm::VPUser::op_begin ( ) const
inline

Definition at line 276 of file VPlanValue.h.

References Operands.

◆ op_end() [1/2]

operand_iterator llvm::VPUser::op_end ( )
inline

Definition at line 277 of file VPlanValue.h.

References Operands.

Referenced by createReplicateRegion(), and operands().

◆ op_end() [2/2]

const_operand_iterator llvm::VPUser::op_end ( ) const
inline

Definition at line 278 of file VPlanValue.h.

References Operands.

◆ operands() [1/2]

operand_range llvm::VPUser::operands ( )
inline

Definition at line 279 of file VPlanValue.h.

References op_begin(), and op_end().

Referenced by llvm::VPInstruction::clone(), llvm::VPWidenRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPReplicateRecipe::execute(), onlyFirstLaneUsed(), llvm::VPInstruction::onlyFirstLaneUsed(), llvm::VPBlendRecipe::onlyFirstLaneUsed(), llvm::VPInterleaveRecipe::onlyFirstLaneUsed(), llvm::VPReplicateRecipe::onlyFirstLaneUsed(), llvm::VPWidenMemoryInstructionRecipe::onlyFirstLaneUsed(), llvm::VPCanonicalIVPHIRecipe::onlyFirstLaneUsed(), llvm::VPDerivedIVRecipe::onlyFirstLaneUsed(), llvm::VPScalarIVStepsRecipe::onlyFirstLaneUsed(), llvm::VPInstruction::print(), llvm::InnerLoopVectorizer::scalarizeInstruction(), sinkScalarOperands(), usesScalars(), llvm::VPLiveOut::usesScalars(), llvm::VPReplicateRecipe::usesScalars(), llvm::VPBranchOnMaskRecipe::usesScalars(), llvm::VPPredInstPHIRecipe::usesScalars(), and ~VPUser().

◆ operands() [2/2]

const_operand_range llvm::VPUser::operands ( ) const
inline

Definition at line 280 of file VPlanValue.h.

References op_begin(), and op_end().

◆ operator=()

VPUser & llvm::VPUser::operator= ( const VPUser &  )
delete

◆ printOperands()

void VPUser::printOperands ( raw_ostream &  O,
VPSlotTracker &  SlotTracker 
) const
protected

Print the operands to O.

Definition at line 1053 of file VPlan.cpp.

References llvm::interleaveComma().

Referenced by llvm::VPWidenRecipe::print(), llvm::VPWidenCastRecipe::print(), llvm::VPWidenCallRecipe::print(), llvm::VPWidenGEPRecipe::print(), llvm::VPWidenPHIRecipe::print(), llvm::VPFirstOrderRecurrencePHIRecipe::print(), llvm::VPReductionPHIRecipe::print(), llvm::VPReplicateRecipe::print(), llvm::VPPredInstPHIRecipe::print(), llvm::VPWidenMemoryInstructionRecipe::print(), llvm::VPActiveLaneMaskPHIRecipe::print(), llvm::VPWidenCanonicalIVRecipe::print(), and llvm::VPScalarIVStepsRecipe::print().

◆ removeLastOperand()

void llvm::VPUser::removeLastOperand ( )
inline

Definition at line 265 of file VPlanValue.h.

References Operands.

◆ setOperand()

void llvm::VPUser::setOperand ( unsigned  I,
VPValue *  New 
)
inline

Definition at line 259 of file VPlanValue.h.

References I, and Operands.

Referenced by createReplicateRegion(), and llvm::VPHeaderPHIRecipe::setStartValue().

◆ usesScalars()

virtual bool llvm::VPUser::usesScalars ( const VPValue *  Op) const
inlinevirtual

Returns true if the VPUser uses scalars of operand Op.

Conservatively returns if only first (scalar) lane is used, as default.

Reimplemented in llvm::VPLiveOut, llvm::VPReplicateRecipe, llvm::VPBranchOnMaskRecipe, and llvm::VPPredInstPHIRecipe.

Definition at line 286 of file VPlanValue.h.

References assert(), llvm::is_contained(), onlyFirstLaneUsed(), and operands().

The documentation for this class was generated from the following files:
Generated on Sun May 28 2023 18:43:35 for LLVM by doxygen 1.9.6