The abstract base pass class. More...

#include "mlir/Pass/Pass.h"

Inheritance diagram for mlir::Pass:

Classes
struct	ListOption
	This class represents a specific pass option that contains a list of values of the provided data type. More...
struct	Option
	This class represents a specific pass option, with a provided data type. More...
class	Statistic
	This class represents a single pass statistic. More...

Public Member Functions
virtual	~Pass ()=default
TypeID	getTypeID () const
	Returns the unique identifier that corresponds to this pass.
const PassInfo *	lookupPassInfo () const
	Returns the pass info for this pass, or null if unknown.
virtual StringRef	getName () const =0
	Returns the derived pass name.
virtual void	getDependentDialects (DialectRegistry &registry) const
	Register dependent dialects for the current pass.
virtual StringRef	getArgument () const
	Return the command line argument used when registering this pass.
virtual StringRef	getDescription () const
	Return the command line description used when registering this pass.
std::optional< StringRef >	getOpName () const
	Returns the name of the operation that this pass operates on, or std::nullopt if this is a generic OperationPass.
virtual LogicalResult	initializeOptions (StringRef options, function_ref< LogicalResult(const Twine &)> errorHandler)
	Attempt to initialize the options of this pass from the given string.
void	printAsTextualPipeline (raw_ostream &os, bool pretty=false)
	Prints out the pass in the textual representation of pipelines.
ArrayRef< Statistic * >	getStatistics () const
	Returns the main statistics for this pass instance.
MutableArrayRef< Statistic * >	getStatistics ()
const Pass *	getThreadingSibling () const
	Returns the thread sibling of this pass.
const Pass *	getThreadingSiblingOrThis () const
	Returns the thread sibling of this pass, or the pass itself it has no sibling.

Protected Member Functions
	Pass (TypeID passID, std::optional< StringRef > opName=std::nullopt)
	Pass (const Pass &other)
Pass &	operator= (const Pass &)=delete
	Pass (Pass &&)=delete
Pass &	operator= (Pass &&)=delete
detail::PassExecutionState &	getPassState ()
	Returns the current pass state.
MLIRContext &	getContext ()
	Return the MLIR context for the current operation being transformed.
virtual void	runOnOperation ()=0
	The polymorphic API that runs the pass over the currently held operation.
virtual LogicalResult	initialize (MLIRContext *context)
	Initialize any complex state necessary for running this pass.
virtual bool	canScheduleOn (RegisteredOperationName opName) const =0
	Indicate if the current pass can be scheduled on the given operation type.
virtual bool	canScheduleOn (Operation *op) const
LogicalResult	runPipeline (OpPassManager &pipeline, Operation *op)
	Schedule an arbitrary pass pipeline on the provided operation.
std::unique_ptr< Pass >	clone () const
	A clone method to create a copy of this pass.
Operation *	getOperation ()
	Return the current operation being transformed.
void	signalPassFailure ()
	Signal that some invariant was broken when running.
template<typename AnalysisT>
AnalysisT &	getAnalysis ()
	Query an analysis for the current ir unit.
template<typename AnalysisT, typename OpT>
AnalysisT &	getAnalysis ()
	Query an analysis for the current ir unit of a specific derived operation type.
template<typename AnalysisT>
std::optional< std::reference_wrapper< AnalysisT > >	getCachedAnalysis ()
	Query a cached instance of an analysis for the current ir unit if one exists.
void	markAllAnalysesPreserved ()
	Mark all analyses as preserved.
template<typename... AnalysesT>
void	markAnalysesPreserved ()
	Mark the provided analyses as preserved.
void	markAnalysesPreserved (TypeID id)
template<typename AnalysisT>
std::optional< std::reference_wrapper< AnalysisT > >	getCachedParentAnalysis (Operation *parent)
	Returns the analysis for the given parent operation if it exists.
template<typename AnalysisT>
std::optional< std::reference_wrapper< AnalysisT > >	getCachedParentAnalysis ()
	Returns the analysis for the parent operation if it exists.
