LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::VPlan Class Reference

VPlan models a candidate for vectorization, encoding various decisions take to produce efficient output IR, including which branches, basic-blocks and output IR instructions to generate, and their cost. More...

#include "Transforms/Vectorize/VPlan.h"

Public Member Functions

 VPlan (VPBasicBlock *Entry, VPIRBasicBlock *ScalarHeader)
 Construct a VPlan with Entry to the plan and with ScalarHeader wrapping the original header of the scalar loop.
 
 VPlan (VPBasicBlock *Entry, VPValue *TC, VPIRBasicBlock *ScalarHeader)
 Construct a VPlan with Entry entering the plan, trip count TC and with ScalarHeader wrapping the original header of the scalar loop.
 
 VPlan (Loop *L)
 Construct a VPlan for L.
 
 ~VPlan ()
 
void setEntry (VPBasicBlock *VPBB)
 
void prepareToExecute (Value *TripCount, Value *VectorTripCount, VPTransformState &State)
 Prepare the plan for execution, setting up the required live-in values.
 
void execute (VPTransformState *State)
 Generate the IR code for this VPlan.
 
InstructionCost cost (ElementCount VF, VPCostContext &Ctx)
 Return the cost of this plan.
 
VPBasicBlockgetEntry ()
 
const VPBasicBlockgetEntry () const
 
VPBasicBlockgetVectorPreheader ()
 Returns the preheader of the vector loop region.
 
VPRegionBlockgetVectorLoopRegion ()
 Returns the VPRegionBlock of the vector loop.
 
const VPRegionBlockgetVectorLoopRegion () const
 
const VPBasicBlockgetMiddleBlock () const
 Returns the 'middle' block of the plan, that is the block that selects whether to execute the scalar tail loop or the exit block from the loop latch.
 
VPBasicBlockgetMiddleBlock ()
 
VPBasicBlockgetScalarPreheader () const
 Return the VPBasicBlock for the preheader of the scalar loop.
 
VPIRBasicBlockgetScalarHeader () const
 Return the VPIRBasicBlock wrapping the header of the scalar loop.
 
auto getExitBlocks ()
 Return an iterator range over the VPIRBasicBlock wrapping the exit blocks of the VPlan, that is leaf nodes except the scalar header.
 
VPValuegetTripCount () const
 The trip count of the original loop.
 
void resetTripCount (VPValue *NewTripCount)
 Resets the trip count for the VPlan.
 
VPValuegetOrCreateBackedgeTakenCount ()
 The backedge taken count of the original loop.
 
VPValuegetVectorTripCount ()
 The vector trip count.
 
VPValuegetVF ()
 Returns the VF of the vector loop region.
 
VPValuegetVFxUF ()
 Returns VF * UF of the vector loop region.
 
void addVF (ElementCount VF)
 
void setVF (ElementCount VF)
 
bool hasVF (ElementCount VF)
 
bool hasScalableVF ()
 
iterator_range< SmallSetVector< ElementCount, 2 >::iterator > vectorFactors () const
 Returns an iterator range over all VFs of the plan.
 
bool hasScalarVFOnly () const
 
bool hasUF (unsigned UF) const
 
unsigned getUF () const
 
void setUF (unsigned UF)
 
std::string getName () const
 Return a string with the name of the plan and the applicable VFs and UFs.
 
void setName (const Twine &newName)
 
VPValuegetOrAddLiveIn (Value *V)
 Gets the live-in VPValue for V or adds a new live-in (if none exists yet) for V.
 
VPValuegetLiveIn (Value *V) const
 Return the live-in VPValue for V, if there is one or nullptr otherwise.
 
void printLiveIns (raw_ostream &O) const
 Print the live-ins of this VPlan to O.
 
void print (raw_ostream &O) const
 Print this VPlan to O.
 
void printDOT (raw_ostream &O) const
 Print this VPlan in DOT format to O.
 
LLVM_DUMP_METHOD void dump () const
 Dump the plan to stderr (for debugging).
 
VPCanonicalIVPHIRecipegetCanonicalIV ()
 Returns the canonical induction recipe of the vector loop.
 
VPValuegetSCEVExpansion (const SCEV *S) const
 
void addSCEVExpansion (const SCEV *S, VPValue *V)
 
VPlanduplicate ()
 Clone the current VPlan, update all VPValues of the new VPlan and cloned recipes to refer to the clones, and return it.
 

Static Public Member Functions

