[clang] [llvm] [InstallAPI] Support mutually exclusive parse options (PR #90686)
Cyndy Ishida via llvm-commits
llvm-commits at lists.llvm.org
Tue Apr 30 20:04:45 PDT 2024
https://github.com/cyndyishida updated https://github.com/llvm/llvm-project/pull/90686
>From c4fec5015555607059b1030b7c53794ad271194d Mon Sep 17 00:00:00 2001
From: Cyndy Ishida <cyndy_ishida at apple.com>
Date: Thu, 18 Apr 2024 07:28:44 -0700
Subject: [PATCH 1/2] [InstallAPI] Support mutually exclusive parse options
Projects like libc use mutually exclusive macros to compile files
multiple times then merge the result into the final library. For
installapi to accept these, we'd need to parse the same declarations in different
ways. This patch add the basic pipelining for installapi to create the
correct TBD file.
* -Xproject allows:
-fmodules, -fobjc-arc, fvisibility=hidden, prefix headers
* -Xlabel allows:
-D and -U settings
* Error on 'private' and 'public' labels -X<label>
* Xplatform allows:
-iframework <path> This is to support the case where zippered
frameworks want to pass in iOSSupport search path.
---
.../clang/Basic/DiagnosticInstallAPIKinds.td | 1 +
clang/include/clang/InstallAPI/MachO.h | 2 +
.../Modules/module.modulemap | 3 +
.../Inputs/LibFoo/usr/include/foo.h | 20 +
.../Inputs/LibFoo/usr/include/public.h | 14 +
.../Zippered.framework/Headers/Zippered.h | 20 +
.../PrivateHeaders/Zippered_Private.h | 9 +
.../InstallAPI/Inputs/Zippered/Zippered.tbd | 47 +++
.../InstallAPI/Inputs/Zippered/Zippered.yaml | 383 ++++++++++++++++++
clang/test/InstallAPI/exclusive-passes-2.test | 58 +++
.../InstallAPI/exclusive-passes-platform.test | 277 +++++++++++++
.../InstallAPI/exclusive-passes-zippered.test | 56 +++
clang/test/InstallAPI/exclusive-passes.test | 54 +++
.../InstallAPI/invalid-exclusive-passes.test | 37 ++
.../InstallAPI/project-header-only-args.test | 81 ++++
.../clang-installapi/ClangInstallAPI.cpp | 20 +-
.../tools/clang-installapi/InstallAPIOpts.td | 30 ++
clang/tools/clang-installapi/Options.cpp | 187 +++++++--
clang/tools/clang-installapi/Options.h | 13 +-
llvm/include/llvm/TextAPI/Utils.h | 9 +
llvm/lib/TextAPI/Utils.cpp | 10 +
21 files changed, 1301 insertions(+), 30 deletions(-)
create mode 100644 clang/test/InstallAPI/Inputs/Foundation/Foundation.framework/Modules/module.modulemap
create mode 100644 clang/test/InstallAPI/Inputs/LibFoo/usr/include/foo.h
create mode 100644 clang/test/InstallAPI/Inputs/LibFoo/usr/include/public.h
create mode 100644 clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/Headers/Zippered.h
create mode 100644 clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/PrivateHeaders/Zippered_Private.h
create mode 100644 clang/test/InstallAPI/Inputs/Zippered/Zippered.tbd
create mode 100644 clang/test/InstallAPI/Inputs/Zippered/Zippered.yaml
create mode 100644 clang/test/InstallAPI/exclusive-passes-2.test
create mode 100644 clang/test/InstallAPI/exclusive-passes-platform.test
create mode 100644 clang/test/InstallAPI/exclusive-passes-zippered.test
create mode 100644 clang/test/InstallAPI/exclusive-passes.test
create mode 100644 clang/test/InstallAPI/invalid-exclusive-passes.test
create mode 100644 clang/test/InstallAPI/project-header-only-args.test
diff --git a/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td b/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td
index 6896e0f5aa593c..674742431dcb2d 100644
--- a/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td
+++ b/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td
@@ -25,6 +25,7 @@ def err_unsupported_vendor : Error<"vendor '%0' is not supported: '%1'">;
def err_unsupported_environment : Error<"environment '%0' is not supported: '%1'">;
def err_unsupported_os : Error<"os '%0' is not supported: '%1'">;
def err_cannot_read_input_list : Error<"could not read %select{alias list|filelist}0 '%1': %2">;
+def err_invalid_label: Error<"label '%0' is reserved: use a different label name for -X<label>">;
} // end of command line category.
let CategoryName = "Verification" in {
diff --git a/clang/include/clang/InstallAPI/MachO.h b/clang/include/clang/InstallAPI/MachO.h
index 9da91a62e23311..1ea544412f4cd8 100644
--- a/clang/include/clang/InstallAPI/MachO.h
+++ b/clang/include/clang/InstallAPI/MachO.h
@@ -45,6 +45,8 @@ using SimpleSymbol = llvm::MachO::SimpleSymbol;
using FileType = llvm::MachO::FileType;
using PackedVersion = llvm::MachO::PackedVersion;
using PathSeq = llvm::MachO::PathSeq;
+using PlatformType = llvm::MachO::PlatformType;
+using PathToPlatformSeq = llvm::MachO::PathToPlatformSeq;
using Target = llvm::MachO::Target;
using TargetList = llvm::MachO::TargetList;
diff --git a/clang/test/InstallAPI/Inputs/Foundation/Foundation.framework/Modules/module.modulemap b/clang/test/InstallAPI/Inputs/Foundation/Foundation.framework/Modules/module.modulemap
new file mode 100644
index 00000000000000..2bb688da1fa4b0
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/Foundation/Foundation.framework/Modules/module.modulemap
@@ -0,0 +1,3 @@
+framework module Foundation [system] {
+ umbrella header "Foundation.h"
+}
diff --git a/clang/test/InstallAPI/Inputs/LibFoo/usr/include/foo.h b/clang/test/InstallAPI/Inputs/LibFoo/usr/include/foo.h
new file mode 100644
index 00000000000000..06ba35c177c88c
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/LibFoo/usr/include/foo.h
@@ -0,0 +1,20 @@
+#if defined(NONDarwin)
+ #define LINUX "$linux"
+ #define DARWIN
+#elif defined(Darwin)
+ #define LINUX
+ #define DARWIN "$darwin"
+#else
+ #define LINUX
+ #define DARWIN
+#endif
+
+#if defined(Foo)
+ #define FOO "FooLib$"
+#else
+ #define FOO
+#endif
+
+#define __STRING(x) #x
+#define PLATFORM_ALIAS(sym) __asm("_" FOO __STRING(sym) DARWIN LINUX)
+extern int foo() PLATFORM_ALIAS(foo);
diff --git a/clang/test/InstallAPI/Inputs/LibFoo/usr/include/public.h b/clang/test/InstallAPI/Inputs/LibFoo/usr/include/public.h
new file mode 100644
index 00000000000000..a7707d3709d366
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/LibFoo/usr/include/public.h
@@ -0,0 +1,14 @@
+#if defined(NONDarwin)
+#define LINUX "$linux"
+#define DARWIN
+#elif defined(Darwin)
+#define LINUX
+#define DARWIN "$darwin"
+#else
+#define LINUX
+#define DARWIN
+#endif
+
+#define __STRING(x) #x
+#define PLATFORM_ALIAS(sym) __asm("_" __STRING(sym) DARWIN LINUX)
+extern int foo() PLATFORM_ALIAS(foo);
diff --git a/clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/Headers/Zippered.h b/clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/Headers/Zippered.h
new file mode 100644
index 00000000000000..ec1b03318be158
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/Headers/Zippered.h
@@ -0,0 +1,20 @@
+#if !__is_target_environment(macabi)
+typedef int MyType;
+#else
+typedef float MyType;
+#endif
+
+extern MyType invalidAPI();
+
+#define OS_AVAILABLE(_target, _availability) \
+ __attribute__((availability(_target, _availability)))
+extern int macOSAPI() OS_AVAILABLE(macos, introduced=10.14) OS_AVAILABLE(ios, unavailable);
+extern int iOSAPI() OS_AVAILABLE(ios, introduced=12.0) OS_AVAILABLE(macos, unavailable);
+extern int commonAPI() OS_AVAILABLE(macos, introduced=10.14) OS_AVAILABLE(ios, introduced=12.0);
+
+extern int obsoletedMacOSAPI() OS_AVAILABLE(macos, obsoleted=10.14) OS_AVAILABLE(ios, unavailable);
+
+#if !__is_target_environment(macabi)
+extern int macOSAPI2() OS_AVAILABLE(macos, introduced = 10.14)
+ OS_AVAILABLE(ios, unavailable);
+#endif
diff --git a/clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/PrivateHeaders/Zippered_Private.h b/clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/PrivateHeaders/Zippered_Private.h
new file mode 100644
index 00000000000000..2182a17275cb2a
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/Zippered/Zippered.framework/PrivateHeaders/Zippered_Private.h
@@ -0,0 +1,9 @@
+#if __is_target_environment(macabi)
+extern int a;
+ at class UIImage;
+UIImage *image;
+#else
+extern long a;
+ at class NSImage;
+NSImage *image;
+#endif
diff --git a/clang/test/InstallAPI/Inputs/Zippered/Zippered.tbd b/clang/test/InstallAPI/Inputs/Zippered/Zippered.tbd
new file mode 100644
index 00000000000000..6ceb589ff0cda0
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/Zippered/Zippered.tbd
@@ -0,0 +1,47 @@
+{
+ "main_library": {
+ "exported_symbols": [
+ {
+ "data": {
+ "global": [
+ "_image", "_a"
+ ]
+ },
+ "text": {
+ "global": [
+ "_invalidAPI", "_commonAPI"
+ ]
+ }
+ },
+ {
+ "targets": [ "x86_64-maccatalyst" ],
+ "text": {
+ "global": [ "_iOSAPI"]
+ }
+ },
+ {
+ "targets": [ "x86_64-macos" ],
+ "text": {
+ "global": [ "_macOSAPI", "_macOSAPI2" ]
+ }
+ }
+ ],
+ "flags": [
+ {
+ "attributes": ["not_app_extension_safe"]
+ }
+ ],
+ "install_names": [
+ {"name": "/System/Library/Frameworks/Zippered.framework/Versions/A/Zippered"}
+ ],
+ "target_info": [
+ {
+ "min_deployment": "13", "target": "x86_64-macos"
+ },
+ {
+ "min_deployment": "16", "target": "x86_64-maccatalyst"
+ }
+ ]
+ },
+ "tapi_tbd_version": 5
+}
diff --git a/clang/test/InstallAPI/Inputs/Zippered/Zippered.yaml b/clang/test/InstallAPI/Inputs/Zippered/Zippered.yaml
new file mode 100644
index 00000000000000..284cd46416fdb6
--- /dev/null
+++ b/clang/test/InstallAPI/Inputs/Zippered/Zippered.yaml
@@ -0,0 +1,383 @@
+# Generated from:
+# xcrun -sdk macosx clang --target=x86_64-apple-macos13 --target-variant=x86_64-apple-ios16-macabi
+# -dynamiclib
+#
+#import "Zippered.h"
+#import "Zippered_Private.h"
+# MyType invalidAPI() { return 0; }
+# int macOSAPI() { return 0; }
+# int macOSAPI2() { return 0; }
+# int iOSAPI() { return 0; }
+# int commonAPI() { return 0; }
+# int obsoletedMacOSAPI() { return 0; }
+#
+# #if __is_target_environment(macabi)
+# int a = 0;
+# UIImage *image = 0;
+# #else
+# long a = 0;
+# NSImage *image = 0;
+# #endif
+
+--- !mach-o
+FileHeader:
+ magic: 0xFEEDFACF
+ cputype: 0x1000007
+ cpusubtype: 0x3
+ filetype: 0x6
+ ncmds: 15
+ sizeofcmds: 1584
+ flags: 0x100085
+ reserved: 0x0
+LoadCommands:
+ - cmd: LC_SEGMENT_64
+ cmdsize: 312
+ segname: __TEXT
+ vmaddr: 0
+ vmsize: 12288
+ fileoff: 0
+ filesize: 12288
+ maxprot: 5
+ initprot: 5
+ nsects: 3
+ flags: 0
+ Sections:
+ - sectname: __text
+ segname: __TEXT
+ addr: 0x1090
+ size: 88
+ offset: 0x1090
+ align: 4
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x80000400
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: 554889E531C05DC30F1F840000000000554889E531C05DC30F1F840000000000554889E531C05DC30F1F840000000000554889E531C05DC30F1F840000000000554889E531C05DC30F1F840000000000554889E531C05DC3
+ - sectname: __unwind_info
+ segname: __TEXT
+ addr: 0x10E8
+ size: 4152
+ offset: 0x10E8
+ align: 2
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x0
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: 010000001C000000010000002000000000000000200000000200000000000001901000003800000038000000E81000000000000038000000030000000C0001001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+ - sectname: __eh_frame
+ segname: __TEXT
+ addr: 0x2120
+ size: 24
+ offset: 0x2120
+ align: 3
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x6000000B
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: 1400000000000000017A520001781001100C070890010000
+ - cmd: LC_SEGMENT_64
+ cmdsize: 152
+ segname: __DATA_CONST
+ vmaddr: 12288
+ vmsize: 4096
+ fileoff: 12288
+ filesize: 4096
+ maxprot: 3
+ initprot: 3
+ nsects: 1
+ flags: 16
+ Sections:
+ - sectname: __objc_imageinfo
+ segname: __DATA_CONST
+ addr: 0x3000
+ size: 8
+ offset: 0x3000
+ align: 0
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x0
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: '0000000040000000'
+ - cmd: LC_SEGMENT_64
+ cmdsize: 152
+ segname: __DATA
+ vmaddr: 16384
+ vmsize: 4096
+ fileoff: 16384
+ filesize: 0
+ maxprot: 3
+ initprot: 3
+ nsects: 1
+ flags: 0
+ Sections:
+ - sectname: __common
+ segname: __DATA
+ addr: 0x4000
+ size: 16
+ offset: 0x0
+ align: 3
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x1
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ - cmd: LC_SEGMENT_64
+ cmdsize: 72
+ segname: __LINKEDIT
+ vmaddr: 20480
+ vmsize: 384
+ fileoff: 16384
+ filesize: 384
+ maxprot: 1
+ initprot: 1
+ nsects: 0
+ flags: 0
+ - 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: 16384
+ export_size: 128
+ - cmd: LC_SYMTAB
+ cmdsize: 24
+ symoff: 16520
+ nsyms: 9
+ stroff: 16664
+ strsize: 104
+ - cmd: LC_DYSYMTAB
+ cmdsize: 80
+ ilocalsym: 0
+ nlocalsym: 0
+ iextdefsym: 0
+ nextdefsym: 8
+ iundefsym: 8
+ 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_ID_DYLIB
+ cmdsize: 96
+ dylib:
+ name: 24
+ timestamp: 0
+ current_version: 65536
+ compatibility_version: 65536
+ Content: '/System/Library/Frameworks/Zippered.framework/Versions/A/Zippered'
+ ZeroPadBytes: 7
+ - cmd: LC_UUID
+ cmdsize: 24
+ uuid: 4C4C44B0-5555-3144-A126-166C8AB77CD1
+ - cmd: LC_BUILD_VERSION
+ cmdsize: 32
+ platform: 1
+ minos: 851968
+ sdk: 983040
+ ntools: 1
+ Tools:
+ - tool: 4
+ version: 1245184
+ - cmd: LC_BUILD_VERSION
+ cmdsize: 32
+ platform: 6
+ minos: 1048576
+ sdk: 1048576
+ ntools: 1
+ Tools:
+ - tool: 4
+ version: 1245184
+ - cmd: LC_LOAD_DYLIB
+ cmdsize: 56
+ dylib:
+ name: 24
+ timestamp: 0
+ current_version: 14942208
+ compatibility_version: 65536
+ Content: '/usr/lib/libobjc.A.dylib'
+ ZeroPadBytes: 8
+ - cmd: LC_LOAD_DYLIB
+ cmdsize: 56
+ dylib:
+ name: 24
+ timestamp: 0
+ current_version: 88539136
+ compatibility_version: 65536
+ Content: '/usr/lib/libSystem.B.dylib'
+ ZeroPadBytes: 6
+ - cmd: LC_FUNCTION_STARTS
+ cmdsize: 16
+ dataoff: 16512
+ datasize: 8
+ - cmd: LC_DATA_IN_CODE
+ cmdsize: 16
+ dataoff: 16520
+ datasize: 0
+LinkEditData:
+ ExportTrie:
+ TerminalSize: 0
+ NodeOffset: 0
+ Name: ''
+ Flags: 0x0
+ Address: 0x0
+ Other: 0x0
+ ImportName: ''
+ Children:
+ - TerminalSize: 0
+ NodeOffset: 5
+ Name: _
+ Flags: 0x0
+ Address: 0x0
+ Other: 0x0
+ ImportName: ''
+ Children:
+ - TerminalSize: 4
+ NodeOffset: 53
+ Name: a
+ Flags: 0x0
+ Address: 0x4000
+ Other: 0x0
+ ImportName: ''
+ - TerminalSize: 0
+ NodeOffset: 59
+ Name: i
+ Flags: 0x0
+ Address: 0x0
+ Other: 0x0
+ ImportName: ''
+ Children:
+ - TerminalSize: 3
+ NodeOffset: 85
+ Name: OSAPI
+ Flags: 0x0
+ Address: 0x10C0
+ Other: 0x0
+ ImportName: ''
+ - TerminalSize: 4
+ NodeOffset: 90
+ Name: mage
+ Flags: 0x0
+ Address: 0x4008
+ Other: 0x0
+ ImportName: ''
+ - TerminalSize: 3
+ NodeOffset: 96
+ Name: nvalidAPI
+ Flags: 0x0
+ Address: 0x1090
+ Other: 0x0
+ ImportName: ''
+ - TerminalSize: 3
+ NodeOffset: 101
+ Name: obsoletedMacOSAPI
+ Flags: 0x0
+ Address: 0x10E0
+ Other: 0x0
+ ImportName: ''
+ - TerminalSize: 3
+ NodeOffset: 106
+ Name: macOSAPI
+ Flags: 0x0
+ Address: 0x10A0
+ Other: 0x0
+ ImportName: ''
+ Children:
+ - TerminalSize: 3
+ NodeOffset: 114
+ Name: '2'
+ Flags: 0x0
+ Address: 0x10B0
+ Other: 0x0
+ ImportName: ''
+ - TerminalSize: 3
+ NodeOffset: 119
+ Name: commonAPI
+ Flags: 0x0
+ Address: 0x10D0
+ Other: 0x0
+ ImportName: ''
+ NameList:
+ - n_strx: 2
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 4240
+ - n_strx: 14
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 4256
+ - n_strx: 24
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 4272
+ - n_strx: 35
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 4288
+ - n_strx: 43
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 4304
+ - n_strx: 54
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 4320
+ - n_strx: 73
+ n_type: 0xF
+ n_sect: 5
+ n_desc: 0
+ n_value: 16384
+ - n_strx: 76
+ n_type: 0xF
+ n_sect: 5
+ n_desc: 0
+ n_value: 16392
+ - n_strx: 83
+ n_type: 0x1
+ n_sect: 0
+ n_desc: 512
+ n_value: 0
+ StringTable:
+ - ' '
+ - _invalidAPI
+ - _macOSAPI
+ - _macOSAPI2
+ - _iOSAPI
+ - _commonAPI
+ - _obsoletedMacOSAPI
+ - _a
+ - _image
+ - dyld_stub_binder
+ - ''
+ - ''
+ - ''
+ - ''
+ FunctionStarts: [ 0x1090, 0x10A0, 0x10B0, 0x10C0, 0x10D0, 0x10E0 ]
+...
diff --git a/clang/test/InstallAPI/exclusive-passes-2.test b/clang/test/InstallAPI/exclusive-passes-2.test
new file mode 100644
index 00000000000000..3e7a6d777d5af7
--- /dev/null
+++ b/clang/test/InstallAPI/exclusive-passes-2.test
@@ -0,0 +1,58 @@
+; RUN: rm -rf %t
+; RUN: split-file %s %t
+
+// All passes should include Foo macro definition.
+; RUN: clang-installapi -target arm64-apple-macos12 \
+; RUN: -install_name @rpath/libfoo.dylib -current_version 1 \
+; RUN: -compatibility_version 1 \
+; RUN: -I%S/Inputs/LibFoo/usr/include -dynamiclib \
+; RUN: -extra-public-header %S/Inputs/LibFoo/usr/include/foo.h \
+; RUN: -o %t/output.tbd \
+; RUN: -DFoo -XApple -DDarwin=1 -XElf -DNONDarwin=1 2>&1 | FileCheck -allow-empty %s
+; RUN: llvm-readtapi --compare %t/output.tbd %t/expected.tbd 2>&1 | FileCheck -allow-empty %s
+
+; CHECK-NOT: error
+; CHECK-NOT: warning
+
+
+//--- expected.tbd
+{
+ "main_library": {
+ "exported_symbols": [
+ {
+ "text": {
+ "global": [
+ "_FooLib$foo$darwin",
+ "_FooLib$foo$linux",
+ "_FooLib$foo"
+ ]
+ }
+ }
+ ],
+ "flags": [
+ {
+ "attributes": [
+ "not_app_extension_safe"
+ ]
+ }
+ ],
+ "install_names": [
+ {
+ "name": "@rpath/libfoo.dylib"
+ }
+ ],
+ "target_info": [
+ {
+ "min_deployment": "12",
+ "target": "arm64-macos"
+ }
+ ]
+ },
+ "tapi_tbd_version": 5
+}
+
+//--- options.json
+{
+ "Apple" : ["-DDarwin=1"],
+ "Elf" : ["-DNONDarwin"]
+}
diff --git a/clang/test/InstallAPI/exclusive-passes-platform.test b/clang/test/InstallAPI/exclusive-passes-platform.test
new file mode 100644
index 00000000000000..99c809b550d5f7
--- /dev/null
+++ b/clang/test/InstallAPI/exclusive-passes-platform.test
@@ -0,0 +1,277 @@
+; RUN: rm -rf %t
+; RUN: split-file %s %t
+; RUN: sed -e "s|DSTROOT|%/t|g" %t/inputs.json.in > %t/inputs.json
+; RUN: yaml2obj %t/Xplatform.yaml -o=%t/Xplatform
+
+// Check that in zippered mode, a successful pass runs in both macos & maccatalyst.
+; RUN: clang-installapi %t/inputs.json \
+; RUN: --target=x86_64-apple-macos10.15 -darwin-target-variant x86_64-apple-ios13.1-macabi \
+; RUN: -Xplatform_ios-macabi -iframework %t/System/iOSSupport/System/Library/Frameworks \
+; RUN: -install_name /System/Library/Frameworks/Xplatform.framework/Versions/A/Xplatform \
+; RUN: -fdefine-target-os-macros --verify-against=%t/Xplatform --verify-mode=Pedantic \
+; RUN: -o Xplatform.tbd -F%t/Frameworks \
+: RUN: -current_version 1 -compatibility_version 1 2>&1 | FileCheck --allow-empty %s\
+; RUN: --implicit-check-not warning: --implicit-check-not error:
+
+// A missing header error should be invoked in macos pass because it wasn't given the needed search path.
+; RUN: not unifdef -DTARGET_OS_MACCATALYST -o %t/Frameworks/Xplatform.framework/Headers/Xplatform.h %t/Frameworks/Xplatform.framework/Headers/Xplatform.h
+
+; RUN: not clang-installapi %t/inputs.json \
+; RUN: --target=x86_64-apple-macos10.15 -darwin-target-variant x86_64-apple-ios13.1-macabi \
+; RUN: -Xplatform_ios-macabi -iframework %t/System/iOSSupport/System/Library/Frameworks \
+; RUN: -install_name /System/Library/Frameworks/Xplatform.framework/Versions/A/Xplatform \
+; RUN: -fdefine-target-os-macros --verify-against=%t/Xplatform --verify-mode=Pedantic \
+; RUN: -o Xplatform.tbd -F%t/Frameworks \
+: RUN: -current_version 1 -compatibility_version 1 2>&1 | FileCheck -check-prefix=MACOSFAIL %s
+
+; MACOSFAIL: fatal error: 'IOSMac/IOSMac.h' file not found
+
+;--- Frameworks/Xplatform.framework/Headers/Xplatform.h
+#if TARGET_OS_MACCATALYST
+#include <IOSMac/IOSMac.h>
+#endif
+
+inline int foo() {
+ int x = 1;
+#if TARGET_OS_MACCATALYST
+ x += iOSAPI();
+#endif
+ return x;
+}
+
+extern int bar();
+
+;--- System/iOSSupport/System/Library/Frameworks/IOSMac.framework/Headers/IOSMac.h
+extern int iOSAPI();
+
+;--- Xplatform.yaml
+--- !mach-o
+FileHeader:
+ magic: 0xFEEDFACF
+ cputype: 0x1000007
+ cpusubtype: 0x3
+ filetype: 0x6
+ ncmds: 16
+ sizeofcmds: 968
+ flags: 0x100085
+ reserved: 0x0
+LoadCommands:
+ - cmd: LC_SEGMENT_64
+ cmdsize: 232
+ segname: __TEXT
+ vmaddr: 0
+ vmsize: 32768
+ fileoff: 0
+ filesize: 32768
+ maxprot: 5
+ initprot: 5
+ nsects: 2
+ flags: 0
+ Sections:
+ - sectname: __text
+ segname: __TEXT
+ addr: 0x4FAD
+ size: 11
+ offset: 0x4FAD
+ align: 0
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x80000400
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: 554889E5B8010000005DC3
+ - sectname: __unwind_info
+ segname: __TEXT
+ addr: 0x4FB8
+ size: 72
+ offset: 0x4FB8
+ align: 2
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x0
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: 010000001C000000000000001C000000000000001C00000002000000AD4F00003400000034000000B94F00000000000034000000030000000C000100100001000000000000000001
+ - cmd: LC_SEGMENT_64
+ cmdsize: 152
+ segname: __DATA
+ vmaddr: 32768
+ vmsize: 16384
+ fileoff: 32768
+ filesize: 16384
+ maxprot: 3
+ initprot: 3
+ nsects: 1
+ flags: 0
+ Sections:
+ - sectname: __objc_imageinfo
+ segname: __DATA
+ addr: 0x8000
+ size: 8
+ offset: 0x8000
+ align: 2
+ reloff: 0x0
+ nreloc: 0
+ flags: 0x0
+ reserved1: 0x0
+ reserved2: 0x0
+ reserved3: 0x0
+ content: '0000000040000000'
+ - cmd: LC_SEGMENT_64
+ cmdsize: 72
+ segname: __LINKEDIT
+ vmaddr: 49152
+ vmsize: 16384
+ fileoff: 49152
+ filesize: 88
+ maxprot: 1
+ initprot: 1
+ nsects: 0
+ flags: 0
+ - cmd: LC_ID_DYLIB
+ cmdsize: 96
+ dylib:
+ name: 24
+ timestamp: 1
+ current_version: 65536
+ compatibility_version: 65536
+ Content: '/System/Library/Frameworks/Xplatform.framework/Versions/A/Xplatform'
+ ZeroPadBytes: 5
+ - 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: 49152
+ export_size: 16
+ - cmd: LC_SYMTAB
+ cmdsize: 24
+ symoff: 49184
+ nsyms: 2
+ stroff: 49216
+ strsize: 24
+ - cmd: LC_DYSYMTAB
+ cmdsize: 80
+ ilocalsym: 0
+ nlocalsym: 0
+ iextdefsym: 0
+ nextdefsym: 1
+ iundefsym: 1
+ 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: 4AA4F126-BD02-359C-B3EF-E53AD399B590
+ - cmd: LC_BUILD_VERSION
+ cmdsize: 32
+ platform: 1
+ minos: 659200
+ sdk: 721152
+ ntools: 1
+ Tools:
+ - tool: 3
+ version: 46008832
+ - cmd: LC_BUILD_VERSION
+ cmdsize: 32
+ platform: 6
+ minos: 0x00d0100
+ sdk: 851968
+ ntools: 1
+ Tools:
+ - tool: 3
+ version: 46008832
+ - cmd: LC_SOURCE_VERSION
+ cmdsize: 16
+ version: 0
+ - cmd: LC_SEGMENT_SPLIT_INFO
+ cmdsize: 16
+ dataoff: 49168
+ datasize: 8
+ - cmd: LC_LOAD_DYLIB
+ cmdsize: 56
+ dylib:
+ name: 24
+ timestamp: 2
+ current_version: 14942208
+ compatibility_version: 65536
+ Content: '/usr/lib/libobjc.A.dylib'
+ ZeroPadBytes: 8
+ - cmd: LC_LOAD_DYLIB
+ cmdsize: 56
+ dylib:
+ name: 24
+ timestamp: 2
+ current_version: 84687873
+ compatibility_version: 65536
+ Content: '/usr/lib/libSystem.B.dylib'
+ ZeroPadBytes: 6
+ - cmd: LC_FUNCTION_STARTS
+ cmdsize: 16
+ dataoff: 49176
+ datasize: 8
+ - cmd: LC_DATA_IN_CODE
+ cmdsize: 16
+ dataoff: 49184
+ datasize: 0
+LinkEditData:
+ ExportTrie:
+ TerminalSize: 0
+ NodeOffset: 0
+ Name: ''
+ Flags: 0x0
+ Address: 0x0
+ Other: 0x0
+ ImportName: ''
+ Children:
+ - TerminalSize: 4
+ NodeOffset: 8
+ Name: _bar
+ Flags: 0x0
+ Address: 0x4FAD
+ Other: 0x0
+ ImportName: ''
+ NameList:
+ - n_strx: 2
+ n_type: 0xF
+ n_sect: 1
+ n_desc: 0
+ n_value: 20397
+ - n_strx: 7
+ n_type: 0x1
+ n_sect: 0
+ n_desc: 512
+ n_value: 0
+ StringTable:
+ - ' '
+ - _bar
+ - dyld_stub_binder
+...
+
+;--- inputs.json.in
+{
+ "headers": [
+ {
+ "path" : "DSTROOT/Frameworks/Xplatform.framework/Headers/Xplatform.h",
+ "type" : "public"
+ }
+ ],
+ "version": "3"
+}
diff --git a/clang/test/InstallAPI/exclusive-passes-zippered.test b/clang/test/InstallAPI/exclusive-passes-zippered.test
new file mode 100644
index 00000000000000..73d9361d553e3e
--- /dev/null
+++ b/clang/test/InstallAPI/exclusive-passes-zippered.test
@@ -0,0 +1,56 @@
+; RUN: rm -rf %t
+; RUN: split-file %s %t
+; RUN: mkdir -p %t/Frameworks/
+; RUN: cp -r %S/Inputs/Zippered/Zippered.framework %t/Frameworks/
+; RUN: sed -e "s|DSTROOT|%/t|g" %t/inputs.json.in > %t/inputs.json
+; RUN: yaml2obj %S/Inputs/Zippered/Zippered.yaml -o %t/Frameworks/Zippered.framework/Zippered
+
+; RUN: clang-installapi \
+; RUN: --target=x86_64-apple-macos13 -darwin-target-variant x86_64-apple-ios16-macabi \
+; RUN: -install_name /System/Library/Frameworks/Zippered.framework/Versions/A/Zippered \
+; RUN: -current_version 1 -compatibility_version 1 %t/inputs.json \
+; RUN: --verify-against=%t/Frameworks/Zippered.framework/Zippered \
+; RUN: -isysroot %S/Inputs/MacOSX13.0.sdk -F%t/Frameworks \
+; RUN: --verify-mode=Pedantic -o %t/Zippered.tbd \
+; RUN: --extra-private-header=%t/Extra.h 2>&1 | FileCheck -allow-empty %s \
+; RUN: --implicit-check-not warning: --implicit-check-not error:
+; RUN: llvm-readtapi -compare %t/Zippered.tbd %S/Inputs/Zippered/Zippered.tbd
+
+// Flag extra symbols exposed by macro definition.
+; RUN: not clang-installapi \
+; RUN: --target=x86_64-apple-macos13 -darwin-target-variant x86_64-apple-ios16-macabi \
+; RUN: -install_name /System/Library/Frameworks/Zippered.framework/Versions/A/Zippered \
+; RUN: -current_version 1 -compatibility_version 1 %t/inputs.json \
+; RUN: -isysroot %S/Inputs/MacOSX13.0.sdk -F%t/Frameworks \
+; RUN: --verify-mode=Pedantic -o %t/Zippered.tbd -v \
+; RUN: --verify-against=%t/Frameworks/Zippered.framework/Zippered \
+; RUN: --extra-private-header=%t/Extra.h -XExtra -DExtra 2>&1 | FileCheck %s --check-prefix=MACRO_DEF
+
+; MACRO_DEF-COUNT-2: "-D" "Extra"
+; MACRO_DEF: violations found for x86_64-apple-macos13
+; MACRO_DEF: Extra.h:5:12: error: declaration has external linkage, but dynamic library doesn't have symbol 'foo$bar'
+; MACRO_DEF-COUNT-2: "-D" "Extra"
+; MACRO_DEF-NOT: violations found for x86_64-apple-ios16-macabi
+
+;--- Extra.h
+#define __STRING(x) #x
+
+#if defined(Extra)
+ #define MACRO_DEF "$bar"
+extern int foo() __asm("_" __STRING(foo) MACRO_DEF) __attribute__((availability(ios, unavailable)));
+#endif
+
+;--- inputs.json.in
+{
+ "headers": [
+ {
+ "path" : "DSTROOT/Frameworks/Zippered.framework/PrivateHeaders/Zippered_Private.h",
+ "type" : "private"
+ },
+ {
+ "path" : "DSTROOT/Frameworks/Zippered.framework/Headers/Zippered.h",
+ "type" : "public"
+ }
+ ],
+ "version": "3"
+}
diff --git a/clang/test/InstallAPI/exclusive-passes.test b/clang/test/InstallAPI/exclusive-passes.test
new file mode 100644
index 00000000000000..29b0fc3d7a2aa9
--- /dev/null
+++ b/clang/test/InstallAPI/exclusive-passes.test
@@ -0,0 +1,54 @@
+; RUN: rm -rf %t
+; RUN: split-file %s %t
+
+; RUN: clang-installapi \
+; RUN: -target arm64-apple-macos12 -install_name @rpath/libfoo.dylib \
+; RUN: -current_version 1 -compatibility_version 1 \
+; RUN: -XApple -DDarwin=1 -XElf -DNONDarwin=1 \
+; RUN: -I%S/Inputs/LibFoo/usr/include -dynamiclib \
+; RUN: -extra-public-header %S/Inputs/LibFoo/usr/include/public.h \
+; RUN: -o %t/output.tbd -v 2>&1 | FileCheck %s --check-prefix=INSTALLAPI
+; RUN: llvm-readtapi --compare %t/output.tbd %t/expected.tbd 2>&1 | FileCheck -allow-empty %s
+
+; CHECK-NOT: error
+; CHECK-NOT: warning
+
+; INSTALLAPI: Public Headers:
+; INSTALLAPI: Apple Public Headers:
+; INSTALLAPI: Elf Public Headers:
+
+;--- expected.tbd
+{
+ "main_library": {
+ "exported_symbols": [
+ {
+ "text": {
+ "global": [
+ "_foo$darwin",
+ "_foo$linux",
+ "_foo"
+ ]
+ }
+ }
+ ],
+ "flags": [
+ {
+ "attributes": [
+ "not_app_extension_safe"
+ ]
+ }
+ ],
+ "install_names": [
+ {
+ "name": "@rpath/libfoo.dylib"
+ }
+ ],
+ "target_info": [
+ {
+ "min_deployment": "12",
+ "target": "arm64-macos"
+ }
+ ]
+ },
+ "tapi_tbd_version": 5
+}
diff --git a/clang/test/InstallAPI/invalid-exclusive-passes.test b/clang/test/InstallAPI/invalid-exclusive-passes.test
new file mode 100644
index 00000000000000..c23c918f0bfbb1
--- /dev/null
+++ b/clang/test/InstallAPI/invalid-exclusive-passes.test
@@ -0,0 +1,37 @@
+; RUN: rm -rf %t
+; RUN: split-file %s %t
+
+// Validate arguments not allowed with -X
+; RUN: not clang-installapi \
+; RUN: -target arm64-apple-macos12 \
+; RUN: -install_name @rpath/libfoo.dylib \
+; RUN: -current_version 1 -compatibility_version 1 \
+; RUN: -XApple -I/fake/path -I%t %t/inputs.json \
+; RUN: -dynamiclib -o %t/output.tbd 2>&1 | FileCheck %s --check-prefix=INVALID_OPT
+; INVALID_OPT: error: invalid argument '-XApple' not allowed with '-I/fake/path'
+
+// Validate reserved labels.
+; RUN: not clang-installapi \
+; RUN: -target arm64-apple-macos12 \
+; RUN: -install_name @rpath/libfoo.dylib \
+; RUN: -current_version 1 -compatibility_version 1 \
+; RUN: -XApple -DDarwin=1 -XElf -DNONDarwin=1 \
+; RUN: -I%t -dynamiclib -o %t/output.tbd %t/inputs.json \
+; RUN: -XPrivate -DInvalid=1 2>&1 | FileCheck %s --check-prefix=INVALID_LABELS
+; INVALID_LABELS: error: label 'Private' is reserved: use a different label name for -X<label>
+
+// Validate arguments not allowed with -Xproject
+; RUN: not clang-installapi \
+; RUN: -target arm64-apple-macos12 \
+; RUN: -install_name @rpath/libfoo.dylib \
+; RUN: -current_version 1 -compatibility_version 1 \
+; RUN: -Xproject -fprofile-instr-generate \
+; RUN: %t/inputs.json -I%t -dynamiclib \
+; RUN: -o %t/output.tbd 2>&1 | FileCheck %s --check-prefix=INVALID_PROJECT_OPT
+; INVALID_PROJECT_OPT: error: invalid argument '-Xproject' not allowed with '-fprofile-instr-generate'
+
+;--- inputs.json
+{
+ "headers": [ ],
+ "version": "3"
+}
diff --git a/clang/test/InstallAPI/project-header-only-args.test b/clang/test/InstallAPI/project-header-only-args.test
new file mode 100644
index 00000000000000..7147c83b0f5d49
--- /dev/null
+++ b/clang/test/InstallAPI/project-header-only-args.test
@@ -0,0 +1,81 @@
+; RUN: rm -rf %t
+; RUN: split-file %s %t
+; RUN: sed -e "s|DSTROOT|%/t|g" %t/inputs.json.in > %t/inputs.json
+
+; RUN: clang-installapi \
+; RUN: -target arm64-apple-macos12 -install_name @rpath/libfoo.dylib \
+; RUN: -current_version 1 -compatibility_version 1 \
+; RUN: -Xproject -fmodules -I%t/usr/include \
+; RUN: -F %S/Inputs/Foundation/ \
+; RUN: -exclude-public-header %t/usr/include/public.h \
+; RUN: -extra-project-header %t/project.h -I%t -dynamiclib \
+; RUN: %t/inputs.json \
+; RUN: -o %t/output.tbd 2>&1 | FileCheck %s --allow-empty
+; RUN: llvm-readtapi --compare %t/output.tbd %t/expected.tbd 2>&1 | FileCheck %s --allow-empty
+
+; RUN: not clang-installapi \
+; RUN: -target arm64-apple-macos12 -install_name @rpath/libfoo.dylib \
+; RUN: -current_version 1 -compatibility_version 1 \
+; RUN: -Xproject -fmodules -I%t/usr/include \
+; RUN: -extra-project-header %t/project.h \
+; RUN: -F %S/Inputs/Foundation/ \
+; RUN: %t/inputs.json \
+; RUN: -I%t -dynamiclib -o %t/output.tbd 2>&1 | FileCheck %s --check-prefix=PUBLIC
+
+; CHECK-NOT: error
+; CHECK-NOT: warning
+
+; PUBLIC: public.h:1:1: error: use of '@import' when modules are disabled
+; PUBLIC-NEXT: @import Foundation;
+
+//--- usr/include/public.h
+ at import Foundation;
+extern int foo();
+
+//--- project.h
+ at import Foundation;
+extern int bar();
+
+//--- expected.tbd
+{
+ "main_library": {
+ "exported_symbols": [
+ {
+ "text": {
+ "global": [
+ "_bar"
+ ]
+ }
+ }
+ ],
+ "flags": [
+ {
+ "attributes": [
+ "not_app_extension_safe"
+ ]
+ }
+ ],
+ "install_names": [
+ {
+ "name": "@rpath/libfoo.dylib"
+ }
+ ],
+ "target_info": [
+ {
+ "min_deployment": "12",
+ "target": "arm64-macos"
+ }
+ ]
+ },
+ "tapi_tbd_version": 5
+}
+
+;--- inputs.json.in
+{
+ "headers": [ {
+ "path" : "DSTROOT/usr/include/public.h",
+ "type" : "public"
+ }
+ ],
+ "version": "3"
+}
diff --git a/clang/tools/clang-installapi/ClangInstallAPI.cpp b/clang/tools/clang-installapi/ClangInstallAPI.cpp
index add28ab4fcda20..1af8133e4d3bb9 100644
--- a/clang/tools/clang-installapi/ClangInstallAPI.cpp
+++ b/clang/tools/clang-installapi/ClangInstallAPI.cpp
@@ -39,7 +39,7 @@ using namespace clang::driver::options;
using namespace llvm::opt;
using namespace llvm::MachO;
-static bool runFrontend(StringRef ProgName, bool Verbose,
+static bool runFrontend(StringRef ProgName, Twine Label, bool Verbose,
InstallAPIContext &Ctx,
llvm::vfs::InMemoryFileSystem *FS,
const ArrayRef<std::string> InitialArgs) {
@@ -50,7 +50,7 @@ static bool runFrontend(StringRef ProgName, bool Verbose,
return true;
if (Verbose)
- llvm::errs() << getName(Ctx.Type) << " Headers:\n"
+ llvm::errs() << Label << " Headers:\n"
<< ProcessedInput->getBuffer() << "\n\n";
std::string InputFile = ProcessedInput->getBufferIdentifier().str();
@@ -127,10 +127,22 @@ static bool run(ArrayRef<const char *> Args, const char *ProgName) {
Ctx.Slice = std::make_shared<FrontendRecordsSlice>(Trip);
for (const HeaderType Type :
{HeaderType::Public, HeaderType::Private, HeaderType::Project}) {
+ std::vector<std::string> ArgStrings = Opts.getClangFrontendArgs();
+ Opts.addConditionalCC1Args(ArgStrings, Trip, Type);
Ctx.Type = Type;
- if (!runFrontend(ProgName, Opts.DriverOpts.Verbose, Ctx,
- InMemoryFileSystem.get(), Opts.getClangFrontendArgs()))
+ StringRef HeaderLabel = getName(Ctx.Type);
+ if (!runFrontend(ProgName, HeaderLabel, Opts.DriverOpts.Verbose, Ctx,
+ InMemoryFileSystem.get(), ArgStrings))
return EXIT_FAILURE;
+
+ // Run extra passes for unique compiler arguments.
+ for (const auto &[Label, ExtraArgs] : Opts.FEOpts.UniqueArgs) {
+ llvm::append_range(ArgStrings, ExtraArgs);
+ if (!runFrontend(ProgName, Label + " " + HeaderLabel,
+ Opts.DriverOpts.Verbose, Ctx, InMemoryFileSystem.get(),
+ ArgStrings))
+ return EXIT_FAILURE;
+ }
}
FrontendRecords.emplace_back(std::move(Ctx.Slice));
}
diff --git a/clang/tools/clang-installapi/InstallAPIOpts.td b/clang/tools/clang-installapi/InstallAPIOpts.td
index 8b1998c280dd69..a95a7a80a9d20c 100644
--- a/clang/tools/clang-installapi/InstallAPIOpts.td
+++ b/clang/tools/clang-installapi/InstallAPIOpts.td
@@ -90,6 +90,15 @@ def project_umbrella_header : Separate<["-"], "project-umbrella-header">,
def project_umbrella_header_EQ : Joined<["--"], "project-umbrella-header=">,
Alias<project_umbrella_header>;
+//
+/// X<label> overrides.
+//
+def Xplatform__ : Joined<["-"], "Xplatform_">;
+def Xproject : Joined<["-"], "Xproject">;
+def X__ : Joined<["-"], "X">,
+ HelpText<"Pass <arg> to run unique clang invocation identified as <label>">,
+ MetaVarName<"<label> <arg>">;
+
//
/// Overidden clang options for different behavior.
//
@@ -108,4 +117,25 @@ def reexport_library : Separate<["-"], "reexport_library">, MetaVarName<"<path>"
def reexport_framework : Separate<["-"], "reexport_framework">,
HelpText<"Re-export the specified framework">;
+// Xproject supported options.
+def fobjc_arc : Flag<["-"], "fobjc-arc">,
+ HelpText<"Synthesize retain and release calls for Objective-C pointers">;
+def include_ : JoinedOrSeparate<["-", "--"], "include">,
+ MetaVarName<"<file>">, HelpText<"Include file before parsing, can only be used with -Xproject">;
+def fvisibility_EQ : Joined<["-"], "fvisibility=">,
+ HelpText<"Set the default symbol visibility for all global declarations">;
+def fmodules : Flag <["-"], "fmodules">,
+ HelpText<"Enable the 'modules' language feature">;
+def fmodules_cache_path : Joined<["-"], "fmodules-cache-path=">,
+ MetaVarName<"<directory>">,
+ HelpText<"Specify the module cache path">;
+
+// Xplatform supported options.
+def iframework : JoinedOrSeparate<["-"], "iframework">,
+ HelpText<"Add directory to SYSTEM framework search path">;
+
+// X<label> prefixes supported options.
+def D : JoinedOrSeparate<["-"], "D">, HelpText<"Define macro">;
+def U : JoinedOrSeparate<["-"], "U">, HelpText<"Undefine macro">;
+
diff --git a/clang/tools/clang-installapi/Options.cpp b/clang/tools/clang-installapi/Options.cpp
index 21f04a291b2f1f..5396ad23620b9d 100644
--- a/clang/tools/clang-installapi/Options.cpp
+++ b/clang/tools/clang-installapi/Options.cpp
@@ -189,12 +189,120 @@ bool Options::processDriverOptions(InputArgList &Args) {
bool Options::processInstallAPIXOptions(InputArgList &Args) {
for (arg_iterator It = Args.begin(), End = Args.end(); It != End; ++It) {
- if ((*It)->getOption().matches(OPT_Xarch__)) {
+ Arg *A = *It;
+ if (A->getOption().matches(OPT_Xarch__)) {
if (!processXarchOption(Args, It))
return false;
+ continue;
+ } else if (A->getOption().matches(OPT_Xplatform__)) {
+ if (!processXplatformOption(Args, It))
+ return false;
+ continue;
+ } else if (A->getOption().matches(OPT_Xproject)) {
+ if (!processXprojectOption(Args, It))
+ return false;
+ continue;
+ } else if (!A->getOption().matches(OPT_X__))
+ continue;
+
+ // Handle any user defined labels.
+ const StringRef Label = A->getValue(0);
+
+ // Ban "public" and "private" labels.
+ if ((Label.lower() == "public") || (Label.lower() == "private")) {
+ Diags->Report(diag::err_invalid_label) << Label;
+ return false;
}
+
+ auto NextIt = std::next(It);
+ if (NextIt == End) {
+ Diags->Report(clang::diag::err_drv_missing_argument)
+ << A->getAsString(Args) << 1;
+ return false;
+ }
+ Arg *NextA = *NextIt;
+ switch ((ID)NextA->getOption().getID()) {
+ case OPT_D:
+ case OPT_U:
+ break;
+ default:
+ Diags->Report(clang::diag::err_drv_argument_not_allowed_with)
+ << A->getAsString(Args) << NextA->getAsString(Args);
+ return false;
+ }
+ const StringRef ASpelling = NextA->getSpelling();
+ const auto &AValues = NextA->getValues();
+ if (AValues.empty())
+ FEOpts.UniqueArgs[Label].emplace_back(ASpelling.str());
+ else
+ for (const StringRef Val : AValues)
+ FEOpts.UniqueArgs[Label].emplace_back((ASpelling + Val).str());
+
+ A->claim();
+ NextA->claim();
}
- // TODO: Add support for the all of the X* options installapi supports.
+
+ return true;
+}
+
+bool Options::processXplatformOption(InputArgList &Args, arg_iterator Curr) {
+ Arg *A = *Curr;
+
+ PlatformType Platform = getPlatformFromName(A->getValue(0));
+ if (Platform == PLATFORM_UNKNOWN) {
+ Diags->Report(diag::err_unsupported_os)
+ << getPlatformName(Platform) << A->getAsString(Args);
+ return false;
+ }
+ auto NextIt = std::next(Curr);
+ if (NextIt == Args.end()) {
+ Diags->Report(diag::err_drv_missing_argument) << A->getAsString(Args) << 1;
+ return false;
+ }
+
+ Arg *NextA = *NextIt;
+ switch ((ID)NextA->getOption().getID()) {
+ case OPT_iframework:
+ FEOpts.SystemFwkPaths.emplace_back(NextA->getValue(), Platform);
+ break;
+ default:
+ Diags->Report(diag::err_drv_invalid_argument_to_option)
+ << A->getAsString(Args) << NextA->getAsString(Args);
+ return false;
+ }
+
+ A->claim();
+ NextA->claim();
+
+ return true;
+}
+
+bool Options::processXprojectOption(InputArgList &Args, arg_iterator Curr) {
+ Arg *A = *Curr;
+ auto NextIt = std::next(Curr);
+ if (NextIt == Args.end()) {
+ Diags->Report(diag::err_drv_missing_argument) << A->getAsString(Args) << 1;
+ return false;
+ }
+
+ Arg *NextA = *NextIt;
+ switch ((ID)NextA->getOption().getID()) {
+ case OPT_fobjc_arc:
+ case OPT_fmodules:
+ case OPT_fmodules_cache_path:
+ case OPT_include_:
+ case OPT_fvisibility_EQ:
+ break;
+ default:
+ Diags->Report(diag::err_drv_argument_not_allowed_with)
+ << A->getAsString(Args) << NextA->getAsString(Args);
+ return false;
+ }
+
+ ProjectLevelArgs.push_back(NextA->getSpelling().str());
+ llvm::copy(NextA->getValues(), std::back_inserter(ProjectLevelArgs));
+ A->claim();
+ NextA->claim();
return true;
}
@@ -333,10 +441,10 @@ bool Options::processFrontendOptions(InputArgList &Args) {
}
}
- // Capture system frameworks.
- // TODO: Support passing framework paths per platform.
+ // Capture system frameworks for all platforms.
for (const Arg *A : Args.filtered(drv::OPT_iframework))
- FEOpts.SystemFwkPaths.emplace_back(A->getValue());
+ FEOpts.SystemFwkPaths.emplace_back(A->getValue(),
+ std::optional<PlatformType>{});
// Capture framework paths.
PathSeq FrameworkPaths;
@@ -359,7 +467,8 @@ bool Options::processFrontendOptions(InputArgList &Args) {
for (const StringRef FwkPath : DefaultFrameworkPaths) {
SmallString<PATH_MAX> Path(FEOpts.ISysroot);
sys::path::append(Path, FwkPath);
- FEOpts.SystemFwkPaths.emplace_back(Path.str());
+ FEOpts.SystemFwkPaths.emplace_back(Path.str(),
+ std::optional<PlatformType>{});
}
return true;
@@ -510,7 +619,11 @@ Options::processAndFilterOutInstallAPIOptions(ArrayRef<const char *> Args) {
for (const Arg *A : ParsedArgs) {
if (A->isClaimed())
continue;
- llvm::copy(A->getValues(), std::back_inserter(ClangDriverArgs));
+ // Forward along unclaimed but overlapping arguments to the clang driver.
+ if (A->getOption().getID() > (unsigned)OPT_UNKNOWN) {
+ ClangDriverArgs.push_back(A->getSpelling().data());
+ } else
+ llvm::copy(A->getValues(), std::back_inserter(ClangDriverArgs));
}
return ClangDriverArgs;
}
@@ -622,12 +735,30 @@ std::pair<LibAttrs, ReexportedInterfaces> Options::getReexportedLibraries() {
return true;
};
+ PlatformSet Platforms;
+ llvm::for_each(DriverOpts.Targets,
+ [&](const auto &T) { Platforms.insert(T.first.Platform); });
// Populate search paths by looking at user paths before system ones.
PathSeq FwkSearchPaths(FEOpts.FwkPaths.begin(), FEOpts.FwkPaths.end());
- // FIXME: System framework paths need to reset if installapi is invoked with
- // different platforms.
- FwkSearchPaths.insert(FwkSearchPaths.end(), FEOpts.SystemFwkPaths.begin(),
- FEOpts.SystemFwkPaths.end());
+ for (const PlatformType P : Platforms) {
+ PathSeq PlatformSearchPaths = getPathsForPlatform(FEOpts.SystemFwkPaths, P);
+ FwkSearchPaths.insert(FwkSearchPaths.end(), PlatformSearchPaths.begin(),
+ PlatformSearchPaths.end());
+ for (const StringMapEntry<ArchitectureSet> &Lib :
+ LinkerOpts.ReexportedFrameworks) {
+ std::string Name = (Lib.getKey() + ".framework/" + Lib.getKey()).str();
+ std::string Path = findLibrary(Name, *FM, FwkSearchPaths, {}, {});
+ if (Path.empty()) {
+ Diags->Report(diag::err_cannot_find_reexport) << false << Lib.getKey();
+ return {};
+ }
+ if (DriverOpts.TraceLibraryLocation)
+ errs() << Path << "\n";
+
+ AccumulateReexports(Path, Lib.getValue());
+ }
+ FwkSearchPaths.resize(FwkSearchPaths.size() - PlatformSearchPaths.size());
+ }
for (const StringMapEntry<ArchitectureSet> &Lib :
LinkerOpts.ReexportedLibraries) {
@@ -647,20 +778,6 @@ std::pair<LibAttrs, ReexportedInterfaces> Options::getReexportedLibraries() {
LinkerOpts.ReexportedLibraryPaths)
AccumulateReexports(Lib.getKey(), Lib.getValue());
- for (const StringMapEntry<ArchitectureSet> &Lib :
- LinkerOpts.ReexportedFrameworks) {
- std::string Name = (Lib.getKey() + ".framework/" + Lib.getKey()).str();
- std::string Path = findLibrary(Name, *FM, FwkSearchPaths, {}, {});
- if (Path.empty()) {
- Diags->Report(diag::err_cannot_find_reexport) << false << Lib.getKey();
- return {};
- }
- if (DriverOpts.TraceLibraryLocation)
- errs() << Path << "\n";
-
- AccumulateReexports(Path, Lib.getValue());
- }
-
return {std::move(Reexports), std::move(ReexportIFs)};
}
@@ -876,5 +993,25 @@ InstallAPIContext Options::createContext() {
return Ctx;
}
+void Options::addConditionalCC1Args(std::vector<std::string> &ArgStrings,
+ const llvm::Triple &Targ,
+ const HeaderType Type) {
+ // Unique to architecture (Xarch) options hold no arguments to pass along for
+ // frontend.
+
+ // Add specific to platform arguments.
+ PathSeq PlatformSearchPaths =
+ getPathsForPlatform(FEOpts.SystemFwkPaths, mapToPlatformType(Targ));
+ llvm::for_each(PlatformSearchPaths, [&ArgStrings](const StringRef Path) {
+ ArgStrings.push_back("-iframework");
+ ArgStrings.push_back(Path.str());
+ });
+
+ // Add specific to header type arguments.
+ if (Type == HeaderType::Project)
+ for (const StringRef A : ProjectLevelArgs)
+ ArgStrings.emplace_back(A);
+}
+
} // namespace installapi
} // namespace clang
diff --git a/clang/tools/clang-installapi/Options.h b/clang/tools/clang-installapi/Options.h
index e9ac75889ad30c..fd1e10065d1028 100644
--- a/clang/tools/clang-installapi/Options.h
+++ b/clang/tools/clang-installapi/Options.h
@@ -133,6 +133,9 @@ struct LinkerOptions {
};
struct FrontendOptions {
+ /// \brief Unique clang options to pass per key in map.
+ llvm::StringMap<std::vector<std::string>> UniqueArgs;
+
/// \brief The language mode to parse headers in.
Language LangMode = Language::ObjC;
@@ -143,7 +146,7 @@ struct FrontendOptions {
PathSeq FwkPaths;
/// \brief Additional SYSTEM framework search paths.
- PathSeq SystemFwkPaths;
+ PathToPlatformSeq SystemFwkPaths;
};
using arg_iterator = llvm::opt::arg_iterator<llvm::opt::Arg **>;
@@ -156,6 +159,8 @@ class Options {
processAndFilterOutInstallAPIOptions(ArrayRef<const char *> Args);
bool processInstallAPIXOptions(llvm::opt::InputArgList &Args);
bool processXarchOption(llvm::opt::InputArgList &Args, arg_iterator Curr);
+ bool processXplatformOption(llvm::opt::InputArgList &Args, arg_iterator Curr);
+ bool processXprojectOption(llvm::opt::InputArgList &Args, arg_iterator Curr);
public:
/// The various options grouped together.
@@ -176,6 +181,11 @@ class Options {
/// ones.
std::vector<std::string> &getClangFrontendArgs() { return FrontendArgs; }
+ /// \brief Add relevant, but conditionalized by active target and header type,
+ /// arguments for constructing a CC1 invocation.
+ void addConditionalCC1Args(std::vector<std::string> &ArgStrings,
+ const llvm::Triple &Targ, const HeaderType Type);
+
private:
bool addFilePaths(llvm::opt::InputArgList &Args, PathSeq &Headers,
llvm::opt::OptSpecifier ID);
@@ -186,6 +196,7 @@ class Options {
FileManager *FM;
std::vector<std::string> FrontendArgs;
llvm::DenseMap<const llvm::opt::Arg *, Architecture> ArgToArchMap;
+ std::vector<std::string> ProjectLevelArgs;
};
enum ID {
diff --git a/llvm/include/llvm/TextAPI/Utils.h b/llvm/include/llvm/TextAPI/Utils.h
index 87550851f091ef..00dfd63e14f915 100644
--- a/llvm/include/llvm/TextAPI/Utils.h
+++ b/llvm/include/llvm/TextAPI/Utils.h
@@ -32,6 +32,8 @@
namespace llvm::MachO {
using PathSeq = std::vector<std::string>;
+using PathToPlatform = std::pair<std::string, std::optional<PlatformType>>;
+using PathToPlatformSeq = std::vector<PathToPlatform>;
// Defines simple struct for storing symbolic links.
struct SymLink {
@@ -87,5 +89,12 @@ using AliasMap = std::map<AliasEntry, AliasEntry>;
/// \return Lookup table of alias to their base symbol.
Expected<AliasMap> parseAliasList(std::unique_ptr<llvm::MemoryBuffer> &Buffer);
+/// Pickup active paths for a given platform.
+///
+/// \param Paths File or search paths to pick up.
+/// \param Platform Platform to collect paths for.
+PathSeq getPathsForPlatform(const PathToPlatformSeq &Paths,
+ PlatformType Platform);
+
} // namespace llvm::MachO
#endif // LLVM_TEXTAPI_UTILS_H
diff --git a/llvm/lib/TextAPI/Utils.cpp b/llvm/lib/TextAPI/Utils.cpp
index 3b5e11e29de4a3..08f14f65177ed3 100644
--- a/llvm/lib/TextAPI/Utils.cpp
+++ b/llvm/lib/TextAPI/Utils.cpp
@@ -232,3 +232,13 @@ llvm::MachO::parseAliasList(std::unique_ptr<llvm::MemoryBuffer> &Buffer) {
return Aliases;
}
+
+PathSeq llvm::MachO::getPathsForPlatform(const PathToPlatformSeq &Paths,
+ PlatformType Platform) {
+ PathSeq Result;
+ for (const auto &[Path, CurrP] : Paths) {
+ if (!CurrP.has_value() || CurrP.value() == Platform)
+ Result.push_back(Path);
+ }
+ return Result;
+}
>From b2ead7f30dee8f53793ab804c9f2ae09f203872e Mon Sep 17 00:00:00 2001
From: Cyndy Ishida <cyndy_ishida at apple.com>
Date: Tue, 30 Apr 2024 20:03:45 -0700
Subject: [PATCH 2/2] Remove `unifdef` dependency on test
---
clang/test/InstallAPI/exclusive-passes-platform.test | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/clang/test/InstallAPI/exclusive-passes-platform.test b/clang/test/InstallAPI/exclusive-passes-platform.test
index 99c809b550d5f7..c5a79cf9a30d16 100644
--- a/clang/test/InstallAPI/exclusive-passes-platform.test
+++ b/clang/test/InstallAPI/exclusive-passes-platform.test
@@ -14,7 +14,7 @@
; RUN: --implicit-check-not warning: --implicit-check-not error:
// A missing header error should be invoked in macos pass because it wasn't given the needed search path.
-; RUN: not unifdef -DTARGET_OS_MACCATALYST -o %t/Frameworks/Xplatform.framework/Headers/Xplatform.h %t/Frameworks/Xplatform.framework/Headers/Xplatform.h
+; RUN: mv %t/Xplatform-macosx.h %t/Frameworks/Xplatform.framework/Headers/Xplatform.h
; RUN: not clang-installapi %t/inputs.json \
; RUN: --target=x86_64-apple-macos10.15 -darwin-target-variant x86_64-apple-ios13.1-macabi \
@@ -41,6 +41,15 @@ inline int foo() {
extern int bar();
+;--- Xplatform-macosx.h
+#include <IOSMac/IOSMac.h>
+inline int foo() {
+ int x = 1;
+ return x;
+}
+
+extern int bar();
+
;--- System/iOSSupport/System/Library/Frameworks/IOSMac.framework/Headers/IOSMac.h
extern int iOSAPI();
More information about the llvm-commits
mailing list