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.

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, std::initializer_list< VPValue * > Operands, std::optional< FastMathFlags > FMFs={}, DebugLoc DL={}, const Twine &Name="")

VPInstruction *	createOverflowingOp (unsigned Opcode, std::initializer_list< VPValue * > Operands, VPRecipeWithIRFlags::WrapFlagsTy WrapFlags, DebugLoc DL={}, const Twine &Name="")

VPValue *	createNot (VPValue *Operand, DebugLoc DL={}, const Twine &Name="")

VPValue *	createAnd (VPValue LHS, VPValue RHS, DebugLoc DL={}, const Twine &Name="")

VPValue *	createOr (VPValue LHS, VPValue RHS, DebugLoc DL={}, const Twine &Name="")

VPValue *	createLogicalAnd (VPValue LHS, VPValue RHS, DebugLoc DL={}, const Twine &Name="")

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

VPValue *	createICmp (CmpInst::Predicate Pred, VPValue A, VPValue B, DebugLoc DL={}, const Twine &Name="")
	Create a new ICmp VPInstruction with predicate `Pred` and operands `A` and `B`.

VPInstruction *	createPtrAdd (VPValue Ptr, VPValue Offset, DebugLoc DL={}, const Twine &Name="")

VPValue *	createInBoundsPtrAdd (VPValue Ptr, VPValue Offset, DebugLoc DL={}, const Twine &Name="")

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`.

VPScalarCastRecipe *	createScalarCast (Instruction::CastOps Opcode, VPValue Op, Type ResultTy, DebugLoc DL)

VPWidenCastRecipe *	createWidenCast (Instruction::CastOps Opcode, VPValue Op, Type ResultTy)

VPScalarIVStepsRecipe *	createScalarIVSteps (Instruction::BinaryOps InductionOpcode, FPMathOperator FPBinOp, VPValue IV, VPValue *Step)

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 45 of file LoopVectorizationPlanner.h.

Constructor & Destructor Documentation

◆ VPBuilder() [1/4]

llvm::VPBuilder::VPBuilder ( )

default

◆ VPBuilder() [2/4]

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

inline

Definition at line 70 of file LoopVectorizationPlanner.h.

References setInsertPoint().

◆ VPBuilder() [3/4]

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

inline

Definition at line 71 of file LoopVectorizationPlanner.h.

References setInsertPoint().

◆ VPBuilder() [4/4]

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

inline

Definition at line 72 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 78 of file LoopVectorizationPlanner.h.

Referenced by restoreIP().

◆ createAnd()

VPValue * llvm::VPBuilder::createAnd	(	VPValue *	LHS,
		VPValue *	RHS,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 182 of file LoopVectorizationPlanner.h.

◆ 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 237 of file LoopVectorizationPlanner.h.

References Name.

Referenced by addResumePhiRecipeForInduction(), and createScalarIVSteps().

◆ createICmp()

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

inline

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

TODO: add createFCmp when needed.

Definition at line 215 of file LoopVectorizationPlanner.h.

Referenced by llvm::VPRecipeBuilder::createHeaderMask(), llvm::VPRecipeBuilder::createSwitchEdgeMasks(), llvm::VPlanTransforms::handleUncountableEarlyExit(), and llvm::VPlanTransforms::tryAddExplicitVectorLength().

◆ createInBoundsPtrAdd()

VPValue * llvm::VPBuilder::createInBoundsPtrAdd	(	VPValue *	Ptr,
		VPValue *	Offset,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 228 of file LoopVectorizationPlanner.h.

◆ createLogicalAnd()

VPValue * llvm::VPBuilder::createLogicalAnd	(	VPValue *	LHS,
		VPValue *	RHS,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 195 of file LoopVectorizationPlanner.h.

Referenced by llvm::VPRecipeBuilder::createEdgeMask(), and llvm::VPRecipeBuilder::createSwitchEdgeMasks().

◆ createNaryOp() [1/3]

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

inline

Definition at line 155 of file LoopVectorizationPlanner.h.

References DL, Name, and Operands.

◆ createNaryOp() [2/3]

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 145 of file LoopVectorizationPlanner.h.

References DL, Name, Operands, and llvm::VPValue::setUnderlyingValue().

Referenced by addCanonicalIVRecipes(), addExitUsersForFirstOrderRecurrences(), addResumePhiRecipeForInduction(), addScalarResumePhis(), addVPLaneMaskPhiAndUpdateExitBranch(), llvm::VPlanTransforms::adjustFixedOrderRecurrences(), llvm::VPlanTransforms::handleUncountableEarlyExit(), preparePlanForMainVectorLoop(), and llvm::VPlanTransforms::tryAddExplicitVectorLength().

◆ createNaryOp() [3/3]

VPInstruction * llvm::VPBuilder::createNaryOp	(	unsigned	Opcode,
		std::initializer_list< VPValue * >	Operands,
		std::optional< FastMathFlags >	FMFs = `{}`,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 159 of file LoopVectorizationPlanner.h.

◆ createNot()

VPValue * llvm::VPBuilder::createNot	(	VPValue *	Operand,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 177 of file LoopVectorizationPlanner.h.

Referenced by addVPLaneMaskPhiAndUpdateExitBranch(), llvm::VPRecipeBuilder::createEdgeMask(), llvm::VPRecipeBuilder::createSwitchEdgeMasks(), and llvm::VPlanTransforms::handleUncountableEarlyExit().

◆ createOr()

VPValue * llvm::VPBuilder::createOr	(	VPValue *	LHS,
		VPValue *	RHS,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 187 of file LoopVectorizationPlanner.h.

Referenced by llvm::VPRecipeBuilder::createBlockInMask(), and llvm::VPRecipeBuilder::createSwitchEdgeMasks().

◆ createOverflowingOp()

VPInstruction * llvm::VPBuilder::createOverflowingOp	(	unsigned	Opcode,
		std::initializer_list< VPValue * >	Operands,
		VPRecipeWithIRFlags::WrapFlagsTy	WrapFlags,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

inline

Definition at line 169 of file LoopVectorizationPlanner.h.

Referenced by addCanonicalIVRecipes(), and addVPLaneMaskPhiAndUpdateExitBranch().

◆ createPtrAdd()

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

inline

Definition at line 223 of file LoopVectorizationPlanner.h.

Referenced by legalizeAndOptimizeInductions().

◆ createScalarCast()

VPScalarCastRecipe * llvm::VPBuilder::createScalarCast	(	Instruction::CastOps	Opcode,
		VPValue *	Op,
		Type *	ResultTy,
		DebugLoc	DL
	)

inline

Definition at line 245 of file LoopVectorizationPlanner.h.

References DL.

Referenced by addResumePhiRecipeForInduction(), and createScalarIVSteps().

◆ createScalarIVSteps()

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

inline

Definition at line 257 of file LoopVectorizationPlanner.h.

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

Referenced by createScalarIVSteps().

◆ createSelect()

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