[LLD][COFF] Print a warning message for ignored options in lld-link

[ayrivera]

Summary

This change set adds a new group of linker options (lldWarnMessageGroup) for LLD COFF driver to handle those flags that aren't supported by lld-link but can be ignore due to compatibility with MS-LINK. LLD will print a warning message saying that the option will be ignored.

Also, the change set adds the option /ASSEMBLYDEBUG.

[ayrivera]

Update for clang-format

lld/COFF/Driver.cpp

void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) {
   }
 
   if (config->incremental && config->doICF) {
     warn("ignoring '/incremental' because ICF is enabled; use '/opt:noicf' to "
          "disable");
     config->incremental = false;
   }
 
+  // Print a warning message for those flags that aren't supported by LLD
+  // but can be ignored due to MS-LINK
+  for (auto *arg : args) {
+
+    auto argOption = arg->getOption();
+    if (!argOption.isValid())
+      continue;
+
+    auto argOptionGroup = argOption.getGroup();
+    if (argOptionGroup.isValid() &&
+        argOptionGroup.getID() == OPT_lldWarnMessageGroup)
+      warn("ignoring unknown argument \'" + argOption.getPrefixedName() + "\'");
+  }
+
   if (errorCount())
     return;
 
   std::set<sys::fs::UniqueID> wholeArchives;
   for (auto *arg : args.filtered(OPT_wholearchive_file))
     if (Optional<StringRef> path = doFindFile(arg->getValue()))
       if (Optional<sys::fs::UniqueID> id = getUniqueID(*path))
         wholeArchives.insert(*id);

lld/COFF/Options.td

 def delay : QF<"delay">;
 def errorreport : QF<"errorreport">;
 def idlout : QF<"idlout">;
 def maxilksize : QF<"maxilksize">;
 def tlbid : QF<"tlbid">;
 def tlbout : QF<"tlbout">;
 def verbose_all : QF<"verbose">;
 def guardsym : QF<"guardsym">;
+
+//=============================================================================
+// Using the flags below will cause a warning to be printed saying that they
+// will be ignored. This is for compatibility with MS LINK.
+//
+//   If the flag doesn't need an extra arguments
+//     def NAME_OF_OPTION : lldWarnMessage<"NAME_OF_OPTION">
+//
+//   If the flag does need an extra argument
+//     def NAME_OF_OPTION :  lldWarnMessageArgs<"NAME_OF_OPTION">
+//
+// If the flag has both options (with and without extra arguments) then both
+// forms need to be added.
+//=============================================================================
+
+// Define the lldWarnMessageGroup group. This group is used to identify
+// all the flags that we want to print the warning message.
+def lldWarnMessageGroup : OptionGroup<"lldWarnMessageGroup">;
+
+// Class for options that won't require extra arguments
+class lldWarnMessage<string name> : F<name> {
+  OptionGroup Group = lldWarnMessageGroup;
+}
+
+// Class for options that require an extra argument
+class lldWarnMessageArgs<string name> : QF<name> {
+  OptionGroup Group = lldWarnMessageGroup;
+}
+
+def assemblydebug : lldWarnMessage<"assemblydebug">;

lld/test/COFF/ignore-option-message.ll

+; This test checks that the option /ASSEMBLYDEBUG causes a warning to be
+; printed and is then ignored.
+
+; RUN: llc %s -o %t.obj -filetype=obj
+
+; Check that the /ASSEMBLYDEBUG flag is ignored
+; RUN: not lld-link /subsystem:console /ASSEMBLYDEBUG %t.obj 2>&1 | FileCheck -check-prefix=CHECKAD -allow-empty %s
+; CHECKAD:     warning: ignoring unknown argument '/assemblydebug'
+; CHECKAD-NOT: could not open '/ASSEMBLYDEBUG'
+
+; Check that the /assemblydebug flag is ignored
+; RUN: not lld-link /subsystem:console /assemblydebug %t.obj 2>&1 | FileCheck -check-prefix=CHECKAD2 -allow-empty %s
+; CHECKAD2:     warning: ignoring unknown argument '/assemblydebug'
+; CHECKAD2-NOT: could not open '/assemblydebug'
+
+target datalayout = "e-m:w-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-pc-windows-msvc"
+
+define internal i32 @add(i32 %a) {
+entry:
+  %add = add nsw i32 %a, 2
+  ret i32 %add
+}