[mlir][IR] Define the singleton builtin types in ODS instead of C++

[rriddle]

Summary

This exposes several issues with the current generation that this revision also fixes.

• TypeDef now allows specifying the base class to use when generating.
• TypeDef now inherits from DialectType, which allows for using it as a TypeConstraint
• Parser/Printers are now no longer generated in the header(removing duplicate symbols), and are now only generated when necessary.
  • Now that generatedTypeParser/Printer are only generated in the definition file, existing users will need to manually expose this functionality when necessary.
• ::get() is no longer generated for singleton types, because it isn't necessary.

[jdd]

mlir/include/mlir/IR/OpBase.td

2422

I think there should be a :: before the dialect.cppNamespace.

2423

What if someone overrides the cppClassName field? I was considering doing this exact thing a while back.

mlir/lib/TableGen/Constraint.cpp

63

I'm pretty sure this'll break the documentation generation.

[jdd]

mlir/lib/TableGen/Constraint.cpp

63

No it won't. Sorry -- didn't see which file it was in.

mlir/tools/mlir-tblgen/TypeDefGen.cpp

537

I think this'll break users who have a separate file to handle their type code. They'll just have to move the callsite, but something to note.

[lattner]

This is really awesome River, I love adopting and dogfooding ODS features in the builtin/std dialect. Thanks for also fixing the TypeConstraint issue.

[rriddle]

Update

[rriddle]

Reformat docs

[rriddle]

mlir/include/mlir/IR/OpBase.td

2422

Most of the usages of cppNamespace in mlir have already been prefixing the :::

https://github.com/llvm/llvm-project/search?p=2&q=cppNamespace
(also github search is horrible)

2423

Thanks for the catch, fixed.

mlir/tools/mlir-tblgen/TypeDefGen.cpp

537

Added an explicit bullet in the description, is there any thing else you'd like to see for this?

[jdd]

This looks great!

[jdd]

mlir/tools/mlir-tblgen/TypeDefGen.cpp

537

Nope

[nathanchance]

This commit breaks my build, am I doing something wrong?

mlir/lib/IR/BuiltinTypes.cpp

28

$ mkdir build

$ cd build

$ cmake \
-G Ninja \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_C_COMPILER=$(command -v clang) \
-DCMAKE_CXX_COMPILER=$(command -v clang++) \
-DLLVM_CCACHE_BUILD=ON \
-DLLVM_ENABLE_PROJECTS=all \
-DLLVM_ENABLE_WARNINGS=OFF \
../llvm
...

$ ninja
...
[7082/8536] Building CXX object projects/debuginfo-tests/CMakeFiles/check-gdb-mlir-support.dir/llvm-prettyprinters/gdb/mlir-support.cpp.o
FAILED: projects/debuginfo-tests/CMakeFiles/check-gdb-mlir-support.dir/llvm-prettyprinters/gdb/mlir-support.cpp.o
CCACHE_CPP2=yes CCACHE_HASHDIR=yes /home/nathan/usr/bin/ccache /home/nathan/usr/bin/clang++ -DGTEST_HAS_RTTI=0 -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -Iprojects/debuginfo-tests -I/home/nathan/src/llvm-project/debuginfo-test$In file included from /home/nathan/src/llvm-project/debuginfo-tests/llvm-prettyprinters/gdb/mlir-support.cpp:2:
/home/nathan/src/llvm-project/llvm/../mlir/include/mlir/IR/BuiltinTypes.h:639:10: fatal error: 'mlir/IR/BuiltinTypes.h.inc' file not found
#include "mlir/IR/BuiltinTypes.h.inc"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 error generated.
...

$ git bisect log
# bad: [f314bcffa3c6083079831dde4e7bc124a25e0c04] [llvm-reduce][test] Make remove-alias.ll CHECK patterns more specific after D90302
# good: [5a1bc69f811059b8f62d381e3526d92fffa7d91a] [clangd] NFC: Add client-side logging for remote index requests
git bisect start 'origin/main~1023' 'origin/main~2047'
# good: [2a2268a6db17cbbef54c1b80f74a04849831c997] [VE][NFC] Sort VEISD operations
git bisect good 2a2268a6db17cbbef54c1b80f74a04849831c997
# bad: [97c006aabb6c831d68204bcb4aad8670af695618] [AArch64] Add a GPR64x8 register class
git bisect bad 97c006aabb6c831d68204bcb4aad8670af695618
# bad: [c10757200d89e59a52ab8cbbc68178eeafaa3600] Revert "Ensure SplitEdge to return the new block between the two given blocks"
git bisect bad c10757200d89e59a52ab8cbbc68178eeafaa3600
# bad: [8c4e55762d8b7a07546a5db18e33ccc6a9d97002] [docs][unittest][Go][StackProtector] Migrate deprecated DebugInfo::get to DILocation::get
git bisect bad 8c4e55762d8b7a07546a5db18e33ccc6a9d97002
# good: [cfa1010c42429f689186125270dfbad7d6a1c01d] [clangd] Provide suggestions with invalid config keys
git bisect good cfa1010c42429f689186125270dfbad7d6a1c01d
# good: [31845199094418173a3beadb786767b860bfda03] [lld-macho] Don't emit rebase opcodes for relocs in TLV sections
git bisect good 31845199094418173a3beadb786767b860bfda03
# good: [a7deedc414e2abbe4b9557d46e896a5bdba25f2b] [NFC][Tests][SimplifyCFG] Trim whitespaces at the end of lines
git bisect good a7deedc414e2abbe4b9557d46e896a5bdba25f2b
# bad: [59decf8e9c3d86472073266ad8ee1cc699d94525] [clang] Migrate deprecated DebugInfo::get to DILocation::get
git bisect bad 59decf8e9c3d86472073266ad8ee1cc699d94525
# bad: [95019de8a122619fc038c9fe3c80e625e3456bbf] [mlir][IR] Define the singleton builtin types in ODS instead of C++
git bisect bad 95019de8a122619fc038c9fe3c80e625e3456bbf
# good: [e1133179587dd895962a2fe4d6eb0cb1e63b5ee2] [NFCI][SimplifyCFG] Add basic scaffolding for gradually making the pass DomTree-aware
git bisect good e1133179587dd895962a2fe4d6eb0cb1e63b5ee2
# first bad commit: [95019de8a122619fc038c9fe3c80e625e3456bbf] [mlir][IR] Define the singleton builtin types in ODS instead of C++

