[lld-macho] improve handling of -platform_version

[gkm]

Summary

This improves the handling of -platform_version by addressing the FIXME in the code to process the arguments.

[tschuett]

Neither PlatformType nor PlatformKind cover all cases of -platform_version, but TextAPI uses PlatformKind.

The ld man page references <mach-o/loader.h> for the numeric values. PlatformType seems to be outdated. It is missing PLATFORM_DRIVERKIT = 10. For the same reason, PlatformKind might be missing driverkit support.

The OSX 10.14 loader.h is missing the driverkit entry. Only the OSX 10.15 loader.h contains the driverkit entry.

[compnerd]

DriverKit was introduced in 10.15, so its not surprising that the LLVM enumeration for the object file format (PLATFORM_TYPE) does not contain the value yet. AIUI, PlatformType is the loader representation (and is used in the object file format). The values in the general purpose usage live outside of the loader (TAPI and dyld are separate code bases) but the PlatformKind enumeration mirrors the PlatformType enumeration.

[smeenai]

This is a dupe of a part of D80582.

[gkm]

I removed the -parse_version portions of D80582, since it's better for my diff to be just foundational Options.td changes, and because @compnerd's diff is nicer.

lld/MachO/Driver.cpp

363–364

LLVM's option library does support multi-part options directly. See the first rev. of D80582.

467

Use error() for option-parsing diagnostics.

473

Use error() for option-parsing diagnostics.

[gkm]

@compnerd, do you intend to complete & land this diff?

[gkm]

Finish, fix & expand tests

[tschuett]

You can add DriverKit here:
https://github.com/llvm/llvm-project/blob/master/llvm/include/llvm/TextAPI/MachO/Platform.h#L33
and here:
https://github.com/llvm/llvm-project/blob/master/llvm/include/llvm/BinaryFormat/MachO.h#L499

[gkm]

@tschuett, see D85594 for DriverKit platform addition

[int3]

lld/test/MachO/platform-version.s

11

nit: it's more common to use hyphens instead of underscores for check prefixes, i.e. FAIL-MISSING

Also, I was thinking it might make sense to split this test into two parts, with all the FAIL- checks going under invalid/, and the passing ones remaining here. Once we support LC_BUILD_VERSION, we'll probably want to expand the test for passing platform strings to include checks that the LC_BUILD_VERSION command contains the expected output.

42

even though man ld indicates that ios-sim is a valid platform string, I couldn't get it to work on ld64 :/ it seems like ios-simulator is expected instead. (I tried that string out after finding it in rG25ce33a6e).

[gkm]

lld/test/MachO/platform-version.s

11

For now, I would rather keep all tests in one place.

42

Indeed, I got the *-sim names from the ld(1) manual page in Xcode 11. Obviously it is wrong.

I looked at ld64/src/ld/PlatformSupport.cpp the newest ld64 source I have (v512), and found that -platform_version matches are case insensitive, with words separated by either dash or space. Here are the official names:

"unknown"
"macOS"
"iOS"
"tvOS"
"watchOS"
"bridgeOS"
"Mac Catalyst"
"iOS Simulator"
"tvOS Simulator"
"watchOS Simulator"
"DriverKit"
"free standing"

I cross-checked against the binary for Xcode 11.3 (v530) via strings(1). I update to make the matches case insensitive and to tolerate either space or dash for word separators.

[tschuett]

Here is v530:
https://opensource.apple.com/tarballs/ld64/ld64-530.tar.gz

[gkm]

respond to review feedback

[int3]

lgtm!

lld/test/MachO/platform-version.s

46

would be good to make one of these test strings contain a hyphen

[gkm]

Add dash to a couple of multi-word platform names

[gkm]

lld/test/MachO/platform-version.s

46

Done.

lld/MachO/Config.h

 //===- Config.h -------------------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLD_MACHO_CONFIG_H
 #define LLD_MACHO_CONFIG_H
 
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/BinaryFormat/MachO.h"
+#include "llvm/Support/VersionTuple.h"
 #include "llvm/TextAPI/MachO/Architecture.h"
