llvm::VPIRMetadata Class Reference

Helper to manage IR metadata for recipes. More...

#include "Transforms/Vectorize/VPlan.h"

Inheritance diagram for llvm::VPIRMetadata:

Public Member Functions
	VPIRMetadata ()=default
	VPIRMetadata (Instruction &I)
	Adds metatadata that can be preserved from the original instruction I.
	VPIRMetadata (const VPIRMetadata &Other)=default
	Copy constructor for cloning.
VPIRMetadata &	operator= (const VPIRMetadata &Other)=default
void	applyMetadata (Instruction &I) const
	Add all metadata to I.
void	setMetadata (unsigned Kind, MDNode *Node)
	Set metadata with kind Kind to Node.
void	intersect (const VPIRMetadata &MD)
	Intersect this VPIRMetadata object with MD, keeping only metadata nodes that are common to both.
MDNode *	getMetadata (unsigned Kind) const
	Get metadata of kind Kind. Returns nullptr if not found.
void	setExecutionFrequency (std::optional< BlockFrequency > Freq, LLVMContext &Ctx)
	Record that the recipe executes with frequency Freq, relative to the entry of the loop region; see vputils::AlwaysExecutesFreq.
std::optional< BlockFrequency >	getExecutionFrequency () const
	Returns the frequency recorded by setExecutionFrequency, if any.
void	clearExecutionFrequency ()
	Drop the frequency recorded by setExecutionFrequency, if any.
void	print (raw_ostream &O, VPSlotTracker &SlotTracker) const
	Print metadata with node IDs.

Detailed Description

Helper to manage IR metadata for recipes.

It filters out metadata that cannot be propagated.

Definition at line 1182 of file VPlan.h.

Constructor & Destructor Documentation

VPIRMetadata() [1/3]

llvm::VPIRMetadata::VPIRMetadata ( )

default

Referenced by intersect(), operator=(), llvm::VPBranchOnMaskRecipe::VPBranchOnMaskRecipe(), llvm::VPHistogramRecipe::VPHistogramRecipe(), llvm::VPInstruction::VPInstruction(), llvm::VPInterleaveBase::VPInterleaveBase(), VPIRMetadata(), and llvm::VPWidenMemoryRecipe::VPWidenMemoryRecipe().

VPIRMetadata() [2/3]

llvm::VPIRMetadata::VPIRMetadata ( Instruction & I )

inline

Adds metatadata that can be preserved from the original instruction I.

Definition at line 1201 of file VPlan.h.

References llvm::getMetadataToPropagate(), and I.

VPIRMetadata() [3/3]

llvm::VPIRMetadata::VPIRMetadata ( const VPIRMetadata & Other )

default

Copy constructor for cloning.

References llvm::Other, and VPIRMetadata().

Member Function Documentation

applyMetadata()

void VPIRMetadata::applyMetadata

(

Instruction &

I

)

const

Add all metadata to I.

Definition at line 2129 of file VPlanRecipes.cpp.

References I.

Referenced by llvm::VPWidenIntrinsicRecipe::createVectorCall(), llvm::VPHistogramRecipe::execute(), llvm::VPInstructionWithType::execute(), llvm::VPInterleaveEVLRecipe::execute(), llvm::VPInterleaveRecipe::execute(), llvm::VPReplicateRecipe::execute(), llvm::VPWidenCallRecipe::execute(), llvm::VPWidenCastRecipe::execute(), llvm::VPWidenLoadEVLRecipe::execute(), llvm::VPWidenLoadRecipe::execute(), llvm::VPWidenRecipe::execute(), llvm::VPWidenStoreEVLRecipe::execute(), llvm::VPWidenStoreRecipe::execute(), and operator=().

clearExecutionFrequency()

void VPIRMetadata::clearExecutionFrequency

(

)

Drop the frequency recorded by setExecutionFrequency, if any.

Definition at line 2169 of file VPlanRecipes.cpp.

References llvm::erase_if(), and P.

Referenced by getCommonMetadata(), and mergeReplicateRegionsIntoSuccessors().

getExecutionFrequency()

std::optional< BlockFrequency > VPIRMetadata::getExecutionFrequency

(

)

const

Returns the frequency recorded by setExecutionFrequency, if any.

Definition at line 2160 of file VPlanRecipes.cpp.

References getExecutionFrequencyFromMD(), and getMetadata().

Referenced by mergeReplicateRegionsIntoSuccessors().

getMetadata()

MDNode * llvm::VPIRMetadata::getMetadata ( unsigned Kind ) const

inline

Get metadata of kind Kind. Returns nullptr if not found.

Definition at line 1236 of file VPlan.h.

References llvm::find_if(), and P.

Referenced by getExecutionFrequency().

intersect()

void VPIRMetadata::intersect

(

const VPIRMetadata &

MD

)

Intersect this VPIRMetadata object with MD, keeping only metadata nodes that are common to both.

Definition at line 2176 of file VPlanRecipes.cpp.

References llvm::SmallVectorImpl< T >::emplace_back(), llvm::Other, and VPIRMetadata().

Referenced by llvm::VPlanTransforms::createInterleaveGroups(), and getCommonMetadata().

operator=()

VPIRMetadata & llvm::VPIRMetadata::operator= ( const VPIRMetadata & Other )

default

References applyMetadata(), I, llvm::Other, and VPIRMetadata().

print()

void VPIRMetadata::print	(	raw_ostream &	O,
		VPSlotTracker &	SlotTracker ) const

Print metadata with node IDs.

Definition at line 2190 of file VPlanRecipes.cpp.

References llvm::vputils::AlwaysExecutesFreq, assert(), llvm::ArrayRef< T >::empty(), llvm::extractBranchWeights(), llvm::format(), getExecutionFrequencyFromMD(), llvm::BlockFrequency::getFrequency(), llvm::interleaveComma(), Node::printAsOperand(), llvm::ArrayRef< T >::size(), and VPlanPrintMetadata.

setExecutionFrequency()

void VPIRMetadata::setExecutionFrequency	(	std::optional< BlockFrequency >	Freq,
		LLVMContext &	Ctx )

Record that the recipe executes with frequency Freq, relative to the entry of the loop region; see vputils::AlwaysExecutesFreq.

Definition at line 2148 of file VPlanRecipes.cpp.

References llvm::vputils::AlwaysExecutesFreq, llvm::MDNode::get(), llvm::Type::getInt64Ty(), and setMetadata().

Referenced by mergeReplicateRegionsIntoSuccessors().

setMetadata()

void llvm::VPIRMetadata::setMetadata ( unsigned Kind, MDNode * Node )

inline

Set metadata with kind Kind to Node.

If metadata with Kind already exists, it will be replaced. Otherwise, it will be added.

Definition at line 1220 of file VPlan.h.

References llvm::find_if(), and P.

Referenced by setExecutionFrequency().

---

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

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