template<typename AnalysisT>
std::optional< std::reference_wrapper< AnalysisT > >	getCachedChildAnalysis (Operation *child)
	Returns the analysis for the given child operation if it exists.
template<typename AnalysisT>
AnalysisT &	getChildAnalysis (Operation *child)
	Returns the analysis for the given child operation, or creates it if it doesn't exist.
template<typename AnalysisT, typename OpTy>
AnalysisT &	getChildAnalysis (OpTy child)
	Returns the analysis for the given child operation of specific derived operation type, or creates it if it doesn't exist.
AnalysisManager	getAnalysisManager ()
	Returns the current analysis manager.
virtual std::unique_ptr< Pass >	clonePass () const =0
	Create a copy of this pass, ignoring statistics and options.
void	copyOptionValuesFrom (const Pass *other)
	Copy the option values from 'other', which is another instance of this pass.

Friends
class	OpPassManager
	Allow access to 'clone'.
class	PassInfo
	Allow access to 'passOptions'.
class	PassInstrumentation
	Allow access to 'signalPassFailure'.

Detailed Description

The abstract base pass class.

This class contains information describing the derived pass object, e.g its kind and abstract TypeID.

Definition at line 52 of file Pass.h.

Constructor & Destructor Documentation

◆ ~Pass()

virtual mlir::Pass::~Pass ( )

virtualdefault

◆ Pass() [1/3]

mlir::Pass::Pass	(	TypeID	passID,
		std::optional< StringRef >	opName = std::nullopt )

inlineexplicitprotected

Definition at line 164 of file Pass.h.

Referenced by mlir::OperationPass< OpT >::classof(), clonePass(), copyOptionValuesFrom(), mlir::ExternalPass::ExternalPass(), getThreadingSibling(), getThreadingSiblingOrThis(), mlir::Pass::ListOption< DataType, OptionParser >::ListOption(), mlir::OperationPass< OpT >::OperationPass(), mlir::OperationPass< void >::OperationPass(), operator=(), operator=(), mlir::Pass::Option< DataType, OptionParser >::Option(), Pass(), Pass(), and mlir::Pass::Statistic::Statistic().

◆ Pass() [2/3]

mlir::Pass::Pass ( const Pass & other )

inlineprotected

Definition at line 166 of file Pass.h.

References Pass().

◆ Pass() [3/3]

mlir::Pass::Pass ( Pass && )

protecteddelete

References Pass().

Member Function Documentation

◆ canScheduleOn() [1/2]

virtual bool mlir::Pass::canScheduleOn ( Operation * op ) const

inlineprotectedvirtual

Reimplemented in mlir::InterfacePass< InterfaceT >, mlir::InterfacePass< FunctionOpInterface >, and mlir::InterfacePass< mlir::FunctionOpInterface >.

Definition at line 197 of file Pass.h.

References canScheduleOn(), mlir::Operation::getName(), and mlir::OperationName::getRegisteredInfo().

◆ canScheduleOn() [2/2]

virtual bool mlir::Pass::canScheduleOn ( RegisteredOperationName opName ) const

protectedpure virtual

Indicate if the current pass can be scheduled on the given operation type.

This is useful for generic operation passes to add restrictions on the operations they operate on.

Implemented in mlir::ExternalPass, mlir::InterfacePass< InterfaceT >, mlir::OperationPass< OpT >, mlir::OperationPass< func::FuncOp >, mlir::OperationPass< gpu::GPUModuleOp >, mlir::OperationPass< mlir::func::FuncOp >, mlir::OperationPass< mlir::LLVM::LLVMFuncOp >, mlir::OperationPass< mlir::ModuleOp >, mlir::OperationPass< ModuleOp >, mlir::OperationPass< spirv::ModuleOp >, mlir::OperationPass< void >, mlir::OperationPass<::mlir::func::FuncOp >, and mlir::OperationPass<::mlir::ModuleOp >.

Referenced by canScheduleOn().

◆ clone()

