LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::VPWidenPHIRecipe Class Reference

A recipe for handling first order recurrences and pointer inductions. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPWidenPHIRecipe:
Inheritance graph
[legend]
Collaboration diagram for llvm::VPWidenPHIRecipe:
Collaboration graph
[legend]

Public Member Functions

 VPWidenPHIRecipe (PHINode *Phi)
 Create a VPWidenPHIRecipe for Phi. More...
 
 VPWidenPHIRecipe (PHINode *Phi, VPValue &Start)
 Create a new VPWidenPHIRecipe for Phi with start value Start. More...
 
 ~VPWidenPHIRecipe () override=default
 
void execute (VPTransformState &State) override
 Generate the phi/select nodes. More...
 
void print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
 Print the recipe. More...
 
VPValuegetStartValue ()
 Returns the start value of the phi, if it is a reduction or first-order recurrence. More...
 
VPValuegetBackedgeValue ()
 Returns the incoming value from the loop backedge, if it is a reduction or first-order recurrence. More...
 
VPRecipeBasegetBackedgeRecipe ()
 Returns the backedge value as a recipe. More...
 
void addIncoming (VPValue *IncomingV, VPBasicBlock *IncomingBlock)
 Adds a pair (IncomingV, IncomingBlock) to the phi. More...
 
VPValuegetIncomingValue (unsigned I)
 Returns the I th incoming VPValue. More...
 
VPBasicBlockgetIncomingBlock (unsigned I)
 Returns the I th incoming VPBasicBlock. More...
 
- Public Member Functions inherited from llvm::VPRecipeBase
 VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands)
 
template<typename IterT >
 VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands)
 
virtual ~VPRecipeBase ()=default
 
VPBasicBlockgetParent ()
 
const VPBasicBlockgetParent () const
 
void insertBefore (VPRecipeBase *InsertPos)
 Insert an unlinked recipe into a basic block immediately before the specified recipe. More...
 
void insertAfter (VPRecipeBase *InsertPos)
 Insert an unlinked Recipe into a basic block immediately after the specified Recipe. More...
 
void moveAfter (VPRecipeBase *MovePos)
 Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos. More...
 
void moveBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator I)
 Unlink this recipe and insert into BB before I. More...
 
void removeFromParent ()
 This method unlinks 'this' from the containing basic block, but does not delete it. More...
 
iplist< VPRecipeBase >::iterator eraseFromParent ()
 This method unlinks 'this' from the containing basic block and deletes it. More...
 
InstructiongetUnderlyingInstr ()
 Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise. More...
 
const InstructiongetUnderlyingInstr () const
 
bool mayHaveSideEffects () const
 Returns true if the recipe may have side-effects. More...
 
bool isPhi () const
 Returns true for PHI-like recipes. More...
 
bool mayReadFromMemory () const
 Returns true if the recipe may read from memory. More...
 
bool mayWriteToMemory () const
 Returns true if the recipe may write to memory. More...
 
bool mayReadOrWriteMemory () const
 Returns true if the recipe may read from or write to memory. More...
 
- Public Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
VPRecipeBasegetPrevNode ()
 
const VPRecipeBasegetPrevNode () const
 Get the previous node, or nullptr for the list head. More...
 
VPRecipeBasegetNextNode ()
 Get the next node, or nullptr for the list tail. More...
 
const VPRecipeBasegetNextNode () const
 Get the next node, or nullptr for the list tail. More...
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node. More...
 
- Public Member Functions inherited from llvm::VPDef
 VPDef (const unsigned char SC)
 
virtual ~VPDef ()
 
VPValuegetVPSingleValue ()
 Returns the only VPValue defined by the VPDef. More...
 
const VPValuegetVPSingleValue () const
 
VPValuegetVPValue (unsigned I)
 Returns the VPValue with index I defined by the VPDef. More...
 
const VPValuegetVPValue (unsigned I) const
 
ArrayRef< VPValue * > definedValues ()
 Returns an ArrayRef of the values defined by the VPDef. More...
 
ArrayRef< VPValue * > definedValues () const
 Returns an ArrayRef of the values defined by the VPDef. More...
 
unsigned getNumDefinedValues () const
 Returns the number of values defined by the VPDef. More...
 
unsigned getVPDefID () const
 
