From 6ec27202c16a81594bbce375c1d1936dec4a702e Mon Sep 17 00:00:00 2001 From: Juergen Ributzka Date: Mon, 12 Aug 2019 23:01:07 +0000 Subject: [PATCH] [TextAPI] Fix & Add tests for tbd files version 3. - There was a simple typo in TextStub code that prevented version 3 files to be read. - Included a version 3 unit test to handle the differences in the format. - Also a typo in Error.h inside the comments. https://reviews.llvm.org/D66041 This patch is from Cyndy Ishida . llvm-svn: 368630 --- include/llvm/Support/Error.h | 2 +- lib/TextAPI/MachO/TextStub.cpp | 8 +- unittests/TextAPI/CMakeLists.txt | 3 +- unittests/TextAPI/TextStubV3Tests.cpp | 436 ++++++++++++++++++++++++++ 4 files changed, 443 insertions(+), 6 deletions(-) create mode 100644 unittests/TextAPI/TextStubV3Tests.cpp diff --git a/include/llvm/Support/Error.h b/include/llvm/Support/Error.h index 9a63e06a320..424906c5d19 100644 --- a/include/llvm/Support/Error.h +++ b/include/llvm/Support/Error.h @@ -548,7 +548,7 @@ public: /// Take ownership of the stored error. /// After calling this the Expected is in an indeterminate state that can /// only be safely destructed. No further calls (beside the destructor) should - /// be made on the Expected vaule. + /// be made on the Expected value. Error takeError() { #if LLVM_ENABLE_ABI_BREAKING_CHECKS Unchecked = false; diff --git a/lib/TextAPI/MachO/TextStub.cpp b/lib/TextAPI/MachO/TextStub.cpp index 799ebdc883a..d333024e698 100644 --- a/lib/TextAPI/MachO/TextStub.cpp +++ b/lib/TextAPI/MachO/TextStub.cpp @@ -534,9 +534,9 @@ template <> struct MappingTraits { // prope file type when reading. if (!IO.outputting()) { - if (IO.mapTag("!tapi-tbd-v2", false)) - Ctx->FileKind = FileType::TBD_V2; - else if (IO.mapTag("!tapi-tbd-v3", false)) + if (IO.mapTag("!tapi-tbd-v3", false)) + Ctx->FileKind = FileType::TBD_V3; + else if (IO.mapTag("!tapi-tbd-v2", false)) Ctx->FileKind = FileType::TBD_V2; else if (IO.mapTag("!tapi-tbd-v1", false) || IO.mapTag("tag:yaml.org,2002:map", false)) @@ -547,7 +547,7 @@ template <> struct MappingTraits { } } - // Set file tyoe when writing. + // Set file type when writing. if (IO.outputting()) { switch (Ctx->FileKind) { default: diff --git a/unittests/TextAPI/CMakeLists.txt b/unittests/TextAPI/CMakeLists.txt index 924b7a2e5f3..7f49df43ac3 100644 --- a/unittests/TextAPI/CMakeLists.txt +++ b/unittests/TextAPI/CMakeLists.txt @@ -6,6 +6,7 @@ add_llvm_unittest(TextAPITests ELFYAMLTest.cpp TextStubV1Tests.cpp TextStubV2Tests.cpp + TextStubV3Tests.cpp ) -target_link_libraries(TextAPITests PRIVATE LLVMTestingSupport) \ No newline at end of file +target_link_libraries(TextAPITests PRIVATE LLVMTestingSupport) diff --git a/unittests/TextAPI/TextStubV3Tests.cpp b/unittests/TextAPI/TextStubV3Tests.cpp new file mode 100644 index 00000000000..9504ec4e434 --- /dev/null +++ b/unittests/TextAPI/TextStubV3Tests.cpp @@ -0,0 +1,436 @@ +//===-- TextStubV3Tests.cpp - TBD V3 File Test ----------------------------===// +// +// 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 +// +//===-----------------------------------------------------------------------===/ + +#include "llvm/TextAPI/MachO/InterfaceFile.h" +#include "llvm/TextAPI/MachO/TextAPIReader.h" +#include "llvm/TextAPI/MachO/TextAPIWriter.h" +#include "gtest/gtest.h" +#include +#include + +using namespace llvm; +using namespace llvm::MachO; + +struct ExportedSymbol { + SymbolKind Kind; + std::string Name; + bool WeakDefined; + bool ThreadLocalValue; +}; +using ExportedSymbolSeq = std::vector; +using UUIDs = std::vector>; + +inline bool operator<(const ExportedSymbol &lhs, const ExportedSymbol &rhs) { + return std::tie(lhs.Kind, lhs.Name) < std::tie(rhs.Kind, rhs.Name); +} + +inline bool operator==(const ExportedSymbol &lhs, const ExportedSymbol &rhs) { + return std::tie(lhs.Kind, lhs.Name, lhs.WeakDefined, lhs.ThreadLocalValue) == + std::tie(rhs.Kind, rhs.Name, rhs.WeakDefined, rhs.ThreadLocalValue); +} + +static ExportedSymbol TBDv3Symbols[] = { + {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, "_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::ObjectiveCClassEHType, "class1", false, false}, + {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar1", false, false}, + {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar2", false, false}, + {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar3", false, false}, +}; + +namespace TBDv3 { + +TEST(TBDv3, ReadFile) { + static const char tbd_v3_file1[] = + "--- !tapi-tbd-v3\n" + "archs: [ armv7, arm64 ]\n" + "uuids: [ 'armv7: 00000000-0000-0000-0000-000000000000',\n" + " 'arm64: 11111111-1111-1111-1111-111111111111']\n" + "platform: ios\n" + "flags: [ installapi ]\n" + "install-name: Test.dylib\n" + "current-version: 2.3.4\n" + "compatibility-version: 1.0\n" + "swift-abi-version: 1.1\n" + "parent-umbrella: Umbrella.dylib\n" + "exports:\n" + " - archs: [ armv7, arm64 ]\n" + " allowable-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-eh-types: [ class1 ]\n" + " objc-ivars: [ class1._ivar1, class1._ivar2 ]\n" + " weak-def-symbols: [ _weak1, _weak2 ]\n" + " thread-local-symbols: [ _tlv1, _tlv3 ]\n" + " - archs: [ armv7 ]\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_v3_file1, "Test.tbd"); + auto Result = TextAPIReader::get(std::move(Buffer)); + EXPECT_TRUE(!!Result); + auto File = std::move(Result.get()); + EXPECT_EQ(FileType::TBD_V3, File->getFileType()); + auto Archs = AK_armv7 | AK_arm64; + EXPECT_EQ(Archs, File->getArchitectures()); + UUIDs uuids = {{AK_armv7, "00000000-0000-0000-0000-000000000000"}, + {AK_arm64, "11111111-1111-1111-1111-111111111111"}}; + EXPECT_EQ(uuids, File->uuids()); + EXPECT_EQ(PlatformKind::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::Retain_Release, File->getObjCConstraint()); + EXPECT_TRUE(File->isTwoLevelNamespace()); + EXPECT_TRUE(File->isApplicationExtensionSafe()); + EXPECT_TRUE(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(ExportedSymbol{Sym->getKind(), Sym->getName(), + Sym->isWeakDefined(), + Sym->isThreadLocalValue()}); + } + llvm::sort(Exports.begin(), Exports.end()); + + EXPECT_EQ(sizeof(TBDv3Symbols) / sizeof(ExportedSymbol), Exports.size()); + EXPECT_TRUE( + std::equal(Exports.begin(), Exports.end(), std::begin(TBDv3Symbols))); +} + +TEST(TBDv3, WriteFile) { + static const char tbd_v3_file3[] = + "--- !tapi-tbd-v3\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-abi-version: 5\n" + "exports:\n" + " - archs: [ i386 ]\n" + " symbols: [ _sym1 ]\n" + " weak-def-symbols: [ _sym2 ]\n" + " thread-local-symbols: [ _sym3 ]\n" + " - archs: [ x86_64 ]\n" + " allowable-clients: [ clientA ]\n" + " re-exports: [ '/usr/lib/libfoo.dylib' ]\n" + " objc-classes: [ Class1 ]\n" + " objc-eh-types: [ Class1 ]\n" + " objc-ivars: [ Class1._ivar1 ]\n" + "...\n"; + + InterfaceFile File; + File.setPath("libfoo.dylib"); + File.setInstallName("/usr/lib/libfoo.dylib"); + File.setFileType(FileType::TBD_V3); + File.setArchitectures(AK_i386 | AK_x86_64); + File.setPlatform(PlatformKind::macOS); + File.setCurrentVersion(PackedVersion(1, 2, 3)); + File.setTwoLevelNamespace(); + File.setApplicationExtensionSafe(); + File.setSwiftABIVersion(5); + File.setObjCConstraint(ObjCConstraintType::Retain_Release); + File.addAllowableClient("clientA", AK_x86_64); + File.addReexportedLibrary("/usr/lib/libfoo.dylib", AK_x86_64); + File.addSymbol(SymbolKind::GlobalSymbol, "_sym1", AK_i386); + File.addSymbol(SymbolKind::GlobalSymbol, "_sym2", AK_i386, + SymbolFlags::WeakDefined); + File.addSymbol(SymbolKind::GlobalSymbol, "_sym3", AK_i386, + SymbolFlags::ThreadLocalValue); + File.addSymbol(SymbolKind::ObjectiveCClass, "Class1", AK_x86_64); + File.addSymbol(SymbolKind::ObjectiveCClassEHType, "Class1", AK_x86_64); + File.addSymbol(SymbolKind::ObjectiveCInstanceVariable, "Class1._ivar1", + AK_x86_64); + + SmallString<4096> Buffer; + raw_svector_ostream OS(Buffer); + auto Result = TextAPIWriter::writeToStream(OS, File); + EXPECT_FALSE(Result); + EXPECT_STREQ(tbd_v3_file3, Buffer.c_str()); +} + +TEST(TBDv3, Platform_macOS) { + static const char tbd_v1_platform_macos[] = "--- !tapi-tbd-v3\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_V3, File->getFileType()); + EXPECT_EQ(PlatformKind::macOS, File->getPlatform()); +} + +TEST(TBDv3, Platform_iOS) { + static const char tbd_v1_platform_ios[] = "--- !tapi-tbd-v3\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_V3, File->getFileType()); + EXPECT_EQ(PlatformKind::iOS, File->getPlatform()); +} + +TEST(TBDv3, Platform_watchOS) { + static const char tbd_v1_platform_watchos[] = "--- !tapi-tbd-v3\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_V3, File->getFileType()); + EXPECT_EQ(PlatformKind::watchOS, File->getPlatform()); +} + +TEST(TBDv3, Platform_tvOS) { + static const char tbd_v1_platform_tvos[] = "--- !tapi-tbd-v3\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_V3, File->getFileType()); + EXPECT_EQ(PlatformKind::tvOS, File->getPlatform()); +} + +TEST(TBDv3, Platform_bridgeOS) { + static const char tbd_v1_platform_bridgeos[] = "--- !tapi-tbd-v3\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_V3, File->getFileType()); + EXPECT_EQ(PlatformKind::bridgeOS, File->getPlatform()); +} + +TEST(TBDv3, Swift_1_0) { + static const char tbd_v1_swift_1_0[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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_V3, File->getFileType()); + EXPECT_EQ(1U, File->getSwiftABIVersion()); +} + +TEST(TBDv3, Swift_1_1) { + static const char tbd_v1_swift_1_1[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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_V3, File->getFileType()); + EXPECT_EQ(2U, File->getSwiftABIVersion()); +} + +TEST(TBDv3, Swift_2_0) { + static const char tbd_v1_swift_2_0[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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_V3, File->getFileType()); + EXPECT_EQ(3U, File->getSwiftABIVersion()); +} + +TEST(TBDv3, Swift_3_0) { + static const char tbd_v1_swift_3_0[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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_V3, File->getFileType()); + EXPECT_EQ(4U, File->getSwiftABIVersion()); +} + +TEST(TBDv3, Swift_4_0) { + static const char tbd_v1_swift_4_0[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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:20: error: invalid Swift ABI " + "version.\nswift-abi-version: 4.0\n ^~~\n", + errorMessage); +} + +TEST(TBDv3, Swift_5) { + static const char tbd_v1_swift_5[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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_V3, File->getFileType()); + EXPECT_EQ(5U, File->getSwiftABIVersion()); +} + +TEST(TBDv3, Swift_99) { + static const char tbd_v1_swift_99[] = "--- !tapi-tbd-v3\n" + "archs: [ arm64 ]\n" + "platform: ios\n" + "install-name: Test.dylib\n" + "swift-abi-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_V3, File->getFileType()); + EXPECT_EQ(99U, File->getSwiftABIVersion()); +} + +TEST(TBDv3, UnknownArchitecture) { + static const char tbd_v3_file_unknown_architecture[] = + "--- !tapi-tbd-v3\n" + "archs: [ foo ]\n" + "platform: macosx\n" + "install-name: Test.dylib\n" + "...\n"; + + auto Buffer = + MemoryBuffer::getMemBuffer(tbd_v3_file_unknown_architecture, "Test.tbd"); + auto Result = TextAPIReader::get(std::move(Buffer)); + EXPECT_TRUE(!!Result); +} + +TEST(TBDv3, UnknownPlatform) { + static const char tbd_v3_file_unknown_platform[] = "--- !tapi-tbd-v3\n" + "archs: [ i386 ]\n" + "platform: newOS\n" + "...\n"; + + auto Buffer = + MemoryBuffer::getMemBuffer(tbd_v3_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(TBDv3, MalformedFile1) { + static const char malformed_file1[] = "--- !tapi-tbd-v3\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(TBDv3, MalformedFile2) { + static const char malformed_file2[] = "--- !tapi-tbd-v3\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); +} + +} // namespace TBDv3