[mehdi_amini]

In D93270#2485236, @nathanchance wrote:

This commit breaks my build, am I doing something wrong?

I believe it is a missing dependency in CMake, so it is non-deterministic and your bisection will not yield the right culprit.
See https://reviews.llvm.org/D87159

[mehdi_amini]

To bisect a build failure, is is more reliable to just build the target that is failing, i.e.: ninja projects/debuginfo-tests/CMakeFiles/check-gdb-mlir-support.dir/llvm-prettyprinters/gdb/mlir-support.cpp.o

mlir/include/mlir/IR/BuiltinDialect.td

+//===-- BuiltinDialect.td - Builtin dialect definition -----*- tablegen -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// This file contains the definition of the Builtin dialect. This dialect
+// contains all of the attributes, operations, and types that are core to MLIR.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef BUILTIN_BASE
+#define BUILTIN_BASE
+
+include "mlir/IR/OpBase.td"
+
+def Builtin_Dialect : Dialect {
+  let summary =
+    "A dialect containing the builtin Attributes, Operations, and Types";
+
+  let name = "";
+  let cppNamespace = "::mlir";
+}
+
+#endif // BUILTIN_BASE

mlir/include/mlir/IR/BuiltinOps.td

 //===- BuiltinOps.td - Builtin operation definitions -------*- tablegen -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Defines the set of builtin MLIR operations, or the set of operations
 // necessary for the validity of and defining the IR.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef BUILTIN_OPS
 #define BUILTIN_OPS
 
+include "mlir/IR/BuiltinDialect.td"
 include "mlir/IR/SymbolInterfaces.td"
 include "mlir/Interfaces/CallInterfaces.td"
 
-def Builtin_Dialect : Dialect {
-  let summary =
-    "A dialect containing the builtin Attributes, Operations, and Types";
-
-  let name = "";
-  let cppNamespace = "::mlir";
-}
-
 // Base class for Builtin dialect ops.
 class Builtin_Op<string mnemonic, list<OpTrait> traits = []> :
     Op<Builtin_Dialect, mnemonic, traits>;
 
 //===----------------------------------------------------------------------===//
 // FuncOp
 //===----------------------------------------------------------------------===//
 

mlir/include/mlir/IR/BuiltinTypes.h

public:
   /// Verify the construction of an integer type.
   static LogicalResult verifyConstructionInvariants(Location loc,
                                                     Type elementType);
 
   Type getElementType();
 };
 
 //===----------------------------------------------------------------------===//
-// IndexType
-//===----------------------------------------------------------------------===//
-
-/// Index is a special integer-like type with unknown platform-dependent bit
-/// width.
-class IndexType : public Type::TypeBase<IndexType, Type, TypeStorage> {
-public:
-  using Base::Base;
-
-  /// Get an instance of the IndexType.
-  static IndexType get(MLIRContext *context);
-
-  /// Storage bit width used for IndexType by internal compiler data structures.
-  static constexpr unsigned kInternalStorageBitWidth = 64;
-};
-
-//===----------------------------------------------------------------------===//
 // IntegerType
 //===----------------------------------------------------------------------===//
 
 /// Integer types can have arbitrary bitwidth up to a large fixed limit.
 class IntegerType
     : public Type::TypeBase<IntegerType, Type, detail::IntegerTypeStorage> {
 public:
   using Base::Base;
public:
   /// Return the bitwidth of this float type.
   unsigned getWidth();
 
   /// Return the floating semantics of this float type.
   const llvm::fltSemantics &getFloatSemantics();
 };
 
 //===----------------------------------------------------------------------===//
-// BFloat16Type
-
-class BFloat16Type
-    : public Type::TypeBase<BFloat16Type, FloatType, TypeStorage> {
-public:
-  using Base::Base;
-
-  /// Return an instance of the bfloat16 type.
-  static BFloat16Type get(MLIRContext *context);
-};
-
-inline FloatType FloatType::getBF16(MLIRContext *ctx) {
-  return BFloat16Type::get(ctx);
-}
-
-//===----------------------------------------------------------------------===//
-// Float16Type
-
-class Float16Type : public Type::TypeBase<Float16Type, FloatType, TypeStorage> {
-public:
-  using Base::Base;
-
-  /// Return an instance of the float16 type.
-  static Float16Type get(MLIRContext *context);
-};
-
-inline FloatType FloatType::getF16(MLIRContext *ctx) {
-  return Float16Type::get(ctx);
-}
-
-//===----------------------------------------------------------------------===//
-// Float32Type
-
-class Float32Type : public Type::TypeBase<Float32Type, FloatType, TypeStorage> {
-public:
-  using Base::Base;
-
-  /// Return an instance of the float32 type.
-  static Float32Type get(MLIRContext *context);
-};
-
-inline FloatType FloatType::getF32(MLIRContext *ctx) {
-  return Float32Type::get(ctx);
-}
-
-//===----------------------------------------------------------------------===//
-// Float64Type
-
-class Float64Type : public Type::TypeBase<Float64Type, FloatType, TypeStorage> {
-public:
-  using Base::Base;
-
-  /// Return an instance of the float64 type.
-  static Float64Type get(MLIRContext *context);
-};
-
-inline FloatType FloatType::getF64(MLIRContext *ctx) {
-  return Float64Type::get(ctx);
-}
-
-//===----------------------------------------------------------------------===//
 // FunctionType
 //===----------------------------------------------------------------------===//
 
 /// Function types map from a list of inputs to a list of results.
 class FunctionType
     : public Type::TypeBase<FunctionType, Type, detail::FunctionTypeStorage> {
 public:
   using Base::Base;
public:
   ArrayRef<Type> getResults() const;
 
   /// Returns a new function type without the specified arguments and results.
   FunctionType getWithoutArgsAndResults(ArrayRef<unsigned> argIndices,
                                         ArrayRef<unsigned> resultIndices);
 };
 
 //===----------------------------------------------------------------------===//
