Skip to content

[readtapi] Add Merge functionality #72656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions llvm/include/llvm/TextAPI/TextAPIWriter.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#ifndef LLVM_TEXTAPI_TEXTAPIWRITER_H
#define LLVM_TEXTAPI_TEXTAPIWRITER_H

#include "llvm/ADT/StringSwitch.h"
#include "llvm/TextAPI/InterfaceFile.h"

namespace llvm {
Expand All @@ -32,6 +33,19 @@ class TextAPIWriter {
static Error writeToStream(raw_ostream &OS, const InterfaceFile &File,
const FileType FileKind = FileType::Invalid,
bool Compact = false);

/// Get TAPI FileType from the input string.
///
/// \param FT String of input to map to FileType.
static FileType parseFileType(const StringRef FT) {
return StringSwitch<FileType>(FT)
.Case("tbd-v1", FileType::TBD_V1)
.Case("tbd-v2", FileType::TBD_V2)
.Case("tbd-v3", FileType::TBD_V3)
.Case("tbd-v4", FileType::TBD_V4)
.Case("tbd-v5", FileType::TBD_V5)
.Default(FileType::Invalid);
}
};

} // end namespace MachO.
Expand Down
6 changes: 6 additions & 0 deletions llvm/test/tools/llvm-readtapi/command-line.test
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
; RUN: llvm-readtapi --help 2>&1 | FileCheck %s
; RUN: llvm-readtapi -help 2>&1 | FileCheck %s
; RUN: not llvm-readtapi -merge -compare -compact %t/tmp.tbd %t/tmp2.tbd 2>&1 | FileCheck %s --check-prefix MULTI_ACTION
; RUN: not llvm-readtapi -merge -compact %t/tmp.tbd %t/tmp2.tbd --filetype=tbd-v2 2>&1 | FileCheck %s --check-prefix FILE_FORMAT

CHECK: OVERVIEW: LLVM TAPI file reader and manipulator
CHECK: USAGE: llvm-readtapi [options] <inputs>
CHECK: OPTIONS:
CHECK: -help display this help

MULTI_ACTION: error: only one of the following actions can be specified: -merge -compare
FILE_FORMAT: error: deprecated filetype 'tbd-v2' is not supported to write

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
; RUN: yaml2obj %S/Inputs/macho.yaml -o %t/macho.dylib
; RUN: not llvm-readtapi --compare %S/Inputs/v4A.tbd %t/macho.dylib 2>&1 | FileCheck %s

; CHECK: error: {{.*}}macho.dylib' unsupported file format
; CHECK: error: {{.*}}macho.dylib' unsupported file type
; CHECK-NOT: error:
; CHECK-NOT: warning:
52 changes: 52 additions & 0 deletions llvm/test/tools/llvm-readtapi/merge-invalid.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
; RUN: rm -rf %t
; RUN: split-file %s %t
; RUN: not llvm-readtapi -merge %t/libfoo.tbd %t/libbar.tbd 2>&1 | FileCheck %s --allow-empty --check-prefix DIFF
; RUN: not llvm-readtapi -merge %t/libfoo.tbd 2>&1 | FileCheck %s --allow-empty --check-prefix INPUT

; DIFF: install names do not match
; INPUT: merge requires at least two input files

;--- libfoo.tbd
{
"main_library": {
"allowable_clients": [
{
"clients": [
"ClientAll"
]
}
],
"install_names": [
{
"name": "/usr/lib/libfoo.dylib"
}
],
"target_info": [
{
"min_deployment": "13.1",
"target": "x86_64-macos"
}
]
},
"tapi_tbd_version": 5
}

;--- libbar.tbd
--- !tapi-tbd
tbd-version: 4
targets: [ arm64-macos ]
install-name: '/usr/lib/libbar.dylib'
allowable-clients:
- targets: [ arm64-macos ]
clients: [ ClientAll ]
reexported-libraries:
- targets: [ arm64-macos ]
libraries: [ '/usr/lib/liball.dylib' ]
exports:
- targets: [ arm64-macos ]
symbols: [ _sym1 ]
objc-classes: [ _A ]
objc-ivars: [ _A._ivar1 ]
weak-symbols: [ _weak1 ]
thread-local-symbols: [ _tlv1 ]
...
139 changes: 139 additions & 0 deletions llvm/test/tools/llvm-readtapi/merge.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
; RUN: rm -rf %t
; RUN: split-file %s %t
; RUN: llvm-readtapi -merge %t/i386.tbd %t/x86_64.tbd %t/arm64.tbd --filetype tbd-v5 -o %t/out.tbd -compact 2>&1 | FileCheck %s --allow-empty
; RUN: llvm-readtapi -merge %t/i386.tbd %t/x86_64.tbd %t/arm64.tbd --filetype=tbd-v5 --o %t/out.tbd -compact 2>&1 | FileCheck %s --allow-empty
; RUN: llvm-readtapi -compare %t/out.tbd %t/expected.tbd 2>&1 | FileCheck %s --allow-empty

