VPlan-based builder utility analogous to IRBuilder. More...

#include "Transforms/Vectorize/LoopVectorizationPlanner.h"

Classes
class	InsertPointGuard
	RAII object that stores the current insertion point and restores it when the object is destroyed. More...
class	VPInsertPoint
	InsertPoint - A saved insertion point. More...

Public Member Functions
	VPBuilder ()=default
	VPBuilder (VPBasicBlock *InsertBB)
	VPBuilder (VPRecipeBase *InsertPt)
	VPBuilder (VPBasicBlock *TheBB, VPBasicBlock::iterator IP)
void	clearInsertionPoint ()
	Clear the insertion point: created instructions will not be inserted into a block.
VPBasicBlock *	getInsertBlock () const
VPBasicBlock::iterator	getInsertPoint () const
void	restoreIP (VPInsertPoint IP)
	Sets the current insert point to a previously-saved location.
void	setInsertPoint (VPBasicBlock *TheBB)
	This specifies that created VPInstructions should be appended to the end of the specified block.
void	setInsertPoint (VPBasicBlock *TheBB, VPBasicBlock::iterator IP)
	This specifies that created instructions should be inserted at the specified point.
void	setInsertPoint (VPRecipeBase *IP)
	This specifies that created instructions should be inserted at the specified point.
void	insert (VPRecipeBase *R)
	Insert `R` at the current insertion point.
VPInstruction *	createNaryOp (unsigned Opcode, ArrayRef< VPValue * > Operands, Instruction *Inst=nullptr, const Twine &Name="")
	Create an N-ary operation with `Opcode`, `Operands` and set `Inst` as its underlying Instruction.
