[mlir][tblgen] Avoid compilation failure

[jpienaar]

This would have failed during compilation post generation later, trim and use raw string literals to avoid such failures.

Probably a few more places where similar failures could occur, but this was unexpected failure user ran into.

[llvmbot]

@llvm/pr-subscribers-mlir-core

@llvm/pr-subscribers-mlir

Author: Jacques Pienaar (jpienaar)

Changes

This would have failed during compilation post generation later, trim and use raw string literals to avoid such failures.

Probably a few more places where similar failures could occur, but this was unexpected failure user ran into.

---

Full diff: https://github.com/llvm/llvm-project/pull/161545.diff

2 Files Affected:

• (modified) mlir/tools/mlir-tblgen/PassGen.cpp (+10-9)
• (modified) mlir/unittests/TableGen/passes.td (+5-2)

diff --git a/mlir/tools/mlir-tblgen/PassGen.cpp b/mlir/tools/mlir-tblgen/PassGen.cpp
index 4b4ac41b9effb..f7134ce02b72f 100644
--- a/mlir/tools/mlir-tblgen/PassGen.cpp
+++ b/mlir/tools/mlir-tblgen/PassGen.cpp
@@ -195,7 +195,7 @@ class {0}Base : public {1} {
   }
   ::llvm::StringRef getArgument() const override { return "{2}"; }
 
-  ::llvm::StringRef getDescription() const override { return "{3}"; }
+  ::llvm::StringRef getDescription() const override { return R"PD({3})PD"; }
 
   /// Returns the derived pass name.
   static constexpr ::llvm::StringLiteral getPassName() {
@@ -271,9 +271,9 @@ static void emitPassOptionDecls(const Pass &pass, raw_ostream &os) {
     os.indent(2) << "::mlir::Pass::"
                  << (opt.isListOption() ? "ListOption" : "Option");
 
-    os << formatv(R"(<{0}> {1}{{*this, "{2}", ::llvm::cl::desc("{3}"))",
+    os << formatv(R"(<{0}> {1}{{*this, "{2}", ::llvm::cl::desc(R"PO({3})PO"))",
                   opt.getType(), opt.getCppVariableName(), opt.getArgument(),
-                  opt.getDescription());
+                  opt.getDescription().trim());
     if (std::optional<StringRef> defaultVal = opt.getDefaultValue())
       os << ", ::llvm::cl::init(" << defaultVal << ")";
     if (std::optional<StringRef> additionalFlags = opt.getAdditionalFlags())
@@ -285,9 +285,10 @@ static void emitPassOptionDecls(const Pass &pass, raw_ostream &os) {
 /// Emit the declarations for each of the pass statistics.
 static void emitPassStatisticDecls(const Pass &pass, raw_ostream &os) {
   for (const PassStatistic &stat : pass.getStatistics()) {
-    os << formatv("  ::mlir::Pass::Statistic {0}{{this, \"{1}\", \"{2}\"};\n",
-                  stat.getCppVariableName(), stat.getName(),
-                  stat.getDescription());
+    os << formatv(
+        "  ::mlir::Pass::Statistic {0}{{this, \"{1}\", R\"PS({2})PS\"};\n",
+        stat.getCppVariableName(), stat.getName(),
+        stat.getDescription().trim());
   }
 }
 
@@ -320,7 +321,7 @@ static void emitPassDefs(const Pass &pass, raw_ostream &os) {
 
   os << "namespace impl {\n";
   os << formatv(baseClassBegin, passName, pass.getBaseClass(),
-                pass.getArgument(), pass.getSummary(),
+                pass.getArgument(), pass.getSummary().trim(),
                 dependentDialectRegistrations);
 
   if (ArrayRef<PassOption> options = pass.getOptions(); !options.empty()) {
@@ -393,7 +394,7 @@ class {0}Base : public {1} {
   }
   ::llvm::StringRef getArgument() const override { return "{2}"; }
 
-  ::llvm::StringRef getDescription() const override { return "{3}"; }
+  ::llvm::StringRef getDescription() const override { return R"PD({3})PD"; }
 
   /// Returns the derived pass name.
   static constexpr ::llvm::StringLiteral getPassName() {
@@ -439,7 +440,7 @@ static void emitOldPassDecl(const Pass &pass, raw_ostream &os) {
         "\n    ");
   }
   os << formatv(oldPassDeclBegin, defName, pass.getBaseClass(),
-                pass.getArgument(), pass.getSummary(),
+                pass.getArgument(), pass.getSummary().trim(),
                 dependentDialectRegistrations);
   emitPassOptionDecls(pass, os);
   emitPassStatisticDecls(pass, os);
diff --git a/mlir/unittests/TableGen/passes.td b/mlir/unittests/TableGen/passes.td
index 5e53cb99ef9fa..79c57a97bba7c 100644
--- a/mlir/unittests/TableGen/passes.td
+++ b/mlir/unittests/TableGen/passes.td
@@ -19,8 +19,11 @@ def TestPassWithOptions : Pass<"test"> {
 
   let options = [
     Option<"testOption", "testOption", "int", "0", "Test option">,
-    ListOption<"testListOption", "test-list-option", "int64_t",
-               "Test list option">
+    // Testing the output of multi-line description. This would fail compilation
+    // if not properly handled.
+    ListOption<"testListOption", "test-list-option", "int64_t", [{
+      Test
+               list option}]>
   ];
 }