[mlir][standalone] Extend sample with custom type

[marbre]

Summary

This extends the standalone example to illustrate how to structure the
files needed to create own types.

[marbre]

This was presented as part of my talk How to Build your own MLIR Dialect at FOSDEM 2023.

[jpienaar]

Nice, thanks

[mehdi_amini]

Nice!

mlir/examples/standalone/include/Standalone/StandaloneDialect.td

def Standalone_Dialect : Dialect {
     let summary = "A standalone out-of-tree MLIR dialect.";
     let description = [{
         This dialect is an example of an out-of-tree MLIR dialect designed to
         illustrate the basic setup required to develop MLIR-based tools without
         working inside of the LLVM source tree.
     }];
     let cppNamespace = "::mlir::standalone";
 
+    let useDefaultTypePrinterParser = 1;
+    let extraClassDeclaration = [{
+        void registerTypes();
+    }];
 }
 
 //===----------------------------------------------------------------------===//
 // Base standalone operation definition.
 //===----------------------------------------------------------------------===//
 
 class Standalone_Op<string mnemonic, list<Trait> traits = []> :
         Op<Standalone_Dialect, mnemonic, traits>;
 
 #endif // STANDALONE_DIALECT

mlir/examples/standalone/include/Standalone/StandaloneOps.td

 //===- StandaloneOps.td - Standalone dialect ops -----------*- tablegen -*-===//
 //
 // This file is licensed 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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef STANDALONE_OPS
 #define STANDALONE_OPS
 
-include "Standalone/StandaloneDialect.td"
+include "Standalone/StandaloneTypes.td"
 include "mlir/Interfaces/InferTypeOpInterface.td"
 include "mlir/Interfaces/SideEffectInterfaces.td"
 
 def Standalone_FooOp : Standalone_Op<"foo", [Pure,
                                              SameOperandsAndResultType]> {
     let summary = "Illustrates how to define an operation.";
     let description = [{
         The `standalone.foo` operation illustrates how to define a new

mlir/examples/standalone/include/Standalone/StandaloneTypes.h

+//===- StandaloneTypes.h - Standalone dialect types -------------*- C++ -*-===//
+//
+// This file is licensed 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef STANDALONE_STANDALONETYPES_H
+#define STANDALONE_STANDALONETYPES_H
+
+#include "mlir/IR/BuiltinTypes.h"
+
+#define GET_TYPEDEF_CLASSES
+#include "Standalone/StandaloneOpsTypes.h.inc"
+
+#endif // STANDALONE_STANDALONETYPES_H

mlir/examples/standalone/include/Standalone/StandaloneTypes.td

+//===- StandaloneTypes.td - Standalone dialect types -------*- tablegen -*-===//
+//
+// This file is licensed 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef STANDALONE_TYPES
+#define STANDALONE_TYPES
+
+include "mlir/IR/AttrTypeBase.td"
+include "Standalone/StandaloneDialect.td"
+
+//===----------------------------------------------------------------------===//
+// Standalone type definitions
+//===----------------------------------------------------------------------===//
+
+class Standalone_Type<string name, string typeMnemonic, list<Trait> traits = []>
+    : TypeDef<Standalone_Dialect, name, traits> {
+  let mnemonic = typeMnemonic;
+}
+
+def Standalone_CustomType : Standalone_Type<"Custom", "custom"> {
+    let summary = "Standalone custom type";
+    let description = "Custom type in standalone dialect";
+    let parameters = (ins StringRefParameter<"the custom value">:$value);
+    let assemblyFormat = "`<` $value `>`";
+}
+
+#endif // STANDALONE_TYPES

mlir/examples/standalone/lib/Standalone/CMakeLists.txt

 add_mlir_dialect_library(MLIRStandalone
+        StandaloneTypes.cpp
         StandaloneDialect.cpp
         StandaloneOps.cpp
 
         ADDITIONAL_HEADER_DIRS
         ${PROJECT_SOURCE_DIR}/include/Standalone
 
         DEPENDS
         MLIRStandaloneOpsIncGen
 
   LINK_LIBS PUBLIC
   MLIRIR
         MLIRInferTypeOpInterface
   )

mlir/examples/standalone/lib/Standalone/StandaloneDialect.cpp

 //===- StandaloneDialect.cpp - Standalone dialect ---------------*- C++ -*-===//
 //
 // This file is licensed 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
 //
 //===----------------------------------------------------------------------===//
 
 #include "Standalone/StandaloneDialect.h"
 #include "Standalone/StandaloneOps.h"
+#include "Standalone/StandaloneTypes.h"
 
 using namespace mlir;
 using namespace mlir::standalone;
 
 #include "Standalone/StandaloneOpsDialect.cpp.inc"
 
 //===----------------------------------------------------------------------===//
 // Standalone dialect.
 //===----------------------------------------------------------------------===//
 
 void StandaloneDialect::initialize() {
   addOperations<
 #define GET_OP_LIST
 #include "Standalone/StandaloneOps.cpp.inc"
       >();
+  registerTypes();
 }

mlir/examples/standalone/lib/Standalone/StandaloneTypes.cpp

+//===- StandaloneTypes.cpp - Standalone dialect types -----------*- C++ -*-===//
+//
+// This file is licensed 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "Standalone/StandaloneTypes.h"
+
+#include "Standalone/StandaloneDialect.h"
+#include "mlir/IR/Builders.h"
+#include "mlir/IR/DialectImplementation.h"
+#include "llvm/ADT/TypeSwitch.h"
+
+using namespace mlir::standalone;
+
+#define GET_TYPEDEF_CLASSES
+#include "Standalone/StandaloneOpsTypes.cpp.inc"
+
+void StandaloneDialect::registerTypes() {
+  addTypes<
+#define GET_TYPEDEF_LIST
+#include "Standalone/StandaloneOpsTypes.cpp.inc"
+      >();
+}

mlir/examples/standalone/test/Standalone/dummy.mlir

 // RUN: standalone-opt %s | standalone-opt | FileCheck %s
 
 module {
     // CHECK-LABEL: func @bar()
     func.func @bar() {
         %0 = arith.constant 1 : i32
         // CHECK: %{{.*}} = standalone.foo %{{.*}} : i32
         %res = standalone.foo %0 : i32
         return
     }
+
+    // CHECK-LABEL: func @standalone_types(%arg0: !standalone.custom<"10">)
+    func.func @standalone_types(%arg0: !standalone.custom<"10">) {
+        return
+    }
 }