[llvm] [mlir] [MLIR][IRDL] Added IRDL to C++ Translation (PR #133982)
Fehr Mathieu via llvm-commits
llvm-commits at lists.llvm.org
Wed Apr 2 08:57:49 PDT 2025
=?utf-8?q?Théo?= Degioanni,=?utf-8?q?Théo?= Degioanni,
=?utf-8?q?Théo?= Degioanni,=?utf-8?q?Théo?= Degioanni,Ivan Ho
<ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,--set <--set>,Ivan Ho
<ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,=?utf-8?q?Théo?= Degioanni,
=?utf-8?q?Théo?= Degioanni,Ivan Ho <ihkh2 at cam.ac.uk>,
=?utf-8?q?Théo?= Degioanni,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho
<ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho
<38537881+hhkit at users.noreply.github.com>,=?utf-8?q?Théo?= Degioanni,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <38537881+hhkit at users.noreply.github.com>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan
Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>,
=?utf-8?q?Théo?= Degioanni,=?utf-8?q?Théo?= Degioanni,Ivan Ho
<ihkh2 at cam.ac.uk>,Ivan Ho <ihkh2 at cam.ac.uk>
Message-ID:
In-Reply-To: <llvm.org/llvm/llvm-project/pull/133982 at github.com>
================
@@ -0,0 +1,570 @@
+//===- IRDLToCpp.cpp - Converts IRDL definitions to 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "mlir/Target/IRDLToCpp/IRDLToCpp.h"
+#include "mlir/Dialect/IRDL/IR/IRDL.h"
+#include "mlir/Support/LLVM.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/ADT/SmallString.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/StringExtras.h"
+#include "llvm/ADT/TypeSwitch.h"
+#include "llvm/Support/FormatVariadic.h"
+#include "llvm/Support/raw_ostream.h"
+
+#include "TemplatingUtils.h"
+
+using namespace mlir;
+
+constexpr char headerTemplateText[] =
+#include "Templates/Header.txt"
+ ;
+
+constexpr char declarationMacroFlag[] = "GEN_DIALECT_DECL_HEADER";
+constexpr char definitionMacroFlag[] = "GEN_DIALECT_DEF";
+
+namespace {
+
+struct DialectStrings {
+ StringRef dialectName;
+ StringRef dialectCppName;
+ StringRef dialectCppShortName;
+ StringRef dialectBaseTypeName;
+
+ StringRef namespaceOpen;
+ StringRef namespaceClose;
+ StringRef namespacePath;
+};
+
+struct TypeStrings {
+ StringRef typeName;
+ std::string typeCppName;
+};
+
+struct OpStrings {
+ StringRef opName;
+ std::string opCppName;
+ SmallVector<std::string> opResultNames;
+ SmallVector<std::string> opOperandNames;
+};
+
+static std::string joinNameList(llvm::ArrayRef<std::string> names) {
+ std::string nameArray;
+ llvm::raw_string_ostream nameArrayStream(nameArray);
+ nameArrayStream << "{\"" << llvm::join(names, "\", \"") << "\"}";
+
+ return nameArray;
+}
+
+static std::string typeToCppName(irdl::TypeOp type) {
+ return llvm::formatv("{0}Type",
+ convertToCamelFromSnakeCase(type.getSymName(), true));
+}
+
+static std::string opToCppName(irdl::OperationOp op) {
+ return llvm::formatv("{0}Op",
+ convertToCamelFromSnakeCase(op.getSymName(), true));
+}
+
+static TypeStrings getStrings(irdl::TypeOp type) {
+ TypeStrings strings;
+ strings.typeName = type.getSymName();
+ strings.typeCppName = typeToCppName(type);
+ return strings;
+}
+
+static OpStrings getStrings(irdl::OperationOp op) {
+ auto operands = op.getOps<irdl::OperandsOp>();
+ auto operandOp =
+ operands.empty() ? std::optional<irdl::OperandsOp>{} : *operands.begin();
+
+ auto results = op.getOps<irdl::ResultsOp>();
+ auto resultOp =
+ results.empty() ? std::optional<irdl::ResultsOp>{} : *results.begin();
+
+ OpStrings strings;
+ strings.opName = op.getSymName();
+ strings.opCppName = opToCppName(op);
+
+ if (operandOp) {
+ strings.opOperandNames = SmallVector<std::string>(
+ llvm::map_range(operandOp->getNames(), [](Attribute attr) {
+ return llvm::formatv("{0}", cast<StringAttr>(attr));
+ }));
+ }
+
+ if (resultOp) {
+ strings.opResultNames = SmallVector<std::string>(
+ llvm::map_range(resultOp->getNames(), [](Attribute attr) {
+ return llvm::formatv("{0}", cast<StringAttr>(attr));
+ }));
+ }
+
+ return strings;
+}
+
+static void fillDict(irdl::detail::dictionary &dict,
+ const TypeStrings &strings) {
+ dict["TYPE_NAME"] = strings.typeName;
+ dict["TYPE_CPP_NAME"] = strings.typeCppName;
+}
+
+static void fillDict(irdl::detail::dictionary &dict, const OpStrings &strings) {
+ const auto operandCount = strings.opOperandNames.size();
+ const auto resultCount = strings.opResultNames.size();
+
+ dict["OP_NAME"] = strings.opName;
+ dict["OP_CPP_NAME"] = strings.opCppName;
+ dict["OP_OPERAND_COUNT"] = std::to_string(strings.opOperandNames.size());
+ dict["OP_RESULT_COUNT"] = std::to_string(strings.opResultNames.size());
+ dict["OP_OPERAND_INITIALIZER_LIST"] =
+ operandCount ? joinNameList(strings.opOperandNames) : "{\"\"}";
+ dict["OP_RESULT_INITIALIZER_LIST"] =
+ resultCount ? joinNameList(strings.opResultNames) : "{\"\"}";
+}
+
+static void fillDict(irdl::detail::dictionary &dict,
+ const DialectStrings &strings) {
+ dict["DIALECT_NAME"] = strings.dialectName;
+ dict["DIALECT_BASE_TYPE_NAME"] = strings.dialectBaseTypeName;
+ dict["DIALECT_CPP_NAME"] = strings.dialectCppName;
+ dict["DIALECT_CPP_SHORT_NAME"] = strings.dialectCppShortName;
+ dict["NAMESPACE_OPEN"] = strings.namespaceOpen;
+ dict["NAMESPACE_CLOSE"] = strings.namespaceClose;
+ dict["NAMESPACE_PATH"] = strings.namespacePath;
+}
+
+static LogicalResult generateTypedefList(irdl::DialectOp &dialect,
+ SmallVector<std::string> &typeNames) {
+ auto typeOps = dialect.getOps<irdl::TypeOp>();
+ auto range = llvm::map_range(typeOps, typeToCppName);
+ typeNames = SmallVector<std::string>(range);
+ return success();
+}
+
+static LogicalResult generateOpList(irdl::DialectOp &dialect,
+ SmallVector<std::string> &opNames) {
+ auto operationOps = dialect.getOps<irdl::OperationOp>();
+ auto range = llvm::map_range(operationOps, opToCppName);
+ opNames = SmallVector<std::string>(range);
+ return success();
+}
+
+} // namespace
+
+static LogicalResult generateTypeInclude(irdl::TypeOp type, raw_ostream &output,
+ irdl::detail::dictionary &dict) {
+ static const auto typeDeclTemplate = irdl::detail::Template(
+#include "Templates/TypeDecl.txt"
+ );
+
+ fillDict(dict, getStrings(type));
+ typeDeclTemplate.render(output, dict);
+
+ return success();
+}
+
+static void generateOpGetterDeclarations(irdl::detail::dictionary &dict,
+ const OpStrings &opStrings) {
+ auto opGetters = std::string{};
+ auto resGetters = std::string{};
+
+ for (size_t i = 0; i < opStrings.opOperandNames.size(); ++i) {
+ const auto op =
+ llvm::convertToCamelFromSnakeCase(opStrings.opOperandNames[i], true);
+ opGetters += llvm::formatv("::mlir::Value get{0}() { return "
+ "getStructuredOperands({1}).front(); }\n ",
+ op, i);
+ }
+ for (size_t i = 0; i < opStrings.opResultNames.size(); ++i) {
+ const auto op =
+ llvm::convertToCamelFromSnakeCase(opStrings.opResultNames[i], true);
+ resGetters += llvm::formatv(
+ R"(::mlir::Value get{0}() { return ::llvm::cast<::mlir::Value>(getStructuredResults({1}).front()); }
+ )",
+ op, i);
+ }
+
+ dict["OP_OPERAND_GETTER_DECLS"] = opGetters;
+ dict["OP_RESULT_GETTER_DECLS"] = resGetters;
+}
+
+static void generateOpBuilderDeclarations(irdl::detail::dictionary &dict,
+ const OpStrings &opStrings) {
+ std::string buildDecls;
+ llvm::raw_string_ostream stream{buildDecls};
+
+ auto resultParams =
+ llvm::join(llvm::map_range(opStrings.opResultNames,
+ [](StringRef name) -> std::string {
+ return llvm::formatv(
+ "::mlir::Type {0}, ",
+ llvm::convertToCamelFromSnakeCase(name));
+ }),
+ "");
+
+ auto operandParams =
+ llvm::join(llvm::map_range(opStrings.opOperandNames,
+ [](StringRef name) -> std::string {
+ return llvm::formatv(
+ "::mlir::Value {0}, ",
+ llvm::convertToCamelFromSnakeCase(name));
+ }),
+ "");
+
+ stream << llvm::formatv(
+ R"(static void build(::mlir::OpBuilder &opBuilder, ::mlir::OperationState &opState, {0} {1} ::llvm::ArrayRef<::mlir::NamedAttribute> attributes = {{});)",
+ resultParams, operandParams);
+ dict["OP_BUILD_DECLS"] = buildDecls;
+}
+
+static LogicalResult generateOperationInclude(irdl::OperationOp op,
+ raw_ostream &output,
+ irdl::detail::dictionary &dict) {
+ static const auto perOpDeclTemplate = irdl::detail::Template(
+#include "Templates/PerOperationDecl.txt"
+ );
+ const auto opStrings = getStrings(op);
+ fillDict(dict, opStrings);
+
+ generateOpGetterDeclarations(dict, opStrings);
+ generateOpBuilderDeclarations(dict, opStrings);
+
+ perOpDeclTemplate.render(output, dict);
+ return success();
+}
+
+static LogicalResult generateInclude(irdl::DialectOp dialect,
+ raw_ostream &output,
+ DialectStrings &dialectStrings) {
+ static const auto dialectDeclTemplate = irdl::detail::Template(
+#include "Templates/DialectDecl.txt"
+ );
+ static const auto typeHeaderDeclTemplate = irdl::detail::Template(
+#include "Templates/TypeHeaderDecl.txt"
+ );
+ output << "#ifdef " << declarationMacroFlag << "\n#undef "
+ << declarationMacroFlag << "\n";
+
+ irdl::detail::dictionary dict;
+ fillDict(dict, dialectStrings);
+
+ dialectDeclTemplate.render(output, dict);
+ typeHeaderDeclTemplate.render(output, dict);
+
+ auto typeOps = dialect.getOps<irdl::TypeOp>();
+ auto operationOps = dialect.getOps<irdl::OperationOp>();
+
+ for (auto &&typeOp : typeOps) {
+ if (failed(generateTypeInclude(typeOp, output, dict)))
+ return failure();
+ }
+
+ SmallVector<std::string> opNames;
+ if (failed(generateOpList(dialect, opNames)))
+ return failure();
+
+ auto classDeclarations =
+ llvm::join(llvm::map_range(opNames,
+ [](llvm::StringRef name) -> std::string {
+ return llvm::formatv("class {0};", name);
+ }),
+ "\n");
+ const auto forwardDeclarations = llvm::formatv(
+ "{1}\n{0}\n{2}", std::move(classDeclarations),
+ dialectStrings.namespaceOpen, dialectStrings.namespaceClose);
+
+ output << forwardDeclarations;
+ for (auto &&operationOp : operationOps) {
+ if (failed(generateOperationInclude(operationOp, output, dict)))
+ return failure();
+ }
+
+ output << "#endif // " << declarationMacroFlag << "\n";
+
+ return success();
+}
+
+static std::string generateOpDefinition(irdl::detail::dictionary &dict,
+ irdl::OperationOp op) {
+ static const auto perOpDefTemplate = mlir::irdl::detail::Template{
+#include "Templates/PerOperationDef.txt"
+ };
+
+ auto opStrings = getStrings(op);
+ fillDict(dict, opStrings);
+
+ const auto operandCount = opStrings.opOperandNames.size();
+ const auto operandNames =
+ operandCount ? joinNameList(opStrings.opOperandNames) : "{\"\"}";
+
+ const auto resultNames = joinNameList(opStrings.opResultNames);
+
+ auto resultTypes = llvm::join(
+ llvm::map_range(opStrings.opResultNames,
+ [](StringRef attr) -> std::string {
+ return llvm::formatv("::mlir::Type {0}, ", attr);
+ }),
+ "");
+ auto operandTypes = llvm::join(
+ llvm::map_range(opStrings.opOperandNames,
+ [](StringRef attr) -> std::string {
+ return llvm::formatv("::mlir::Value {0}, ", attr);
+ }),
+ "");
+ auto operandAdder =
+ llvm::join(llvm::map_range(opStrings.opOperandNames,
+ [](StringRef attr) -> std::string {
+ return llvm::formatv(
+ " opState.addOperands({0});", attr);
+ }),
+ "\n");
+ auto resultAdder = llvm::join(
+ llvm::map_range(opStrings.opResultNames,
+ [](StringRef attr) -> std::string {
+ return llvm::formatv(" opState.addTypes({0});", attr);
+ }),
+ "\n");
+
+ const auto buildDefinition = llvm::formatv(
+ R"(
+void {0}::build(::mlir::OpBuilder &opBuilder, ::mlir::OperationState &opState, {1} {2} ::llvm::ArrayRef<::mlir::NamedAttribute> attributes) {{
+{3}
+{4}
+}
+)",
+ opStrings.opCppName, std::move(resultTypes), std::move(operandTypes),
+ std::move(operandAdder), std::move(resultAdder));
+
+ dict["OP_BUILD_DEFS"] = buildDefinition;
+
+ std::string str;
+ llvm::raw_string_ostream stream{str};
+ perOpDefTemplate.render(stream, dict);
+ return str;
+}
+
+static std::string
+generateTypeVerifierCase(StringRef name, const DialectStrings &dialectStrings) {
+ return llvm::formatv(
+ R"(.Case({1}::{0}::getMnemonic(), [&](llvm::StringRef, llvm::SMLoc) {
+value = {1}::{0}::get(parser.getContext());
+return ::mlir::success(!!value);
+}))",
+ name, dialectStrings.namespacePath);
+}
+
+static LogicalResult generateLib(irdl::DialectOp dialect, raw_ostream &output,
+ DialectStrings &dialectStrings) {
+
+ static const auto typeHeaderDefTemplate = mlir::irdl::detail::Template{
+#include "Templates/TypeHeaderDef.txt"
+ };
+ static const auto typeDefTemplate = mlir::irdl::detail::Template{
+#include "Templates/TypeDef.txt"
+ };
+ static const auto dialectDefTemplate = mlir::irdl::detail::Template{
+#include "Templates/DialectDef.txt"
+ };
+
+ irdl::detail::dictionary dict;
+ fillDict(dict, dialectStrings);
+
+ output << "#ifdef " << definitionMacroFlag << "\n#undef "
+ << definitionMacroFlag << "\n";
+
+ typeHeaderDefTemplate.render(output, dict);
+
+ SmallVector<std::string> typeNames;
+ if (failed(generateTypedefList(dialect, typeNames)))
+ return failure();
+
+ dict["TYPE_LIST"] = llvm::join(
+ llvm::map_range(typeNames,
+ [&dialectStrings](llvm::StringRef name) -> std::string {
+ return llvm::formatv(
+ "{0}::{1}", dialectStrings.namespacePath, name);
+ }),
+ ",\n");
+
+ auto typeVerifierGenerator =
+ [&dialectStrings](llvm::StringRef name) -> std::string {
+ return generateTypeVerifierCase(name, dialectStrings);
+ };
+
+ auto typeCase =
+ llvm::join(llvm::map_range(typeNames, typeVerifierGenerator), "\n");
+
+ dict["TYPE_PARSER"] = llvm::formatv(
+ R"(static ::mlir::OptionalParseResult generatedTypeParser(::mlir::AsmParser &parser, ::llvm::StringRef *mnemonic, ::mlir::Type &value) {
+ return ::mlir::AsmParser::KeywordSwitch<::mlir::OptionalParseResult>(parser)
+ {0}
+ .Default([&](llvm::StringRef keyword, llvm::SMLoc) {{
+ *mnemonic = keyword;
+ return std::nullopt;
+ });
+})",
+ std::move(typeCase));
+
+ auto typePrintCase =
+ llvm::join(llvm::map_range(typeNames,
+ [&](llvm::StringRef name) -> std::string {
+ return llvm::formatv(
+ R"(.Case<{1}::{0}>([&](auto t) {
+ printer << {1}::{0}::getMnemonic();
+ return ::mlir::success();
+ }))",
+ name, dialectStrings.namespacePath);
+ }),
+ "\n");
+ dict["TYPE_PRINTER"] = llvm::formatv(
+ R"(static ::llvm::LogicalResult generatedTypePrinter(::mlir::Type def, ::mlir::AsmPrinter &printer) {
+ return ::llvm::TypeSwitch<::mlir::Type, ::llvm::LogicalResult>(def)
+ {0}
+ .Default([](auto) {{ return ::mlir::failure(); });
+})",
+ std::move(typePrintCase));
+
+ dict["TYPE_DEFINES"] =
+ join(map_range(typeNames,
+ [&](StringRef name) -> std::string {
+ return formatv("MLIR_DEFINE_EXPLICIT_TYPE_ID({1}::{0})",
+ name, dialectStrings.namespacePath);
+ }),
+ "\n");
+
+ typeDefTemplate.render(output, dict);
+
+ auto operations = dialect.getOps<irdl::OperationOp>();
+ SmallVector<std::string> opNames;
+ if (failed(generateOpList(dialect, opNames)))
+ return failure();
+
+ const auto commaSeparatedOpList = llvm::join(
+ map_range(opNames,
+ [&dialectStrings](llvm::StringRef name) -> std::string {
+ return llvm::formatv("{0}::{1}", dialectStrings.namespacePath,
+ name);
+ }),
+ ",\n");
+
+ const auto opDefinitionGenerator = [&dict](irdl::OperationOp op) {
+ return generateOpDefinition(dict, op);
+ };
+
+ const auto perOpDefinitions =
+ llvm::join(llvm::map_range(operations, opDefinitionGenerator), "\n");
+
+ dict["OP_LIST"] = commaSeparatedOpList;
+ dict["OP_CLASSES"] = perOpDefinitions;
+ output << perOpDefinitions;
+ dialectDefTemplate.render(output, dict);
+
+ output << "#endif // " << definitionMacroFlag << "\n";
+ return success();
+}
+
+static LogicalResult verifySupported(irdl::DialectOp dialect) {
+ LogicalResult res = success();
+ dialect.walk([&](mlir::Operation *op) {
+ res =
+ llvm::TypeSwitch<Operation *, LogicalResult>(op)
+ .Case<irdl::DialectOp>(([](irdl::DialectOp) { return success(); }))
+ .Case<irdl::OperationOp>(
+ ([](irdl::OperationOp) { return success(); }))
+ .Case<irdl::TypeOp>(([](irdl::TypeOp) { return success(); }))
+ .Case<irdl::OperandsOp>(([](irdl::OperandsOp op) {
+ if (llvm::all_of(
+ op.getVariadicity(), [](irdl::VariadicityAttr attr) {
+ return attr.getValue() == irdl::Variadicity::single;
+ }))
+ return success();
+ return failure();
+ }))
+ .Case<irdl::ResultsOp>(([](irdl::ResultsOp op) {
+ if (llvm::all_of(
+ op.getVariadicity(), [](irdl::VariadicityAttr attr) {
+ return attr.getValue() == irdl::Variadicity::single;
+ }))
+ return success();
+ return failure();
----------------
math-fehr wrote:
Same here
https://github.com/llvm/llvm-project/pull/133982
More information about the llvm-commits
mailing list