[TableGen] Improve error report of unspecified arguments

[wangpc]

Summary

Wrong error message is fixed and a note of argument is printed.

Tests are added in llvm/test/TableGen/template-args.td.

[wangpc]

Fix tests.

[DavidSpickett]

LGTM, thanks for the quick fix!

llvm/test/TableGen/template-args.td

166

Just for my understanding, was it decided that :: would mean things in a multiclass? As opposed to single : in a normal class.

[wangpc]

Thanks!
This patch needs to backport to LLVM Release 17 since it is a fix of bug introduced by named arguments patch.

llvm/test/TableGen/template-args.td

166

Yes! It is the way how TableGen normalizes argument names currently.
(But I think there is no need to distinguish them, I may post a patch to remove the difference later.)

llvm/lib/TableGen/TGParser.cpp

for (auto *Arg : ArgValues) {
     ArgValueHandler(ArgName, ArgValue);
     llvm::erase_value(UnsolvedArgNames, ArgName);
   }
 
   // For unsolved arguments, if there is no default value, complain.
   for (auto *UnsolvedArgName : UnsolvedArgNames) {
     Init *Default = Rec->getValue(UnsolvedArgName)->getValue();
     if (!Default->isComplete()) {
-      return Error(Loc, "value not specified for template argument (" +
-                            UnsolvedArgName->getAsUnquotedString() +
-                            ") of multiclass '" + Rec->getNameInitAsString() +
-                            "'");
+      std::string Name = UnsolvedArgName->getAsUnquotedString();
+      Error(Loc, "value not specified for template argument '" + Name + "'");
+      PrintNote(Rec->getFieldLoc(Name),
+                "declared in '" + Rec->getNameInitAsString() + "'");
+      return true;
     }
     ArgValueHandler(UnsolvedArgName, Default);
   }
 
   return false;
 }
 
 /// Resolve the arguments of class and set them to MapResolver.

llvm/test/TableGen/template-args.td

 // RUN: llvm-tblgen %s | FileCheck %s
 // RUN: not llvm-tblgen -DERROR1 %s 2>&1 | FileCheck --check-prefix=ERROR1 %s
 // RUN: not llvm-tblgen -DERROR2 %s 2>&1 | FileCheck --check-prefix=ERROR2 %s
 // RUN: not llvm-tblgen -DERROR3 %s 2>&1 | FileCheck --check-prefix=ERROR3 %s
 // RUN: not llvm-tblgen -DERROR4 %s 2>&1 | FileCheck --check-prefix=ERROR4 %s
 // RUN: not llvm-tblgen -DERROR5 %s 2>&1 | FileCheck --check-prefix=ERROR5 %s
 // RUN: not llvm-tblgen -DERROR6 %s 2>&1 | FileCheck --check-prefix=ERROR6 %s
 // RUN: not llvm-tblgen -DERROR7 %s 2>&1 | FileCheck --check-prefix=ERROR7 %s
+// RUN: not llvm-tblgen -DERROR8 %s 2>&1 | FileCheck --check-prefix=ERROR8 %s
+// RUN: not llvm-tblgen -DERROR9 %s 2>&1 | FileCheck --check-prefix=ERROR9 %s
+// RUN: not llvm-tblgen -DERROR10 %s 2>&1 | FileCheck --check-prefix=ERROR10 %s
 
-// This file tests that template arguments are type-checked and cast
-// if necessary.
+// This file tests that all required arguments are specified and template
+// arguments are type-checked and cast if necessary.
 
 // Class template arguments.
 
 class Class1<string nm> {
   string Name = nm;
 }
 
 // CHECK: def Rec1

 multiclass TwoArgs<bits<8> a, string b> {
   def _1 { bits<8> A = a; }
   def _2 { string B = b; }
 }
 defm Good : TwoArgs<1, "one">;
 defm MissingComma : TwoArgs<2 "two">;
 // ERROR7: [[#@LINE-1]]:31: error: Expected comma before next argument
 #endif
+
+#ifdef ERROR8
+def error8: Class1;
+// ERROR8: value not specified for template argument 'Class1:nm'
+// ERROR8: 18:21: note: declared in 'Class1'
+#endif
+
+#ifdef ERROR9
+defm error9: MC1;
+// ERROR9: value not specified for template argument 'MC1::nm'
+// ERROR9: 99:23: note: declared in 'MC1'
+#endif
+
+#ifdef ERROR10
+def error10 {
+  int value = Class2<>.Code;
+}
+// ERROR10: value not specified for template argument 'Class2:cd'
+// ERROR10: 37:22: note: declared in 'Class2'
+#endif