This is the LLVM vectorization plan. More...

#include "VPlan.h"
#include "LoopVectorizationPlanner.h"
#include "VPlanCFG.h"
#include "VPlanDominatorTree.h"
#include "VPlanHelpers.h"
#include "VPlanPatternMatch.h"
#include "VPlanTransforms.h"
#include "VPlanUtils.h"
#include "llvm/ADT/PostOrderIterator.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Analysis/DomTreeUpdater.h"
#include "llvm/Analysis/LoopInfo.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/CFG.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Value.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/GraphWriter.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
#include "llvm/Transforms/Utils/LoopVersioning.h"
#include "llvm/Transforms/Vectorize/LoopVectorizationLegality.h"
#include <cassert>
#include <string>

Macros
#define	DEBUG_TYPE "loop-vectorize"

Functions
template<typename T>
static T *	getPlanEntry (T *Start)
template<typename T>
static T *	getEnclosingLoopRegionForRegion (T *P)
	Return the enclosing loop region for region `P`.
static bool	hasConditionalTerminator (const VPBasicBlock *VPBB)
static std::pair< VPBlockBase , VPBlockBase >	cloneFrom (VPBlockBase *Entry)
static void	remapOperands (VPBlockBase Entry, VPBlockBase NewEntry, DenseMap< VPValue , VPValue > &Old2NewVPValues)
static bool	isDefinedInsideLoopRegions (const VPValue *VPV)
	Returns true if there is a vector loop region and `VPV` is defined in a loop region.
static void	addRuntimeUnrollDisableMetaData (Loop *L)

Variables
cl::opt< unsigned >	ForceTargetInstructionCost
static cl::opt< bool >	PrintVPlansInDotFormat ("vplan-print-in-dot-format", cl::Hidden, cl::desc("Use dot format instead of plain text when dumping VPlans"))

const char	LLVMLoopVectorizeFollowupAll [] = "llvm.loop.vectorize.followup_all"
const char	LLVMLoopVectorizeFollowupVectorized []
const char	LLVMLoopVectorizeFollowupEpilogue []

Detailed Description

This is the LLVM vectorization plan.

It represents a candidate for vectorization, allowing to plan and optimize how to vectorize a given loop before generating LLVM-IR. The vectorizer uses vectorization plans to estimate the costs of potential candidates and if profitable to execute the desired plan, generating vector LLVM-IR code.

Definition in file VPlan.cpp.

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE "loop-vectorize"

Definition at line 70 of file VPlan.cpp.

Function Documentation

◆ addRuntimeUnrollDisableMetaData()

void addRuntimeUnrollDisableMetaData ( Loop * L )

static

Definition at line 1589 of file VPlan.cpp.

References llvm::dyn_cast(), llvm::MDNode::get(), llvm::MDString::get(), llvm::MDNode::getNumOperands(), llvm::MDNode::getOperand(), I, llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::MDNode::replaceOperandWith().

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

◆ cloneFrom()

std::pair< VPBlockBase *, VPBlockBase * > cloneFrom ( VPBlockBase * Entry )

static

Definition at line 678 of file VPlan.cpp.