std::unique_ptr< Pass > mlir::Pass::clone ( ) const

inlineprotected

A clone method to create a copy of this pass.

Definition at line 213 of file Pass.h.

References clonePass().

◆ clonePass()

virtual std::unique_ptr< Pass > mlir::Pass::clonePass ( ) const

protectedpure virtual

Create a copy of this pass, ignoring statistics and options.

References Pass().

Referenced by clone().

◆ copyOptionValuesFrom()

void Pass::copyOptionValuesFrom ( const Pass * other )

protected

Copy the option values from 'other', which is another instance of this pass.

Definition at line 78 of file Pass.cpp.

References Pass().

◆ getAnalysis() [1/2]

template<typename AnalysisT>

AnalysisT & mlir::Pass::getAnalysis ( )

inlineprotected

Query an analysis for the current ir unit.

Definition at line 230 of file Pass.h.

References mlir::AnalysisManager::getAnalysis(), and getAnalysisManager().

Referenced by mlir::InterfacePass< InterfaceT >::getAnalysis(), and mlir::OperationPass< OpT >::getAnalysis().

◆ getAnalysis() [2/2]

template<typename AnalysisT, typename OpT>

AnalysisT & mlir::Pass::getAnalysis ( )

inlineprotected

Query an analysis for the current ir unit of a specific derived operation type.

Definition at line 237 of file Pass.h.

References mlir::AnalysisManager::getAnalysis(), and getAnalysisManager().

◆ getAnalysisManager()

AnalysisManager mlir::Pass::getAnalysisManager ( )

inlineprotected

Returns the current analysis manager.

Definition at line 298 of file Pass.h.

References mlir::detail::PassExecutionState::analysisManager, and getPassState().

Referenced by getAnalysis(), getCachedAnalysis(), getCachedChildAnalysis(), getCachedParentAnalysis(), getCachedParentAnalysis(), getChildAnalysis(), and getChildAnalysis().

◆ getArgument()

StringRef Pass::getArgument ( ) const

inlinevirtual

Return the command line argument used when registering this pass.

Return an empty string if one does not exist.

Definition at line 76 of file Pass.h.

Referenced by lookupPassInfo(), and printAsTextualPipeline().

◆ getCachedAnalysis()

template<typename AnalysisT>

std::optional< std::reference_wrapper< AnalysisT > > mlir::Pass::getCachedAnalysis ( )

inlineprotected

Query a cached instance of an analysis for the current ir unit if one exists.

Definition at line 244 of file Pass.h.

References getAnalysisManager(), and mlir::AnalysisManager::getCachedAnalysis().

◆ getCachedChildAnalysis()

template<typename AnalysisT>

std::optional< std::reference_wrapper< AnalysisT > > mlir::Pass::getCachedChildAnalysis ( Operation * child )

inlineprotected

Returns the analysis for the given child operation if it exists.

Definition at line 279 of file Pass.h.

References getAnalysisManager(), and mlir::AnalysisManager::getCachedChildAnalysis().

◆ getCachedParentAnalysis() [1/2]

template<typename AnalysisT>

std::optional< std::reference_wrapper< AnalysisT > > mlir::Pass::getCachedParentAnalysis ( )

inlineprotected

Returns the analysis for the parent operation if it exists.

Definition at line 271 of file Pass.h.

References getAnalysisManager(), mlir::AnalysisManager::getCachedParentAnalysis(), getOperation(), and mlir::Operation::getParentOp().

◆ getCachedParentAnalysis() [2/2]

template<typename AnalysisT>

std::optional< std::reference_wrapper< AnalysisT > > mlir::Pass::getCachedParentAnalysis ( Operation * parent )

inlineprotected

Returns the analysis for the given parent operation if it exists.

Definition at line 265 of file Pass.h.

References getAnalysisManager(), and mlir::AnalysisManager::getCachedParentAnalysis().

Referenced by mlir::acc::impl::ACCBindRoutineBase< DerivedT >::clonePass().

◆ getChildAnalysis() [1/2]

