[MachO] Add skeletal support for DriverKit platform

[gkm]

Summary

Define the platform ID = 10, and simple mappings between platform ID & name.

[MaskRay]

llvm/include/llvm/BinaryFormat/MachO.h

499

Add a trailing comma so that the next update can be easier.

llvm/include/llvm/TextAPI/MachO/Platform.h

33

Add a trailing comma so that the next update can be easier.

[tschuett]

Do you want to add something similar to:
https://github.com/llvm/llvm-project/blob/master/llvm/unittests/TextAPI/TextStubV4Tests.cpp#L593
for DriverKit?

[gkm]

@tschuett, I prefer not to do anything that involves semantics for DriverKit, since I don't have any domain knowledge. For that matter, perhaps I shouldn't even follow-through with this diff, which I only embarked upon at your suggestion because the original author of the MachO -platform_version diff (I commandeered it) had a TODO comment. I can code-monkey the TBDv4 testcase via simple substitution, but what about TBDv1 .. TBDv3? IDK, and don't want to spend time determining minimum version# for DriverKit. Do you know that?

[tschuett]

No worries. I added @ributzka and @cishida as reviewers because they should know.

[gkm]

Add trailing commas, as per review feeddback

[MaskRay]

In D85594#2207081, @tschuett wrote:

No worries. I added @ributzka and @cishida as reviewers because they should know.

A lot of string values in that list miss tests. People with domain knowledge can add the tests separately, I think.

[cishida]

In D85594#2207080, @gkm wrote:

@tschuett, I prefer not to do anything that involves semantics for DriverKit, since I don't have any domain knowledge. For that matter, perhaps I shouldn't even follow-through with this diff, which I only embarked upon at your suggestion because the original author of the MachO -platform_version diff (I commandeered it) had a TODO comment. I can code-monkey the TBDv4 testcase via simple substitution, but what about TBDv1 .. TBDv3? IDK, and don't want to spend time determining minimum version# for DriverKit. Do you know that?

The current TextAPI library is simple reader/writer support and the referenced unit tests reflect any valid inputs to generate tbd and nothing else. IMO adding one TBDv4 test case with just the target info and install name would be good to add. I'd be happy to write the patch for it after this lands if that helps.

llvm/lib/TextAPI/MachO/Platform.cpp

52

DriverKit case should be included

[gkm]

rebase

[gkm]

add unittest for new symbol PlatformKind::driverKit

[gkm]

llvm/unittests/TextAPI/TextStubV4Tests.cpp

761–784

@cishida, is this sufficient?

[cishida]

llvm/unittests/TextAPI/TextStubV4Tests.cpp

761–784

Looks good, thanks!

[gkm]

llvm/lib/TextAPI/MachO/Platform.cpp

52

@cishida, a case here depends on first defining DriverKit for enum Triple::OSType in llvm/include/llvm/ADT/Triple.h, which does not yet exist. (Same for BridgeOS according to your comment above). I see that properly supporting these Triple::OSType enums requires knowing minimum OS versions in several contexts, and knowing more about the platforms than I do.

May I commit this diff as-is, without Triple::OSType::DriverKit, and leave that to you?

[cishida]

llvm/lib/TextAPI/MachO/Platform.cpp

52

SGTM! In the revision that lands, could you just include driverkit in the TODO comment?

[gkm]

supplement TODO comment

llvm/include/llvm/BinaryFormat/MachO.h

enum PlatformType {
   PLATFORM_MACOS = 1,
   PLATFORM_IOS = 2,
   PLATFORM_TVOS = 3,
   PLATFORM_WATCHOS = 4,
   PLATFORM_BRIDGEOS = 5,
   PLATFORM_MACCATALYST = 6,
   PLATFORM_IOSSIMULATOR = 7,
   PLATFORM_TVOSSIMULATOR = 8,
-  PLATFORM_WATCHOSSIMULATOR = 9
+  PLATFORM_WATCHOSSIMULATOR = 9,
+  PLATFORM_DRIVERKIT = 10,
 };
 
 // Values for tools enum in build_tool_version.
 enum { TOOL_CLANG = 1, TOOL_SWIFT = 2, TOOL_LD = 3 };
 
 // Structs from <mach-o/loader.h>
 
 struct mach_header {

llvm/include/llvm/Object/MachO.h

static std::string getBuildPlatform(uint32_t platform) {
     case MachO::PLATFORM_IOS: return "ios";
     case MachO::PLATFORM_TVOS: return "tvos";
     case MachO::PLATFORM_WATCHOS: return "watchos";
     case MachO::PLATFORM_BRIDGEOS: return "bridgeos";
     case MachO::PLATFORM_MACCATALYST: return "macCatalyst";
     case MachO::PLATFORM_IOSSIMULATOR: return "iossimulator";
     case MachO::PLATFORM_TVOSSIMULATOR: return "tvossimulator";
     case MachO::PLATFORM_WATCHOSSIMULATOR: return "watchossimulator";
+    case MachO::PLATFORM_DRIVERKIT: return "driverkit";
     default:
       std::string ret;
       raw_string_ostream ss(ret);
       ss << format_hex(platform, 8, true);
       return ss.str();
     }
   }
 

