abi-compliance-checker

NAME

abi-compliance-checker - tool to compare ABI compatibility of shared C/C++ library versions

DESCRIPTION

NAME:

ABI Compliance Checker (abi-compliance-checker) Check backward compatibility of a C/C++ library API

DESCRIPTION:

ABI Compliance Checker (ABICC) is a tool for checking backward binary compatibility and backward source compatibility of a C/C++ library API.

The tool analyzes changes in API and ABI (ABI=API+compiler ABI) that may break binary compatibility and/or source compatibility: changes in calling stack, v-table changes, removed symbols, renamed fields, etc.

Binary incompatibility may result in crashing or incorrect behavior of applications built with an old version of a library if they run on a new one. Source incompatibility may result in recompilation errors with a new library version.

The tool can create and compare ABI dumps for header files and shared objects of a library. The ABI dump for a library can also be created by the ABI Dumper tool (https://github.com/lvc/abi-dumper) if shared objects include debug-info.

The tool is intended for developers of software libraries and maintainers of operating systems who are interested in ensuring backward compatibility, i.e. allow old applications to run or to be recompiled with newer library versions.

Also the tool can be used by ISVs for checking applications portability to new library versions. Found issues can be taken into account when adapting the application to a new library version.

This tool is free software: you can redistribute it and/or modify it under the terms of the GNU LGPL 2.1.

USAGE #1 (WITH ABI DUMPER):

1. Library should be compiled with "-g -Og" GCC options

to contain DWARF debug info

2. Create ABI dumps for both library versions

using the ABI Dumper (https://github.com/lvc/abi-dumper) tool:

abi-dumper OLD.so -o ABI-0.dump -lver 0 abi-dumper NEW.so -o ABI-1.dump -lver 1

3. You can filter public ABI with the help of

additional -public-headers option of the ABI Dumper tool.

4. Compare ABI dumps to create report:

abi-compliance-checker -l NAME -old ABI-0.dump -new ABI-1.dump

USAGE #2 (ORIGINAL):

1. Create XML-descriptors for two versions

of a library (OLD.xml and NEW.xml):

<version>

1.0

</version>

<headers>

/path/to/headers/

</headers>

<libs>

/path/to/libraries/

</libs>

2. Compare Xml-descriptors to create report:

abi-compliance-checker -lib NAME -old OLD.xml -new NEW.xml

USAGE #3 (CREATE ABI DUMPS):

1. Create XML-descriptors for two versions

of a library (OLD.xml and NEW.xml):

<version>

1.0

</version>

<headers>

/path/to/headers/

</headers>

<libs>

/path/to/libraries/

</libs>

2. Create ABI dumps:

abi-compliance-checker -lib NAME -dump OLD.xml -dump-path ./ABI-0.dump abi-compliance-checker -lib NAME -dump NEW.xml -dump-path ./ABI-1.dump

3. Compare ABI dumps to create report:

abi-compliance-checker -l NAME -old ABI-0.dump -new ABI-1.dump

INFO OPTIONS:

Print this help.

Print complete info including all options.

Print version information.

Print the tool version (2.3) and don't do anything else.

GENERAL OPTIONS:

Any name of the library.

Descriptor of the 1st (old) library version. It may be one of the following:

1. ABI dump generated by the ABI Dumper tool 2. XML-descriptor (*.xml file):

<version>

1.0

</version>

<headers>

/path1/to/header(s)/ /path2/to/header(s)/

...

</headers>

<libs>

/path1/to/library(ies)/ /path2/to/library(ies)/

...

</libs>

...

3. ABI dump generated by -dump option 4. Directory with headers and libraries 5. Single header file

If you are using 4-5 descriptor types then you should specify version numbers with -v1 and -v2 options.

For more information, please see:

https://lvc.github.io/abi-compliance-checker/Xml-Descriptor.html

Descriptor of the 2nd (new) library version.

Create library ABI dump for the input XML descriptor. You can transfer it anywhere and pass instead of the descriptor. Also it can be used for debugging the tool.

A path to XML descriptor with skip_* rules to filter analyzed symbols in the report.

EXTRA OPTIONS:

Debugging mode. Print debug info on the screen. Save intermediate analysis stages in the debug directory:

debug/LIB_NAME/VERSION/

Also consider using -dump option for debugging the tool.

If your library A is supposed to be used by other library B and you want to control the ABI of B, then you should enable this option. The tool will check for changes in all data types, even if they are not used by any function in the library A. Such data types are not part of the A library ABI, but may be a part of the ABI of the B library.

The short scheme is:

app C (broken) -> lib B (broken ABI) -> lib A (stable ABI)

Check static libraries instead of the shared ones. The <libs> section of the XML-descriptor should point to static libraries location.

Path to the cross GCC compiler to use instead of the usual (host) GCC.

GCC toolchain prefix.

Additional compiler options.

Count total public symbols in the ABI dump.

Make dumps for two versions of a library and compare dumps. This should increase the performance of the tool and decrease the system memory usage.

Alias for: --report-format=xml or --dump-format= xml

This option allows one to specify the application that should be checked for portability to the new library version.

Check header files without libraries. It is easy to run, but may provide a low quality compatibility report with false positives and without detecting of added/removed symbols.

Specify 1st library version outside the descriptor. This option is needed if you have preferred an alternative descriptor type (see -d1 option).

In general case you should specify it in the XML-descriptor:

<version>

VERSION

</version>

Specify 2nd library version outside the descriptor.

Replace {RELPATH} macros to PATH in the 1st XML-descriptor ( -d1).

Replace {RELPATH} macros to PATH in the 2nd XML-descriptor ( -d2).

TEST OPTIONS:

Run internal tests. Create two binary incompatible versions of a sample library and run the tool to check them for compatibility. This option allows one to check if the tool works correctly in the current environment.

Test ability to create, read and compare ABI dumps.

Compare ABI dumps created by the ABI Dumper tool.

REPORT OPTIONS:

Show binary compatibility problems only. Generate report to:

compat_reports/LIB_NAME/V1_to_V2/abi_compat_report.html

Show source compatibility problems only. Generate report to:

compat_reports/LIB_NAME/V1_to_V2/src_compat_report.html

Treat all compatibility warnings as problems. Add a number of "Low" severity problems to the return value of the tool.

REPORT PATH OPTIONS:

Path to compatibility report. Default:

compat_reports/LIB_NAME/V1_to_V2/compat_report.html

Path to binary compatibility report. Default:

compat_reports/LIB_NAME/V1_to_V2/abi_compat_report.html

Path to source compatibility report. Default:

compat_reports/LIB_NAME/V1_to_V2/src_compat_report.html

REPORT FORMAT OPTIONS:

Show the symbol's return type in the report.

Print analysis results (compatibility reports and ABI dumps) to stdout instead of creating a file. This would allow piping data to other programs.

Change format of compatibility report. Formats:

htm - HTML format (default) xml - XML format

Generate old-style report.

Change library name in the report title to NAME. By default will be displayed a name specified by -l option.

The component name in the title and summary of the HTML report. Default:

library

Path to file with the function parameter names. It can be used for improving report view if the library header files have no parameter names. File format:

func1;param1;param2;param3 ... func2;param1;param2;param3 ...

...

The maximum number of affected symbols listed under the description of the changed type in the report.

Generate file with the list of incompatible symbols beside the HTML compatibility report. Use 'c++filt @file' command from GNU binutils to unmangle C++ symbols in the generated file. Default names:

abi_affected.txt src_affected.txt

ABI DUMP OPTIONS:

Specify a *.dump file path where to generate an ABI dump. Default:

abi_dumps/LIB_NAME/VERSION/ABI.dump

Change format of ABI dump. Formats:

perl - Data::Dumper format (default) xml - XML format

Check completeness of the ABI dump.

Dump extra info to DIR.

Create extended ABI dump containing all symbols from the translation unit.

Replace {RELPATH} macros to PATH in the XML-descriptor used for dumping the library ABI (see -dump option).

Specify the library version in the generated ABI dump. The <version> section of the input XML descriptor will be overwritten in this case.

Enable sorting of data in ABI dumps.

FILTER SYMBOLS OPTIONS:

This option allows one to specify a file with a list of symbols (mangled names in C++) that should be checked. Other symbols will not be checked.

This option allows one to specify a file with a list of types that should be checked. Other types will not be checked.

The list of symbols that should not be checked.

The list of types that should not be checked.

Do not check symbols matched by the regular expression.

Do not check types matched by the regular expression. It's matched against full qualified type names (e.g. 'struct xyz::Name<T>'). It has to match any part of type name.

Check _ZS*, _ZNS* and _ZNKS* symbols.

Report changes in reserved fields.

FILTER HEADERS OPTIONS:

The file with the list of header files, that should not be checked.

The file with a list of headers, that should be checked/dumped.

Check/Dump ABI of this header only.

Do not search in GCC standard system directories for header files.

Apply a set of heuristics to successfully compile input header files. You can enable several tolerance levels by joining them into one string (e.g. 13, 124, etc.). Levels:

1 - skip non-Linux headers (e.g. win32_*.h, etc.) 2 - skip internal headers (e.g. *_p.h, impl/*.h, etc.) 3 - skip headers that include non-Linux headers 4 - skip headers included by others

Enable highest tolerance level [1234].

Skip header files in 'headers' and 'include_preamble' sections of the XML descriptor that cannot be found. This is useful if you are trying to use the same descriptor for different targets.

FILTER RULES OPTIONS:

Do not report a problem if type is covered or uncovered by typedef (useful for broken debug info).

Check data types from the private part of the ABI when comparing ABI dumps created by the ABI Dumper tool with use of the -public-headers option.

Requires ABI Dumper >= 0.99.14

Do not check for changes in constants.

Do not detect added constants.

Do not detect removed constants.

OTHER OPTIONS:

Set library language (C or C++). You can use this option if the tool cannot auto-detect a language. This option may be useful for checking C-library headers ( --lang=C) in --headers-only or --extended modes.

Set library architecture (x86, x86_64, ia64, arm, ppc32, ppc64, s390, ect.). The option is useful if the tool cannot detect correct architecture of the input objects.

If input header files are compatible with the MinGW GCC compiler, then you can tell the tool about this and speedup the analysis.

Set this option if input C header files use C++ keywords. The tool will try to replace such keywords at preprocessor stage and replace them back in the final TU dump.

Do nothing.

Quick analysis. Disable check of some template instances.

Try to enable this option if the tool checked not all types and symbols in header files.

OS ANALYSIS OPTIONS:

Find all the shared libraries and header files in DIR directory, create XML descriptors and make ABI dumps for each library. The result set of ABI dumps can be compared ( --cmp-systems) with the other one created for other version of operating system in order to check them for compatibility. Do not forget to specify -cross-gcc option if your target system requires some specific version of GCC compiler (different from the host GCC). The system ABI dump will be generated to:

sys_dumps/NAME/ARCH

The same as the previous option but takes an XML descriptor of the target system as input, where you should describe it:

/* Primary sections */

<name>

/* Name of the system */

</name>

<headers>

/* The list of paths to header files and/or

directories with header files, one per line */

</headers>

<libs>

/* The list of paths to shared libraries and/or

directories with shared libraries, one per line */

</libs>

/* Optional sections */

<search_headers>

/* List of directories to be searched

for header files to automatically generate include paths, one per line */

</search_headers>

<search_libs>

/* List of directories to be searched

for shared libraries to resolve dependencies, one per line */

</search_libs>

<tools>

/* List of directories with tools used

for analysis (GCC toolchain), one per line */

</tools>

<cross_prefix>

/* GCC toolchain prefix.

Examples:

arm-linux-gnueabi arm-none-symbianelf */

</cross_prefix>

<gcc_options>

/* Additional GCC options, one per line */

</gcc_options>

Compare two ABI dumps of a system. Create compatibility reports for each system library and the common HTML report including the summary of test results for all checked libraries.

Summary report will be generated to:

sys_compat_reports/NAME1_to_NAME2/ARCH

Specify the alternative root directory. The tool will search for include paths in the DIR/usr/include and DIR/usr/lib directories.

This option should be used with -dump-system option to dump ABI of operating systems and configure the dumping process.

The file with a list of libraries, that should be dumped by the -dump-system option or should be checked by the -cmp-systems option.

LOGGING OPTIONS:

Log path for all messages. Default:

logs/LIB_NAME/VERSION/log.txt

Log path for 1st version of a library. Default:

logs/LIB_NAME/V1/log.txt

Log path for 2nd version of a library. Default:

logs/LIB_NAME/V2/log.txt

Change logging mode. Modes:

w - overwrite old logs (default) a - append old logs n - do not write any logs

Print all messages to the file instead of stdout and stderr. Default path (can be changed by -log-path option):

logs/run.log

REPORT PATH:

Compatibility report will be generated to:

compat_reports/LIB_NAME/V1_to_V2/compat_report.html

LOG PATH:

Log will be generated to:

logs/LIB_NAME/V1/log.txt logs/LIB_NAME/V2/log.txt

EXIT CODES:

0 - Compatible. The tool has run without any errors. non-zero - Incompatible or the tool has run with errors.

MORE INFO:

https://lvc.github.io/abi-compliance-checker/ https://github.com/lvc/abi-compliance-checker

AUTHOR

This manual page was written by Mathieu Malaterre <[email protected]> for the Debian GNU/Linux system (but may be used by others). Written by Andrey Ponomarenko.

COPYRIGHT

Copyright © 2018 Andrey Ponomarenko's ABI Laboratory License: GNU LGPL 2.1 <http://www.gnu.org/licenses/> This program is free software: you can redistribute it and/or modify it.