template<typename AnalysisT>

AnalysisT & mlir::Pass::getChildAnalysis ( Operation * child )

inlineprotected

Returns the analysis for the given child operation, or creates it if it doesn't exist.

Definition at line 286 of file Pass.h.

References getAnalysisManager(), and mlir::AnalysisManager::getChildAnalysis().

◆ getChildAnalysis() [2/2]

template<typename AnalysisT, typename OpTy>

AnalysisT & mlir::Pass::getChildAnalysis ( OpTy child )

inlineprotected

Returns the analysis for the given child operation of specific derived operation type, or creates it if it doesn't exist.

Definition at line 293 of file Pass.h.

References getAnalysisManager(), and mlir::AnalysisManager::getChildAnalysis().

◆ getContext()

MLIRContext & mlir::Pass::getContext ( )

inlineprotected

Return the MLIR context for the current operation being transformed.

Definition at line 178 of file Pass.h.

References mlir::Operation::getContext(), and getOperation().

Referenced by mlir::LLVM::impl::LLVMTargetToDataLayoutBase< DerivedT >::getDescription(), AmdgpuMaskedloadToLoadPass::runOnOperation(), and TargetToTargetFeaturesPass::runOnOperation().

◆ getDependentDialects()

virtual void mlir::Pass::getDependentDialects ( DialectRegistry & registry ) const

inlinevirtual

Register dependent dialects for the current pass.

A pass is expected to register the dialects it will create entities for (Operations, Types, Attributes), other than dialect that exists in the input. For example, a pass that converts from Linalg to Affine would register the Affine dialect but does not need to register Linalg.

Reimplemented in mlir::detail::OpToOpPassAdaptor, and mlir::ExternalPass.

Definition at line 72 of file Pass.h.

◆ getDescription()

StringRef Pass::getDescription ( ) const

inlinevirtual

Return the command line description used when registering this pass.

Return an empty string if one does not exist.

Definition at line 80 of file Pass.h.

◆ getName()

virtual StringRef mlir::Pass::getName ( ) const

pure virtual

Returns the derived pass name.

Referenced by printAsTextualPipeline(), and printIRHeader().

◆ getOperation()

Operation * mlir::Pass::getOperation ( )

inlineprotected

Return the current operation being transformed.

Definition at line 220 of file Pass.h.

References getPassState(), and mlir::detail::PassExecutionState::irAndPassFailed.

Referenced by getCachedParentAnalysis(), getContext(), mlir::InterfacePass< InterfaceT >::getOperation(), mlir::OperationPass< OpT >::getOperation(), and mlir::ExternalPass::runOnOperation().

◆ getOpName()

std::optional< StringRef > mlir::Pass::getOpName ( ) const

inline

Returns the name of the operation that this pass operates on, or std::nullopt if this is a generic OperationPass.

Definition at line 84 of file Pass.h.

Referenced by mlir::ExternalPass::canScheduleOn(), mlir::OperationPass< OpT >::canScheduleOn(), mlir::OperationPass< OpT >::classof(), and mlir::ExternalPass::clonePass().

◆ getPassState()

detail::PassExecutionState & mlir::Pass::getPassState ( )

inlineprotected

Returns the current pass state.

Definition at line 172 of file Pass.h.

Referenced by getAnalysisManager(), getOperation(), markAllAnalysesPreserved(), markAnalysesPreserved(), markAnalysesPreserved(), and signalPassFailure().

◆ getStatistics() [1/2]

MutableArrayRef< Statistic * > mlir::Pass::getStatistics ( )

inline

Definition at line 146 of file Pass.h.

◆ getStatistics() [2/2]

ArrayRef< PassStatistic > Pass::getStatistics ( ) const

inline

Returns the main statistics for this pass instance.

Definition at line 145 of file Pass.h.

◆ getThreadingSibling()

const Pass * mlir::Pass::getThreadingSibling ( ) const

inline

Returns the thread sibling of this pass.

