Merge pull request #37588 from nkcsgexi/78233352

ModuleInterface: move -user-module-version to a new field

Author: nkcsgexi

include/swift/Frontend/ModuleInterfaceSupport.h

@@ -20,6 +20,7 @@
 #define SWIFT_INTERFACE_FORMAT_VERSION_KEY "swift-interface-format-version"
 #define SWIFT_COMPILER_VERSION_KEY "swift-compiler-version"
 #define SWIFT_MODULE_FLAGS_KEY "swift-module-flags"
+#define SWIFT_MODULE_FLAGS_IGNORABLE_KEY "swift-module-flags-ignorable"
 
 namespace swift {
 
@@ -41,6 +42,10 @@ struct ModuleInterfaceOptions {
   /// back .swiftinterface and reconstructing .swiftmodule.
   std::string Flags;
 
+  /// Flags that should be emitted to the .swiftinterface file but are OK to be
+  /// ignored by the earlier version of the compiler.
+  std::string IgnorableFlags;
+
   /// Print SPI decls and attributes.
   bool PrintSPIs = false;
 

include/swift/Option/Options.h

@@ -41,6 +41,7 @@ namespace options {
     SwiftSymbolGraphExtractOption = (1 << 16),
     SwiftAPIDigesterOption = (1 << 17),
     NewDriverOnlyOption = (1 << 18),
+    ModuleInterfaceOptionIgnorable = (1 << 19),
   };
 
   enum ID {

include/swift/Option/Options.td

@@ -51,6 +51,11 @@ def ArgumentIsPath : OptionFlag;
 // and read/parsed from there when reconstituting a .swiftmodule from it.
 def ModuleInterfaceOption : OptionFlag;
 
+// The option should be written into a .swiftinterface module interface file,
+// and read/parsed from there when reconstituting a .swiftmodule from it.
+// The option can be safely ignored by the older compiler.
+def ModuleInterfaceOptionIgnorable : OptionFlag;
+
 // The option causes the output of a supplementary output, or is the path option
 // for a supplementary output. E.g., `-emit-module` and `-emit-module-path`.
 def SupplementaryOutput : OptionFlag;
@@ -1184,7 +1189,7 @@ def working_directory_EQ : Joined<["-"], "working-directory=">,
   Alias<working_directory>;
 
 def user_module_version : Separate<["-"], "user-module-version">,
-  Flags<[FrontendOption, ModuleInterfaceOption, NewDriverOnlyOption]>,
+  Flags<[FrontendOption, ModuleInterfaceOptionIgnorable, NewDriverOnlyOption]>,
   HelpText<"Module version specified from Swift module authors">,
   MetaVarName<"<vers>">;
 

lib/Frontend/CompilerInvocation.cpp

@@ -355,14 +355,26 @@ static void SaveModuleInterfaceArgs(ModuleInterfaceOptions &Opts,
   if (!FOpts.InputsAndOutputs.hasModuleInterfaceOutputPath())
     return;
   ArgStringList RenderedArgs;
+  ArgStringList RenderedArgsIgnorable;
   for (auto A : Args) {
-    if (A->getOption().hasFlag(options::ModuleInterfaceOption))
+    if (A->getOption().hasFlag(options::ModuleInterfaceOptionIgnorable)) {
+      A->render(Args, RenderedArgsIgnorable);
+    } else if (A->getOption().hasFlag(options::ModuleInterfaceOption)) {
       A->render(Args, RenderedArgs);
+    }
+  }
+  {
+    llvm::raw_string_ostream OS(Opts.Flags);
+    interleave(RenderedArgs,
+               [&](const char *Argument) { PrintArg(OS, Argument, StringRef()); },
+               [&] { OS << " "; });
+  }
+  {
+    llvm::raw_string_ostream OS(Opts.IgnorableFlags);
+    interleave(RenderedArgsIgnorable,
+               [&](const char *Argument) { PrintArg(OS, Argument, StringRef()); },
+               [&] { OS << " "; });
   }
-  llvm::raw_string_ostream OS(Opts.Flags);
-  interleave(RenderedArgs,
-             [&](const char *Argument) { PrintArg(OS, Argument, StringRef()); },
-             [&] { OS << " "; });
 }
 
 static bool ParseLangArgs(LangOptions &Opts, ArgList &Args,

lib/Frontend/ModuleInterfaceSupport.cpp

@@ -56,6 +56,10 @@ static void printToolVersionAndFlagsComment(raw_ostream &out,
       << ToolsVersion << "\n";
   out << "// " SWIFT_MODULE_FLAGS_KEY ": "
       << Opts.Flags << "\n";
+  if (!Opts.IgnorableFlags.empty()) {
+    out << "// " SWIFT_MODULE_FLAGS_IGNORABLE_KEY ": "
+        << Opts.IgnorableFlags << "\n";
+  }
 }
 
 std::string

lib/Serialization/SerializedModuleLoader.cpp

@@ -22,7 +22,10 @@
 #include "swift/Basic/STLExtras.h"
 #include "swift/Basic/SourceManager.h"
 #include "swift/Basic/Version.h"
+#include "swift/Option/Options.h"
 
+#include "llvm/Option/OptTable.h"
+#include "llvm/Option/ArgList.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringSet.h"
 #include "llvm/Support/Debug.h"
@@ -970,6 +973,33 @@ bool swift::extractCompilerFlagsFromInterface(StringRef buffer,
     return true;
   assert(FlagMatches.size() == 2);
   llvm::cl::TokenizeGNUCommandLine(FlagMatches[1], ArgSaver, SubArgs);
+  SmallVector<StringRef, 1> IgnFlagMatches;
+  // Cherry-pick supported options from the ignorable list.
+  auto IgnFlagRe = llvm::Regex("^// swift-module-flags-ignorable:(.*)$",
+                               llvm::Regex::Newline);
+  // It's OK the interface doesn't have the ignorable list, we just ignore them
+  // all.
+  if (!IgnFlagRe.match(buffer, &IgnFlagMatches))
+    return false;
+  SmallVector<const char *, 8> IgnSubArgs;
+  llvm::cl::TokenizeGNUCommandLine(IgnFlagMatches[1], ArgSaver, IgnSubArgs);
+  std::unique_ptr<llvm::opt::OptTable> table = swift::createSwiftOptTable();
+  unsigned missingArgIdx = 0;
+  unsigned missingArgCount = 0;
+  auto parsedIgns = table->ParseArgs(IgnSubArgs, missingArgIdx, missingArgCount);
+  for (auto parse: parsedIgns) {
+    // Check if the option is a frontend option. This will filter out unknown
+    // options and input-like options.
+    if (!parse->getOption().hasFlag(options::FrontendOption))
+      continue;
+    // Push the supported option and its value to the list.
+    // We shouldn't need to worry about cases like -tbd-install_name=Foo because
+    // the parsing function should have droped alias options already.
+    SubArgs.push_back(ArgSaver.save(parse->getSpelling()).data());
+    for (auto value: parse->getValues())
+      SubArgs.push_back(value);
+  }
+
   return false;
 }
 

test/ModuleInterface/ignorable-compiler-flags.swift

@@ -0,0 +1,15 @@
+// RUN: %empty-directory(%t)
+// RUN: %empty-directory(%t/textual)
+// RUN: %empty-directory(%t/module-cache)
+
+// RUN: echo "// swift-interface-format-version: 1.0" > %t/textual/Foo.swiftinterface
+// RUN: echo "// swift-module-flags: -swift-version 5 -enable-library-evolution -module-name Foo" >> %t/textual/Foo.swiftinterface
+
+// RUN: %target-swift-ide-test -print-module-metadata -module-to-print Foo -I %t/textual -source-filename %s -module-cache-path %t/module-cache | %FileCheck %s --check-prefix=USER-MODULE-PRINT-NOT
+
+// RUN: echo "// swift-module-flags-ignorable: -enable-library-evolution -user-module-version 13.13 -future-flag1 3 -future-flag2 abc -future-flag3 /tmp/t.swift /tmp/u.swift -tbd-install_name=aaa" >> %t/textual/Foo.swiftinterface
+
+// RUN: %target-swift-ide-test -print-module-metadata -module-to-print Foo -I %t/textual -source-filename %s -module-cache-path %t/module-cache | %FileCheck %s --check-prefix=USER-MODULE-PRINT
+
+// USER-MODULE-PRINT-NOT-NOT: user module version: 13.13.0.0
+// USER-MODULE-PRINT: user module version: 13.13.0.0