[TextAPI] TBD Reader/Writer

Add basic infrastructure for reading and writting TBD files (version 1 - 3).

The TextAPI library is not used by anything yet (besides the unit tests). Tool
support will be added in a separate commit.

The TBD format is currently documented in the implementation file (TextStub.cpp).

https://reviews.llvm.org/D53945

Update: This contains changes to fix issues discovered by the bots:
 - add parentheses to silence warnings.
 - rename variables
 - use PlatformType from BinaryFormat
llvm-svn: 347823

1 files changed, 444 insertions, 0 deletions

diff --git a/llvm/unittests/TextAPI/TextStubV1Tests.cpp b/llvm/unittests/TextAPI/TextStubV1Tests.cpp
new file mode 100644
index 00000000000..e5d8e42de7b
--- /dev/null
+++ b/llvm/unittests/TextAPI/TextStubV1Tests.cpp
@@ -0,0 +1,444 @@
+//===-- TextStubV1Tests.cpp - TBD V1 File Test ----------------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+#include "llvm/TextAPI/MachO/InterfaceFile.h"
+#include "llvm/TextAPI/MachO/TextAPIReader.h"
+#include "llvm/TextAPI/MachO/TextAPIWriter.h"
+#include "gtest/gtest.h"
+#include <string>
+#include <vector>
+
+using namespace llvm;
+using namespace llvm::MachO;
+
+using ExportedSymbol = std::tuple<SymbolKind, std::string, bool, bool>;
+using ExportedSymbolSeq = std::vector<ExportedSymbol>;
+
+inline bool operator<(const ExportedSymbol &lhs, const ExportedSymbol &rhs) {
+  return std::get<1>(lhs) < std::get<1>(rhs);
+}
+
+static ExportedSymbolSeq TBDv1Symbols({
+    {SymbolKind::GlobalSymbol, "$ld$hide$os9.0$_sym1", false, false},
+    {SymbolKind::GlobalSymbol, "_sym1", false, false},
+    {SymbolKind::GlobalSymbol, "_sym2", false, false},
+    {SymbolKind::GlobalSymbol, "_sym3", false, false},
+    {SymbolKind::GlobalSymbol, "_sym4", false, false},
+    {SymbolKind::GlobalSymbol, "_sym5", false, false},
+    {SymbolKind::GlobalSymbol, "_tlv1", false, true},
+    {SymbolKind::GlobalSymbol, "_tlv2", false, true},
+    {SymbolKind::GlobalSymbol, "_tlv3", false, true},
+    {SymbolKind::GlobalSymbol, "_weak1", true, false},
+    {SymbolKind::GlobalSymbol, "_weak2", true, false},
+    {SymbolKind::GlobalSymbol, "_weak3", true, false},
+    {SymbolKind::ObjectiveCClass, "class1", false, false},
+    {SymbolKind::ObjectiveCClass, "class2", false, false},
+    {SymbolKind::ObjectiveCClass, "class3", false, false},
+    {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar1", false, false},
+    {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar2", false, false},
+    {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar3", false, false},
+});
+
+namespace TBDv1 {
+
+TEST(TBDv1, ReadFile) {
+  static const char tbd_v1_file1[] =
+      "---\n"
+      "archs: [ armv7, armv7s, armv7k, arm64 ]\n"
+      "platform: ios\n"
+      "install-name: Test.dylib\n"
+      "current-version: 2.3.4\n"
+      "compatibility-version: 1.0\n"
+      "swift-version: 1.1\n"
+      "exports:\n"
+      "  - archs: [ armv7, armv7s, armv7k, arm64 ]\n"
+      "    allowed-clients: [ clientA ]\n"
+      "    re-exports: [ /usr/lib/libfoo.dylib ]\n"
+      "    symbols: [ _sym1, _sym2, _sym3, _sym4, $ld$hide$os9.0$_sym1 ]\n"
+      "    objc-classes: [ _class1, _class2 ]\n"
+      "    objc-ivars: [ _class1._ivar1, _class1._ivar2 ]\n"
+      "    weak-def-symbols: [ _weak1, _weak2 ]\n"
+      "    thread-local-symbols: [ _tlv1, _tlv2 ]\n"
+      "  - archs: [ armv7, armv7s, armv7k ]\n"
+      "    symbols: [ _sym5 ]\n"
+      "    objc-classes: [ _class3 ]\n"
+      "    objc-ivars: [ _class1._ivar3 ]\n"
+      "    weak-def-symbols: [ _weak3 ]\n"
+      "    thread-local-symbols: [ _tlv3 ]\n"
+      "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_file1, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  auto Archs = Architecture::armv7 | Architecture::armv7s |
+               Architecture::armv7k | Architecture::arm64;
+  EXPECT_EQ(Archs, File->getArchitectures());
+  EXPECT_EQ(PLATFORM_IOS, File->getPlatform());
+  EXPECT_EQ(std::string("Test.dylib"), File->getInstallName());
+  EXPECT_EQ(PackedVersion(2, 3, 4), File->getCurrentVersion());
+  EXPECT_EQ(PackedVersion(1, 0, 0), File->getCompatibilityVersion());
+  EXPECT_EQ(2U, File->getSwiftABIVersion());
+  EXPECT_EQ(ObjCConstraintType::None, File->getObjCConstraint());
+  EXPECT_TRUE(File->isTwoLevelNamespace());
+  EXPECT_TRUE(File->isApplicationExtensionSafe());
+  EXPECT_FALSE(File->isInstallAPI());
+  InterfaceFileRef client("clientA", Archs);
+  InterfaceFileRef reexport("/usr/lib/libfoo.dylib", Archs);
+  EXPECT_EQ(1U, File->allowableClients().size());
+  EXPECT_EQ(client, File->allowableClients().front());
+  EXPECT_EQ(1U, File->reexportedLibraries().size());
+  EXPECT_EQ(reexport, File->reexportedLibraries().front());
+
+  ExportedSymbolSeq Exports;
+  for (const auto *Sym : File->symbols()) {
+    EXPECT_FALSE(Sym->isWeakReferenced());
+    EXPECT_FALSE(Sym->isUndefined());
+    Exports.emplace_back(Sym->getKind(), Sym->getName(), Sym->isWeakDefined(),
+                         Sym->isThreadLocalValue());
+  }
+  llvm::sort(Exports.begin(), Exports.end());
+
+  EXPECT_EQ(TBDv1Symbols.size(), Exports.size());
+  EXPECT_TRUE(std::equal(Exports.begin(), Exports.end(), TBDv1Symbols.begin()));
+}
+
+TEST(TBDv1, ReadFile2) {
+  static const char tbd_v1_file2[] = "--- !tapi-tbd-v1\n"
+                                     "archs: [ armv7, armv7s, armv7k, arm64 ]\n"
+                                     "platform: ios\n"
+                                     "install-name: Test.dylib\n"
+                                     "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_file2, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  auto Archs = Architecture::armv7 | Architecture::armv7s |
+               Architecture::armv7k | Architecture::arm64;
+  EXPECT_EQ(Archs, File->getArchitectures());
+  EXPECT_EQ(PLATFORM_IOS, File->getPlatform());
+  EXPECT_EQ(std::string("Test.dylib"), File->getInstallName());
+  EXPECT_EQ(PackedVersion(1, 0, 0), File->getCurrentVersion());
+  EXPECT_EQ(PackedVersion(1, 0, 0), File->getCompatibilityVersion());
+  EXPECT_EQ(0U, File->getSwiftABIVersion());
+  EXPECT_EQ(ObjCConstraintType::None, File->getObjCConstraint());
+  EXPECT_TRUE(File->isTwoLevelNamespace());
+  EXPECT_TRUE(File->isApplicationExtensionSafe());
+  EXPECT_FALSE(File->isInstallAPI());
+  EXPECT_EQ(0U, File->allowableClients().size());
+  EXPECT_EQ(0U, File->reexportedLibraries().size());
+}
+
+TEST(TBDv1, WriteFile) {
+  static const char tbd_v1_file3[] =
+      "---\n"
+      "archs:           [ i386, x86_64 ]\n"
+      "platform:        macosx\n"
+      "install-name:    '/usr/lib/libfoo.dylib'\n"
+      "current-version: 1.2.3\n"
+      "compatibility-version: 0\n"
+      "swift-version:   5\n"
+      "objc-constraint: retain_release\n"
+      "exports:         \n"
+      "  - archs:           [ i386 ]\n"
+      "    symbols:         [ _sym1 ]\n"
+      "    weak-def-symbols: [ _sym2 ]\n"
+      "    thread-local-symbols: [ _sym3 ]\n"
+      "  - archs:           [ x86_64 ]\n"
+      "    allowed-clients: [ clientA ]\n"
+      "    re-exports:      [ '/usr/lib/libfoo.dylib' ]\n"
+      "    symbols:         [ '_OBJC_EHTYPE_$_Class1' ]\n"
+      "    objc-classes:    [ _Class1 ]\n"
+      "    objc-ivars:      [ _Class1._ivar1 ]\n"
+      "...\n";
+
+  InterfaceFile File;
+  File.setPath("libfoo.dylib");
+  File.setInstallName("/usr/lib/libfoo.dylib");
+  File.setFileType(FileType::TBD_V1);
+  File.setArchitectures(Architecture::i386 | Architecture::x86_64);
+  File.setPlatform(PLATFORM_MACOS);
+  File.setCurrentVersion(PackedVersion(1, 2, 3));
+  File.setSwiftABIVersion(5);
+  File.setObjCConstraint(ObjCConstraintType::Retain_Release);
+  File.addAllowableClient("clientA", Architecture::x86_64);
+  File.addReexportedLibrary("/usr/lib/libfoo.dylib", Architecture::x86_64);
+  File.addSymbol(SymbolKind::GlobalSymbol, "_sym1", Architecture::i386);
+  File.addSymbol(SymbolKind::GlobalSymbol, "_sym2", Architecture::i386,
+                 SymbolFlags::WeakDefined);
+  File.addSymbol(SymbolKind::GlobalSymbol, "_sym3", Architecture::i386,
+                 SymbolFlags::ThreadLocalValue);
+  File.addSymbol(SymbolKind::ObjectiveCClass, "Class1", Architecture::x86_64);
+  File.addSymbol(SymbolKind::ObjectiveCClassEHType, "Class1",
+                 Architecture::x86_64);
+  File.addSymbol(SymbolKind::ObjectiveCInstanceVariable, "Class1._ivar1",
+                 Architecture::x86_64);
+
+  SmallString<4096> Buffer;
+  raw_svector_ostream OS(Buffer);
+  auto Result = TextAPIWriter::writeToStream(OS, File);
+  EXPECT_FALSE(Result);
+  EXPECT_STREQ(tbd_v1_file3, Buffer.c_str());
+}
+
+TEST(TBDv1, Platform_macOS) {
+  static const char tbd_v1_platform_macos[] = "---\n"
+                                              "archs: [ x86_64 ]\n"
+                                              "platform: macosx\n"
+                                              "install-name: Test.dylib\n"
+                                              "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_platform_macos, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(PLATFORM_MACOS, File->getPlatform());
+}
+
+TEST(TBDv1, Platform_iOS) {
+  static const char tbd_v1_platform_ios[] = "---\n"
+                                            "archs: [ arm64 ]\n"
+                                            "platform: ios\n"
+                                            "install-name: Test.dylib\n"
+                                            "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_platform_ios, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(PLATFORM_IOS, File->getPlatform());
+}
+
+TEST(TBDv1, Platform_watchOS) {
+  static const char tbd_v1_platform_watchos[] = "---\n"
+                                                "archs: [ armv7k ]\n"
+                                                "platform: watchos\n"
+                                                "install-name: Test.dylib\n"
+                                                "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_platform_watchos, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(PLATFORM_WATCHOS, File->getPlatform());
+}
+
+TEST(TBDv1, Platform_tvOS) {
+  static const char tbd_v1_platform_tvos[] = "---\n"
+                                             "archs: [ arm64 ]\n"
+                                             "platform: tvos\n"
+                                             "install-name: Test.dylib\n"
+                                             "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_platform_tvos, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(PLATFORM_TVOS, File->getPlatform());
+}
+
+TEST(TBDv1, Platform_bridgeOS) {
+  static const char tbd_v1_platform_bridgeos[] = "---\n"
+                                                 "archs: [ armv7k ]\n"
+                                                 "platform: bridgeos\n"
+                                                 "install-name: Test.dylib\n"
+                                                 "...\n";
+
+  auto Buffer =
+      MemoryBuffer::getMemBuffer(tbd_v1_platform_bridgeos, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(PLATFORM_BRIDGEOS, File->getPlatform());
+}
+
+TEST(TBDv1, Swift_1_0) {
+  static const char tbd_v1_swift_1_0[] = "---\n"
+                                         "archs: [ arm64 ]\n"
+                                         "platform: ios\n"
+                                         "install-name: Test.dylib\n"
+                                         "swift-version: 1.0\n"
+                                         "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_1_0, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(1U, File->getSwiftABIVersion());
+}
+
+TEST(TBDv1, Swift_1_1) {
+  static const char tbd_v1_swift_1_1[] = "---\n"
+                                         "archs: [ arm64 ]\n"
+                                         "platform: ios\n"
+                                         "install-name: Test.dylib\n"
+                                         "swift-version: 1.1\n"
+                                         "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_1_1, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(2U, File->getSwiftABIVersion());
+}
+
+TEST(TBDv1, Swift_2_0) {
+  static const char tbd_v1_swift_2_0[] = "---\n"
+                                         "archs: [ arm64 ]\n"
+                                         "platform: ios\n"
+                                         "install-name: Test.dylib\n"
+                                         "swift-version: 2.0\n"
+                                         "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_2_0, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(3U, File->getSwiftABIVersion());
+}
+
+TEST(TBDv1, Swift_3_0) {
+  static const char tbd_v1_swift_3_0[] = "---\n"
+                                         "archs: [ arm64 ]\n"
+                                         "platform: ios\n"
+                                         "install-name: Test.dylib\n"
+                                         "swift-version: 3.0\n"
+                                         "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_3_0, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(4U, File->getSwiftABIVersion());
+}
+
+TEST(TBDv1, Swift_4_0) {
+  static const char tbd_v1_swift_4_0[] = "---\n"
+                                         "archs: [ arm64 ]\n"
+                                         "platform: ios\n"
+                                         "install-name: Test.dylib\n"
+                                         "swift-version: 4.0\n"
+                                         "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_4_0, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_FALSE(!!Result);
+  auto errorMessage = toString(Result.takeError());
+  EXPECT_EQ("malformed file\nTest.tbd:5:16: error: invalid Swift ABI "
+            "version.\nswift-version: 4.0\n               ^~~\n",
+            errorMessage);
+}
+
+TEST(TBDv1, Swift_5) {
+  static const char tbd_v1_swift_5[] = "---\n"
+                                       "archs: [ arm64 ]\n"
+                                       "platform: ios\n"
+                                       "install-name: Test.dylib\n"
+                                       "swift-version: 5\n"
+                                       "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_5, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(5U, File->getSwiftABIVersion());
+}
+
+TEST(TBDv1, Swift_99) {
+  static const char tbd_v1_swift_99[] = "---\n"
+                                        "archs: [ arm64 ]\n"
+                                        "platform: ios\n"
+                                        "install-name: Test.dylib\n"
+                                        "swift-version: 99\n"
+                                        "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(tbd_v1_swift_99, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+  auto File = std::move(Result.get());
+  EXPECT_EQ(FileType::TBD_V1, File->getFileType());
+  EXPECT_EQ(99U, File->getSwiftABIVersion());
+}
+
+TEST(TBDv1, UnknownArchitecture) {
+  static const char tbd_v1_file_unknown_architecture[] =
+      "---\n"
+      "archs: [ foo ]\n"
+      "platform: macosx\n"
+      "install-name: Test.dylib\n"
+      "...\n";
+
+  auto Buffer =
+      MemoryBuffer::getMemBuffer(tbd_v1_file_unknown_architecture, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_TRUE(!!Result);
+}
+
+TEST(TBDv1, UnknownPlatform) {
+  static const char tbd_v1_file_unknown_platform[] = "---\n"
+                                                     "archs: [ i386 ]\n"
+                                                     "platform: newOS\n"
+                                                     "...\n";
+
+  auto Buffer =
+      MemoryBuffer::getMemBuffer(tbd_v1_file_unknown_platform, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_FALSE(!!Result);
+  auto errorMessage = toString(Result.takeError());
+  EXPECT_EQ("malformed file\nTest.tbd:3:11: error: unknown platform\nplatform: "
+            "newOS\n          ^~~~~\n",
+            errorMessage);
+}
+
+TEST(TBDv1, MalformedFile1) {
+  static const char malformed_file1[] = "---\n"
+                                        "archs: [ arm64 ]\n"
+                                        "foobar: \"Unsupported key\"\n"
+                                        "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(malformed_file1, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_FALSE(!!Result);
+  auto errorMessage = toString(Result.takeError());
+  ASSERT_EQ("malformed file\nTest.tbd:2:1: error: missing required key "
+            "'platform'\narchs: [ arm64 ]\n^\n",
+            errorMessage);
+}
+
+TEST(TBDv1, MalformedFile2) {
+  static const char malformed_file2[] = "---\n"
+                                        "archs: [ arm64 ]\n"
+                                        "platform: ios\n"
+                                        "install-name: Test.dylib\n"
+                                        "foobar: \"Unsupported key\"\n"
+                                        "...\n";
+
+  auto Buffer = MemoryBuffer::getMemBuffer(malformed_file2, "Test.tbd");
+  auto Result = TextAPIReader::get(std::move(Buffer));
+  EXPECT_FALSE(!!Result);
+  auto errorMessage = toString(Result.takeError());
+  ASSERT_EQ(
+      "malformed file\nTest.tbd:5:9: error: unknown key 'foobar'\nfoobar: "
+      "\"Unsupported key\"\n        ^~~~~~~~~~~~~~~~~\n",
+      errorMessage);
+}
+
+} // end namespace TBDv1.