VPInstruction *	createNaryOp (unsigned Opcode, ArrayRef< VPValue * > Operands, DebugLoc DL, const Twine &Name="")
VPInstruction *	createNaryOp (unsigned Opcode, ArrayRef< VPValue * > Operands, const VPIRFlags &Flags, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createNaryOp (unsigned Opcode, ArrayRef< VPValue * > Operands, Type *ResultTy, const VPIRFlags &Flags={}, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createOverflowingOp (unsigned Opcode, ArrayRef< VPValue * > Operands, VPRecipeWithIRFlags::WrapFlagsTy WrapFlags, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createNot (VPValue *Operand, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createAnd (VPValue LHS, VPValue RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createOr (VPValue LHS, VPValue RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createLogicalAnd (VPValue LHS, VPValue RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createSelect (VPValue Cond, VPValue TrueVal, VPValue *FalseVal, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="", std::optional< FastMathFlags > FMFs=std::nullopt)
VPInstruction *	createICmp (CmpInst::Predicate Pred, VPValue A, VPValue B, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
	Create a new ICmp VPInstruction with predicate `Pred` and operands `A` and `B`.
VPInstruction *	createFCmp (CmpInst::Predicate Pred, VPValue A, VPValue B, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
	Create a new FCmp VPInstruction with predicate `Pred` and operands `A` and `B`.
VPInstruction *	createPtrAdd (VPValue Ptr, VPValue Offset, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createNoWrapPtrAdd (VPValue Ptr, VPValue Offset, GEPNoWrapFlags GEPFlags, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction *	createWidePtrAdd (VPValue Ptr, VPValue Offset, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPPhi *	createScalarPhi (ArrayRef< VPValue * > IncomingValues, DebugLoc DL, const Twine &Name="")
VPValue *	createElementCount (Type *Ty, ElementCount EC)
VPDerivedIVRecipe *	createDerivedIV (InductionDescriptor::InductionKind Kind, FPMathOperator FPBinOp, VPValue Start, VPValue Current, VPValue Step, const Twine &Name="")
	Convert the input value `Current` to the corresponding value of an induction with `Start` and `Step` values, using `Start` + `Current` * `Step`.
VPInstruction *	createScalarCast (Instruction::CastOps Opcode, VPValue Op, Type ResultTy, DebugLoc DL, const VPIRFlags &Flags={}, const VPIRMetadata &Metadata={})
VPValue *	createScalarZExtOrTrunc (VPValue Op, Type ResultTy, Type *SrcTy, DebugLoc DL)
VPWidenCastRecipe *	createWidenCast (Instruction::CastOps Opcode, VPValue Op, Type ResultTy)
VPScalarIVStepsRecipe *	createScalarIVSteps (Instruction::BinaryOps InductionOpcode, FPMathOperator FPBinOp, VPValue IV, VPValue Step, VPValue VF, DebugLoc DL)
VPExpandSCEVRecipe *	createExpandSCEV (const SCEV *Expr)

Static Public Member Functions
static VPBuilder	getToInsertAfter (VPRecipeBase *R)
	Create a VPBuilder to insert after `R`.

Detailed Description

VPlan-based builder utility analogous to IRBuilder.

Definition at line 54 of file LoopVectorizationPlanner.h.

Constructor & Destructor Documentation

◆ VPBuilder() [1/4]

llvm::VPBuilder::VPBuilder ( )

default

Referenced by getToInsertAfter(), and llvm::VPBuilder::InsertPointGuard::InsertPointGuard().

◆ VPBuilder() [2/4]

llvm::VPBuilder::VPBuilder ( VPBasicBlock * InsertBB )

inline

Definition at line 73 of file LoopVectorizationPlanner.h.

References setInsertPoint().

◆ VPBuilder() [3/4]

llvm::VPBuilder::VPBuilder ( VPRecipeBase * InsertPt )

inline

Definition at line 74 of file LoopVectorizationPlanner.h.

References setInsertPoint().

◆ VPBuilder() [4/4]

llvm::VPBuilder::VPBuilder	(	VPBasicBlock *	TheBB,
		VPBasicBlock::iterator	IP )

inline

Definition at line 75 of file LoopVectorizationPlanner.h.

References setInsertPoint().

Member Function Documentation

◆ clearInsertionPoint()

void llvm::VPBuilder::clearInsertionPoint ( )

inline

Clear the insertion point: created instructions will not be inserted into a block.

Definition at line 81 of file LoopVectorizationPlanner.h.

Referenced by restoreIP().

◆ createAnd()

VPInstruction * llvm::VPBuilder::createAnd	(	VPValue *	LHS,
		VPValue *	RHS,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 196 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), LHS, and RHS.

◆ createDerivedIV()

VPDerivedIVRecipe * llvm::VPBuilder::createDerivedIV	(	InductionDescriptor::InductionKind	Kind,
		FPMathOperator *	FPBinOp,
		VPValue *	Start,
		VPValue *	Current,
		VPValue *	Step,
		const Twine &	Name = "" )

inline

Convert the input value Current to the corresponding value of an induction with Start and Step values, using Start + Current * Step.

Definition at line 297 of file LoopVectorizationPlanner.h.

Referenced by addResumePhiRecipeForInduction().

◆ createElementCount()

VPValue * llvm::VPBuilder::createElementCount	(	Type *	Ty,
		ElementCount	EC )

inline

Definition at line 281 of file LoopVectorizationPlanner.h.

References createNaryOp(), createOverflowingOp(), llvm::VPlan::getConstantInt(), getInsertBlock(), llvm::VPBlockBase::getPlan(), and llvm::VPInstruction::VScale.

Referenced by llvm::VPlanTransforms::narrowInterleaveGroups().

◆ createExpandSCEV()

VPExpandSCEVRecipe * llvm::VPBuilder::createExpandSCEV ( const SCEV * Expr )

inline

Definition at line 344 of file LoopVectorizationPlanner.h.

◆ createFCmp()

VPInstruction * llvm::VPBuilder::createFCmp	(	CmpInst::Predicate	Pred,
		VPValue *	A,
		VPValue *	B,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Create a new FCmp VPInstruction with predicate Pred and operands A and B.

Definition at line 243 of file LoopVectorizationPlanner.h.

References A(), assert(), B(), DL, llvm::CmpInst::FIRST_FCMP_PREDICATE, llvm::DebugLoc::getUnknown(), and llvm::CmpInst::LAST_FCMP_PREDICATE.

◆ createICmp()

VPInstruction * llvm::VPBuilder::createICmp	(	CmpInst::Predicate	Pred,
		VPValue *	A,
		VPValue *	B,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Create a new ICmp VPInstruction with predicate Pred and operands A and B.

Definition at line 232 of file LoopVectorizationPlanner.h.

References A(), assert(), B(), DL, llvm::CmpInst::FIRST_ICMP_PREDICATE, llvm::DebugLoc::getUnknown(), and llvm::CmpInst::LAST_ICMP_PREDICATE.

◆ createLogicalAnd()

VPInstruction * llvm::VPBuilder::createLogicalAnd	(	VPValue *	LHS,
		VPValue *	RHS,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 211 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), LHS, llvm::VPInstruction::LogicalAnd, and RHS.

◆ createNaryOp() [1/4]

VPInstruction * llvm::VPBuilder::createNaryOp	(	unsigned	Opcode,
		ArrayRef< VPValue * >	Operands,
		const VPIRFlags &	Flags,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 165 of file LoopVectorizationPlanner.h.

References DL, and llvm::DebugLoc::getUnknown().

◆ createNaryOp() [2/4]

VPInstruction * llvm::VPBuilder::createNaryOp	(	unsigned	Opcode,
		ArrayRef< VPValue * >	Operands,
		DebugLoc	DL,
		const Twine &	Name = "" )

inline

Definition at line 161 of file LoopVectorizationPlanner.h.

References DL.

◆ createNaryOp() [3/4]

VPInstruction * llvm::VPBuilder::createNaryOp	(	unsigned	Opcode,
		ArrayRef< VPValue * >	Operands,
		Instruction *	Inst = nullptr,
		const Twine &	Name = "" )

inline

Create an N-ary operation with Opcode, Operands and set Inst as its underlying Instruction.

Definition at line 151 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), and llvm::VPValue::setUnderlyingValue().

Referenced by llvm::VPlanTransforms::addExitUsersForFirstOrderRecurrences(), llvm::VPlanTransforms::addScalarResumePhis(), llvm::VPlanTransforms::adjustFixedOrderRecurrences(), llvm::VPlanTransforms::attachCheckBlock(), createElementCount(), llvm::VPlanTransforms::handleUncountableEarlyExit(), llvm::VPlanTransforms::narrowInterleaveGroups(), and preparePlanForMainVectorLoop().

◆ createNaryOp() [4/4]

VPInstruction * llvm::VPBuilder::createNaryOp	(	unsigned	Opcode,
		ArrayRef< VPValue * >	Operands,
		Type *	ResultTy,
		const VPIRFlags &	Flags = {},
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 173 of file LoopVectorizationPlanner.h.

◆ createNot()

VPInstruction * llvm::VPBuilder::createNot	(	VPValue *	Operand,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 190 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), and llvm::VPInstruction::Not.

◆ createNoWrapPtrAdd()

VPInstruction * llvm::VPBuilder::createNoWrapPtrAdd	(	VPValue *	Ptr,
		VPValue *	Offset,
		GEPNoWrapFlags	GEPFlags,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 260 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), llvm::Offset, Ptr, and llvm::VPInstruction::PtrAdd.

◆ createOr()

VPInstruction * llvm::VPBuilder::createOr	(	VPValue *	LHS,
		VPValue *	RHS,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 202 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), LHS, and RHS.

◆ createOverflowingOp()

VPInstruction * llvm::VPBuilder::createOverflowingOp	(	unsigned	Opcode,
		ArrayRef< VPValue * >	Operands,
		VPRecipeWithIRFlags::WrapFlagsTy	WrapFlags,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 181 of file LoopVectorizationPlanner.h.

References DL, and llvm::DebugLoc::getUnknown().

Referenced by createElementCount().

◆ createPtrAdd()

VPInstruction * llvm::VPBuilder::createPtrAdd	(	VPValue *	Ptr,
		VPValue *	Offset,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "" )

inline

Definition at line 252 of file LoopVectorizationPlanner.h.

References DL, llvm::DebugLoc::getUnknown(), llvm::GEPNoWrapFlags::none(), llvm::Offset, Ptr, and llvm::VPInstruction::PtrAdd.

◆ createScalarCast()

VPInstruction * llvm::VPBuilder::createScalarCast	(	Instruction::CastOps	Opcode,
		VPValue *	Op,
		Type *	ResultTy,
		DebugLoc	DL,
		const VPIRFlags &	Flags = {},
		const VPIRMetadata &	Metadata = {} )

inline

Definition at line 305 of file LoopVectorizationPlanner.h.

References DL.

Referenced by addResumePhiRecipeForInduction(), and createScalarZExtOrTrunc().

◆ createScalarIVSteps()

VPScalarIVStepsRecipe * llvm::VPBuilder::createScalarIVSteps	(	Instruction::BinaryOps	InductionOpcode,
		FPMathOperator *	FPBinOp,
		VPValue *	IV,
		VPValue *	Step,
		VPValue *	VF,
		DebugLoc	DL )

inline

Definition at line 336 of file LoopVectorizationPlanner.h.

References DL, llvm::FPMathOperator::getFastMathFlags(), and IV.

◆ createScalarPhi()

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

inline

Definition at line 276 of file LoopVectorizationPlanner.h.

References DL.

Referenced by addResumePhiRecipeForInduction(), llvm::VPlanTransforms::addScalarResumePhis(), llvm::VPlanTransforms::canonicalizeEVLLoops(), llvm::VPRegionBlock::dissolveToCFGLoop(), and preparePlanForMainVectorLoop().

◆ createScalarZExtOrTrunc()

VPValue * llvm::VPBuilder::createScalarZExtOrTrunc	(	VPValue *	Op,
		Type *	ResultTy,
		Type *	SrcTy,
		DebugLoc	DL )

inline

Definition at line 313 of file LoopVectorizationPlanner.h.

References createScalarCast(), DL, and llvm::Type::getScalarSizeInBits().

◆ createSelect()

VPInstruction * llvm::VPBuilder::createSelect	(	VPValue *	Cond,
		VPValue *	TrueVal,
		VPValue *	FalseVal,
		DebugLoc	DL = DebugLoc::getUnknown(),
		const Twine &	Name = "",
		std::optional< FastMathFlags >	FMFs = std::nullopt )