llzk::polymorphic::impl::FlatteningPassBase< DerivedT > Class Template Reference

Inheritance diagram for llzk::polymorphic::impl::FlatteningPassBase< DerivedT >:

Collaboration diagram for llzk::polymorphic::impl::FlatteningPassBase< DerivedT >:

Public Types
using	Base = FlatteningPassBase

Public Member Functions
	FlatteningPassBase ()
	FlatteningPassBase (const FlatteningPassBase &other)
FlatteningPassBase &	operator= (const FlatteningPassBase &)=delete
	FlatteningPassBase (FlatteningPassBase &&)=delete
FlatteningPassBase &	operator= (FlatteningPassBase &&)=delete
	~FlatteningPassBase ()=default
::llvm::StringRef	getArgument () const override
::llvm::StringRef	getDescription () const override
::llvm::StringRef	getName () const override
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.
	FlatteningPassBase (FlatteningPassOptions options)
	Explicitly declare the TypeID for this class. We declare an explicit private instantiation because Pass classes should only be visible by the current library.

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< unsigned >	iterationLimit {*this, "max-iter", ::llvm::cl::desc(R"PO(Maximum number of times the pass will run if a fixpoint is not reached earlier. Unrolling loops can provide more opportunities for instantiating structs but the converse is true as well. Thus, the pass will run multiple times until no further changes can be made or the upper limit provided in this option is reached.)PO"), ::llvm::cl::init(1000)}
::mlir::Pass::Option<::llzk::polymorphic::FlatteningCleanupMode >	cleanupMode

Friends
std::unique_ptr<::mlir::Pass >	createFlatteningPass ()
std::unique_ptr<::mlir::Pass >	createFlatteningPass (FlatteningPassOptions options)

Detailed Description

template<typename DerivedT>
class llzk::polymorphic::impl::FlatteningPassBase< DerivedT >

Definition at line 213 of file FlatteningPass.cpp.

Member Typedef Documentation

Base

template<typename DerivedT>

using llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::Base = FlatteningPassBase

Definition at line 215 of file FlatteningPass.cpp.

Constructor & Destructor Documentation

FlatteningPassBase() [1/4]

template<typename DerivedT>

llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::FlatteningPassBase ( )

inline

Definition at line 217 of file FlatteningPass.cpp.

FlatteningPassBase() [2/4]

template<typename DerivedT>

llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::FlatteningPassBase ( const FlatteningPassBase< DerivedT > & other )

inline

Definition at line 218 of file FlatteningPass.cpp.

FlatteningPassBase() [3/4]

template<typename DerivedT>

llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::FlatteningPassBase ( FlatteningPassBase< DerivedT > && )

delete

~FlatteningPassBase()

template<typename DerivedT>

llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::~FlatteningPassBase ( )

default

FlatteningPassBase() [4/4]

template<typename DerivedT>

llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::FlatteningPassBase ( FlatteningPassOptions 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 270 of file FlatteningPass.cpp.

Member Function Documentation

classof()

template<typename DerivedT>

bool llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::classof ( const ::mlir::Pass * pass )

inlinestatic

Support isa/dyn_cast functionality for the derived pass class.

Definition at line 239 of file FlatteningPass.cpp.

clonePass()

template<typename DerivedT>

std::unique_ptr<::mlir::Pass > llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::clonePass ( ) const

inlineoverride

A clone method to create a copy of this pass.

Definition at line 244 of file FlatteningPass.cpp.

getArgument()

template<typename DerivedT>

::llvm::StringRef llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::getArgument ( ) const

inlineoverride

Definition at line 228 of file FlatteningPass.cpp.

getArgumentName()

template<typename DerivedT>

constexpr ::llvm::StringLiteral llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::getArgumentName ( )

inlinestatic

Returns the command-line argument attached to this pass.

Definition at line 225 of file FlatteningPass.cpp.

getDependentDialects()

template<typename DerivedT>

void llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::getDependentDialects ( ::mlir::DialectRegistry & registry ) const

inlineoverride

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

Definition at line 249 of file FlatteningPass.cpp.

getDescription()

template<typename DerivedT>

::llvm::StringRef llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::getDescription ( ) const

inlineoverride

Definition at line 230 of file FlatteningPass.cpp.

getName()

template<typename DerivedT>

::llvm::StringRef llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::getName ( ) const

inlineoverride

Definition at line 236 of file FlatteningPass.cpp.

getPassName()

template<typename DerivedT>

constexpr ::llvm::StringLiteral llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::getPassName ( )

inlinestatic

Returns the derived pass name.

Definition at line 233 of file FlatteningPass.cpp.

operator=() [1/2]

template<typename DerivedT>

FlatteningPassBase & llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::operator= ( const FlatteningPassBase< DerivedT > & )

delete

operator=() [2/2]

template<typename DerivedT>

FlatteningPassBase & llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::operator= ( FlatteningPassBase< DerivedT > && )

delete

Friends And Related Symbol Documentation

createFlatteningPass [1/2]

template<typename DerivedT>

std::unique_ptr<::mlir::Pass > createFlatteningPass ( )

friend

Definition at line 295 of file FlatteningPass.cpp.

createFlatteningPass [2/2]

template<typename DerivedT>

std::unique_ptr<::mlir::Pass > createFlatteningPass ( FlatteningPassOptions options )

friend

Definition at line 299 of file FlatteningPass.cpp.

Member Data Documentation

cleanupMode

template<typename DerivedT>

::mlir::Pass::Option<::llzk::polymorphic::FlatteningCleanupMode> llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::cleanupMode

protected

Initial value:

{*this, "cleanup", ::llvm::cl::desc(R"PO(Specifies the extent to which unused parameterized definitions (i.e. structs or free functions within a `poly.template`) are removed during the flattening pass.)PO"), ::llvm::cl::init(::llzk::polymorphic::FlatteningCleanupMode::Unspecified), ::llvm::cl::values(
                clEnumValN(::llzk::polymorphic::FlatteningCleanupMode::Unspecified,
                           stringifyFlatteningCleanupMode(::llzk::polymorphic::FlatteningCleanupMode::Unspecified),
                           "Use the cleanup mode specified by the calling pipeline (defaults to `preimage` if not specified)."),
                clEnumValN(::llzk::polymorphic::FlatteningCleanupMode::Disabled,
                           stringifyFlatteningCleanupMode(::llzk::polymorphic::FlatteningCleanupMode::Disabled),
                           "No definitions are deleted."),
                clEnumValN(::llzk::polymorphic::FlatteningCleanupMode::Preimage,
                           stringifyFlatteningCleanupMode(::llzk::polymorphic::FlatteningCleanupMode::Preimage),
                           "Only definitions that were replaced with concrete instantiations are deleted."),
                clEnumValN(::llzk::polymorphic::FlatteningCleanupMode::ConcreteAsRoot,
                           stringifyFlatteningCleanupMode(::llzk::polymorphic::FlatteningCleanupMode::ConcreteAsRoot),
                           "All definitions that cannot be reached by a use-def chain from some concrete definition are deleted."),
                clEnumValN(::llzk::polymorphic::FlatteningCleanupMode::MainAsRoot,
                           stringifyFlatteningCleanupMode(::llzk::polymorphic::FlatteningCleanupMode::MainAsRoot),
                           "All definitions that cannot be reached by a use-def chain from the \"Main\" struct are deleted.")
          )}

Definition at line 276 of file FlatteningPass.cpp.

iterationLimit

template<typename DerivedT>

::mlir::Pass::Option<unsigned> llzk::polymorphic::impl::FlatteningPassBase< DerivedT >::iterationLimit {*this, "max-iter", ::llvm::cl::desc(R"PO(Maximum number of times the pass will run if a fixpoint is not reached earlier. Unrolling loops can provide more opportunities for instantiating structs but the converse is true as well. Thus, the pass will run multiple times until no further changes can be made or the upper limit provided in this option is reached.)PO"), ::llvm::cl::init(1000)}

protected

Definition at line 275 of file FlatteningPass.cpp.

---

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

• lib/Dialect/Polymorphic/Transforms/FlatteningPass.cpp