Merge pull request swiftlang#30788 from DougGregor/driver-darwin-sdk-version-to-linker

DougGregor · web-flow · commit bdb2aeecfd23 · 2020-04-03T20:56:40.000-07:00
[Driver] Use -platform_version to specify platform versions for the Darwin linker
diff --git a/include/swift/AST/DiagnosticsDriver.def b/include/swift/AST/DiagnosticsDriver.def
@@ -207,6 +207,10 @@ ERROR(cannot_find_migration_script, none,
 ERROR(error_darwin_static_stdlib_not_supported, none,
       "-static-stdlib is no longer supported on Apple platforms", ())
 
+WARNING(warn_drv_darwin_sdk_invalid_settings, none,
+    "SDK settings were ignored because 'SDKSettings.json' could not be parsed",
+    ())
+
 #ifndef DIAG_NO_UNDEF
 # if defined(DIAG)
 #  undef DIAG
diff --git a/include/swift/Driver/ToolChain.h b/include/swift/Driver/ToolChain.h
@@ -318,6 +318,13 @@ class ToolChain {
                                  const llvm::opt::ArgList &args,
                                  StringRef defaultTarget) const {}
 
+  /// Validate the output information.
+  ///
+  /// An override point for platform-specific subclasses to customize their
+  /// behavior once the outputs are known.
+  virtual void validateOutputInfo(DiagnosticEngine &diags,
+                                  const OutputInfo &outputInfo) const { }
+
   llvm::Expected<file_types::ID>
   remarkFileTypeFromArgs(const llvm::opt::ArgList &Args) const;
 };
diff --git a/lib/Driver/DarwinToolChains.cpp b/lib/Driver/DarwinToolChains.cpp
@@ -21,6 +21,7 @@
 #include "swift/Basic/TaskQueue.h"
 #include "swift/Config.h"
 #include "swift/Driver/Compilation.h"
+#include "clang/Driver/DarwinSDKInfo.h"
 #include "swift/Driver/Driver.h"
 #include "swift/Driver/Job.h"
 #include "swift/Option/Options.h"
@@ -481,61 +482,138 @@ toolchains::Darwin::addProfileGenerationArgs(ArgStringList &Arguments,
   }
 }
 