If this pass was cloned by the pass manager for the sake of multi-threading, this function returns the original pass it was cloned from. This is useful for diagnostic purposes to distinguish passes that were replicated for threading purposes from passes instantiated by the user. Used to collapse passes in timing statistics.

Definition at line 155 of file Pass.h.

References Pass().

◆ getThreadingSiblingOrThis()

const Pass * mlir::Pass::getThreadingSiblingOrThis ( ) const

inline

Returns the thread sibling of this pass, or the pass itself it has no sibling.

See getThreadingSibling() for details.

Definition at line 159 of file Pass.h.

References Pass().

◆ getTypeID()

TypeID mlir::Pass::getTypeID ( ) const

inline

Returns the unique identifier that corresponds to this pass.

Definition at line 57 of file Pass.h.

Referenced by mlir::PassWrapper< PassT, BaseT >::classof().

◆ initialize()

virtual LogicalResult mlir::Pass::initialize ( MLIRContext * context )

inlineprotectedvirtual

Initialize any complex state necessary for running this pass.

This hook should not rely on any state accessible during the execution of a pass. For example, getContext/getOperation/getAnalysis/etc. should not be invoked within this hook. This method is invoked after all dependent dialects for the pipeline are loaded, and is not allowed to load any further dialects (override the getDependentDialects() for this purpose instead). Returns a LogicalResult to indicate failure, in which case the pass pipeline won't execute.

Reimplemented in mlir::ExternalPass.

Definition at line 191 of file Pass.h.

References success().

◆ initializeOptions()

LogicalResult Pass::initializeOptions	(	StringRef	options,
		function_ref< LogicalResult(const Twine &)>	errorHandler )

virtual

Attempt to initialize the options of this pass from the given string.

Derived classes may override this method to hook into the point at which options are initialized, but should generally always invoke this base class variant.

Definition at line 65 of file Pass.cpp.

References options, and success().

◆ lookupPassInfo()

const PassInfo * mlir::Pass::lookupPassInfo ( ) const

inline

Returns the pass info for this pass, or null if unknown.

Definition at line 60 of file Pass.h.

References getArgument(), mlir::PassInfo::lookup(), and PassInfo.

◆ markAllAnalysesPreserved()

void mlir::Pass::markAllAnalysesPreserved ( )

inlineprotected

Mark all analyses as preserved.

Definition at line 249 of file Pass.h.

References getPassState(), mlir::detail::PreservedAnalyses::preserveAll(), and mlir::detail::PassExecutionState::preservedAnalyses.

◆ markAnalysesPreserved() [1/2]

template<typename... AnalysesT>

void mlir::Pass::markAnalysesPreserved ( )

inlineprotected

Mark the provided analyses as preserved.

Definition at line 255 of file Pass.h.

References getPassState(), mlir::detail::PreservedAnalyses::preserve(), and mlir::detail::PassExecutionState::preservedAnalyses.

◆ markAnalysesPreserved() [2/2]

void mlir::Pass::markAnalysesPreserved ( TypeID id )

inlineprotected

Definition at line 258 of file Pass.h.

References getPassState(), mlir::detail::PreservedAnalyses::preserve(), and mlir::detail::PassExecutionState::preservedAnalyses.

◆ operator=() [1/2]

Pass & mlir::Pass::operator= ( const Pass & )

protecteddelete

References Pass().

◆ operator=() [2/2]

Pass & mlir::Pass::operator= ( Pass && )

protecteddelete

References Pass().

◆ printAsTextualPipeline()

void Pass::printAsTextualPipeline	(	raw_ostream &	os,
		bool	pretty = false )

Prints out the pass in the textual representation of pipelines.

If this is an adaptor pass, print its pass managers. When pretty is true, the printed pipeline is formatted for readability.

Definition at line 85 of file Pass.cpp.

References getArgument(), getName(), and OpPassManager.

Referenced by mlir::detail::PassCrashReproducerGenerator::prepareReproducerFor(), mlir::detail::PassCrashReproducerGenerator::prepareReproducerFor(), printAsTextualPipeline(), and printIRHeader().

