Reland "[llvm] llvm-tapi-diff"

This is relanding commit d1d36f7 .
This patch additionally addresses failures found in buildbots due to unstable build ordering & post review comments.

This patch introduces a new tool, llvm-tapi-diff, that compares and returns the diff of two TBD files.

Reviewed By: ributzka, JDevlieghere

Differential Revision: https://reviews.llvm.org/D101835

Author: mcl0vinit

llvm/include/llvm/Object/TapiUniversal.h

@@ -101,6 +101,8 @@ class TapiUniversal : public Binary {
     return make_range(begin_objects(), end_objects());
   }
 
+  const MachO::InterfaceFile &getInterfaceFile() { return *ParsedFile; }
+
   uint32_t getNumberOfObjects() const { return Libraries.size(); }
 
   static bool classof(const Binary *v) { return v->isTapiUniversal(); }

llvm/include/llvm/TextAPI/Platform.h

@@ -40,6 +40,8 @@ PlatformKind mapToPlatformKind(const Triple &Target);
 PlatformSet mapToPlatformSet(ArrayRef<Triple> Targets);
 StringRef getPlatformName(PlatformKind Platform);
 PlatformKind getPlatformFromName(StringRef Name);
+std::string getOSAndEnvironmentName(PlatformKind Platform,
+                                    std::string Version = "");
 
 } // end namespace MachO.
 } // end namespace llvm.

llvm/include/llvm/TextAPI/Symbol.h

@@ -105,12 +105,17 @@ class Symbol {
 #endif
 
   bool operator==(const Symbol &O) const {
-    return (Kind == O.Kind) && (Name == O.Name) && (Targets == O.Targets) &&
-           (Flags == O.Flags);
+    return std::tie(Name, Kind, Targets, Flags) ==
+           std::tie(O.Name, O.Kind, O.Targets, O.Flags);
   }
 
   bool operator!=(const Symbol &O) const { return !(*this == O); }
 
+  bool operator<(const Symbol &O) const {
+    return std::tie(Name, Kind, Targets, Flags) <
+           std::tie(O.Name, O.Kind, O.Targets, O.Flags);
+  }
+
 private:
   StringRef Name;
   TargetList Targets;

llvm/include/llvm/TextAPI/Target.h

@@ -60,6 +60,8 @@ inline bool operator!=(const Target &LHS, const Architecture &RHS) {
 PlatformSet mapToPlatformSet(ArrayRef<Target> Targets);
 ArchitectureSet mapToArchitectureSet(ArrayRef<Target> Targets);
 
+std::string getTargetTripleName(const Target &Targ);
+
 raw_ostream &operator<<(raw_ostream &OS, const Target &Target);
 
 } // namespace MachO

llvm/lib/TextAPI/Platform.cpp

@@ -105,5 +105,34 @@ PlatformKind getPlatformFromName(StringRef Name) {
       .Default(PlatformKind::unknown);
 }
 
+std::string getOSAndEnvironmentName(PlatformKind Platform,
+                                    std::string Version) {
+  switch (Platform) {
+  case PlatformKind::unknown:
+    return "darwin" + Version;
+  case PlatformKind::macOS:
+    return "macos" + Version;
+  case PlatformKind::iOS:
+    return "ios" + Version;
+  case PlatformKind::tvOS:
+    return "tvos" + Version;
+  case PlatformKind::watchOS:
+    return "watchos" + Version;
+  case PlatformKind::bridgeOS:
+    return "bridgeos" + Version;
+  case PlatformKind::macCatalyst:
+    return "ios" + Version + "-macabi";
+  case PlatformKind::iOSSimulator:
+    return "ios" + Version + "-simulator";
+  case PlatformKind::tvOSSimulator:
+    return "tvos" + Version + "-simulator";
+  case PlatformKind::watchOSSimulator:
+    return "watchos" + Version + "-simulator";
+  case PlatformKind::driverKit:
+    return "driverkit" + Version;
+  }
+  llvm_unreachable("Unknown llvm::MachO::PlatformKind enum");
+}
+
 } // end namespace MachO.
 } // end namespace llvm.