+#include "llvm/TextAPI/MachO/Platform.h"
 
 #include <vector>
 
 namespace lld {
 namespace macho {
 
 class Symbol;
 struct SymbolPriorityEntry;
 
+struct PlatformInfo {
+  llvm::MachO::PlatformKind kind;
+  llvm::VersionTuple minimum;
+  llvm::VersionTuple sdk;
+};
+
 struct Configuration {
   Symbol *entry;
   bool hasReexports = false;
   uint32_t headerPad;
   llvm::StringRef installName;
   llvm::StringRef outputFile;
   llvm::MachO::Architecture arch;
+  PlatformInfo platform;
   llvm::MachO::HeaderFileType outputType;
   std::vector<llvm::StringRef> librarySearchPaths;
   std::vector<llvm::StringRef> frameworkSearchPaths;
   llvm::DenseMap<llvm::StringRef, SymbolPriorityEntry> priorities;
 };
 
 // The symbol with the highest priority should be ordered first in the output
 // section (modulo input section contiguity constraints). Using priority

lld/MachO/Driver.cpp

 #include "llvm/Object/Archive.h"
 #include "llvm/Option/ArgList.h"
 #include "llvm/Option/Option.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Host.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
 
+#include <algorithm>
+
 using namespace llvm;
 using namespace llvm::MachO;
 using namespace llvm::sys;
 using namespace llvm::opt;
 using namespace lld;
 using namespace lld::macho;
 
 Configuration *lld::macho::config;
if (auto *dylibFile = dyn_cast<DylibFile>(file)) {
         dylibFile->reexport = true;
         return true;
       }
     }
   }
   return false;
 }
 
