This is a concrete Recipe that models a single VPlan-level instruction. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPInstruction:

[legend]

Public Types
enum	{ FirstOrderRecurrenceSplice , Not , SLPLoad , SLPStore , ActiveLaneMask , CalculateTripCountMinusVF , CanonicalIVIncrement , CanonicalIVIncrementForPart , BranchOnCount , BranchOnCond }
	VPlan opcodes, extending LLVM IR with idiomatics instructions. More...

Public Types inherited from llvm::VPDef
using	VPRecipeTy = enum { VPBranchOnMaskSC, VPDerivedIVSC, VPExpandSCEVSC, VPInstructionSC, VPInterleaveSC, VPReductionSC, VPReplicateSC, VPScalarIVStepsSC, VPWidenCallSC, VPWidenCanonicalIVSC, VPWidenCastSC, VPWidenGEPSC, VPWidenMemoryInstructionSC, VPWidenSC, VPWidenSelectSC, VPBlendSC, VPPredInstPHISC, VPCanonicalIVPHISC, VPActiveLaneMaskPHISC, VPFirstOrderRecurrencePHISC, VPWidenPHISC, VPWidenIntOrFpInductionSC, VPWidenPointerInductionSC, VPReductionPHISC, VPFirstPHISC=VPBlendSC, VPFirstHeaderPHISC=VPCanonicalIVPHISC, VPLastHeaderPHISC=VPReductionPHISC, VPLastPHISC=VPReductionPHISC, }
	An enumeration for keeping track of the concrete subclass of VPRecipeBase that is actually instantiated.

Public Types inherited from llvm::VPUser
enum class	VPUserID { Recipe , LiveOut }
	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_iterator >	operand_range

typedef iterator_range< const_operand_iterator >	const_operand_range

Public Types inherited from llvm::VPValue
enum	{ VPValueSC , VPVRecipeSC }
	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_iterator >	user_range

typedef iterator_range< const_user_iterator >	const_user_range

Public Member Functions
	VPInstruction (unsigned Opcode, ArrayRef< VPValue * > Operands, DebugLoc DL, const Twine &Name="")

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

	VPInstruction (unsigned Opcode, CmpInst::Predicate Pred, VPValue A, VPValue B, DebugLoc DL={}, const Twine &Name="")

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

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

unsigned	getOpcode () const

void	execute (VPTransformState &State) override
	Generate the instruction.

void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const override
	Print the VPInstruction to `O`.

LLVM_DUMP_METHOD void	dump () const
	Print the VPInstruction to dbgs() (for debugging).

bool	mayWriteToMemory () const
	Return true if this instruction may modify memory.

bool	hasResult () const

bool	onlyFirstLaneUsed (const VPValue *Op) const override
	Returns true if the recipe only uses the first lane of operand `Op`.

Public Member Functions inherited from llvm::VPRecipeWithIRFlags
template<typename IterT >
	VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, DebugLoc DL={})

template<typename IterT >
	VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, Instruction &I)

template<typename IterT >
	VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, CmpInst::Predicate Pred, DebugLoc DL={})

template<typename IterT >
	VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, WrapFlagsTy WrapFlags, DebugLoc DL={})

template<typename IterT >
	VPRecipeWithIRFlags (const unsigned char SC, IterT Operands, FastMathFlags FMFs, DebugLoc DL={})

void	dropPoisonGeneratingFlags ()
	Drop all poison-generating flags.

void	setFlags (Instruction *I) const
	Set the IR flags for `I`.

CmpInst::Predicate	getPredicate () const

bool	isInBounds () const

bool	hasFastMathFlags () const
	Returns true if the recipe has fast-math flags.

FastMathFlags	getFastMathFlags () const

bool	hasNoUnsignedWrap () const

bool	hasNoSignedWrap () const

void	printFlags (raw_ostream &O) const

Public Member Functions inherited from llvm::VPRecipeBase
	VPRecipeBase (const unsigned char SC, ArrayRef< VPValue * > Operands, DebugLoc DL={})

