MLIR 23.0.0git
mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT > Class Template Reference
Inheritance diagram for mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >:

Public Types

using Base = StaticMemoryPlannerAnalysisPassBase

Public Member Functions

 StaticMemoryPlannerAnalysisPassBase ()
 StaticMemoryPlannerAnalysisPassBase (const StaticMemoryPlannerAnalysisPassBase &other)
StaticMemoryPlannerAnalysisPassBaseoperator= (const StaticMemoryPlannerAnalysisPassBase &)=delete
 StaticMemoryPlannerAnalysisPassBase (StaticMemoryPlannerAnalysisPassBase &&)=delete
StaticMemoryPlannerAnalysisPassBaseoperator= (StaticMemoryPlannerAnalysisPassBase &&)=delete
 ~StaticMemoryPlannerAnalysisPassBase ()=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::PassclonePass () 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.
 StaticMemoryPlannerAnalysisPassBase (StaticMemoryPlannerAnalysisPassOptions 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 PassInfolookupPassInfo () 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 PassgetThreadingSibling () const
 Returns the thread sibling of this pass.
const PassgetThreadingSiblingOrThis () 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< std::string > arenaMode {*this, "arena-mode", ::llvm::cl::desc(R"PO(Arena allocation mode: 'allocate' creates arena via AllocOp, 'arg' extracts arena from function arguments)PO"), ::llvm::cl::init("allocate")}
::mlir::Pass::Option<::mlir::bufferization::MemoryPlannerAlgorithm > algorithm
::mlir::Pass::Statistic numEligible {this, "num-eligible", R"PS(Number of alloc/dealloc pairs eligible for static planning)PS"}
::mlir::Pass::Statistic numSkipDynamic {this, "num-skipped-dynamic", R"PS(Number of allocations skipped: dynamic shape)PS"}
::mlir::Pass::Statistic numSkipNested {this, "num-skipped-nested", R"PS(Number of allocations skipped: nested in loop or conditional)PS"}
::mlir::Pass::Statistic numSkipNoDealloc {this, "num-skipped-no-dealloc", R"PS(Number of allocations skipped: no unique same-block dealloc)PS"}
::mlir::Pass::Statistic numSkipEscaping {this, "num-skipped-escaping", R"PS(Number of allocations skipped: cross-block alias or escaping use)PS"}

Friends

std::unique_ptr<::mlir::PasscreateStaticMemoryPlannerAnalysisPass ()
std::unique_ptr<::mlir::PasscreateStaticMemoryPlannerAnalysisPass (StaticMemoryPlannerAnalysisPassOptions options)

Additional Inherited Members

Protected Member Functions inherited from mlir::InterfacePass< FunctionOpInterface >
 OperationPass (TypeID passID)
 OperationPass (const OperationPass &)=default
 OperationPass (OperationPass &&)=delete
bool canScheduleOn (Operation *op) const final
 Indicate if the current pass can be scheduled on the given operation type.
FunctionOpInterface getOperation ()
 Return the current operation being transformed.
AnalysisT & getAnalysis ()
 Query an analysis for the current operation.
Protected Member Functions inherited from mlir::OperationPass< OpT >
 OperationPass (TypeID passID)
 OperationPass (const OperationPass &)=default
OperationPassoperator= (const OperationPass &)=delete
 OperationPass (OperationPass &&)=delete
OperationPassoperator= (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)
Passoperator= (const Pass &)=delete
 Pass (Pass &&)=delete
Passoperator= (Pass &&)=delete
detail::PassExecutionStategetPassState ()
 Returns the current pass state.
MLIRContextgetContext ()
 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< Passclone () const
 A clone method to create a copy of this pass.
OperationgetOperation ()
 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::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >

Definition at line 1128 of file StaticMemoryPlannerAnalysis.cpp.

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ StaticMemoryPlannerAnalysisPassBase() [1/4]

template<typename DerivedT>
mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::StaticMemoryPlannerAnalysisPassBase ( )
inline

Definition at line 1132 of file StaticMemoryPlannerAnalysis.cpp.

◆ StaticMemoryPlannerAnalysisPassBase() [2/4]

template<typename DerivedT>
mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::StaticMemoryPlannerAnalysisPassBase ( const StaticMemoryPlannerAnalysisPassBase< DerivedT > & other)
inline

Definition at line 1133 of file StaticMemoryPlannerAnalysis.cpp.

◆ StaticMemoryPlannerAnalysisPassBase() [3/4]

template<typename DerivedT>
mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::StaticMemoryPlannerAnalysisPassBase ( StaticMemoryPlannerAnalysisPassBase< DerivedT > && )
delete

◆ ~StaticMemoryPlannerAnalysisPassBase()

◆ StaticMemoryPlannerAnalysisPassBase() [4/4]

template<typename DerivedT>
mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::StaticMemoryPlannerAnalysisPassBase ( StaticMemoryPlannerAnalysisPassOptions 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 1173 of file StaticMemoryPlannerAnalysis.cpp.

Member Function Documentation

◆ classof()

template<typename DerivedT>
bool mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::classof ( const ::mlir::Pass * pass)
inlinestatic

Support isa/dyn_cast functionality for the derived pass class.

Definition at line 1154 of file StaticMemoryPlannerAnalysis.cpp.

◆ clonePass()

template<typename DerivedT>
std::unique_ptr<::mlir::Pass > mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::clonePass ( ) const
inlineoverridevirtual

A clone method to create a copy of this pass.

Implements mlir::Pass.

Definition at line 1159 of file StaticMemoryPlannerAnalysis.cpp.

◆ getArgument()

template<typename DerivedT>
::llvm::StringRef mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< 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 1143 of file StaticMemoryPlannerAnalysis.cpp.

◆ getArgumentName()

template<typename DerivedT>
constexpr ::llvm::StringLiteral mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::getArgumentName ( )
inlinestatic

Returns the command-line argument attached to this pass.

Definition at line 1140 of file StaticMemoryPlannerAnalysis.cpp.

◆ getDependentDialects()

template<typename DerivedT>
void mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::getDependentDialects ( ::mlir::DialectRegistry & registry) const
inlineoverride

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

Definition at line 1164 of file StaticMemoryPlannerAnalysis.cpp.

◆ getDescription()

template<typename DerivedT>
::llvm::StringRef mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< 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 1145 of file StaticMemoryPlannerAnalysis.cpp.

◆ getName()

template<typename DerivedT>
::llvm::StringRef mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::getName ( ) const
inlineoverridevirtual

Returns the derived pass name.

Implements mlir::Pass.

Definition at line 1151 of file StaticMemoryPlannerAnalysis.cpp.

◆ getPassName()

template<typename DerivedT>
constexpr ::llvm::StringLiteral mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::getPassName ( )
inlinestatic

Returns the derived pass name.

Definition at line 1148 of file StaticMemoryPlannerAnalysis.cpp.

◆ operator=() [1/2]

template<typename DerivedT>
StaticMemoryPlannerAnalysisPassBase & mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::operator= ( const StaticMemoryPlannerAnalysisPassBase< DerivedT > & )
delete

◆ operator=() [2/2]

◆ createStaticMemoryPlannerAnalysisPass [1/2]

template<typename DerivedT>
std::unique_ptr<::mlir::Pass > createStaticMemoryPlannerAnalysisPass ( )
friend

Definition at line 1194 of file StaticMemoryPlannerAnalysis.cpp.

◆ createStaticMemoryPlannerAnalysisPass [2/2]

template<typename DerivedT>
std::unique_ptr<::mlir::Pass > createStaticMemoryPlannerAnalysisPass ( StaticMemoryPlannerAnalysisPassOptions options)
friend

Definition at line 1198 of file StaticMemoryPlannerAnalysis.cpp.

Member Data Documentation

◆ algorithm

template<typename DerivedT>
::mlir::Pass::Option<::mlir::bufferization::MemoryPlannerAlgorithm> mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::algorithm
protected
Initial value:
{*this, "algorithm", ::llvm::cl::desc(R"PO(Memory planning algorithm to use.)PO"), ::llvm::cl::init(::mlir::bufferization::MemoryPlannerAlgorithm::Trivial), ::llvm::cl::values(
clEnumValN(::mlir::bufferization::MemoryPlannerAlgorithm::Trivial,
"trivial",
"Sequential packing without lifetime overlap"),
clEnumValN(::mlir::bufferization::MemoryPlannerAlgorithm::BestFit,
"best-fit",
"Best-fit packing with lifetime-aware gap reuse")
)}

Definition at line 1179 of file StaticMemoryPlannerAnalysis.cpp.

◆ arenaMode

template<typename DerivedT>
::mlir::Pass::Option<std::string> mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::arenaMode {*this, "arena-mode", ::llvm::cl::desc(R"PO(Arena allocation mode: 'allocate' creates arena via AllocOp, 'arg' extracts arena from function arguments)PO"), ::llvm::cl::init("allocate")}
protected

Definition at line 1178 of file StaticMemoryPlannerAnalysis.cpp.

◆ numEligible

template<typename DerivedT>
::mlir::Pass::Statistic mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::numEligible {this, "num-eligible", R"PS(Number of alloc/dealloc pairs eligible for static planning)PS"}
protected

Definition at line 1187 of file StaticMemoryPlannerAnalysis.cpp.

◆ numSkipDynamic

template<typename DerivedT>
::mlir::Pass::Statistic mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::numSkipDynamic {this, "num-skipped-dynamic", R"PS(Number of allocations skipped: dynamic shape)PS"}
protected

Definition at line 1188 of file StaticMemoryPlannerAnalysis.cpp.

◆ numSkipEscaping

template<typename DerivedT>
::mlir::Pass::Statistic mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::numSkipEscaping {this, "num-skipped-escaping", R"PS(Number of allocations skipped: cross-block alias or escaping use)PS"}
protected

Definition at line 1191 of file StaticMemoryPlannerAnalysis.cpp.

◆ numSkipNested

template<typename DerivedT>
::mlir::Pass::Statistic mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::numSkipNested {this, "num-skipped-nested", R"PS(Number of allocations skipped: nested in loop or conditional)PS"}
protected

Definition at line 1189 of file StaticMemoryPlannerAnalysis.cpp.

◆ numSkipNoDealloc

template<typename DerivedT>
::mlir::Pass::Statistic mlir::bufferization::impl::StaticMemoryPlannerAnalysisPassBase< DerivedT >::numSkipNoDealloc {this, "num-skipped-no-dealloc", R"PS(Number of allocations skipped: no unique same-block dealloc)PS"}
protected

Definition at line 1190 of file StaticMemoryPlannerAnalysis.cpp.


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