mirror of
git://sourceware.org/git/libabigail.git
synced 2024-12-26 03:32:08 +00:00
2f296a7846
* doc/manuals/Makefile: New file, generated by sphinx-quickstart. * doc/manuals/abidiff.rst: New manual for abidiff. * doc/manuals/abidw.rst: New manual for abidw. * doc/manuals/abilint.rst: New manual for abilint. * doc/manuals/conf.py: New configuration file generated by sphinx-quickstart. * doc/manuals/index.rst: The root of the this documentation. * doc/manuals/libabigail-overview.rst: The overview of libabigail. * doc/manuals/tools.rst: The root of the tools manuals. Signed-off-by: Dodji Seketeli <dodji@redhat.com>
44 lines
1.9 KiB
ReStructuredText
44 lines
1.9 KiB
ReStructuredText
#######################
|
|
Overview of Libabigail
|
|
#######################
|
|
|
|
Libabigail stands for the Application Binary Interface Generic
|
|
Analysis and Instrumentation Library.
|
|
|
|
It aims at helping developers and software distributors to spot some
|
|
ABI-related issues like interface incompatibility in `ELF`_ shared
|
|
libraries.
|
|
|
|
The type of interface incompatibilities that ``libabigail`` focuses on
|
|
is related to changes on the exported ELF functions and variables
|
|
symbols, as well as layout and size changes of data types of the
|
|
functions and variables exported by shared libraries.
|
|
|
|
In other words, if the return type of a function exported by a shared
|
|
library changes in an incompatible way from one version of a given
|
|
shared library to another, we want ``libabigail`` to help people catch
|
|
that.
|
|
|
|
In more concrete terms, ``libabigail`` can parse a shared library in
|
|
`ELF`_ format, accompanied with its associated debug information in
|
|
`DWARF`_ format, build an internal representation of all the functions
|
|
and variables it exports, along with their types. It also builds an
|
|
internal representation of the `ELF_ symbols`_ of these functions and
|
|
variables. That information about these exported functions and
|
|
variables is roughly what we consider as being the ABI of the shared
|
|
library, at least, in the scope of Libabigail.
|
|
|
|
Aside of this internal representation, ``libabigail`` provides
|
|
facilities to perform deep comparisons of two ABIs. That is, it can
|
|
compare the types of two sets of functions or variables and represents
|
|
the result in a way that allows it to emit textual reports about the
|
|
differences.
|
|
|
|
This allows us to write tools like :doc:`abidiff` that can compare the
|
|
ABI of two shared libraries and represent the result in a meaningful
|
|
enough way to help us spot ABI incompatibilities.
|
|
|
|
.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
|
|
.. _DWARF: http://www.dwarfstd.org
|
|
.. _Elf symbols: https://blogs.oracle.com/ali/entry/inside_elf_symbol_tables
|