llvm/include/llvm/TextAPI/MachO/Platform.h

enum class PlatformKind : unsigned {
   macOS = MachO::PLATFORM_MACOS,
   iOS = MachO::PLATFORM_IOS,
   tvOS = MachO::PLATFORM_TVOS,
   watchOS = MachO::PLATFORM_WATCHOS,
   bridgeOS = MachO::PLATFORM_BRIDGEOS,
   macCatalyst = MachO::PLATFORM_MACCATALYST,
   iOSSimulator = MachO::PLATFORM_IOSSIMULATOR,
   tvOSSimulator = MachO::PLATFORM_TVOSSIMULATOR,
-  watchOSSimulator = MachO::PLATFORM_WATCHOSSIMULATOR
+  watchOSSimulator = MachO::PLATFORM_WATCHOSSIMULATOR,
+  driverKit = MachO::PLATFORM_DRIVERKIT,
 };
 
 using PlatformSet = SmallSet<PlatformKind, 3>;
 
 PlatformKind mapToPlatformKind(PlatformKind Platform, bool WantSim);
 PlatformKind mapToPlatformKind(const Triple &Target);
 PlatformSet mapToPlatformSet(ArrayRef<Triple> Targets);
 StringRef getPlatformName(PlatformKind Platform);
 
 } // end namespace MachO.
 } // end namespace llvm.
 
-#endif // LLVM_TEXTAPI_MACHO_PLATFORM_H
+#endif // LLVM_TEXTAPI_MACHO_PLATFORM_H
 

llvm/lib/MC/MCAsmStreamer.cpp

static const char *getPlatformName(MachO::PlatformType Type) {
   case MachO::PLATFORM_IOS:              return "ios";
   case MachO::PLATFORM_TVOS:             return "tvos";
   case MachO::PLATFORM_WATCHOS:          return "watchos";
   case MachO::PLATFORM_BRIDGEOS:         return "bridgeos";
   case MachO::PLATFORM_MACCATALYST:      return "macCatalyst";
   case MachO::PLATFORM_IOSSIMULATOR:     return "iossimulator";
   case MachO::PLATFORM_TVOSSIMULATOR:    return "tvossimulator";
   case MachO::PLATFORM_WATCHOSSIMULATOR: return "watchossimulator";
+  case MachO::PLATFORM_DRIVERKIT:        return "driverkit";
   }
   llvm_unreachable("Invalid Mach-O platform type");
 }
 
 void MCAsmStreamer::emitBuildVersion(unsigned Platform, unsigned Major,
                                      unsigned Minor, unsigned Update,
                                      VersionTuple SDKVersion) {
   const char *PlatformName = getPlatformName((MachO::PlatformType)Platform);

llvm/lib/MC/MCParser/DarwinAsmParser.cpp

static Triple::OSType getOSTypeFromPlatform(MachO::PlatformType Type) {
   case MachO::PLATFORM_IOS:     return Triple::IOS;
   case MachO::PLATFORM_TVOS:    return Triple::TvOS;
   case MachO::PLATFORM_WATCHOS: return Triple::WatchOS;
   case MachO::PLATFORM_BRIDGEOS:         /* silence warning */ break;
   case MachO::PLATFORM_MACCATALYST: return Triple::IOS;
   case MachO::PLATFORM_IOSSIMULATOR:     /* silence warning */ break;
   case MachO::PLATFORM_TVOSSIMULATOR:    /* silence warning */ break;
   case MachO::PLATFORM_WATCHOSSIMULATOR: /* silence warning */ break;
+  case MachO::PLATFORM_DRIVERKIT:        /* silence warning */ break;
   }
   llvm_unreachable("Invalid mach-o platform type");
 }
 
 /// parseBuildVersion
 ///   ::= .build_version (macos|ios|tvos|watchos), parseVersion parseSDKVersion
 bool DarwinAsmParser::parseBuildVersion(StringRef Directive, SMLoc Loc) {
   StringRef PlatformName;

llvm/lib/TextAPI/MachO/Platform.cpp

if (Target.getEnvironment() == Triple::MacABI)
       return PlatformKind::macCatalyst;
     return PlatformKind::iOS;
   case Triple::TvOS:
     return Target.isSimulatorEnvironment() ? PlatformKind::tvOSSimulator
                                            : PlatformKind::tvOS;
   case Triple::WatchOS:
     return Target.isSimulatorEnvironment() ? PlatformKind::watchOSSimulator
                                            : PlatformKind::watchOS;
-    // TODO: add bridgeOS once in llvm::Triple
+    // TODO: add bridgeOS & driverKit once in llvm::Triple
   }
   llvm_unreachable("Unknown Target Triple");
 }
 
 PlatformSet mapToPlatformSet(ArrayRef<Triple> Targets) {
   PlatformSet Result;
   for (const auto &Target : Targets)
     Result.insert(mapToPlatformKind(Target));
StringRef getPlatformName(PlatformKind Platform) {
   case PlatformKind::macCatalyst:
     return "macCatalyst";
   case PlatformKind::iOSSimulator:
     return "iOS Simulator";
   case PlatformKind::tvOSSimulator:
     return "tvOS Simulator";
   case PlatformKind::watchOSSimulator:
     return "watchOS Simulator";
+  case PlatformKind::driverKit:
+    return "driverKit";
   }
   llvm_unreachable("Unknown llvm.MachO.PlatformKind enum");
 }
 
 } // end namespace MachO.
 } // end namespace llvm.

