| commit | 0659b3b0a23e3535f41c6fd8dee5255ad8e29f7e | [log] [tgz] |
|---|---|---|
| author | Kier Davis <me@kierdavis.com> | Mon Sep 13 08:41:05 2021 -0500 |
| committer | Kier Davis <me@kierdavis.com> | Mon Sep 13 08:41:05 2021 -0500 |
| tree | 41d322dc6fdd6a379614bb112214df5c6a9938ec | |
| parent | 8caa4417e5ccbd1cbf6add727842e205d6568cb4 [diff] |
add statx to list of ignored functions
statx (like stat, wait, flock, sysinfo) is both the name of a function:
/usr/include/bits/statx-generic.h:int statx (int __dirfd, const char *__restrict __path, int __flags,
/usr/include/bits/statx-generic.h: unsigned int __mask, struct statx *__restrict __buf)
and a struct:
/usr/include/linux/stat.h:struct statx {
...
/usr/include/linux/stat.h:};
Typically `statx` always denotes the function and `struct statx` denotes the struct.
When usage of the struct is encountered in C++ code, abi-compliance-checker generates this line in dump1.h:
statx* tmp_add_class_66;
which fails to compile:
/tmp/qktDQcucCm/dump1.h:103:3: error: 'statx' does not name a type
statx* tmp_add_class_66;
^~~~~
Ideally abi-compliance-checker should instead generate this in dump1.h:
struct statx* tmp_add_class_66;
but determining when the `struct` qualifier should/shouldn't be used seems non-trivial, so lets take the same approach as we do for other similarly overloaded names.
ABI Compliance Checker (ABICC) — a tool for checking backward binary and source-level compatibility of a C/C++ software library.
The tool analyzes changes in API/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.
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 Linux maintainers who are interested in ensuring backward compatibility, i.e. allow old applications to run or to be recompiled with newer library versions.
The tool is a core of the ABI Tracker and Upstream Tracker projects: https://abi-laboratory.pro/tracker/
The tool is developed by Andrey Ponomarenko.
sudo make install prefix=/usr
Library should be compiled with -g -Og GCC options to contain DWARF debug info
Create ABI dumps for both library versions using the ABI Dumper (https://github.com/lvc/abi-dumper) tool:
abi-dumper OLD.so -o ABI-1.dump -lver 1 abi-dumper NEW.so -o ABI-2.dump -lver 2
You can filter public ABI with the help of additional -public-headers option of the ABI Dumper tool
Compare ABI dumps to create report:
abi-compliance-checker -l NAME -old ABI-1.dump -new ABI-2.dump
abi-compliance-checker -lib NAME -old OLD.xml -new NEW.xml
OLD.xml and NEW.xml are XML-descriptors:
<version>
1.0
</version>
<headers>
/path/to/headers/
</headers>
<libs>
/path/to/libraries/
</libs>
For advanced usage, see doc/index.html or output of -help option.
The tool is tested properly in the ABI Tracker and Upstream Tracker projects, by the community and by the internal test suite:
abi-compliance-checker -test
There are about 100 test cases for C and 200 test cases for C++ API/ABI breaks.