References assert(), llvm::VPBlockBase::clone(), llvm::VPBlockBase::getParent(), llvm::VPBlockBase::getPredecessors(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::VPBlockBase::setPredecessors(), llvm::VPBlockBase::setSuccessors(), llvm::VPBlockBase::successors(), llvm::vp_depth_first_shallow(), and llvm::zip().

Referenced by llvm::VPRegionBlock::clone(), and llvm::VPlan::duplicate().

◆ getEnclosingLoopRegionForRegion()

template<typename T>

T * getEnclosingLoopRegionForRegion ( T * P )

static

Return the enclosing loop region for region P.

The templated version is used to support both const and non-const block arguments.

Definition at line 568 of file VPlan.cpp.

References assert(), P, and T.

Referenced by llvm::VPBasicBlock::getEnclosingLoopRegion(), and llvm::VPBasicBlock::getEnclosingLoopRegion().

◆ getPlanEntry()

template<typename T>

T * getPlanEntry ( T * Start )

static

Definition at line 141 of file VPlan.cpp.

References llvm::SetVector< T, Vector, Set, N >::insert(), llvm::SetVector< T, Vector, Set, N >::insert_range(), llvm_unreachable, llvm::Next, llvm::SetVector< T, Vector, Set, N >::size(), and T.

Referenced by llvm::VPBlockBase::getPlan(), and llvm::VPBlockBase::getPlan().

◆ hasConditionalTerminator()

bool hasConditionalTerminator ( const VPBasicBlock * VPBB )

static

Definition at line 586 of file VPlan.cpp.

References assert(), llvm::VPBasicBlock::back(), llvm::cast(), llvm::VPBasicBlock::empty(), llvm::VPBlockBase::getNumSuccessors(), llvm::VPBlockBase::getParent(), llvm::isa(), IsCondBranch(), llvm::VPBasicBlock::isExiting(), llvm::VPRegionBlock::isReplicator(), llvm::VPlanPatternMatch::m_BranchOnCond(), llvm::VPlanPatternMatch::m_BranchOnCount(), llvm::PatternMatch::m_CombineOr(), and llvm::PatternMatch::match().

Referenced by llvm::VPBasicBlock::getTerminator(), and llvm::VPBasicBlock::getTerminator().

◆ isDefinedInsideLoopRegions()

bool isDefinedInsideLoopRegions ( const VPValue * VPV )

static

Returns true if there is a vector loop region and VPV is defined in a loop region.

Definition at line 1368 of file VPlan.cpp.

References llvm::VPValue::getDefiningRecipe(), llvm::VPBasicBlock::getEnclosingLoopRegion(), and llvm::VPRecipeBase::getParent().

Referenced by llvm::VPValue::isDefinedOutsideLoopRegions().

◆ remapOperands()

void remapOperands	(	VPBlockBase *	Entry,
		VPBlockBase *	NewEntry,
		DenseMap< VPValue , VPValue > &	Old2NewVPValues )

static

Definition at line 1115 of file VPlan.cpp.

References assert(), llvm::VPBlockUtils::blocksOnly(), E(), I, llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::lookup(), and llvm::zip().

Referenced by llvm::VPlan::duplicate().

Variable Documentation

◆ ForceTargetInstructionCost

cl::opt<unsigned> ForceTargetInstructionCost

extern

◆ LLVMLoopVectorizeFollowupAll

const char LLVMLoopVectorizeFollowupAll[] = "llvm.loop.vectorize.followup_all"

Metadata attribute names

Definition at line 57 of file VPlan.cpp.

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

◆ LLVMLoopVectorizeFollowupEpilogue

const char LLVMLoopVectorizeFollowupEpilogue[]

Initial value:

=

"llvm.loop.vectorize.followup_epilogue"

Definition at line 60 of file VPlan.cpp.

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

◆ LLVMLoopVectorizeFollowupVectorized

const char LLVMLoopVectorizeFollowupVectorized[]

Initial value:

=

"llvm.loop.vectorize.followup_vectorized"

Definition at line 58 of file VPlan.cpp.

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

◆ PrintVPlansInDotFormat

cl::opt< bool > PrintVPlansInDotFormat("vplan-print-in-dot-format", cl::Hidden, cl::desc("Use dot format instead of plain text when dumping VPlans"))	(	"vplan-print-in-dot-format"	,
		cl::Hidden	,
		cl::desc("Use dot format instead of plain text when dumping VPlans")	)

static

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

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DEBUG_TYPE

Function Documentation

◆ addRuntimeUnrollDisableMetaData()

◆ cloneFrom()

◆ getEnclosingLoopRegionForRegion()

◆ getPlanEntry()

◆ hasConditionalTerminator()

◆ isDefinedInsideLoopRegions()

◆ remapOperands()

Variable Documentation

◆ ForceTargetInstructionCost

◆ LLVMLoopVectorizeFollowupAll

◆ LLVMLoopVectorizeFollowupEpilogue

◆ LLVMLoopVectorizeFollowupVectorized

◆ PrintVPlansInDotFormat