-// NoneType
-//===----------------------------------------------------------------------===//
-
-/// NoneType is a unit type, i.e. a type with exactly one possible value, where
-/// its value does not have a defined dynamic representation.
-class NoneType : public Type::TypeBase<NoneType, Type, TypeStorage> {
-public:
-  using Base::Base;
-
-  /// Get an instance of the NoneType.
-  static NoneType get(MLIRContext *context);
-};
-
-//===----------------------------------------------------------------------===//
 // OpaqueType
 //===----------------------------------------------------------------------===//
 
 /// Opaque types represent types of non-registered dialects. These are types
 /// represented in their raw string form, and can only usefully be tested for
 /// type equality.
 class OpaqueType
     : public Type::TypeBase<OpaqueType, Type, detail::OpaqueTypeStorage> {
public:
   iterator end() const { return getTypes().end(); }
 
   /// Return the element type at index 'index'.
   Type getType(size_t index) const {
     assert(index < size() && "invalid index for tuple type");
     return getTypes()[index];
   }
 };
+} // end namespace mlir
+
+//===----------------------------------------------------------------------===//
+// Tablegen Type Declarations
+//===----------------------------------------------------------------------===//
+
+#define GET_TYPEDEF_CLASSES
+#include "mlir/IR/BuiltinTypes.h.inc"
 
 //===----------------------------------------------------------------------===//
 // Deferred Method Definitions
 //===----------------------------------------------------------------------===//
 