static VPlanPtr createInitialVPlan (Type *InductionTy, PredicatedScalarEvolution &PSE, bool RequiresScalarEpilogueCheck, bool TailFolded, Loop *TheLoop)
 Create initial VPlan, having an "entry" VPBasicBlock (wrapping original scalar pre-header) which contains SCEV expansions that need to happen before the CFG is modified (when executing a VPlan for the epilogue vector loop, the original entry needs to be replaced by a new one); a VPBasicBlock for the vector pre-header, followed by a region for the vector loop, followed by the middle VPBasicBlock.
 

Friends

class VPlanPrinter
 
class VPSlotTracker
 

Detailed Description

VPlan models a candidate for vectorization, encoding various decisions take to produce efficient output IR, including which branches, basic-blocks and output IR instructions to generate, and their cost.

VPlan holds a Hierarchical-CFG of VPBasicBlocks and VPRegionBlocks rooted at an Entry VPBasicBlock.

Definition at line 3761 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPlan() [1/3]

llvm::VPlan::VPlan ( VPBasicBlock Entry,
VPIRBasicBlock ScalarHeader 
)
inline

Construct a VPlan with Entry to the plan and with ScalarHeader wrapping the original header of the scalar loop.

Definition at line 3818 of file VPlan.h.

References assert(), and llvm::VPBlockBase::getNumSuccessors().

◆ VPlan() [2/3]

llvm::VPlan::VPlan ( VPBasicBlock Entry,
VPValue TC,
VPIRBasicBlock ScalarHeader 
)
inline

Construct a VPlan with Entry entering the plan, trip count TC and with ScalarHeader wrapping the original header of the scalar loop.

Definition at line 3827 of file VPlan.h.

◆ VPlan() [3/3]

VPlan::VPlan ( Loop L)

Construct a VPlan for L.

This will create VPIRBasicBlocks wrapping the original preheader and scalar header of L, to be used as entry and scalar header blocks of the new VPlan.

Definition at line 824 of file VPlan.cpp.

References llvm::VPIRBasicBlock::fromBasicBlock().

◆ ~VPlan()

VPlan::~VPlan ( )

Member Function Documentation

◆ addSCEVExpansion()

void llvm::VPlan::addSCEVExpansion ( const SCEV S,
VPValue V 
)
inline

◆ addVF()

void llvm::VPlan::addVF ( ElementCount  VF)
inline

Definition at line 3935 of file VPlan.h.

References llvm::SetVector< T, Vector, Set, N >::insert().

◆ cost()

InstructionCost VPlan::cost ( ElementCount  VF,
VPCostContext Ctx 
)

Return the cost of this plan.

Definition at line 1078 of file VPlan.cpp.

References llvm::VPTransformState::VF.

◆ createInitialVPlan()

VPlanPtr VPlan::createInitialVPlan ( Type InductionTy,
PredicatedScalarEvolution PSE,
bool  RequiresScalarEpilogueCheck,
bool  TailFolded,
Loop TheLoop 
)
static

Create initial VPlan, having an "entry" VPBasicBlock (wrapping original scalar pre-header) which contains SCEV expansions that need to happen before the CFG is modified (when executing a VPlan for the epilogue vector loop, the original entry needs to be replaced by a new one); a VPBasicBlock for the vector pre-header, followed by a region for the vector loop, followed by the middle VPBasicBlock.

If a check is needed to guard executing the scalar epilogue loop, it will be added to the middle block, together with VPBasicBlocks for the scalar preheader and exit blocks. InductionTy is the type of the canonical induction and used for related values, like the trip count expression.

Definition at line 851 of file VPlan.cpp.

References assert(), llvm::VPInstruction::BranchOnCond, llvm::VPTransformState::Builder, llvm::VPBlockUtils::connectBlocks(), llvm::VPIRBasicBlock::fromBasicBlock(), llvm::Type::getContext(), getEntry(), llvm::Type::getInt1Ty(), llvm::LoopBase< BlockT, LoopT >::getLoopLatch(), getOrAddLiveIn(), llvm::vputils::getOrCreateVPValueForSCEVExpr(), getScalarHeader(), llvm::PredicatedScalarEvolution::getSE(), llvm::PredicatedScalarEvolution::getSymbolicMaxBackedgeTakenCount(), llvm::BasicBlock::getTerminator(), getTripCount(), llvm::ScalarEvolution::getTripCountFromExitCount(), llvm::ConstantInt::getTrue(), llvm::SCEV::getType(), llvm::LoopBase< BlockT, LoopT >::getUniqueLatchExitBlock(), getVectorTripCount(), llvm::CmpInst::ICMP_EQ, llvm::VPBlockUtils::insertBlockAfter(), and llvm::VPTransformState::Plan.