llvm/lib/TextAPI/MachO/Target.cpp

Platform = StringSwitch<PlatformKind>(PlatformStr)
                  .Case("ios", PlatformKind::iOS)
                  .Case("tvos", PlatformKind::tvOS)
                  .Case("watchos", PlatformKind::watchOS)
                  .Case("bridgeos", PlatformKind::bridgeOS)
                  .Case("maccatalyst", PlatformKind::macCatalyst)
                  .Case("ios-simulator", PlatformKind::iOSSimulator)
                  .Case("tvos-simulator", PlatformKind::tvOSSimulator)
                  .Case("watchos-simulator", PlatformKind::watchOSSimulator)
+                 .Case("driverkit", PlatformKind::driverKit)
                  .Default(PlatformKind::unknown);
 
   if (Platform == PlatformKind::unknown) {
     if (PlatformStr.startswith("<") && PlatformStr.endswith(">")) {
       PlatformStr = PlatformStr.drop_front().drop_back();
       unsigned long long RawValue;
       if (!PlatformStr.getAsInteger(10, RawValue))
         Platform = (PlatformKind)RawValue;

llvm/lib/TextAPI/MachO/TextStub.cpp

case PlatformKind::iOSSimulator:
       OS << "ios-simulator";
       break;
     case PlatformKind::tvOSSimulator:
       OS << "tvos-simulator";
       break;
     case PlatformKind::watchOSSimulator:
       OS << "watchos-simulator";
       break;
+    case PlatformKind::driverKit:
+      OS << "driverkit";
+      break;
     }
   }
 
   static StringRef input(StringRef Scalar, void *, Target &Value) {
     auto Result = Target::create(Scalar);
     if (!Result) {
       consumeError(Result.takeError());
       return "unparsable target";

llvm/lib/TextAPI/MachO/TextStubCommon.cpp

case PlatformKind::tvOS:
     OS << "tvos";
     break;
   case PlatformKind::bridgeOS:
     OS << "bridgeos";
     break;
   case PlatformKind::macCatalyst:
     OS << "iosmac";
     break;
+  case PlatformKind::driverKit:
+    OS << "driverkit";
+    break;
   }
 }
 
 StringRef ScalarTraits<PlatformSet>::input(StringRef Scalar, void *IO,
                                            PlatformSet &Values) {
   const auto *Ctx = reinterpret_cast<TextAPIContext *>(IO);
   assert((!Ctx || Ctx->FileKind != FileType::Invalid) &&
          "File type is not set in context");

llvm/unittests/TextAPI/TextStubV4Tests.cpp

TEST(TBDv4, Target_i386_watchos_simulator) {
   SmallString<4096> Buffer;
   raw_svector_ostream OS(Buffer);
   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
   EXPECT_TRUE(!WriteResult);
   EXPECT_EQ(stripWhitespace(TBDv4i386watchOSSim),
             stripWhitespace(Buffer.c_str()));
 }
 
+TEST(TBDv4, Target_i386_driverkit) {
+  static const char TBDv4i386DriverKit[] =
+      "--- !tapi-tbd\n"
+      "tbd-version: 4\n"
+      "targets: [  i386-driverkit  ]\n"
+      "install-name: Test.dylib\n"
+      "...\n";
+
+  Expected<TBDFile> Result =
+      TextAPIReader::get(MemoryBufferRef(TBDv4i386DriverKit, "Test.tbd"));
+  EXPECT_TRUE(!!Result);
+  TBDFile File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V4, File->getFileType());
+  EXPECT_EQ(ArchitectureSet(AK_i386), File->getArchitectures());
+  EXPECT_EQ(File->getPlatforms().size(), 1U);
+  EXPECT_EQ(PlatformKind::driverKit, *File->getPlatforms().begin());
+
+  SmallString<4096> Buffer;
+  raw_svector_ostream OS(Buffer);
+  auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
+  EXPECT_TRUE(!WriteResult);
+  EXPECT_EQ(stripWhitespace(TBDv4i386DriverKit),
+            stripWhitespace(Buffer.c_str()));
+}
+
 TEST(TBDv4, Swift_1) {
   static const char TBDv4SwiftVersion1[] = "--- !tapi-tbd\n"
                                            "tbd-version: 4\n"
                                            "targets: [  x86_64-macos ]\n"
                                            "install-name: Test.dylib\n"
                                            "swift-abi-version: 1\n"
                                            "...\n";