MLIR  14.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
mlir::Dialect Class Reference

Dialects are groups of MLIR operations, types and attributes, as well as behavior associated with the entire group. More...

#include "mlir/IR/Dialect.h"

Public Types

using ParseOpHook = function_ref< ParseResult(OpAsmParser &parser, OperationState &result)>
 Type for a callback provided by the dialect to parse a custom operation. More...
 

Public Member Functions

virtual ~Dialect ()
 
MLIRContextgetContext () const
 
StringRef getNamespace () const
 
TypeID getTypeID () const
 Returns the unique identifier that corresponds to this dialect. More...
 
bool allowsUnknownOperations () const
 Returns true if this dialect allows for unregistered operations, i.e. More...
 
bool allowsUnknownTypes () const
 Return true if this dialect allows for unregistered types, i.e., types prefixed with the dialect namespace but not registered with addType. More...
 
virtual void getCanonicalizationPatterns (RewritePatternSet &results) const
 Register dialect-wide canonicalization patterns. More...
 
virtual OperationmaterializeConstant (OpBuilder &builder, Attribute value, Type type, Location loc)
 Registered hook to materialize a single constant operation from a given attribute value with the desired resultant type. More...
 
virtual Attribute parseAttribute (DialectAsmParser &parser, Type type) const
 Parse an attribute registered to this dialect. More...
 
virtual void printAttribute (Attribute, DialectAsmPrinter &) const
 Print an attribute registered to this dialect. More...
 
virtual Type parseType (DialectAsmParser &parser) const
 Parse a type registered to this dialect. More...
 
virtual void printType (Type, DialectAsmPrinter &) const
 Print a type registered to this dialect. More...
 
virtual Optional< ParseOpHookgetParseOperationHook (StringRef opName) const
 Return the hook to parse an operation registered to this dialect, if any. More...
 
virtual llvm::unique_function< void(Operation *, OpAsmPrinter &printer)> getOperationPrinter (Operation *op) const
 Print an operation registered to this dialect. More...
 
virtual LogicalResult verifyRegionArgAttribute (Operation *, unsigned regionIndex, unsigned argIndex, NamedAttribute)
 Verify an attribute from this dialect on the argument at 'argIndex' for the region at 'regionIndex' on the given operation. More...
 
virtual LogicalResult verifyRegionResultAttribute (Operation *, unsigned regionIndex, unsigned resultIndex, NamedAttribute)
 Verify an attribute from this dialect on the result at 'resultIndex' for the region at 'regionIndex' on the given operation. More...
 
virtual LogicalResult verifyOperationAttribute (Operation *, NamedAttribute)
 Verify an attribute from this dialect on the given operation. More...
 
const DialectInterfacegetRegisteredInterface (TypeID interfaceID)
 Lookup an interface for the given ID if one is registered, otherwise nullptr. More...
 
template<typename InterfaceT >
const InterfaceT * getRegisteredInterface ()
 
virtual voidgetRegisteredInterfaceForOp (TypeID interfaceID, OperationName opName)
 Lookup an op interface for the given ID if one is registered, otherwise nullptr. More...
 
template<typename InterfaceT >
InterfaceT::Concept * getRegisteredInterfaceForOp (OperationName opName)
 

Static Public Member Functions

static bool isValidNamespace (StringRef str)
 Utility function that returns if the given string is a valid dialect namespace. More...
 

Protected Member Functions

 Dialect (StringRef name, MLIRContext *context, TypeID id)
 The constructor takes a unique namespace for this dialect as well as the context to bind to. More...
 
template<typename... Args>
void addOperations ()
 This method is used by derived classes to add their operations to the set. More...
 
template<typename... Args>
void addTypes ()
 Register a set of type classes with this dialect. More...
 
void addType (TypeID typeID, AbstractType &&typeInfo)
 Register a type instance with this dialect. More...
 