◆ dump()

LLVM_DUMP_METHOD void VPlan::dump ( ) const

Dump the plan to stderr (for debugging).

Definition at line 1183 of file VPlan.cpp.

References llvm::dbgs(), and llvm::print().

◆ duplicate()

VPlan * VPlan::duplicate ( )

Clone the current VPlan, update all VPValues of the new VPlan and cloned recipes to refer to the clones, and return it.

Definition at line 1224 of file VPlan.cpp.

References assert(), cloneFrom(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::contains(), llvm::find_if(), Name, remapOperands(), llvm::VPTransformState::VF, and llvm::vp_depth_first_shallow().

Referenced by llvm::LoopVectorizePass::processLoop().

◆ execute()

void VPlan::execute ( VPTransformState State)

◆ getCanonicalIV()

VPCanonicalIVPHIRecipe * llvm::VPlan::getCanonicalIV ( )
inline

◆ getEntry() [1/2]

VPBasicBlock * llvm::VPlan::getEntry ( )
inline

◆ getEntry() [2/2]

const VPBasicBlock * llvm::VPlan::getEntry ( ) const
inline

Definition at line 3870 of file VPlan.h.

◆ getExitBlocks()

auto llvm::VPlan::getExitBlocks ( )
inline

Return an iterator range over the VPIRBasicBlock wrapping the exit blocks of the VPlan, that is leaf nodes except the scalar header.

Defined in VPlanHCFG, as the definition of the type needs access to the definitions of VPBlockShallowTraversalWrapper.

Definition at line 309 of file VPlanCFG.h.

References llvm::VPBlockBase::getNumSuccessors(), getScalarHeader(), getVectorLoopRegion(), llvm::make_filter_range(), and llvm::vp_depth_first_shallow().

Referenced by collectUsersInExitBlocks().

◆ getLiveIn()

VPValue * llvm::VPlan::getLiveIn ( Value V) const
inline

Return the live-in VPValue for V, if there is one or nullptr otherwise.

Definition at line 3993 of file VPlan.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::lookup().

◆ getMiddleBlock() [1/2]

VPBasicBlock * llvm::VPlan::getMiddleBlock ( )
inline

Definition at line 3887 of file VPlan.h.

References getScalarPreheader().

◆ getMiddleBlock() [2/2]

const VPBasicBlock * llvm::VPlan::getMiddleBlock ( ) const
inline

Returns the 'middle' block of the plan, that is the block that selects whether to execute the scalar tail loop or the exit block from the loop latch.

Definition at line 3884 of file VPlan.h.

References getScalarPreheader().

Referenced by addExitUsersForFirstOrderRecurrences(), addUsersInExitBlocks(), collectUsersInExitBlocks(), llvm::LoopVectorizationPlanner::executePlan(), llvm::InnerLoopVectorizer::fixVectorizedLoop(), and llvm::VPlanTransforms::handleUncountableEarlyExit().

◆ getName()

std::string VPlan::getName ( ) const

Return a string with the name of the plan and the applicable VFs and UFs.

Definition at line 1153 of file VPlan.cpp.

References llvm::drop_begin(), Name, and llvm::VPTransformState::VF.

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

◆ getOrAddLiveIn()

VPValue * llvm::VPlan::getOrAddLiveIn ( Value V)
inline

◆ getOrCreateBackedgeTakenCount()

VPValue * llvm::VPlan::getOrCreateBackedgeTakenCount ( )
inline

The backedge taken count of the original loop.

Definition at line 3920 of file VPlan.h.

Referenced by llvm::VPRecipeBuilder::createHeaderMask(), and llvm::vputils::isHeaderMask().

◆ getScalarHeader()

VPIRBasicBlock * llvm::VPlan::getScalarHeader ( ) const
inline

Return the VPIRBasicBlock wrapping the header of the scalar loop.

Definition at line 3897 of file VPlan.h.

Referenced by addScalarResumePhis(), llvm::InnerLoopVectorizer::createInductionResumeVPValues(), createInitialVPlan(), getExitBlocks(), and getScalarPreheader().

◆ getScalarPreheader()

VPBasicBlock * llvm::VPlan::getScalarPreheader ( ) const
inline

◆ getSCEVExpansion()

VPValue * llvm::VPlan::getSCEVExpansion ( const SCEV S) const
inline

◆ getTripCount()

VPValue * llvm::VPlan::getTripCount ( ) const
inline

◆ getUF()

unsigned llvm::VPlan::getUF ( ) const
inline

◆ getVectorLoopRegion() [1/2]

VPRegionBlock * VPlan::getVectorLoopRegion ( )

◆ getVectorLoopRegion() [2/2]

const VPRegionBlock * VPlan::getVectorLoopRegion ( ) const

Definition at line 1092 of file VPlan.cpp.

References B, and llvm::vp_depth_first_shallow().

◆ getVectorPreheader()

VPBasicBlock * llvm::VPlan::getVectorPreheader ( )
inline

◆ getVectorTripCount()

VPValue & llvm::VPlan::getVectorTripCount ( )
inline

The vector trip count.

Definition at line 3927 of file VPlan.h.

Referenced by addCanonicalIVRecipes(), llvm::InnerLoopVectorizer::createInductionResumeVPValues(), and createInitialVPlan().

◆ getVF()

VPValue & llvm::VPlan::getVF ( )
inline

Returns the VF of the vector loop region.

Definition at line 3930 of file VPlan.h.

Referenced by createWidenInductionRecipes(), and transformRecipestoEVLRecipes().

◆ getVFxUF()

VPValue & llvm::VPlan::getVFxUF ( )
inline

Returns VF * UF of the vector loop region.

Definition at line 3933 of file VPlan.h.

Referenced by addCanonicalIVRecipes().

◆ hasScalableVF()

bool llvm::VPlan::hasScalableVF ( )
inline

◆ hasScalarVFOnly()

bool llvm::VPlan::hasScalarVFOnly ( ) const
inline

Definition at line 3954 of file VPlan.h.

References llvm::SetVector< T, Vector, Set, N >::size().

Referenced by sinkScalarOperands().

◆ hasUF()

bool llvm::VPlan::hasUF ( unsigned  UF) const
inline

◆ hasVF()

bool llvm::VPlan::hasVF ( ElementCount  VF)
inline

◆ prepareToExecute()

void VPlan::prepareToExecute ( Value TripCount,
Value VectorTripCount,
VPTransformState State 
)

◆ print()

LLVM_DUMP_METHOD void VPlan::print ( raw_ostream O) const

Print this VPlan to O.

Definition at line 1136 of file VPlan.cpp.

References llvm::Block, and getName().

Referenced by llvm::operator<<(), and llvm::LoopVectorizationPlanner::printPlans().

◆ printDOT()

LLVM_DUMP_METHOD void VPlan::printDOT ( raw_ostream O) const

Print this VPlan in DOT format to O.

Definition at line 1177 of file VPlan.cpp.

References llvm::Metadata::dump(), and Printer.

Referenced by llvm::LoopVectorizationPlanner::printPlans().

◆ printLiveIns()

void VPlan::printLiveIns ( raw_ostream O) const

Print the live-ins of this VPlan to O.

Definition at line 1100 of file VPlan.cpp.

References llvm::VPTransformState::VF.

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

◆ resetTripCount()

void llvm::VPlan::resetTripCount ( VPValue NewTripCount)
inline

Resets the trip count for the VPlan.

The caller must make sure all uses of the original trip count have been replaced.

Definition at line 3913 of file VPlan.h.

References assert(), and llvm::VPValue::getNumUsers().

Referenced by preparePlanForEpilogueVectorLoop().

◆ setEntry()

void llvm::VPlan::setEntry ( VPBasicBlock VPBB)
inline

◆ setName()

void llvm::VPlan::setName ( const Twine newName)
inline

Definition at line 3972 of file VPlan.h.

References Name, and llvm::Twine::str().

Referenced by llvm::VPlanHCFGBuilder::buildHierarchicalCFG().

◆ setUF()

void llvm::VPlan::setUF ( unsigned  UF)
inline

◆ setVF()

void llvm::VPlan::setVF ( ElementCount  VF)
inline

◆ vectorFactors()

iterator_range< SmallSetVector< ElementCount, 2 >::iterator > llvm::VPlan::vectorFactors ( ) const
inline

Returns an iterator range over all VFs of the plan.

Definition at line 3950 of file VPlan.h.

References llvm::SetVector< T, Vector, Set, N >::begin(), and llvm::SetVector< T, Vector, Set, N >::end().

Referenced by llvm::LoopVectorizationPlanner::computeBestVF().

Friends And Related Function Documentation

◆ VPlanPrinter

friend class VPlanPrinter
friend

Definition at line 3762 of file VPlan.h.

◆ VPSlotTracker

friend class VPSlotTracker
friend

Definition at line 3763 of file VPlan.h.


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