◆ runOnOperation()

virtual void mlir::Pass::runOnOperation ( )

protectedpure virtual

The polymorphic API that runs the pass over the currently held operation.

Implemented in AmdgpuMaskedloadToLoadPass, mlir::detail::OpToOpPassAdaptor, mlir::ExternalPass, mlir::sparse_tensor::SparsificationAndBufferizationPass, ShardingPropagation, SimplifyAffineMinMaxPass, TargetToDataLayoutPass, and TargetToTargetFeaturesPass.

◆ runPipeline()

LogicalResult mlir::Pass::runPipeline	(	OpPassManager &	pipeline,
		Operation *	op )

inlineprotected

Schedule an arbitrary pass pipeline on the provided operation.

This can be invoke any time in a pass to dynamic schedule more passes. The provided operation must be the current one or one nested below.

Definition at line 208 of file Pass.h.

References OpPassManager.

Referenced by mlir::sparse_tensor::SparsificationAndBufferizationPass::runOnOperation().

◆ signalPassFailure()

void mlir::Pass::signalPassFailure ( )

inlineprotected

Signal that some invariant was broken when running.

The IR is allowed to be in an invalid state.

Definition at line 226 of file Pass.h.

References getPassState(), and mlir::detail::PassExecutionState::irAndPassFailed.

◆ OpPassManager

friend class OpPassManager

friend

Allow access to 'clone'.

Definition at line 335 of file Pass.h.

References OpPassManager.

Referenced by mlir::detail::OpToOpPassAdaptor::getAdaptorName(), OpPassManager, mlir::detail::OpToOpPassAdaptor::OpToOpPassAdaptor(), printAsTextualPipeline(), mlir::sparse_tensor::SparsificationAndBufferizationPass::runOnOperation(), runPipeline(), and mlir::detail::OpToOpPassAdaptor::tryMergeInto().

◆ PassInfo

friend class PassInfo

friend

Allow access to 'passOptions'.

Definition at line 344 of file Pass.h.

References PassInfo.

Referenced by lookupPassInfo(), and PassInfo.

◆ PassInstrumentation

friend class PassInstrumentation

friend

Allow access to 'signalPassFailure'.

Definition at line 347 of file Pass.h.

References PassInstrumentation.

Referenced by PassInstrumentation.

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

include/mlir/Pass/Pass.h
lib/Pass/Pass.cpp
lib/TableGen/Pass.cpp

Classes

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~Pass()

◆ Pass() [1/3]

◆ Pass() [2/3]

◆ Pass() [3/3]

Member Function Documentation

◆ canScheduleOn() [1/2]

◆ canScheduleOn() [2/2]

◆ clone()

◆ clonePass()

◆ copyOptionValuesFrom()

◆ getAnalysis() [1/2]

◆ getAnalysis() [2/2]

◆ getAnalysisManager()

◆ getArgument()

◆ getCachedAnalysis()

◆ getCachedChildAnalysis()

◆ getCachedParentAnalysis() [1/2]

◆ getCachedParentAnalysis() [2/2]

◆ getChildAnalysis() [1/2]

◆ getChildAnalysis() [2/2]

◆ getContext()

◆ getDependentDialects()

◆ getDescription()

◆ getName()

◆ getOperation()

◆ getOpName()

◆ getPassState()

◆ getStatistics() [1/2]

◆ getStatistics() [2/2]

◆ getThreadingSibling()

◆ getThreadingSiblingOrThis()

◆ getTypeID()

◆ initialize()

◆ initializeOptions()

◆ lookupPassInfo()

◆ markAllAnalysesPreserved()

◆ markAnalysesPreserved() [1/2]

◆ markAnalysesPreserved() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ printAsTextualPipeline()

◆ runOnOperation()

◆ runPipeline()

◆ signalPassFailure()

Friends And Related Symbol Documentation

◆ OpPassManager

◆ PassInfo

◆ PassInstrumentation