Inheritance diagram for mlir::impl::CanonicalizerBase< DerivedT >:

Public Types
using	Base = CanonicalizerBase

Public Member Functions
	CanonicalizerBase ()
	CanonicalizerBase (const CanonicalizerBase &other)
CanonicalizerBase &	operator= (const CanonicalizerBase &)=delete
	CanonicalizerBase (CanonicalizerBase &&)=delete
CanonicalizerBase &	operator= (CanonicalizerBase &&)=delete
	~CanonicalizerBase ()=default
::llvm::StringRef	getArgument () const override
	Return the command line argument used when registering this pass.
::llvm::StringRef	getDescription () const override
	Return the command line description used when registering this pass.
::llvm::StringRef	getName () const override
	Returns the derived pass name.
std::unique_ptr<::mlir::Pass >	clonePass () const override
	A clone method to create a copy of this pass.
void	getDependentDialects (::mlir::DialectRegistry &registry) const override
	Return the dialect that must be loaded in the context before this pass.
	CanonicalizerBase (CanonicalizerOptions options)
	Explicitly declare the TypeID for this class.
Public Member Functions inherited from mlir::OperationPass< OpT >
	~OperationPass () override=default
Public Member Functions inherited from mlir::Pass
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 void	getDependentDialects (DialectRegistry &registry) const
	Register dependent dialects for the current 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.

Static Public Member Functions
static constexpr ::llvm::StringLiteral	getArgumentName ()
	Returns the command-line argument attached to this pass.
static constexpr ::llvm::StringLiteral	getPassName ()
	Returns the derived pass name.
static bool	classof (const ::mlir::Pass *pass)
	Support isa/dyn_cast functionality for the derived pass class.

Protected Attributes
::mlir::Pass::Option< bool >	topDownProcessingEnabled {*this, "top-down", ::llvm::cl::desc(R"PO(Seed the worklist in general top-down order)PO"), ::llvm::cl::init(true)}
::mlir::Pass::Option< mlir::GreedySimplifyRegionLevel >	regionSimplifyLevel
::mlir::Pass::Option< int64_t >	maxIterations {*this, "max-iterations", ::llvm::cl::desc(R"PO(Max. iterations between applying patterns / simplifying regions)PO"), ::llvm::cl::init(10)}
::mlir::Pass::Option< int64_t >	maxNumRewrites {*this, "max-num-rewrites", ::llvm::cl::desc(R"PO(Max. number of pattern rewrites within an iteration)PO"), ::llvm::cl::init(-1)}
::mlir::Pass::Option< bool >	testConvergence {*this, "test-convergence", ::llvm::cl::desc(R"PO(Test only: Fail pass on non-convergence to detect cyclic pattern)PO"), ::llvm::cl::init(false)}
::mlir::Pass::ListOption< std::string >	disabledPatterns {*this, "disable-patterns", ::llvm::cl::desc(R"PO(Labels of patterns that should be filtered out during application)PO")}
::mlir::Pass::ListOption< std::string >	enabledPatterns {*this, "enable-patterns", ::llvm::cl::desc(R"PO(Labels of patterns that should be used during application, all other patterns are filtered out)PO")}

Additional Inherited Members
Protected Member Functions inherited from mlir::OperationPass< OpT >
	OperationPass (TypeID passID)
	OperationPass (const OperationPass &)=default
OperationPass &	operator= (const OperationPass &)=delete
	OperationPass (OperationPass &&)=delete
OperationPass &	operator= (OperationPass &&)=delete
bool	canScheduleOn (RegisteredOperationName opName) const final
	Indicate if the current pass can be scheduled on the given operation type.
OpT	getOperation ()
	Return the current operation being transformed.
template<typename AnalysisT>
AnalysisT &	getAnalysis ()
	Query an analysis for the current operation of the specific derived operation type.
Protected Member Functions inherited from mlir::Pass
	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.
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.
void	copyOptionValuesFrom (const Pass *other)
	Copy the option values from 'other', which is another instance of this pass.
Static Protected Member Functions inherited from mlir::OperationPass< OpT >
static bool	classof (const Pass *pass)
	Support isa/dyn_cast functionality.

Detailed Description

template<typename DerivedT>
class mlir::impl::CanonicalizerBase< DerivedT >

Definition at line 188 of file Canonicalizer.cpp.

