Skip to content

ABI/API checker: abort after error occurs while importing a module #26773

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 3 commits into from
Aug 22, 2019
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
6 changes: 6 additions & 0 deletions test/api-digester/Outputs/empty-baseline.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"kind": "Root",
"name": "TopLevel",
"printedName": "TopLevel",
"json_format_version": 1
}
8 changes: 8 additions & 0 deletions test/api-digester/dump-empty-baseline.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// REQUIRES: OS=macosx
// RUN: %empty-directory(%t.mod)
// RUN: %empty-directory(%t.sdk)
// RUN: %empty-directory(%t.module-cache)
// RUN: %api-digester -generate-empty-baseline -o %t.result -avoid-tool-args
// RUN: diff -u %S/Outputs/empty-baseline.json %t.result
// RUN: %api-digester -deserialize-sdk -input-paths %S/Outputs/empty-baseline.json -o %t.result
// RUN: diff -u %S/Outputs/empty-baseline.json %t.result
34 changes: 24 additions & 10 deletions tools/swift-api-digester/ModuleAnalyzerNodes.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2070,16 +2070,24 @@ void SwiftDeclCollector::serialize(StringRef Filename) {
SwiftDeclCollector::serialize(Filename, RootNode);
}

SDKNodeRoot *
swift::ide::api::getEmptySDKNodeRoot(SDKContext &SDKCtx) {
SwiftDeclCollector Collector(SDKCtx);
return Collector.getSDKRoot();
}

SDKNodeRoot*
swift::ide::api::getSDKNodeRoot(SDKContext &SDKCtx,
const CompilerInvocation &InitInvok,
const llvm::StringSet<> &ModuleNames,
CheckerOptions Opts) {
const llvm::StringSet<> &ModuleNames) {
CheckerOptions Opts = SDKCtx.getOpts();
CompilerInvocation Invocation(InitInvok);

CompilerInstance &CI = SDKCtx.newCompilerInstance();
// Display diagnostics to stderr.
PrintingDiagnosticConsumer PrintDiags;
PrintingDiagnosticConsumer PrintDiags(llvm::errs());
if (llvm::errs().has_colors())
PrintDiags.forceColors();
CI.addDiagnosticConsumer(&PrintDiags);
if (CI.setup(Invocation)) {
llvm::errs() << "Failed to setup the compiler instance\n";
Expand All @@ -2102,7 +2110,7 @@ swift::ide::api::getSDKNodeRoot(SDKContext &SDKCtx,
if (Opts.Verbose)
llvm::errs() << "Loading module: " << Name << "...\n";
auto *M = Ctx.getModuleByName(Name);
if (!M || M->failedToLoad()) {
if (!M || M->failedToLoad() || Ctx.Diags.hadAnyError()) {
llvm::errs() << "Failed to load module: " << Name << '\n';
if (Opts.AbortOnModuleLoadFailure)
return nullptr;
Expand All @@ -2118,18 +2126,24 @@ swift::ide::api::getSDKNodeRoot(SDKContext &SDKCtx,
return Collector.getSDKRoot();
}

void swift::ide::api::dumpSDKRoot(SDKNodeRoot *Root, StringRef OutputFile) {
assert(Root);
auto Opts = Root->getSDKContext().getOpts();
if (Opts.Verbose)
llvm::errs() << "Dumping SDK...\n";
SwiftDeclCollector::serialize(OutputFile, Root);
if (Opts.Verbose)
llvm::errs() << "Dumped to "<< OutputFile << "\n";
}

int swift::ide::api::dumpSDKContent(const CompilerInvocation &InitInvok,
const llvm::StringSet<> &ModuleNames,
StringRef OutputFile, CheckerOptions Opts) {
SDKContext SDKCtx(Opts);
SDKNode *Root = getSDKNodeRoot(SDKCtx, InitInvok, ModuleNames, Opts);
SDKNodeRoot *Root = getSDKNodeRoot(SDKCtx, InitInvok, ModuleNames);
if (!Root)
return 1;
if (Opts.Verbose)
llvm::errs() << "Dumping SDK...\n";
SwiftDeclCollector::serialize(OutputFile, Root);
if (Opts.Verbose)
llvm::errs() << "Dumped to "<< OutputFile << "\n";
dumpSDKRoot(Root, OutputFile);
return 0;
}

Expand Down
7 changes: 5 additions & 2 deletions tools/swift-api-digester/ModuleAnalyzerNodes.h
Original file line number Diff line number Diff line change
Expand Up @@ -747,8 +747,11 @@ int dumpSwiftModules(const CompilerInvocation &InitInvok,

SDKNodeRoot *getSDKNodeRoot(SDKContext &SDKCtx,
const CompilerInvocation &InitInvok,
const llvm::StringSet<> &ModuleNames,
CheckerOptions Opts);
const llvm::StringSet<> &ModuleNames);

SDKNodeRoot *getEmptySDKNodeRoot(SDKContext &SDKCtx);

void dumpSDKRoot(SDKNodeRoot *Root, StringRef OutputFile);

int dumpSDKContent(const CompilerInvocation &InitInvok,
const llvm::StringSet<> &ModuleNames,
Expand Down
20 changes: 14 additions & 6 deletions tools/swift-api-digester/swift-api-digester.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ namespace {
DeserializeSDK,
GenerateNameCorrectionTemplate,
FindUsr,
GenerateEmptyBaseline,
};
} // end anonymous namespace

Expand Down Expand Up @@ -173,7 +174,10 @@ Action(llvm::cl::desc("Mode:"), llvm::cl::init(ActionType::None),
"Find USR for decls by given condition"),
clEnumValN(ActionType::GenerateNameCorrectionTemplate,
"generate-name-correction",
"Generate name correction template")));
"Generate name correction template"),
clEnumValN(ActionType::GenerateEmptyBaseline,
"generate-empty-baseline",
"Generate an empty baseline")));

