From 33888ff66b1950da4af2025da5d368f6a0038fd1 Mon Sep 17 00:00:00 2001
From: Javed Absar <javed.absar@arm.com>
Date: Tue, 26 Mar 2019 10:49:09 +0000
Subject: [PATCH] [TableGen] Give meaningful msg for def use in multiclass

When one mistakenly specifies 'def' instead of using 'defm',
the error message is quite misleading: 'Couldn't find class..'
Instead, it should recommend using defm if the multiclass of
same name exists.

Reviewed By: hfinkel

Differential Revision: https://reviews.llvm.org/D59294

llvm-svn: 356985
---
 llvm/lib/TableGen/TGParser.cpp            | 10 ++++++++--
 llvm/test/TableGen/MultiClass-def-fail.td | 10 ++++++++++
 2 files changed, 18 insertions(+), 2 deletions(-)
 create mode 100644 llvm/test/TableGen/MultiClass-def-fail.td

diff --git a/llvm/lib/TableGen/TGParser.cpp b/llvm/lib/TableGen/TGParser.cpp
index 90c9b390e103..3fc2e53f208a 100644
--- a/llvm/lib/TableGen/TGParser.cpp
+++ b/llvm/lib/TableGen/TGParser.cpp
@@ -536,8 +536,14 @@ Record *TGParser::ParseClassID() {
   }
 
   Record *Result = Records.getClass(Lex.getCurStrVal());
-  if (!Result)
-    TokError("Couldn't find class '" + Lex.getCurStrVal() + "'");
+  if (!Result) {
+    std::string Msg("Couldn't find class '" + Lex.getCurStrVal() + "'");
+    if (MultiClasses[Lex.getCurStrVal()].get())
+      TokError(Msg + ". Use 'defm' if you meant to use multiclass '" +
+               Lex.getCurStrVal() + "'");
+    else
+      TokError(Msg);
+  }
 
   Lex.Lex();
   return Result;
diff --git a/llvm/test/TableGen/MultiClass-def-fail.td b/llvm/test/TableGen/MultiClass-def-fail.td
new file mode 100644
index 000000000000..ed37e5cd71cb
--- /dev/null
+++ b/llvm/test/TableGen/MultiClass-def-fail.td
@@ -0,0 +1,10 @@
+// RUN: not llvm-tblgen %s 2>&1 | FileCheck %s
+// XFAIL: vg_leak
+
+// This test checks that using def instead of defm gives a meaningful error
+multiclass M2 {
+  def X;
+}
+
+// CHECK: error: Couldn't find class 'M2'. Use 'defm' if you meant to use multiclass 'M2'
+def rec1 : M2;