+/// Remap the given version number via the version map, or produce \c None if
+/// there is no mapping for this version.
+static Optional<llvm::VersionTuple> remapVersion(
+    const llvm::StringMap<llvm::VersionTuple> &versionMap,
+    llvm::VersionTuple version) {
+  // The build number is never used in the lookup.
+  version = version.withoutBuild();
+
+  // Look for this specific version.
+  auto known = versionMap.find(version.getAsString());
+  if (known != versionMap.end())
+    return known->second;
+
+  // If an extra ".0" was specified (in the subminor version), drop that
+  // and look again.
+  if (!version.getSubminor() || *version.getSubminor() != 0)
+    return None;
+
+  version = llvm::VersionTuple(version.getMajor(), *version.getMinor());
+  known = versionMap.find(version.getAsString());
+  if (known != versionMap.end())
+    return known->second;
+
+  // If another extra ".0" wa specified (in the minor version), drop that
+  // and look again.
+  if (!version.getMinor() || *version.getMinor() != 0)
+    return None;
+
+  version = llvm::VersionTuple(version.getMajor());
+  known = versionMap.find(version.getAsString());
+  if (known != versionMap.end())
+    return known->second;
+
+  return None;
+}
+
 void
 toolchains::Darwin::addDeploymentTargetArgs(ArgStringList &Arguments,
                                             const JobContext &context) const {
-  const llvm::Triple &Triple = getTriple();
-  // FIXME: Properly handle deployment targets.
-  assert(Triple.isiOS() || Triple.isWatchOS() || Triple.isMacOSX());
-  if (Triple.isiOS()) {
-    bool isiOSSimulator = tripleIsiOSSimulator(Triple);
-    if (Triple.isTvOS()) {
-      if (isiOSSimulator)
-        Arguments.push_back("-tvos_simulator_version_min");
-      else
-        Arguments.push_back("-tvos_version_min");
+  auto addPlatformVersionArg = [&](const llvm::Triple &triple) {
+    // Compute the name of the platform for the linker.
+    const char *platformName;
+    if (tripleIsMacCatalystEnvironment(triple)) {
+      platformName = "mac-catalyst";
     } else {
-      if (isiOSSimulator)
-        Arguments.push_back("-ios_simulator_version_min");
-      else if (tripleIsMacCatalystEnvironment(Triple))
-        Arguments.push_back("-maccatalyst_version_min");
-      else
-        Arguments.push_back("-iphoneos_version_min");
+      switch (getDarwinPlatformKind(triple)) {
+      case DarwinPlatformKind::MacOS:
+        platformName = "macos";
+        break;
+      case DarwinPlatformKind::IPhoneOS:
+        platformName = "ios";
+        break;
+      case DarwinPlatformKind::IPhoneOSSimulator:
+        platformName = "ios-simulator";
+        break;
+      case DarwinPlatformKind::TvOS:
+        platformName = "tvos";
+        break;
+      case DarwinPlatformKind::TvOSSimulator:
+        platformName = "tvos-simulator";
+        break;
+      case DarwinPlatformKind::WatchOS:
+        platformName = "watchos";
+        break;
+      case DarwinPlatformKind::WatchOSSimulator:
+        platformName = "watchos-simulator";
+        break;
+      }
     }
+
+    // Compute the platform version.
     unsigned major, minor, micro;
-    Triple.getiOSVersion(major, minor, micro);
-    addVersionString(context.Args, Arguments, major, minor, micro);
+    if (tripleIsMacCatalystEnvironment(triple)) {
+      triple.getiOSVersion(major, minor, micro);
+
+      // Mac Catalyst was introduced with an iOS deployment target of 13.0;
+      // the linker doesn't want to see a deployment target before that.
+      if (major < 13) {
+        major = 13;
+        minor = 0;
+        micro = 0;
+      }
+    } else {
+      switch (getDarwinPlatformKind((triple))) {
+      case DarwinPlatformKind::MacOS:
+        triple.getMacOSXVersion(major, minor, micro);
+        break;
+      case DarwinPlatformKind::IPhoneOS:
+      case DarwinPlatformKind::IPhoneOSSimulator:
+      case DarwinPlatformKind::TvOS:
+      case DarwinPlatformKind::TvOSSimulator:
+        triple.getiOSVersion(major, minor, micro);
+        break;
+      case DarwinPlatformKind::WatchOS:
+      case DarwinPlatformKind::WatchOSSimulator:
+        triple.getOSVersion(major, minor, micro);
+        break;
+      }
+    }
+
+    // Compute the SDK version.
+    unsigned sdkMajor = 0, sdkMinor = 0, sdkMicro = 0;
+    if (SDKInfo) {
+      // Retrieve the SDK version.
+      auto SDKVersion = SDKInfo->getVersion();
+
+      // For the Mac Catalyst environment, we have a macOS SDK with a macOS
+      // SDK version. Map that to the corresponding iOS version number to pass
+      // down to the linker.
+      if (tripleIsMacCatalystEnvironment(triple)) {
+        SDKVersion = remapVersion(
+            SDKInfo->getVersionMap().MacOS2iOSMacMapping, SDKVersion)
+              .getValueOr(llvm::VersionTuple(0, 0, 0));
+      }
 
-    if (TargetVariant) {
-      assert(triplesAreValidForZippering(Triple, *TargetVariant));
-      assert(TargetVariant->isMacOSX());
-      Arguments.push_back("-macosx_version_min");
-      unsigned major, minor, micro;
-      TargetVariant->getMacOSXVersion(major, minor, micro);
-      addVersionString(context.Args, Arguments, major, minor, micro);
+      // Extract the version information.
+      sdkMajor = SDKVersion.getMajor();
+      sdkMinor = SDKVersion.getMinor().getValueOr(0);
+      sdkMicro = SDKVersion.getSubminor().getValueOr(0);
     }
-  } else if (Triple.isWatchOS()) {
-    if (tripleIsWatchSimulator(Triple))
-      Arguments.push_back("-watchos_simulator_version_min");
-    else
-      Arguments.push_back("-watchos_version_min");
-    unsigned major, minor, micro;
-    Triple.getOSVersion(major, minor, micro);
-    addVersionString(context.Args, Arguments, major, minor, micro);
-  } else {
-    Arguments.push_back("-macosx_version_min");
-    unsigned major, minor, micro;
-    Triple.getMacOSXVersion(major, minor, micro);
+
+    Arguments.push_back("-platform_version");
+    Arguments.push_back(platformName);
     addVersionString(context.Args, Arguments, major, minor, micro);
+    addVersionString(context.Args, Arguments, sdkMajor, sdkMinor, sdkMicro);
+  };
 
-    if (TargetVariant) {
-      assert(triplesAreValidForZippering(Triple, *TargetVariant));
-      assert(tripleIsMacCatalystEnvironment(*TargetVariant));
-      Arguments.push_back("-maccatalyst_version_min");
-      unsigned major, minor, micro;
-      TargetVariant->getiOSVersion(major, minor, micro);
-      addVersionString(context.Args, Arguments, major, minor, micro);
-    }
+  addPlatformVersionArg(getTriple());
+
+  if (auto targetVariant = getTargetVariant()) {
+    assert(triplesAreValidForZippering(getTriple(), *targetVariant));
+    addPlatformVersionArg(*targetVariant);
   }
 }
 
@@ -778,3 +856,20 @@ toolchains::Darwin::validateArguments(DiagnosticEngine &diags,
     diags.diagnose(SourceLoc(), diag::error_darwin_static_stdlib_not_supported);
   }
 }
+
+void
+toolchains::Darwin::validateOutputInfo(DiagnosticEngine &diags,
+                                       const OutputInfo &outputInfo) const {
+  // If we are linking and have been provided with an SDK, go read the SDK
+  // information.
+  if (outputInfo.shouldLink() && !outputInfo.SDKPath.empty()) {
+    auto SDKInfoOrErr = clang::driver::parseDarwinSDKInfo(
+        *llvm::vfs::getRealFileSystem(), outputInfo.SDKPath);
+    if (SDKInfoOrErr) {
+      SDKInfo = *SDKInfoOrErr;
+    } else {
+      llvm::consumeError(SDKInfoOrErr.takeError());
+      diags.diagnose(SourceLoc(), diag::warn_drv_darwin_sdk_invalid_settings);
+    }
+  }
+}
diff --git a/lib/Driver/Driver.cpp b/lib/Driver/Driver.cpp
@@ -883,6 +883,10 @@ Driver::buildCompilation(const ToolChain &TC,
   assert(OI.CompilerOutputType != file_types::ID::TY_INVALID &&
          "buildOutputInfo() must set a valid output type!");
 
+  TC.validateOutputInfo(Diags, OI);
+  if (Diags.hadAnyError())
+    return nullptr;
+
   validateEmbedBitcode(*TranslatedArgList, OI, Diags);
 
   if (OI.CompilerMode == OutputInfo::Mode::REPL)
diff --git a/lib/Driver/ToolChains.h b/lib/Driver/ToolChains.h
@@ -15,6 +15,7 @@
 
 #include "swift/Basic/LLVM.h"
 #include "swift/Driver/ToolChain.h"
+#include "clang/Driver/DarwinSDKInfo.h"
 #include "llvm/Option/ArgList.h"
 #include "llvm/Support/Compiler.h"
 
@@ -58,10 +59,18 @@ class LLVM_LIBRARY_VISIBILITY Darwin : public ToolChain {
                          const llvm::opt::ArgList &args,
                          StringRef defaultTarget) const override;
 
+  void validateOutputInfo(DiagnosticEngine &diags,
+                          const OutputInfo &outputInfo) const override;
+
   std::string findProgramRelativeToSwiftImpl(StringRef name) const override;
 
   bool shouldStoreInvocationInDebugInfo() const override;
 
+  /// Information about the SDK that the application is being built against.
+  /// This information is only used by the linker, so it is only populated
+  /// when there will be a linker job.
+  mutable Optional<clang::driver::DarwinSDKInfo> SDKInfo;
+
   const Optional<llvm::Triple> TargetVariant;
 
 public:
diff --git a/test/Driver/Inputs/MacOSX10.15.4.versioned.sdk/SDKSettings.json b/test/Driver/Inputs/MacOSX10.15.4.versioned.sdk/SDKSettings.json
@@ -0,0 +1,27 @@
+{
+  "Version":"10.15.4",
+  "VersionMap" : {
+      "macOS_iOSMac" : {
+          "10.14.4" : "12.4",
+          "10.14.3" : "12.3",
+          "10.14.2" : "12.2",
+          "10.14.1" : "12.1",
+          "10.15" : "13.0",
+          "10.14" : "12.0",
+          "10.14.5" : "12.5",
+          "10.15.1" : "13.2",
+          "10.15.4" : "13.4"
+      },
+      "iOSMac_macOS" : {
+          "13.0" : "10.15",
+          "12.3" : "10.14.3",
+          "12.0" : "10.14",
+          "12.4" : "10.14.4",
+          "12.1" : "10.14.1",
+          "12.5" : "10.14.5",
+          "12.2" : "10.14.2",
+          "13.2" : "10.15.1",
+          "13.4" : "10.15.4"
+      }
+  }
+}
diff --git a/test/Driver/Inputs/MacOSX10.15.versioned.sdk/SDKSettings.json b/test/Driver/Inputs/MacOSX10.15.versioned.sdk/SDKSettings.json
@@ -0,0 +1,13 @@
+{
+  "Version":"10.15",
+  "VersionMap" : {
+      "macOS_iOSMac" : {
+          "10.15" : "13.1",
+          "10.15.1" : "13.2"
+      },
+      "iOSMac_macOS" : {
+          "13.1" : "10.15",
+          "13.2" : "10.15.1"
+      }
+  }
+}
diff --git a/test/Driver/linker.swift b/test/Driver/linker.swift
@@ -101,6 +101,15 @@
 // INFERRED_NAMED_DARWIN tests above: 'libLINKER.dylib'.
 // RUN: %swiftc_driver -driver-print-jobs -target x86_64-apple-macosx10.9 -emit-library %s -o libLINKER.dylib | %FileCheck -check-prefix INFERRED_NAME_DARWIN %s
 
+// Check reading the SDKSettings.json from an SDK
+// RUN: %swiftc_driver -driver-print-jobs -target x86_64-apple-macosx10.9 -sdk %S/Inputs/MacOSX10.15.versioned.sdk %s 2>&1 | %FileCheck -check-prefix MACOS_10_15 %s
+// RUN: %swiftc_driver -driver-print-jobs -target x86_64-apple-macosx10.9 -sdk %S/Inputs/MacOSX10.15.4.versioned.sdk %s 2>&1 | %FileCheck -check-prefix MACOS_10_15_4 %s
+// RUN: %swiftc_driver -driver-print-jobs -target x86_64-apple-macosx10.9 -sdk %S/Inputs/MacOSX10.15.sdk %s 2>&1 | %FileCheck -check-prefix MACOS_UNVERSIONED %s
+
+// MACOS_10_15: -platform_version macos 10.9.0 10.15.0
+// MACOS_10_15_4: -platform_version macos 10.9.0 10.15.4
+// MACOS_UNVERSIONED: -platform_version macos 10.9.0 0.0.0
+
 // There are more RUN lines further down in the file.
 
 // CHECK: swift
@@ -117,7 +126,7 @@
 
 // SIMPLE: {{(bin/)?}}ld{{"? }}
 // SIMPLE-NOT: -syslibroot
-// SIMPLE: -macosx_version_min 10.{{[0-9]+}}.{{[0-9]+}}
+// SIMPLE: -platform_version macos 10.{{[0-9]+}}.{{[0-9]+}} 0.0.0
 // SIMPLE-NOT: -syslibroot
 // SIMPLE: -o linker
 
@@ -133,7 +142,7 @@
 // IOS_SIMPLE-DAG: -L {{[^ ]+(/|\\\\)lib(/|\\\\)swift(/|\\\\)iphonesimulator}}
 // IOS_SIMPLE-DAG: -lSystem
 // IOS_SIMPLE-DAG: -arch x86_64
-// IOS_SIMPLE-DAG: -ios_simulator_version_min 7.1.{{[0-9]+}}
+// IOS_SIMPLE-DAG: -platform_version ios-simulator 7.1.{{[0-9]+}} 0.0.0
 // IOS_SIMPLE: -o linker
 
 
@@ -145,7 +154,7 @@
 // tvOS_SIMPLE-DAG: -L {{[^ ]+(/|\\\\)lib(/|\\\\)swift(/|\\\\)appletvsimulator}}
 // tvOS_SIMPLE-DAG: -lSystem
 // tvOS_SIMPLE-DAG: -arch x86_64
-// tvOS_SIMPLE-DAG: -tvos_simulator_version_min 9.0.{{[0-9]+}}
+// tvOS_SIMPLE-DAG: -platform_version tvos-simulator 9.0.{{[0-9]+}} 0.0.0
 // tvOS_SIMPLE: -o linker
 
 
@@ -157,7 +166,7 @@
 // watchOS_SIMPLE-DAG: -L {{[^ ]+(/|\\\\)lib(/|\\\\)swift(/|\\\\)watchsimulator}}
 // watchOS_SIMPLE-DAG: -lSystem
 // watchOS_SIMPLE-DAG: -arch i386
-// watchOS_SIMPLE-DAG: -watchos_simulator_version_min 2.0.{{[0-9]+}}
+// watchOS_SIMPLE-DAG: -platform_version watchos-simulator 2.0.{{[0-9]+}} 0.0.0
 // watchOS_SIMPLE: -o linker
 
 
@@ -298,7 +307,7 @@
 // COMPLEX-DAG: -L baz
 // COMPLEX-DAG: -F garply -F car -F cdr
 // COMPLEX-DAG: -undefined dynamic_lookup
-// COMPLEX-DAG: -macosx_version_min 10.9.1
+// COMPLEX-DAG: -platform_version macos 10.9.1 0.0.0
 // COMPLEX: -o sdk.out
 
 // LINUX_DYNLIB-x86_64: swift
diff --git a/test/Driver/macabi-environment.swift b/test/Driver/macabi-environment.swift
