MLIR  17.0.0git
Dialect.h
Go to the documentation of this file.
1 //===- Dialect.h - IR Dialect Description -----------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the 'dialect' abstraction.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef MLIR_IR_DIALECT_H
14 #define MLIR_IR_DIALECT_H
15 
18 #include "mlir/Support/TypeID.h"
19 
20 #include <map>
21 #include <tuple>
22 
23 namespace mlir {
24 class DialectAsmParser;
25 class DialectAsmPrinter;
26 class DialectInterface;
27 class OpBuilder;
28 class Type;
29 
30 //===----------------------------------------------------------------------===//
31 // Dialect
32 //===----------------------------------------------------------------------===//
33 
34 /// Dialects are groups of MLIR operations, types and attributes, as well as
35 /// behavior associated with the entire group. For example, hooks into other
36 /// systems for constant folding, interfaces, default named types for asm
37 /// printing, etc.
38 ///
39 /// Instances of the dialect object are loaded in a specific MLIRContext.
40 ///
41 class Dialect {
42 public:
43  /// Type for a callback provided by the dialect to parse a custom operation.
44  /// This is used for the dialect to provide an alternative way to parse custom
45  /// operations, including unregistered ones.
46  using ParseOpHook =
48 
49  virtual ~Dialect();
50 
51  /// Utility function that returns if the given string is a valid dialect
52  /// namespace
53  static bool isValidNamespace(StringRef str);
54 
55  MLIRContext *getContext() const { return context; }
56 
57  StringRef getNamespace() const { return name; }
58 
59  /// Returns the unique identifier that corresponds to this dialect.
60  TypeID getTypeID() const { return dialectID; }
61 
62  /// Returns true if this dialect allows for unregistered operations, i.e.
63  /// operations prefixed with the dialect namespace but not registered with
64  /// addOperation.
65  bool allowsUnknownOperations() const { return unknownOpsAllowed; }
66 
67  /// Return true if this dialect allows for unregistered types, i.e., types
68  /// prefixed with the dialect namespace but not registered with addType.
69  /// These are represented with OpaqueType.
70  bool allowsUnknownTypes() const { return unknownTypesAllowed; }
71 
72  /// Register dialect-wide canonicalization patterns. This method should only
73  /// be used to register canonicalization patterns that do not conceptually
74  /// belong to any single operation in the dialect. (In that case, use the op's
75  /// canonicalizer.) E.g., canonicalization patterns for op interfaces should
76  /// be registered here.
77  virtual void getCanonicalizationPatterns(RewritePatternSet &results) const {}
78 
79  /// Registered hook to materialize a single constant operation from a given
80  /// attribute value with the desired resultant type. This method should use
81  /// the provided builder to create the operation without changing the
82  /// insertion position. The generated operation is expected to be constant
83  /// like, i.e. single result, zero operands, non side-effecting, etc. On
84  /// success, this hook should return the value generated to represent the
85  /// constant value. Otherwise, it should return null on failure.
87  Type type, Location loc) {
88  return nullptr;
89  }
90 
91  //===--------------------------------------------------------------------===//
92  // Parsing Hooks
93  //===--------------------------------------------------------------------===//
94 
95  /// Parse an attribute registered to this dialect. If 'type' is nonnull, it
96  /// refers to the expected type of the attribute.
97  virtual Attribute parseAttribute(DialectAsmParser &parser, Type type) const;
98 
99  /// Print an attribute registered to this dialect. Note: The type of the
100  /// attribute need not be printed by this method as it is always printed by
101  /// the caller.
102  virtual void printAttribute(Attribute, DialectAsmPrinter &) const {
103  llvm_unreachable("dialect has no registered attribute printing hook");
104  }
105 
106  /// Parse a type registered to this dialect.
107  virtual Type parseType(DialectAsmParser &parser) const;
108 
109  /// Print a type registered to this dialect.
110  virtual void printType(Type, DialectAsmPrinter &) const {
111  llvm_unreachable("dialect has no registered type printing hook");
112  }
113 
114  /// Return the hook to parse an operation registered to this dialect, if any.
115  /// By default this will lookup for registered operations and return the
116  /// `parse()` method registered on the RegisteredOperationName. Dialects can
117  /// override this behavior and handle unregistered operations as well.
118  virtual std::optional<ParseOpHook>
119  getParseOperationHook(StringRef opName) const;
120 
121  /// Print an operation registered to this dialect.
122  /// This hook is invoked for registered operation which don't override the
123  /// `print()` method to define their own custom assembly.
124  virtual llvm::unique_function<void(Operation *, OpAsmPrinter &printer)>
125  getOperationPrinter(Operation *op) const;
126 
127  //===--------------------------------------------------------------------===//
128  // Verification Hooks
129  //===--------------------------------------------------------------------===//
130 
131  /// Verify an attribute from this dialect on the argument at 'argIndex' for
132  /// the region at 'regionIndex' on the given operation. Returns failure if
133  /// the verification failed, success otherwise. This hook may optionally be
134  /// invoked from any operation containing a region.
136  unsigned regionIndex,
137  unsigned argIndex,
139 
140  /// Verify an attribute from this dialect on the result at 'resultIndex' for
141  /// the region at 'regionIndex' on the given operation. Returns failure if
142  /// the verification failed, success otherwise. This hook may optionally be
143  /// invoked from any operation containing a region.
145  unsigned regionIndex,
146  unsigned resultIndex,
148 
149  /// Verify an attribute from this dialect on the given operation. Returns
150  /// failure if the verification failed, success otherwise.
152  return success();
153  }
154 
155  //===--------------------------------------------------------------------===//
156  // Interfaces
157  //===--------------------------------------------------------------------===//
158 
159  /// Lookup an interface for the given ID if one is registered, otherwise
160  /// nullptr.
162  auto it = registeredInterfaces.find(interfaceID);
163  return it != registeredInterfaces.end() ? it->getSecond().get() : nullptr;
164  }
165  template <typename InterfaceT>
166  InterfaceT *getRegisteredInterface() {
167  return static_cast<InterfaceT *>(
168  getRegisteredInterface(InterfaceT::getInterfaceID()));
169  }
170 
171  /// Lookup an op interface for the given ID if one is registered, otherwise
172  /// nullptr.
173  virtual void *getRegisteredInterfaceForOp(TypeID interfaceID,
174  OperationName opName) {
175  return nullptr;
176  }
177  template <typename InterfaceT>
178  typename InterfaceT::Concept *
180  return static_cast<typename InterfaceT::Concept *>(
181  getRegisteredInterfaceForOp(InterfaceT::getInterfaceID(), opName));
182  }
183 
184  /// Register a dialect interface with this dialect instance.
185  void addInterface(std::unique_ptr<DialectInterface> interface);
186 
187  /// Register a set of dialect interfaces with this dialect instance.
188  template <typename... Args>
189  void addInterfaces() {
190  (addInterface(std::make_unique<Args>(this)), ...);
191  }
192  template <typename InterfaceT, typename... Args>
193  InterfaceT &addInterface(Args &&...args) {
194  InterfaceT *interface = new InterfaceT(this, std::forward<Args>(args)...);
195  addInterface(std::unique_ptr<DialectInterface>(interface));
196  return *interface;
197  }
198 
199 protected:
200  /// The constructor takes a unique namespace for this dialect as well as the
201  /// context to bind to.
202  /// Note: The namespace must not contain '.' characters.
203  /// Note: All operations belonging to this dialect must have names starting
204  /// with the namespace followed by '.'.
205  /// Example:
206  /// - "tf" for the TensorFlow ops like "tf.add".
207  Dialect(StringRef name, MLIRContext *context, TypeID id);
208 
209  /// This method is used by derived classes to add their operations to the set.
210  ///
211  template <typename... Args>
212  void addOperations() {
213  // This initializer_list argument pack expansion is essentially equal to
214  // using a fold expression with a comma operator. Clang however, refuses
215  // to compile a fold expression with a depth of more than 256 by default.
216  // There seem to be no such limitations for initializer_list.
217  (void)std::initializer_list<int>{
218  0, (RegisteredOperationName::insert<Args>(*this), 0)...};
219  }
220 
221  /// Register a set of type classes with this dialect.
222  template <typename... Args>
223  void addTypes() {
224  (addType<Args>(), ...);
225  }
226 
227  /// Register a type instance with this dialect.
228  /// The use of this method is in general discouraged in favor of
229  /// 'addTypes<CustomType>()'.
230  void addType(TypeID typeID, AbstractType &&typeInfo);
231 
232  /// Register a set of attribute classes with this dialect.
233  template <typename... Args>
234  void addAttributes() {
235  (addAttribute<Args>(), ...);
236  }
237 
238  /// Register an attribute instance with this dialect.
239  /// The use of this method is in general discouraged in favor of
240  /// 'addAttributes<CustomAttr>()'.
241  void addAttribute(TypeID typeID, AbstractAttribute &&attrInfo);
242 
243  /// Enable support for unregistered operations.
244  void allowUnknownOperations(bool allow = true) { unknownOpsAllowed = allow; }
245 
246  /// Enable support for unregistered types.
247  void allowUnknownTypes(bool allow = true) { unknownTypesAllowed = allow; }
248 
249 private:
250  Dialect(const Dialect &) = delete;
251  void operator=(Dialect &) = delete;
252 
253  /// Register an attribute instance with this dialect.
254  template <typename T>
255  void addAttribute() {
256  // Add this attribute to the dialect and register it with the uniquer.
257  addAttribute(T::getTypeID(), AbstractAttribute::get<T>(*this));
258  detail::AttributeUniquer::registerAttribute<T>(context);
259  }
260 
261  /// Register a type instance with this dialect.
262  template <typename T>
263  void addType() {
264  // Add this type to the dialect and register it with the uniquer.
265  addType(T::getTypeID(), AbstractType::get<T>(*this));
266  detail::TypeUniquer::registerType<T>(context);
267  }
268 
269  /// The namespace of this dialect.
270  StringRef name;
271 
272  /// The unique identifier of the derived Op class, this is used in the context
273  /// to allow registering multiple times the same dialect.
274  TypeID dialectID;
275 
276  /// This is the context that owns this Dialect object.
277  MLIRContext *context;
278 
279  /// Flag that specifies whether this dialect supports unregistered operations,
280  /// i.e. operations prefixed with the dialect namespace but not registered
281  /// with addOperation.
282  bool unknownOpsAllowed = false;
283 
284  /// Flag that specifies whether this dialect allows unregistered types, i.e.
285  /// types prefixed with the dialect namespace but not registered with addType.
286  /// These types are represented with OpaqueType.
287  bool unknownTypesAllowed = false;
288 
289  /// A collection of registered dialect interfaces.
290  DenseMap<TypeID, std::unique_ptr<DialectInterface>> registeredInterfaces;
291 
292  friend class DialectRegistry;
293  friend void registerDialect();
294  friend class MLIRContext;
295 };
296 
297 } // namespace mlir
298 
299 namespace llvm {
300 /// Provide isa functionality for Dialects.
301 template <typename T>
302 struct isa_impl<T, ::mlir::Dialect,
303  std::enable_if_t<std::is_base_of<::mlir::Dialect, T>::value>> {
304  static inline bool doit(const ::mlir::Dialect &dialect) {
305  return mlir::TypeID::get<T>() == dialect.getTypeID();
306  }
307 };
308 template <typename T>
309 struct isa_impl<
310  T, ::mlir::Dialect,
311  std::enable_if_t<std::is_base_of<::mlir::DialectInterface, T>::value>> {
312  static inline bool doit(const ::mlir::Dialect &dialect) {
313  return const_cast<::mlir::Dialect &>(dialect).getRegisteredInterface<T>();
314  }
315 };
316 template <typename T>
317 struct cast_retty_impl<T, ::mlir::Dialect *> {
318  using ret_type = T *;
319 };
320 template <typename T>
321 struct cast_retty_impl<T, ::mlir::Dialect> {
322  using ret_type = T &;
323 };
324 
325 template <typename T>
326 struct cast_convert_val<T, ::mlir::Dialect, ::mlir::Dialect> {
327  template <typename To>
328  static std::enable_if_t<std::is_base_of<::mlir::Dialect, To>::value, To &>
329  doitImpl(::mlir::Dialect &dialect) {
330  return static_cast<To &>(dialect);
331  }
332  template <typename To>
333  static std::enable_if_t<std::is_base_of<::mlir::DialectInterface, To>::value,
334  To &>
335  doitImpl(::mlir::Dialect &dialect) {
336  return *dialect.getRegisteredInterface<To>();
337  }
338 
339  static auto &doit(::mlir::Dialect &dialect) { return doitImpl<T>(dialect); }
340 };
341 template <class T>
342 struct cast_convert_val<T, ::mlir::Dialect *, ::mlir::Dialect *> {
343  static auto doit(::mlir::Dialect *dialect) {
344  return &cast_convert_val<T, ::mlir::Dialect, ::mlir::Dialect>::doit(
345  *dialect);
346  }
347 };
348 
349 } // namespace llvm
350 
351 #endif
This class contains all of the static information common to all instances of a registered Attribute.
This class contains all of the static information common to all instances of a registered Type.
Definition: TypeSupport.h:30
Attributes are known-constant values of operations.
Definition: Attributes.h:25
The DialectAsmParser has methods for interacting with the asm parser when parsing attributes and type...
This is a pure-virtual base class that exposes the asmprinter hooks necessary to implement a custom p...
This class represents an interface overridden for a single dialect.
The DialectRegistry maps a dialect namespace to a constructor for the matching dialect.
Dialects are groups of MLIR operations, types and attributes, as well as behavior associated with the...
Definition: Dialect.h:41
void addAttributes()
Register a set of attribute classes with this dialect.
Definition: Dialect.h:234
void addInterfaces()
Register a set of dialect interfaces with this dialect instance.
Definition: Dialect.h:189
virtual ~Dialect()
virtual void * getRegisteredInterfaceForOp(TypeID interfaceID, OperationName opName)
Lookup an op interface for the given ID if one is registered, otherwise nullptr.
Definition: Dialect.h:173
friend class MLIRContext
Definition: Dialect.h:294
virtual Type parseType(DialectAsmParser &parser) const
Parse a type registered to this dialect.
Definition: Dialect.cpp:66
virtual std::optional< ParseOpHook > getParseOperationHook(StringRef opName) const
Return the hook to parse an operation registered to this dialect, if any.
Definition: Dialect.cpp:79
StringRef getNamespace() const
Definition: Dialect.h:57
static bool isValidNamespace(StringRef str)
Utility function that returns if the given string is a valid dialect namespace.
Definition: Dialect.cpp:92
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' ...
Definition: Dialect.cpp:52
DialectInterface * getRegisteredInterface(TypeID interfaceID)
Lookup an interface for the given ID if one is registered, otherwise nullptr.
Definition: Dialect.h:161
InterfaceT::Concept * getRegisteredInterfaceForOp(OperationName opName)
Definition: Dialect.h:179
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' o...
Definition: Dialect.cpp:43
void addOperations()
This method is used by derived classes to add their operations to the set.
Definition: Dialect.h:212
InterfaceT * getRegisteredInterface()
Definition: Dialect.h:166
virtual llvm::unique_function< void(Operation *, OpAsmPrinter &printer)> getOperationPrinter(Operation *op) const
Print an operation registered to this dialect.
Definition: Dialect.cpp:84
bool allowsUnknownTypes() const
Return true if this dialect allows for unregistered types, i.e., types prefixed with the dialect name...
Definition: Dialect.h:70
virtual void printAttribute(Attribute, DialectAsmPrinter &) const
Print an attribute registered to this dialect.
Definition: Dialect.h:102
void addTypes()
Register a set of type classes with this dialect.
Definition: Dialect.h:223
virtual void printType(Type, DialectAsmPrinter &) const
Print a type registered to this dialect.
Definition: Dialect.h:110
MLIRContext * getContext() const
Definition: Dialect.h:55
void allowUnknownTypes(bool allow=true)
Enable support for unregistered types.
Definition: Dialect.h:247
virtual LogicalResult verifyOperationAttribute(Operation *, NamedAttribute)
Verify an attribute from this dialect on the given operation.
Definition: Dialect.h:151
void allowUnknownOperations(bool allow=true)
Enable support for unregistered operations.
Definition: Dialect.h:244
bool allowsUnknownOperations() const
Returns true if this dialect allows for unregistered operations, i.e.
Definition: Dialect.h:65
virtual Attribute parseAttribute(DialectAsmParser &parser, Type type) const
Parse an attribute registered to this dialect.
Definition: Dialect.cpp:58
void addInterface(std::unique_ptr< DialectInterface > interface)
Register a dialect interface with this dialect instance.
Definition: Dialect.cpp:98
TypeID getTypeID() const
Returns the unique identifier that corresponds to this dialect.
Definition: Dialect.h:60
friend void registerDialect()
Dialect(StringRef name, MLIRContext *context, TypeID id)
The constructor takes a unique namespace for this dialect as well as the context to bind to.
Definition: Dialect.cpp:32
InterfaceT & addInterface(Args &&...args)
Definition: Dialect.h:193
virtual void getCanonicalizationPatterns(RewritePatternSet &results) const
Register dialect-wide canonicalization patterns.
Definition: Dialect.h:77
virtual Operation * materializeConstant(OpBuilder &builder, Attribute value, Type type, Location loc)
Registered hook to materialize a single constant operation from a given attribute value with the desi...
Definition: Dialect.h:86
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
Definition: Location.h:63
MLIRContext is the top-level object for a collection of MLIR operations.
Definition: MLIRContext.h:60
NamedAttribute represents a combination of a name and an Attribute value.
Definition: Attributes.h:189
The OpAsmParser has methods for interacting with the asm parser: parsing things from it,...
This is a pure-virtual base class that exposes the asmprinter hooks necessary to implement a custom p...
This class helps build Operations.
Definition: Builders.h:202
Operation is the basic unit of execution within MLIR.
Definition: Operation.h:75
This class represents success/failure for parsing-like operations that find it important to chain tog...
This class provides an efficient unique identifier for a specific C++ type.
Definition: TypeID.h:104
Instances of the Type class are uniqued, have an immutable identifier and an optional mutable compone...
Definition: Types.h:74
Include the generated interface declarations.
Definition: CallGraph.h:229
@ Type
An inlay hint that for a type annotation.
This header declares functions that assit transformations in the MemRef dialect.
LogicalResult success(bool isSuccess=true)
Utility function to generate a LogicalResult.
Definition: LogicalResult.h:56
static auto & doit(::mlir::Dialect &dialect)
Definition: Dialect.h:339
static std::enable_if_t< std::is_base_of<::mlir::Dialect, To >::value, To & > doitImpl(::mlir::Dialect &dialect)
Definition: Dialect.h:329
static std::enable_if_t< std::is_base_of<::mlir::DialectInterface, To >::value, To & > doitImpl(::mlir::Dialect &dialect)
Definition: Dialect.h:335
This class represents an efficient way to signal success or failure.
Definition: LogicalResult.h:26
This represents an operation in an abstracted form, suitable for use with the builder APIs.