Bug: 204597573

Clone this repo:
  1. 0b983f2 Merge branch upstream-master into master by Matthias Maennich · 2 weeks ago master
  2. 779a937 Fix compatibility with GCC 8 by Matthias Maennich · 2 weeks ago upstream-master
  3. 1337601 ELF loader: implement getting an optional section by name by Aleksei Vetrov · 3 weeks ago
  4. 11a7f07 ELF loader: move ELF wrappers into anonymous namespace by Aleksei Vetrov · 3 weeks ago
  5. 1f7e286 ELF loader: fix nullptr access in `GetSectionsByName` by Aleksei Vetrov · 3 weeks ago

Symbol-Type Graph (STG)

The STG (symbol-type graph) is an ABI representation and this project contains tools for the creation and comparison of such representations. At present parsers exist for libabigail's ABI XML (C types only) and BTF. The ABI diff tool, stgdiff, supports multiple reporting options.

This software currently depends on libxml2 for XML parsing, on libelf to find .BTF sections and on Linux UAPI headers for BTF types.

How to build the project

To build from source, you will need a few dependencies:

DebianRedHat
libelf-develfutils-devel
libxml2-devlibxml2-devel
linux-libc-devkernel-headers

Instructions are included for local and Docker builds.

Local Build

You can build as follows:

$ make

Docker Build

A Dockerfile is provided to build a container with libabigail to easily compile the STG tools:

$ docker build -t stg .

And then enter the container:

$ docker run -it stg

If you want to bind your development code to the container:

$ docker run -it $PWD:/src -it stg

The source code is added to /src, so when your code is bound you can edit on your host and re-compile in the container.

Note that the Dockerfile can provide a development environment (non multi-stage build with the source code) or a production image (a multi-stage build with only the final binary). By default we provide the first, and you can uncomment the final lines of the file for the latter.

Contributions

See CONTRIBUTING.md for details.