VPTransformState holds information passed down when "executing" a VPlan, needed for generating the output IR. More...

#include "Transforms/Vectorize/VPlan.h"

Collaboration diagram for llvm::VPTransformState:

[legend]

Classes
struct	CFGState
	Hold state information used when constructing the CFG of the output IR, traversing the VPBasicBlocks and generating corresponding IR BasicBlocks. More...

struct	DataState

Public Member Functions
	VPTransformState (ElementCount VF, unsigned UF, LoopInfo LI, DominatorTree DT, IRBuilderBase &Builder, InnerLoopVectorizer ILV, VPlan Plan)

Value *	get (VPValue *Def, unsigned Part)
	Get the generated Value for a given VPValue and a given Part.

Value *	get (VPValue *Def, const VPIteration &Instance)
	Get the generated Value for a given VPValue and given Part and Lane.

bool	hasVectorValue (VPValue *Def, unsigned Part)

bool	hasAnyVectorValue (VPValue *Def) const

bool	hasScalarValue (VPValue *Def, VPIteration Instance)

void	set (VPValue Def, Value V, unsigned Part)
	Set the generated Value for a given VPValue and a given Part.

void	reset (VPValue Def, Value V, unsigned Part)
	Reset an existing vector value for `Def` and a given `Part`.

void	set (VPValue Def, Value V, const VPIteration &Instance)
	Set the generated scalar `V` for `Def` and the given `Instance`.

void	reset (VPValue Def, Value V, const VPIteration &Instance)
	Reset an existing scalar value for `Def` and a given `Instance`.

void	addNewMetadata (Instruction To, const Instruction Orig)
	Add additional metadata to `To` that was not present on `Orig`.

void	addMetadata (Instruction To, Instruction From)
	Add metadata from one instruction to another.

void	addMetadata (ArrayRef< Value * > To, Instruction *From)
	Similar to the previous function but it adds the metadata to a vector of instructions.

void	setDebugLocFromInst (const Value *V)
	Set the debug location in the builder using the debug location in `V`.

Public Attributes
ElementCount	VF
	The chosen Vectorization and Unroll Factors of the loop being vectorized.

unsigned	UF

std::optional< VPIteration >	Instance
	Hold the indices to generate specific scalar instructions.

struct llvm::VPTransformState::DataState	Data

struct llvm::VPTransformState::CFGState	CFG

LoopInfo *	LI
	Hold a pointer to LoopInfo to register new basic blocks in the loop.

DominatorTree *	DT
	Hold a pointer to Dominator Tree to register new basic blocks in the loop.

IRBuilderBase &	Builder
	Hold a reference to the IRBuilder used to generate output IR code.

VPValue2ValueTy	VPValue2Value

Value *	CanonicalIV = nullptr
	Hold the canonical scalar IV of the vector loop (start=0, step=VF*UF).

InnerLoopVectorizer *	ILV
	Hold a pointer to InnerLoopVectorizer to reuse its IR generation methods.

VPlan *	Plan
	Pointer to the VPlan code is generated for.

SmallPtrSet< VPRecipeBase *, 16 >	MayGeneratePoisonRecipes
	Holds recipes that may generate a poison value that is used after vectorization, even when their operands are not poison.

Loop *	CurrentVectorLoop = nullptr
	The loop object for the current parent region, or nullptr.

std::unique_ptr< LoopVersioning >	LVer
	LoopVersioning.

Detailed Description

VPTransformState holds information passed down when "executing" a VPlan, needed for generating the output IR.

Definition at line 206 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPTransformState()

llvm::VPTransformState::VPTransformState	(	ElementCount	VF,
		unsigned	UF,
		LoopInfo *	LI,
		DominatorTree *	DT,
		IRBuilderBase &	Builder,
		InnerLoopVectorizer *	ILV,
		VPlan *	Plan
	)

inline

Definition at line 207 of file VPlan.h.

Member Function Documentation

◆ addMetadata() [1/2]

void VPTransformState::addMetadata	(	ArrayRef< Value * >	To,
		Instruction *	From
	)

Similar to the previous function but it adds the metadata to a vector of instructions.

Definition at line 250 of file VPlan.cpp.

References addMetadata(), From, and I.

◆ addMetadata() [2/2]

void VPTransformState::addMetadata	(	Instruction *	To,
		Instruction *	From
	)

Add metadata from one instruction to another.

This includes both the original MDs from From and additional ones (

See also: addNewMetadata). Use this for newly created instructions in the vector loop.

Definition at line 245 of file VPlan.cpp.

References addNewMetadata(), From, and llvm::propagateMetadata().

Referenced by addMetadata(), llvm::VPWidenRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenSelectRecipe::execute(), llvm::VPWidenGEPRecipe::execute(), llvm::VPWidenIntOrFpInductionRecipe::execute(), and llvm::VPWidenMemoryInstructionRecipe::execute().

◆ addNewMetadata()

void VPTransformState::addNewMetadata	(	Instruction *	To,
		const Instruction *	Orig
	)

Add additional metadata to To that was not present on Orig.

Currently this is used to add the noalias annotations based on the inserted memchecks. Use this for instructions that are cloned into the vector loop.

Definition at line 237 of file VPlan.cpp.

References LVer.

Referenced by addMetadata(), and llvm::InnerLoopVectorizer::scalarizeInstruction().

◆ get() [1/2]

Value * VPTransformState::get	(	VPValue *	Def,
		const VPIteration &	Instance
	)

Get the generated Value for a given VPValue and given Part and Lane.

Definition at line 211 of file VPlan.cpp.

References assert(), Builder, llvm::IRBuilderBase::CreateExtractElement(), Data, hasScalarValue(), hasVectorValue(), Instance, llvm::VPTransformState::DataState::PerPartOutput, llvm::VPTransformState::DataState::PerPartScalars, and VF.

◆ get() [2/2]

Value * VPTransformState::get	(	VPValue *	Def,
		unsigned	Part
	)

Get the generated Value for a given VPValue and a given Part.

Note that as some Defs are still created by ILV and managed in its ValueMap, this method will delegate the call to ILV in such cases in order to provide callers a consistent API.