template<typename... Args>
void addAttributes ()
 Register a set of attribute classes with this dialect. More...
 
void allowUnknownOperations (bool allow=true)
 Enable support for unregistered operations. More...
 
void allowUnknownTypes (bool allow=true)
 Enable support for unregistered types. More...
 
void addInterface (std::unique_ptr< DialectInterface > interface)
 Register a dialect interface with this dialect instance. More...
 
template<typename... Args>
void addInterfaces ()
 Register a set of dialect interfaces with this dialect instance. More...
 

Friends

class DialectRegistry
 
class MLIRContext
 
void registerDialect ()
 

Detailed Description

Dialects are groups of MLIR operations, types and attributes, as well as behavior associated with the entire group.

For example, hooks into other systems for constant folding, interfaces, default named types for asm printing, etc.

Instances of the dialect object are loaded in a specific MLIRContext.

Definition at line 42 of file Dialect.h.

Member Typedef Documentation

◆ ParseOpHook

Type for a callback provided by the dialect to parse a custom operation.

This is used for the dialect to provide an alternative way to parse custom operations, including unregistered ones.

Definition at line 48 of file Dialect.h.

Constructor & Destructor Documentation

◆ ~Dialect()

Dialect::~Dialect ( )
virtualdefault

Referenced by Dialect().

◆ Dialect()

Dialect::Dialect ( StringRef  name,
MLIRContext context,
TypeID  id 
)
protected

The constructor takes a unique namespace for this dialect as well as the context to bind to.

Note: The namespace must not contain '.' characters. Note: All operations belonging to this dialect must have names starting with the namespace followed by '.'. Example:

  • "tf" for the TensorFlow ops like "tf.add".

Definition at line 122 of file Dialect.cpp.

References isValidNamespace(), and ~Dialect().

Referenced by addInterfaces(), and getRegisteredInterfaceForOp().

Member Function Documentation

◆ addAttributes()

template<typename... Args>
void mlir::Dialect::addAttributes ( )
inlineprotected

Register a set of attribute classes with this dialect.

Definition at line 211 of file Dialect.h.

◆ addInterface()

void Dialect::addInterface ( std::unique_ptr< DialectInterface interface)
protected

Register a dialect interface with this dialect instance.

Register a set of dialect interfaces with this dialect instance.

Definition at line 188 of file Dialect.cpp.

References mlir::DialectInterface::~DialectInterface().

Referenced by addInterfaces(), allowUnknownTypes(), and mlir::DialectRegistry::registerDelayedInterfaces().

◆ addInterfaces()

template<typename... Args>
void mlir::Dialect::addInterfaces ( )
inlineprotected

Register a set of dialect interfaces with this dialect instance.

Definition at line 225 of file Dialect.h.

References addInterface(), and Dialect().

◆ addOperations()

template<typename... Args>
void mlir::Dialect::addOperations ( )
inlineprotected

This method is used by derived classes to add their operations to the set.

Definition at line 195 of file Dialect.h.

◆ addType()

void Dialect::addType ( TypeID  typeID,
AbstractType &&  typeInfo 
)
protected

Register a type instance with this dialect.

The use of this method is in general discouraged in favor of 'addTypes<CustomType>()'.

Definition at line 596 of file MLIRContext.cpp.

Referenced by addTypes().

◆ addTypes()

template<typename... Args>
void mlir::Dialect::addTypes ( )
inlineprotected

Register a set of type classes with this dialect.

Definition at line 201 of file Dialect.h.

References addType().

◆ allowsUnknownOperations()

bool mlir::Dialect::allowsUnknownOperations ( ) const
inline

Returns true if this dialect allows for unregistered operations, i.e.

operations prefixed with the dialect namespace but not registered with addOperation.

Definition at line 66 of file Dialect.h.

◆ allowsUnknownTypes()

bool mlir::Dialect::allowsUnknownTypes ( ) const
inline