template<typename IterT >
	VPRecipeBase (const unsigned char SC, iterator_range< IterT > Operands, DebugLoc DL={})

virtual	~VPRecipeBase ()=default

VPBasicBlock *	getParent ()

const VPBasicBlock *	getParent () const

virtual void	execute (VPTransformState &State)=0
	The method which generates the output IR instructions that correspond to this VPRecipe, thereby "executing" the VPlan.

void	insertBefore (VPRecipeBase *InsertPos)
	Insert an unlinked recipe into a basic block immediately before the specified recipe.

void	insertBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator IP)
	Insert an unlinked recipe into `BB` immediately before the insertion point `IP`;.

void	insertAfter (VPRecipeBase *InsertPos)
	Insert an unlinked Recipe into a basic block immediately after the specified Recipe.

void	moveAfter (VPRecipeBase *MovePos)
	Unlink this recipe from its current VPBasicBlock and insert it into the VPBasicBlock that MovePos lives in, right after MovePos.

void	moveBefore (VPBasicBlock &BB, iplist< VPRecipeBase >::iterator I)
	Unlink this recipe and insert into BB before I.

void	removeFromParent ()
	This method unlinks 'this' from the containing basic block, but does not delete it.

iplist< VPRecipeBase >::iterator	eraseFromParent ()
	This method unlinks 'this' from the containing basic block and deletes it.

Instruction *	getUnderlyingInstr ()
	Returns the underlying instruction, if the recipe is a VPValue or nullptr otherwise.

const Instruction *	getUnderlyingInstr () const

bool	mayHaveSideEffects () const
	Returns true if the recipe may have side-effects.

bool	isPhi () const
	Returns true for PHI-like recipes.

bool	mayReadFromMemory () const
	Returns true if the recipe may read from memory.

bool	mayWriteToMemory () const
	Returns true if the recipe may write to memory.

bool	mayReadOrWriteMemory () const
	Returns true if the recipe may read from or write to memory.

DebugLoc	getDebugLoc () const
	Returns the debug location of the recipe.

Public Member Functions inherited from llvm::ilist_node_with_parent< VPRecipeBase, VPBasicBlock >
VPRecipeBase *	getPrevNode ()

const VPRecipeBase *	getPrevNode () const
	Get the previous node, or `nullptr` for the list head.

VPRecipeBase *	getNextNode ()
	Get the next node, or `nullptr` for the list tail.

const VPRecipeBase *	getNextNode () const
	Get the next node, or `nullptr` for the list tail.

Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, 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.

Public Member Functions inherited from llvm::VPDef
	VPDef (const unsigned char SC)

virtual	~VPDef ()

VPValue *	getVPSingleValue ()
	Returns the only VPValue defined by the VPDef.

const VPValue *	getVPSingleValue () const

VPValue *	getVPValue (unsigned I)
	Returns the VPValue with index `I` defined by the VPDef.

const VPValue *	getVPValue (unsigned I) const

ArrayRef< VPValue * >	definedValues ()
	Returns an ArrayRef of the values defined by the VPDef.

ArrayRef< VPValue * >	definedValues () const
	Returns an ArrayRef of the values defined by the VPDef.

unsigned	getNumDefinedValues () const
	Returns the number of values defined by the VPDef.

unsigned	getVPDefID () const

void	dump () const
	Dump the VPDef to stderr (for debugging).

virtual void	print (raw_ostream &O, const Twine &Indent, VPSlotTracker &SlotTracker) const =0
	Each concrete VPDef prints itself.

Public Member Functions inherited from llvm::VPUser
	VPUser ()=delete

	VPUser (const VPUser &)=delete

VPUser &	operator= (const VPUser &)=delete

virtual	~VPUser ()

VPUserID	getVPUserID () const

void	addOperand (VPValue *Operand)

unsigned	getNumOperands () const