void dump () const
 Dump the VPDef to stderr (for debugging). More...
 
- Public Member Functions inherited from llvm::VPUser
 VPUser ()=delete
 
 VPUser (const VPUser &)=delete
 
VPUseroperator= (const VPUser &)=delete
 
virtual ~VPUser ()
 
VPUserID getVPUserID () const
 
void addOperand (VPValue *Operand)
 
unsigned getNumOperands () const
 
VPValuegetOperand (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
 
- Public Member Functions inherited from llvm::VPValue
ValuegetUnderlyingValue ()
 Return the underlying Value attached to this VPValue. More...
 
const ValuegetUnderlyingValue () const
 
 VPValue (Value *UV=nullptr, VPDef *Def=nullptr)
 
 VPValue (const VPValue &)=delete
 
VPValueoperator= (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). More...
 
unsigned getNumUsers () const
 
void addUser (VPUser &User)
 
void removeUser (VPUser &User)
 Remove a single User from the list of users. More...
 
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. More...
 
void replaceAllUsesWith (VPValue *New)
 
VPDefgetDef ()
 
ValuegetLiveInIRValue ()
 Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan. More...
 

Static Public Member Functions

static bool classof (const VPRecipeBase *B)
 Method to support type inquiry through isa, cast, and dyn_cast. More...
 
static bool classof (const VPValue *V)
 
- 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. More...
 
static bool classof (const VPUser *U)
 
- Static Public Member Functions inherited from llvm::VPUser
static bool classof (const VPDef *Recipe)
 Method to support type inquiry through isa, cast, and dyn_cast. More...
 

Protected Member Functions

 VPWidenPHIRecipe (unsigned char VPVID, unsigned char VPDefID, PHINode *Phi, VPValue *Start=nullptr)
 
- 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< VPRecipeBase, 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. More...
 
 VPUser (ArrayRef< VPValue * > Operands, VPUserID ID)
 
 VPUser (std::initializer_list< VPValue * > Operands, VPUserID ID)
 
template<typename IterT >
 VPUser (iterator_range< IterT > Operands, VPUserID ID)
 
- Protected Member Functions inherited from llvm::VPValue
 VPValue (const unsigned char SC, Value *UV=nullptr, VPDef *Def=nullptr)
 
void setUnderlyingValue (Value *Val)
 

Additional Inherited Members

- Public Types inherited from llvm::VPDef
using VPRecipeTy = enum { VPBranchOnMaskSC, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPWidenCallSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenCanonicalIVSC, VPWidenIntOrFpInductionSC, VPPredInstPHISC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, VPLastPHISC=VPReductionPHISC, }
 An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated. More...
 
- Public Types inherited from llvm::VPUser
enum  VPUserID { VPUserID::Recipe, VPUserID::Block }
 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_iteratoroperand_range
 
typedef iterator_range< const_operand_iteratorconst_operand_range
 
- Public Types inherited from llvm::VPValue
enum  {
  VPValueSC, VPVInstructionSC, VPVMemoryInstructionSC, VPVReductionSC,
  VPVReplicateSC, VPVWidenSC, VPVWidenCallSC, VPVWidenGEPSC,
  VPVWidenSelectSC, VPVBlendSC, VPVFirstOrderRecurrencePHISC, VPVWidenPHISC,
  VPVWidenCanonicalIVSC, VPVWidenIntOrFpInductionSC, VPVPredInstPHI, VPVReductionPHISC
}
 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_iteratoruser_range
 
typedef iterator_range< const_user_iteratorconst_user_range
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< VPRecipeBase, Options... >::type, true, true >
 
- Protected Attributes inherited from llvm::VPValue
ValueUnderlyingVal
 
VPDefDef
 Pointer to the VPDef that defines this VPValue. More...
 

Detailed Description

A recipe for handling first order recurrences and pointer inductions.

For first-order recurrences, the start value is the first operand of the recipe and the incoming value from the backedge is the second operand. It also serves as base class for VPReductionPHIRecipe. In the VPlan native path, all incoming VPValues & VPBasicBlock pairs are managed in the recipe directly.

Definition at line 1061 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPWidenPHIRecipe() [1/3]

llvm::VPWidenPHIRecipe::VPWidenPHIRecipe ( unsigned char  VPVID,
unsigned char  VPDefID,
PHINode Phi,
VPValue Start = nullptr 
)
inlineprotected

Definition at line 1066 of file VPlan.h.

◆ VPWidenPHIRecipe() [2/3]

llvm::VPWidenPHIRecipe::VPWidenPHIRecipe ( PHINode Phi)
inline

Create a VPWidenPHIRecipe for Phi.

Definition at line 1075 of file VPlan.h.

◆ VPWidenPHIRecipe() [3/3]

llvm::VPWidenPHIRecipe::VPWidenPHIRecipe ( PHINode Phi,
VPValue Start 
)
inline

Create a new VPWidenPHIRecipe for Phi with start value Start.

Definition at line 1079 of file VPlan.h.

◆ ~VPWidenPHIRecipe()

llvm::VPWidenPHIRecipe::~VPWidenPHIRecipe ( )
overridedefault

Member Function Documentation

◆ addIncoming()

void llvm::VPWidenPHIRecipe::addIncoming ( VPValue IncomingV,
VPBasicBlock IncomingBlock 
)
inline

Adds a pair (IncomingV, IncomingBlock) to the phi.

Definition at line 1125 of file VPlan.h.

References llvm::VPUser::addOperand().

◆ classof() [1/2]

static bool llvm::VPWidenPHIRecipe::classof ( const VPRecipeBase B)
inlinestatic

Method to support type inquiry through isa, cast, and dyn_cast.

Definition at line 1086 of file VPlan.h.

References B.

◆ classof() [2/2]

static bool llvm::VPWidenPHIRecipe::classof ( const VPValue V)
inlinestatic

◆ execute()

void VPWidenPHIRecipe::execute ( VPTransformState State)
overridevirtual

Generate the phi/select nodes.

Implements llvm::VPRecipeBase.

Reimplemented in llvm::VPReductionPHIRecipe, and llvm::VPFirstOrderRecurrencePHIRecipe.

Definition at line 9681 of file LoopVectorize.cpp.

References llvm::VPTransformState::ILV, and llvm::InnerLoopVectorizer::widenPHIInstruction().

◆ getBackedgeRecipe()

VPRecipeBase* llvm::VPWidenPHIRecipe::getBackedgeRecipe ( )
inline

Returns the backedge value as a recipe.

The backedge value is guaranteed to be a recipe.

Definition at line 1120 of file VPlan.h.

References getBackedgeValue(), and llvm::VPValue::getDef().

◆ getBackedgeValue()

VPValue* llvm::VPWidenPHIRecipe::getBackedgeValue ( )
inline

Returns the incoming value from the loop backedge, if it is a reduction or first-order recurrence.

Definition at line 1114 of file VPlan.h.

References llvm::VPUser::getOperand().

Referenced by llvm::InnerLoopVectorizer::fixFirstOrderRecurrence(), llvm::InnerLoopVectorizer::fixReduction(), and getBackedgeRecipe().

◆ getIncomingBlock()

VPBasicBlock* llvm::VPWidenPHIRecipe::getIncomingBlock ( unsigned  I)
inline

Returns the I th incoming VPBasicBlock.

Definition at line 1134 of file VPlan.h.

References I.

Referenced by llvm::InnerLoopVectorizer::fixNonInductionPHIs().

◆ getIncomingValue()

VPValue* llvm::VPWidenPHIRecipe::getIncomingValue ( unsigned  I)
inline

Returns the I th incoming VPValue.

Definition at line 1131 of file VPlan.h.

References llvm::VPUser::getOperand(), and I.

Referenced by llvm::InnerLoopVectorizer::fixNonInductionPHIs().

◆ getStartValue()

VPValue* llvm::VPWidenPHIRecipe::getStartValue ( )
inline

Returns the start value of the phi, if it is a reduction or first-order recurrence.

Definition at line 1108 of file VPlan.h.

References llvm::VPUser::getNumOperands(), and llvm::VPUser::getOperand().

Referenced by llvm::VPFirstOrderRecurrencePHIRecipe::execute(), and llvm::VPReductionPHIRecipe::execute().

◆ print()

void VPWidenPHIRecipe::print ( raw_ostream O,
const Twine Indent,
VPSlotTracker SlotTracker 
) const
overridevirtual

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