llvm::LoopVectorizeHints Class Reference

Utility class for getting and setting loop vectorizer hints in the form of loop metadata. More...

#include "llvm/Transforms/Vectorize/LoopVectorizationLegality.h"

Public Types
enum	ForceKind { FK_Undefined = -1, FK_Disabled = 0, FK_Enabled = 1 }

Public Member Functions
	LoopVectorizeHints (const Loop *L, bool InterleaveOnlyWhenForced, OptimizationRemarkEmitter &ORE)
void	setAlreadyVectorized ()
	Mark the loop L as already vectorized by setting the width to 1. More...
bool	allowVectorization (Function *F, Loop *L, bool VectorizeOnlyWhenForced) const
void	emitRemarkWithHints () const
	Dumps all the hint information. More...
unsigned	getWidth () const
unsigned	getInterleave () const
unsigned	getIsVectorized () const
enum ForceKind	getForce () const
const char *	vectorizeAnalysisPassName () const
	If hints are provided that force vectorization, use the AlwaysPrint pass name to force the frontend to print the diagnostic. More...
bool	allowReordering () const
bool	isPotentiallyUnsafe () const
void	setPotentiallyUnsafe ()

Detailed Description

Utility class for getting and setting loop vectorizer hints in the form of loop metadata.

This class keeps a number of loop annotations locally (as member variables) and can, upon request, write them back as metadata on the loop. It will initially scan the loop for existing metadata, and will update the local values based on information in the loop. We cannot write all values to metadata, as the mere presence of some info, for example 'force', means a decision has been made. So, we need to be careful NOT to add them if the user hasn't specifically asked so.

Definition at line 58 of file LoopVectorizationLegality.h.

Member Enumeration Documentation

ForceKind

enum llvm::LoopVectorizeHints::ForceKind

Enumerator
FK_Undefined	Not selected.
FK_Disabled	Forcing disabled.
FK_Enabled	Forcing enabled.

Definition at line 92 of file LoopVectorizationLegality.h.

Constructor & Destructor Documentation

LoopVectorizeHints()

llvm::LoopVectorizeHints::LoopVectorizeHints	(	const Loop *	L,
		bool	InterleaveOnlyWhenForced,
		OptimizationRemarkEmitter &	ORE
	)

Definition at line 83 of file LoopVectorizationLegality.cpp.

References llvm::dbgs(), llvm::VectorizerParams::isInterleaveForced(), LLVM_DEBUG, and llvm::VectorizerParams::VectorizationInterleave.

Member Function Documentation

allowReordering()

bool llvm::LoopVectorizeHints::allowReordering ( ) const

inline

Definition at line 128 of file LoopVectorizationLegality.h.

References FK_Enabled, getForce(), and getWidth().

Referenced by llvm::LoopVectorizationRequirements::doesNotMeet().

allowVectorization()

bool llvm::LoopVectorizeHints::allowVectorization	(	Function *	F,
		Loop *	L,
		bool	VectorizeOnlyWhenForced
	)		const

Definition at line 106 of file LoopVectorizationLegality.cpp.

References llvm::dbgs(), llvm::OptimizationRemarkEmitter::emit(), emitRemarkWithHints(), FK_Disabled, FK_Enabled, getForce(), llvm::LoopBase< BlockT, LoopT >::getHeader(), getIsVectorized(), llvm::Loop::getStartLoc(), LLVM_DEBUG, and vectorizeAnalysisPassName().

Referenced by setAlreadyVectorized().

emitRemarkWithHints()

void llvm::LoopVectorizeHints::emitRemarkWithHints

(

)

const

Dumps all the hint information.

Definition at line 139 of file LoopVectorizationLegality.cpp.

References FK_Disabled, FK_Enabled, and LV_NAME.

Referenced by allowVectorization(), and setAlreadyVectorized().

getForce()

enum ForceKind llvm::LoopVectorizeHints::getForce ( ) const

inline

Definition at line 117 of file LoopVectorizationLegality.h.

References FK_Disabled, FK_Undefined, llvm::hasDisableAllTransformsHint(), and vectorizeAnalysisPassName().

Referenced by allowReordering(), allowVectorization(), isPotentiallyUnsafe(), processLoopInVPlanNativePath(), and vectorizeAnalysisPassName().

getInterleave()

unsigned llvm::LoopVectorizeHints::getInterleave ( ) const

inline

Definition at line 115 of file LoopVectorizationLegality.h.

getIsVectorized()

unsigned llvm::LoopVectorizeHints::getIsVectorized ( ) const

inline

Definition at line 116 of file LoopVectorizationLegality.h.

Referenced by allowVectorization().

getWidth()

unsigned llvm::LoopVectorizeHints::getWidth ( ) const

inline

Definition at line 114 of file LoopVectorizationLegality.h.

Referenced by allowReordering(), processLoopInVPlanNativePath(), and vectorizeAnalysisPassName().

isPotentiallyUnsafe()

bool llvm::LoopVectorizeHints::isPotentiallyUnsafe ( ) const

inline

Definition at line 137 of file LoopVectorizationLegality.h.

References FK_Enabled, and getForce().

setAlreadyVectorized()

void llvm::LoopVectorizeHints::setAlreadyVectorized ( )

inline

Mark the loop L as already vectorized by setting the width to 1.

Definition at line 102 of file LoopVectorizationLegality.h.

References allowVectorization(), emitRemarkWithHints(), and F().

Referenced by llvm::InnerLoopVectorizer::createVectorizedLoopSkeleton(), and processLoopInVPlanNativePath().

setPotentiallyUnsafe()

void llvm::LoopVectorizeHints::setPotentiallyUnsafe ( )

inline

Definition at line 146 of file LoopVectorizationLegality.h.

References Arg, and Name.

vectorizeAnalysisPassName()

const char * llvm::LoopVectorizeHints::vectorizeAnalysisPassName

(

)

const

If hints are provided that force vectorization, use the AlwaysPrint pass name to force the frontend to print the diagnostic.

Definition at line 165 of file LoopVectorizationLegality.cpp.

References llvm::OptimizationRemarkAnalysis::AlwaysPrint, Arg, llvm::AMDGPU::HSAMD::Kernel::Key::Args, assert(), C, Context, llvm::dbgs(), llvm::dyn_cast(), FK_Disabled, FK_Undefined, llvm::ConstantInt::get(), llvm::ConstantAsMetadata::get(), llvm::MDString::get(), llvm::MDNode::get(), getForce(), llvm::Type::getInt32Ty(), llvm::MDNode::getNumOperands(), llvm::MDNode::getOperand(), llvm::MDString::getString(), getWidth(), llvm::ConstantInt::getZExtValue(), H, LLVM_DEBUG, LV_NAME, Name, llvm::StringRef::npos, llvm::SmallVectorTemplateBase< T >::push_back(), llvm::SmallVectorBase::size(), llvm::size(), llvm::StringRef::startswith(), and llvm::StringRef::substr().

Referenced by allowVectorization(), llvm::LoopVectorizationRequirements::doesNotMeet(), and getForce().

---

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

• include/llvm/Transforms/Vectorize/LoopVectorizationLegality.h
• lib/Transforms/Vectorize/LoopVectorizationLegality.cpp