[clang] [mlir] [mlir][ODS] Fully qualify names in generated bytecode readers and writers (PR #241224)
via cfe-commits
cfe-commits at lists.llvm.org
Wed Nov 11 03:06:17 PST 2026
llvmorg-github-actions[bot] wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-mlir-core
Author: Markus Böck (zero9178)
<details>
<summary>Changes</summary>
The code generated by `-gen-bytecode` referred to MLIR and LLVM constructs such as `MLIRContext`, `DialectBytecodeReader`, `LogicalResult`, `TypeSwitch` and `getChecked` without qualification, as did the snippets in `BytecodeBase.td`. It therefore only compiled in a source file with `using namespace mlir;`.
This PR fully qualifies all names emitted by the generator and by `BytecodeBase.td`. Performed a minor refactor while doing so that also fixes an error message and makes the code less ad-hoc
---
Patch is 22.27 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/241224.diff
7 Files Affected:
- (modified) clang/include/clang/CIR/Dialect/IR/CIRDialectBytecode.td (+2)
- (modified) clang/lib/CIR/Dialect/IR/CIRDialectBytecode.cpp (-5)
- (modified) mlir/include/mlir/IR/BytecodeBase.td (+23-19)
- (modified) mlir/test/Bytecode/bytecode_callback_full_override.mlir (+1-1)
- (modified) mlir/test/mlir-tblgen/bytecode-reserved.td (+1-1)
- (modified) mlir/test/mlir-tblgen/bytecode-write.td (+5-5)
- (modified) mlir/tools/mlir-tblgen/BytecodeDialectGen.cpp (+75-64)
``````````diff
diff --git a/clang/include/clang/CIR/Dialect/IR/CIRDialectBytecode.td b/clang/include/clang/CIR/Dialect/IR/CIRDialectBytecode.td
index faff6de30caee7..465ff1c3c537f8 100644
--- a/clang/include/clang/CIR/Dialect/IR/CIRDialectBytecode.td
+++ b/clang/include/clang/CIR/Dialect/IR/CIRDialectBytecode.td
@@ -129,9 +129,11 @@ def FPAttr : DialectAttribute<(attr
}
// BoolType is a singleton, so the type is rebuilt on read rather than stored.
+// Qualified, as the name is ambiguous with mlir::BoolAttr otherwise.
def BoolAttr : DialectAttribute<(attr
Bool:$value
)> {
+ let cType = "::cir::BoolAttr";
let cBuilder = "get<$_resultType>(context, cir::BoolType::get(context), value)";
}
diff --git a/clang/lib/CIR/Dialect/IR/CIRDialectBytecode.cpp b/clang/lib/CIR/Dialect/IR/CIRDialectBytecode.cpp
index 877ab487bba448..51555b6ecbad00 100644
--- a/clang/lib/CIR/Dialect/IR/CIRDialectBytecode.cpp
+++ b/clang/lib/CIR/Dialect/IR/CIRDialectBytecode.cpp
@@ -24,11 +24,6 @@ using namespace cir;
namespace {
-// Both namespaces declare a BoolAttr, named unqualified below. This must live
-// in the inner namespace: at global scope it merges with the using-directives
-// and stays ambiguous.
-using cir::BoolAttr;
-
//===--------------------------------------------------------------------===//
// Helpers referenced by the generated readers
//===--------------------------------------------------------------------===//
diff --git a/mlir/include/mlir/IR/BytecodeBase.td b/mlir/include/mlir/IR/BytecodeBase.td
index 3eab62493ffef2..9419efb3b17d33 100644
--- a/mlir/include/mlir/IR/BytecodeBase.td
+++ b/mlir/include/mlir/IR/BytecodeBase.td
@@ -67,51 +67,55 @@ class WithGetter<string g="", Bytecode t=Bytecode<>> :
class CompositeBytecode<string t = ""> : WithType<t>;
class AttributeKind :
- WithParser <"succeeded($_reader.readAttribute($_var))",
+ WithParser <"::mlir::succeeded($_reader.readAttribute($_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeAttribute($_getter)">>>;
-def Attribute : AttributeKind;
+def Attribute : AttributeKind {
+ let cType = "::mlir::Attribute";
+}
class TypeKind :
- WithParser <"succeeded($_reader.readType($_var))",
+ WithParser <"::mlir::succeeded($_reader.readType($_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeType($_getter)">>>;
-def Type : TypeKind;
+def Type : TypeKind {
+ let cType = "::mlir::Type";
+}
def VarInt :
- WithParser <"succeeded($_reader.readVarInt($_var))",
+ WithParser <"::mlir::succeeded($_reader.readVarInt($_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeVarInt($_getter)",
WithType <"uint64_t">>>>;
def SignedVarInt :
- WithParser <"succeeded($_reader.readSignedVarInt($_var))",
+ WithParser <"::mlir::succeeded($_reader.readSignedVarInt($_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeSignedVarInt($_getter)",
WithType <"int64_t">>>>;
def Blob :
- WithParser <"succeeded($_reader.readBlob($_var))",
+ WithParser <"::mlir::succeeded($_reader.readBlob($_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeOwnedBlob($_getter)",
- WithType <"ArrayRef<char>">>>>;
+ WithType <"::llvm::ArrayRef<char>">>>>;
def Bool :
- WithParser <"succeeded($_reader.readBool($_var))",
+ WithParser <"::mlir::succeeded($_reader.readBool($_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeOwnedBool($_getter)",
WithType <"bool">>>>;
class KnownWidthAPInt<string s> :
- WithParser <"succeeded(readAPIntWithKnownWidth($_reader, " # s # ", $_var))",
+ WithParser <"::mlir::succeeded(readAPIntWithKnownWidth($_reader, " # s # ", $_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeAPIntWithKnownWidth($_getter)",
- WithType <"FailureOr<APInt>">>>>;
+ WithType <"::mlir::FailureOr<::llvm::APInt>">>>>;
class KnownSemanticsAPFloat<string s> :
- WithParser <"succeeded(readAPFloatWithKnownSemantics($_reader, " # s # ", $_var))",
+ WithParser <"::mlir::succeeded(readAPFloatWithKnownSemantics($_reader, " # s # ", $_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeAPFloatWithKnownSemantics($_getter)",
- WithType <"FailureOr<APFloat>">>>>;
+ WithType <"::mlir::FailureOr<::llvm::APFloat>">>>>;
class ResourceHandle<string s> :
- WithParser <"succeeded(readResourceHandle<" # s # ">($_reader, $_var))",
+ WithParser <"::mlir::succeeded(::mlir::readResourceHandle<" # s # ">($_reader, $_var))",
WithBuilder<"$_args",
WithPrinter<"$_writer.writeResourceHandle($_getter)",
- WithType <"FailureOr<" # s # ">">>>>;
+ WithType <"::mlir::FailureOr<" # s # ">">>>>;
// Helper to define variable that is defined later but not parsed nor printed.
class LocalVar<string t, string d> :
@@ -155,12 +159,12 @@ class DialectAttrOrType<dag d> {
}
class DialectAttribute<dag d> : DialectAttrOrType<d>, AttributeKind {
- let cParser = "succeeded($_reader.readAttribute<$_resultType>($_var))";
- let cBuilder = "getChecked<$_resultType>([&]() { return reader.emitError(); }, context, $_args)";
+ let cParser = "::mlir::succeeded($_reader.readAttribute<$_resultType>($_var))";
+ let cBuilder = "::mlir::getChecked<$_resultType>([&]() { return reader.emitError(); }, context, $_args)";
}
class DialectType<dag d> : DialectAttrOrType<d>, TypeKind {
- let cParser = "succeeded($_reader.readType<$_resultType>($_var))";
- let cBuilder = "getChecked<$_resultType>([&]() { return reader.emitError(); }, context, $_args)";
+ let cParser = "::mlir::succeeded($_reader.readType<$_resultType>($_var))";
+ let cBuilder = "::mlir::getChecked<$_resultType>([&]() { return reader.emitError(); }, context, $_args)";
}
// Variant of the above, where it never prints. Useful for staging.
class DialectTypeNoPrint<dag d> : DialectType<d> {
diff --git a/mlir/test/Bytecode/bytecode_callback_full_override.mlir b/mlir/test/Bytecode/bytecode_callback_full_override.mlir
index 792f8f6e2959b7..a76187537b3477 100644
--- a/mlir/test/Bytecode/bytecode_callback_full_override.mlir
+++ b/mlir/test/Bytecode/bytecode_callback_full_override.mlir
@@ -9,7 +9,7 @@ func.func @base_test(%arg0 : i32) -> f32 {
// -----
-// CHECK-LABEL: error: unknown attribute code: 99
+// CHECK-LABEL: error: unknown type code: 99
// CHECK: failed to read bytecode
func.func @base_test(%arg0 : !test.i32) -> f32 {
%0 = "test.addi"(%arg0, %arg0) : (!test.i32, !test.i32) -> !test.i32
diff --git a/mlir/test/mlir-tblgen/bytecode-reserved.td b/mlir/test/mlir-tblgen/bytecode-reserved.td
index 5162a6b36317c7..0fd76ea5c90b95 100644
--- a/mlir/test/mlir-tblgen/bytecode-reserved.td
+++ b/mlir/test/mlir-tblgen/bytecode-reserved.td
@@ -5,7 +5,7 @@ include "mlir/IR/BuiltinDialectBytecode.td"
// CHECK: static ::mlir::Type readIntegerType
def TestDialectTypes : DialectTypes<"Test"> {
-// CHECK: static Type readType
+// CHECK: static ::mlir::Type readType
let elems = [
// CHECK: case 0:
// CHECK-NEXT: return readIntegerType(context, reader);
diff --git a/mlir/test/mlir-tblgen/bytecode-write.td b/mlir/test/mlir-tblgen/bytecode-write.td
index ab5a3eea0f0f10..ef8994188e10a6 100644
--- a/mlir/test/mlir-tblgen/bytecode-write.td
+++ b/mlir/test/mlir-tblgen/bytecode-write.td
@@ -15,14 +15,14 @@ def TestDialectTypes : DialectTypes<"Test"> {
];
}
-// CHECK-LABEL: static LogicalResult write(Float64Type type, DialectBytecodeWriter &writer) {
+// CHECK-LABEL: static ::llvm::LogicalResult write(Float64Type type, ::mlir::DialectBytecodeWriter &writer) {
// CHECK: if (false) {
// CHECK: writer.writeVarInt(/* Float64Type */ 1);
-// CHECK: return success();
+// CHECK: return ::mlir::success();
// CHECK: }
-// CHECK: return failure();
-// CHECK-LABEL: static LogicalResult writeType(Type type,
-// CHECK: return TypeSwitch<Type, LogicalResult>(type)
+// CHECK: return ::mlir::failure();
+// CHECK-LABEL: static ::llvm::LogicalResult writeType(::mlir::Type type,
+// CHECK: return ::llvm::TypeSwitch<::mlir::Type, ::llvm::LogicalResult>(type)
// CHECK-NEXT: .Case([&](Float64Type t) {
// CHECK-NEXT: return write(t, writer);
diff --git a/mlir/tools/mlir-tblgen/BytecodeDialectGen.cpp b/mlir/tools/mlir-tblgen/BytecodeDialectGen.cpp
index 031fe6cc94eb27..8f94f4b7d35316 100644
--- a/mlir/tools/mlir-tblgen/BytecodeDialectGen.cpp
+++ b/mlir/tools/mlir-tblgen/BytecodeDialectGen.cpp
@@ -25,6 +25,15 @@ static cl::opt<std::string>
cl::cat(dialectGenCat), cl::CommaSeparated);
namespace {
+/// The kind of entity, attribute or type, that readers and writers are
+/// generated for.
+struct AttrOrTypeKind {
+ /// Lowercase name, e.g. "attribute". Capitalized, it names the generated
+ /// entry points, e.g. `readAttribute` and `writeAttribute`.
+ StringRef name;
+ /// Fully qualified C++ class, e.g. "::mlir::Attribute".
+ StringRef cppClass;
+};
/// Helper class to generate C++ bytecode parser helpers.
class Generator {
@@ -32,27 +41,28 @@ class Generator {
Generator(raw_ostream &output) : output(output) {}
/// Returns whether successfully emitted attribute/type parsers.
- void emitParse(StringRef kind, const Record &x);
+ void emitParse(const AttrOrTypeKind &kind, const Record &x);
/// Returns whether successfully emitted attribute/type printers.
- void emitPrint(StringRef kind, StringRef type,
+ void emitPrint(const AttrOrTypeKind &kind, StringRef type,
ArrayRef<std::pair<int64_t, const Record *>> vec);
/// Emits parse dispatch table.
- void emitParseDispatch(StringRef kind, ArrayRef<const Record *> vec);
+ void emitParseDispatch(const AttrOrTypeKind &kind,
+ ArrayRef<const Record *> vec);
/// Emits print dispatch table.
- void emitPrintDispatch(StringRef kind, ArrayRef<std::string> vec);
+ void emitPrintDispatch(const AttrOrTypeKind &kind, ArrayRef<std::string> vec);
private:
/// Emits parse calls to construct given kind.
- void emitParseHelper(StringRef kind, StringRef returnType, StringRef builder,
+ void emitParseHelper(StringRef returnType, StringRef builder,
ArrayRef<const Init *> args,
ArrayRef<std::string> argNames, StringRef failure,
mlir::raw_indented_ostream &ios);
/// Emits print instructions.
- void emitPrintHelper(const Record *memberRec, StringRef kind,
+ void emitPrintHelper(const Record *memberRec, const AttrOrTypeKind &kind,
StringRef parent, StringRef name,
mlir::raw_indented_ostream &ios);
@@ -81,7 +91,7 @@ static std::string getCType(const Record *def) {
std::string format = "{0}";
if (def->isSubClassOf("Array")) {
def = def->getValueAsDef("elemT");
- format = "SmallVector<{0}>";
+ format = "::llvm::SmallVector<{0}>";
}
StringRef cType = def->getValueAsString("cType");
@@ -94,23 +104,23 @@ static std::string getCType(const Record *def) {
return formatv(format.c_str(), cType.str());
}
-void Generator::emitParseDispatch(StringRef kind,
+void Generator::emitParseDispatch(const AttrOrTypeKind &kind,
ArrayRef<const Record *> vec) {
mlir::raw_indented_ostream os(output);
- char const *head =
- R"(static {0} read{0}(MLIRContext* context, DialectBytecodeReader &reader))";
- os << formatv(head, capitalize(kind));
+ char const *head = R"(static {0} read{1}(::mlir::MLIRContext* context, )"
+ R"(::mlir::DialectBytecodeReader &reader))";
+ os << formatv(head, kind.cppClass, capitalize(kind.name));
auto funScope = os.scope(" {\n", "}\n\n");
if (vec.empty()) {
- os << "return reader.emitError() << \"unknown attribute\", "
- << capitalize(kind) << "();\n";
+ os << "return reader.emitError() << \"unknown " << kind.name << "\", "
+ << kind.cppClass << "();\n";
return;
}
os << "uint64_t kind;\n";
- os << "if (failed(reader.readVarInt(kind)))\n"
- << " return " << capitalize(kind) << "();\n";
+ os << "if (::mlir::failed(reader.readVarInt(kind)))\n"
+ << " return " << kind.cppClass << "();\n";
os << "switch (kind) ";
{
auto switchScope = os.scope("{\n", "}\n");
@@ -122,31 +132,29 @@ void Generator::emitParseDispatch(StringRef kind,
it.value()->getName(), it.index());
}
os << "default:\n"
- << " reader.emitError() << \"unknown attribute code: \" "
- << "<< kind;\n"
- << " return " << capitalize(kind) << "();\n";
+ << " reader.emitError() << \"unknown " << kind.name
+ << " code: \" << kind;\n"
+ << " return " << kind.cppClass << "();\n";
}
- os << "return " << capitalize(kind) << "();\n";
+ os << "return " << kind.cppClass << "();\n";
}
-void Generator::emitParse(StringRef kind, const Record &x) {
+void Generator::emitParse(const AttrOrTypeKind &kind, const Record &x) {
if (x.getNameInitAsString() == "ReservedOrDead")
return;
- char const *head =
- R"(static {0} read{1}(MLIRContext* context, DialectBytecodeReader &reader) )";
+ char const *head = R"(static {0} read{1}(::mlir::MLIRContext* context, )"
+ R"(::mlir::DialectBytecodeReader &reader) )";
mlir::raw_indented_ostream os(output);
std::string returnType = getCType(&x);
- os << formatv(head,
- kind == "attribute" ? "::mlir::Attribute" : "::mlir::Type",
- x.getName());
+ os << formatv(head, kind.cppClass, x.getName());
const DagInit *members = x.getValueAsDag("members");
SmallVector<std::string> argNames =
llvm::map_to_vector(members->getArgNames(), [](const StringInit *init) {
return init->getAsUnquotedString();
});
StringRef builder = x.getValueAsString("cBuilder").trim();
- emitParseHelper(kind, returnType, builder, members->getArgs(), argNames,
+ emitParseHelper(returnType, builder, members->getArgs(), argNames,
returnType + "()", os);
os << "\n\n";
}
@@ -180,16 +188,17 @@ static void printParseConditional(mlir::raw_indented_ostream &ios,
const Record *def = attr->getValueAsDef("elemT");
bool composite = def->isSubClassOf("CompositeBytecode");
if (!composite && def->isSubClassOf("AttributeKind"))
- parser = "succeeded($_reader.readAttributes($_var))";
+ parser = "::mlir::succeeded($_reader.readAttributes($_var))";
else if (!composite && def->isSubClassOf("TypeKind"))
- parser = "succeeded($_reader.readTypes($_var))";
+ parser = "::mlir::succeeded($_reader.readTypes($_var))";
else if (attr->isSubClassOf("ArrayWithKnownSize")) {
std::string sizeRef = attr->getValueAsString("knownSizeRef").str();
- parser = ("succeeded($_reader.readListWithKnownSize($_var, " +
- sizeRef + ", " + listHelperName(std::get<1>(it)) + "))")
- .str();
+ parser =
+ ("::mlir::succeeded($_reader.readListWithKnownSize($_var, " +
+ sizeRef + ", " + listHelperName(std::get<1>(it)) + "))")
+ .str();
} else
- parser = ("succeeded($_reader.readList($_var, " +
+ parser = ("::mlir::succeeded($_reader.readList($_var, " +
listHelperName(std::get<1>(it)) + "))")
.str();
} else {
@@ -203,8 +212,8 @@ static void printParseConditional(mlir::raw_indented_ostream &ios,
[&]() { ios << " &&\n"; });
}
-void Generator::emitParseHelper(StringRef kind, StringRef returnType,
- StringRef builder, ArrayRef<const Init *> args,
+void Generator::emitParseHelper(StringRef returnType, StringRef builder,
+ ArrayRef<const Init *> args,
ArrayRef<std::string> argNames,
StringRef failure,
mlir::raw_indented_ostream &ios) {
@@ -212,8 +221,8 @@ void Generator::emitParseHelper(StringRef kind, StringRef returnType,
if (args.empty()) {
ios << formatv(
- "return getChecked<{0}>([&]() {{ return reader.emitError(); }, "
- "context);\n",
+ "return ::mlir::getChecked<{0}>([&]() {{ return reader.emitError(); "
+ "}, context);\n",
returnType);
return;
}
@@ -260,7 +269,7 @@ void Generator::emitParseHelper(StringRef kind, StringRef returnType,
continue;
std::string returnType = getCType(def);
- ios << "auto " << listHelperName(name) << " = [&]() -> FailureOr<"
+ ios << "auto " << listHelperName(name) << " = [&]() -> ::mlir::FailureOr<"
<< returnType << "> ";
SmallVector<const Init *> args;
SmallVector<std::string> argNames;
@@ -275,7 +284,7 @@ void Generator::emitParseHelper(StringRef kind, StringRef returnType,
argNames = {"temp"};
}
StringRef builder = def->getValueAsString("cBuilder");
- emitParseHelper(kind, returnType, builder, args, argNames, "failure()",
+ emitParseHelper(returnType, builder, args, argNames, "::mlir::failure()",
ios);
ios << ";\n";
}
@@ -303,15 +312,15 @@ void Generator::emitParseHelper(StringRef kind, StringRef returnType,
ios << "}\nreturn " << failure << ";\n";
}
-void Generator::emitPrint(StringRef kind, StringRef type,
+void Generator::emitPrint(const AttrOrTypeKind &kind, StringRef type,
ArrayRef<std::pair<int64_t, const Record *>> vec) {
if (type == "ReservedOrDead")
return;
- char const *head =
- R"(static LogicalResult write({0} {1}, DialectBytecodeWriter &writer) )";
+ char const *head = R"(static ::llvm::LogicalResult write({0} {1}, )"
+ R"(::mlir::DialectBytecodeWriter &writer) )";
mlir::raw_indented_ostream os(output);
- os << formatv(head, type, kind);
+ os << formatv(head, type, kind.name);
auto funScope = os.scope("{\n", "}\n\n");
// Check that predicates specified if multiple bytecode instances.
@@ -332,7 +341,7 @@ void Generator::emitPrint(StringRef kind, StringRef type,
for (auto [index, rec] : vec) {
StringRef pred = rec->getValueAsString("printerPredicate");
if (!pred.empty()) {
- os << "if (" << format(pred, {{"$_val", kind.str()}}) << ") {\n";
+ os << "if (" << format(pred, {{"$_val", kind.name.str()}}) << ") {\n";
os.indent();
}
@@ -345,22 +354,24 @@ void Generator::emitPrint(StringRef kind, StringRef type,
const DefInit *def = dyn_cast<DefInit>(arg);
assert(def);
const Record *memberRec = def->getDef();
- emitPrintHelper(memberRec, kind, kind, name->getAsUnquotedString(), os);
+ emitPrintHelper(memberRec, kind, kind.name, name->getAsUnquotedString(),
+ os);
}
if (!pred.empty()) {
- os << "return success();\n";
+ os << "return ::mlir::success();\n";
os.unindent();
os << "}\n";
} else {
- os << "return success();\n";
+ os << "return ::mlir::success();\n";
}
}
- os << "return failure();\n";
+ os << "return ::mlir::failure();\n";
}
-void Generator::emitPrintHelper(const Record *memberRec, StringRef kind,
- StringRef parent, StringRef name,
+void Generator::emitPrintHelper(const Record *memberRec,
+ const AttrOrTypeKind &kind, StringRef parent,
+ StringRef name,
mlir::raw_indented_ostream &ios) {
std::string getter;
if (auto cGetter = memberRec->getValueAsOptionalString("cGetter");
@@ -389,7 +400,7 @@ void Generator::emitPrintHelper(const Record *memberRec, StringRef kind,
}
}
std::string returnType = getCType(def);
- std::string nestedName = kind.str();
+ std::string nestedName = kind.name.str();
StringRef writeMethod = memberRec->isSubClassOf("ArrayWithKnownSize")
? "writer.writeListWithKnownSize("
: "writer.writeList(";
@@ -412,20 +423,21 @@ void Generator::emitPrintHelper(const Record *memberRec, StringRef kind,
if (std::string printer = memberRec->getValueAsString("cPrinter").str();
!printer.empty())
ios << format(printer, {{"$_writer", "writer"},
- {"$_name", kind.str()},
+ ...
[truncated]
``````````
</details>
https://github.com/llvm/llvm-project/pull/241224
More information about the cfe-commits
mailing list