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

#include "Transforms/Vectorize/VPlan.h"

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 (const TargetTransformInfo TTI, ElementCount VF, unsigned UF, LoopInfo LI, DominatorTree DT, IRBuilderBase &Builder, InnerLoopVectorizer ILV, VPlan Plan, Loop CurrentParentLoop, Type *CanonicalIVTy)

Value *	get (VPValue *Def, bool IsScalar=false)
	Get the generated vector Value for a given VPValue `Def` if `IsScalar` is false, otherwise return the generated scalar.

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

bool	hasVectorValue (VPValue *Def)

bool	hasScalarValue (VPValue *Def, VPLane Lane)

void	set (VPValue Def, Value V, bool IsScalar=false)
	Set the generated vector Value for a given VPValue, if `IsScalar` is false.

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

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

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

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

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

void	setDebugLocFrom (DebugLoc DL)
	Set the debug location in the builder using the debug location `DL`.

void	packScalarIntoVectorValue (VPValue *Def, const VPLane &Lane)
	Construct the vector value of a scalarized value `V` one lane at a time.

Public Attributes
const TargetTransformInfo *	TTI
	Target Transform Info.

ElementCount	VF
	The chosen Vectorization Factor of the loop being vectorized.

std::optional< VPLane >	Lane
	Hold the index 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.

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

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

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

Loop *	CurrentParentLoop = nullptr
	The parent loop object for the current scope, or nullptr.

LoopVersioning *	LVer = nullptr
	LoopVersioning.

DenseMap< const SCEV , Value >	ExpandedSCEVs
	Map SCEVs to their expanded values.

VPTypeAnalysis	TypeAnalysis
	VPlan-based type analysis.

Detailed Description

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

Definition at line 236 of file VPlan.h.

Constructor & Destructor Documentation

◆ VPTransformState()

VPTransformState::VPTransformState	(	const TargetTransformInfo *	TTI,
		ElementCount	VF,
		unsigned	UF,
		LoopInfo *	LI,
		DominatorTree *	DT,
		IRBuilderBase &	Builder,
		InnerLoopVectorizer *	ILV,
		VPlan *	Plan,
		Loop *	CurrentParentLoop,
		Type *	CanonicalIVTy
	)

Definition at line 215 of file VPlan.cpp.

Member Function Documentation

◆ addMetadata()

void VPTransformState::addMetadata	(	Value *	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 361 of file VPlan.cpp.

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

Referenced by llvm::VPWidenRecipe::execute(), llvm::VPWidenCastRecipe::execute(), llvm::VPWidenIntrinsicRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenSelectRecipe::execute(), llvm::VPWidenGEPRecipe::execute(), llvm::VPWidenIntOrFpInductionRecipe::execute(), llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), and llvm::VPWidenEVLRecipe::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 353 of file VPlan.cpp.

References llvm::LoopVersioning::annotateInstWithNoAlias(), and LVer.

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