Member Typedef Documentation

◆ Base

template<typename DerivedT>

using mlir::impl::CanonicalizerBase< DerivedT >::Base = CanonicalizerBase

Definition at line 190 of file Canonicalizer.cpp.

Constructor & Destructor Documentation

◆ CanonicalizerBase() [1/4]

template<typename DerivedT>

mlir::impl::CanonicalizerBase< DerivedT >::CanonicalizerBase ( )

inline

Definition at line 192 of file Canonicalizer.cpp.

◆ CanonicalizerBase() [2/4]

template<typename DerivedT>

mlir::impl::CanonicalizerBase< DerivedT >::CanonicalizerBase ( const CanonicalizerBase< DerivedT > & other )

inline

Definition at line 193 of file Canonicalizer.cpp.

◆ CanonicalizerBase() [3/4]

template<typename DerivedT>

mlir::impl::CanonicalizerBase< DerivedT >::CanonicalizerBase ( CanonicalizerBase< DerivedT > && )

delete

◆ ~CanonicalizerBase()

template<typename DerivedT>

mlir::impl::CanonicalizerBase< DerivedT >::~CanonicalizerBase ( )

default

◆ CanonicalizerBase() [4/4]

template<typename DerivedT>

mlir::impl::CanonicalizerBase< DerivedT >::CanonicalizerBase ( CanonicalizerOptions options )

inline

Explicitly declare the TypeID for this class.

We declare an explicit private instantiation because Pass classes should only be visible by the current library.

Definition at line 233 of file Canonicalizer.cpp.

Member Function Documentation

◆ classof()

template<typename DerivedT>

bool mlir::impl::CanonicalizerBase< DerivedT >::classof ( const ::mlir::Pass * pass )

inlinestatic

Support isa/dyn_cast functionality for the derived pass class.

Definition at line 214 of file Canonicalizer.cpp.

◆ clonePass()

template<typename DerivedT>

std::unique_ptr<::mlir::Pass > mlir::impl::CanonicalizerBase< DerivedT >::clonePass ( ) const

inlineoverridevirtual

A clone method to create a copy of this pass.

Implements mlir::Pass.

Definition at line 219 of file Canonicalizer.cpp.

◆ getArgument()

template<typename DerivedT>

::llvm::StringRef mlir::impl::CanonicalizerBase< DerivedT >::getArgument ( ) const

inlineoverridevirtual

Return the command line argument used when registering this pass.

Return an empty string if one does not exist.

Reimplemented from mlir::Pass.

Definition at line 203 of file Canonicalizer.cpp.

◆ getArgumentName()

template<typename DerivedT>

constexpr ::llvm::StringLiteral mlir::impl::CanonicalizerBase< DerivedT >::getArgumentName ( )

inlinestatic

Returns the command-line argument attached to this pass.

Definition at line 200 of file Canonicalizer.cpp.

◆ getDependentDialects()

template<typename DerivedT>

void mlir::impl::CanonicalizerBase< DerivedT >::getDependentDialects ( ::mlir::DialectRegistry & registry ) const

inlineoverride

Return the dialect that must be loaded in the context before this pass.

Definition at line 224 of file Canonicalizer.cpp.

◆ getDescription()

template<typename DerivedT>

::llvm::StringRef mlir::impl::CanonicalizerBase< DerivedT >::getDescription ( ) const

inlineoverridevirtual

Return the command line description used when registering this pass.

Return an empty string if one does not exist.

Reimplemented from mlir::Pass.

Definition at line 205 of file Canonicalizer.cpp.

◆ getName()

template<typename DerivedT>

::llvm::StringRef mlir::impl::CanonicalizerBase< DerivedT >::getName ( ) const

inlineoverridevirtual

Returns the derived pass name.

Implements mlir::Pass.

Definition at line 211 of file Canonicalizer.cpp.

◆ getPassName()

template<typename DerivedT>

constexpr ::llvm::StringLiteral mlir::impl::CanonicalizerBase< DerivedT >::getPassName ( )

inlinestatic

Returns the derived pass name.

Definition at line 208 of file Canonicalizer.cpp.

◆ operator=() [1/2]

template<typename DerivedT>

CanonicalizerBase & mlir::impl::CanonicalizerBase< DerivedT >::operator= ( CanonicalizerBase< DerivedT > && )

delete

◆ operator=() [2/2]