VPValue *	getOperand (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

virtual bool	usesScalars (const VPValue *Op) const
	Returns true if the VPUser uses scalars of operand `Op`.

virtual bool	onlyFirstLaneUsed (const VPValue *Op) const
	Returns true if the VPUser only uses the first lane of operand `Op`.

Public Member Functions inherited from llvm::VPValue
Value *	getUnderlyingValue ()
	Return the underlying Value attached to this VPValue.

const Value *	getUnderlyingValue () const

	VPValue (Value *UV=nullptr)
	Create a live-in VPValue.

	VPValue (VPDef Def, Value UV=nullptr)
	Create a VPValue for a `Def` which is a subclass of VPValue.

	VPValue (Value UV, VPDef Def)
	Create a VPValue for a `Def` which defines multiple values.

	VPValue (const VPValue &)=delete

VPValue &	operator= (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).

unsigned	getNumUsers () const

void	addUser (VPUser &User)

void	removeUser (VPUser &User)
	Remove a single `User` from the list of users.

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.

void	replaceAllUsesWith (VPValue *New)

VPRecipeBase *	getDefiningRecipe ()
	Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe, i.e.

const VPRecipeBase *	getDefiningRecipe () const

bool	hasDefiningRecipe () const
	Returns true if this VPValue is defined by a recipe.

bool	isLiveIn () const
	Returns true if this VPValue is a live-in, i.e. defined outside the VPlan.

Value *	getLiveInIRValue ()
	Returns the underlying IR value, if this VPValue is defined outside the scope of VPlan.

const Value *	getLiveInIRValue () const

bool	isDefinedOutsideVectorRegions () const
	Returns true if the VPValue is defined outside any vector regions, i.e.

Protected Member Functions
void	setUnderlyingInstr (Instruction *I)

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

	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)

Friends
class	VPlanSlp

Additional Inherited Members
Static Public Member Functions inherited from llvm::VPRecipeWithIRFlags
static bool	classof (const VPRecipeBase *R)

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.

static bool	classof (const VPUser *U)

Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< T, Options... >::type >
using	self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, false, false >

using	const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, false, true >

using	reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, true, false >

using	const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< T, Options... >::type, true, true >

Protected Attributes inherited from llvm::VPValue
Value *	UnderlyingVal

VPDef *	Def
	Pointer to the VPDef that defines this VPValue.

Detailed Description

This is a concrete Recipe that models a single VPlan-level instruction.

While as any Recipe it may generate a sequence of IR instructions when executed, these instructions would always form a single-def expression as the VPInstruction is also a single def-use vertex.

Definition at line 1018 of file VPlan.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

VPlan opcodes, extending LLVM IR with idiomatics instructions.

Enumerator
FirstOrderRecurrenceSplice
Not
SLPLoad
SLPStore
ActiveLaneMask
CalculateTripCountMinusVF
CanonicalIVIncrement
CanonicalIVIncrementForPart
BranchOnCount
BranchOnCond

Definition at line 1023 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPInstruction() [1/5]

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

inline

Definition at line 1063 of file VPlan.h.

◆ VPInstruction() [2/5]

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

inline

Definition at line 1068 of file VPlan.h.

◆ VPInstruction() [3/5]

VPInstruction::VPInstruction	(	unsigned	Opcode,
		CmpInst::Predicate	Pred,
		VPValue *	A,
		VPValue *	B,
		DebugLoc	DL = `{}`,
		const Twine &	Name = `""`
	)

Definition at line 249 of file VPlanRecipes.cpp.

References A, and B.

◆ VPInstruction() [4/5]

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

inline

Definition at line 1075 of file VPlan.h.

◆ VPInstruction() [5/5]

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

Definition at line 259 of file VPlanRecipes.cpp.

References assert().

Member Function Documentation

◆ dump()

void VPInstruction::dump ( ) const

Print the VPInstruction to dbgs() (for debugging).

Definition at line 440 of file VPlanRecipes.cpp.

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