llvm/lib/TextAPI/Target.cpp

@@ -72,5 +72,11 @@ ArchitectureSet mapToArchitectureSet(ArrayRef<Target> Targets) {
   return Result;
 }
 
+std::string getTargetTripleName(const Target &Targ) {
+  return (getArchitectureName(Targ.Arch) + "-apple-" +
+          getOSAndEnvironmentName(Targ.Platform))
+      .str();
+}
+
 } // end namespace MachO.
 } // end namespace llvm.

llvm/test/CMakeLists.txt

@@ -116,6 +116,7 @@ set(LLVM_TEST_DEPENDS
           llvm-strip
           llvm-symbolizer
           llvm-tblgen
+          llvm-tapi-diff
           llvm-undname
           llvm-windres
           llvm-xray

llvm/test/lit.cfg.py

@@ -164,7 +164,7 @@ def get_asan_rtlib():
     'llvm-modextract', 'llvm-nm', 'llvm-objcopy', 'llvm-objdump', 'llvm-otool',
     'llvm-pdbutil', 'llvm-profdata', 'llvm-profgen', 'llvm-ranlib', 'llvm-rc', 'llvm-readelf',
     'llvm-readobj', 'llvm-rtdyld', 'llvm-size', 'llvm-split', 'llvm-strings',
-    'llvm-strip', 'llvm-tblgen', 'llvm-undname', 'llvm-windres',
+    'llvm-strip', 'llvm-tblgen', 'llvm-tapi-diff', 'llvm-undname', 'llvm-windres',
     'llvm-c-test', 'llvm-cxxfilt',
     'llvm-xray', 'yaml2obj', 'obj2yaml', 'yaml-bench', 'verify-uselistorder',
     'bugpoint', 'llc', 'llvm-symbolizer', 'opt', 'sancov', 'sanstats'])

llvm/test/tools/llvm-tapi-diff/Inputs/macho.yaml