; CHECK-NOT: error
; CHECK-NOT: warning

;--- expected.tbd
{
"main_library": {
"allowable_clients": [{ "clients": ["ClientAll"] }],
"exported_symbols": [
{
"data": {
"global": ["_sym1"],
"objc_class": ["_A"],
"thread_local": ["_tlv1"],
"weak": ["_weak1"]
}
},
{
"data": {
"objc_ivar": ["_A._ivar1"]
},
"targets": [ "x86_64-macos", "arm64-macos" ]
}
],
"install_names": [
{ "name": "/usr/lib/libfat.dylib" }
],
"reexported_libraries": [
{
"names": [ "/usr/lib/liball.dylib" ]
}
],
"target_info": [
{ "target": "i386-macos" },
{
"min_deployment": "13.1",
"target": "x86_64-macos"
},
{
"target": "arm64-macos"
}
]
},
"tapi_tbd_version": 5
}


;--- i386.tbd
--- !tapi-tbd-v3
archs: [ i386 ]
platform: macosx
install-name: /usr/lib/libfat.dylib
exports:
- archs: [ i386 ]
allowable-clients: [ ClientAll ]
re-exports: [ /usr/lib/liball.dylib ]
symbols: [ _sym1 ]
objc-classes: [ _A ]
weak-def-symbols: [ _weak1 ]
thread-local-symbols: [ _tlv1 ]
...

;--- x86_64.tbd
{
"main_library": {
"allowable_clients": [
{
"clients": [
"ClientAll"
]
}
],
"exported_symbols": [
{
"data": {
"global": [
"_sym1"
],
"objc_class": [
"_A"
],
"objc_ivar": [
"_A._ivar1"
],
"thread_local": [
"_tlv1"
],
"weak": [
"_weak1"
]
}
}
],
"install_names": [
{
"name": "/usr/lib/libfat.dylib"
}
],
"reexported_libraries": [
{
"names": [
"/usr/lib/liball.dylib"
]
}
],
"target_info": [
{
"min_deployment": "13.1",
"target": "x86_64-macos"
}
]
},
"tapi_tbd_version": 5
}

;--- arm64.tbd
--- !tapi-tbd
tbd-version: 4
targets: [ arm64-macos ]
install-name: '/usr/lib/libfat.dylib'
allowable-clients:
- targets: [ arm64-macos ]
clients: [ ClientAll ]
reexported-libraries:
- targets: [ arm64-macos ]
libraries: [ '/usr/lib/liball.dylib' ]
exports:
- targets: [ arm64-macos ]
symbols: [ _sym1 ]
objc-classes: [ _A ]
objc-ivars: [ _A._ivar1 ]
weak-symbols: [ _weak1 ]
thread-local-symbols: [ _tlv1 ]
...
77 changes: 77 additions & 0 deletions llvm/test/tools/llvm-readtapi/write.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
; RUN: rm -rf %t
; RUN: split-file %s %t
; RUN: llvm-readtapi %t/arm64.tbd 2>&1 | FileCheck %s

; CHECK-NOT: error
; CHECK-NOT: warning
; CHECK: {
; CHECK-NEXT: "main_library": {
; CHECK-NEXT: "allowable_clients": [
; CHECK-NEXT: {
; CHECK-NEXT: "clients": [
; CHECK-NEXT: "ClientAll"
; CHECK-NEXT: ]
; CHECK-NEXT: }
; CHECK-NEXT: ],
; CHECK-NEXT: "exported_symbols": [
; CHECK-NEXT: {
; CHECK-NEXT: "data": {
; CHECK-NEXT: "global": [
; CHECK-NEXT: "_sym1"
; CHECK-NEXT: ],
; CHECK-NEXT: "objc_class": [
; CHECK-NEXT: "_A"
; CHECK-NEXT: ],
; CHECK-NEXT: "objc_ivar": [
; CHECK-NEXT: "_A._ivar1"
; CHECK-NEXT: ],
; CHECK-NEXT: "thread_local": [
; CHECK-NEXT: "_tlv1"
; CHECK-NEXT: ],
; CHECK-NEXT: "weak": [
; CHECK-NEXT: "_weak1"
; CHECK-NEXT: ]
; CHECK-NEXT: }
; CHECK-NEXT: }
; CHECK-NEXT: ],
; CHECK-NEXT: "install_names": [
; CHECK-NEXT: {
; CHECK-NEXT: "name": "/usr/lib/libfat.dylib"
; CHECK-NEXT: }
; CHECK-NEXT: ],
; CHECK-NEXT: "reexported_libraries": [
; CHECK-NEXT: {
; CHECK-NEXT: "names": [
; CHECK-NEXT: "/usr/lib/liball.dylib"
; CHECK-NEXT: ]
; CHECK-NEXT: }
; CHECK-NEXT: ],
; CHECK-NEXT: "target_info": [
; CHECK-NEXT: {
; CHECK-NEXT: "target": "arm64-macos"
; CHECK-NEXT: }
; CHECK-NEXT: ]
; CHECK-NEXT: },
; CHECK-NEXT: "tapi_tbd_version": 5
; CHECK-NEXT: }