+namespace mlir {
 inline bool BaseMemRefType::classof(Type type) {
   return type.isa<MemRefType, UnrankedMemRefType>();
 }
 
 inline bool FloatType::classof(Type type) {
   return type.isa<BFloat16Type, Float16Type, Float32Type, Float64Type>();
 }
 
+inline FloatType FloatType::getBF16(MLIRContext *ctx) {
+  return BFloat16Type::get(ctx);
+}
+
+inline FloatType FloatType::getF16(MLIRContext *ctx) {
+  return Float16Type::get(ctx);
+}
+
+inline FloatType FloatType::getF32(MLIRContext *ctx) {
+  return Float32Type::get(ctx);
+}
+
+inline FloatType FloatType::getF64(MLIRContext *ctx) {
+  return Float64Type::get(ctx);
+}
+
 inline bool ShapedType::classof(Type type) {
   return type.isa<RankedTensorType, VectorType, UnrankedTensorType,
                   UnrankedMemRefType, MemRefType>();
 }
 
 inline bool TensorType::classof(Type type) {
   return type.isa<RankedTensorType, UnrankedTensorType>();
 }

mlir/include/mlir/IR/BuiltinTypes.td

+//===- BuiltinTypes.td - Builtin type definitions ----------*- tablegen -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Defines the set of builtin MLIR types, or the set of types necessary for the
+// validity of and defining the IR.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef BUILTIN_TYPES
+#define BUILTIN_TYPES
+
+include "mlir/IR/BuiltinDialect.td"
+
+// TODO: Currently the types defined in this file are prefixed with `Builtin_`.
+// This is to differentiate the types here with the ones in OpBase.td. We should
+// remove the definitions in OpBase.td, and repoint users to this file instead.
+
+// Base class for Builtin dialect types.
+class Builtin_Type<string name> : TypeDef<Builtin_Dialect, name> {
+  let mnemonic = ?;
+}
+
+//===----------------------------------------------------------------------===//
+// FloatType
+//===----------------------------------------------------------------------===//
+
+// Base class for Builtin dialect float types.
+class Builtin_FloatType<string name> : TypeDef<Builtin_Dialect, name,
+                                               "::mlir::FloatType"> {
+  let extraClassDeclaration = [{
+    static }] # name # [{Type get(MLIRContext *context);
+  }];
+}
+
+//===----------------------------------------------------------------------===//
+// BFloat16Type
+
+def Builtin_BFloat16 : Builtin_FloatType<"BFloat16"> {
+  let summary = "bfloat16 floating-point type";
+}
+
+//===----------------------------------------------------------------------===//
+// Float16Type
+
+def Builtin_Float16 : Builtin_FloatType<"Float16"> {
+  let summary = "16-bit floating-point type";
+}
+
+//===----------------------------------------------------------------------===//
+// Float32Type
+
+def Builtin_Float32 : Builtin_FloatType<"Float32"> {
+  let summary = "32-bit floating-point type";
+}
+
+//===----------------------------------------------------------------------===//
+// Float64Type
+
+def Builtin_Float64 : Builtin_FloatType<"Float64"> {
+  let summary = "64-bit floating-point type";
+}
+
+//===----------------------------------------------------------------------===//
+// IndexType
+//===----------------------------------------------------------------------===//
+
+def Builtin_Index : Builtin_Type<"Index"> {
+  let summary = "Integer-like type with unknown platform-dependent bit width";
+  let description = [{
+    Syntax:
+
+    ```
+    // Target word-sized integer.
+    index-type ::= `index`
+    ```
+
+    The index type is a signless integer whose size is equal to the natural
+    machine word of the target ( [rationale](https://mlir.llvm.org/docs/Rationale/Rationale/#integer-signedness-semantics) )
+    and is used by the affine constructs in MLIR. Unlike fixed-size integers,
+    it cannot be used as an element of vector ( [rationale](https://mlir.llvm.org/docs/Rationale/Rationale/#index-type-disallowed-in-vector-types) ).
+
+    **Rationale:** integers of platform-specific bit widths are practical to
+    express sizes, dimensionalities and subscripts.
+  }];
+  let extraClassDeclaration = [{
+    static IndexType get(MLIRContext *context);
+
+    /// Storage bit width used for IndexType by internal compiler data
+    /// structures.
+    static constexpr unsigned kInternalStorageBitWidth = 64;
+  }];
+}
+
+//===----------------------------------------------------------------------===//
+// NoneType
+//===----------------------------------------------------------------------===//
+
+def Builtin_None : Builtin_Type<"None"> {
+  let summary = "A unit type";
+  let description = [{
+    NoneType is a unit type, i.e. a type with exactly one possible value, where
+    its value does not have a defined dynamic representation.
+  }];
+  let extraClassDeclaration = [{
+    static NoneType get(MLIRContext *context);
+  }];
+}
+
+#endif // BUILTIN_TYPES

mlir/include/mlir/IR/CMakeLists.txt

 add_mlir_interface(OpAsmInterface)
 add_mlir_interface(SymbolInterfaces)
 add_mlir_interface(RegionKindInterface)
 
+set(LLVM_TARGET_DEFINITIONS BuiltinDialect.td)
+mlir_tablegen(BuiltinDialect.h.inc -gen-dialect-decls)
+add_public_tablegen_target(MLIRBuiltinDialectIncGen)
+
 set(LLVM_TARGET_DEFINITIONS BuiltinOps.td)
 mlir_tablegen(BuiltinOps.h.inc -gen-op-decls)
 mlir_tablegen(BuiltinOps.cpp.inc -gen-op-defs)
-mlir_tablegen(BuiltinDialect.h.inc -gen-dialect-decls)
 add_public_tablegen_target(MLIRBuiltinOpsIncGen)
 
+set(LLVM_TARGET_DEFINITIONS BuiltinTypes.td)
+mlir_tablegen(BuiltinTypes.h.inc -gen-typedef-decls)
+mlir_tablegen(BuiltinTypes.cpp.inc -gen-typedef-defs)
+add_public_tablegen_target(MLIRBuiltinTypesIncGen)
+
 add_mlir_doc(BuiltinOps -gen-op-doc Builtin Dialects/)

mlir/include/mlir/IR/OpBase.td

 // so to replace the matched DAG with an existing SSA value.
 def replaceWithValue;
 
 
 //===----------------------------------------------------------------------===//
 // Data type generation
 //===----------------------------------------------------------------------===//
 
-// Define a new type belonging to a dialect and called 'name'.
-class TypeDef<Dialect owningdialect, string name> {
-  Dialect dialect = owningdialect;
+// Define a new type belonging to a dialect, named 'name', that inherits from
+// the given C++ base class.
+class TypeDef<Dialect dialect, string name,
+              string baseCppClass = "::mlir::Type">
+    : DialectType<dialect, CPred<"">> {
+  // The name of the C++ Type class.
   string cppClassName = name # "Type";
+  // The name of the C++ base class to use for this Type.
+  string cppBaseClassName = baseCppClass;
 
   // Short summary of the type.
   string summary = ?;
-  // The longer description of this type.
-  string description = ?;
 
   // Name of storage class to generate or use.
   string storageClass = name # "TypeStorage";
   // Namespace (withing dialect c++ namespace) in which the storage class
   // resides.
   string storageNamespace = "detail";
   // Specify if the storage class is to be generated.
   bit genStorageClass = 1;
class TypeDef<Dialect dialect, string name,
 
   // If set, generate accessors for each Type parameter.
   bit genAccessors = 1;
   // Generate the verifyConstructionInvariants declaration and getChecked
   // method.
   bit genVerifyInvariantsDecl = 0;
   // Extra code to include in the class declaration.
   code extraClassDeclaration = [{}];
+
+  // The predicate for when this type is used as a type constraint.
+  let predicate = CPred<"$_self.isa<" # dialect.cppNamespace #
+                                 "::" # cppClassName # ">()">;
+  // A constant builder provided when the type has no parameters.
+  let builderCall = !if(!empty(parameters),
+                           "$_builder.getType<" # dialect.cppNamespace #
+                               "::" # cppClassName # ">()",
+                           "");
 }
 
 // 'Parameters' should be subclasses of this or simple strings (which is a
 // shorthand for TypeParameter<"C++Type">).
 class TypeParameter<string type, string desc> {
   // Custom memory allocation code for storage constructor.
   code allocator = ?;
   // The C++ type of this parameter.

mlir/include/mlir/TableGen/TypeDef.h

public:
   bool hasDescription() const;
   StringRef getDescription() const;
   bool hasSummary() const;
   StringRef getSummary() const;
 
   // Returns the name of the C++ class to generate.
   StringRef getCppClassName() const;
 
+  // Returns the name of the C++ base class to use when generating this type.
+  StringRef getCppBaseClassName() const;
+
   // Returns the name of the storage class for this type.
   StringRef getStorageClassName() const;
 
   // Returns the C++ namespace for this types storage class.
   StringRef getStorageNamespace() const;
 
   // Returns true if we should generate the storage class.
   bool genStorageClass() const;

mlir/lib/IR/BuiltinTypes.cpp

 #include "llvm/ADT/BitVector.h"
 #include "llvm/ADT/Sequence.h"
 #include "llvm/ADT/Twine.h"
 
 using namespace mlir;
 using namespace mlir::detail;
 
 //===----------------------------------------------------------------------===//
+/// Tablegen Type Definitions
+//===----------------------------------------------------------------------===//
+
+#define GET_TYPEDEF_CLASSES
+#include "mlir/IR/BuiltinTypes.cpp.inc"
+
+//===----------------------------------------------------------------------===//
 /// ComplexType
 //===----------------------------------------------------------------------===//
 
 ComplexType ComplexType::get(Type elementType) {
   return Base::get(elementType.getContext(), elementType);
 }
 
 ComplexType ComplexType::getChecked(Type elementType, Location location) {

mlir/lib/IR/CMakeLists.txt

add_mlir_library(MLIRIR
   Value.cpp
   Verifier.cpp
   Visitors.cpp
 
   ADDITIONAL_HEADER_DIRS
   ${MLIR_MAIN_INCLUDE_DIR}/mlir/IR
 
   DEPENDS
+  MLIRBuiltinDialectIncGen
   MLIRBuiltinOpsIncGen
+  MLIRBuiltinTypesIncGen
   MLIRCallInterfacesIncGen
   MLIROpAsmInterfaceIncGen
   MLIRRegionKindInterfaceIncGen
   MLIRSymbolInterfacesIncGen
 
   LINK_LIBS PUBLIC
   MLIRSupport
   )

mlir/lib/TableGen/Constraint.cpp

 //===- Constraint.cpp - Constraint class ----------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Constraint wrapper to simplify using TableGen Record for constraints.
 //
 //===----------------------------------------------------------------------===//
 
 #include "mlir/TableGen/Constraint.h"
 #include "llvm/TableGen/Record.h"
 
+using namespace mlir;
 using namespace mlir::tblgen;
 
 Constraint::Constraint(const llvm::Record *record)
     : def(record), kind(CK_Uncategorized) {
   // Look through OpVariable's to their constraint.
   if (def->isSubClassOf("OpVariable"))
     def = def->getValueAsDef("constraint");
   if (def->isSubClassOf("TypeConstraint")) {
Pred Constraint::getPredicate() const {
   const auto *pred = dyn_cast<llvm::DefInit>(val->getValue());
   return Pred(pred);
 }
 
 std::string Constraint::getConditionTemplate() const {
   return getPredicate().getCondition();
 }
 
-llvm::StringRef Constraint::getDescription() const {
-  auto doc = def->getValueAsString("description");
-  if (doc.empty())
-    return def->getName();
-  return doc;
+StringRef Constraint::getDescription() const {
+  // If a summary is found, we use that given that it is a focused single line
+  // comment.
+  if (Optional<StringRef> summary = def->getValueAsOptionalString("summary"))
+    return *summary;
+  // If a summary can't be found, look for a specific description field to use
+  // for the constraint.
+  StringRef desc = def->getValueAsString("description");
+  if (!desc.empty())
+    return desc;
+  // Otherwise, fallback to the name of the constraint definition.
 }
 
 AppliedConstraint::AppliedConstraint(Constraint &&constraint,
                                      llvm::StringRef self,
                                      std::vector<std::string> &&entities)
     : constraint(constraint), self(std::string(self)),
       entities(std::move(entities)) {}

mlir/lib/TableGen/TypeDef.cpp

Dialect TypeDef::getDialect() const {
   return Dialect(dialectDef->getDef());
 }
 
 StringRef TypeDef::getName() const { return def->getName(); }
 StringRef TypeDef::getCppClassName() const {
   return def->getValueAsString("cppClassName");
 }
 
+StringRef TypeDef::getCppBaseClassName() const {
+  return def->getValueAsString("cppBaseClassName");
+}
+
 bool TypeDef::hasDescription() const {
   const llvm::RecordVal *s = def->getValue("description");
   return s != nullptr && isa<llvm::StringInit>(s->getValue());
 }
 
 StringRef TypeDef::getDescription() const {
   return def->getValueAsString("description");
 }

mlir/test/lib/Dialect/Test/TestDialect.cpp

 #include "TestTypes.h"
 #include "mlir/Dialect/StandardOps/IR/Ops.h"
 #include "mlir/IR/BuiltinOps.h"
 #include "mlir/IR/DialectImplementation.h"
 #include "mlir/IR/PatternMatch.h"
 #include "mlir/IR/TypeUtilities.h"
 #include "mlir/Transforms/FoldUtils.h"
 #include "mlir/Transforms/InliningUtils.h"
-#include "llvm/ADT/SetVector.h"
 #include "llvm/ADT/StringSwitch.h"
 
 using namespace mlir;
 using namespace mlir::test;
 
 void mlir::test::registerTestDialect(DialectRegistry &registry) {
   registry.insert<TestDialect>();
 }
#include "TestTypeDefs.cpp.inc"
   allowUnknownOperations();
 }
 
 Operation *TestDialect::materializeConstant(OpBuilder &builder, Attribute value,
                                             Type type, Location loc) {
   return builder.create<TestOpConstant>(loc, type, value);
 }
 
-static Type parseTestType(MLIRContext *ctxt, DialectAsmParser &parser,
-                          llvm::SetVector<Type> &stack) {
-  StringRef typeTag;
-  if (failed(parser.parseKeyword(&typeTag)))
-    return Type();
-
-  auto genType = generatedTypeParser(ctxt, parser, typeTag);
-  if (genType != Type())
-    return genType;
-
-  if (typeTag == "test_type")
-    return TestType::get(parser.getBuilder().getContext());
-
-  if (typeTag != "test_rec")
-    return Type();
-
-  StringRef name;
-  if (parser.parseLess() || parser.parseKeyword(&name))
-    return Type();
-  auto rec = TestRecursiveType::get(parser.getBuilder().getContext(), name);
-
-  // If this type already has been parsed above in the stack, expect just the
-  // name.
-  if (stack.contains(rec)) {
-    if (failed(parser.parseGreater()))
-      return Type();
-    return rec;
-  }
-
-  // Otherwise, parse the body and update the type.
-  if (failed(parser.parseComma()))
-    return Type();
-  stack.insert(rec);
-  Type subtype = parseTestType(ctxt, parser, stack);
-  stack.pop_back();
-  if (!subtype || failed(parser.parseGreater()) || failed(rec.setBody(subtype)))
-    return Type();
-
-  return rec;
-}
-
-Type TestDialect::parseType(DialectAsmParser &parser) const {
-  llvm::SetVector<Type> stack;
-  return parseTestType(getContext(), parser, stack);
-}
-
-static void printTestType(Type type, DialectAsmPrinter &printer,
-                          llvm::SetVector<Type> &stack) {
-  if (succeeded(generatedTypePrinter(type, printer)))
-    return;
-  if (type.isa<TestType>()) {
-    printer << "test_type";
-    return;
-  }
-
-  auto rec = type.cast<TestRecursiveType>();
-  printer << "test_rec<" << rec.getName();
-  if (!stack.contains(rec)) {
-    printer << ", ";
-    stack.insert(rec);
-    printTestType(rec.getBody(), printer, stack);
-    stack.pop_back();
-  }
-  printer << ">";
-}
-
-void TestDialect::printType(Type type, DialectAsmPrinter &printer) const {
-  llvm::SetVector<Type> stack;
-  printTestType(type, printer, stack);
-}
-
 LogicalResult TestDialect::verifyOperationAttribute(Operation *op,
                                                     NamedAttribute namedAttr) {
   if (namedAttr.first == "test.invalid_attr")
     return op->emitError() << "invalid to use 'test.invalid_attr'";
   return success();
 }
 
 LogicalResult TestDialect::verifyRegionArgAttribute(Operation *op,

mlir/test/lib/Dialect/Test/TestTypes.cpp

 //===- TestTypes.cpp - MLIR Test Dialect Types ------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file contains types defined by the TestDialect for testing various
 // features of MLIR.
 //
 //===----------------------------------------------------------------------===//
 
 #include "TestTypes.h"
+#include "TestDialect.h"
+#include "mlir/IR/Builders.h"
 #include "mlir/IR/DialectImplementation.h"
 #include "mlir/IR/Types.h"
 #include "llvm/ADT/Hashing.h"
+#include "llvm/ADT/SetVector.h"
 #include "llvm/ADT/TypeSwitch.h"
 
 using namespace mlir;
 using namespace mlir::test;
 
 // Custom parser for SignednessSemantics.
 static ParseResult
 parseSignedness(DialectAsmParser &parser,

 // Example type validity checker.
 LogicalResult TestIntegerType::verifyConstructionInvariants(
     Location loc, TestIntegerType::SignednessSemantics ss, unsigned int width) {
   if (width > 8)
     return failure();
   return success();
 }
 
+//===----------------------------------------------------------------------===//
+// Tablegen Generated Definitions
+//===----------------------------------------------------------------------===//
+
 #define GET_TYPEDEF_CLASSES
 #include "TestTypeDefs.cpp.inc"
+
+//===----------------------------------------------------------------------===//
+// TestDialect
+//===----------------------------------------------------------------------===//
+
+static Type parseTestType(MLIRContext *ctxt, DialectAsmParser &parser,
+                          llvm::SetVector<Type> &stack) {
+  StringRef typeTag;
+  if (failed(parser.parseKeyword(&typeTag)))
+    return Type();
+
+  auto genType = generatedTypeParser(ctxt, parser, typeTag);
+  if (genType != Type())
+    return genType;
+
+  if (typeTag == "test_type")
+    return TestType::get(parser.getBuilder().getContext());
+
+  if (typeTag != "test_rec")
+    return Type();
+
+  StringRef name;
+  if (parser.parseLess() || parser.parseKeyword(&name))
+    return Type();
+  auto rec = TestRecursiveType::get(parser.getBuilder().getContext(), name);
+
+  // If this type already has been parsed above in the stack, expect just the
+  // name.
+  if (stack.contains(rec)) {
+    if (failed(parser.parseGreater()))
+      return Type();
+    return rec;
+  }
+
+  // Otherwise, parse the body and update the type.
+  if (failed(parser.parseComma()))
+    return Type();
+  stack.insert(rec);
+  Type subtype = parseTestType(ctxt, parser, stack);
+  stack.pop_back();
+  if (!subtype || failed(parser.parseGreater()) || failed(rec.setBody(subtype)))
+    return Type();
+
+  return rec;
+}
+
+Type TestDialect::parseType(DialectAsmParser &parser) const {
+  llvm::SetVector<Type> stack;
+  return parseTestType(getContext(), parser, stack);
+}
+
+static void printTestType(Type type, DialectAsmPrinter &printer,
+                          llvm::SetVector<Type> &stack) {
+  if (succeeded(generatedTypePrinter(type, printer)))
+    return;
+  if (type.isa<TestType>()) {
+    printer << "test_type";
+    return;
+  }
+
+  auto rec = type.cast<TestRecursiveType>();
+  printer << "test_rec<" << rec.getName();
+  if (!stack.contains(rec)) {
+    printer << ", ";
+    stack.insert(rec);
+    printTestType(rec.getBody(), printer, stack);
+    stack.pop_back();
+  }
+  printer << ">";
+}
+
+void TestDialect::printType(Type type, DialectAsmPrinter &printer) const {
+  llvm::SetVector<Type> stack;
+  printTestType(type, printer, stack);
+}

mlir/test/mlir-tblgen/typedefs.td

 // RUN: mlir-tblgen -gen-typedef-decls -I %S/../../include %s | FileCheck %s --check-prefix=DECL
 // RUN: mlir-tblgen -gen-typedef-defs -I %S/../../include %s | FileCheck %s --check-prefix=DEF
 
 include "mlir/IR/OpBase.td"
 
 // DECL: #ifdef GET_TYPEDEF_CLASSES
 // DECL: #undef GET_TYPEDEF_CLASSES
 
 // DECL: namespace mlir {
 // DECL: class DialectAsmParser;
 // DECL: class DialectAsmPrinter;
 // DECL: } // namespace mlir
 
-// DECL: ::mlir::Type generatedTypeParser(::mlir::MLIRContext* ctxt, ::mlir::DialectAsmParser& parser, ::llvm::StringRef mnenomic);
-// DECL: ::mlir::LogicalResult generatedTypePrinter(::mlir::Type type, ::mlir::DialectAsmPrinter& printer);
-
 // DEF: #ifdef GET_TYPEDEF_LIST
 // DEF: #undef GET_TYPEDEF_LIST
 // DEF: ::mlir::test::SimpleAType,
 // DEF: ::mlir::test::CompoundAType,
 // DEF: ::mlir::test::IndexType,
 // DEF: ::mlir::test::SingleParameterType,
 // DEF: ::mlir::test::IntegerType
 

mlir/tools/mlir-tblgen/TypeDefGen.cpp

public:
 
   TypeParamCommaFormatter(EmitFormat emitFormat, ArrayRef<TypeParameter> params,
                           bool prependComma = true)
       : emitFormat(emitFormat), params(params), prependComma(prependComma) {}
 
   /// llvm::formatv will call this function when using an instance as a
   /// replacement value.
   void format(raw_ostream &os, StringRef options) override {
-    if (params.size() && prependComma)
+    if (!params.empty() && prependComma)
       os << ", ";
 
     switch (emitFormat) {
     case EmitFormat::TypeNamePairs:
       interleaveComma(params, os,
                       [&](const TypeParameter &p) { emitTypeNamePair(p, os); });
       break;
     case EmitFormat::TypeNameInitializer:

 class DialectAsmPrinter;
 } // namespace mlir
 )";
 
 /// The code block for the start of a typeDef class declaration -- singleton
 /// case.
 ///
 /// {0}: The name of the typeDef class.
+/// {1}: The name of the type base class.
 static const char *const typeDefDeclSingletonBeginStr = R"(
-  class {0}: public ::mlir::Type::TypeBase<{0}, ::mlir::Type, ::mlir::TypeStorage> {{
+  class {0}: public ::mlir::Type::TypeBase<{0}, {1}, ::mlir::TypeStorage> {{
   public:
     /// Inherit some necessary constructors from 'TypeBase'.
     using Base::Base;
 
 )";
 
 /// The code block for the start of a typeDef class declaration -- parametric
 /// case.
 ///
 /// {0}: The name of the typeDef class.
-/// {1}: The typeDef storage class namespace.
-/// {2}: The storage class name.
-/// {3}: The list of parameters with types.
+/// {1}: The name of the type base class.
+/// {2}: The typeDef storage class namespace.
+/// {3}: The storage class name.
+/// {4}: The list of parameters with types.
 static const char *const typeDefDeclParametricBeginStr = R"(
-  namespace {1} {
-    struct {2};
+  namespace {2} {
+    struct {3};
   }
-  class {0}: public ::mlir::Type::TypeBase<{0}, ::mlir::Type,
-                                        {1}::{2}> {{
+  class {0}: public ::mlir::Type::TypeBase<{0}, {1},
+                                        {2}::{3}> {{
   public:
     /// Inherit some necessary constructors from 'TypeBase'.
     using Base::Base;
 
 )";
 
 /// The snippet for print/parse.
 static const char *const typeDefParsePrint = R"(

 static void emitTypeDefDecl(const TypeDef &typeDef, raw_ostream &os) {
   SmallVector<TypeParameter, 4> params;
   typeDef.getParameters(params);
 
   // Emit the beginning string template: either the singleton or parametric
   // template.
   if (typeDef.getNumParameters() == 0)
     os << formatv(typeDefDeclSingletonBeginStr, typeDef.getCppClassName(),
-                  typeDef.getStorageNamespace(), typeDef.getStorageClassName());
+                  typeDef.getCppBaseClassName());
   else
     os << formatv(typeDefDeclParametricBeginStr, typeDef.getCppClassName(),
-                  typeDef.getStorageNamespace(), typeDef.getStorageClassName());
+                  typeDef.getCppBaseClassName(), typeDef.getStorageNamespace(),
+                  typeDef.getStorageClassName());
 
   // Emit the extra declarations first in case there's a type definition in
   // there.
   if (Optional<StringRef> extraDecl = typeDef.getExtraDecls())
     os << *extraDecl << "\n";
 
   TypeParamCommaFormatter emitTypeNamePairsAfterComma(
       TypeParamCommaFormatter::EmitFormat::TypeNamePairs, params);
+  if (!params.empty()) {
     os << llvm::formatv("    static {0} get(::mlir::MLIRContext* ctxt{1});\n",
                         typeDef.getCppClassName(), emitTypeNamePairsAfterComma);
+  }
 
   // Emit the verify invariants declaration.
   if (typeDef.genVerifyInvariantsDecl())
     os << llvm::formatv(typeDefDeclVerifyStr, emitTypeNamePairsAfterComma);
 
   // Emit the mnenomic, if specified.
   if (auto mnenomic = typeDef.getMnemonic()) {
     os << "    static ::llvm::StringRef getMnemonic() { return \"" << mnenomic
static bool emitTypeDefDecls(const llvm::RecordKeeper &recordKeeper,
   SmallVector<TypeDef, 16> typeDefs;
   findAllTypeDefs(recordKeeper, typeDefs);
 
   IfDefScope scope("GET_TYPEDEF_CLASSES", os);
 
   // Output the common "header".
   os << typeDefDeclHeader;
 
-  if (typeDefs.size() > 0) {
+  if (!typeDefs.empty()) {
     NamespaceEmitter nsEmitter(os, typeDefs.begin()->getDialect());
 
-    // Well known print/parse dispatch function declarations. These are called
-    // from Dialect::parseType() and Dialect::printType() methods.
-    os << "  ::mlir::Type generatedTypeParser(::mlir::MLIRContext* ctxt, "
-          "::mlir::DialectAsmParser& parser, ::llvm::StringRef mnenomic);\n";
-    os << "  ::mlir::LogicalResult generatedTypePrinter(::mlir::Type type, "
-          "::mlir::DialectAsmPrinter& printer);\n";
-    os << "\n";
-
     // Declare all the type classes first (in case they reference each other).
     for (const TypeDef &typeDef : typeDefs)
       os << "  class " << typeDef.getCppClassName() << ";\n";
 
     // Declare all the typedefs.
     for (const TypeDef &typeDef : typeDefs)
       emitTypeDefDecl(typeDef, os);
   }
static void emitTypeDefDef(TypeDef typeDef, raw_ostream &os) {
   NamespaceEmitter ns(os, typeDef.getDialect());
   SmallVector<TypeParameter, 4> parameters;
   typeDef.getParameters(parameters);
 
   // Emit the storage class, if requested and necessary.
   if (typeDef.genStorageClass() && typeDef.getNumParameters() > 0)
     emitStorageClass(typeDef, os);
 
+  if (!parameters.empty()) {
     os << llvm::formatv(
         "{0} {0}::get(::mlir::MLIRContext* ctxt{1}) {{\n"
         "  return Base::get(ctxt{2});\n}\n",
         typeDef.getCppClassName(),
         TypeParamCommaFormatter(
             TypeParamCommaFormatter::EmitFormat::TypeNamePairs, parameters),
         TypeParamCommaFormatter(TypeParamCommaFormatter::EmitFormat::JustParams,
                                 parameters));
+  }
 
   // Emit the parameter accessors.
   if (typeDef.genAccessors())
     for (const TypeParameter &parameter : parameters) {
       SmallString<16> name = parameter.getName();
       name[0] = llvm::toUpper(name[0]);
       os << formatv("{0} {3}::get{1}() const { return getImpl()->{2}; }\n",
                     parameter.getCppType(), name, parameter.getName(),
static void emitTypeDefDef(TypeDef typeDef, raw_ostream &os) {
   // If mnemonic is specified maybe print definitions for the parser and printer
   // code, if they're specified.
   if (typeDef.getMnemonic())
     emitParserPrinter(typeDef, os);
 }
 
 /// Emit the dialect printer/parser dispatcher. User's code should call these
 /// functions from their dialect's print/parse methods.
-static void emitParsePrintDispatch(SmallVectorImpl<TypeDef> &typeDefs,
-                                   raw_ostream &os) {
-  if (typeDefs.size() == 0)
+static void emitParsePrintDispatch(ArrayRef<TypeDef> types, raw_ostream &os) {
+  if (llvm::none_of(types, [](const TypeDef &type) {
+        return type.getMnemonic().hasValue();
+      })) {
     return;
-  const Dialect &dialect = typeDefs.begin()->getDialect();
-  NamespaceEmitter ns(os, dialect);
+  }
 
-  // The parser dispatch is just a list of if-elses, matching on the mnemonic
-  // and calling the class's parse function.
-  os << "::mlir::Type generatedTypeParser(::mlir::MLIRContext* ctxt, "
+  // The parser dispatch is just a list of if-elses, matching on the
+  // mnemonic and calling the class's parse function.
+  os << "static ::mlir::Type generatedTypeParser(::mlir::MLIRContext* "
+        "ctxt, "
         "::mlir::DialectAsmParser& parser, ::llvm::StringRef mnemonic) {\n";
-  for (const TypeDef &typeDef : typeDefs)
-    if (typeDef.getMnemonic())
+  for (const TypeDef &type : types)
+    if (type.getMnemonic())
       os << formatv("  if (mnemonic == {0}::{1}::getMnemonic()) return "
                     "{0}::{1}::parse(ctxt, parser);\n",
-                    typeDef.getDialect().getCppNamespace(),
-                    typeDef.getCppClassName());
+                    type.getDialect().getCppNamespace(),
+                    type.getCppClassName());
   os << "  return ::mlir::Type();\n";
   os << "}\n\n";
 
   // The printer dispatch uses llvm::TypeSwitch to find and call the correct
   // printer.
-  os << "::mlir::LogicalResult generatedTypePrinter(::mlir::Type type, "
+  os << "static ::mlir::LogicalResult generatedTypePrinter(::mlir::Type "
+        "type, "
         "::mlir::DialectAsmPrinter& printer) {\n"
      << "  ::mlir::LogicalResult found = ::mlir::success();\n"
      << "  ::llvm::TypeSwitch<::mlir::Type>(type)\n";
-  for (auto typeDef : typeDefs)
-    if (typeDef.getMnemonic())
+  for (const TypeDef &type : types)
+    if (type.getMnemonic())
       os << formatv("    .Case<{0}::{1}>([&](::mlir::Type t) {{ "
                     "t.dyn_cast<{0}::{1}>().print(printer); })\n",
-                    typeDef.getDialect().getCppNamespace(),
-                    typeDef.getCppClassName());
+                    type.getDialect().getCppNamespace(),
+                    type.getCppClassName());
   os << "    .Default([&found](::mlir::Type) { found = ::mlir::failure(); "
         "});\n"
      << "  return found;\n"
      << "}\n\n";
 }
 
 /// Entry point for typedef definitions.
 static bool emitTypeDefDefs(const llvm::RecordKeeper &recordKeeper,