LineageOS/android_development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Simplify the error message for ABI check

Browse Source 
- Remove "VNDK" from the message.
- Deprecate -elf-unreferenced-symbol-errors.
- Fix the status string for CompatibilityStatusIR::UnreferencedChanges.

Test: ./test.py
Bug: 249324120
Change-Id: I5a1fd64f9101caa29d87d9f65bd4d17b8bd77059
This commit is contained in:
Hsin-Yi Chen
2022-09-30 10:16:28 +08:00
parent fc212f2a34
commit f5f04a5b6c
1 changed files with 25 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
vndk/tools/header-checker/src/diff/header_abi_diff.cpp
View File

@@ -66,8 +66,7 @@ static llvm::cl::opt<bool> advice_only(
static llvm::cl::opt<bool> elf_unreferenced_symbol_errors(
"elf-unreferenced-symbol-errors",
llvm::cl::desc("Display erors on removal of elf symbols, unreferenced by"
"metadata in exported headers."),
llvm::cl::desc("This option is deprecated and has no effect."),
llvm::cl::Optional, llvm::cl::cat(header_checker_category));
static llvm::cl::opt<bool> check_all_apis(
@@ -205,17 +204,24 @@ static void ReadConfigFile(const std::string &config_file_path) {
}
}
static const char kWarn[] = "\033[36;1mwarning: \033[0m";
static const char kError[] = "\033[31;1merror: \033[0m";
bool ShouldEmitWarningMessage(CompatibilityStatusIR status) {
return ((!allow_extensions &&
(status & CompatibilityStatusIR::Extension)) ||
(!allow_unreferenced_changes &&
(status & CompatibilityStatusIR::UnreferencedChanges)) ||
(!allow_unreferenced_elf_symbol_changes &&
(status & CompatibilityStatusIR::ElfIncompatible)) ||
(status & CompatibilityStatusIR::Incompatible));
static std::string GetErrorMessage(CompatibilityStatusIR status) {
if (status & CompatibilityStatusIR::Incompatible) {
return "INCOMPATIBLE CHANGES";
}
if (!allow_unreferenced_elf_symbol_changes &&
(status & CompatibilityStatusIR::ElfIncompatible)) {
return "ELF Symbols not referenced by exported headers removed";
}
if (!allow_extensions && (status & CompatibilityStatusIR::Extension)) {
return "EXTENDING CHANGES";
}
if (!allow_unreferenced_changes &&
(status & CompatibilityStatusIR::UnreferencedChanges)) {
return "changes in exported headers, which are not directly referenced "
"by exported symbols. This MIGHT be an ABI breaking change due to "
"internal typecasts";
}
return "";
}
int main(int argc, const char **argv) {
@@ -244,55 +250,18 @@ int main(int argc, const char **argv) {
CompatibilityStatusIR status = judge.GenerateCompatibilityReport();
std::string status_str = "";
std::string unreferenced_change_str = "";
std::string error_or_warning_str = kWarn;
switch (status) {
case CompatibilityStatusIR::Incompatible:
error_or_warning_str = kError;
status_str = "INCOMPATIBLE CHANGES";
break;
case CompatibilityStatusIR::ElfIncompatible:
if (elf_unreferenced_symbol_errors) {
error_or_warning_str = kError;
}
status_str = "ELF Symbols not referenced by exported headers removed";
break;
default:
break;
}
if (status & CompatibilityStatusIR::Extension) {
if (!allow_extensions) {
error_or_warning_str = kError;
}
status_str = "EXTENDING CHANGES";
}
if (status & CompatibilityStatusIR::UnreferencedChanges) {
unreferenced_change_str = ", changes in exported headers, which are";
unreferenced_change_str += " not directly referenced by exported symbols.";
unreferenced_change_str += " This MIGHT be an ABI breaking change due to";
unreferenced_change_str += " internal typecasts.";
}
bool should_emit_warning_message = ShouldEmitWarningMessage(status);
if (should_emit_warning_message) {
std::string status_str = GetErrorMessage(status);
if (!status_str.empty()) {
llvm::errs() << "******************************************************\n"
<< error_or_warning_str
<< "VNDK library: "
<< "\033[31;1merror: \033[0m"
<< lib_name
<< "'s ABI has "
<< status_str
<< unreferenced_change_str
<< " Please check compatibility report at: "
<< ". Please check compatibility report at: "
<< compatibility_report << "\n"
<< "******************************************************\n";
}
if (!advice_only && should_emit_warning_message) {
return status;
}
return CompatibilityStatusIR::Compatible;
return (advice_only || status_str.empty()) ? CompatibilityStatusIR::Compatible
: status;
}