◆ execute()

void VPInstruction::execute ( VPTransformState & State )

overridevirtual

Generate the instruction.

TODO: We currently execute only per-part unless a specific instance is provided.

Implements llvm::VPRecipeBase.

Definition at line 422 of file VPlanRecipes.cpp.

References assert(), llvm::VPTransformState::Builder, llvm::VPRecipeWithIRFlags::getFastMathFlags(), getOpcode(), llvm::VPRecipeWithIRFlags::hasFastMathFlags(), hasResult(), llvm::VPTransformState::Instance, llvm::VPTransformState::set(), llvm::IRBuilderBase::setFastMathFlags(), and llvm::VPTransformState::UF.

◆ getOpcode()

unsigned llvm::VPInstruction::getOpcode ( ) const

inline

Definition at line 1085 of file VPlan.h.

Referenced by canSimplifyBranchOnCond(), execute(), hasResult(), onlyFirstLaneUsed(), and print().

◆ hasResult()

bool llvm::VPInstruction::hasResult ( ) const

inline

Definition at line 1109 of file VPlan.h.

References BranchOnCond, BranchOnCount, and getOpcode().

Referenced by execute(), and print().

◆ mayWriteToMemory()

bool llvm::VPInstruction::mayWriteToMemory ( ) const

inline

Return true if this instruction may modify memory.

Definition at line 1102 of file VPlan.h.

References SLPStore.

◆ onlyFirstLaneUsed()

bool llvm::VPInstruction::onlyFirstLaneUsed ( const VPValue * Op ) const

inlineoverridevirtual

Returns true if the recipe only uses the first lane of operand Op.

Reimplemented from llvm::VPUser.

Definition at line 1132 of file VPlan.h.

References ActiveLaneMask, assert(), BranchOnCount, CalculateTripCountMinusVF, CanonicalIVIncrement, CanonicalIVIncrementForPart, getOpcode(), llvm::VPUser::getOperand(), llvm::is_contained(), llvm_unreachable, and llvm::VPUser::operands().

◆ print()

void VPInstruction::print	(	raw_ostream &	O,
		const Twine &	Indent,
		VPSlotTracker &	SlotTracker
	)		const

overridevirtual

Print the VPInstruction to O.

Implements llvm::VPDef.

Definition at line 445 of file VPlanRecipes.cpp.

References ActiveLaneMask, BranchOnCond, BranchOnCount, CalculateTripCountMinusVF, CanonicalIVIncrement, CanonicalIVIncrementForPart, DL, FirstOrderRecurrenceSplice, llvm::VPRecipeBase::getDebugLoc(), getOpcode(), llvm::Instruction::getOpcodeName(), hasResult(), Not, llvm::MachineBasicBlock::print(), llvm::VPValue::printAsOperand(), llvm::VPRecipeWithIRFlags::printFlags(), llvm::VPUser::printOperands(), SLPLoad, and SLPStore.

Referenced by dump().

◆ setUnderlyingInstr()

void llvm::VPInstruction::setUnderlyingInstr ( Instruction * I )

inlineprotected

Definition at line 1060 of file VPlan.h.

References I, and llvm::VPValue::setUnderlyingValue().

Friends And Related Function Documentation

◆ VPlanSlp

friend class VPlanSlp

friend

Definition at line 1019 of file VPlan.h.

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

lib/Transforms/Vectorize/VPlan.h
lib/Transforms/Vectorize/VPlanRecipes.cpp

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ VPInstruction() [1/5]

◆ VPInstruction() [2/5]

◆ VPInstruction() [3/5]

◆ VPInstruction() [4/5]

◆ VPInstruction() [5/5]

Member Function Documentation

◆ dump()

◆ execute()

◆ getOpcode()

◆ hasResult()

◆ mayWriteToMemory()

◆ onlyFirstLaneUsed()

◆ print()

◆ setUnderlyingInstr()

Friends And Related Function Documentation

◆ VPlanSlp