@@ -0,0 +1,141 @@
+--- !mach-o
+FileHeader:
+  magic:           0xFEEDFACF
+  cputype:         0x1000007
+  cpusubtype:      0x3
+  filetype:        0x6
+  ncmds:           13
+  sizeofcmds:      584
+  flags:           0x100085
+  reserved:        0x0
+LoadCommands:
+  - cmd:             LC_SEGMENT_64
+    cmdsize:         152
+    segname:         __TEXT
+    vmaddr:          0
+    vmsize:          4096
+    fileoff:         0
+    filesize:        4096
+    maxprot:         7
+    initprot:        5
+    nsects:          1
+    flags:           0
+    Sections:
+      - sectname:        __text
+        segname:         __TEXT
+        addr:            0x1000
+        size:            0
+        offset:          0x1000
+        align:           0
+        reloff:          0x0
+        nreloc:          0
+        flags:           0x80000400
+        reserved1:       0x0
+        reserved2:       0x0
+        reserved3:       0x0
+        content:         ''
+  - cmd:             LC_SEGMENT_64
+    cmdsize:         72
+    segname:         __LINKEDIT
+    vmaddr:          4096
+    vmsize:          4096
+    fileoff:         4096
+    filesize:        112
+    maxprot:         7
+    initprot:        1
+    nsects:          0
+    flags:           0
+  - cmd:             LC_ID_DYLIB
+    cmdsize:         48
+    dylib:
+      name:            24
+      timestamp:       1
+      current_version: 65536
+      compatibility_version: 65536
+    PayloadString:   macho-no-exports.dylib
+    ZeroPadBytes:    2
+  - cmd:             LC_DYLD_INFO_ONLY
+    cmdsize:         48
+    rebase_off:      0
+    rebase_size:     0
+    bind_off:        0
+    bind_size:       0
+    weak_bind_off:   0
+    weak_bind_size:  0
+    lazy_bind_off:   0
+    lazy_bind_size:  0
+    export_off:      0
+    export_size:     0
+  - cmd:             LC_SYMTAB
+    cmdsize:         24
+    symoff:          4168
+    nsyms:           1
+    stroff:          4184
+    strsize:         24
+  - cmd:             LC_DYSYMTAB
+    cmdsize:         80
+    ilocalsym:       0
+    nlocalsym:       0
+    iextdefsym:      0
+    nextdefsym:      0
+    iundefsym:       0
+    nundefsym:       1
+    tocoff:          0
+    ntoc:            0
+    modtaboff:       0
+    nmodtab:         0
+    extrefsymoff:    0
+    nextrefsyms:     0
+    indirectsymoff:  0
+    nindirectsyms:   0
+    extreloff:       0
+    nextrel:         0
+    locreloff:       0
+    nlocrel:         0
+  - cmd:             LC_UUID
+    cmdsize:         24
+    uuid:            A24CBA21-865D-372D-B267-4964F4ADCDFC
+  - cmd:             LC_VERSION_MIN_MACOSX
+    cmdsize:         16
+    version:         657920
+    sdk:             657920
+  - cmd:             LC_SOURCE_VERSION
+    cmdsize:         16
+    version:         0
+  - cmd:             LC_LOAD_DYLIB
+    cmdsize:         56
+    dylib:
+      name:            24
+      timestamp:       2
+      current_version: 79495168
+      compatibility_version: 65536
+    PayloadString:   '/usr/lib/libSystem.B.dylib'
+    ZeroPadBytes:    6
+  - cmd:             LC_FUNCTION_STARTS
+    cmdsize:         16
+    dataoff:         4096
+    datasize:        8
+  - cmd:             LC_DATA_IN_CODE
+    cmdsize:         16
+    dataoff:         4104
+    datasize:        0
+  - cmd:             LC_DYLIB_CODE_SIGN_DRS
+    cmdsize:         16
+    dataoff:         4104
+    datasize:        64
+LinkEditData:
+  NameList:
+    - n_strx:          2
+      n_type:          0x1
+      n_sect:          0
+      n_desc:          256
+      n_value:         0
+  StringTable:
+    - ' '
+    - dyld_stub_binder
+    - ''
+    - ''
+    - ''
+    - ''
+    - ''
+...

llvm/test/tools/llvm-tapi-diff/Inputs/v4A.tbd

@@ -0,0 +1,49 @@
+--- !tapi-tbd
+tbd-version: 4
+targets:  [ i386-macos, x86_64-macos, x86_64-ios ]
+uuids:
+  - target: i386-macos
+    value: 00000000-0000-0000-0000-000000000000
+  - target: x86_64-macos
+    value: 11111111-1111-1111-1111-111111111111
+  - target: x86_64-ios
+    value: 11111111-1111-1111-1111-111111111111
+flags: [ flat_namespace, installapi ]
+install-name: Umbrella.framework/Umbrella
+current-version: 1.2.3
+compatibility-version: 1.2
+swift-abi-version: 5
+parent-umbrella:
+  - targets: [ i386-macos, x86_64-macos, x86_64-ios ]
+    umbrella: System
+allowable-clients:
+  - targets: [ i386-macos, x86_64-macos, x86_64-ios ]
+    clients: [ ClientA ]
+exports:
+  - targets: [ i386-macos ]
+    symbols: [ _symA ]
+    objc-classes: []
+    objc-eh-types: []
+    objc-ivars: []
+    weak-symbols: []
+    thread-local-symbols: []
+  - targets: [ x86_64-ios ]
+    symbols: [_symB]
+  - targets: [ x86_64-macos, x86_64-ios ]
+    symbols: [_symAB]
+reexports:
+  - targets: [ i386-macos ]
+    symbols: [_symC]
+    objc-classes: []
+    objc-eh-types: []
+    objc-ivars: []
+    weak-symbols: []
+    thread-local-symbols: []
+undefineds:
+  - targets: [ i386-macos ]
+    symbols: [ _symD ]
+    objc-classes: []
+    objc-eh-types: []
+    objc-ivars: []
+    weak-symbols: []
+    thread-local-symbols: []