static llvm::cl::list<std::string>
SDKJsonPaths("input-paths",
Expand Down Expand Up @@ -2464,13 +2468,12 @@ static CheckerOptions getCheckOpts(int argc, char *argv[]) {
return Opts;
}

static SDKNodeRoot *getSDKRoot(const char *Main, SDKContext &Ctx,
CheckerOptions Opts, bool IsBaseline) {
static SDKNodeRoot *getSDKRoot(const char *Main, SDKContext &Ctx, bool IsBaseline) {
CompilerInvocation Invok;
llvm::StringSet<> Modules;
if (prepareForDump(Main, Invok, Modules, IsBaseline))
return nullptr;
return getSDKNodeRoot(Ctx, Invok, Modules, Opts);
return getSDKNodeRoot(Ctx, Invok, Modules);
}

static bool hasBaselineInput() {
Expand Down Expand Up @@ -2521,8 +2524,8 @@ int main(int argc, char *argv[]) {
std::move(protocolWhitelist));
else {
SDKContext Ctx(Opts);
return diagnoseModuleChange(Ctx, getSDKRoot(argv[0], Ctx, Opts, true),
getSDKRoot(argv[0], Ctx, Opts, false),
return diagnoseModuleChange(Ctx, getSDKRoot(argv[0], Ctx, true),
getSDKRoot(argv[0], Ctx, false),
options::OutputFile,
std::move(protocolWhitelist));
}
Expand Down Expand Up @@ -2551,6 +2554,11 @@ int main(int argc, char *argv[]) {
Store.addStorePath(Paths[I]);
return deserializeNameCorrection(Store, options::OutputFile);
}
case ActionType::GenerateEmptyBaseline: {
SDKContext Ctx(Opts);
dumpSDKRoot(getEmptySDKNodeRoot(Ctx), options::OutputFile);
return 0;
}
case ActionType::FindUsr: {
if (options::SDKJsonPaths.size() != 1) {
llvm::cl::PrintHelpMessage();
Expand Down
9 changes: 7 additions & 2 deletions utils/api_checker/swift-api-checker.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,13 @@ def escapeCmdArg(arg):
def check_call(cmd, cwd=None, env=os.environ, verbose=False, output=None):
if verbose:
print(' '.join([escapeCmdArg(arg) for arg in cmd]))
return subprocess.check_call(cmd, cwd=cwd, env=env,
stderr=None, stdout=output)
try:
subprocess.check_call(cmd, cwd=cwd, env=env,
stderr=None, stdout=output)
return 0
except Exception as error:
printerr(error)
return 1


def check_output(cmd, verbose=False):
Expand Down