template<typename DerivedT>

CanonicalizerBase & mlir::impl::CanonicalizerBase< DerivedT >::operator= ( const CanonicalizerBase< DerivedT > & )

delete

Member Data Documentation

◆ disabledPatterns

template<typename DerivedT>

::mlir::Pass::ListOption<std::string> mlir::impl::CanonicalizerBase< DerivedT >::disabledPatterns {*this, "disable-patterns", ::llvm::cl::desc(R"PO(Labels of patterns that should be filtered out during application)PO")}

protected

Definition at line 255 of file Canonicalizer.cpp.

◆ enabledPatterns

template<typename DerivedT>

::mlir::Pass::ListOption<std::string> mlir::impl::CanonicalizerBase< DerivedT >::enabledPatterns {*this, "enable-patterns", ::llvm::cl::desc(R"PO(Labels of patterns that should be used during application, all other patterns are filtered out)PO")}

protected

Definition at line 256 of file Canonicalizer.cpp.

◆ maxIterations

template<typename DerivedT>

::mlir::Pass::Option<int64_t> mlir::impl::CanonicalizerBase< DerivedT >::maxIterations {*this, "max-iterations", ::llvm::cl::desc(R"PO(Max. iterations between applying patterns / simplifying regions)PO"), ::llvm::cl::init(10)}

protected

Definition at line 252 of file Canonicalizer.cpp.

◆ maxNumRewrites

template<typename DerivedT>

::mlir::Pass::Option<int64_t> mlir::impl::CanonicalizerBase< DerivedT >::maxNumRewrites {*this, "max-num-rewrites", ::llvm::cl::desc(R"PO(Max. number of pattern rewrites within an iteration)PO"), ::llvm::cl::init(-1)}

protected

Definition at line 253 of file Canonicalizer.cpp.

◆ regionSimplifyLevel

template<typename DerivedT>

::mlir::Pass::Option<mlir::GreedySimplifyRegionLevel> mlir::impl::CanonicalizerBase< DerivedT >::regionSimplifyLevel

protected

Initial value:

{*this, "region-simplify", ::llvm::cl::desc(R"PO(Perform control flow optimizations to the region tree)PO"), ::llvm::cl::init(mlir::GreedySimplifyRegionLevel::Normal), ::llvm::cl::values(
               clEnumValN(mlir::GreedySimplifyRegionLevel::Disabled, "disabled",
                "Don't run any control-flow simplification."),
               clEnumValN(mlir::GreedySimplifyRegionLevel::Normal, "normal",
                "Perform simple control-flow simplifications (e.g. dead args elimination)."),
               clEnumValN(mlir::GreedySimplifyRegionLevel::Aggressive, "aggressive",
                "Perform aggressive control-flow simplification (e.g. block merging).")
              )}

Definition at line 244 of file Canonicalizer.cpp.

◆ testConvergence

template<typename DerivedT>

::mlir::Pass::Option<bool> mlir::impl::CanonicalizerBase< DerivedT >::testConvergence {*this, "test-convergence", ::llvm::cl::desc(R"PO(Test only: Fail pass on non-convergence to detect cyclic pattern)PO"), ::llvm::cl::init(false)}

protected

Definition at line 254 of file Canonicalizer.cpp.

◆ topDownProcessingEnabled

template<typename DerivedT>

::mlir::Pass::Option<bool> mlir::impl::CanonicalizerBase< DerivedT >::topDownProcessingEnabled {*this, "top-down", ::llvm::cl::desc(R"PO(Seed the worklist in general top-down order)PO"), ::llvm::cl::init(true)}

protected

Definition at line 243 of file Canonicalizer.cpp.

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

lib/Transforms/Canonicalizer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ CanonicalizerBase() [1/4]

◆ CanonicalizerBase() [2/4]

◆ CanonicalizerBase() [3/4]

◆ ~CanonicalizerBase()

◆ CanonicalizerBase() [4/4]

Member Function Documentation

◆ classof()

◆ clonePass()

◆ getArgument()

◆ getArgumentName()

◆ getDependentDialects()

◆ getDescription()

◆ getName()

◆ getPassName()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ disabledPatterns

◆ enabledPatterns

◆ maxIterations

◆ maxNumRewrites

◆ regionSimplifyLevel

◆ testConvergence

◆ topDownProcessingEnabled