+static inline char toLowerDash(char x) {
+  if (x >= 'A' && x <= 'Z')
+    return x - 'A' + 'a';
+  else if (x == ' ')
+    return '-';
+  return x;
+}
+
+static std::string lowerDash(StringRef s) {
+  return std::string(map_iterator(s.begin(), toLowerDash),
+                     map_iterator(s.end(), toLowerDash));
+}
+
 static void handlePlatformVersion(const opt::Arg *arg) {
-  // TODO: implementation coming very soon ...
+  StringRef platformStr = arg->getValue(0);
+  StringRef minVersionStr = arg->getValue(1);
+  StringRef sdkVersionStr = arg->getValue(2);
+
+  // TODO(compnerd) see if we can generate this case list via XMACROS
+  config->platform.kind =
+      llvm::StringSwitch<llvm::MachO::PlatformKind>(lowerDash(platformStr))
+          .Cases("macos", "1", llvm::MachO::PlatformKind::macOS)
+          .Cases("ios", "2", llvm::MachO::PlatformKind::iOS)
+          .Cases("tvos", "3", llvm::MachO::PlatformKind::tvOS)
+          .Cases("watchos", "4", llvm::MachO::PlatformKind::watchOS)
+          .Cases("bridgeos", "5", llvm::MachO::PlatformKind::bridgeOS)
+          .Cases("mac-catalyst", "6", llvm::MachO::PlatformKind::macCatalyst)
+          .Cases("ios-simulator", "7", llvm::MachO::PlatformKind::iOSSimulator)
+          .Cases("tvos-simulator", "8",
+                 llvm::MachO::PlatformKind::tvOSSimulator)
+          .Cases("watchos-simulator", "9",
+                 llvm::MachO::PlatformKind::watchOSSimulator)
+          .Default(llvm::MachO::PlatformKind::unknown);
+  if (config->platform.kind == llvm::MachO::PlatformKind::unknown)
+    error(Twine("malformed platform: ") + platformStr);
+  // TODO: check validity of version strings, which varies by platform
+  // NOTE: ld64 accepts version strings with 5 components
+  // llvm::VersionTuple accepts no more than 4 components
+  // Has Apple ever published version strings with 5 components?
+  if (config->platform.minimum.tryParse(minVersionStr))
+    error(Twine("malformed minimum version: ") + minVersionStr);
+  if (config->platform.sdk.tryParse(sdkVersionStr))
+    error(Twine("malformed sdk version: ") + sdkVersionStr);
 }
 
 static void warnIfDeprecatedOption(const opt::Option &opt) {
   if (!opt.getGroup().isValid())
     return;
   if (opt.getGroup().getID() == OPT_grp_deprecated) {
     warn("Option `" + opt.getPrefixedName() + "' is deprecated in ld64:");
     warn(opt.getHelpText());
bool macho::link(llvm::ArrayRef<const char *> argsArr, bool canExitEarly,
   }
 
   config = make<Configuration>();
   symtab = make<SymbolTable>();
   target = createTargetInfo(args);
 
   config->entry = symtab->addUndefined(args.getLastArgValue(OPT_e, "_main"));
   config->outputFile = args.getLastArgValue(OPT_o, "a.out");
   config->installName =
       args.getLastArgValue(OPT_install_name, config->outputFile);
   config->headerPad = args::getHex(args, OPT_headerpad, /*Default=*/32);
   config->outputType = args.hasArg(OPT_dylib) ? MH_DYLIB : MH_EXECUTE;
 
   std::vector<StringRef> roots;
   for (const Arg *arg : args.filtered(OPT_syslibroot))
     roots.push_back(arg->getValue());
   // NOTE: the final `-syslibroot` being `/` will ignore all roots
   if (roots.size() && roots.back() == "/")
     roots.clear();
   // NOTE: roots can never be empty - add an empty root to simplify the library
   // and framework search path computation.
   if (roots.empty())
     roots.emplace_back("");

lld/test/MachO/platform-version.s

+# REQUIRES: x86
+# RUN: llvm-mc -filetype=obj -triple=x86_64-apple-darwin %s -o %t.o
+
+### We test every platform keyword. Sometimes good keywords are coupled
+### with bad version strings, so we use *-NOT patterns to ensure that
+### no "malformed platform" diagnostic appears in those cases.
+
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version \
+# RUN:    | FileCheck --check-prefix=FAIL-MISSING %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version wtf \
+# RUN:    | FileCheck --check-prefix=FAIL-MISSING %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version lolz 1.2.3.4.5 \
+# RUN:    | FileCheck --check-prefix=FAIL-MISSING %s
+# FAIL-MISSING: -platform_version: missing argument
+# FAIL-MISSING-NOT: malformed platform: {{.*}}
+# FAIL-MISSING-NOT: malformed {{minimum|sdk}} version: {{.*}}
+
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version macOS -lfoo 2 \
+# RUN:     | FileCheck --check-prefix=FAIL-MALFORM %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version iOS 1 2.a \
+# RUN:     | FileCheck --check-prefix=FAIL-MALFORM %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version tvOS 1.2.3.4.5 10 \
+# RUN:     | FileCheck --check-prefix=FAIL-MALFORM %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version watchOS 10 1.2.3.4.5 \
+# RUN:     | FileCheck --check-prefix=FAIL-MALFORM %s
+# FAIL-MALFORM-NOT: malformed platform: {{.*}}
+# FAIL-MALFORM: malformed {{minimum|sdk}} version: {{.*}}
+
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version bridgeOS 1 5
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version "Mac Catalyst" 1.2 5.6
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version "iOS Simulator" 1.2.3 5.6.7
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version tvOS-Simulator 1.2.3.4 5.6.7.8
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version watchOS-Simulator 1 5
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version 1 1 5
+# RUN: lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version 9 1 5
+
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version wtf 1 5 \
+# RUN:     | FileCheck --check-prefix=FAIL-PLATFORM %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version 0 1 5 \
+# RUN:     | FileCheck --check-prefix=FAIL-PLATFORM %s
+# RUN: not lld -flavor darwinnew -Z -o %t %t.o 2>&1 \
+# RUN:        -platform_version 10 1 5 \
+# RUN:     | FileCheck --check-prefix=FAIL-PLATFORM %s
+# FAIL-PLATFORM: malformed platform: {{.*}}
+# FAIL-PLATFORM-NOT: malformed {{minimum|sdk}} version: {{.*}}
+
+.text
+.global _main
+_main:
+  mov $0, %eax
+  ret

lld/test/MachO/platform-version.test

-# RUN: not lld -flavor darwinnew -platform_version 2>&1 \
-# RUN:     | FileCheck --check-prefix=MISSING %s
-# RUN: not lld -flavor darwinnew -platform_version macos 2>&1 \
-# RUN:     | FileCheck --check-prefix=MISSING %s
-# RUN: not lld -flavor darwinnew -platform_version macos 10.15 2>&1 \
-# RUN:     | FileCheck --check-prefix=MISSING %s
-# RUN: not lld -flavor darwinnew -platform_version macos -lfoo 10.15 2>&1 \
-# RUN:     | FileCheck --check-prefix=GOOD %s
-# RUN: not lld -flavor darwinnew -platform_version macos 10.15 10.15.4 2>&1 \
-# RUN:     | FileCheck --check-prefix=GOOD %s
-# RUN: not lld -flavor darwinnew -platform_version macos 10.15 10.15.4 foobar 2>&1 \
-# RUN:     | FileCheck --check-prefix=FAIL_FILE %s
-
-MISSING: -platform_version: missing argument
-FAIL: usage: -platform_version platform min_version sdk_version
-GOOD: undefined symbol: _main
-FAIL_FILE: cannot open foobar