Return true if this dialect allows for unregistered types, i.e., types prefixed with the dialect namespace but not registered with addType.

These are represented with OpaqueType.

Definition at line 71 of file Dialect.h.

Referenced by parseType().

◆ allowUnknownOperations()

void mlir::Dialect::allowUnknownOperations ( bool  allow = true)
inlineprotected

Enable support for unregistered operations.

Definition at line 216 of file Dialect.h.

◆ allowUnknownTypes()

void mlir::Dialect::allowUnknownTypes ( bool  allow = true)
inlineprotected

Enable support for unregistered types.

Definition at line 219 of file Dialect.h.

References addInterface().

◆ getCanonicalizationPatterns()

virtual void mlir::Dialect::getCanonicalizationPatterns ( RewritePatternSet results) const
inlinevirtual

Register dialect-wide canonicalization patterns.

This method should only be used to register canonicalization patterns that do not conceptually belong to any single operation in the dialect. (In that case, use the op's canonicalizer.) E.g., canonicalization patterns for op interfaces should be registered here.

Definition at line 78 of file Dialect.h.

◆ getContext()

MLIRContext* mlir::Dialect::getContext ( ) const
inline

◆ getNamespace()

StringRef mlir::Dialect::getNamespace ( ) const
inline

◆ getOperationPrinter()

llvm::unique_function< void(Operation *, OpAsmPrinter &printer)> Dialect::getOperationPrinter ( Operation op) const
virtual

Print an operation registered to this dialect.

This hook is invoked for registered operation which don't override the print() method to define their own custom assembly.

Definition at line 174 of file Dialect.cpp.

References mlir::Operation::getDialect().

Referenced by mlir::OpState::print(), and printType().

◆ getParseOperationHook()

Optional< Dialect::ParseOpHook > Dialect::getParseOperationHook ( StringRef  opName) const
virtual

Return the hook to parse an operation registered to this dialect, if any.

By default this will lookup for registered operations and return the parse() method registered on the RegisteredOperationName. Dialects can override this behavior and handle unregistered operations as well.

Definition at line 169 of file Dialect.cpp.

Referenced by mlir::OpState::parse(), and printType().

◆ getRegisteredInterface() [1/2]

const DialectInterface* mlir::Dialect::getRegisteredInterface ( TypeID  interfaceID)
inline

Lookup an interface for the given ID if one is registered, otherwise nullptr.

Definition at line 161 of file Dialect.h.

Referenced by mlir::DialectRegistry::registerDelayedInterfaces(), and mlir::detail::verifyDataLayoutSpec().

◆ getRegisteredInterface() [2/2]

template<typename InterfaceT >
const InterfaceT* mlir::Dialect::getRegisteredInterface ( )
inline

Definition at line 165 of file Dialect.h.

◆ getRegisteredInterfaceForOp() [1/2]

virtual void* mlir::Dialect::getRegisteredInterfaceForOp ( TypeID  interfaceID,
OperationName  opName 
)
inlinevirtual

Lookup an op interface for the given ID if one is registered, otherwise nullptr.

Definition at line 172 of file Dialect.h.

Referenced by mlir::OpInterface< AffineMapAccessInterface, detail::AffineMapAccessInterfaceInterfaceTraits >::getInterfaceFor(), and getRegisteredInterfaceForOp().

◆ getRegisteredInterfaceForOp() [2/2]

template<typename InterfaceT >
InterfaceT::Concept* mlir::Dialect::getRegisteredInterfaceForOp ( OperationName  opName)
inline

Definition at line 178 of file Dialect.h.

References Dialect(), and getRegisteredInterfaceForOp().

◆ getTypeID()

TypeID mlir::Dialect::getTypeID ( ) const
inline

Returns the unique identifier that corresponds to this dialect.

Definition at line 61 of file Dialect.h.

Referenced by mlir::DialectRegistry::registerDelayedInterfaces().

◆ isValidNamespace()

bool Dialect::isValidNamespace ( StringRef  str)
static

Utility function that returns if the given string is a valid dialect namespace.

Definition at line 182 of file Dialect.cpp.

Referenced by mlir::BoolAttr::classof(), mlir::DenseIntElementsAttr::classof(), Dialect(), and mlir::FloatType::scaleElementBitwidth().

◆ materializeConstant()

virtual Operation* mlir::Dialect::materializeConstant ( OpBuilder builder,
Attribute  value,
Type  type,
Location  loc 
)
inlinevirtual

Registered hook to materialize a single constant operation from a given attribute value with the desired resultant type.

This method should use the provided builder to create the operation without changing the insertion position. The generated operation is expected to be constant like, i.e. single result, zero operands, non side-effecting, etc. On success, this hook should return the value generated to represent the constant value. Otherwise, it should return null on failure.

Definition at line 87 of file Dialect.h.

References parseAttribute().

Referenced by materializeConstant(), and mlir::OpBuilder::tryFold().

◆ parseAttribute()

Attribute Dialect::parseAttribute ( DialectAsmParser parser,
Type  type 
) const
virtual

Parse an attribute registered to this dialect.

If 'type' is nonnull, it refers to the expected type of the attribute.

Definition at line 148 of file Dialect.cpp.

References mlir::AsmParser::emitError(), mlir::AsmParser::getNameLoc(), and getNamespace().

Referenced by materializeConstant().

◆ parseType()

Type Dialect::parseType ( DialectAsmParser parser) const
virtual

◆ printAttribute()

virtual void mlir::Dialect::printAttribute ( Attribute  ,
DialectAsmPrinter  
) const
inlinevirtual

Print an attribute registered to this dialect.

Note: The type of the attribute need not be printed by this method as it is always printed by the caller.

Definition at line 103 of file Dialect.h.

References parseType().

◆ printType()

virtual void mlir::Dialect::printType ( Type  ,
DialectAsmPrinter  
) const
inlinevirtual

Print a type registered to this dialect.

Definition at line 111 of file Dialect.h.

References getOperationPrinter(), getParseOperationHook(), resultIndex(), verifyRegionArgAttribute(), and verifyRegionResultAttribute().

◆ verifyOperationAttribute()

virtual LogicalResult mlir::Dialect::verifyOperationAttribute ( Operation ,
NamedAttribute   
)
inlinevirtual

Verify an attribute from this dialect on the given operation.

Returns failure if the verification failed, success otherwise.

Definition at line 151 of file Dialect.h.

References mlir::success().

◆ verifyRegionArgAttribute()

LogicalResult Dialect::verifyRegionArgAttribute ( Operation ,
unsigned  regionIndex,
unsigned  argIndex,
NamedAttribute   
)
virtual

Verify an attribute from this dialect on the argument at 'argIndex' for the region at 'regionIndex' on the given operation.

Returns failure if the verification failed, success otherwise. This hook may optionally be invoked from any operation containing a region.

Definition at line 133 of file Dialect.cpp.

References mlir::success().

Referenced by printType().

◆ verifyRegionResultAttribute()

LogicalResult Dialect::verifyRegionResultAttribute ( Operation ,
unsigned  regionIndex,
unsigned  resultIndex,
NamedAttribute   
)
virtual

Verify an attribute from this dialect on the result at 'resultIndex' for the region at 'regionIndex' on the given operation.

Returns failure if the verification failed, success otherwise. This hook may optionally be invoked from any operation containing a region.

Definition at line 142 of file Dialect.cpp.

References mlir::success().

Referenced by printType().

Friends And Related Function Documentation

◆ DialectRegistry

friend class DialectRegistry
friend

Definition at line 272 of file Dialect.h.

◆ MLIRContext

friend class MLIRContext
friend

Definition at line 274 of file Dialect.h.

◆ registerDialect

void registerDialect ( )
friend

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