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

Public Types
using	Base = SparsificationAndBufferizationBase

Public Member Functions
	SparsificationAndBufferizationBase ()
	SparsificationAndBufferizationBase (const SparsificationAndBufferizationBase &other)
SparsificationAndBufferizationBase &	operator= (const SparsificationAndBufferizationBase &)=delete
	SparsificationAndBufferizationBase (SparsificationAndBufferizationBase &&)=delete
SparsificationAndBufferizationBase &	operator= (SparsificationAndBufferizationBase &&)=delete
	~SparsificationAndBufferizationBase ()=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.
	SparsificationAndBufferizationBase (SparsificationAndBufferizationOptions options)
	Explicitly declare the TypeID for this class.
Public Member Functions inherited from mlir::OperationPass< ModuleOp >
	~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< int32_t >	vectorLength {*this, "vl", ::llvm::cl::desc(R"PO(Set the vector length (use 0 to disable vectorization))PO"), ::llvm::cl::init(0)}
::mlir::Pass::Option< bool >	enableVLAVectorization {*this, "enable-vla-vectorization", ::llvm::cl::desc(R"PO(Enable vector length agnostic vectorization)PO"), ::llvm::cl::init(false)}
::mlir::Pass::Option< bool >	enableSIMDIndex32 {*this, "enable-simd-index32", ::llvm::cl::desc(R"PO(Enable i32 indexing into vectors (for efficient gather/scatter))PO"), ::llvm::cl::init(false)}
::mlir::Pass::Option< bool >	enableGPULibgen {*this, "enable-gpu-libgen", ::llvm::cl::desc(R"PO(Enable GPU acceleration by means of direct library calls)PO"), ::llvm::cl::init(false)}
::mlir::Pass::Option< mlir::SparseEmitStrategy >	sparseEmitStrategy
::mlir::Pass::Option< mlir::SparseParallelizationStrategy >	parallelization

Additional Inherited Members
Protected Member Functions inherited from mlir::OperationPass< ModuleOp >
	OperationPass (TypeID passID)
OperationPass &	operator= (const OperationPass &)=delete
bool	canScheduleOn (RegisteredOperationName opName) const final
	Indicate if the current pass can be scheduled on the given operation type.
ModuleOp	getOperation ()
	Return the current operation being transformed.
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< ModuleOp >
static bool	classof (const Pass *pass)
	Support isa/dyn_cast functionality.

Detailed Description

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

Definition at line 908 of file SparsificationAndBufferizationPass.cpp.

Member Typedef Documentation

◆ Base

template<typename DerivedT>

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

Definition at line 910 of file SparsificationAndBufferizationPass.cpp.

Constructor & Destructor Documentation

◆ SparsificationAndBufferizationBase() [1/4]

template<typename DerivedT>

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

inline

Definition at line 912 of file SparsificationAndBufferizationPass.cpp.

◆ SparsificationAndBufferizationBase() [2/4]

template<typename DerivedT>

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

inline

Definition at line 913 of file SparsificationAndBufferizationPass.cpp.

◆ SparsificationAndBufferizationBase() [3/4]

template<typename DerivedT>

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

delete

◆ ~SparsificationAndBufferizationBase()

template<typename DerivedT>

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

default

◆ SparsificationAndBufferizationBase() [4/4]

template<typename DerivedT>