;--- arm64.tbd
--- !tapi-tbd
tbd-version: 4
targets: [ arm64-macos ]
install-name: '/usr/lib/libfat.dylib'
allowable-clients:
- targets: [ arm64-macos ]
clients: [ ClientAll ]
reexported-libraries:
- targets: [ arm64-macos ]
libraries: [ '/usr/lib/liball.dylib' ]
exports:
- targets: [ arm64-macos ]
symbols: [ _sym1 ]
objc-classes: [ _A ]
objc-ivars: [ _A._ivar1 ]
weak-symbols: [ _weak1 ]
thread-local-symbols: [ _tlv1 ]
...
10 changes: 4 additions & 6 deletions llvm/tools/llvm-readtapi/DiffEngine.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -560,13 +560,11 @@ void DiffEngine::printDifferences(raw_ostream &OS,
}

bool DiffEngine::compareFiles(raw_ostream &OS) {
const auto *IFLHS = &(FileLHS->getInterfaceFile());
const auto *IFRHS = &(FileRHS->getInterfaceFile());
if (*IFLHS == *IFRHS)
if (*FileLHS == *FileRHS)
return false;
OS << "< " << std::string(IFLHS->getPath().data()) << "\n> "
<< std::string(IFRHS->getPath().data()) << "\n\n";
std::vector<DiffOutput> Diffs = findDifferences(IFLHS, IFRHS);
OS << "< " << std::string(FileLHS->getPath().data()) << "\n> "
<< std::string(FileRHS->getPath().data()) << "\n\n";
std::vector<DiffOutput> Diffs = findDifferences(FileLHS, FileRHS);
printDifferences(OS, Diffs, 0);
return true;
}
8 changes: 4 additions & 4 deletions llvm/tools/llvm-readtapi/DiffEngine.h
Original file line number Diff line number Diff line change
Expand Up @@ -141,14 +141,14 @@ class InlineDoc : public AttributeDiff {
/// output of the differences found in the files.
class DiffEngine {
public:
DiffEngine(object::TapiUniversal *InputFileNameLHS,
object::TapiUniversal *InputFileNameRHS)
DiffEngine(MachO::InterfaceFile *InputFileNameLHS,
MachO::InterfaceFile *InputFileNameRHS)
: FileLHS(InputFileNameLHS), FileRHS(InputFileNameRHS){};
bool compareFiles(raw_ostream &);

private:
object::TapiUniversal *FileLHS;
object::TapiUniversal *FileRHS;
MachO::InterfaceFile *FileLHS;
MachO::InterfaceFile *FileRHS;

/// Function that prints the differences found in the files.
void printDifferences(raw_ostream &, const std::vector<DiffOutput> &, int);
Expand Down
14 changes: 9 additions & 5 deletions llvm/tools/llvm-readtapi/TapiOpts.td
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@ multiclass JS<string name, string help, string var = ""> {
}

//
// General Driver options
// Top level operations
//
def help : FF<"help", "display this help">;
defm output: JS<"o", "write output to <file>","<file>">;
def action_group : OptionGroup<"action group">;
def compare : FF<"compare", "compare tapi files for library differences">, Group<action_group>;
def merge : FF<"merge", "merge the input files that represent the same library">, Group<action_group>;

//
// Compare options
// General Driver options
//
def compare : FF<"compare", "compare tapi files for library differences">;
def help : FF<"help", "display this help">;
defm output: JS<"o", "write output to <file>","<file>">;
def compact: FF<"compact", "write compact tapi output file">;
defm filetype: JS<"filetype", "specify the output file type (tbd-v3, tbd-v4 or tbd-v5)","<value>">;
Loading