[clang] [InstallAPI] Add installapi specific options & diagnostics (PR #85100)
Cyndy Ishida via cfe-commits
cfe-commits at lists.llvm.org
Thu Mar 14 12:08:58 PDT 2024
https://github.com/cyndyishida updated https://github.com/llvm/llvm-project/pull/85100
>From 1281dfa43781cd544b80575d6b8e76a89204e7ff Mon Sep 17 00:00:00 2001
From: Cyndy Ishida <cyndy_ishida at apple.com>
Date: Wed, 6 Mar 2024 09:16:20 -0800
Subject: [PATCH] [InstallAPI] Add installapi specific options & diagnostics
* A lot of `tapi installapi` options are already shared with clang, but not all.
This patch handles installapi specific options by filtering for them in initial argv input, then passing the rest to the clang driver.
* Installapi not only generates a text file but also reports to library
developers when there are inconsistences between an interface and it's
implementation. To allow this, add support for reporting installapi
diagnostics. This will be leveraged in the verifier service.
---
clang/include/clang/Basic/AllDiagnostics.h | 1 +
clang/include/clang/Basic/CMakeLists.txt | 1 +
clang/include/clang/Basic/Diagnostic.td | 1 +
clang/include/clang/Basic/DiagnosticIDs.h | 4 +-
.../clang/Basic/DiagnosticInstallAPI.h | 26 +++
.../clang/Basic/DiagnosticInstallAPIKinds.td | 20 ++
.../include/clang/InstallAPI/DylibVerifier.h | 27 +++
.../clang/InstallAPI/InstallAPIDiagnostic.h | 14 ++
clang/lib/Basic/DiagnosticIDs.cpp | 10 +-
.../InstallAPI/driver-invalid-options.test | 7 +-
clang/test/InstallAPI/functions.test | 2 +-
clang/tools/clang-installapi/CMakeLists.txt | 8 +
.../clang-installapi/ClangInstallAPI.cpp | 23 +--
.../tools/clang-installapi/InstallAPIOpts.td | 31 +++
clang/tools/clang-installapi/Options.cpp | 194 +++++++++++++++---
clang/tools/clang-installapi/Options.h | 25 ++-
16 files changed, 343 insertions(+), 51 deletions(-)
create mode 100644 clang/include/clang/Basic/DiagnosticInstallAPI.h
create mode 100644 clang/include/clang/Basic/DiagnosticInstallAPIKinds.td
create mode 100644 clang/include/clang/InstallAPI/DylibVerifier.h
create mode 100644 clang/include/clang/InstallAPI/InstallAPIDiagnostic.h
create mode 100644 clang/tools/clang-installapi/InstallAPIOpts.td
diff --git a/clang/include/clang/Basic/AllDiagnostics.h b/clang/include/clang/Basic/AllDiagnostics.h
index cc6aa631534a5d..e64634cc138f7f 100644
--- a/clang/include/clang/Basic/AllDiagnostics.h
+++ b/clang/include/clang/Basic/AllDiagnostics.h
@@ -20,6 +20,7 @@
#include "clang/Basic/DiagnosticCrossTU.h"
#include "clang/Basic/DiagnosticDriver.h"
#include "clang/Basic/DiagnosticFrontend.h"
+#include "clang/Basic/DiagnosticInstallAPI.h"
#include "clang/Basic/DiagnosticLex.h"
#include "clang/Basic/DiagnosticParse.h"
#include "clang/Basic/DiagnosticSema.h"
diff --git a/clang/include/clang/Basic/CMakeLists.txt b/clang/include/clang/Basic/CMakeLists.txt
index 7785fb430c069b..7d53c751c13ac4 100644
--- a/clang/include/clang/Basic/CMakeLists.txt
+++ b/clang/include/clang/Basic/CMakeLists.txt
@@ -12,6 +12,7 @@ clang_diag_gen(Common)
clang_diag_gen(CrossTU)
clang_diag_gen(Driver)
clang_diag_gen(Frontend)
+clang_diag_gen(InstallAPI)
clang_diag_gen(Lex)
clang_diag_gen(Parse)
clang_diag_gen(Refactoring)
diff --git a/clang/include/clang/Basic/Diagnostic.td b/clang/include/clang/Basic/Diagnostic.td
index 8d66e265fbaef0..0b8b3af939ba0e 100644
--- a/clang/include/clang/Basic/Diagnostic.td
+++ b/clang/include/clang/Basic/Diagnostic.td
@@ -162,6 +162,7 @@ include "DiagnosticCommonKinds.td"
include "DiagnosticCrossTUKinds.td"
include "DiagnosticDriverKinds.td"
include "DiagnosticFrontendKinds.td"
+include "DiagnosticInstallAPIKinds.td"
include "DiagnosticLexKinds.td"
include "DiagnosticParseKinds.td"
include "DiagnosticRefactoringKinds.td"
diff --git a/clang/include/clang/Basic/DiagnosticIDs.h b/clang/include/clang/Basic/DiagnosticIDs.h
index 0cdda42793f6f0..95b502b1e97ab1 100644
--- a/clang/include/clang/Basic/DiagnosticIDs.h
+++ b/clang/include/clang/Basic/DiagnosticIDs.h
@@ -42,6 +42,7 @@ namespace clang {
DIAG_SIZE_SEMA = 4500,
DIAG_SIZE_ANALYSIS = 100,
DIAG_SIZE_REFACTORING = 1000,
+ DIAG_SIZE_INSTALLAPI = 100,
};
// Start position for diagnostics.
enum {
@@ -57,7 +58,8 @@ namespace clang {
DIAG_START_SEMA = DIAG_START_CROSSTU + static_cast<int>(DIAG_SIZE_CROSSTU),
DIAG_START_ANALYSIS = DIAG_START_SEMA + static_cast<int>(DIAG_SIZE_SEMA),
DIAG_START_REFACTORING = DIAG_START_ANALYSIS + static_cast<int>(DIAG_SIZE_ANALYSIS),
- DIAG_UPPER_LIMIT = DIAG_START_REFACTORING + static_cast<int>(DIAG_SIZE_REFACTORING)
+ DIAG_START_INSTALLAPI = DIAG_START_REFACTORING + static_cast<int>(DIAG_SIZE_REFACTORING),
+ DIAG_UPPER_LIMIT = DIAG_START_INSTALLAPI + static_cast<int>(DIAG_SIZE_INSTALLAPI)
};
class CustomDiagInfo;
diff --git a/clang/include/clang/Basic/DiagnosticInstallAPI.h b/clang/include/clang/Basic/DiagnosticInstallAPI.h
new file mode 100644
index 00000000000000..a76f6e087a2b0a
--- /dev/null
+++ b/clang/include/clang/Basic/DiagnosticInstallAPI.h
@@ -0,0 +1,26 @@
+//===--- DiagnosticInstallAPI.h - Diagnostics for InstallAPI-----*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_BASIC_DIAGNOSTICINSTALLAPI_H
+#define LLVM_CLANG_BASIC_DIAGNOSTICINSTALLAPI_H
+
+#include "clang/Basic/Diagnostic.h"
+namespace clang {
+namespace diag {
+enum {
+#define DIAG(ENUM, FLAGS, DEFAULT_MAPPING, DESC, GROUP, SFINAE, NOWERROR, \
+ SHOWINSYSHEADER, SHOWINSYSMACRO, DEFERRABLE, CATEGORY) \
+ ENUM,
+#define INSTALLAPISTART
+#include "clang/Basic/DiagnosticInstallAPIKinds.inc"
+#undef DIAG
+ NUM_BUILTIN_INSTALLAPI_DIAGNOSTICS
+};
+} // namespace diag
+} // namespace clang
+#endif // LLVM_CLANG_BASIC_DIAGNOSTICINSTALLAPI_H
diff --git a/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td b/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td
new file mode 100644
index 00000000000000..31be4f09cf3a1c
--- /dev/null
+++ b/clang/include/clang/Basic/DiagnosticInstallAPIKinds.td
@@ -0,0 +1,20 @@
+//==--- DiagnosticInstallAPIKinds.td - installapi diagnostics -------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+//===----------------------------------------------------------------------===//
+// InstallAPI Diagnostics
+//===----------------------------------------------------------------------===//
+
+let Component = "InstallAPI" in {
+let CategoryName = "Command line" in {
+def err_cannot_write_file : Error<"cannot write file '%0': %1">;
+def err_no_install_name : Error<"no install name specified: add -install_name <path>">;
+def err_no_output_file: Error<"no output file specified">;
+} // end of command line category.
+
+} // end of InstallAPI component
diff --git a/clang/include/clang/InstallAPI/DylibVerifier.h b/clang/include/clang/InstallAPI/DylibVerifier.h
new file mode 100644
index 00000000000000..1a6121b3a258b5
--- /dev/null
+++ b/clang/include/clang/InstallAPI/DylibVerifier.h
@@ -0,0 +1,27 @@
+//===- InstallAPI/DylibVerifier.h -------------------------------*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_INSTALLAPI_DYLIBVERIFIER_H
+#define LLVM_CLANG_INSTALLAPI_DYLIBVERIFIER_H
+
+#include "llvm/TextAPI/Target.h"
+
+namespace clang {
+namespace installapi {
+
+/// A list of InstallAPI verification modes.
+enum class VerificationMode {
+ Invalid,
+ ErrorsOnly,
+ ErrorsAndWarnings,
+ Pedantic,
+};
+
+} // namespace installapi
+} // namespace clang
+#endif // LLVM_CLANG_INSTALLAPI_DYLIBVERIFIER_H
diff --git a/clang/include/clang/InstallAPI/InstallAPIDiagnostic.h b/clang/include/clang/InstallAPI/InstallAPIDiagnostic.h
new file mode 100644
index 00000000000000..547fb0bcf9a893
--- /dev/null
+++ b/clang/include/clang/InstallAPI/InstallAPIDiagnostic.h
@@ -0,0 +1,14 @@
+//===--- InstallAPIDiagnostic.h - Diagnostics for InstallAPI ----*- C++ -*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_INSTALLAPI_INSTALLAPIDIAGNOSTIC_H
+#define LLVM_CLANG_INSTALLAPI_INSTALLAPIDIAGNOSTIC_H
+
+#include "clang/Basic/DiagnosticInstallAPI.h"
+
+#endif
diff --git a/clang/lib/Basic/DiagnosticIDs.cpp b/clang/lib/Basic/DiagnosticIDs.cpp
index b353a6627f298b..4138b4ee4b0e5d 100644
--- a/clang/lib/Basic/DiagnosticIDs.cpp
+++ b/clang/lib/Basic/DiagnosticIDs.cpp
@@ -49,6 +49,7 @@ struct StaticDiagInfoDescriptionStringTable {
#include "clang/Basic/DiagnosticSemaKinds.inc"
#include "clang/Basic/DiagnosticAnalysisKinds.inc"
#include "clang/Basic/DiagnosticRefactoringKinds.inc"
+#include "clang/Basic/DiagnosticInstallAPIKinds.inc"
// clang-format on
#undef DIAG
};
@@ -70,7 +71,8 @@ const StaticDiagInfoDescriptionStringTable StaticDiagInfoDescriptions = {
#include "clang/Basic/DiagnosticSemaKinds.inc"
#include "clang/Basic/DiagnosticAnalysisKinds.inc"
#include "clang/Basic/DiagnosticRefactoringKinds.inc"
- // clang-format on
+#include "clang/Basic/DiagnosticInstallAPIKinds.inc"
+// clang-format on
#undef DIAG
};
@@ -95,7 +97,8 @@ const uint32_t StaticDiagInfoDescriptionOffsets[] = {
#include "clang/Basic/DiagnosticSemaKinds.inc"
#include "clang/Basic/DiagnosticAnalysisKinds.inc"
#include "clang/Basic/DiagnosticRefactoringKinds.inc"
- // clang-format on
+#include "clang/Basic/DiagnosticInstallAPIKinds.inc"
+// clang-format on
#undef DIAG
};
@@ -173,6 +176,7 @@ VALIDATE_DIAG_SIZE(CROSSTU)
VALIDATE_DIAG_SIZE(SEMA)
VALIDATE_DIAG_SIZE(ANALYSIS)
VALIDATE_DIAG_SIZE(REFACTORING)
+VALIDATE_DIAG_SIZE(INSTALLAPI)
#undef VALIDATE_DIAG_SIZE
#undef STRINGIFY_NAME
@@ -204,6 +208,7 @@ const StaticDiagInfoRec StaticDiagInfo[] = {
#include "clang/Basic/DiagnosticSemaKinds.inc"
#include "clang/Basic/DiagnosticAnalysisKinds.inc"
#include "clang/Basic/DiagnosticRefactoringKinds.inc"
+#include "clang/Basic/DiagnosticInstallAPIKinds.inc"
// clang-format on
#undef DIAG
};
@@ -246,6 +251,7 @@ CATEGORY(CROSSTU, COMMENT)
CATEGORY(SEMA, CROSSTU)
CATEGORY(ANALYSIS, SEMA)
CATEGORY(REFACTORING, ANALYSIS)
+CATEGORY(INSTALLAPI, REFACTORING)
#undef CATEGORY
// Avoid out of bounds reads.
diff --git a/clang/test/InstallAPI/driver-invalid-options.test b/clang/test/InstallAPI/driver-invalid-options.test
index a2e008e1eb03e7..69f3b2d66ab8b6 100644
--- a/clang/test/InstallAPI/driver-invalid-options.test
+++ b/clang/test/InstallAPI/driver-invalid-options.test
@@ -1,4 +1,9 @@
/// Check non-darwin triple is rejected.
-// RUN: not clang-installapi -target x86_64-unknown-unknown %s 2> %t
+// RUN: not clang-installapi -target x86_64-unknown-unknown %s -o tmp.tbd 2> %t
// RUN: FileCheck --check-prefix INVALID_INSTALLAPI -input-file %t %s
// INVALID_INSTALLAPI: error: unsupported option 'installapi' for target 'x86_64-unknown-unknown'
+
+/// Check that missing install_name is reported.
+// RUN: not clang-installapi -target x86_64-apple-ios-simulator %s -o tmp.tbd 2> %t
+// RUN: FileCheck --check-prefix INVALID_INSTALL_NAME -input-file %t %s
+// INVALID_INSTALL_NAME: error: no install name specified: add -install_name <path>
diff --git a/clang/test/InstallAPI/functions.test b/clang/test/InstallAPI/functions.test
index 527965303cb351..5b5fd1308842ed 100644
--- a/clang/test/InstallAPI/functions.test
+++ b/clang/test/InstallAPI/functions.test
@@ -4,7 +4,7 @@
// RUN: clang-installapi -target arm64-apple-macos13.1 \
// RUN: -I%t/usr/include -I%t/usr/local/include \
-// RUN: -install_name @rpath/lib/libfunctions.dylib \
+// RUN: -install_name @rpath/lib/libfunctions.dylib --filetype=tbd-v4 \
// RUN: %t/inputs.json -o %t/outputs.tbd 2>&1 | FileCheck %s --allow-empty
// RUN: llvm-readtapi -compare %t/outputs.tbd %t/expected.tbd 2>&1 | FileCheck %s --allow-empty
diff --git a/clang/tools/clang-installapi/CMakeLists.txt b/clang/tools/clang-installapi/CMakeLists.txt
index e05f4eac3ad198..b90ffc847b1558 100644
--- a/clang/tools/clang-installapi/CMakeLists.txt
+++ b/clang/tools/clang-installapi/CMakeLists.txt
@@ -2,13 +2,20 @@ set(LLVM_LINK_COMPONENTS
Support
TargetParser
TextAPI
+ TextAPIBinaryReader
Option
)
+set(LLVM_TARGET_DEFINITIONS InstallAPIOpts.td)
+tablegen(LLVM InstallAPIOpts.inc -gen-opt-parser-defs)
+add_public_tablegen_target(InstallAPIDriverOptions)
+
add_clang_tool(clang-installapi
ClangInstallAPI.cpp
Options.cpp
+ DEPENDS
+ InstallAPIDriverOptions
GENERATE_DRIVER
)
@@ -22,3 +29,4 @@ clang_target_link_libraries(clang-installapi
clangTooling
clangSerialization
)
+
diff --git a/clang/tools/clang-installapi/ClangInstallAPI.cpp b/clang/tools/clang-installapi/ClangInstallAPI.cpp
index 15b0baee88bc34..fdf7628cabd807 100644
--- a/clang/tools/clang-installapi/ClangInstallAPI.cpp
+++ b/clang/tools/clang-installapi/ClangInstallAPI.cpp
@@ -14,12 +14,12 @@
#include "Options.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticFrontend.h"
-#include "clang/Driver/Driver.h"
#include "clang/Driver/DriverDiagnostic.h"
#include "clang/Driver/Tool.h"
#include "clang/Frontend/TextDiagnosticPrinter.h"
#include "clang/InstallAPI/Frontend.h"
#include "clang/InstallAPI/FrontendRecords.h"
+#include "clang/InstallAPI/InstallAPIDiagnostic.h"
#include "clang/InstallAPI/MachO.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/ArrayRef.h"
@@ -92,22 +92,8 @@ static bool run(ArrayRef<const char *> Args, const char *ProgName) {
IntrusiveRefCntPtr<clang::FileManager> FM(
new FileManager(clang::FileSystemOptions(), OverlayFileSystem));
- // Set up driver to parse input arguments.
- auto DriverArgs = llvm::ArrayRef(Args).slice(1);
- clang::driver::Driver Driver(ProgName, llvm::sys::getDefaultTargetTriple(),
- *Diag, "clang installapi tool");
- auto TargetAndMode =
- clang::driver::ToolChain::getTargetAndModeFromProgramName(ProgName);
- Driver.setTargetAndMode(TargetAndMode);
- bool HasError = false;
- llvm::opt::InputArgList ArgList =
- Driver.ParseArgStrings(DriverArgs, /*UseDriverMode=*/true, HasError);
- if (HasError)
- return EXIT_FAILURE;
- Driver.setCheckInputsExist(false);
-
- // Capture InstallAPI specific options and diagnose any option errors.
- Options Opts(*Diag, FM.get(), ArgList);
+ // Capture all options and diagnose any errors.
+ Options Opts(*Diag, FM.get(), Args, ProgName);
if (Diag->hasErrorOccurred())
return EXIT_FAILURE;
@@ -161,7 +147,8 @@ static bool run(ArrayRef<const char *> Args, const char *ProgName) {
// Write output file and perform CI cleanup.
if (auto Err = TextAPIWriter::writeToStream(*Out, IF, Ctx.FT)) {
- Diag->Report(diag::err_cannot_open_file) << Ctx.OutputLoc;
+ Diag->Report(diag::err_cannot_write_file)
+ << Ctx.OutputLoc << std::move(Err);
CI->clearOutputFiles(/*EraseFiles=*/true);
return EXIT_FAILURE;
}
diff --git a/clang/tools/clang-installapi/InstallAPIOpts.td b/clang/tools/clang-installapi/InstallAPIOpts.td
new file mode 100644
index 00000000000000..87f4c3327e8409
--- /dev/null
+++ b/clang/tools/clang-installapi/InstallAPIOpts.td
@@ -0,0 +1,31 @@
+//===--- InstallAPIOpts.td ------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the specific options for InstallAPI.
+//
+//===----------------------------------------------------------------------===//
+
+// Include the common option parsing interfaces.
+include "llvm/Option/OptParser.td"
+
+
+/////////
+// Options
+
+// TextAPI options.
+def filetype : Joined<["--"], "filetype=">,
+ HelpText<"Specify the output file type (tbd-v4 or tbd-v5)">;
+
+// Verification options.
+def verify_against : Separate<["-"], "verify-against">,
+ HelpText<"Verify the specified dynamic library/framework against the headers">;
+def verify_against_EQ : Joined<["--"], "verify-against=">, Alias<verify_against>;
+def verify_mode_EQ : Joined<["--"], "verify-mode=">,
+ HelpText<"Specify the severity and extend of the validation. Valid modes are ErrorsOnly, ErrorsAndWarnings, and Pedantic.">;
+def demangle : Flag<["--", "-"], "demangle">,
+ HelpText<"Demangle symbols when printing warnings and errors">;
diff --git a/clang/tools/clang-installapi/Options.cpp b/clang/tools/clang-installapi/Options.cpp
index 70cb80f0fdb36f..7c8272a8ba7e05 100644
--- a/clang/tools/clang-installapi/Options.cpp
+++ b/clang/tools/clang-installapi/Options.cpp
@@ -10,35 +10,85 @@
#include "clang/Driver/Driver.h"
#include "clang/Frontend/FrontendDiagnostic.h"
#include "clang/InstallAPI/FileList.h"
+#include "clang/InstallAPI/InstallAPIDiagnostic.h"
#include "llvm/Support/Program.h"
#include "llvm/TargetParser/Host.h"
+#include "llvm/TextAPI/DylibReader.h"
+#include "llvm/TextAPI/TextAPIWriter.h"
-using namespace clang::driver;
-using namespace clang::driver::options;
+using namespace llvm;
using namespace llvm::opt;
using namespace llvm::MachO;
+namespace drv = clang::driver::options;
+
namespace clang {
namespace installapi {
+/// Create prefix string literals used in InstallAPIOpts.td.
+#define PREFIX(NAME, VALUE) \
+ static constexpr llvm::StringLiteral NAME##_init[] = VALUE; \
+ static constexpr llvm::ArrayRef<llvm::StringLiteral> NAME( \
+ NAME##_init, std::size(NAME##_init) - 1);
+#include "InstallAPIOpts.inc"
+#undef PREFIX
+
+static constexpr const llvm::StringLiteral PrefixTable_init[] =
+#define PREFIX_UNION(VALUES) VALUES
+#include "InstallAPIOpts.inc"
+#undef PREFIX_UNION
+ ;
+static constexpr const ArrayRef<StringLiteral>
+ PrefixTable(PrefixTable_init, std::size(PrefixTable_init) - 1);
+
+/// Create table mapping all options defined in InstallAPIOpts.td.
+static constexpr OptTable::Info InfoTable[] = {
+#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, \
+ VISIBILITY, PARAM, HELPTEXT, METAVAR, VALUES) \
+ {PREFIX, NAME, HELPTEXT, METAVAR, OPT_##ID, Option::KIND##Class, \
+ PARAM, FLAGS, VISIBILITY, OPT_##GROUP, OPT_##ALIAS, ALIASARGS, \
+ VALUES},
+#include "InstallAPIOpts.inc"
+#undef OPTION
+};
+
+namespace {
+
+/// \brief Create OptTable class for parsing actual command line arguments.
+class DriverOptTable : public opt::PrecomputedOptTable {
+public:
+ DriverOptTable() : PrecomputedOptTable(InfoTable, PrefixTable) {}
+};
+
+} // end anonymous namespace.
+
+static llvm::opt::OptTable *createDriverOptTable() {
+ return new DriverOptTable();
+}
+
bool Options::processDriverOptions(InputArgList &Args) {
// Handle inputs.
- llvm::append_range(DriverOpts.FileLists, Args.getAllArgValues(OPT_INPUT));
+ llvm::append_range(DriverOpts.FileLists,
+ Args.getAllArgValues(drv::OPT_INPUT));
// Handle output.
SmallString<PATH_MAX> OutputPath;
- if (auto *Arg = Args.getLastArg(OPT_o)) {
+ if (auto *Arg = Args.getLastArg(drv::OPT_o)) {
OutputPath = Arg->getValue();
if (OutputPath != "-")
FM->makeAbsolutePath(OutputPath);
DriverOpts.OutputPath = std::string(OutputPath);
}
+ if (DriverOpts.OutputPath.empty()) {
+ Diags->Report(diag::err_no_output_file);
+ return false;
+ }
// Do basic error checking first for mixing -target and -arch options.
- auto *ArgArch = Args.getLastArgNoClaim(OPT_arch);
- auto *ArgTarget = Args.getLastArgNoClaim(OPT_target);
+ auto *ArgArch = Args.getLastArgNoClaim(drv::OPT_arch);
+ auto *ArgTarget = Args.getLastArgNoClaim(drv::OPT_target);
auto *ArgTargetVariant =
- Args.getLastArgNoClaim(OPT_darwin_target_variant_triple);
+ Args.getLastArgNoClaim(drv::OPT_darwin_target_variant_triple);
if (ArgArch && (ArgTarget || ArgTargetVariant)) {
Diags->Report(clang::diag::err_drv_argument_not_allowed_with)
<< ArgArch->getAsString(Args)
@@ -46,7 +96,7 @@ bool Options::processDriverOptions(InputArgList &Args) {
return false;
}
- auto *ArgMinTargetOS = Args.getLastArgNoClaim(OPT_mtargetos_EQ);
+ auto *ArgMinTargetOS = Args.getLastArgNoClaim(drv::OPT_mtargetos_EQ);
if ((ArgTarget || ArgTargetVariant) && ArgMinTargetOS) {
Diags->Report(clang::diag::err_drv_cannot_mix_options)
<< ArgTarget->getAsString(Args) << ArgMinTargetOS->getAsString(Args);
@@ -55,7 +105,7 @@ bool Options::processDriverOptions(InputArgList &Args) {
// Capture target triples first.
if (ArgTarget) {
- for (const Arg *A : Args.filtered(OPT_target)) {
+ for (const Arg *A : Args.filtered(drv::OPT_target)) {
A->claim();
llvm::Triple TargetTriple(A->getValue());
Target TAPITarget = Target(TargetTriple);
@@ -69,30 +119,32 @@ bool Options::processDriverOptions(InputArgList &Args) {
}
}
- DriverOpts.Verbose = Args.hasArgNoClaim(OPT_v);
+ DriverOpts.Verbose = Args.hasArgNoClaim(drv::OPT_v);
return true;
}
bool Options::processLinkerOptions(InputArgList &Args) {
- // TODO: add error handling.
-
- // Required arguments.
- if (const Arg *A = Args.getLastArg(options::OPT_install__name))
+ // Handle required arguments.
+ if (const Arg *A = Args.getLastArg(drv::OPT_install__name))
LinkerOpts.InstallName = A->getValue();
+ if (LinkerOpts.InstallName.empty()) {
+ Diags->Report(diag::err_no_install_name);
+ return false;
+ }
// Defaulted or optional arguments.
- if (auto *Arg = Args.getLastArg(OPT_current__version))
+ if (auto *Arg = Args.getLastArg(drv::OPT_current__version))
LinkerOpts.CurrentVersion.parse64(Arg->getValue());
- if (auto *Arg = Args.getLastArg(OPT_compatibility__version))
+ if (auto *Arg = Args.getLastArg(drv::OPT_compatibility__version))
LinkerOpts.CompatVersion.parse64(Arg->getValue());
- LinkerOpts.IsDylib = Args.hasArg(OPT_dynamiclib);
+ LinkerOpts.IsDylib = Args.hasArg(drv::OPT_dynamiclib);
- LinkerOpts.AppExtensionSafe =
- Args.hasFlag(OPT_fapplication_extension, OPT_fno_application_extension,
- /*Default=*/LinkerOpts.AppExtensionSafe);
+ LinkerOpts.AppExtensionSafe = Args.hasFlag(
+ drv::OPT_fapplication_extension, drv::OPT_fno_application_extension,
+ /*Default=*/LinkerOpts.AppExtensionSafe);
if (::getenv("LD_NO_ENCRYPT") != nullptr)
LinkerOpts.AppExtensionSafe = true;
@@ -105,7 +157,7 @@ bool Options::processLinkerOptions(InputArgList &Args) {
bool Options::processFrontendOptions(InputArgList &Args) {
// Do not claim any arguments, as they will be passed along for CC1
// invocations.
- if (auto *A = Args.getLastArgNoClaim(OPT_x)) {
+ if (auto *A = Args.getLastArgNoClaim(drv::OPT_x)) {
FEOpts.LangMode = llvm::StringSwitch<clang::Language>(A->getValue())
.Case("c", clang::Language::C)
.Case("c++", clang::Language::CXX)
@@ -119,8 +171,8 @@ bool Options::processFrontendOptions(InputArgList &Args) {
return false;
}
}
- for (auto *A : Args.filtered(OPT_ObjC, OPT_ObjCXX)) {
- if (A->getOption().matches(OPT_ObjC))
+ for (auto *A : Args.filtered(drv::OPT_ObjC, drv::OPT_ObjCXX)) {
+ if (A->getOption().matches(drv::OPT_ObjC))
FEOpts.LangMode = clang::Language::ObjC;
else
FEOpts.LangMode = clang::Language::ObjCXX;
@@ -129,9 +181,77 @@ bool Options::processFrontendOptions(InputArgList &Args) {
return true;
}
+std::vector<const char *>
+Options::processAndFilterOutInstallAPIOptions(ArrayRef<const char *> Args) {
+ std::unique_ptr<llvm::opt::OptTable> Table;
+ Table.reset(createDriverOptTable());
+
+ unsigned MissingArgIndex, MissingArgCount;
+ auto ParsedArgs = Table->ParseArgs(Args.slice(1), MissingArgIndex,
+ MissingArgCount, Visibility());
+
+ // Capture InstallAPI only driver options.
+ DriverOpts.Demangle = ParsedArgs.hasArg(OPT_demangle);
+
+ if (auto *A = ParsedArgs.getLastArg(OPT_filetype)) {
+ DriverOpts.OutFT = TextAPIWriter::parseFileType(A->getValue());
+ if (DriverOpts.OutFT == FileType::Invalid) {
+ Diags->Report(clang::diag::err_drv_invalid_value)
+ << A->getAsString(ParsedArgs) << A->getValue();
+ return {};
+ }
+ }
+
+ if (const Arg *A = ParsedArgs.getLastArg(OPT_verify_mode_EQ)) {
+ DriverOpts.VerifyMode =
+ StringSwitch<VerificationMode>(A->getValue())
+ .Case("ErrorsOnly", VerificationMode::ErrorsOnly)
+ .Case("ErrorsAndWarnings", VerificationMode::ErrorsAndWarnings)
+ .Case("Pedantic", VerificationMode::Pedantic)
+ .Default(VerificationMode::Invalid);
+
+ if (DriverOpts.VerifyMode == VerificationMode::Invalid) {
+ Diags->Report(clang::diag::err_drv_invalid_value)
+ << A->getAsString(ParsedArgs) << A->getValue();
+ return {};
+ }
+ }
+
+ if (const Arg *A = ParsedArgs.getLastArg(OPT_verify_against))
+ DriverOpts.DylibToVerify = A->getValue();
+
+ /// Any unclaimed arguments should be forwarded to the clang driver.
+ std::vector<const char *> ClangDriverArgs(ParsedArgs.size());
+ for (const Arg *A : ParsedArgs) {
+ if (A->isClaimed())
+ continue;
+ llvm::copy(A->getValues(), std::back_inserter(ClangDriverArgs));
+ }
+ return ClangDriverArgs;
+}
+
Options::Options(DiagnosticsEngine &Diag, FileManager *FM,
- InputArgList &ArgList)
+ ArrayRef<const char *> Args, const StringRef ProgName)
: Diags(&Diag), FM(FM) {
+
+ // First process InstallAPI specific options.
+ auto DriverArgs = processAndFilterOutInstallAPIOptions(Args);
+ if (Diags->hasErrorOccurred())
+ return;
+
+ // Set up driver to parse remaining input arguments.
+ clang::driver::Driver Driver(ProgName, llvm::sys::getDefaultTargetTriple(),
+ *Diags, "clang installapi tool");
+ auto TargetAndMode =
+ clang::driver::ToolChain::getTargetAndModeFromProgramName(ProgName);
+ Driver.setTargetAndMode(TargetAndMode);
+ bool HasError = false;
+ llvm::opt::InputArgList ArgList =
+ Driver.ParseArgStrings(DriverArgs, /*UseDriverMode=*/true, HasError);
+ if (HasError)
+ return;
+ Driver.setCheckInputsExist(false);
+
if (!processDriverOptions(ArgList))
return;
@@ -145,7 +265,6 @@ Options::Options(DiagnosticsEngine &Diag, FileManager *FM,
for (const Arg *A : ArgList) {
if (A->isClaimed())
continue;
-
FrontendArgs.emplace_back(A->getSpelling());
llvm::copy(A->getValues(), std::back_inserter(FrontendArgs));
}
@@ -172,16 +291,37 @@ InstallAPIContext Options::createContext() {
for (const std::string &ListPath : DriverOpts.FileLists) {
auto Buffer = FM->getBufferForFile(ListPath);
if (auto Err = Buffer.getError()) {
- Diags->Report(diag::err_cannot_open_file) << ListPath;
+ Diags->Report(diag::err_cannot_open_file) << ListPath << Err.message();
return Ctx;
}
if (auto Err = FileListReader::loadHeaders(std::move(Buffer.get()),
Ctx.InputHeaders)) {
- Diags->Report(diag::err_cannot_open_file) << ListPath;
+ Diags->Report(diag::err_cannot_open_file) << ListPath << std::move(Err);
return Ctx;
}
}
+ // Parse binary dylib.
+ // TODO: Initialize verifier.
+ if (DriverOpts.DylibToVerify.empty())
+ return Ctx;
+
+ auto Buffer = FM->getBufferForFile(DriverOpts.DylibToVerify);
+ if (auto Err = Buffer.getError()) {
+ Diags->Report(diag::err_cannot_open_file)
+ << DriverOpts.DylibToVerify << Err.message();
+ return Ctx;
+ }
+
+ DylibReader::ParseOption PO;
+ PO.Undefineds = false;
+ Expected<Records> Slices =
+ DylibReader::readFile((*Buffer)->getMemBufferRef(), PO);
+ if (auto Err = Slices.takeError()) {
+ Diags->Report(diag::err_cannot_open_file) << DriverOpts.DylibToVerify;
+ return Ctx;
+ }
+
return Ctx;
}
diff --git a/clang/tools/clang-installapi/Options.h b/clang/tools/clang-installapi/Options.h
index e218d57b30518e..2beeafc86bb086 100644
--- a/clang/tools/clang-installapi/Options.h
+++ b/clang/tools/clang-installapi/Options.h
@@ -11,8 +11,10 @@
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/FileManager.h"
+#include "clang/Driver/Driver.h"
#include "clang/Frontend/FrontendOptions.h"
#include "clang/InstallAPI/Context.h"
+#include "clang/InstallAPI/DylibVerifier.h"
#include "clang/InstallAPI/MachO.h"
#include "llvm/Option/ArgList.h"
#include "llvm/Option/Option.h"
@@ -32,12 +34,21 @@ struct DriverOptions {
/// \brief Mappings of target triples & tapi targets to build for.
std::map<llvm::MachO::Target, llvm::Triple> Targets;
+ /// \brief Path to binary dylib for comparing.
+ std::string DylibToVerify;
+
/// \brief Output path.
std::string OutputPath;
/// \brief File encoding to print.
FileType OutFT = FileType::TBD_V5;
+ /// \brief Verification mode for comparing symbols.
+ VerificationMode VerifyMode = VerificationMode::Pedantic;
+
+ /// \brief Print demangled symbols when reporting errors.
+ bool Demangle = false;
+
/// \brief Print verbose output.
bool Verbose = false;
};
@@ -69,6 +80,8 @@ class Options {
bool processDriverOptions(llvm::opt::InputArgList &Args);
bool processLinkerOptions(llvm::opt::InputArgList &Args);
bool processFrontendOptions(llvm::opt::InputArgList &Args);
+ std::vector<const char *>
+ processAndFilterOutInstallAPIOptions(ArrayRef<const char *> Args);
public:
/// The various options grouped together.
@@ -83,7 +96,7 @@ class Options {
/// \brief Constructor for options.
Options(clang::DiagnosticsEngine &Diag, FileManager *FM,
- llvm::opt::InputArgList &Args);
+ ArrayRef<const char *> Args, const StringRef ProgName);
/// \brief Get CC1 arguments after extracting out the irrelevant
/// ones.
@@ -95,6 +108,16 @@ class Options {
std::vector<std::string> FrontendArgs;
};
+enum ID {
+ OPT_INVALID = 0, // This is not an option ID.
+#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, \
+ VISIBILITY, PARAM, HELPTEXT, METAVAR, VALUES) \
+ OPT_##ID,
+#include "InstallAPIOpts.inc"
+ LastOption
+#undef OPTION
+};
+
} // namespace installapi
} // namespace clang
#endif
More information about the cfe-commits
mailing list