mlir::impl::SparsificationAndBufferizationBase< DerivedT >::SparsificationAndBufferizationBase ( SparsificationAndBufferizationOptions 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 962 of file SparsificationAndBufferizationPass.cpp.

Member Function Documentation

◆ classof()

template<typename DerivedT>

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

inlinestatic

Support isa/dyn_cast functionality for the derived pass class.

Definition at line 934 of file SparsificationAndBufferizationPass.cpp.

◆ clonePass()

template<typename DerivedT>

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

inlineoverridevirtual

A clone method to create a copy of this pass.

Implements mlir::Pass.

Definition at line 939 of file SparsificationAndBufferizationPass.cpp.

◆ getArgument()

template<typename DerivedT>

::llvm::StringRef mlir::impl::SparsificationAndBufferizationBase< 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 923 of file SparsificationAndBufferizationPass.cpp.

◆ getArgumentName()

template<typename DerivedT>

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

inlinestatic

Returns the command-line argument attached to this pass.

Definition at line 920 of file SparsificationAndBufferizationPass.cpp.

◆ getDependentDialects()

template<typename DerivedT>

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

inlineoverride

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

Definition at line 944 of file SparsificationAndBufferizationPass.cpp.

◆ getDescription()

template<typename DerivedT>

::llvm::StringRef mlir::impl::SparsificationAndBufferizationBase< 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 925 of file SparsificationAndBufferizationPass.cpp.

◆ getName()

template<typename DerivedT>

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

inlineoverridevirtual

Returns the derived pass name.

Implements mlir::Pass.

Definition at line 931 of file SparsificationAndBufferizationPass.cpp.

◆ getPassName()

template<typename DerivedT>

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

inlinestatic

Returns the derived pass name.

Definition at line 928 of file SparsificationAndBufferizationPass.cpp.

◆ operator=() [1/2]

template<typename DerivedT>

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

delete

◆ operator=() [2/2]

template<typename DerivedT>

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

delete

Member Data Documentation

◆ enableGPULibgen

template<typename DerivedT>

::mlir::Pass::Option<bool> mlir::impl::SparsificationAndBufferizationBase< DerivedT >::enableGPULibgen {*this, "enable-gpu-libgen", ::llvm::cl::desc(R"PO(Enable GPU acceleration by means of direct library calls)PO"), ::llvm::cl::init(false)}

protected

Definition at line 974 of file SparsificationAndBufferizationPass.cpp.

◆ enableSIMDIndex32

template<typename DerivedT>

::mlir::Pass::Option<bool> mlir::impl::SparsificationAndBufferizationBase< DerivedT >::enableSIMDIndex32 {*this, "enable-simd-index32", ::llvm::cl::desc(R"PO(Enable i32 indexing into vectors (for efficient gather/scatter))PO"), ::llvm::cl::init(false)}

protected

Definition at line 973 of file SparsificationAndBufferizationPass.cpp.

◆ enableVLAVectorization

template<typename DerivedT>

::mlir::Pass::Option<bool> mlir::impl::SparsificationAndBufferizationBase< DerivedT >::enableVLAVectorization {*this, "enable-vla-vectorization", ::llvm::cl::desc(R"PO(Enable vector length agnostic vectorization)PO"), ::llvm::cl::init(false)}

protected

Definition at line 972 of file SparsificationAndBufferizationPass.cpp.

◆ parallelization

template<typename DerivedT>

::mlir::Pass::Option<mlir::SparseParallelizationStrategy> mlir::impl::SparsificationAndBufferizationBase< DerivedT >::parallelization

protected

Initial value:

{*this, "parallelization-strategy", ::llvm::cl::desc(R"PO(Set the parallelization strategy)PO"), ::llvm::cl::init(mlir::SparseParallelizationStrategy::kNone), llvm::cl::values(
             clEnumValN(mlir::SparseParallelizationStrategy::kNone, "none",
                        "Turn off sparse parallelization."),
             clEnumValN(mlir::SparseParallelizationStrategy::kDenseOuterLoop,
                        "dense-outer-loop",
                        "Enable dense outer loop sparse parallelization."),
             clEnumValN(mlir::SparseParallelizationStrategy::kAnyStorageOuterLoop,
                        "any-storage-outer-loop",
                        "Enable sparse parallelization regardless of storage for the outer loop."),
             clEnumValN(mlir::SparseParallelizationStrategy::kDenseAnyLoop,
                        "dense-any-loop",
                        "Enable dense parallelization for any loop."),
             clEnumValN(mlir::SparseParallelizationStrategy::kAnyStorageAnyLoop,
                        "any-storage-any-loop",
                        "Enable sparse parallelization for any storage and loop."))}

Definition at line 982 of file SparsificationAndBufferizationPass.cpp.

◆ sparseEmitStrategy

template<typename DerivedT>

::mlir::Pass::Option<mlir::SparseEmitStrategy> mlir::impl::SparsificationAndBufferizationBase< DerivedT >::sparseEmitStrategy

protected

Initial value:

{*this, "sparse-emit-strategy", ::llvm::cl::desc(R"PO(Emit functional code or interfaces (to debug) for sparse loops)PO"), ::llvm::cl::init(mlir::SparseEmitStrategy::kFunctional), llvm::cl::values(
             clEnumValN(mlir::SparseEmitStrategy::kFunctional, "functional",
                        "Emit functional code (with scf.for/while)."),
             clEnumValN(mlir::SparseEmitStrategy::kSparseIterator, "sparse-iterator",
                        "Emit (experimental) loops (with sparse.iterate)."),
             clEnumValN(mlir::SparseEmitStrategy::kDebugInterface, "debug-interface",
                        "Emit non-functional but easy-to-read interfaces to debug."))}

Definition at line 975 of file SparsificationAndBufferizationPass.cpp.

◆ vectorLength

template<typename DerivedT>

::mlir::Pass::Option<int32_t> mlir::impl::SparsificationAndBufferizationBase< DerivedT >::vectorLength {*this, "vl", ::llvm::cl::desc(R"PO(Set the vector length (use 0 to disable vectorization))PO"), ::llvm::cl::init(0)}

protected

Definition at line 971 of file SparsificationAndBufferizationPass.cpp.

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

lib/Dialect/SparseTensor/Transforms/SparsificationAndBufferizationPass.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ SparsificationAndBufferizationBase() [1/4]

◆ SparsificationAndBufferizationBase() [2/4]

◆ SparsificationAndBufferizationBase() [3/4]

◆ ~SparsificationAndBufferizationBase()

◆ SparsificationAndBufferizationBase() [4/4]

Member Function Documentation

◆ classof()

◆ clonePass()

◆ getArgument()

◆ getArgumentName()

◆ getDependentDialects()

◆ getDescription()

◆ getName()

◆ getPassName()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ enableGPULibgen

◆ enableSIMDIndex32

◆ enableVLAVectorization

◆ parallelization

◆ sparseEmitStrategy

◆ vectorLength